- ベース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アカウントのセットアップを完了していません。