日付範囲のキャンペーン統計の取得

GET /v1/campaigns/:campaignId/stats

指定された日付範囲のキャンペーン統計を取得します。日付範囲を指定するには、startDateおよびendDateクエリパラメータを使用します。startDateとendDate間の日付範囲は、1回あたり最長366日に制限されます。

mergeパラメータがfalseに設定されている場合、このエンドポイントは日付範囲内の各日について個別のキャンペーン統計を返します。trueに設定されている場合、日付範囲の統計を集約した単一のエントリーを返します。

startDateとendDateを指定しない場合は、直近30日間のキャンペーン統計が返されます。

注記

リクエストされた日付範囲にキャンペーン統計が存在しない場合、CurrencyCodeはnullに設定されます
リクエストされた日付範囲内に採用企業の通貨が変更された場合、CurrencyCodeはnullに設定されます

OAuthのスコープ	アクセストークンの種類
`employer.advertising.campaign_report.read`	採用企業に紐づいたアクセストークン。

Request

Path Parameters

campaignId stringrequired

キャンペーンID

Query Parameters

startDate date

日付範囲の開始日（範囲にはその日付も含まれます）。YYYY-MM-DDの形式で表します。

endDate date

日付範囲の終了日（範囲にはその日付は含まれません）。YYYY-MM-DDの形式で表します。終了日は、開始日の翌日以降にする必要があります。

start string

YYYY-MM-DD形式で表す開始日です。開始日からのキャンペーン統計のリストが返されます（開始日を含む）。このパラメータの目的はページ付けのみで、その他すべての目的にはstartDateを使用する必要があります。

merge boolean

キャンペーンの統計結果を結合するかどうかを選びます。設定可能な値は、trueとfalseです。デフォルトはfalseです。mergeパラメータがfalseに設定されている場合、このエンドポイントは日付範囲内の各日について個別のキャンペーン統計を返します。trueに設定されている場合、日付範囲の統計を結合した単一のエントリーを返します。

perPage integer

1ページに表示されるエントリーの最大数。後方互換性のためにデフォルト値は10に設定されていますが、ページ付けを回避してパフォーマンスを高めるために、perPage=366 に設定することをお勧めします。

Responses

成功

application/json

Schema
Example (from schema)
merge=false
merge=true

Schema

meta

object

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

status int32

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

errors

object[]

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

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

スポンサー求人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

oneOf

CampaignStatsDaily
CampaignStatsMerged

entries

object[]

Array [

Name string

キャンペーン名

Id string

キャンペーンID

Date date

キャンペーンのトラフィック統計が記録された日付。ISO 8601の形式「YYYY-MM-DD」に従います（日付はすべて米国中部標準時）。

Clicks int32

特定の日のキャンペーンにおけるスポンサークリック数

Impressions int32

特定の日にスポンサー求人キャンペーンを閲覧したユーザーの数

Conversions int32

特定の日に求人キャンペーンの直接クリックから応募につながった数。

OrganicClicks int32

特定の日のキャンペーンにおける無料掲載求人のクリック数。

OrganicImpressions int32

特定の日のキャンペーンにおける無料掲載求人の閲覧数。

CurrencyCode string

採用企業のISO 4217通貨コード。

Cost number

すでに消費された求人のキャンペーン予算の金額。

Applystarts integer

特定の日にスポンサー求人キャンペーンで[応募]ボタンがクリックされた回数。

OrganicApplystarts integer

特定の日のキャンペーンにおける無料掲載求人の応募開始数。

]

{
  "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": {}
}

{
  "meta": {
    "status": 200,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 30,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns/da4d7052916d0c75/stats"
      }
    ]
  },
  "data": {
    "entries": [
      {
        "Name": "Hand model",
        "Id": "da4d7052916d0c75",
        "Date": "2019-02-25",
        "Clicks": 169,
        "Impressions": 2825,
        "Conversions": 2,
        "OrganicClicks": 324,
        "OrganicImpressions": 4242,
        "CurrencyCode": "GBP",
        "Cost": 0.45,
        "Applystarts": 40,
        "OrganicApplystarts": 20
      },
      {
        "Name": "Hand model",
        "Id": "da4d7052916d0c75",
        "Date": "2019-02-26",
        "Clicks": 171,
        "Impressions": 2567,
        "Conversions": 3,
        "OrganicClicks": 567,
        "OrganicImpressions": 4272,
        "CurrencyCode": "GBP",
        "Cost": 0.9,
        "Applystarts": 50,
        "OrganicApplystarts": 10
      }
    ]
  }
}

{
  "meta": {
    "status": 200,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 30,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns/da4d7052916d0c75/stats"
      }
    ]
  },
  "data": {
    "Name": "Hand model",
    "Id": "da4d7052916d0c75",
    "StartDate": "2019-02-25",
    "EndDate": "2019-02-26",
    "Clicks": 169,
    "Impressions": 2825,
    "Conversions": 2,
    "OrganicClicks": 324,
    "OrganicImpressions": 4242,
    "CurrencyCode": "GBP",
    "Cost": 0.45,
    "Applystarts": 40,
    "OrganicApplystarts": 20
  }
}

リクエストパラメータの1つに問題がありました。

application/json

Schema
Example (from schema)
Example

Schema

meta

object

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

status int32

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

errors

object[]

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

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

スポンサー求人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": "END_DATE_BEFORE_START_DATE",
        "description": "End date should not be before start date."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": {
      "rel": "up",
      "href": "/v1/campaigns"
    }
  },
  "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

スポンサー求人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": "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

meta

object

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

status int32

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

errors

object[]

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

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

スポンサー求人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": "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

meta

object

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

status int32

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

errors

object[]

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

Array [

type string

エラーの名前。

description string

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

]

rootLocation string

スポンサー求人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": 404,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "Couldn't locate the requested resource."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": {
      "rel": "up",
      "href": "/v1/campaigns"
    }
  },
  "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

スポンサー求人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": "Failed to process the request."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

日付範囲のキャンペーン統計の取得

Request​

Path Parameters

Query Parameters

Responses​

Schema

Schema

Schema

Schema

Schema

Schema

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

Request

Responses