- 前提条件
- OAuthを設定する
- OAuth v2トークンスコープ
- OAuthアクセストークンを取得する
- キャンペーン管理ガイド
- キャンペーン予算見積もりを取得する
- 単発キャンペーンを作成する
- 目標ベースのキャンペーンを作成する
- 定期キャンペーンを作成する
- 定期キャンペーン情報を更新する
- キャンペーン予算を更新する
- キャンペーン期間を更新する
- キャンペーン内の求人の詳細を取 得する
- レポートのハウツーガイド
- キャンペーンパフォーマンスをレポートする
- アカウント管理のハウツーガイド
- 採用企業アカウント情報を取得する
- サブアカウント情報を取得する
- サブアカウントを作成する
- アカウント予算を取得する
- アカウント予算を設定する
- APIクォータ使用量のハウツーガイド
- 広告主のAPIクォータ使用量を取得する
- 推奨事項とガイドライン
- 結果整合性に備える
- API変更との互換性を確保する
- FAQとトラブルシューティング
- FAQ
- よくあるエラーをトラブルシューティングする
- OAuthエラーをトラブルシューティングする
スポンサー求人APIスタートガイド
スポンサー求人APIを使い始めます。
Indeed の API の使用について Indeed と書面による契約を締結していない場合、この API またはそのドキュメントを使用することにより、Indeed の API の使用には Indeed API Terms (新しいウィンドウで開きます) および Additional API Terms and Guidelines が適用されることに同意したものとみなされます。
-
2026年1月8日:
2026年2月1日より、Indeed は EU 諸国およびスイスのすべてのユーザーに対して、Indeed スポンサー求人API の使用ポリシーを適用します。対象国は、AT、BE、CH、DE、DK、EE、ES、FI、FR、GR、IE、IT、LU、NL、PL、PT、RO、および SE です。
Indeed は、スポンサー求人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 スポンサー求人API の使用ポリシーを適用します。
Indeed は、スポンサー求人API の呼び出し 1 回ごとに 3 USD、または広告主が選択した請求通貨での同等額を請求します。Indeed は、月間のキャンペーンスポンサーシップ支出額が月間の API 呼び出し総費用を下回る場合にのみ課金します。
このポリシーでは、スポンサー求人API のお客様に対して、スポンサーシップ支出額に基づく API 使用料の支払いを求めます。このポリシーは、Indeed 独自の ATS プラグインを使用するお客様には適用されません。
推奨される使用パターンについては、スポンサー求人API best practices to reduce call volume (新しいウィンドウで開きます) をご覧ください。
スポンサー求人API を使用できるのは、過去 3 暦月以内にキャンペーンを通じてスポンサー求人を掲載した有料のお客様のみです。
Indeed は、暦月ごとの スポンサー求人API の使用回数に上限を設けています。この上限は、前月の Sponsored Jobs キャンペーン支出額とクレジット上限額のいずれか大きい方に等しくなります。
/apiquotausageエンドポイントを呼び出して、当月の API 使用状況を取得します。
-
2026年1月8日:
2024年12月1日より、Indeed は米国において Indeed スポンサー求人API の使用ポリシーを適用します。
このポリシーでは、Indeed スポンサー求人API のお客様に対して、スポンサーシップ支出額に基づく API 使用料の支払いを求めます。
このポリシーは、Indeed 独自の ATS プラグインを使用するお客様には適用されません。
推奨される API 使用パターンについては、スポンサー求人API best practices to reduce call volume (新しいウィンドウで開きます) をご覧ください。
-
2024-06-30 より有効:
GET /v1/stats/datastatusエンドポイントは廃止され、HTTP404を返します。代わりにGET /v1/statsを使用してください。 -
2024-06-26 より有効:
GET /v1/campaigns/:campaignId/stats/:dateおよびGET /v1/campaigns/:campaignId/stats/entryDatesエンドポイントは廃止され、HTTP404を返します。代わりに
GET /v1/campaigns/{campaignId}/statsを使用してください。 -
2024-06-26 より有効:
GET /v1/campaignsのperPageパラメータは500が上限となります。これより大きい値を指定したリクエストは、無効として拒否されます。 -
Sponsored Jobs レガシー API の廃止:
2021-08-01:Indeed OAuth v2 エンドポイントを使用し、可用性が高く低レイテンシのインフラストラクチャで動作する、最新の スポンサー求人API ゲートウェイへ移行してください。
2022-01-01:Sponsored Jobs レガシー API が廃止されました。
2022-03-31:Sponsored Jobs XML 連携が廃止されました。
前提条件、例付きのハウツーガイド、FAQ、トラブルシューティングをご覧ください。
前提条件
#OAuthを設定する
#スポンサー求人APIを使用する前に、次のものが必要です。
- Indeedアカウント
- APIクライアントIDとシークレット
- Indeedアカウント内でスポンサーできる求人
- アカウントに 関連付けられた採用企業
| OAuth | 説明 |
|---|---|
| 2-legged OAuth | このガイドの例では、クライアントクレデンシャルフロー(2-legged OAuth)を使用します。直接採用企業、代理店、またはプログラマティックパートナーの場合は、このフローを使用してください。 採用企業に代わって業務を行う代理店またはプログラマティックパートナーの場合、Indeedは、採用企業がお客様のIndeedアカウントをセカンダリユーザー (新しいウィンドウで開きます)として追加することを推奨します。これにより、クライアントクレデンシャルフローを使用できます。 クライアントIDとシークレットを取得するには、Partner Console (新しいウィンドウで開きます)で2-legged OAuthアプリを登録します。コンソールにアクセスできない場合は、Indeed担当者または marketplacesupport@indeed.com にお問い合わせください。 |
| 3-legged OAuth | ATSパートナーは認可コードフロー(3-legged OAuth)を使用する必要があります。 Indeed パートナーになると、Indeed が連携用のアプリを作成します。Partner Console (新しいウィンドウで開きます) にサインインすると、アプリと OAuth 認証情報(クライアント ID とシークレット)を確認できます。API 呼び出しを認証するには、これらの認証情報をアクセストークンと交換します。 |
OAuth v2トークンスコープ
#アクセストークンを取得するときは、少なくとも 1 つのスコープをリクエストする必要があります。
- 書き込みスコープには、対応する読み取り専用スコープが含まれます。たとえば、
employer.advertising.campaignにはemployer.advertising.campaign.readも含まれます。 - 1 つのアクセストークンに複数のスコープをリクエストできます。用語集をご覧ください。スコープはスペースで区切って指定します。例:
employer_access employer.advertising.campaign employer.advertising.campaign_report.read
OAuth 認可コードリクエストでは、呼び出す API エンドポイントに必要なスコープを含めます。エンドユーザーは、そのスコープの一部、すべて、またはどれも付与しないことができます。用語集をご覧ください。
次をご覧ください。
OAuthアクセストークンを取得する
#oauth/v2/tokensを呼び出してアクセストークンを取得するには、使用するAPI向けのトークンをリクエストします。
スポンサー求人APIのほとんどのエンドポイントは、採用企業を表すアクセストークンを必要とします。呼び出す予定のエンドポイントで必要なスコープに加えてemployer_accessをリクエストし、データにアクセスする採用企業を指定するemployerパラメータを含めてください。
マスターアカウントを使用してサブアカウント管理エンドポイントを呼び出す場合は、アクセストークンをリクエストする際にemployerパラメータを省略してください。
サブアカウント管理エンドポイントは、次のいずれかで呼び出せます。
GET /v1/subaccountsPOST /v1/subaccountstokensエンドポイントのAPI詳細
#| API URL | https://apis.indeed.com/oauth/v2/tokens |
|---|---|
| リクエストタイプ | POST |
| コンテンツタイプ | application/json |
| 認証 | なし |
tokensエンドポ イントのリクエストパラメータ
#| キー | 値 |
|---|---|
client_id | クライアントID。次から取得します。
|
client_secret | クライアントシークレット。次から取得します。
|
grant_type | client_credentials |
scope | 呼び出すエンドポイントによって異なります。例: |
employer | 採用企業アカウントID。 |
tokensエンドポイントのレスポンス例
#{ "access_token": "<access_token>", "scope": "employer.advertising.account.read employer_access", "token_type": "Bearer", "expires_in": 3600}キャンペーン管理ガイド
#キャンペーン予算見積もりを取得する
#採用企業は、平均日次予算(ADB)キャンペーンを作成する前に、求人ごとの推奨日次予算とキャンペーンレベルの平均日次予算を取得できます。
スポンサーシッププランの平均予算見積もり、一致した各求人の予算見積もり、およびSTANDARDティアとPREMIUMティアの推奨値を返します。
推奨日次予算は目標であり、保証ではありません。Indeedは目標に向けて最適化しますが、実際の日次支出は変動する場合があ ります。
たとえば、平均日次予算が$25の場合、1日目の支出が$20、2日目の支出が$30になることがあります。
このエンドポイントへの呼び出しは、スポンサー求人APIの使用ポリシーでは課金対象になりません。
- 新しい求人を掲載してから2〜3時間待ってから、キャンペーンを作成してください。
- 予算推奨の呼び出しから1時間以内にキャンペーンを作成してください。それを過ぎると市場環境が変わる可能性があり、キャンペーンの作成には最新の推奨予算が使用されます。
- クエリベースの求人解決によって自動的に追加された求人は、キャンペーン作成後に追加された場合も、推奨予算が日次支出の既定値として使用されます。
- キャンペーンに手動で追加された求人も、推奨予算が日次支出の既定値として使用されます。
この例では、求人ごとの推奨日次予算とキャンペーンレベルの平均日次予算を取得します。
-
求人ごとの推奨日次予算とキャンペーンレベルの平均日次予算を取得します。
API詳細:
キャンペーン予算見積もりを取得する API URL https://apis.indeed.com/ads/v1/campaignbudgetquoteリクエストタイプ POSTコンテンツタイプ application/json認証 OAuth 2.0ベアラートークン リクエスト例:
curl -L -X POST 'https://apis.indeed.com/ads/v1/campaignbudgetquote' \-H 'Content-Type: application/json' \-H 'Accept: application/json' \--data-raw '{"jobsQuery": "title:\"financial analyst\" AND city:(toronto OR \"new york\")","jobsTitle": "Healthcare Intern","jobsCompany": "Indeed","jobsLocation": "Austin, TX","jobsLocationRadius": 25,"jobsSourceId": "8977ac341a3c4527","jobsSourceName": "CompanyABC","jobsToInclude": "ALL"}'レスポンス例:
{"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": {"sponsorshipPlanBudgetQuotes": [{"sponsorshipPlan": "PREMIUM","dailyAvgBudgetPerJob": {"amount": 0,"currency": "string"},"jobBudgetQuotes": [{"jobKey": "89deb9de58ebe149","dailyBudget": {"amount": 0,"currency": "string"}}]}]}}
単発キャンペーンを作成する
#前提条件
- 新しい求人を掲載してから2〜3時間待ってから、キャンペーンを作成してください。
- キャンペーンを作成する前に、採用企業アカウントを求人ソースに関連付ける必要があります。アカウントの求人ソースを一覧表示するには、
GET /v1/accountを使用します。関連付けられている求人ソースがない場合は、Indeedカスタマーサポート にお問い合わせください。 - キャンペーンが求人をスポンサーする前に、採用企業アカウントに有効な請求情報が登録されている必要があります。
この例では、2週間実行される単発キャンペーンを作成し、$500の予算で2か所の求人をスポンサーします。
-
必要なスコープを持つアクセストークンを使用します。
単発キャンペーンを作成する scope employer_access employer.advertising.campaign -
求人ソースIDを取得します。
求人ソースIDを確認するには、採用企業アカウント情報を取得する手順をご覧ください。採用企業は、Webサイトやドメインごとにそれぞれ1つずつ、複数の求人ソースIDを持つことができます。対象のサイトの
jobSourceList.idを使用してください。 -
単発キャンペーンを作成します。
API詳細:
単発キャンペーンのAPI詳細 API URL https://apis.indeed.com/ads/v1/campaignsリクエストタイプ 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呼び出し: