キャンペーン予測の取得

POST 
/v1/campaignpredictions

このエンドポイントは、

• 特定の予算に対して、期待される求人のパフォーマンスを合計求人応募数の観点から予測します。
• 目的のパフォーマンスに基づき、求人を有料掲載するための予算をお勧めします。

特定の求人とそのプロパティにおいて、これらの予測は、Indeed における同様の求人の過去のパフォーマンスに基づいて行われます。

現在、予測は米国（英語）の求人に対してのみ利用できます。また、1日当たり100ドル未満の予算に対してパフォーマンスを予測します。応答のすべての予算額は米ドル（USD）を単位とします。 複数の求人についてキャンペーンのパフォーマンスを予測することもできます。

予測は求人のプロパティと、キャンペーンのタイプと期間に基づき行われます。採用企業が推奨予算を承認したら、同じパラメータでキャンペーンが作成されることを確認してください。

提示された数値は Indeed の過去のデータに基づいて算出された予測値であり、今後のパフォーマンスを保証するものではありません。

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

Request

Query Parameters

mode string

Possible values: [multi-job]

複数の求人があるキャンペーンの予測を取得するには、パラメータの値をmulti-jobとして渡す必要があります。

application/json

Body

jobInfo

object

jobsLocation stringrequired

• 求人のある都市。
• jobsQueryおよびjobsSourceNameが指定されない場合、または新規求人の場合に必須です。

jobsQuery stringrequired

• 求人クエリ。
• jobsSourceNameが指定された場合に必須です。

jobsSourceName stringrequired

• 求人のソース名。
• 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 undefined[]required

• 予想されるパフォーマンスを得るための予算。パフォーマンスは応募数として予想されます。配列で渡される数字は1つだけです。predictionTypeがBUDGET_BASEDの場合に必須です。複数の求人のキャンペーンでは、予算は求人全体にわたって配分されます。
• predictionTypeがBUDGET_BASEDの場合に必須です。

totalApplies integer[]required

• 予想される予算で得られる求人全体にわたる応募数の合計。配列で渡される数字は1つだけです。predictionTypeがAPPLY_BASEDで、appliesPerJobが設定されていない場合に必須です。
• predictionTypeがAPPLY_BASEDで、appliesPerJobが設定されていない場合に必須です。

appliesPerJob integer[]required

• 予想される予算で得られる求人当たりの応募数の合計。配列で渡される数字は1つだけです。predictionTypeがAPPLY_BASEDで、totalAppliesが設定されていない場合に必須です。
• predictionTypeがAPPLY_BASEDで、totalAppliesが設定されていない場合に必須です。

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

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 になる可能性があります。

Array [

job

object

jobKey string

求人キー

refNum string

求人参照ID

title string

職種名

location 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リクエストの場合、このフィールドは応答に含まれません。

]

]

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

Budget Based

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

Apply Based

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

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
}

Example

{
  "meta": {
    "status": 400,
    "errors": [
      {
        "type": "INVALID_REQUEST",
        "description": "endDate: The end date should be after the start date."
      }
    ],
    "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
}

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...

 

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