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

基本的なキャンペーン情報の更新

PATCH 
/v1/campaigns/:campaignId

既存のスポンサー求人キャンペーンの基本情報を更新します。

OAuthのスコープアクセストークンの種類
employer.advertising.campaign

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

Request​

Path Parameters

    campaignId stringrequired

    更新するキャンペーンのキャンペーンID。

Body

required

リクエスト本文は、キャンペーンに対して行う変更を記述するJSONオブジェクトである必要があります。リクエストには Content-Type: application/json ヘッダーを含めるようにしてください。

値が nullのフィールドや、リクエストで指定されていないフィールドは、現在の値を維持します。ただし、jobsToIncludeをALLに変更すると、 jobsQuery、jobsTitle、jobsCompany、jobsLocation、およびjobsLocationRadiusの既存の値は クリアされます。

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

    name string

    Possible values: non-empty and <= 250 characters

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

    trackingToken string

    Possible values: <= 255 characters

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

    status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    キャンペーンのステータス。キャンペーンのスポンサー求人を停止するには、PAUSEDまたはDELETEDに設定します。DELETEDの場合は、キャンペーンがキャンペーン管理ポータルのデフォルトビューにも表示されなくなります。

    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です。

    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

Responses​

正常に実行されると、HTTPステータスとして200 を返します。

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

    campaignId string

    リクエストで指定されるcampaignId と常に同じ値です。

Loading...

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

に最終更新