Skip to main content

GET/ad_campaign/suggest_budget

Note: This method is only supported for Offsite Ads campaigns. Sellers can use the getAdvertisingEligibility method of the Account API v1 to determine if they are eligible for Offsite Ads.
This method allows sellers to retrieve the suggested budget for an Offsite Ads campaign.

Input

Resource URI

GET https://api.ebay.com/sell/marketing/v1/ad_campaign/suggest_budget

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

This method has no URI parameters.

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

HeaderTypeDescription
X-EBAY-C-MARKETPLACE-IDstringThis header identifies the seller's eBay marketplace.

Note: If a marketplace ID value is not provided, the default value of EBAY_US is used.
See MarketplaceIdEnum for supported values.

Occurrence: Required

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.marketing

eBayUser

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
suggestedBudgetarray of BudgetRecommendationResponse

The suggested allocated daily budget for an Offsite Ads campaign.

Occurrence: Conditional

suggestedBudget.budgetCampaignBudget

The allocated daily budget for the Cost Per Click (CPC) Promoted Listings campaign.

Occurrence: Conditional

suggestedBudget.budget.dailyBudget

The daily budget limit for the Cost Per Click (CPC) Promoted Listings campaign.

Required if the campaign's funding model is CPC.

This will be a dollar value. All clicks using the keywords defined for the campaign will go towards expending the daily budget. Once the daily budget is exceeded for the campaign, all Promoted Listings under the campaign will be turned off until the next day.

When running an Offsite Ads campaign, eBay may spend more or less than the seller's daily budget to capitalize on interested buyers, but will not exceed 2x the daily budget. The average over the course of the campaign will not exceed the provided daily budget. This value is used to calculate a total monthly budget by multiplying 30.4 by the provided daily budget. Over the course of the campaign, eBay will not charge more than this total budget per month.

If a campaign ends prematurely, however, the seller may be charged up to 2x their daily budget on a daily basis, as the campaign may have not had the chance to average the budget out over time.

Valid Values:

  • 50.00
  • 100.00

Occurrence: Conditional

suggestedBudget.budget.daily.amountAmount

The allocated budget amount for a CPC Promoted Listings campaign.

Occurrence: Conditional

suggestedBudget.budget.daily.amount.currencyCurrencyCodeEnum

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Default: The default currency of the eBay marketplace that hosts the listing.

Occurrence: Conditional

suggestedBudget.budget.daily.amount.valuestring

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

suggestedBudget.budget.daily.budgetStatusBudgetStatusEnum

The budget status for a CPC Promoted Listings campaign.

Occurrence: Conditional

suggestedBudget.campaignIdstring

The unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.

Occurrence: Conditional

suggestedBudget.channelsarray of ChannelEnum

The channel for the campaign. This value indicates whether the campaign is an Onsite or Offsite advertising campaign.

Valid Values:

  • ON_SITE
  • OFF_SITE

Occurrence: Conditional

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
400Bad Request
404Not Found
409Business error
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35002API_MARKETINGAPPLICATIONInternal error. Please wait a few minutes and try the call again.
35041API_MARKETINGREQUESTThe 'marketplaceId' is required.
35095API_MARKETINGBUSINESS'marketplaceId' {marketplaceId} is not supported. Offsite Ads is supported only on these marketplaces: {supportedMarketplaces}.

Warnings

This call has no warnings.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Retrieve Suggested Budget for an Offsite Ads Campaign

This example retrieves the suggested budget for an Offsite Ads campaign.

Input

This method does not have a request payload.

GEThttps://api.ebay.com/sell/marketing/v1/ad_campaign/suggest_budget

Output

If the call is successful, the suggested budget for the Offsite Ad campaign is returned, alongside the associated campaignId.

In this sample, the Offsite Ads campaign has a suggested allocated budget of 20 USD per day.