キャンペーンの予算または期間を更新する

PATCH 
/v1/campaigns/:campaignId/budget

キャンペーンの予算または期間、あるいはその両方を更新します。値が null のプロパティ、またはリクエストで指定されていないプロパティは、既存の値を維持します。

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

Request

Path Parameters

campaignId stringrequired

キャンペーンID

application/json

Body

required

リクエストには Content-Type: application/json ヘッダーを含めるようにしてください。

budgetOnetimeLimit number

この値を設定すると、キャンペーン期間全体にわたって指定の予算が使用されます。必ず budgetOnetimeLimitまたはbudgetMonthlyLimitを指定する必要がありますが、両方は指定できません。

予算は採用企業アカウントの通貨で指定します。スポンサー求人APIによって解析および格納および返される値は、浮動小数点数ではなく、正確な小数として処理されます。

budgetMonthlyLimit number

この値を設定すると、キャンペーンは月額予算を使用します。月額予算を使用するキャンペーンの場合、終了日はオプションです。この場合、 budgetOnetimeLimitまたはbudgetMonthlyLimitのうちの1つのみを必ず指定する必要があります。

予算は採用企業アカウントの通貨で指定します。スポンサー求人APIによって解析および格納および返される値は、浮動小数点数ではなく、正確な小数として処理されます。

budgetFirstMonthBehavior string

Possible values: [startNowProratedAmount, startNowFullAmount, startNextMonthFullAmount]

キャンペーンが月額予算を使用し（budgetMonthlyLimit を指定）、キャンペーンの開始日が月初日ではない場合に、初月の予算を計算する方法を指定します。

値	意味	例：月額予算が9万円で、開始日が6月11日の場合に適用される予算
		6月11～30日	7月1～31日
startNowFullAmount	初月の予算は1か月分全額が充てられます。	9万円	9万円
startNowProratedAmount	初月の予算は、開始日から月末までの残り日数で日割り計算されます。	6万円	9万円
startNextMonthFullAmount	初月はキャンペーンに予算が割り当てられず、有料掲載は行われません。	0円	9万円

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）を終了目標にします。

Responses

200

成功

application/json

Schema

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

campaignId string

更新されたキャンペーンのキャンペーンID

Example (from schema)

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

Example

{
  "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/bceed88523d89731"
      },
      {
        "rel": "Traffic Statistics",
        "href": "/v1/campaigns/bceed88523d89731/stats"
      }
    ]
  },
  "data": {
    "campaignId": "bceed88523d89731"
  }
}

400

リクエストパラメータの1つに問題がありました。descriptionフィールドには通常、問題のあるパラメータの名前と、より詳細なエラーメッセージが格納されます。 他のエラータイプと異なり、meta.errors配列には複数のINVALID_REQUEST エラーが含まれる可能性があります（問題のあるリクエストパラメータごとに1つずつ）。

application/json

Schema

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

Example (from schema)

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

Updating start date after campaign is active

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "startDate: Cannot update the start date for this campaign."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      }
    ]
  },
  "data": null
}

Multiple types of end date

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "targetEndDate: You can have only one end date type, either fixed or target."
      },
      {
        "type": "INVALID_REQUEST",
        "description": "fixedEndDate: You can have only one end date type, either fixed or target."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaigns"
      }
    ]
  },
  "data": null
}

401

次の理由で、リクエストに有効なアクセストークンが含まれていませんでした。

• Authorizationヘッダーが存在しない、または形式に誤りがあった。必ずAuthorizationHTTPヘッダーでアクセストークンを送信し、値のヘッダーにBearerというワードとスペースを使用してください。たとえば、アクセストークンがXYZならば、リクエストにはAuthorization: Bearer XYZ というヘッダーを含める必要があります。
• アクセストークンの形式に誤りがあった。HTTPリクエストを手動で作成してAPIをテストしている場合は、リクエストにアクセストークンをコピーする際に、アクセストークンの先頭や末尾の文字を誤って削除したり、余分な文字を含めたりしていないことを確認してください。
• アクセストークンが期限切れになっている。アクセストークンは1時間（3,600秒）のみ有効です。期限が切れた後は、リフレッシュトークン（3-legged OAuth）を使用して別のアクセストークンを取得する必要があります。

application/json

Schema

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

Example (from schema)

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

Example

{
  "meta": {
    "status": 401,
    "errors": [
      {
        "type": "INVALID_TOKEN",
        "description": "Invalid OAuth access token."
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": null
}

403

アクセストークンは有効でしたが、この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

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

Example (from schema)

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

Example

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

404

リクエストされたキャンペーンは存在しないか、別の採用企業のものです。リクエストされたキャンペーンを所有している採用企業に紐づけられたアクセストークンを必ず使用してください。

application/json

Schema

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

Example (from schema)

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

Example

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

500

予期しないエラーを示しています。これは一時的な問題の場合があり、まったく同じリクエストをもう一度試すと成功する可能性があります。

リクエストをもう一度試しても解決しない場合は、リクエストの解析に問題があることが考えられます。必要なパラメータがすべて指定されており、すべてのパラメータの形式が正しいことを確認してください。

application/json

Schema

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

Example (from schema)

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

Example

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

Loading...

 

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