- ベースURL
- エンドポイント
- 公開エンドポイント
- プライベートエンドポイント
- OAuthスコープ
- キャンペ ーン予測
- オーガニック求人予測
- 認可エラーを処理する
- 推奨ベストプラクティス
- アカウント管理
- キャンペーン管理
- キャンペーンの予算見積もりを取得する
- キャンペーンを作成する
- キャンペーンの基本情報を更新する
- キャンペーンの予算と期間を取得する
- キャンペーンの予算と期間を更新する
- レポート
- 期間を指定してキャンペーンの統計を取得する
- キャンペーン予測を取得する
- リクエストボディ
- CampaignPredictions
- JobInfo
- CampaignInfo
- PredictionsInfo
- レスポンス
- JobLevelPredictions
- 求人の詳細
- Prediction
- オーガニック求人のパフォーマンスと予測を取得する
- オーガニック求人のパフォーマンスと予測のリクエスト
- OrganicjobPredictionフィールド
- JobInfoフィールド
- オーガニック求人のパフォーマンスと予測のレスポンス
- OrganicMetricフィールド
- OrganicPredictionフィールド
- SponsoredPredictionフィールド
ATSパートナー向けスポンサー求人APIガイド
キャンペーンの予測やオーガニック求人のパフォーマンスと予測など、プライベートエンドポイントにアクセスします。
Indeed の API の使用について Indeed と書面による契約を締結していない場合、この API またはそのドキュメントを使用することにより、Indeed の API の使用には Indeed API Terms (新しいウィンドウで開きます) および Additional API Terms and Guidelines が適用されることに同意したものとみなされます。
ここに記載する技術的な詳細は、ATSパートナー向けスポンサー求人APIリファレンスを補足するものであり、連携で使用できるエンドポイントを説明します。一部のエンドポイントは公開されています。それ以外はプライベートで、ATSパートナーのみが使用できます。
ベースURL
ATSパートナーは、次のベースURLでAPIにアクセスします。
|
エンドポイント
公開エンドポイント
ATSパートナー向けスポンサー求人APIリファレンスでは、次のエンドポイントを説明しています。
エンドポイントが広告代理店向けと直接の採用企業向けの両方の利用方法に対応している場合は、直接の採用企業向けの方法を使用してください。
プライベートエンドポイント
次のエンドポイントは、このプログラム向けにセットアップされたATSパートナーのみが使用できます。
OAuthスコープ
OAuth認可コードリクエストでは、呼び出すエンドポイントのスコープを渡します。エンドユーザーは、それらのスコープをまったく付与しない、一部だけ付与する、またはすべて付与できます。各エンドポイントのスコープは、次の表で確認してください。
キャンペーン予測
| APIエンドポイント | OAuthスコープ | アクセストークンの種類 |
|---|---|---|
POST /v1/campaignpredictions | employer_access | employer_accessスコープ付き。採用企業を表すアクセストークンを取得するをご覧ください。 |
オーガニック求人予測
| APIエンドポイント | OAuthスコープ | アクセストークンの種類 |
|---|---|---|
POST /v1/organicjobpredictions | employer_access | 任意 |
認可エラーを処理する
ユーザーがリクエストしたスコープにアクセスできない場合、またはアプリを認可しない場合に発生するエラーを処理してください。付与されたスコープを確認するには、アクセストークンレスポンスのscopeフィールドを確認します。
エラーコードは次のとおりです。
| エラーコード | 説明 |
|---|---|
403 INSUFFICIENT_SCOPE | アクセストークンは有効ですが、必要なスコープが付与されていません。 |
401 INVALID_TOKEN | アクセストークンがない、無効である、または期限切れです。 |
これらのエラーの対処方法については、推奨ベストプラクティスをご覧ください。ユーザーにOAuth認可コードグラントを再度実行させて、より多くのスコープを認可してもらうこともできますが、一部のユーザーは権限が制限されているため、リクエストしたすべてのスコープを認可できません。
アプリにリクエストしたすべてのスコープが付与されない場合は、制限付きの機能セットで動作できるようにしてください。
推奨ベストプラクティス
APIは結果整合性です。POST /v1/campaignsでキャンペーンを作成した後、短時間GET /v1/campaigns/{campaignId}がそのキャンペーンを返さないことがあります。作成または変更の直後にリソースをリクエストする場合は、再試行の仕組みを追加してください。
API利用上の問題を検知するために、4XXレスポ ンスを監視してください。OAuthスコープを使用すると、401 INVALID_TOKENや403 INSUFFICIENT_SCOPEエラーが発生することがあります。
5XXレスポンスは通常、一時的な内部サービスの問題です。少し待ってから再試行してください。エラーが解消しない場合は、marketplacesupport@indeed.comにメールでお問い合わせください。
リクエストパスに/adsが付いていない場合、レスポンスはIndeedがリクエストをスポンサー求人APIにルーティングできなかったことを示します。たとえば、https://apis.indeed.com/v1/accountではなくhttps://apis.indeed.com/ads/v1/accountを使用します。
アカウント管理
| メソッド | エンドポイント | 参照 |
|---|---|---|
GET | /v1/account | 採用企業のIndeed広告アカウント情報を取得する |
このエンドポイントを使用して、採用企業の基本情報を取得します。
次のレスポンスは、採用企業が採用企業アカウントをセットアップするを完了する必要があることを示します。
-
400 NOT_EMPLOYER_ACCOUNTは、ユーザーがIndeedの採用企業アカウントを持っていないことを示します。 -
billingActiveがfalseの場合、ユーザーは求人をスポンサーするために必要なIndeedアカウントのセットアップを完了していません。レスポンスに請求ステータスを含めるには、
fields=id,email,contact,company,jobSourceList,billingActiveを渡します。
キャンペーン管理
採用企業のキャンペーンは、採用企業がIndeed Analytics (新しいウィンドウで開きます)ダッシュボードで管理する内容と一致します。すべての求人キャンペーンには、784e4acec9x100z2のような一意のIDがあります。
次のエンドポイントを使用します。
キャンペーンの予算見積もりを取得する
採用企業が平均日予算(ADB)キャンペーンを作成する前に、このエンドポイントを使用して、求人ごとの推奨日予算とキャンペーン単位の平均日予算を取得します。
| メソッド | エンドポイント | 参照 |
|---|---|---|
POST |
| キャンペーンの予算見積もりを取得する |
レスポンスには、スポンサープランの平均予算見積もり、一致した各求人の見積もり、STANDARDおよびPREMIUMティアの推奨が含まれます。
推奨日予算は目標であり、保証ではありません。Indeedはこの金額に近づくよう最適化しますが、日々の消化額は変動します。たとえば、平均日予算が$25の場合、1日目は$20、2日目は$30になることがあります。
このエンドポイントへの呼び出しは、スポンサー求人APIの利用ポリシーの対象として課金されません。
- 新しい求人を掲載してから2〜3時間待ってから、キャンペーンを作成してください。
- 予算推奨の呼び出しから1時間以内にキャンペーンを作成してください。それ以降は市場状況が変わる可能性があり、キャンペーン作成時には最新の推奨予算が使用されます。
- 手動で追加された求人、およびクエリベースの求人解決によって自動的に追加された求人は、推奨予算がデフォルトの日次消化額として使用されます。
リクエスト:
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カスタマーサポートにお問い合わせください。 - キャンペーンが求人をスポンサーするには、採用企業アカウントに有効な請求情報 (新しいウィンドウで開きます)が登録されている必要があります。
| メソッド | エンドポイント | 参照 |
|---|---|---|
POST |
| キャンペーンを作成する |
このエンドポイントを使用してキャンペーンを作成します。このエンドポイントは新しいキャンペーンのIDを返します。このキャンペーンIDを保存し、キャンペーンの変更やレポート取得に使用してください。
キャンペーンを作成するときは、採用企業が選択した予算と期間を設定します。採用企業のデフォルト通貨を使用してください。
- 最小予算と最小期間は、それぞれ$50と7日間です。
- 各求人には、XMLフィードの一意の参照番号を使用します。
- 日付は
YYYY-MM-DD形式で、米国中部時間で指定します。
キャンペーンを作成するには、これらのパラメータを設定する
| フィールド | 説明 |
|---|---|
jobsToInclude | 常に |
jobsQuery |
例:
|
jobsSourceName | この求人のソースまたは会社です。XML求人フィードにある求人の 例:
|
採用企業が月次キャンペーンを選択した場合
月次の定期キャンペーンは暦月に従います。
| フィールド | 説明 |
|---|---|
budgetMonthlyLimit | 予算額。 |
budgetFirstMonthBehavior |
|
採用企業が固定期間キャンペーンを選択した場合
| フィールド | 説明 |
|---|---|
budgetOnetimeLimit | 予算額。 |
startDate | キャンペーンの開始日です。YYYY-MM-DD形式、米国中部時間で指定します。デフォルトは当日です。 |
| キャンペーンの終了日です。
|
キャンペーンの基本情報を更新する
| メソッド | エンドポイント | 参照 |
|---|---|---|
PATCH | /v1/campaigns/{campaignId} | キャンペーンの基本情報を更新する |