指定の日付範囲について、キャンペーンと求人ごとの詳細なトラフィックレポートをリクエストする

GET /v1/stats

詳細レポートへのリンクを取得します。求人単位の詳細レポートは日単位でのみリクエストできます。ただし、レポート ID は再利用できます。同じレポート ID を使用すると、データが利用可能になり次第、API は更新されたデータを返します。この方式により、その日のレポート ID をすでに持っている場合は新しいレポート ID を生成する必要がなくなり、呼び出し回数を削減できます。

リクエストが成功すると、HTTP 202 ACCEPTED ステータスコードと、CSV 形式レポートへのパスを含む Location ヘッダーが返されます。レポートのパスでは GET /v1/stats/{reportId} リソースを使用します。詳しくは、このリソースをご覧ください。

Request

Query Parameters

startDate daterequired

キャンペーンのトラフィックレポートの開始日（開始日を含む）。「YYYY-MM-DD」形式を使用します。

endDate daterequired

キャンペーンのトラフィックレポートの終了日（その日付は含まれません）。YYYY-MM-DDの形式で表します。開始日のちょうど1日後にする必要があります。

v string

Possible values: [1, 5, 6, 7, 8]

Default value: 1

レポートのバージョン。
1 - 従来のバージョン 1。
5 - Campaign ID 列と Organic Metric 列を含むレポートバージョン。
6 - 推奨レポートバージョン。Campaign ID 列、Organic Metric 列、ApplyStarts 列を含みます。
7 - 推奨レポートバージョン。Campaign ID 列、Organic Metric 列、ApplyStarts 列、Organic Conversions 列を含みます。
8 - 推奨レポートバージョン。Campaign ID 列、Organic Metric 列、ApplyStarts 列、Organic Conversions 列、Employer Job ID (IRI) 列、Employer Job ID (UUID) 列を含みます。

Responses

受付完了

application/json

Schema
Example (from schema)
Example

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

links

object[]

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

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

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

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

href string

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

]

data

object

location string

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "location": "/v1/stats/fef5d7f5f8e?v=6"
  }
}

{
  "meta": {
    "status": 202,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": {
    "location": "/v1/stats/fef5d7f5f8e?v=5"
  }
}

無効なリクエスト

application/json

Schema
Example (from schema)
Example

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

links

object[]

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

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

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

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

href string

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "1 回のリクエストで指定できるのは 1 日分のみです。"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

次の理由で、リクエストに有効なアクセストークンが含まれていませんでした。

Authorizationヘッダーが存在しない、または形式に誤りがあった。必ずAuthorizationHTTPヘッダーでアクセストークンを送信し、値のヘッダーにBearerというワードとスペースを使用してください。たとえば、アクセストークンがXYZならば、リクエストにはAuthorization: Bearer XYZ というヘッダーを含める必要があります。
アクセストークンの形式に誤りがあった。HTTPリクエストを手動で作成してAPIをテストしている場合は、リクエストにアクセストークンをコピーする際に、アクセストークンの先頭や末尾の文字を誤って削除したり、余分な文字を含めたりしていないことを確認してください。
アクセストークンが期限切れになっている。アクセストークンは1時間（3,600秒）のみ有効です。期限が切れた後は、リフレッシュトークン（3-legged OAuth）を使用して別のアクセストークンを取得する必要があります。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

links

object[]

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

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

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

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

href string

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

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

アクセストークンは有効でしたが、この APIでは使用できません。詳しくは、 meta.errors で返されるエラーを調べてください。

エラーのタイプ	意味とよくある原因
`INSUFFICIENT_SCOPE`	この API エンドポイントに必要なスコープがアクセストークンに設定されていませんでした。よくある原因については、「Troubleshooting Guide」（トラブルシューティングガイド）をご覧ください。
`NOT_EMPLOYER_ACCESS_TOKEN`	このエンドポイントには、採用企業を表すアクセストークンが必要です。つまり、アクセストークンをリクエストする際には、`employer`パラメータを指定する必要があります。Sponsored Jobs APIエンドポイントの大部分において、こういったパラメータ指定が必要です。
`LEGACY_ACCESS_TOKEN_NOT_ALLOWED`	Sponsored Jobs APIは、旧バージョンのOAuthエンドポイントを使用して取得されたアクセストークンを現在はサポートしていません。更新されたエンドポイントについては、最新の「Authorization Guide」（認証ガイド）を確認してください。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

links

object[]

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

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

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

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

href string

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

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

予期しないエラーを示しています。これは一時的な問題の場合があり、まったく同じリクエストをもう一度試すと成功する可能性があります。

リクエストをもう一度試しても解決しない場合は、リクエストの解析に問題があることが考えられます。必要なパラメータがすべて指定されており、すべてのパラメータの形式が正しいことを確認してください。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

応答に関連するメタデータ。

status int32

常に応答のHTTPステータスコードと等しい値。

errors

object[]

リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

Sponsored Jobs API のベース URL。

perPage int32

links

object[]

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

Array [

rel string

リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

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

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

href string

]

data object

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

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

指定の日付範囲について、キャンペーンと求人ごとの詳細なトラフィックレポートをリクエストする

Request​

Query Parameters

Responses​

Schema

Schema

Schema

Schema

Schema

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

Request

Responses