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.

REST Resource: customers.smartCampaignSettings

Resource: SmartCampaignSetting

Settings for configuring Smart campaigns.

JSON representation
{
  "resourceName": string,
  "campaign": string,
  "phoneNumber": {
    object (PhoneNumber)
  },
  "finalUrl": string,
  "advertisingLanguageCode": string,

  // Union field business_setting can be only one of the following:
  "businessName": string,
  "businessLocationId": string
  // End of list of possible types for union field business_setting.
}
Fields
resourceName

string

Immutable. The resource name of the Smart campaign setting. Smart campaign setting resource names have the form:

customers/{customerId}/smartCampaignSettings/{campaignId}

campaign

string

Output only. The campaign to which these settings apply.

phoneNumber

object (PhoneNumber)

Phone number and country code.

finalUrl

string

Landing page url given by user for this Campaign.

advertisingLanguageCode

string

The ISO-639-1 language code to advertise in.

Union field business_setting. The business setting of this campaign. business_setting can be only one of the following:
businessName

string

The name of the business.

businessLocationId

string (int64 format)

The ID of the Google My Business (GMB) Location. The location ID can be fetched by GMB API with its form: accounts/{accountId}/locations/{locationId}. The last {locationId} component from the GMB API represents the businessLocationId. See the Google My Business API

PhoneNumber

Phone number and country code in smart campaign settings.

JSON representation
{
  "phoneNumber": string,
  "countryCode": string
}
Fields
phoneNumber

string

Phone number of the smart campaign.

countryCode

string

Upper-case, two-letter country code as defined by ISO-3166.

Methods

get

Returns the requested Smart campaign setting in full detail.

mutate

Updates Smart campaign settings for campaigns.