キャンペーンの求人数を取得

GET /v1/campaigns/:campaignId/jobCount

キャンペーンの求人数を取得します。

注記

求人数は、キャンペーンが現在スポンサーしている求人の数、またはアクティブな場合にスポンサーする求人の数です。この数には、キャンペーンが過去にスポンサーした求人は含まれません。内訳の詳細を取得するには、jobCountFormat=detailedクエリパラメータを指定してください。

含まれる求人は、以下のキャンペーンフィールドに依存します: jobsQuery、jobsTitle、jobsCompany、jobsLocation、jobsToIncludeまたはjobsLocationRadius。含まれる求人の詳細を取得するには、GET /v1/campaigns/{campaignId}/jobDetailsエンドポイントを使用します。employer.advertising.campaign.read OAuthスコープをリクエストして、採用企業を表すアクセストークンを取得します。採用企業を表すアクセストークンを取得するを参照してください。

OAuthスコープ	アクセストークンタイプ
`employer.advertising.campaign.read`	採用企業を表すアクセストークン。採用企業を表すアクセストークンを取得するを参照してください。

Request

Path Parameters

campaignId stringrequired

キャンペーンID。

Query Parameters

jobCountFormat string

Possible values: [detailed]

レスポンスの形式。detailedに設定すると、求人数を過去にスポンサーされた求人、現在スポンサー中の求人、現在キューにある求人、合計求人に分類します。

Responses

成功

application/json

Schema
Example (from schema)
Basic job count
With jobCountFormat Detailed

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs APIのベースURL。

perPage int32

ページネーションされた結果を返すエンドポイントの場合、1ページに返されるエントリの実際の最大数。perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが単一の結果を返すかページネーションしない場合、値はnullです。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
next: ページネーションされた結果の次のページ。
prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data int32

キャンペーンが現在スポンサーしている求人の数、またはキャンペーンがアクティブだった場合にスポンサーされる求人の数。

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": 7
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      },
      {
        "rel": "Traffic Statistics",
        "href": "/v1/campaigns/bceed88523d89731/stats"
      }
    ]
  },
  "data": 14946
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      },
      {
        "rel": "Traffic Statistics",
        "href": "/v1/campaigns/bceed88523d89731/stats"
      }
    ]
  },
  "data": {
    "jobsSponsoredTillDate": 7892,
    "jobsCurrentlySponsored": 1694,
    "jobsCurrentlyInQueue": 7084,
    "totalJobs": 14946
  }
}

リクエストに有効なアクセストークンが含まれていませんでした:

Authorizationヘッダーが欠落しているか不正な形式でした。HTTPのAuthorizationヘッダーにアクセストークンを含め、値の前にBearerという単語とスペースを付けてください。例えば、アクセストークンがXYZの場合、リクエストにはAuthorization: Bearer XYZヘッダーを含める必要があります。
アクセストークンの形式が不正でした。HTTPリクエストを手動で構築してAPIをテストしている場合、リクエストにコピーする際にアクセストークンの先頭または末尾の文字を省略したり余分な文字を含めたりしていないか確認してください。
アクセストークンが期限切れです。アクセストークンは1時間（3,600秒）のみ有効です。その後、クライアント資格情報（2-legged OAuth）またはリフレッシュトークン（3-legged OAuth）を使用して別のアクセストークンを取得する必要があります。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs APIのベースURL。

perPage int32

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
next: ページネーションされた結果の次のページ。
prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "Invalid OAuth access token."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

このAPIで使用できない有効なアクセストークンです。詳細については、meta.errorsで返されるエラーを確認してください。

エラータイプ	意味と一般的な原因
`INSUFFICIENT_SCOPE`	アクセストークンには、このAPIエンドポイントに必要なOAuth v2トークンスコープがありません。一般的な原因については、FAQとトラブルシューティングを参照してください。
`NOT_EMPLOYER_ACCESS_TOKEN`	このエンドポイントには、採用企業を表すアクセストークンが必要です。採用企業を表すアクセストークンを取得するを参照してください。つまり、アクセストークンをリクエストする際に`employer`パラメータを指定する必要があります。Sponsored Jobs APIエンドポイントの大部分でこれが必要です。
`LEGACY_ACCESS_TOKEN_NOT_ALLOWED`	Sponsored Jobs APIはレガシーOAuthエンドポイントから取得したアクセストークンをサポートしなくなりました。更新されたエンドポイントについては、IndeedとAPIの統合と呼び出しを参照してください。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs APIのベースURL。

perPage int32

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
next: ページネーションされた結果の次のページ。
prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 403,
    "errors": [
      {
        "type": "INSUFFICIENT_SCOPE",
        "description": "Access token does not have permission to access this API."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

リクエストされたキャンペーンが存在しないか、別の採用企業に属しています。リクエストされたキャンペーンを所有する採用企業を表すアクセストークンを使用してください。採用企業を表すアクセストークンを取得するを参照してください。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs APIのベースURL。

perPage int32

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
next: ページネーションされた結果の次のページ。
prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 404,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": {
      "rel": "up",
      "href": "/v1/campaigns"
    }
  },
  "data": null
}

予期しないエラーが発生しました。問題は一時的な場合があり、まったく同じリクエストを再試行すると成功する場合があります。

リクエストの再試行が役立たない場合は、リクエストの解析に問題が発生した可能性があります。必要なすべてのパラメータが存在し、すべてのパラメータが正しくフォーマットされていることを確認してください。

クライアント資格情報グラントタイプ（2-legged OAuth）で取得したアクセストークンをレガシーSponsored Jobs APIエンドポイントで使用した場合、INTERNAL_SERVER_ERRORエラーが発生します。最新のベースURL（https://apis.indeed.com/ads）を使用してください。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs APIのベースURL。

perPage int32

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
next: ページネーションされた結果の次のページ。
prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 500,
    "errors": [
      {
        "type": "INTERNAL_SERVER_ERROR",
        "description": "Failed to process the request."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

キャンペーンの求人数を取得

Request​

Path Parameters

Query Parameters

Responses​

Schema

Schema

Schema

Schema

Schema

このページは役に立ちましたか？

Request

Responses