Sponsored Jobs APIの前提条件
OAuthを設定する
OAuth v2トークンスコープ
OAuthアクセストークンを取得する
キャンペーン管理のハウツーガイド
単発キャンペーンを作成する
目標ベースのキャンペーンを作成する
定期キャンペーンを作成する
定期キャンペーンを編集する
キャンペーン予算を変更する
キャンペーン期間を変更する
キャンペーン内の求人を表示する
レポートのハウツーガイド
キャンペーンパフォーマンスをレポートする

Sponsored Jobs API スタートガイド

Sponsored Jobs APIを使い始めます。

法的注意

Indeed の API の使用について Indeed と書面による契約を締結していない場合、この API またはそのドキュメントを使用することにより、Indeed の API の使用には Indeed API Terms および Additional API Terms and Guidelines が適用されることに同意したものとみなされます。

2026年1月8日:
- 2026年2月1日より、Indeed は EU 諸国およびスイスのすべてのユーザーに対して、Indeed Sponsored Jobs API の使用ポリシーを適用します。対象国は、AT、BE、CH、DE、DK、EE、ES、FI、FR、GR、IE、IT、LU、NL、PL、PT、RO、および SE です。
  Indeed は、Sponsored Jobs API の呼び出し 1 回ごとに 3 EUR、または広告主が選択した請求通貨での同等額を請求します。Indeed は、月間のキャンペーンスポンサーシップ支出額が月間の API 呼び出し総費用を下回る場合にのみ課金します。
- 2026年2月1日より、Indeed は AR、AU、BR、CA、CL、CO、CR、GB、ID、IN、MX、MY、NZ、PA、PH、SG、および TH のすべてのユーザーに対して、Indeed Sponsored Jobs API の使用ポリシーを適用します。
  Indeed は、Sponsored Jobs API の呼び出し 1 回ごとに 3 USD、または広告主が選択した請求通貨での同等額を請求します。Indeed は、月間のキャンペーンスポンサーシップ支出額が月間の API 呼び出し総費用を下回る場合にのみ課金します。
  このポリシーでは、Sponsored Jobs API のお客様に対して、スポンサーシップ支出額に基づく API 使用料の支払いを求めます。このポリシーは、Indeed 独自の ATS プラグインを使用するお客様には適用されません。
  推奨される使用パターンについては、Sponsored Jobs API best practices to reduce call volume をご覧ください。
  Sponsored Jobs API を使用できるのは、過去 3 暦月以内にキャンペーンを通じてスポンサー求人を掲載した有料のお客様のみです。
  Indeed は、暦月ごとの Sponsored Jobs API の使用回数に上限を設けています。この上限は、前月の Sponsored Jobs キャンペーン支出額とクレジット上限額のいずれか大きい方に等しくなります。
  /apiquotausage エンドポイントを呼び出して、当月の API 使用状況を取得します。
2026年1月8日:
- 2024年12月1日より、Indeed は米国において Indeed Sponsored Jobs API の使用ポリシーを適用します。
  このポリシーでは、Indeed Sponsored Jobs API のお客様に対して、スポンサーシップ支出額に基づく API 使用料の支払いを求めます。
  このポリシーは、Indeed 独自の ATS プラグインを使用するお客様には適用されません。
  推奨される API 使用パターンについては、Sponsored Jobs API best practices to reduce call volume をご覧ください。
2024-06-30 より有効：GET /v1/stats/datastatus エンドポイントは廃止され、HTTP 404 を返します。代わりに GET /v1/stats を使用してください。
2024-06-26 より有効：GET /v1/campaigns/:campaignId/stats/:date および GET /v1/campaigns/:campaignId/stats/entryDates エンドポイントは廃止され、HTTP 404 を返します。

代わりに GET /v1/campaigns/{campaignId}/stats を使用してください。
2024-06-26 より有効：GET /v1/campaigns の perPage パラメータは 500 が上限となります。これより大きい値を指定したリクエストは、無効として拒否されます。
Sponsored Jobs レガシー API の廃止：
- 2021-08-01：Indeed OAuth v2 エンドポイントを使用し、可用性が高く低レイテンシのインフラストラクチャで動作する、最新の Sponsored Jobs API ゲートウェイへ移行してください。
- 2022-01-01：Sponsored Jobs レガシー API が廃止されました。
- 2022-03-31：Sponsored Jobs XML 連携が廃止されました。

前提条件、例付きのハウツーガイド、FAQ、トラブルシューティングを確認してください。

OAuthを設定する

Sponsored Jobs APIを使用する前に、次のものが必要です。

Indeedアカウント
APIクライアントIDとシークレット
Indeedアカウント内でスポンサーできる求人
アカウントに関連付けられた採用企業

Sponsored Jobs APIのOAuth
OAuth	説明
2-legged OAuth	このガイドの例では、クライアントクレデンシャルフロー（2-legged OAuth）を使用しています。直接採用企業、代理店、またはプログラマティックの場合は、このOAuthフローを使用してください。採用企業に代わって動作する代理店およびプログラマティックの場合、Indeedは採用企業がIndeedアカウントをセカンダリユーザーとして追加することを推奨します。これにより、クライアントクレデンシャルフロー（2-legged OAuth）を使用できます。 2-legged OAuthアプリを登録してクライアントIDとシークレットを取得します。 * 日本のみ: アプリ認証情報の管理ページを使用します。 * 日本以外: Partner Consoleを使用します。コンソールにアクセスできない場合は、Indeed担当者または marketplacesupport@indeed.com にお問い合わせください。
3-legged OAuth	ATSパートナーは認可コードフロー（3-legged OAuth）を使用する必要があります。 Indeed パートナーになると、Indeed が連携用のアプリを作成します。Partner Console にサインインして、アプリと OAuth 認証情報（クライアント ID、クライアントシークレット、および 3-legged OAuth の場合は認可コード）を確認します。認証情報をアクセストークンと交換し、API 呼び出しを認証します。

OAuth v2トークンスコープ

スコープ値は、各API呼び出しの認証トークンを生成するときに必要です。

書き込みスコープをリクエストすると、対応する読み取り専用スコープのアクセス許可も付与されます。

たとえば、employer.advertising.campaignをリクエストすると、employer.advertising.campaign.readの権限も付与されます。
複数のスコープを1つのアクセストークンに紐付けることができます。その場合はスコープをスペースで区切ります。

たとえばemployer_access employer.advertising.campaign employer.advertising.campaign_report.readとします。

OAuth認可コードリクエストで、呼び出しているAPIエンドポイントに対応するスコープを渡します。

次にエンドユーザーは、リクエストしたスコープを付与しない、一部を許可、すべてを許可のいずれかから選択します。

この表を使用して、各APIエンドポイントにリクエストするスコープを決定します。

APIクォータ使用状況

このエンドポイントでは、employer_accessスコープのアクセストークンを取得します。採用企業を代表するアクセストークンを取得するをご覧ください。

APIクォータ使用状況
動詞	APIエンドポイント	OAuthスコープ
`GET`	`/v1/apiquotausage`	`employer.advertising.account.read`

アカウント管理

アカウント管理スコープ
動詞	APIエンドポイント	OAuthスコープ	アクセストークンの種類
`GET`	`/v1/account`	採用企業アカウントの場合：`employer.advertising.account.read`	`employer_access`スコープあり。採用企業を代表するアクセストークンを取得するをご覧ください。
`GET`	`/v1/account`	マスターアカウントの場合：`employer.advertising.subaccount.read`	`employer`パラメータなし
`GET`	`/v1/subaccounts`	`employer.advertising.subaccount.read`	`employer`パラメータなし
`POST`	`/v1/subaccounts`	`employer.advertising.subaccount`	`employer`パラメータなし
`GET`	`/v1/account/budget`	`employer.advertising.account.read`	`employer_access`スコープあり。採用企業を代表するアクセストークンを取得するをご覧ください。
`PATCH`	`/v1/account/budget`	`employer.advertising.account`	`employer_access`スコープあり。採用企業を代表するアクセストークンを取得するをご覧ください。

キャンペーン管理

これらのエンドポイントでは、employer_accessスコープのアクセストークンを取得します。採用企業を代表するアクセストークンを取得するをご覧ください。

キャンペーン管理スコープ
動詞	APIエンドポイント	OAuthスコープ
`GET`	`/v1/campaigns`	`employer.advertising.campaign.read`
`POST`	`/v1/campaigns`	`employer.advertising.campaign`
`GET`	`/v1/campaigns/{campaignId}`	`employer.advertising.campaign.read`
`PATCH`	`/v1/campaigns/{campaignId}`	`employer.advertising.campaign`
`GET`	`/v1/campaigns/{campaignId}/budget`	`employer.advertising.campaign.read`
`PATCH`	`/v1/campaigns/{campaignId}/budget`	`employer.advertising.campaign`
`GET`	`/v1/campaigns/{campaignId}/jobCount`	`employer.advertising.campaign.read`
`GET`	`/v1/campaigns/{campaignId}/properties`	`employer.advertising.campaign.read`

レポート

レポートスコープ
動詞	APIエンドポイント	OAuthスコープ
`GET`	`/v1/campaigns/{campaignId}/stats`	`employer.advertising.campaign_report.read`
`GET`	`/v1/campaigns/{campaignId}/stats/{date}`	`employer.advertising.campaign_report.read`
`GET`	`/v1/campaigns/{campaignId}/stats/entryDates`	`employer.advertising.campaign_report.read`
`GET`	`/v1/stats`	`employer.advertising.campaign_report.read`
`GET`	`/v1/stats/{reportId}`	`employer.advertising.campaign_report.read`

OAuthアクセストークンを取得する

oauth/v2/tokens APIエンドポイントを呼び出してアクセストークンを取得するには、必要なトークンを呼び出すAPIに合わせて更新します。

Sponsored Jobs APIのほとんどのエンドポイントは、採用企業を表すアクセストークンを必要とします。そのため、呼び出す予定のエンドポイントで必要なスコープに加えてemployer_accessスコープをリクエストし、アクセスする採用企業を指定するemployerパラメータを含めます。ただし、マスターアカウントを持っていてサブアカウント管理エンドポイントを呼び出す場合は、アクセストークンをリクエストする際にemployerパラメータを省略します。サブアカウント管理エンドポイントは次のいずれかで呼び出します。

GET /v1/subaccounts
POST /v1/subaccounts

tokensエンドポイントのAPI詳細

tokensエンドポイント
API URL	`https://apis.indeed.com/oauth/v2/tokens`
リクエストタイプ	`POST`
コンテンツタイプ	`application/json`
認証	なし

tokensエンドポイントのリクエストパラメータ

tokensリクエストパラメータ
キー	値
`client_id`	クライアントID。次から取得します。 * 日本のみ: アプリ認証情報の管理。詳細については、認証情報を参照してください。 * 日本以外: Partner Console。コンソールにアクセスできない場合は、Indeed担当者または marketplacesupport@indeed.com にお問い合わせください。
`client_secret`	クライアントシークレット。次から取得します。 * 日本のみ: アプリ認証情報の管理。詳細については、認証情報を参照してください。 * 日本以外: Partner Console。コンソールにアクセスできない場合は、Indeed担当者または marketplacesupport@indeed.com にお問い合わせください。
`grant_type`	`client_credentials`。
`scope`	エンドポイントに依存します。例: `employer_access employer.advertising.account.read`。
`employer`	採用企業アカウントID。

tokensエンドポイントのレスポンス例

{
  "access_token": "<access_token>",
  "scope": "employer.advertising.account.read employer_access",
  "token_type": "Bearer",
  "expires_in": 3600
}

キャンペーン管理のハウツーガイド

単発キャンペーンを作成する

この例では、2週間実行される単発キャンペーンを作成し、$500の予算で2か所の求人をスポンサーします。

単発キャンペーンのスコープを持つアクセストークンを使用します。

単発キャンペーンを作成する
scope employer_access employer.advertising.campaign
求人のジョブソースIDを取得します。

ジョブソースIDを取得するには、採用企業アカウント情報を取得するを参照してください。採用企業はWebサイトやドメインごとに1つずつ、複数のジョブソースIDを持つことができます。jobSourceList.idレスポンスフィールドの値が、各サイトのジョブソースIDです。

単発キャンペーンを作成する
scope	`employer_access employer.advertising.campaign`

単発キャンペーンを作成します。

単発キャンペーンのAPI詳細:

単発キャンペーンのAPI詳細
API URL	`https://apis.indeed.com/ads/v1/campaigns` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`POST`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

単発キャンペーンのリクエスト例:

{
  "name": "Test Campaign Single-use",
  "status": "PAUSED",
  "trackingToken": "MyTrackingToken",
  "jobsSourceId": "[Your jobsSourceId from Step 2]",
  "jobsToInclude": "QUERY",
  "jobsQuery": "city:Aberdeen OR city:Glasgow",
  "budgetOnetimeLimit": 500,
  "startDate": "2021-09-01",
  "fixedEndDate": "2021-09-15"
}

単発キャンペーンのレスポンス例:

{
  "meta": {
    "status": 201,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [{
      "rel": "Campaign Info",
      "href": "/v1/campaigns/c8bxxxxxxxxx449"
    }]
  },
  "data": {
    "campaignId": "c8bxxxxxxxxx449"
  }
}

Indeedで単発キャンペーンを表示します。

単発キャンペーンのAPI呼び出し:

キャンペーンを作成するAPI呼び出し

Indeedで作成された単発キャンペーン:

Indeedで作成された単発キャンペーン

目標ベースのキャンペーンを作成する

この例では、特定の予定面接数を目標とする目標ベースのキャンペーンを作成します。

目標ベースのキャンペーンのスコープを持つアクセストークンを使用します。
目標ベースのキャンペーンを作成する
scope
employer_access employer.advertising.campaign
目標ベースのキャンペーン用に求人のソースIDを取得します。

ジョブソースIDを取得するには、採用企業アカウント情報を取得するを参照してください。採用企業はWebサイトやドメインごとに1つずつ、複数のジョブソースIDを持つことができます。jobSourceList.idレスポンスフィールドの値が、各サイトのジョブソースIDです。

目標ベースのキャンペーンを作成する
scope	`employer_access employer.advertising.campaign`

面接目標キャンペーンを作成します。

面接目標キャンペーンのAPI詳細:

面接目標キャンペーンを作成する
API URL	`https://apis.indeed.com/ads/v1/campaigns` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`POST`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

面接目標キャンペーンのリクエスト例:

{
  "name": "XXX SCHEDULED_INTERVIEWS",
  "status": "PAUSED",
  "trackingToken": "indeed_chi",
  "jobsSourceId": "[Your jobsSourceId from Step 2]",
  "jobsToInclude": "ALL",
  "jobsQuery": "Java",
  "jobsTitle": "software engineer",
  "jobsCompany": "Indeed",
  "jobsLocation": "Austin",
  "jobsLocationRadius": 5,
  "fixedEndDate": "2023-10-20",
  "budgetOnetimeLimit": 1000,
  "objective": {
    "objectiveType": "SCHEDULED_INTERVIEWS",
    "target": 77
  }
}

面接目標キャンペーンのレスポンス例:

{
  "meta": {
    "status": 201,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [{
      "rel": "Campaign Info",
      "href": "/v1/campaigns/f261xxxxxxxx6567"
    }]
  },
  "data": {
    "campaignId": "f261xxxxxxxx6567"
  }
}

Indeedで面接キャンペーンを表示します。

Indeedで作成された面接キャンペーン

Indeedで作成された面接キャンペーンの面接目標設定

定期キャンペーンを作成する

この例では、6か月間実行される定期キャンペーンを作成し、3か所のマネージャー求人を月$1500の予算でスポンサーします。

スコープを持つアクセストークンを使用します。
定期キャンペーンを作成する
scope
employer_access employer.advertising.campaign
定期キャンペーン用に求人のソースIDを取得します。

ジョブソースIDを取得するには、採用企業アカウント情報を取得するを参照してください。採用企業はWebサイトやドメインごとに1つずつ、複数のジョブソースIDを持つことができます。jobSourceList.idレスポンスフィールドの値が、各サイトのジョブソースIDです。

定期キャンペーンを作成する
scope	`employer_access employer.advertising.campaign`

定期キャンペーンを作成します。

定期キャンペーンのAPI詳細:

定期キャンペーンを作成する
API URL	`https://apis.indeed.com/ads/v1/campaigns` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`POST`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

定期キャンペーンのリクエスト例:

{
  "name": "Test Campaign Recurring",
  "status": "PAUSED",
  "trackingToken": "MyTrackingToken",
  "jobsSourceId": "[Your jobsSourceId from Step 2]",
  "jobsToInclude": "QUERY",
  "jobsQuery": "(city:Aberdeen OR city:Glasgow OR city:London) AND title: Manager",
  "budgetMonthlyLimit": 1500,
  "startDate": "2021-09-01",
  "fixedEndDate": "2022-04-01"
}

定期キャンペーンのレスポンス例:

{
  "meta": {
    "status": 201,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [{
      "rel": "Campaign Info",
      "href": "/v1/campaigns/52fxxxxxxxxx310"
    }]
  },
  "data": {
    "campaignId": "52fxxxxxxxxx310"
  }
}

Indeedで定期キャンペーンを表示します。

定期キャンペーンのAPI呼び出し:

Indeedで作成された定期キャンペーンのAPI呼び出し

Indeedで作成された定期キャンペーン:

Indeedで作成された定期キャンペーン

定期キャンペーンを編集する

この例では、キャンペーンを検索して更新し、追加の場所を加えます。このエンドポイントを使用して、キャンペーンの開始や一時停止、名前変更、トラッキングトークンの変更も行えます。詳細については、Sponsored Jobs APIリファレンスを参照してください。

更新用のスコープを持つアクセストークンを使用します。
定期キャンペーンを編集する
scope
employer_access employer.advertising.campaign

定期キャンペーンを編集する
scope	`employer_access employer.advertising.campaign`

キャンペーンとそのIDを一覧表示して、定期キャンペーンのキャンペーンIDを取得します。

定期キャンペーン更新のAPI詳細:

定期キャンペーンを更新する
API URL	`https://apis.indeed.com/ads/v1/campaigns` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`GET`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

定期キャンペーン更新のリクエストパラメータ:

定期キャンペーン更新のリクエストパラメータ
キー	値
`perPage`	10
`status`	PAUSED
`type`	SOURCE

定期キャンペーン更新のレスポンス例:

"meta": {
  "status": 200,
  "errors": null,
  "rootLocation": "https://apis.indeed.com/ads",
  "perPage": 10,
  "links": [{
      "rel": "'Test Campaign Single-use' Info",
      "href": "/v1/campaigns/c8bxxxxxxxxx449"
    },
    {
      "rel": "'Test Campaign Recurring' Info",
      "href": "/v1/campaigns/52fxxxxxxxxx310"
    }
  ]
},
"data": {
  "Campaigns": [{
      "Name": "Test Campaign Single-use",
      "Id": "c8bxxxxxxxxx449",
      "Status": "PAUSED"
    },
    {
      "Name": "Test Campaign Recurring",
      "Id": "52fxxxxxxxxx310",
      "Status": "PAUSED"
    }
  ]
}

キャンペーンクエリを更新します。

jobsQueryフィールドで、インデックス求人クエリ形式を使用してクエリを渡します。

キャンペーンクエリ更新のAPI詳細:

キャンペーンクエリを更新する
API URL	`https://apis.indeed.com/ads/v1/campaigns/<YourCampaignIdFromStep2}` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`PATCH`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

キャンペーンクエリ更新のリクエスト例:

{
  "jobsToInclude": "QUERY",
  "jobsQuery": "(city:Aberdeen OR city:Glasgow OR city:London OR city:Birmingham) AND title: Manager"
}

キャンペーンクエリ更新のレスポンス例:

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

Indeedで更新されたキャンペーンクエリを表示します。

定期キャンペーン更新のAPI呼び出し:

定期キャンペーンを編集するAPI呼び出し

Indeedで更新された定期キャンペーン:

Indeedで更新された定期キャンペーン

キャンペーン予算を変更する

この例では、キャンペーンを検索して更新し、予算を月$250増額（$1500から$1750）します。

キャンペーン予算更新のスコープを持つアクセストークンを使用します。
キャンペーン予算を変更する
scope
employer_access employer.advertising.campaign
更新するキャンペーン予算のIDを取得します。

キャンペーンを一覧表示するには、定期キャンペーンのキャンペーンIDを取得するを参照してください。

キャンペーン予算を変更する
scope	`employer_access employer.advertising.campaign`

キャンペーン予算を更新します。

キャンペーン予算更新のAPI詳細:

キャンペーン予算を更新する
API URL	`https://apis.indeed.com/ads/v1/campaigns/{YourCampaignIdFromStep2}/budget` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`PATCH`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

キャンペーン予算更新のリクエスト例:

{
  "budgetMonthlyLimit": "1750"
}

キャンペーン予算更新のレスポンス例:

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

Indeedでキャンペーン予算を表示します。

キャンペーン予算を更新するAPI呼び出し:

キャンペーン予算を更新するAPI呼び出し

キャンペーン予算更新の例:

Indeedで更新されたキャンペーン予算

キャンペーン期間を変更する

この例では、単発キャンペーンの期間を検索して2週間延長します。

キャンペーン期間のスコープを持つアクセストークンを使用します。
キャンペーン期間を変更する
scope
employer_access employer.advertising.campaign
キャンペーン期間のIDを取得します。

キャンペーンを一覧表示するには、定期キャンペーンのキャンペーンIDを取得するを参照してください。

キャンペーン期間を変更する
scope	`employer_access employer.advertising.campaign`

キャンペーンの日付を更新します。

キャンペーン期間のAPI詳細:

キャンペーンの日付を更新する
API URL	`https://apis.indeed.com/ads/v1/campaigns/{YourCampaignIdFromStep2}/budget` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`PATCH`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

キャンペーン期間のリクエスト例:

{
  "fixedEndDate": "2021-09-30"
}

キャンペーン期間のレスポンス例:

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

Indeedでキャンペーン期間を表示します。

キャンペーン期間を更新するAPI呼び出し:

キャンペーン期間を更新するAPI呼び出し

キャンペーン終了日更新の例:

Indeedで更新された終了日

キャンペーン内の求人を表示する

この例では、キャンペーンがスポンサーする求人の詳細情報を取得します。

キャンペーン求人のスコープを持つアクセストークンを使用します。
キャンペーン内の求人を表示する
scope
employer_access employer.advertising.campaign
更新するキャンペーンのIDを取得します。キャンペーンを一覧表示するには、定期キャンペーンのキャンペーンIDを取得するを参照してください。

キャンペーン内の求人を表示する
scope	`employer_access employer.advertising.campaign`

キャンペーンがスポンサーする求人の最初のページを取得します。

求人のAPI詳細:

キャンペーンがスポンサーする求人の最初のページを取得する
API URL	`https://apis.indeed.com/ads/v1/campaigns/{YourCampaignIdFromStep2}/jobDetails` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`GET`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

更新キャンペーンのリクエスト例:

更新キャンペーンのリクエストパラメータ:

更新キャンペーンのリクエストパラメータ
キー	値
`start`	0
`perPage`	3

更新キャンペーンのレスポンス例:

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.qa.indeed.tech/ads",
    "perPage": 3,
    "links": null
  },
  "data": {
    "entries": [{
        "jobKey": "839d4e5b2b8ca2a6",
        "refNum": "267",
        "title": "Experienced Driver",
        "location": "London"
      },
      {
        "jobKey": "4191b62313a544aa",
        "refNum": "259",
        "title": "Branch Foreman",
        "location": "London"
      },
      {
        "jobKey": "2977cb389f748f51",
        "refNum": "305",
        "title": "Trainee Manager",
        "location": "London"
      }
    ],
    "hash": 964409796
  }
}

残りのページを取得します。

後続のリクエストは最初のリクエストと同じ形式に従います。新しいページを取得するには、startを前のリクエストのstartとperPageの合計に設定し、perPageを前のリクエストと同じに設定します。たとえば、最後のページがstart = 10、perPage = 5で取得された場合、次のページはstart = 15、perPage = 5でリクエストできます。キャンペーンがスポンサーするすべての求人を取得するには、次のいずれかに達するまで連続するページを取得し続けます。
- レスポンスオブジェクトのperPageメタフィールドが、リクエストしたperPageと異なる。これは最終ページが読み取られたことを示します。
  
  perPageの最大値は500なので、リクエストされたperPageが500を超える場合、レスポンスでの差異が必ずしも最終ページに到達したことを示すとは限りません。
- レスポンスオブジェクトのhashフィールドが、前のページの値と異なる。これは読み取り中に求人リストが変更されたことを示します。クライアントは1分間一時停止してから、start = 0から読み取りを再開する必要があります。

レポートのハウツーガイド

キャンペーンパフォーマンスをレポートする

この例では、3日間のキャンペーンのパフォーマンスデータをリクエストします。

この例では、結果セットの集計と日別の内訳の両方を提供します。

キャンペーンパフォーマンスレポートのスコープを持つアクセストークンを使用する

キャンペーンパフォーマンスレポートのスコープを持つアクセストークンを使用する
scope	`employer_access employer.advertising.campaign_report.read`

キャンペーンパフォーマンスレポートのキャンペーンIDを取得する

キャンペーンを一覧表示するには、定期キャンペーンのキャンペーンIDを取得するを参照してください。

キャンペーン統計を取得する

キャンペーンパフォーマンスレポートのAPI詳細

キャンペーンパフォーマンスレポート
API URL	`https://apis.indeed.com/ads/v1/campaigns/{YourCampaignIdFromStep2}/stats` （Sponsored Jobs APIリファレンス）
リクエストタイプ	`GET`
コンテンツタイプ	`application/json`
認証	OAuth 2.0ベアラートークン

キャンペーンパフォーマンスレポートのリクエストパラメータ

キャンペーンパフォーマンスレポートのリクエストパラメータ
キー	値
`startDate`	2021-07-16
`endDate`	2021-07-31
`merge`	`TRUE` 日別の内訳を取得するには`FALSE`に設定します。

APIレスポンス（Merge = TRUE）

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [{
      "rel": "up",
      "href": "/v1/campaigns//b0fxxxxxxxxx327/stats"
    }]
  },
  "data": {
    "Name": "TMN test UK - Target Applies",
    "Id": "/b0fxxxxxxxxx327",
    "StartDate": "2021-07-22",
    "EndDate": "2021-07-24",
    "Clicks": 989,
    "Impressions": 8384,
    "Conversions": 217,
    "CurrencyCode": "USD",
    "Cost": 598.69,
    "OrganicClicks": 35,
    "OrganicImpressions": 303,
    "Applystarts": 320,
    "OrganicApplystarts": 18
  }
}

APIレスポンス（Merge = FALSE）

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 10,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns//b0fxxxxxxxxx327/stats"
      }
    ]
  },
  "data": {
    "entries": [
      {
        "Name": "TMN test UK - Target Applies",
        "Id": "/b0fxxxxxxxxx327",
        "Date": "2021-07-22",
        "Clicks": 373,
        "Impressions": 3238,
        "Conversions": 83,
        "CurrencyCode": "USD",
        "Cost": 258.76,
        "OrganicClicks": 22,
        "OrganicImpressions": 226,
        "Applystarts": 125,
        "OrganicApplystarts": 9
      },
      {
        "Name": "TMN test UK - Target Applies",
        "Id": "/b0fxxxxxxxxx327",
        "Date": "2021-07-23",
        "Clicks": 318,
        "Impressions": 2665,
        "Conversions": 74,
        "CurrencyCode": "USD",
        "Cost": 178.28,
        "OrganicClicks": 7,
        "OrganicImpressions": 42,
        "Applystarts": 104,
        "OrganicApplystarts": 4
      },
      {
        "Name": "TMN test UK - Target Applies",
        "Id": "/b0fxxxxxxxxx327",
        "Date": "2021-07-24",
        "Clicks": 298,
        "Impressions": 2481,
        "Conversions": 60,
        "CurrencyCode": "USD",
        "Cost": 161.65,
        "OrganicClicks": 6,
        "OrganicImpressions": 35,
        "Applystarts": 91,
        "OrganicApplystarts": 5
      }
    ]
  }
}

キャンペーンパフォーマンスレポートのAPI呼び出し

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

On this page

Sponsored Jobs APIの前提条件​

OAuthを設定する​

OAuth v2トークンスコープ​

APIクォータ使用状況​

アカウント管理​

キャンペーン管理​

レポート​

OAuthアクセストークンを取得する​

tokensエンドポイントのAPI詳細​

tokensエンドポイントのリクエストパラメータ​

tokensエンドポイントのレスポンス例​

キャンペーン管理のハウツーガイド​

単発キャンペーンを作成する​

目標ベースのキャンペーンを作成する​

定期キャンペーンを作成する​

定期キャンペーンを編集する​

キャンペーン予算を変更する​

キャンペーン期間を変更する​

キャンペーン内の求人を表示する​

レポートのハウツーガイド​

キャンペーンパフォーマンスをレポートする​

キャンペーンパフォーマンスレポートのスコープを持つアクセストークンを使用する​

キャンペーンパフォーマンスレポートのキャンペーンIDを取得する​

キャンペーン統計を取得する​

キャンペーンパフォーマンスレポートのAPI詳細​

キャンペーンパフォーマンスレポートのリクエストパラメータ​

APIレスポンス（Merge = TRUE）​

APIレスポンス（Merge = FALSE）​

キャンペーンパフォーマンスレポートのAPI呼び出し​

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

このページの内容

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

Sponsored Jobs APIの前提条件

OAuthを設定する

OAuth v2トークンスコープ

APIクォータ使用状況

アカウント管理

キャンペーン管理

レポート

OAuthアクセストークンを取得する

tokensエンドポイントのAPI詳細

tokensエンドポイントのリクエストパラメータ

tokensエンドポイントのレスポンス例

キャンペーン管理のハウツーガイド

単発キャンペーンを作成する

目標ベースのキャンペーンを作成する

定期キャンペーンを作成する

定期キャンペーンを編集する

キャンペーン予算を変更する

キャンペーン期間を変更する

キャンペーン内の求人を表示する

レポートのハウツーガイド

キャンペーンパフォーマンスをレポートする

キャンペーンパフォーマンスレポートのスコープを持つアクセストークンを使用する

キャンペーンパフォーマンスレポートのキャンペーンIDを取得する

キャンペーン統計を取得する

キャンペーンパフォーマンスレポートのAPI詳細

キャンペーンパフォーマンスレポートのリクエストパラメータ

APIレスポンス（Merge = TRUE）

APIレスポンス（Merge = FALSE）

キャンペーンパフォーマンスレポートのAPI呼び出し