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

採用企業のキャンペーンとステータスを一覧表示

GET 
/v1/campaigns

採用企業のキャンペーンとそのステータスを一覧表示します。結果はページネーションされる場合があります。

例： アクティブなキャンペーンを最大100件ずつ表示する:

https://apis.indeed.com/ads/v1/campaigns?status=ACTIVE&perPage=100
OAuthスコープアクセストークンタイプ
employer.advertising.campaign.read

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

Request​

Query Parameters

    perPage integer

    Default value: 30

    レスポンス内のキャンペーンの最大数。要求した最大数よりも少ないキャンペーンが返される場合があります。常にレスポンスで次のページを確認してください。1ページあたりの最大上限は500キャンペーンです。

    start string

    ページネーションされたレスポンス内の位置。次のページの結果に対応する値は、結果が利用可能な場合はレスポンスに含まれます。

    status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    キャンペーンステータス。キャンペーンステータスで結果をフィルタリングするには、ACTIVE、DELETED、またはPAUSEDのいずれかを渡します。デフォルトはすべてのステータスのキャンペーンを返します。

    type string

    Possible values: [SOURCE, HOSTED]

    求人タイプ。キャンペーンがスポンサーする求人のタイプで結果をフィルタリングするには、SOURCE（ウェブから収集された求人、またはXMLフィードを使用してIndeedに送信された求人）またはHOSTED（求人投稿ページを使用して投稿された求人）のいずれかを渡します。デフォルトはいずれかのタイプの求人を持つキャンペーンを返します。

    fields string

    レスポンスに含めるフィールドのカンマ区切りリスト。有効な値はId、Name、Status、NonSpendingReasons、Type、CurrencyCode、TrackingToken、StartDate、FixedEndDate、TargetEndDate、BudgetOnetimeLimit、BudgetMonthlyLimit、FundingSource、SponsorshipPlan、およびDailyAvgBudgetPerJobです。デフォルトはId、Name、Statusです。

    campaignIds string

    キャンペーンを一覧表示するcampaignIdsのカンマ区切りリスト。最大50件のキャンペーンIDをサポートします。fieldsクエリパラメータのみをサポートします。

Responses​

キャンペーンを一覧表示します。一致するキャンペーンが見つからずcampaignIdsが省略された場合、HTTP200ステータスコードとともに空のdata.Campaigns配列を返します。

結果はページネーションされる場合があります。さらに結果がある場合、meta.links配列には"rel": "next"のアイテムが含まれます。href値をベースURLに追加して次のページを取得します。

next URLにはstartパラメータのみが含まれます。perPage、status、またはtypeにデフォルト以外の値を使用した場合は、URLに手動で追加してください。

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に追加します。

  • ]

    • 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

    data

    object

    Campaigns

    object[]

  • Array [

    • Name string

    Possible values: non-empty and <= 250 characters

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

    Id string

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

    Status string

    Possible values: [ACTIVE, DELETED, PAUSED]

    Default value: ACTIVE

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

    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

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

  • ]

    • Type string

    Possible values: [SOURCE, HOSTED]

    キャンペーンがスポンサーする求人のタイプ。ウェブから収集された求人、またはXMLフィードを使用してIndeedに送信された求人にはSOURCE、求人投稿ページを通じて投稿された求人にはHOSTED。

    CurrencyCode string

    キャンペーン予算の通貨のISO 4217通貨コード。

    TrackingToken string

    Possible values: <= 255 characters

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

    BudgetOnetimeLimit number

    キャンペーンの一括予算上限。budgetOnetimeLimitとbudgetMonthlyLimitを同時に設定することはできません。

    BudgetMonthlyLimit number

    キャンペーンの月次予算上限。dailyAvgBudgetPerJob、budgetOnetimeLimit、budgetMonthlyLimitを同時に設定することはできません。

    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

    キャンペーンの資金調達ソース:

    • Bonus Sponsored Job Credits: Annual Deals ボーナスクレジットで資金調達。
    • Budget: 通常の予算で資金調達。

    可能な値: [Bonus Sponsored Job Credits、Budget]。

    SponsorshipPlan string

    Annual Deals ボーナスクレジットで資金調達されたキャンペーンのスポンサーシッププラン。標準キャンペーンは空の文字列（""）を返します。プレミアムプランキャンペーンは"Premium"を返します。

    可能な値: [Premium、``（空の文字列）]

    DailyAvgBudgetPerJob number

    キャンペーンの各求人の1日平均予算。平均日次予算（ADB）モデルを使用するキャンペーンにのみ返されます。dailyAvgBudgetPerJobとbudgetMonthlyLimitを同時に設定することはできません。

  • ]

Loading...

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

に最終更新