Google Code offered in: English - Español - 日本語 - 한국어 - Português - Pусский - 中文(简体) - 中文(繁體)
Documentation for the requested version is not available.Documentation for the requested diff is not available.
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.
| Field name | Field type | Field description |
|---|---|---|
| address | string |
(Optional) Street address of ad. If specified, must match the
address of the business corresponding to the businessKey. |
| adGroupId | long |
ID of the ad group associated with this ad.
This field is not mutable. |
| adType | AdType |
Concrete type of this ad. Generally, this field is
read-only, but may be set by scripting languages to indicate a concrete
type.
Values are:
|
| 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 |
Destination URL associated with this ad. May be overridden
on a per-keyword basis by Keyword.destinationUrl.
Must less than 1024 characters (or 200 characters for mobile ads).
Must use the http://your-domain-name format (for example,
http://www.google.com). |
| disapproved | boolean |
True if 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 |
URL shown in this ad. Must not exceed 35 characters (or
20 characters for mobile ads). Mobile
ads targeted to Japan must not exceed 10 Japanese characters.
http:// is not required (for examle,
www.google.com). |
| exemptionRequest | string |
Reason for allowing submission of an ad that violates the ad
policies described by Google's AdWords Editorial Guidelines. Must be no
longer than 300 characters.
Set this field only if this ad violates policy. Unnecessarily specifying an exemption request will cause any add or update operation to fail. For more information, see Policy Checking in the Web Services overview. |
| fullBusinessName | string |
The full business name of the ad, which may have been truncated for
businessName. This field is read-only. |
| id | long |
ID of this ad. This field is set by AdService when
the ad is created and it is not mutable. |
| latitude | int |
Latitude of the address specified in micro-degrees. This field
is read-only. |
| longitude | 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 |
Current status of this ad.
Values are:
|
| 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:
|
| targetRadiusInKm | double |
Target radius, in kilometers, of the ad. Must be at least 16.09344
and no more than 160.9344. |