キャンペーンの予算と期間を取得

GET /v1/campaigns/:campaignId/budget

キャンペーンの予算と期間を取得します。

employer.advertising.campaign.read OAuthスコープをリクエストして、採用企業を表すアクセストークンを取得します。採用企業を表すアクセストークンを取得するを参照してください。

OAuthスコープ	アクセストークンタイプ
`employer.advertising.campaign.read`	採用企業を表すアクセストークン。採用企業を表すアクセストークンを取得するを参照してください。

Request

Path Parameters

campaignId stringrequired

キャンペーンID。

Responses

成功

application/json

Schema
Example (from schema)
One-time budget
Monthly recurring budget
Daily Average Budget Per Job

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

budgetOnetimeLimit number

キャンペーンの一括予算上限。budgetOnetimeLimitとbudgetMonthlyLimitを同時に設定することはできません。

budgetMonthlyLimit number

キャンペーンの月次予算上限。dailyAvgBudgetPerJob、budgetOnetimeLimit、budgetMonthlyLimitを同時に設定することはできません。

dailyAvgBudgetPerJob number

キャンペーンの各求人の1日平均予算。平均日次予算（ADB）モデルを使用するキャンペーンにのみ返されます。dailyAvgBudgetPerJobとbudgetMonthlyLimitを同時に設定することはできません。

startDate date

キャンペーンが求人のスポンサーを開始する日付。ISO 8601のYYYY-MM-DD形式。デフォルトは現在の日付です。

キャンペーンは指定された日付の米国中部時間（CT、US/Central）の開始時に求人のスポンサーを開始します。開始日はCTの現在日付以降です。例えば、startDateが2021-01-15の場合、キャンペーンは2021年1月15日の午前0:00 CTにスポンサーを開始します。開始日が指定されていないか現在の日付の場合、キャンペーンはすぐにスポンサーを開始します。

キャンペーンがアクティブで支出中の場合、startDateを更新できません。キャンペーンを一時的に一時停止する場合は、statusをPAUSEDに設定します。

fixedEndDate date

残りの未使用予算があっても、キャンペーンが求人のスポンサーを停止しなければならない日付。ISO 8601のYYYY-MM-DD形式に従います。

一括予算（budgetOnetimeLimit）を持つキャンペーンには、常にfixedEndDateまたはtargetEndDateのいずれか1つが必要ですが、両方は指定できません。

月次定期予算（budgetMonthlyLimit）を持つキャンペーンには、オプションでfixedEndDateを設定できます。月次定期キャンペーンは、手動で一時停止または削除するまで求人のスポンサーを続けます。これらは「エバーグリーン」キャンペーンと呼ばれます。指定された日の開始時にキャンペーンを停止するには、fixedEndDateを指定します。

キャンペーンは指定された日付の米国中部時間（CT、US/Central）の開始時に求人のスポンサーを停止します。fixedEndDateはCTの現在日付から少なくとも1日後、またはキャンペーンがある場合はキャンペーンのstartDateから少なくとも1日後です。例えば、固定終了日が2021-06-20の場合、キャンペーンは2021年6月20日の午前0:00 CTに停止します。

targetEndDate date

キャンペーンが求人のスポンサーを停止すべき日付ですが、予算全体をまだ使い切っていない場合は指定日を過ぎてもスポンサーを続ける場合があります。ISO 8601のYYYY-MM-DD形式に従います。

一括予算（budgetOnetimeLimit）を持つキャンペーンには、常にfixedEndDateまたはtargetEndDateのいずれか1つが必要ですが、両方は指定できません。月次定期予算（budgetMonthlyLimit）を持つキャンペーンにはtargetEndDateを設定できず、fixedEndDateまたは終了日なしのみ設定できます。

キャンペーンは指定された日付の米国中部時間（CT、US/Central）の開始を目標とします。目標終了日はCTの現在日付から少なくとも1日後、またはキャンペーンがある場合はキャンペーンのstartDateから少なくとも1日後です。例えば、目標終了日が2021-06-20の場合、キャンペーンは2021年6月20日の午前0:00 CTを目標とします。

{
  "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": {
    "budgetOnetimeLimit": 10000,
    "budgetMonthlyLimit": 10000,
    "dailyAvgBudgetPerJob": 2000,
    "startDate": "2021-01-15",
    "fixedEndDate": "2021-06-20",
    "targetEndDate": "2021-05-01"
  }
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      },
      {
        "rel": "Campaign Info",
        "href": "/v1/campaigns/cda7fa7645b613d5"
      }
    ]
  },
  "data": {
    "budgetOnetimeLimit": 10000,
    "startDate": "2022-05-20",
    "targetEndDate": "2024-01-20"
  }
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      },
      {
        "rel": "Campaign Info",
        "href": "/v1/campaigns/cda7fa7645b613d5"
      }
    ]
  },
  "data": {
    "budgetMonthlyLimit": 6000,
    "startDate": "2022-03-13"
  }
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      },
      {
        "rel": "Campaign Info",
        "href": "/v1/campaigns/cda7fa7645b613d5"
      }
    ]
  },
  "data": {
    "dailyAvgBudgetPerJob": 500,
    "startDate": "2022-03-13",
    "targetEndDate": "2024-01-20"
  }
}

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

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

Responses​

Schema

Schema

Schema

Schema

Schema

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

Request

Responses