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

Get campaign budget quote

POST 
/v1/campaignbudgetquote

Gets recommended daily budgets for jobs before you create an average daily budget (ADB) campaign.

Returns a campaign-level average budget quote, a budget quote for each matched job, and recommended budgets for the STANDARD and PREMIUM tiers.

The recommended daily budget is a target, not a guarantee.

Indeed optimizes toward it, but daily spend can vary.

For example, if the average daily budget is $25, spend might be $20 on day 1 and $30 on day 2.

Calls to this endpoint are not charged under the Sponsored Jobs API usage policy.

  • Wait 2 to 3 hours after posting new jobs before creating a campaign.

  • Create the campaign within 1 hour of the budget recommendation call.

    After 1 hour, market conditions can change, and campaign creation uses the latest recommended budgets.

  • Jobs added automatically through query-based job resolution, including after campaign creation, use recommended budgets as the default daily spend.

  • Jobs added manually to a campaign also use recommended budgets as the default daily spend.

Request​

Body

required

Request body must be a JSON object that defines the campaign updates.

HTTP request headers

Include these HTTP request headers:

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

    Jobs query.

    If set, the campaign sponsors only jobs that match these search terms.

    Supports Boolean expressions.

    See Indexed jobs query format.

    Applies only when jobsToInclude is QUERY.

    jobsTitle string

    Job title in the query.

    If set, the campaign sponsors only jobs with this title.

    Applies only when jobsToInclude is QUERY.

    jobsCompany string

    Hiring company in the query.

    If set, the campaign sponsors only jobs from this company.

    Applies only when jobsToInclude is QUERY.

    jobsLocation string

    Job location in the query.

    If set, the campaign sponsors only jobs at or near this location.

    Applies only when jobsToInclude is QUERY.

    jobsLocationRadius int32

    Default value: 25

    Maximum distance from the job location to jobsLocation in the query.

    Valid values are 5, 10, 15, 25, 50, and 100.

    Use miles for jobs in the United States and the United Kingdom.

    Use kilometers in all other countries.

    jobsSourceId string

    Source ID that overrides jobsSource.

    It identifies the job source used by the campaign.

    Use the id of a job source from jobSourceList in GET /v1/account.

    If the employer account has no job sources, contact Indeed Customer Support.

    Each campaign supports only one jobsSourceId.

    If you have multiple job sources, create a separate campaign for each source.

    jobsSourceName string

    Source name.

    For ATS partners only.

    jobsToInclude stringrequired

    Possible values: [ALL, QUERY]

    Required. Use ALL or QUERY.

    ALL sponsors all jobs in the job source.

    With ALL, the API ignores jobsQuery, jobsTitle, jobsCompany, jobsLocation, and jobsLocationRadius.

    QUERY sponsors only jobs that match the criteria you provide.

    If you provide more than one criterion, jobs must match all of them.

    If you set jobsToInclude to QUERY but provide no criteria, the campaign currently sponsors all jobs in the job source.

    To avoid errors, provide at least one criterion.

Responses​

Success

Schema

    meta

    object

    Response-related metadata.

    status int32

    HTTP status code of the response.

    errors

    object[]

    Errors that prevented the request from being processed successfully.

    If there are no errors, this value is null.

  • Array [

    • type string

    Name of the error.

    description string

    Human-readable description of the problem.

  • ]

    • rootLocation string

    Base URL of the Sponsored Jobs API.

    perPage int32

    For endpoints that return paginated results, the effective maximum number of entries returned on one page.

    The value may be smaller than the maximum you requested with the perPage parameter.

    If the endpoint returns a single result or doesn't paginate, the value is null.

    links

    object[]

    Resources related to the requested resource.

  • Array [

    • rel string

    The relationship between the requested resource and the related resource. These values are commonly used:

    • up: The related resource is a collection that contains the requested resource, or an entity that the requested resource is attached to.

    • next: The next page of entries in a paginated result.

    • prev: The previous page of entries in a paginated result.

    However, the value may also be an arbitrary string describing the relationship, such as Campaign Info.

    href string

    Endpoint URL of the related resource.

    Can contain query string parameters.

    To get the complete URL, append the href to rootLocation.

  • ]

    • data

    object

    sponsorshipPlanBudgetQuotes

    object[]

    List of budget quotes for each sponsorship plan. Current values:

    • PREMIUM: Campaign uses the premium plan.

    • STANDARD: Campaign uses the standard plan.

  • Array [

    • sponsorshipPlan string

    Possible values: [PREMIUM, STANDARD]

    Sponsorship plan for the annual deals bonus credits-funded campaign.

    • PREMIUM: Campaign uses the premium plan.

    • STANDARD: Campaign uses the standard plan.

    dailyAvgBudgetPerJob

    object

    Average of the job budget quotes for this sponsorship plan.

    In GET campaign details, this matches avgDailyBudgetConfig.recommendedBudgetPerJob.

    If budgetBoostPercentage is applied during campaign creation, the effective average daily budget (ADB) per job can increase, so this value can differ from avgDailyBudgetConfig.dailyAvgBudgetPerJob.

    amount number

    Budget amount in currency.

    currency string

    ISO 4217 currency code, such as JPY or USD.

    jobBudgetQuotes

    object[]

    Budget quote for each job matched by the request. Limited to 900 jobs. If the job parameters match more than 900 jobs, the API returns a 400 error.

  • Array [

    • jobKey string

    Indeed-generated unique identifier for this job.

    dailyBudget

    object

    Daily budget target for the job in an average daily budget (ADB) campaign.

    amount number

    Budget amount in currency.

    currency string

    ISO 4217 currency code, such as JPY or USD.

  • ]

  • ]

Loading...

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