Sponsored Jobs APIスコープ
Sponsored Jobsエンドポイント用のOAuthスコープリファレンス。
ユーザーは Indeed のAPIまたはそのドキュメントを使用することにより、本APIの使用に関する Indeed との書面による同意がない限り、Indeed のAPIの使用に Indeed API規約と追加API規約およびガイドラインが適用されることに同意したことになります。
スコープ値は、各API呼び出しの認証トークンを生成するときに必要です。
-
書き込みスコープをリクエストすると、対応する読み取り専用スコープのアクセス許可も付与されます。
たとえば、
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スコープ |
|---|---|---|
GET | /v1/apiquotausage | employer.advertising.account.read |
アカウント管理
| 動詞 | APIエンドポイント | OAuthスコープ | アクセストークンの種類 |
|---|---|---|---|
GET | /v1/account | 採用企業アカウントの場合： |
|
マスターアカウントの場合： |
| ||
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スコープのアクセストークンを取得します。採用企業を代表するアクセストークンを取得するをご覧ください。
| 動詞 | 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スコープのアクセストークンを取得します。採用企業を代表するアクセストークンを取得するをご覧ください。
| 動詞 | 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 |