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

GET /v1/campaigns/:campaignId/budget

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

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パラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

links

object[]

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

Array [

rel string

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

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

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

href string

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

]

data

object

budgetOnetimeLimit number

キャンペーンのワンタイム予算上限。budgetOnetimeLimitとbudgetMonthlyLimitは同時に設定できません。

budgetMonthlyLimit number

キャンペーンの月額予算上限。dailyAvgBudgetPerJob、budgetOnetimeLimit、budgetMonthlyLimitは同時に設定できません。

dailyAvgBudgetPerJob number

キャンペーンの求人ごとの日次平均予算。Average Daily Budget（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のいずれかを指定する必要があります（ただし、両方は指定できません）。

月額予算（budgetMonthlyLimit）を使用するキャンペーンには、オプションでfixedEndDateを指定できます。月額予算を使用するキャンペーンは、デフォルトでは手動でキャンペーンを一時停止または削除するまで有料掲載を継続します。これらは「常時募集中」のキャンペーンと呼ばれます。 fixedEndDate により、特定の日に日付が変わったタイミングでキャンペーンを停止します。

キャンペーンのスポンサー求人は、米国中部標準時（CT、 US/Central）で指定した終了日に日付が変わったタイミングで停止されます。fixedEndDateは、CTでの現在の日付の翌日以降、またはキャンペーンのstartDateの翌日以降（開始日が指定されている場合）にする必要があります。たとえば、指定終了日が2021-06-20ならば、キャンペーンは2021年6月20日の午前0:00（CT）に停止します。

targetEndDate date

キャンペーンが有料掲載を停止する目標日付を指定します（この日付に変わる前に停止することが目標）。ただし、指定した日付を過ぎても予算を全額使い切っていなければ、有料掲載を継続できます。ISO 8601の形式 YYYY-MM-DDに従います。

ワンタイム予算（budgetOnetimeLimit）を使用するキャンペーンには、fixedEndDateまたはtargetEndDateのいずれかを指定する必要があります（ただし、両方は指定できません）。月額予算（budgetMonthlyLimit）を使用するキャンペーンにはtargetEndDateは使用できません。終了日としてfixedEndDateを指定するか、終了日を指定しないかのいずれかの選択となります。

キャンペーンは、米国中部標準時（CT、 US/Central）で指定した日に日付が変わったタイミングを目標とします。目標終了日は、CTでの現在の日付の翌日以降、またはキャンペーンのstartDateの翌日以降（開始日が指定されている場合）にする必要があります。たとえば、目標終了日が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ヘッダーが存在しない、または形式に誤りがあった。必ず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": 404,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "要求されたリソースが見つかりませんでした。"
      }
    ],
    "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

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​

Path Parameters

Responses​

Schema

Schema

Schema

Schema

Schema

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

Request

Responses