キャンペーン予測を取得

POST /v1/campaignpredictions

キャンペーン予測を取得します:

予算に対する合計求人応募数の観点から予想される求人パフォーマンスを推定します。
希望するパフォーマンスに基づいて求人をスポンサーするための予算を推奨します。

予測は求人プロパティ、キャンペーンのタイプと期間に基づいています。個別の求人予測はIndeedでの類似求人の過去のパフォーマンスに基づいています。複数の求人を含むキャンペーンのパフォーマンスも予測できます。

予測でサポートされている通貨コードはCAD、GBP、EUR、JPY、USDです。デフォルトはUSDです。APIは1日あたりUSD $100未満の予算のパフォーマンス推定をサポートします。

採用企業が推奨予算を承認した後は、同じパラメータでキャンペーンが作成されていることを確認してください。

提供される数値は、Indeedの過去のパフォーマンスに基づく推定値のみであり、将来のパフォーマンスを保証するものではありません。

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

Request

application/json

Body

jobInfo

object

jobsLocation stringrequired

求人が所在する都市。
jobsQueryとjobsSourceNameが指定されていない場合、または新しい求人の場合は必須。

jobsQuery stringrequired

求人クエリ。
jobsSourceIdが指定されている場合は必須。

jobsSourceId stringrequired

求人のソースID。
jobsQueryが指定されている場合は必須。

jobsTitle stringrequired

求人タイトル。
jobsQueryとjobsSourceNameが指定されていない場合、または新しい求人の場合は必須。

campaignInfo

object

campaignType stringrequired

ONETIMEまたはMONTHLYのいずれか。

startDate string

キャンペーン開始日。デフォルトは今日。YYYY-MM-DD形式で米国中部時間。campaignTypeがONETIMEの場合のみ適用されます。

endDate stringrequired

キャンペーン終了日。YYYY-MM-DD形式で米国中部時間。campaignTypeがONETIMEの場合は必須。
campaignTypeがONETIMEの場合は必須。

predictionsInfo

object

predictionType string

BUDGET_BASEDまたはAPPLY_BASEDのいずれか。

currencyCode string

予算金額の通貨コード。サポートされている通貨コードはCAD、GBP、EUR、JPY、USDです。デフォルトはUSDです。

budgets number[]required

推定パフォーマンスを返す予算金額。currencyCodeで指定された通貨で表します。配列に1つの数値を渡します。

predictionTypeがBUDGET_BASEDの場合は必須。

BUDGET_BASEDの予測は1つの求人のみをサポートします。jobsQueryが複数の求人に解決される場合、Indeedは400バリデーションエラーを返します。

totalApplies integer[]required

推定予算を返す求人全体の合計応募数。配列に1つの数値を渡します。

predictionTypeがAPPLY_BASEDで、appliesPerJobが設定されていない場合は必須。

appliesPerJob integer[]required

推定予算を返す求人ごとの合計応募数。配列に1つの数値を渡します。

predictionTypeがAPPLY_BASEDで、totalAppliesが設定されていない場合は必須。

Responses

成功

application/json

Schema
Example (from schema)
Budget Based
Apply Based

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

currencyCode string

返された予算金額の通貨コード。このオブジェクトのすべての値は個別の求人予測の集計結果です。

predictions

object[]

予測のリスト。単一の値。

Array [

budget number

BUDGET_BASEDリクエストの場合、推定応募数が基づく予算。APPLY_BASEDリクエストの場合、希望する合計応募数を達成するための推奨予算。

organicApplies integer

BUDGET_BASEDリクエストの場合、スポンサーなしの求人の推定オーガニック応募数。totalAppliesとorganicAppliesを使用して、求人をスポンサーすることで得られる推定応募数を計算します。

totalApplies integer

BUDGET_BASEDリクエストの場合、予算値に対する求人の推定合計応募数（オーガニックとスポンサー）。APPLY_BASEDリクエストの場合、推奨予算が基づく合計応募数。

estimatedLowerApplies integer

BUDGET_BASEDリクエストの場合、予算値に対する求人の推定応募数の下限範囲（オーガニックとスポンサー）。APPLY_BASEDリクエストの場合、レスポンスにはこのフィールドは含まれません。

estimatedHigherApplies integer

BUDGET_BASEDリクエストの場合、予算値に対する求人の推定応募数の上限範囲（オーガニックとスポンサー）。APPLY_BASEDリクエストの場合、レスポンスにはこのフィールドは含まれません。

]

jobLevelPredictions

object[]

各求人の予測のリスト。入力パラメータによってはnullになる場合があります。このオブジェクトのすべての値は個別の求人に対応します。このフィールドは入力パラメータによってはnullになる場合があります。

Array [

job

object

jobKey string

求人キー。

refNum string

求人参照ID。

title string

求人タイトル。

location string

求人の場所。

predictions

object[]

予測のリスト。単一の値。

Array [

budget number

BUDGET_BASEDリクエストの場合、推定応募数が基づく予算。APPLY_BASEDリクエストの場合、希望する合計応募数を達成するための推奨予算。

organicApplies integer

totalApplies integer

estimatedLowerApplies integer

estimatedHigherApplies 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": {
    "currencyCode": "USD",
    "predictions": [
      {
        "budget": "75.50",
        "organicApplies": "2",
        "totalApplies": "10",
        "estimatedLowerApplies": "8",
        "estimatedHigherApplies": "15"
      }
    ],
    "jobLevelPredictions": [
      {
        "job": {
          "jobKey": "80fdf7e9de72243f",
          "refNum": "12800649-92-99",
          "title": "Firmware Engineer",
          "location": "Irvine"
        },
        "predictions": [
          {
            "budget": "75.50",
            "organicApplies": "2",
            "totalApplies": "10",
            "estimatedLowerApplies": "8",
            "estimatedHigherApplies": "15"
          }
        ]
      }
    ]
  }
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": {
    "currencyCode": "USD",
    "predictions": [
      {
        "predictionType": "BUDGET_BASED",
        "budget": 151,
        "organicApplies": 3,
        "totalApplies": 7,
        "estimatedLowerApplies": 3,
        "estimatedHigherApplies": 10
      }
    ],
    "jobLevelPredictions": [
      {
        "job": {
          "jobKey": "80fdf7e9de72243f",
          "refNum": "12800649-92-99",
          "title": "Firmware Engineer",
          "location": "Irvine"
        },
        "predictions": [
          {
            "predictionType": "BUDGET_BASED",
            "budget": 75.5,
            "organicApplies": 2,
            "totalApplies": 4,
            "estimatedLowerApplies": 2,
            "estimatedHigherApplies": 5
          }
        ]
      },
      {
        "job": {
          "jobKey": "79db86f75cbbde08",
          "refNum": "12800649-93-100",
          "title": "Principal Software Engineer",
          "location": "Irvine"
        },
        "predictions": [
          {
            "predictionType": "BUDGET_BASED",
            "budget": 75.5,
            "organicApplies": 1,
            "totalApplies": 3,
            "estimatedLowerApplies": 1,
            "estimatedHigherApplies": 5
          }
        ]
      }
    ]
  }
}

{
  "meta": {
    "status": 200,
    "errors": null,
    "rootLocation": "https://apis.indeed.com/ads",
    "perPage": null,
    "links": null
  },
  "data": {
    "currencyCode": "USD",
    "predictions": [
      {
        "predictionType": "APPLY_BASED",
        "budget": 816,
        "organicApplies": 0,
        "totalApplies": 16
      }
    ],
    "jobLevelPredictions": [
      {
        "job": {
          "jobKey": "80fdf7e9de72243f",
          "refNum": "12800649-92-99",
          "title": "Firmware Engineer",
          "location": "Irvine"
        },
        "predictions": [
          {
            "predictionType": "APPLY_BASED",
            "budget": 416,
            "organicApplies": 0,
            "totalApplies": 8
          }
        ]
      },
      {
        "job": {
          "jobKey": "79db86f75cbbde08",
          "refNum": "12800649-93-100",
          "title": "Principal Software Engineer",
          "location": "Irvine"
        },
        "predictions": [
          {
            "predictionType": "APPLY_BASED",
            "budget": 400,
            "organicApplies": 0,
            "totalApplies": 8
          }
        ]
      }
    ]
  }
}

リクエストパラメータが無効です。descriptionフィールドには通常、問題のあるパラメータの名前とより詳細なエラーメッセージが含まれます。

他のエラータイプとは異なり、meta.errors配列には、問題のあるリクエストパラメータごとに1つずつ、複数のINVALID_REQUESTエラーが含まれる場合があります。

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": "INVALID_REQUEST",
        "description": "jobsSourceId: required attribute is missing."
      }
    ],
    "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
}

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

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

クライアント資格情報グラントタイプ（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​

Body

Responses​

Schema

Schema

Schema

Schema

Schema

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

Request

Responses