キャンペーンの詳細なトラフィックレポートを取得
GET/v1/stats/:reportId
レポートを取得するには、 GET /v1/statsによって返されるレポートURLに対してGETリクエストを実行します。例：
https://apis.indeed.com/ads/v1/stats/68dd7bee34c4846dfea43875405836?v=6応答が 202の場合、後でもう一度確認してください。
応答が 200の場合は、応答本体にCSV形式のレポートが含まれています。
バージョン6レポートの例
Campaign ID,Advertisement,Job,Job Reference Number,Platform,Clicks,Impressions,Conversions,Indeed Apply Conversions,Spend (currency),Organic Clicks,Organic Impressions,Apply Starts,Organic Apply Startsecc0e827cc1650c1,"Hand Model",D6US908,mobile,4.0,233,1.0,1,3.43(USD),3,5,2,4| OAuthのスコープ | アクセストークンの種類 |
|---|---|
employer.advertising.campaign_report.read | 採用企業に紐づいたアクセストークン。 |
Request
Path Parameters
v1/statsリソースがロケーションヘッダーで返すレポートのID。
Query Parameters
Possible values: [1, 5, 6]
Default value: 1
レポートのバージョン。
「1」- 旧バージョン1
「5」- レポートバージョン。[キャンペーンID]、[オーガニック指標]を含む
「6」- 推奨レポートバージョン。[キャンペーンID]、[オーガニック指標]、[応募開始数]を含む
Responses
- 202
- 401
- 403
- 500
受付完了
Response Headers
Location
string
レポートへのパス
次の理由で、リクエストに有効なアクセストークンが含まれていませんでした。
Authorizationヘッダーが存在しない、または形式に誤りがあった。必ずAuthorizationHTTPヘッダーでアクセストークンを送信し、値のヘッダーにBearerというワードとスペースを使用してください。たとえば、アクセストークンがXYZならば、リクエストにはAuthorization: Bearer XYZというヘッダーを含める必要があります。- アクセストークンの形式に誤りがあった。HTTPリクエストを手動で作成してAPIをテストしている場合は、リクエストにアクセストークンをコピーする際に、アクセストークンの先頭や末尾の文字を誤って削除したり、余分な文字を含めたりしていないことを確認してください。
- アクセストークンが期限切れになっている。アクセストークンは1時間（3,600秒）のみ有効です。期限が切れた後は、リフレッシュトークン（3-legged OAuth）を使用して別のアクセストークンを取得する必要があります。
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Array [
up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。next：ページ付けされた結果内で次のエントリーのページ。prev：ページ付けされた結果内で前のエントリーのページ。]
meta
object
応答に関連するメタデータ。
常に応答のHTTPステータスコードと等しい値。
errors
object[]
リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。
エラーの名前。
人間が読める形式での問題の説明。
スポンサー求人APIのベースURL。
ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。
links
object[]
リクエストされたリソースに関連するリソース。
リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。
ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。
関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。
{ "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": "Invalid OAuth access token." } ], "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パラメータを指定する必要があります。スポンサー求人APIエンドポイントの大部分において、こういったパラメータ指定が必要です。 |
LEGACY_ACCESS_TOKEN_NOT_ALLOWED | スポンサー求人APIは、旧バージョンのOAuthエンドポイントを使用して取得されたアクセストークンを現在はサポートしていません。更新されたエンドポイントについては、最新の「Authorization Guide」（認証ガイド）を確認してください。 |
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Array [
up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。next：ページ付けされた結果内で次のエントリーのページ。prev：ページ付けされた結果内で前のエントリーのページ。]
meta
object
応答に関連するメタデータ。
常に応答のHTTPステータスコードと等しい値。
errors
object[]
リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。
エラーの名前。
人間が読める形式での問題の説明。
スポンサー求人APIのベースURL。
ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。
links
object[]
リクエストされたリソースに関連するリソース。
リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。
ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。
関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。
{ "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": "Access token does not have permission to access this API." } ], "rootLocation": "https://apis.indeed.com/ads", "perPage": null, "links": null }, "data": null}予期しないエラーを示しています。これは一時的な問題の場合があり、まったく同じリクエストをもう一度試すと成功する可能性があります。
リクエストをもう一度試しても解決しない場合は、リクエストの解析に問題があることが考えられます。必要なパラメータがすべて指定されており、すべてのパラメータの形式が正しいことを確認してください。
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Array [
up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。next：ページ付けされた結果内で次のエントリーのページ。prev：ページ付けされた結果内で前のエントリーのページ。]
meta
object
応答に関連するメタデータ。
常に応答のHTTPステータスコード と等しい値。
errors
object[]
リクエストを正常に処理できない原因となったエラー。エラーがなかった場合、値はnullです。
エラーの名前。
人間が読める形式での問題の説明。
スポンサー求人APIのベースURL。
ページ付けされた結果を返すエンドポイントの場合、1つのページに返される実質的な最大エントリー数。この値は、perPageパラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。
links
object[]
リクエストされたリソースに関連するリソース。
リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。
ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります 。
関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。
{ "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": "Failed to process the request." } ], "rootLocation": "https://apis.indeed.com/ads", "perPage": null, "links": null }, "data": null}