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

GET /v1/campaigns/:campaignId/stats

日付範囲のキャンペーン統計を取得します。startDateとendDateクエリパラメータを使用して日付範囲を指定します。startDateとendDate間の日付範囲は一度に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形式。終了日は開始日の少なくとも1日後である必要があります。

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

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

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

その日にキャンペーンが獲得した無償応募開始数。

]

Name string

キャンペーン名。

Id string

キャンペーンID。

StartDate date

集計されたキャンペーントラフィック統計の開始日。米国中部時間のISO 8601のYYYY-MM-DD形式に従います。

EndDate 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
  }
}

リクエストパラメータが無効です。

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

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

]

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ヘッダーが欠落しているか不正な形式でした。HTTPのAuthorizationヘッダーにアクセストークンを含め、値の前にBearerという単語とスペースを付けてください。例えば、アクセストークンがXYZの場合、リクエストにはAuthorization: Bearer XYZヘッダーを含める必要があります。
アクセストークンの形式が不正でした。HTTPリクエストを手動で構築してAPIをテストしている場合、リクエストにコピーする際にアクセストークンの先頭または末尾の文字を省略したり余分な文字を含めたりしていないか確認してください。
アクセストークンが期限切れです。アクセストークンは1時間（3,600秒）のみ有効です。その後、クライアント資格情報（2-legged OAuth）またはリフレッシュトークン（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

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

]

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エンドポイントに必要なOAuth v2トークンスコープがありません。一般的な原因については、FAQとトラブルシューティングを参照してください。
`NOT_EMPLOYER_ACCESS_TOKEN`	このエンドポイントには、採用企業を表すアクセストークンが必要です。採用企業を表すアクセストークンを取得するを参照してください。つまり、アクセストークンをリクエストする際に`employer`パラメータを指定する必要があります。Sponsored Jobs APIエンドポイントの大部分でこれが必要です。
`LEGACY_ACCESS_TOKEN_NOT_ALLOWED`	Sponsored Jobs APIはレガシーOAuthエンドポイントから取得したアクセストークンをサポートしなくなりました。更新されたエンドポイントについては、IndeedとAPIの統合と呼び出しを参照してください。

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

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

]

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

Sponsored Jobs APIのベースURL。

perPage int32

links

object[]

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

Array [

rel string

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

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

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

href string

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

]

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
}

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

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

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

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

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

]

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