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	employer_access スコープ付き。雇用主を表すアクセストークンの取得をご覧ください。

オーガニック求人予測

オーガニック求人予測のスコープ

API エンドポイント	OAuth スコープ	アクセストークンの種類
POST /v1/organicjobpredictions	employer_access	任意

各 API 呼び出しの auth token を生成するときは、scope 値が必要です。

• 書き込み scope をリクエストすると、対応する読み取り専用 scope の権限も付与されます。

  たとえば、employer.advertising.campaign をリクエストすると、employer.advertising.campaign.read の権限も付与されます。

• 複数の scope を 1 つの access token に関連付けることができます。scope はスペース区切りで指定します。

  たとえば employer_access employer.advertising.campaign employer.advertising.campaign_report.read です。

OAuth の authorization code リクエストで、呼び出す API endpoint に対応する scope を渡します。

その後、エンドユーザーは、リクエストした scope を付与しない、一部だけ付与する、またはすべて付与するかを選択します。

各 API endpoint でどの scope をリクエストするかは、次の表で確認してください。

API quota usage

この endpoint では、employer_access scope を持つ access token を取得します。採用企業を表す access token を取得するをご覧ください。

API quota usage

Verb	API endpoint	OAuth scope
GET	/v1/apiquotausage	employer.advertising.account.read

アカウント管理

アカウント管理スコープ

Verb	API endpoint	OAuth scope	Access token type
GET	/v1/account	採用企業アカウントの場合: employer.advertising.account.read	employer_access scope あり。採用企業を表す access token を取得するをご覧ください。
		マスターアカウントの場合: employer.advertising.subaccount.read	employer parameter なし
GET	/v1/advertisers	employer.advertising.subaccount.read	employer parameter なし
GET	/v1/subaccounts	employer.advertising.subaccount.read	employer parameter なし
POST	/v1/subaccounts	employer.advertising.subaccount	employer parameter なし
GET	/v1/account/budget	employer.advertising.account.read	employer_access scope あり。採用企業を表す access token を取得するをご覧ください。
PATCH	/v1/account/budget	employer.advertising.account	employer_access scope あり。採用企業を表す access token を取得するをご覧ください。

キャンペーン管理

これらの endpoint では、employer_access scope を持つ access token を取得します。採用企業を表す access token を取得するをご覧ください。

キャンペーン管理スコープ

Verb	API endpoint	OAuth scope
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

レポート

これらの endpoint では、employer_access scope を持つ access token を取得します。採用企業を表す access token を取得するをご覧ください。

レポートスコープ

Verb	API endpoint	OAuth scope
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

 

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