Note: JavaScript must be enabled for you to properly view versions. It seems JavaScript is either disabled or is not supported by your browser which causes all versions of text to be simultaneously displayed. Enable JavaScript in your browser options, then try again.

AdWords API Resources

Sample Code

FAQ

Developer Forum

AdWords API Blog

LocalBusinessAd

Represents a local business ad, which is associated with a specific business location. These ads have an enhanced map component when shown on Google Maps, Google Earth or select third-party sites that use Google Maps technology, and they appear in standard text ad format on Google and the other sites in the Google Network.

For more information about local business ads, see the Local Business Ads FAQ.

Fields

Inherited Fields

Field nameField typeField description
address string
(Optional) Street address of ad. If specified, must match the address of the business corresponding to the businessKey.
adGroupId long
The id of the AdGroup associated with this Ad. This field is not mutable.
adType AdType
The concrete type of this ad. Generally, this attribute is read only, but may be set by scripting languages to indicate a concrete type.

Values are:

  • TextAd
  • ImageAd
  • LocalBusinessAd
  • MobileAd
  • CommerceAd
  • VideoAd

businessImage Image
Business image for the ad. Maximum image size is 125 x 125 pixels.
businessKey string
The key of the business the ad is for. Not set when returning an existing ad. When adding a new Local Business Ad, set this field to the key of the business you want to associate the ad with. You can obtain valid business keys by calling AdService.findBusinesses or AdService.getMyBusinesses.
businessName string
(Optional) The headline/business name of the ad. If specified, must match the name of the business corresponding to the businessKey provided the real business name is under 25 characters.
city string
(Optional) City of ad. If specified, must match the city of the business corresponding to the businessKey.
countryCode string
Country of ad. If specified, must match the countryCode of the business corresponding to the businessKey.
customIcon Image
Custom 16 x 16 pixel image. This field is used for creating new ads only.
customIconId long
When creating a new local business ad, you can set this field to the icon id of a custom icon previously uploaded to this account. When retrieving an existing local business ad, this field will be populated with the id that AdService assigns to the custom icon used for this ad, if one is used.
description1 string
The first line of description text in the ad. Must not exceed 35 characters.
description2 string
The second line of description text in the ad. Must not exceed 35 characters.
destinationUrl string
The destination URL associated with this Ad. May be overridden on a per-keyword basis by Keyword.destinationUrl. Must not exceed 1024 characters, or 200 characters for mobile ads. Must be in the full "http://" URL format. Example: http://www.google.com
disapproved boolean
Whether this Ad has been disapproved by Google. Disapproved Ads will not be served. Ads might be disapproved for a variety of reasons, see the AdWords Help Center for more information about disapproved ads.
displayUrl string
The URL shown in an Ad. Must not exceed 35 characters, or 20 characters for mobile ads. Mobile ads targeted to Japan must not exceed 10 Japanese characters. The full "http://" URL format is not required. Example: www.google.com
exemptionRequest string
(Optional) Specifies a reason for allowing submission of an Ad or Keyword that violates the ad policies described by Google's AdWords Editorial Guidelines. Maximum length of the exemptionRequest string is 300 characters.

If you want to submit an Ad or Keyword that violates an ad policy, you can specify a string explaining why you want an exemption to the policy in question. For example, if the headline of an Ad violates the policy for excessive punctuation, you might request an exemption such as "Ad for a board game that teaches correct punctuation."

Specifying an exemptionRequest prevents an operation that adds a policy-violating Keyword or Ad from throwing an exception, but does not guarantee that the ad will ultimately be approved.

For more information about Ad Violation policies, see the Google AdWords Editorial Guidelines.

fullBusinessName
  new in v12		 string
The full business name of the ad, which may have been truncated for businessName. This field is read-only.
id long
The numeric ID associated with this Ad. This is set by the AdService when the ad is created and it is not mutable.
latitude
  new in v12		 int
Latitude of the address specified in micro-degrees. This field is read-only.
longitude
  new in v12		 int
Longitude of the address specified in micro-degrees. This field is read-only.
phoneNumber string
(Optional) The phone number associated with the ad.
postalCode string
(Optional) Postal code of ad. If specified, must match the postalCode of the business corresponding to the businessKey.
region string
(Optional) Region of ad. If specified, must match the region of the business corresponding to the businessKey.
status AdStatus
The current status of this ad.

Values are:

  • Enabled
  • Disabled
  • Paused

stockIcon StockIcon
Indicates what standard stock icon to use. One of the three fields stockIcon, customIconId, and customIcon can be used to indicate the image used to identify this ad on maps. These three fields are mutually exclusive -- supplying more than one causes an error to be returned.

Values are:

  • Standard_1 -
  • Standard_2 -
  • Standard_3 -
  • Standard_4 -
  • Standard_5 -
  • Standard_6 -
  • Standard_7 -
  • Standard_8 -
  • Standard_9 -
  • Standard_10 -
  • Standard_11 -
  • Standard_12 -
  • Standard_13 -
  • Standard_14 -
  • Standard_15 -
  • Standard_16 -
  • Standard_17 -

targetRadiusInKm double
Target radius, in kilometers, of the ad. Must be at least 16.09344 and no more than 160.9344.