メインコンテンツまでスキップ

採用企業のキャンペーンとキャンペーンステータスのリストの取得

GET 
/v1/campaigns

採用企業のキャンペーンとそのステータスのリストを返します。結果はページ付けされる場合があります。

例：1ページ当たり100件まで、アクティブなキャンペーンを取得します。

https://apis.indeed.com/ads/v1/campaigns?status=ACTIVE&perPage=100
OAuthのスコープアクセストークンの種類
employer.advertising.campaign.read

採用企業に紐づいたアクセストークン。

Request​

Query Parameters

    perPage integer

    Default value: 30

    応答で返されるキャンペーンの最大数。取得できる結果が他に存在するにもかかわらず、応答で返されるキャンペーンの数がリクエストした最大数より少ないことがあります。次の結果ページがあるかどうか、必ず応答を確認してください。

    start string

    ページ付けされた応答内の位置を指定します。取得できる結果がさらに存在する場合は、次の結果ページに相当する値も応答に含まれます。

    status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    キャンペーンのステータス。キャンペーンのステータスで結果を絞り込むには、ACTIVE、DELETED、またはPAUSEDのいずれかを渡します。デフォルトでは、すべてのステータスのキャンペーンが返されます。

    type string

    Possible values: [SOURCE, HOSTED]

    求人のタイプ。キャンペーンのスポンサー求人の種類で結果を絞り込むには、SOURCE（Webから収集された求人、またはXML フィードを使用して Indeed に送信された求人）、またはHOSTED （求人投稿ページを使用して投稿された求人）のどちらかを渡します。デフォルトでは、両タイプの求人を含むキャンペーンが返されます。

    fields string

    応答に含めるフィールドのカンマ区切りリスト。指定可能な値はId、Name、Status、NonSpendingReasons、Type、CurrencyCode、TrackingToken、StartDate、FixedEndDate、TargetEndDate、BudgetOnetimeLimit、BudgetMonthlyLimit、FundingSource、SponsorshipPlan、DailyAvgBudgetPerJobです。デフォルトはId、Name、Statusです。

    campaignIds string

    一覧表示するキャンペーンのcampaignIdsのカンマ区切りリスト。最大50件のキャンペーンIDをサポートします。fieldsクエリパラメータのみと併用できます。

Responses​

キャンペーンを一覧表示します。該当するキャンペーンが存在せず、campaignIdsパラメータを指定しない場合は、空のdata.Campaigns配列とHTTP200ステータスコードを返します。

結果はページ付けされる場合があります。結果が1ページよりも多い場合は、 meta.links配列には"rel": "next"プロパティを持つアイテムが含まれます。href のプロパティの値をベースURLに追加して、次の結果ページを取得します。

注：現時点で nextのURLには、startパラメータ以外のパラメータは含まれません。perPage、status、またはtypeにデフォルト以外の値を使用した場合は、それらを手動でURLに追加していただく必要があります。この動作は、APIの今後のバージョンでは変更となる可能性があります。

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を追加します。

  • ]

    • objective

    object

    キャンペーンが達成すべき採用目標を指定し、キャンペーンを目標設定型キャンペーンにします。値はJSONオブジェクトで、 キャンペーンの目標を指定するobjectiveTypeフィールドを含み、また一部のオブジェクトタイプでは、特定の目標指標を特定するtarget フィールドを含みます。

    たとえば、キャンペーンの目標が10件の応募を獲得することであれば、 objective を次のように設定します。

    {
      "objectiveType": "TARGET_APPLICATIONS",
      "target": 10
    }

    目標のない既存のキャンペーンには目標を追加でき、既存の目標の target値を変更することもできます。ただし、目標を削除したり、objectiveTypeを変更したりすることはできません。

    objectiveType

    string

    Possible values: [BALANCE, MAXIMUM, QUICK, TARGET_APPLICATIONS, TARGET_COST_PER_APPLICATION, SCHEDULED_INTERVIEWS]

    キャンペーンの目標。指定可能な値は次のとおりです。

    • BALANCE：求人全体にわたってバランスを取りながら、予算に対して得られる合計応募数を最大にします。
    • MAXIMUM：求人全体にわたってクリック数のバランスを取らずに、予算に対して得られる合計応募数を最大にします。
    • QUICK：5日間のキャンペーンは予算が高くなりますが、より早く結果につながります。スポンサー求人APIは現在、この目標を指定したキャンペーンの作成や変更をサポートしていません。ただし、スポンサー求人APIは、この目標タイプを指定したキャンペーンに関するキャンペーンレポートの取得には対応しています（これらのキャンペーンは、Indeed 求人掲載を使用して作成されます）。
    • TARGET_APPLICATIONS：targetによって指定される応募数の達成を目標とします。目標応募数に達した場合、その求人への支出は大幅に削減され、他の求人に割り当てられます。
    • TARGET_COST_PER_APPLICATION：応募単価がtargetによって指定される数値を常に下回るようにすることを目標とします。
    • SCHEDULED_INTERVIEWS：スクリーニングを通過した応募者との面接をただちに設定します。targetによって指定される面接数の達成を目標とします。この目標を使用するには、アクティブな Indeed Hiring Platformのサブスクリプションが必要です。また、対象となる求人の採用イベントを作成する準備がお客様側で整っている場合にのみ使用を推奨しています。

    アプリケーションの外部で作成されたキャンペーンは、そのアプリケーションではまだサポートされていない新しく追加された目標タイプを使用している可能性があります。アプリケーションには、予期しない objectiveType 値を処理するためのフォールバックロジックを組み込む必要があります。

    any

    data

    object

    Campaigns

    object[]

  • Array [

    • Name string

    Possible values: non-empty and <= 250 characters

    キャンペーンを後で識別するために役立つキャンペーン名。採用企業アカウント内で固有の名前にする必要があります。

    Id string

    キャンペーンID。キャンペーンの作成時に自動的に生成されます。

    Status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Default value: ACTIVE

    キャンペーンのステータス。手動で有効にしない限り有料掲載を開始しないキャンペーンを作成したり、既存のキャンペーンの有料掲載を一時的に停止したりしたい場合は、ステータスをPAUSED に設定します。

    NonSpendingReasons

    object[]

    キャンペーンの有料掲載が現時点で行われていない理由のリスト。

  • Array [

    • type string

    Possible values: [BEFORE_START_DATE, AFTER_END_DATE, ACCOUNT_MONTHLY_BUDGET_HIT, MONTHLY_BUDGET_HIT, ONETIME_BUDGET_HIT, JOB_SOURCE_NOT_VERIFIED, BILLING_PENDING, USER_PAUSED_CAMPAIGN, USER_DELETED_CAMPAIGN, TARGET_APPLICATIONS_HIT, OTHER]

    問題の識別子。サポートされる値は次のとおりです。

    • BEFORE_START_DATE：米国中部標準時での現在の日付が、キャンペーン開始日より前です。
    • AFTER_END_DATE：米国中部標準時での現在の日付が、キャンペーン終了日と同じかそれ以降です。
    • ACCOUNT_MONTHLY_BUDGET_HIT：採用企業アカウントはすでに今月の予算を使い切っています。
    • MONTHLY_BUDGET_HIT：キャンペーンはすでに今月の予算を使い切っています。
    • ONETIME_BUDGET_HIT：キャンペーンはすでに予算を使い切っています。
    • JOB_SOURCE_NOT_VERIFIED：求人ソースはまだ Indeed によって確認されていません。
    • BILLING_PENDING：採用企業アカウントに有効な請求情報がありません。
    • USER_PAUSED_CAMPAIGN：キャンペーンはリクエストにより一時停止しました。
    • USER_DELETED_CAMPAIGN：キャンペーンはリクエストにより削除されました。
    • TARGET_APPLICATIONS_HIT：キャンペーンはすでにリクエストされた応募数を達成しました。
    • OTHER：不明な理由。
    description string

    人間が読める形式での問題の説明。

  • ]

    • Type string

    Possible values: [SOURCE, HOSTED]

    キャンペーンで有料掲載している求人のタイプ。SOURCE（Webから収集された求人、またはXMLフィードを使用して Indeed に送信された求人）、またはHOSTED（求人投稿ページを使用して投稿された求人）のどちらかです。

    CurrencyCode string

    キャンペーンの予算の支払いが行われる通貨のISO 4217通貨コード。

    TrackingToken string

    Possible values: <= 255 characters

    スポンサークリック時に求人URLに追加されるクリックトラッキングトークン。クリックが Indeed から行われたこと、また必要に応じてクリックのスポンサーとなったキャンペーンを特定できます。

    BudgetOnetimeLimit number

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

    BudgetMonthlyLimit number

    キャンペーンの月額予算の上限。dailyAvgBudgetPerJob、budgetOnetimeLimit、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）を終了目標にします。

    FundingSource string

    キャンペーンの資金源：

    • Bonus Sponsored Job Credits：Annual Deals ボーナスクレジットで資金が供給されます。
    • Budget：通常の予算で資金が供給されます。

    設定可能な値：[Bonus Sponsored Job Credits, Budget]

    SponsorshipPlan string

    Annual Deals ボーナスクレジットで資金が供給されるキャンペーンのスポンサーシッププラン。スタンダードキャンペーンは空の文字列（""）を返します。プレミアムプランのキャンペーンは"Premium"を返します。

    設定可能な値：[Premium, `` (空の文字列)]

    DailyAvgBudgetPerJob number

    キャンペーン内の求人ごとの1日の平均予算。Average Daily Budget（ADB）モデルを使用するキャンペーンにのみ返されます。dailyAvgBudgetPerJobとbudgetMonthlyLimitを同時に設定することはできません。

  • ]

Loading...

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

に最終更新