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

キャンペーンの一般情報を更新

PATCH 
/v1/campaigns/:campaignId

スポンサー求人キャンペーンの基本プロパティを更新します。

OAuthスコープアクセストークンタイプ
employer.advertising.campaign

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

Request​

Path Parameters

    campaignId stringrequired

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

Body

required

リクエスト本文は、キャンペーンに対して行う変更を記述するJSONオブジェクトである必要があります。

HTTPリクエストヘッダー

次のHTTPリクエストヘッダーを含めてください。

  • Content-Type: application/json
  • Accept: application/json

更新

値がnullのフィールドや、リクエストで指定されていないフィールドは、現在の値を維持します。

jobsToIncludeをALLに変更すると、jobsQuery、jobsTitle、jobsCompany、jobsLocation、およびjobsLocationRadiusの既存の値はクリアされます。

目標

平均日次予算（ADB）キャンペーン（STANDARDおよびPREMIUM）では、目標を設定または変更できません。

目標が設定されていないキャンペーンには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]

    キャンペーンのステータス。

    • ACTIVE：キャンペーンを開始します。
    • PAUSED：手動で有効にするまでキャンペーンを非アクティブのままにします。または、有料掲載を一時的に停止します。
    • DELETED：有料掲載を停止し、キャンペーン管理ポータルのデフォルト表示からキャンペーンを非表示にします。
    jobsToInclude string

    Possible values: [ALL, QUERY]

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

    注意: jobsToIncludeが条件なしのQUERYの場合、すべての求人がスポンサーされます。これは将来のバージョンではエラーになります。少なくとも1つの条件を指定するか、jobsToIncludeをALLに設定してください。ボーナスクレジットキャンペーンの場合、採用企業はjobsQueryとjobsToIncludeのみ更新できます。

    jobsQuery string

    これらの検索語を含む求人のみをスポンサーします。ブール式をサポートします。インデックス求人クエリ形式を参照してください。jobsToIncludeがQUERYの場合のみ適用されます。ボーナスクレジットキャンペーンの場合、採用企業はjobsQueryとjobsToIncludeのみ更新できます。

    jobsTitle string

    指定した場合、キャンペーンはこの求人タイトルを持つ求人のみをスポンサーします。jobsToIncludeがQUERYの場合のみ適用されます。

    jobsCompany string

    指定した場合、キャンペーンはこの採用企業を持つ求人のみをスポンサーします。jobsToIncludeがQUERYの場合のみ適用されます。

    jobsLocation string

    指定した場合、キャンペーンはこの場所またはその近くの求人のみをスポンサーします。jobsToIncludeがQUERYの場合のみ適用されます。

    jobsLocationRadius int32

    Default value: 25

    求人の場所とjobsLocationで指定された場所の最大距離。有効な値は5、10、15、25、50、100です。求人が米国または英国にある場合、単位はマイルです。それ以外の場合、単位はキロメートルです。

    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]

    キャンペーンの目標。平均日次予算（ADB）キャンペーン（STANDARDおよびPREMIUM）では、このフィールドを更新できません。

    利用可能な値は:

    • 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

    UpdateAvgDailyBudgetConfig

    object

    平均日次予算（ADB）の詳細。

    ADB キャンペーンの予算を更新する場合は必須です。

    adbBehaviour stringrequired

    Possible values: [AUTO]

    必須。平均日次予算（ADB）の動作。有効な値: AUTO。

    budgetBoostPercentage integer

    Possible values: <= 1500

    求人ごとの基本平均日次予算（ADB）を指定した割合で引き上げます。

    このフィールドは柔軟なADBキャンペーンでのみ使用します。

    月額キャンペーンや一回限りのキャンペーンでは使用しないでください。

    手動またはクエリ解決で新しく追加された求人も、推奨予算に対して同じ割合の引き上げが適用されます。

    有効な値は0から1500です。

Responses​

成功時にHTTP200ステータスコードを返します。

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

    リクエストのcampaignId値。

Loading...

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

に最終更新