ボーナスクレジットキャンペーン向け Sponsored Jobs API 連携ガイド
Indeed 年間契約のボーナスクレジットを利用して、特別キャンペーンで求人をスポンサーします。
Indeed の API の使用について Indeed と書面による契約を締結していない場合、この API またはそのドキュメントを使用することにより、Indeed の API の使用には Indeed API Terms および Additional API Terms and Guidelines が適用されることに同意したものとみなされます。
概要
このガイドでは、Indeed 年間契約に基づくボーナススポンサー求人クレジットの利用に関する API サポートについて説明します。ボーナススポンサー求人クレジットを利用して、指定された特別キャンペーンで求人をスポンサーします。クレジットが広告主アカウントに割り当てられると、Indeed が対応するキャンペーンを自動的に作成します。
2026-01-19 以降、Sponsored Jobs API を使用して、ボーナスクレジット残高の確認、ボーナスクレジットキャンペーンの特定、求人ごとの予算のモニタリング、および求人選択クエリの更新を行えます。
変更点の概要
| エンドポイント | 変更タイプ | 変更内容 |
|---|---|---|
クレジット割り当てと残高を取得 | 新規 | 広告主のボーナススポンサー求人クレジットの合計と残高を取得します。 以下をご覧ください。 |
雇用主のキャンペーンとステータスの一覧 | 機能強化 | 新しい
ボーナスクレジットキャンペーンの識別(更新されたエンドポイント)をご覧ください。 |
キャンペーンの一般情報を取得 | 機能強化 | 以下のフィールドを自動的に含みます。
単一キャンペーンの詳細をご覧ください。 |
キャンペーンの予算と期間を取得 | 機能強化 | ボーナスクレジットキャンペーンの場合、以下のフィールドを自動的に含みます。
求人ごとの予算の可視化(更新)をご覧ください。 |
キャンペーンの一般情報を更新 | 機能強化 | ボーナスクレジットキャンペーンに、求人選択条件を追加しました。 求人選択の更新をご覧ください。 |
クレジット残高の可視化(新規)
| エンドポイント | クレジット割り当てと残高を取得 |
|---|---|
| 説明 | 広告主のボーナススポンサー求人クレジットの合計と残高を取得します。 クレジット残高はリアルタイムで返されます。 |
| 認証 | |
| レスポンス |
|
| ユースケース |
|
ボーナスクレジットキャンペーンの識別(更新されたエンドポイント)
機能強化されたキャンペーン一覧
| エンドポイント | 雇用主のキャンペーンとステータスの一覧 |
|---|---|
| 説明 | キャンペーン一覧エンドポイントは、レスポンスに含めるデータを指定できる 追加された
|
| 認証 | |
| リクエスト |
|
| レスポンス |
|
単一キャンペーンの詳細
| エンドポイント | キャンペーンの一般情報を取得 |
|---|---|
| 説明 | 機能強化されたキャンペーン一覧エンドポイントとは異なり、単一キャンペーンの詳細エンドポイントのレスポンスには、常に |
| 認証 | |
| リクエスト |
|
| レスポンス |
null 値と空文字列 JSON レスポンスには以下の両方が含まれます。
|
連携時の推奨事項
-
雇用主のキャンペーンとステータスの一覧クエリの場合:
- ボーナスクレジットキャンペーンをフィルタまたは表示するには、必ず
fieldsパラメータにFundingSourceを含めてください。 - ボーナスクレジットのプレミアムキャンペーンを特定するには、
SponsorshipPlanを含めてください。 - 完全に分類するには、両方の値を含めてください。
- ボーナスクレジットキャンペーンをフィルタまたは表示するには、必ず
-
キャンペーンの一般情報の取得では、両方のフィールドが常に存在します。特別な処理は不要です。
- 通常のキャンペーンを特定するには、
FundingSourceの空文字列("")を確認してください。 - 標準プランのキャンペーンを特定するには、
SponsorshipPlanの空文字列("")を確認してください。
- 通常のキャンペーンを特定するには、
-
ユースケース:
- ボーナスクレジットキャンペーンを個別にフィルタして表示する。
- ボーナスクレジットのプレミアムプランキャンペーンを特定する。
求人ごとの予算の可視化(更新)
-
更新されたエンドポイント:
GET /v1/campaigns(fieldsクエリパラメータでオプトイン)GET /v1/campaigns/{campaignId}/budget(自動)
ボーナスクレジットキャンペーンは、Indeed が求人ごとに日次予算を推奨する日次予算モデルを使用します。従来のキャンペーンは、月またはキャンペーン期間の合計予算を使用します。
-
現在の状態: キャンペーンエンドポイントは
BudgetOnetimeLimit(合計のライフタイム予算)またはBudgetMonthlyLimit(月次予算)を返します。キャンペーンタイプに応じて、該当するフィールドのみが表示されます。 -
新規:
DailyAvgBudgetPerJobフィールドは、ボーナスクレジットキャンペーンにおける求人ごとの平均日次予算を示します。Indeed の最適化システムが、求人選択に基づいて求人ごとの予算を自動的に管理します。この値は読み取り専用です。
| エンドポイント | 雇用主のキャンペーンとステータスの一覧
|
|---|---|
| 説明 | このエンドポイントは、返されるデータを定義する 新規: フィールドが表示される場合:
フィールドが非表示の場合:
主な動作:
|
| 認証 | |
| リクエスト |
|
| レスポンス |
注記 null 値と空文字列 JSON レスポンスには以下の両方が含まれます。
|
求人選択の更新
| エンドポイント | キャンペーンの一般情報を更新 |
|---|---|
| 説明 | ボーナスクレジットキャンペーンの求人選択を更新します。 ボーナスクレジットキャンペーンで許可される更新:
|
| 制限事項 | Indeed がその他のキャンペーン設定( |
| ユースケース | ボーナスクレジットキャンペーンに求人を追加または削除する。 |
連携ワークフロー
1. 前提条件
連携を開始する前に、以下を確認してください。
- Indeed とのアクティブな年間契約があること
- 雇用主スコープで設定された OAuth 2.0 クレデンシャル
- 米国を拠点とする広告主アカウント(初期リリースは米国のみ)
- 広告主アカウントに割り当てられたクレジット(Indeed カスタマーサービスチームが対応)
2. キャンペーン作成プロセス
Indeed が最初にアカウントへボーナスクレジットを割り当てると、自動的にボーナスクレジットキャンペーンが作成されます。
- Indeed がアカウントにボーナスクレジットキャンペーンを作成します。
- キャンペーンは API ですぐに表示できるようになります。
3. クレジット残高をモニタリングする
OAuth の
Bearerトークンを使用してGET /v1/advertisers/{yourAdvertiserId}/creditsを呼び出します。ボーナスクレジットキャンペーンで求人をスポンサーする前。
クレジットが割り当てられたとき。
支出追跡のために毎週または必要に応じて。
ベストプラクティス: 残高をキャッシュし、過度なポーリングを避けてください(呼び出しはレート制限の対象になります)。
4. ボーナスクレジットキャンペーンを特定する
オプション A: 資金源を含めてすべてのキャンペーンを一覧表示する:
どのキャンペーンがボーナスクレジットで資金提供されているかを特定するには、
GET /v1/campaignsを呼び出します。fieldsパラメータにFundingSourceを含めてください。ボーナスクレジットキャンペーンと通常予算キャンペーンを区別するには、
FundingSourceが"Bonus Sponsored Job Credits"と等しいかを確認します。
オプション B: 特定キャンペーンの詳細を取得する:
GET /v1/campaigns/{campaignId}を呼び出します。この呼び出しはレスポンスに自動的に
FundingSourceフィールドを含めます。
5. 求人選択を更新する
求人選択条件を含む JSON 本文で
PATCH /v1/campaigns/{creditCampaignId}を呼び出します。以下のフィールドを更新できます。
jobsToInclude。選択モード (ALLまたはQUERY)。jobsQuery。検索キーワード。
以下のフィールドは更新できません。
- キャンペーン名、ステータス、目的、予算(自動管理)、
jobsTitle、jobsCompany、jobsLocation、jobsLocationRadius。
エラー処理: 制限されたフィールドを更新すると、次のエラーが返されます。
"Only Jobs Query Criteria field update is allowed for campaigns using Bonus Sponsored Job Credits."
6. 予算割り当てを確認する
GET /v1/campaignsを呼び出します。特定のキャンペーンについては、GET /v1/campaigns/{campaignId}/budgetを呼び出します。いずれの呼び出しでも、
fieldsパラメータにDailyAvgBudgetPerJobおよびFundingSourceを含めるよう設定します。呼び出しは次の情報を返します。
キャンペーン全体の予算割り当て。
求人ごとの平均日次予算(ボーナスクレジットキャンペーンの場合)。