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

キャンペーンの基本情報を取得する

GET 
/v1/campaigns/:campaignId

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

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

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

Request​

Path Parameters

    campaignId stringrequired

    取得するキャンペーンのキャンペーンID。

Responses​

キャンペーンの基本情報を返します。

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

    Name string

    Possible values: non-empty and <= 250 characters

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

    Id string

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

    Type string

    Possible values: [SOURCE, HOSTED]

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

    Status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Default value: ACTIVE

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

    CurrencyCode string

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

    TrackingToken string

    Possible values: <= 255 characters

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

    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

    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

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

  • ]

    • SpendingChannels SpendingChannel[]

    Possible values: [TMN]

    キャンペーンが予算を消費しているチャネルのリスト。デフォルトのチャネルは除外されます。

    FundingSource string

    キャンペーンの資金源：

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

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

    SponsorshipPlan string

    Annual Deals ボーナスクレジットで資金が供給されるキャンペーンのスポンサーシッププラン。

    • Premium：キャンペーンはプレミアムプランを使用します。
    • "" (空の文字列)：スタンダードキャンペーン。

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

Loading...

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

に最終更新