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

キャンペーンを作成

POST 
/v1/campaigns

スポンサー求人キャンペーンを作成します。

前提条件

  • キャンペーンを作成する前に、採用企業アカウントに求人ソースを関連付ける必要があります。GET /v1/accountエンドポイントを使用して、アカウントに関連付けられた求人ソースを一覧表示します。採用企業アカウントがまだ求人ソースに関連付けられていない場合は、Indeedカスタマーサポートに連絡してください。
  • キャンペーンが求人のスポンサーを開始する前に、採用企業アカウントに有効な請求情報を設定する必要があります。
OAuthスコープアクセストークンタイプ
employer.advertising.campaign

採用企業を表すアクセストークン。採用企業を表すアクセストークンを取得するを参照してください。

Request​

Body

required

リクエストボディは、作成するキャンペーンを説明するJSONオブジェクトである必要があります。リクエストにContent-Type: application/jsonヘッダーを含めてください。

常にname、jobsSourceName、およびjobsToIncludeを指定する必要があります。

スポンサーする求人の選択

  • 求人ソース内のすべての求人をスポンサーする: jobsToIncludeをALLに設定します。jobsQuery、jobsTitle、jobsCompany、jobsLocation、およびjobsLocationRadiusは無視されるため、指定しないでください。
  • 求人のサブセットをスポンサーする: jobsToIncludeをQUERYに設定します。jobsQuery、jobsTitle、jobsCompany、またはjobsLocationのうち少なくとも1つを指定します。

キャンペーン予算と期間の設定

  • 指定した日付に終了するキャンペーンを作成する: budgetOnetimeLimitを指定します。終了日以降にキャンペーンが予算残がある場合でもスポンサーを停止させたい場合はfixedEndDateを、予算をすべて使い切るまでスポンサーを続けさせたい場合はtargetEndDateを指定します。（月次金額で予算を設定し、各月に均等な予算を確保したい場合は代わりにbudgetMonthlyLimitを指定できますが、その場合はfixedEndDateのみ使用できます。）
  • 手動で停止するまで求人をスポンサーするキャンペーンを作成する: budgetMonthlyLimitを指定します。終了日は指定しないでください。

キャンペーン開始時期の選択

  • すぐにスポンサーを開始するキャンペーンを作成する: startDateまたはstatusを指定しない場合のデフォルトです。
  • 指定した将来の日付に開始するキャンペーンを作成する: startDateを指定します。
  • 手動で有効にした時に開始するキャンペーンを作成する: statusをPAUSEDに設定します。

オプション機能

  • このキャンペーンがスポンサーするクリックを識別する: trackingTokenを指定します。
  • 特定の採用目標を達成するためにキャンペーンの動作を最適化する: objectiveを指定します。Sponsored Jobs APIで作成されるすべてのキャンペーンには目標が必要です。キャンペーン作成時に採用企業が目標を指定しない場合、Sponsored Jobs APIはキャンペーンに適切な目標を選択します。
  • Trusted Media Network（TMN）で求人をスポンサーする: channelsを指定します。詳細については、Trusted Media Network（TMN）とは何ですか？を参照してください。有効または無効なチャンネルを持つキャンペーンを作成した後は、チャンネルのステータスを変更できません。

各フィールドの詳細と値の例については、モデル定義を参照してください。リクエストの例については、キャンペーン管理のハウツーガイドを参照してください。

    name string

    Possible values: non-empty and <= 250 characters

    キャンペーン名。キャンペーンを識別できます。名前は採用企業アカウント内で一意である必要があります。

    status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Default value: ACTIVE

    キャンペーンステータス。PAUSEDは手動で有効にするまで求人のスポンサーを開始しないキャンペーンを作成するか、キャンペーンが求人のスポンサーを一時的に停止します。

    trackingToken string

    Possible values: <= 255 characters

    スポンサークリック時に求人URLに追加されるクリックトラッキングトークン。クリックがIndeedからのものであることを特定し、クリックをスポンサーしたキャンペーンを識別できます。

    jobsSourceId string

    このキャンペーンが求人をスポンサーする求人ソース。GET /v1/accountのjobSourceListフィールドで返された求人ソースのidを指定します。採用企業アカウントがまだ求人ソースに関連付けられていない場合は、Indeedカスタマーサポートに連絡してください。

    各キャンペーンは1つのjobsSourceIdのみをサポートします。複数の求人ソースがある場合は、各ソースに対して個別のキャンペーンを作成します。

    jobsToInclude string

    Possible values: [ALL, QUERY]

    • ALL - キャンペーンは求人ソース内のすべての求人をスポンサーします。jobsQuery、jobsTitle、jobsCompany、jobsLocation、jobsLocationRadiusフィールドの値は無視され、既存の値はクリアされます。
    • QUERY - キャンペーンはjobsQuery、jobsTitle、jobsCompany、jobsLocation、jobsLocationRadiusフィールドで定義された条件に一致する求人のサブセットをスポンサーします。複数のフィールドが指定された場合、すべての条件に一致する求人のみがスポンサーされます。

    注意: jobsToIncludeがQUERYでもすべての条件を省略した場合、キャンペーンは求人ソース内のすべての求人をスポンサーします。将来のAPIバージョンでは、この動作はエラーになります。少なくとも1つの条件を指定するか、jobsToIncludeを明示的にALLに設定してすべての求人をスポンサーしてください。

    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です。求人が米国または英国にある場合、単位はマイルです。それ以外の場合、単位はキロメートルです。

    budgetOnetimeLimit number

    設定されている場合、キャンペーンはキャンペーンの期間に対して単一の予算を持ちます。常にbudgetOnetimeLimitまたはbudgetMonthlyLimitのいずれかを指定する必要がありますが、両方は指定できません。

    予算は採用企業アカウントの通貨です。Sponsored Jobs APIは値を浮動小数点数ではなく正確な小数として解析、保存、返却します。

    budgetMonthlyLimit number

    設定されている場合、キャンペーンは月次定期予算を持ちます。月次定期予算を持つキャンペーンの終了日はオプションです。budgetOnetimeLimitまたはbudgetMonthlyLimitのどちらか1つを指定します。

    予算は採用企業アカウントの通貨です。Sponsored Jobs APIは値を浮動小数点数ではなく正確な小数として解析、保存、返却します。

    budgetFirstMonthBehavior string

    Possible values: [startNowFullAmount, startNowProratedAmount, startNextMonthFullAmount]

    Default value: startNowFullAmount

    budgetMonthlyLimitと月の最初の日以外のキャンペーン開始日とともに、最初の月の予算の動作を定義します。値は以下の通りです。

    値最初の月の予算
    startNowFullAmount 月次予算の全額。
    startNowProratedAmount開始日以降の月の日数に比例。
    startNextMonthFullAmount 予算なし。

    この表は、月次予算が900 USD、開始日が6月11日、budgetFirstMonthBehaviorがこれらの値のいずれかに設定されている場合の最初の月と翌月の予算を示しています:

    値6月11日〜30日7月1日〜31日
    startNowFullAmount 900 USD900 USD
    startNowProratedAmount 600 USD900 USD
    startNextMonthFullAmount 0 USD900 USD
    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のいずれか1つが必要ですが、両方は指定できません。

    月次定期予算（budgetMonthlyLimit）を持つキャンペーンには、オプションでfixedEndDateを設定できます。月次定期キャンペーンは、手動で一時停止または削除するまで求人のスポンサーを続けます。これらは「エバーグリーン」キャンペーンと呼ばれます。指定された日の開始時にキャンペーンを停止するには、fixedEndDateを指定します。

    キャンペーンは指定された日付の米国中部時間（CT、US/Central）の開始時に求人のスポンサーを停止します。fixedEndDateはCTの現在日付から少なくとも1日後、またはキャンペーンがある場合はキャンペーンのstartDateから少なくとも1日後である必要があります。例えば、固定終了日が2021-06-20の場合、キャンペーンは2021年6月20日の午前0:00 CTに停止します。

    targetEndDate date

    キャンペーンが求人のスポンサーを停止すべき日付ですが、予算全体をまだ使い切っていない場合は指定日を過ぎてもスポンサーを続ける場合があります。ISO 8601のYYYY-MM-DD形式に従います。

    一括予算（budgetOnetimeLimit）を持つキャンペーンには、常にfixedEndDateまたはtargetEndDateのいずれか1つが必要ですが、両方は指定できません。月次定期予算（budgetMonthlyLimit）を持つキャンペーンにはtargetEndDateを設定できず、fixedEndDateまたは終了日なしのみ設定できます。

    キャンペーンは指定された日付の米国中部時間（CT、US/Central）の開始を目標とします。目標終了日はCTの現在日付から少なくとも1日後、またはキャンペーンがある場合はキャンペーンのstartDateから少なくとも1日後である必要があります。例えば、目標終了日が2021-06-20の場合、キャンペーンは2021年6月20日の午前0:00 CTを目標とします。

    fundingSource string

    Possible values: [Budget, Bonus Sponsored Job Credits]

    Default value: Budget

    キャンペーンの資金調達ソース。有効な値はBudget（デフォルト）またはBonus Sponsored Job Creditsです。キャンペーンを作成した後に資金調達ソースを変更することはできません。

    Annual Deals クライアントはAnnual Deals の一部としてボーナススポンサー求人クレジットを受け取り、月次または生涯キャンペーンの作成に使用できます。

    objective

    object

    キャンペーンが達成しようとする採用目標で、キャンペーンを目標設定型キャンペーンにします。値は、キャンペーンの目標を指定するobjectiveTypeフィールドと、一部の目標タイプの場合は特定の目標指標を識別するtargetフィールドを持つJSONオブジェクトです。

    例えば、キャンペーンの目標が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日間キャンペーン。Sponsored Jobs APIは現在、この目標でのキャンペーンの作成または変更をサポートしていません。 ただし、Sponsored Jobs APIはこの目標タイプのキャンペーンのキャンペーンレポートの取得は許可しています（これらのキャンペーンはIndeed for Employersを使用して作成されています）。
    • TARGET_APPLICATIONS: targetで指定された応募数への到達を目指します。目標応募数に達すると、これらの求人への支出は大幅に削減され、他の場所に割り当てられます。
    • TARGET_COST_PER_APPLICATION: targetで指定された数値を下回る応募あたりのコストを維持することを目指します。
    • SCHEDULED_INTERVIEWS: スクリーニングされた候補者をすぐに面接に送ります。targetで指定された面接数への到達を目指します。この目標はアクティブなIndeed Hiring Platformサブスクリプションが必要で、顧客が含まれる求人の採用イベントを作成する準備ができている場合のみ使用してください。

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

    any

    channels

    object[]

    チャンネルはデフォルトのチャンネルを含みません。

    例えば、TMNチャンネルを有効にするには、channelsを以下のように設定します:

    [
      {
        "channel": "TMN",
        "status": "CHANNEL_ENABLED"
      }
    ]

  • Array [

    • channel SpendingChannel

    Possible values: [TMN]

    チャンネルID。有効な値は:

    • TMN : Trusted Media Network。
    status ChannelStatus

    Possible values: [CHANNEL_ENABLED, CHANNEL_DISABLED]

    チャンネル支出ステータスID。有効な値は:

    • CHANNEL_ENABLED : チャンネルが支出に対して有効
    • CHANNEL_DISABLED : チャンネルが支出に対して無効

  • ]

Responses​

新しいキャンペーンのキャンペーンIDをdata.campaignIdフィールドとして返します。HTTPステータスは201で、200ではないことに注意してください。

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

    campaignId string
Loading...

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

に最終更新