ダイレクト連携向けスポンサー求人APIスコープ

スポンサー求人のエンドポイント向けOAuthスコープのリファレンスです。

 

法的注意

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

アクセストークンを取得するときは、少なくとも 1 つのスコープをリクエストする必要があります。

• 書き込みスコープには、対応する読み取り専用スコープが含まれます。たとえば、employer.advertising.campaign には employer.advertising.campaign.read も含まれます。
• 1 つのアクセストークンに複数のスコープをリクエストできます。用語集をご覧ください。スコープはスペースで区切って指定します。例: employer_access employer.advertising.campaign employer.advertising.campaign_report.read

OAuth 認可コードリクエストでは、呼び出す API エンドポイントに必要なスコープを含めます。エンドユーザーは、そのスコープの一部、すべて、またはどれも付与しないことができます。用語集をご覧ください。

各APIエンドポイントに適したスコープは、次の表で確認してください。

APIクォータ使用量

APIクォータ使用量のスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
広告主のAPIクォータ使用量を取得する GET /v1/apiquotausage	employer.advertising.account.read	採用企業を表すアクセストークン

APIアクセス

APIアクセスのスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
広告主のAPIアクセスを更新する PATCH /v1/account/apiaccess	employer.advertising.account	採用企業を表すアクセストークン

アカウント管理

アカウント管理のスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
採用企業の Indeed 広告主アカウント情報を取得する GET /v1/account	employer.advertising.account.read	採用企業を表すアクセストークン
広告主サブアカウントを一覧表示する GET /v1/advertisers	employer.advertising.subaccount.read	employerパラメータなしのアクセストークン
広告主サブアカウントを作成する POST /v1/subaccounts	employer.advertising.subaccount	employerパラメータなしのアクセストークン
月間求人予算を取得する GET /v1/account/budget	employer.advertising.account.read	採用企業を表すアクセストークン
月間求人予算を更新する PATCH /v1/account/budget	employer.advertising.account	採用企業を表すアクセストークン
採用企業アカウントを一覧表示する GET /v1/advertisers	employer.advertising.subaccount.read	employerパラメータなしのアクセストークン。2-leggedと3-leggedの両方のグラントに対応します。
クレジットの割り当てと残高を取得する GET /v1/advertisers/credits	employer.advertising.account.read	採用企業を表すアクセストークン

キャンペーン管理

これらのエンドポイントでは、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/jobDetails	employer.advertising.campaign.read	採用企業を表すアクセストークン
採用企業のキャンペーンの主要な日付を取得する GET /v1/campaigns/:campaignId/properties	employer.advertising.campaign.read	採用企業を表すアクセストークン

レポート

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

レポートのスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
期間を指定してキャンペーンの統計を取得する GET /v1/campaigns/:campaignId/stats	employer.advertising.campaign_report.read	採用企業を表すアクセストークン

詳細レポート

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

詳細レポートのスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
期間を指定してキャンペーン別・求人別のトラフィックレポートを取得する GET /v1/stats	employer.advertising.campaign_report.read	採用企業を表すアクセストークン
キャンペーンの詳細トラフィックレポートを取得する GET /v1/stats/:reportId	employer.advertising.campaign_report.read	採用企業を表すアクセストークン

キャンペーン予測

キャンペーン予測のスコープ

APIエンドポイント	OAuthスコープ	アクセストークンの種類
キャンペーン予測を取得する POST /v1/campaignpredictions	employer_access	採用企業を表すアクセストークン

 

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