キャンペーン予算見積もりを取得する

POST 
/v1/campaignbudgetquote

平均日次予算（ADB）キャンペーンを作成する前に、求人の推奨日次予算を取得します。

キャンペーンレベルの平均予算見積もり、一致した各求人の予算見積もり、およびSTANDARDティアとPREMIUMティアの推奨予算を返します。

推奨日次予算は目標値であり、保証されるものではありません。

Indeed は目標値に近づくよう最適化しますが、日々の消費額は変動します。

たとえば、平均日次予算が 25 ドルの場合、1 日目の消費額が 20 ドル、2 日目が 30 ドルになることがあります。

このエンドポイントの呼び出しは、Sponsored Jobs API の使用ポリシーによる課金の対象外です。

• 新しい求人を投稿してから 2〜3 時間待ってキャンペーンを作成してください。

• 予算推奨の呼び出しから 1 時間以内にキャンペーンを作成してください。

  1 時間を超えると市場の状況が変化する可能性があり、キャンペーンの作成では最新の推奨予算が使用されます。

• キャンペーン作成後を含め、クエリによる求人解決で自動的に追加された求人は、推奨予算を既定の日次消費額として使用します。

• キャンペーンに手動で追加された求人も、推奨予算を既定の日次消費額として使用します。

OAuth スコープ	アクセストークンの種類
employer.advertising.campaign.read	採用企業を表すアクセストークン。

Request

application/json

Body

required

リクエストボディは、キャンペーンの更新内容を定義する JSON オブジェクトである必要があります。

HTTP リクエストヘッダー

次のHTTP リクエストヘッダーを含めてください。

• Content-Type: application/json
• Accept: application/json

jobsQuery string

求人クエリ。

設定すると、キャンペーンはこの検索条件に一致する求人のみをスポンサー表示します。

ブール式に対応しています。

インデックス済み求人のクエリ形式をご覧ください。

jobsToIncludeがQUERYの場合にのみ適用されます。

jobsTitle string

クエリ内の職種名。

設定すると、キャンペーンはこの職種名の求人のみをスポンサー表示します。

jobsToIncludeがQUERYの場合にのみ適用されます。

jobsCompany string

クエリ内の採用企業。

設定すると、キャンペーンはこの企業の求人のみをスポンサー表示します。

jobsToIncludeがQUERYの場合にのみ適用されます。

jobsLocation string

クエリ内の勤務地。

設定すると、キャンペーンはこの勤務地またはその周辺の求人のみをスポンサー表示します。

jobsToIncludeがQUERYの場合にのみ適用されます。

jobsLocationRadius int32

Default value: 25

クエリ内のjobsLocationから勤務地までの最大距離。

有効な値は5、10、15、25、50、100です。

米国と英国の求人にはマイルを使用します。

それ以外の国ではキロメートルを使用します。

jobsSourceId string

jobsSourceを上書きするソース ID。

キャンペーンが使用する求人ソースを識別します。

GET /v1/accountのjobSourceListに含まれる求人ソースのidを使用します。

採用企業アカウントに求人ソースがない場合は、Indeed カスタマーサポートにお問い合わせください。

各キャンペーンはjobsSourceIdを 1 つだけサポートします。

求人ソースが複数ある場合は、ソースごとに個別のキャンペーンを作成してください。

jobsSourceName string

ソース名。

ATS パートナーのみが使用します。

jobsToInclude stringrequired

Possible values: [ALL, QUERY]

必須。ALLまたはQUERYを使用します。

ALLは求人ソース内のすべての求人をスポンサー表示します。

ALLの場合、API はjobsQuery、jobsTitle、jobsCompany、jobsLocation、jobsLocationRadiusを無視します。

QUERYは指定した条件に一致する求人のみをスポンサー表示します。

条件を複数指定した場合、求人はそのすべてに一致する必要があります。

jobsToIncludeにQUERYを設定して条件を指定しない場合、キャンペーンは現在、求人ソース内のすべての求人をスポンサー表示します。

エラーを避けるため、条件を 1 つ以上指定してください。

Responses

200

成功

application/json

Schema

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

sponsorshipPlanBudgetQuotes

object[]

スポンサーシッププランごとの予算見積もりのリスト。現在の値:

• PREMIUM: Campaign uses the premium plan.

• STANDARD: Campaign uses the standard plan.

Array [

sponsorshipPlan string

Possible values: [PREMIUM, STANDARD]

年間契約のボーナスクレジットを財源とするキャンペーンのスポンサーシッププラン。

• PREMIUM：キャンペーンはプレミアムプランを使用します。

• STANDARD：キャンペーンはスタンダードプランを使用します。

dailyAvgBudgetPerJob

object

このスポンサーシッププランにおける求人予算見積もりの平均。

キャンペーン詳細の GET では、この値は avgDailyBudgetConfig.recommendedBudgetPerJob と一致します。

キャンペーン作成時に budgetBoostPercentage が適用されると、求人ごとの実効平均日次予算（ADB）が増加するため、この値は avgDailyBudgetConfig.dailyAvgBudgetPerJob と異なる場合があります。

amount number

通貨単位での予算額。

currency string

ISO 4217 通貨コード（JPY、USD など）。

jobBudgetQuotes

object[]

リクエストに一致した各求人の予算見積もり。900 件までに制限されます。求人パラメータが 900 件を超える求人に一致する場合、API は 400 エラーを返します。

Array [

jobKey string

この求人に対して Indeed が生成する一意の識別子。

dailyBudget

object

平均日次予算（ADB）キャンペーンにおける、この求人の日次予算の目標値。

amount number

通貨単位での予算額。

currency string

ISO 4217 通貨コード（JPY、USD など）。

]

]

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "リクエストされたリソースが見つかりませんでした"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": {
    "sponsorshipPlanBudgetQuotes": [
      {
        "sponsorshipPlan": "PREMIUM",
        "dailyAvgBudgetPerJob": {
          "amount": 1500,
          "currency": "USD"
        },
        "jobBudgetQuotes": [
          {
            "jobKey": "89deb9de58ebe149",
            "dailyBudget": {
              "amount": 1500,
              "currency": "USD"
            }
          }
        ]
      }
    ]
  }
}

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

無効なリクエスト

application/json

Schema

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

Example (from schema)

{
  "meta": {
    "status": 200,
    "errors": [
      {
        "type": "RESOURCE_NOT_FOUND",
        "description": "リクエストされたリソースが見つかりませんでした"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": 25,
    "links": [
      {
        "rel": "next",
        "href": "/v1/campaigns/3141592653589793"
      }
    ]
  },
  "data": null
}

jobLimitExceeded

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "<p><code>jobsQuery</code>が900件を超える求人に一致しました。</p>\n<p><code>jobsQuery</code>、<code>jobsTitle</code>、<code>jobsCompany</code>、<code>jobsLocation</code>、または<code>jobsLocationRadius</code>でクエリを絞り込んでください。</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaignbudgetquote"
      }
    ]
  },
  "data": null
}

invalidJobsLocationRadius

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "<p><code>jobsLocationRadius</code>は<code>5</code>、<code>10</code>、<code>15</code>、<code>25</code>、<code>50</code>、<code>100</code>のいずれかの値である必要があります。</p>"
      }
    ],
    "rootLocation": "https://apis.indeed.com/ads",
    "links": [
      {
        "rel": "up",
        "href": "/v1/campaignbudgetquote"
      }
    ]
  },
  "data": null
}

Loading...

 

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