Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.suggestSmartCampaignBudgetOptions

Returns BudgetOption suggestions.

HTTP request

POST https://googleads.googleapis.com/v8/customers/{customerId}:suggestSmartCampaignBudgetOptions

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer whose budget options are to be suggested.

Request body

The request body contains data with the following structure:

JSON representation
{

  // Union field suggestion_data can be only one of the following:
  "campaign": string,
  "suggestionInfo": {
    object (SmartCampaignSuggestionInfo)
  }
  // End of list of possible types for union field suggestion_data.
}
Fields
Union field suggestion_data. Required. For first time campaign creation use SuggestionInfo, for subsequent updates on BudgetOptions based on an already created campaign use that campaign. suggestion_data can be only one of the following:
campaign

string

Required. The resource name of the campaign to get suggestion for.

suggestionInfo

object (SmartCampaignSuggestionInfo)

Required. Information needed to get budget options

Response body

If successful, the response body contains data with the following structure:

Response message for [SmartCampaignSuggestService.SuggestSmartCampaignBudgets][]. Depending on whether the system could suggest the options, either all of the options or none of them might be returned.

JSON representation
{
  "low": {
    object (BudgetOption)
  },
  "recommended": {
    object (BudgetOption)
  },
  "high": {
    object (BudgetOption)
  }
}
Fields
low

object (BudgetOption)

Optional. The lowest budget option.

recommended

object (BudgetOption)

Optional. The recommended budget option.

high

object (BudgetOption)

Optional. The highest budget option.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

BudgetOption

Smart Campaign budget option.

JSON representation
{
  "dailyAmountMicros": string,
  "metrics": {
    object (Metrics)
  }
}
Fields
dailyAmountMicros

string (int64 format)

The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.

metrics

object (Metrics)

Metrics pertaining to the suggested budget, could be empty if there is not enough information to derive the estimates.

Metrics

Performance metrics for a given budget option.

JSON representation
{
  "minDailyClicks": string,
  "maxDailyClicks": string
}
Fields
minDailyClicks

string (int64 format)

The estimated min daily clicks.

maxDailyClicks

string (int64 format)

The estimated max daily clicks.