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

新しいキャンペーンの作成

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を指定します。詳しくは、「What is the Trusted Media Network (TMN)?」（Trusted Media Network（TMN）とは）をご覧ください。有効化または無効化するチャネルを設定してキャンペーンを作成した後は、各チャネルのステータスを変更することはできません。

各フィールドの詳細と値の例については、定義モデルをご覧ください。リクエストの例については、「Getting Started Guide」（スタートガイド）をご覧ください。

    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 から行われたこと、また必要に応じてクリックのスポンサーとなったキャンペーンを特定できます。

    jobsToInclude string

    Possible values: [ALL, QUERY]

    求人ソース内のすべての求人を有料掲載する場合は ALLに設定し、一部の求人を有料掲載する場合はQUERY に設定します。

    ここで ALLに設定する場合、このキャンペーンは求人ソース内の求人すべてを有料掲載します。jobsQuery、jobsTitle、jobsCompany、jobsLocation、jobsLocationRadius の各フィールドの値は無視されます。

    これが QUERYの場合、このキャンペーンは、jobsQuery、jobsTitle、jobsCompany、jobsLocation、jobsLocationRadiusの 各フィールドに指定された条件と一致する一部の求人を有料掲載します。複数のフィールドを指定した場合は、指定した条件すべてと一致した求人のみが有料掲載されます。

    注： jobsToIncludeがQUERYの場合に、すべての条件が未指定もしくは空の場合、キャンペーンは求人ソース内の求人すべてを有料掲載します。API の今後のバージョンでは、これはエラーとして扱われる予定です。少なくとも1つの条件を指定するか、すべての求人を有料掲載する場合は、jobsToIncludeをALLと 設定することをお勧めします。

    jobsQuery string

    指定すると、キャンペーンはこれらの検索キーワードを含む求人のみを有料掲載します。クエリには複雑なブール式を含めることができます。詳しくは、Indexed jobs query format（インデックス求人のクエリ形式）をご覧ください。これは、 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のみです。単位は、求人の勤務地が米国または英国内の場合はマイル、それ以外の場合はkmです。

    jobsSourceName string

    この求人の掲載元または企業。XML Jobフィードの求人用の「sourename」ノードと一致する必要があります。

    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 を指定）、キャンペーンの開始日が月初日ではない場合に、初月の予算を計算する方法を指定します。

    値意味例：月額予算が9万円で、開始日が6月11日の場合に適用される予算
    6月11～30日7月1～31日
    startNowFullAmount初月の予算は1か月分全額です。9万円9万円
    startNowProratedAmount初月の予算は、開始日から月末までの残り日数で日割り計算されます。6万円9万円
    startNextMonthFullAmount初月はキャンペーンに予算が割り当てられず、有料掲載は行われません。0円9万円
    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

    Possible values: [Budget, Bonus Sponsored Job Credits]

    Default value: Budget

    キャンペーンの資金源です。指定可能な値は Budget（デフォルト）または Bonus Sponsored Job Credits です。キャンペーン作成後に資金源を変更することはできません。

    Annual Deals のクライアントは、契約条件に基づいて Bonus Sponsored Job Credits を受け取り、月額または全期間のキャンペーン作成に使用できます。

    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日間のキャンペーンは予算が高くなりますが、より早く結果につながります。Sponsored Jobs APIは現在、この目標を指定したキャンペーンの作成や変更をサポートしていません。ただし、Sponsored Jobs APIは、この目標タイプを指定したキャンペーンに関するキャンペーンレポートの取得には対応しています（これらのキャンペーンは、Indeed 求人掲載を使用して作成されます）。
    • 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 SpendingChannelrequired

    Possible values: [TMN]

    チャネルID。次の値が有効です。

    • TMN ：Trusted Media Network。
    status ChannelStatusrequired

    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パラメータでリクエストした最大値より小さい場合があります。エンドポイントが返す結果が1つの場合や、ページ付けが行われない場合は、値はnullになります。

    links

    object[]

    リクエストされたリソースに関連するリソース。

  • Array [

    • rel string

    リクエストされたリソースと関連リソースの関係。次の値が一般的に使用されます。

    • up：関連リソースはリクエストされたリソースを含むコレクション、またはリクエストされたリソースが付加されているエンティティ。
    • next：ページ付けされた結果内で次のエントリーのページ。
    • prev：ページ付けされた結果内で前のエントリーのページ。

    ただし、この値は関係を説明する Campaign Infoのような任意の文字列の場合もあります。

    href string

    関連リソースのエンドポイントのURL。クエリの文字列パラメータを含む場合があります。完全なURLを取得するには、rootLocationにhrefを追加します。

  • ]

    • data

    object

    campaignId string
Loading...

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

に最終更新