ATS パートナー向け Sponsored Jobs API スコープ
ATS 専用エンドポイントを含む、Sponsored Jobs エンドポイント向けの OAuth スコープです。
Indeed の API の使用について Indeed と書面による契約を締結していない場合、この API またはそのドキュメントを使用することにより、Indeed の API の使用には Indeed API Terms および Additional API Terms and Guidelines が適用されることに同意したものとみなされます。
キャンペーン予測
| API エンドポイント | OAuth スコープ | アクセストークンの種類 |
|---|---|---|
POST /v1/campaignpredictions | employer_access |
|
オーガニック求人予測
| API エンドポイント | OAuth スコープ | アクセストークンの種類 |
|---|---|---|
POST /v1/organicjobpredictions | employer_access | 任意 |
各 API 呼び出しの OAuth アクセストークンを生成するときは、scope の値を指定する必要があります。
-
書き込みスコープをリクエストすると、対応する読み取り専用スコープの権限も付与されます。
たとえば、
employer.advertising.campaignをリクエストすると、employer.advertising.campaign.readの権限も付与されます。 -
複数のスコープを 1 つの アクセストークン に関連付けることができます。スコープはスペース区切りで指定します。
たとえば
employer_access employer.advertising.campaign employer.advertising.campaign_report.readです。
OAuth の 認可コード リクエストで、呼び出す API エンドポイントに対応するスコープを渡します。
その後、エンドユーザーは、リクエストしたスコープをまったく付与しない、一部だけ付与する、またはすべて付与するかを選択します。
各 API エンドポイントでどのスコープをリクエストするかは、次の表で確認してください。
API クォータ使用量
このエンドポイントでは、employer_access スコープを持つアクセストークンを取得してくださ い。雇用主を表すアクセストークンを取得するをご覧ください。
| API エンドポイント | OAuth スコープ | アクセストークンの種類 |
|---|---|---|
広告主の API アクセスを更新する | employer.advertising.account.read | 雇用主を表すアクセストークン |
アカウント管理
| HTTP メソッド | API エンドポイント | OAuth スコープ | アクセストークンの種類 |
|---|---|---|---|
GET | /v1/account | 採用企業アカウントの場合: |
|
マスターアカウントの場合: |
| ||
GET | /v1/advertisers | employer.advertising.subaccount.read | employer パラメータなし |
GET | /v1/subaccounts | employer.advertising.subaccount.read | employer パラメータなし |
POST | /v1/subaccounts | employer.advertising.subaccount | employer パラメータなし |
GET | /v1/account/budget | employer.advertising.account.read | employer_access スコープあり。雇用主を表すアクセストークンを取得してください。 |
PATCH | /v1/account/budget | employer.advertising.account | employer_access スコープあり。雇用主を表すアクセストークンを取得してください。 |
キャンペーン管理
これらのエンドポイントでは、employer_access スコープを持つアクセストークンを取得してください。雇用主を表すアクセストークンを取得するをご覧ください。
| HTTP メソッド | 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}/properties | employer.advertising.campaign.read |
レポート
これらのエンドポイントでは、employer_access スコープを持つアクセストークンを取得してください。雇用主を表すアクセストークンを取得するをご覧ください。
| HTTP メソッド | API エンドポイント | OAuth スコープ |
|---|---|---|
GET | /v1/campaigns/{campaignId}/stats | employer.advertising.campaign_report.read |
GET | /v1/campaigns/{campaignId}/stats/{date} | employer.advertising.campaign_report.read |
GET | /v1/campaigns/{campaignId}/stats/entryDates | employer.advertising.campaign_report.read |
GET | /v1/stats | employer.advertising.campaign_report.read |
GET | /v1/stats/{reportId} | employer.advertising.campaign_report.read |