採用企業アカウントの一覧を取得

GET 
/v1/advertisers

呼び出し元がアクセスできるすべての採用企業アカウントを返します。会社名、連絡先、および階層メタデータが含まれます。

レスポンスのemployerIdをemployerパラメータとして渡すと、広告主スコープのアクセストークンをリクエストできます。採用企業を表すアクセストークンを取得するを参照してください。

OAuthスコープ	アクセストークンタイプ
employer.advertising.subaccount.read	アカウントスコープのアクセストークン（employerパラメータなし）。2-legged と 3-legged のグラントをサポートします。

Request

Responses

200

成功

application/json

Schema

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

ページネーションされた結果を返すエンドポイントの場合、1ページに返されるエントリの実際の最大数。perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが単一の結果を返すかページネーションしない場合、値はnullです。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

• up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
• next: ページネーションされた結果の次のページ。
• prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data

object

employers

object[]

呼び出し元がアクセスできる採用企業アカウントの一覧です。常に存在し、該当がない場合は空です。

Array [

employerId string

ユニバーサル採用企業キー（広告主ID）です。OAuth tokenエンドポイントのemployerパラメータにこの値を渡すと、広告主スコープのアクセストークンを取得できます。

company string

採用企業アカウントの登録会社名です。

contact string

採用企業アカウントの主要連絡先です。

email stringnullable

採用企業アカウントの主要連絡先メールアドレスです。設定されていない場合は含まれません。

isRoot boolean

trueは、この採用企業アカウントがその階層のルート広告主（サブアカウントが集約される最上位アカウント）であることを示します。falseは、サブアカウントであることを示します。

]

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "リクエストされたリソースが見つかりませんでした"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "employers": [
      {
        "employerId": "fcf363fe1256cf0e81fd6f77df64a6bc",
        "company": "Acme Corp",
        "contact": "Jane Doe",
        "email": "admin@acme.com",
        "isRoot": true
      }
    ]
  }
}

Example

{
  "data": {
    "employers": [
      {
        "email": "admin@acme.com",
        "contact": "Jane Doe",
        "employerId": "fcf363fe1256cf0e81fd6f77df64a6bc",
        "company": "Acme Corp",
        "isRoot": true
      },
      {
        "email": "admin@acme.com",
        "contact": "John Smith",
        "employerId": "d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9",
        "company": "Acme Corp - West",
        "isRoot": false
      }
    ]
  },
  "meta": {
    "status": 200,
    "rootLocation": "https://apis.indeed.com/ads",
    "links": [
      {
        "rel": "up",
        "href": "/v1/account"
      }
    ]
  }
}

401

リクエストに有効なアクセストークンが含まれていませんでした:

• Authorizationヘッダーが欠落しているか不正な形式でした。HTTPのAuthorizationヘッダーにアクセストークンを含め、値の前にBearerという単語とスペースを付けてください。例えば、アクセストークンがXYZの場合、リクエストにはAuthorization: Bearer XYZヘッダーを含める必要があります。

• アクセストークンの形式が不正でした。HTTPリクエストを手動で構築してAPIをテストしている場合、リクエストにコピーする際にアクセストークンの先頭または末尾の文字を省略したり余分な文字を含めたりしていないか確認してください。

• アクセストークンが期限切れです。アクセストークンは1時間（3,600秒）のみ有効です。その後、クライアント資格情報（2-legged OAuth）またはリフレッシュトークン（3-legged OAuth）を使用して別のアクセストークンを取得する必要があります。

application/json

Schema

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

ページネーションされた結果を返すエンドポイントの場合、1ページに返されるエントリの実際の最大数。perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが単一の結果を返すかページネーションしない場合、値はnullです。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

• up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
• next: ページネーションされた結果の次のページ。
• prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "リクエストされたリソースが見つかりませんでした"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "OAuth アクセストークンが無効です。"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

403

このAPIで使用できない有効なアクセストークンです。詳細については、meta.errorsで返されるエラーを確認してください。

エラータイプ	意味と一般的な原因
INSUFFICIENT_SCOPE	アクセストークンには、このAPIエンドポイントに必要なOAuth v2トークンスコープがありません。一般的な原因については、FAQとトラブルシューティングを参照してください。
EMPLOYER_ACCESS_TOKEN_NOT_ALLOWED	このAPIエンドポイントは採用企業を表すアクセストークンではアクセスできません。これは以下の理由による場合があります: この操作のアクセストークンをリクエストする際に、employerパラメータを省略する必要があります。現在、このエラーはGET /v1/subaccountsとPOST /v1/subaccountsからのみ返されます。 最新のAPIエンドポイントではなく、レガシーSponsored Jobs APIエンドポイントを呼び出しています。最新のエンドポイント（ https://apis.indeed.com/ads ）を使用してください。
LEGACY_ACCESS_TOKEN_NOT_ALLOWED	Sponsored Jobs APIはレガシーOAuthエンドポイントから取得したアクセストークンをサポートしなくなりました。更新されたエンドポイントについては、IndeedとAPIの統合と呼び出しを参照してください。

application/json

Schema

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

ページネーションされた結果を返すエンドポイントの場合、1ページに返されるエントリの実際の最大数。perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが単一の結果を返すかページネーションしない場合、値はnullです。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

• up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
• next: ページネーションされた結果の次のページ。
• prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "リクエストされたリソースが見つかりませんでした"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 403,
    "errors": [
      {
        "type": "INSUFFICIENT_SCOPE",
        "description": "アクセストークンにはこの API にアクセスする権限がありません。"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

500

予期しないエラーが発生しました。問題は一時的な場合があり、まったく同じリクエストを再試行すると成功する場合があります。

リクエストの再試行が役立たない場合は、リクエストの解析に問題が発生した可能性があります。必要なすべてのパラメータが存在し、すべてのパラメータが正しくフォーマットされていることを確認してください。

クライアント資格情報グラントタイプ（2-legged OAuth）で取得したアクセストークンをレガシーSponsored Jobs APIエンドポイントで使用した場合、INTERNAL_SERVER_ERRORエラーが発生します。最新のベースURL（https://apis.indeed.com/ads）を使用してください。

application/json

Schema

Schema

meta

object

レスポンス関連のメタデータ。

status int32

レスポンスのHTTPステータスコード。

errors

object[]

リクエストの正常な処理を妨げたエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

問題の人間が読める説明。

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

ページネーションされた結果を返すエンドポイントの場合、1ページに返されるエントリの実際の最大数。perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが単一の結果を返すかページネーションしない場合、値はnullです。

links

object[]

リクエストされたリソースに関連するリソース。

Array [

rel string

リクエストされたリソースと関連リソースの関係。一般的に使用される値:

• up: 関連リソースは、リクエストされたリソースを含むコレクション、またはリクエストされたリソースが関連付けられているエンティティです。
• next: ページネーションされた結果の次のページ。
• prev: ページネーションされた結果の前のページ。

ただし、値はCampaign Infoなどの関係を説明する任意の文字列の場合もあります。

href string

関連リソースのエンドポイントURL。クエリ文字列パラメータを含む場合があります。完全なURLを取得するには、hrefをrootLocationに追加します。

]

data object

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "リクエストされたリソースが見つかりませんでした"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

Example

{
  "meta": {
    "status": 500,
    "errors": [
      {
        "type": "INTERNAL_SERVER_ERROR",
        "description": "リクエストを処理できませんでした。"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

Loading...

 

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