LocationAdExtension Data Object - Campaign Management
Defines an ad extension that specifies a business address and phone number to include in a text ad.
You can associate a location ad extension with the account or with campaigns in the account. Each entity (account or campaign) can be associated with as many location ad extensions as you decide, up to the total number of location ad extensions in your account.
<xs:complexType name="LocationAdExtension" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexContent mixed="false"> <xs:extension base="tns:AdExtension"> <xs:sequence> <xs:element minOccurs="0" name="Address" nillable="true" type="tns:Address" /> <xs:element minOccurs="0" name="CompanyName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="GeoCodeStatus" nillable="true" type="tns:BusinessGeoCodeStatus" /> <xs:element minOccurs="0" name="GeoPoint" nillable="true" type="tns:GeoPoint" /> <xs:element minOccurs="0" name="PhoneNumber" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType>
|Address||The business address.
The supported country code values include AR, AT, AU, BR, CA, CH, CL, CO, DE, DK, ES, FI, FR, GB, HK, ID, IE, IN, IT, MX, MY, NL, NZ, NO, PE, PH, SE, SG, TH, TW, US, VE, and VN.
|CompanyName||The name of the business. The name can contain a maximum of 80 characters.
|GeoCodeStatus||A status value that indicates whether the business latitude and longitude coordinates have been determined.
If you provide the coordinates, the status will be set to Complete; otherwise, the status will indicate the progress of determining the coordinates of the specified business address.
Add: Not allowed
Update: Not allowed
|GeoPoint||The latitude and longitude coordinates of the specified Address element. The coordinates are used to mark the business location on Bing Maps when the user clicks the address on the ad. If the specified coordinates are not within the range of valid values, the service determines the coordinates based on the address.
If you specify the known coordinates, the service does not confirm whether the specified coordinates match the specified business address. If you do not provide the coordinates, the AddAdExtensions operation uses the business address to determine the coordinates.
When adding more than 10 location ad extensions, the service resolves coordinates offline, and otherwise resolves coordinates up front during execution of the service operation. The location will not be used in an ad until the coordinates are determined, which can take from seconds to minutes depending on the number of location ad extensions being added and the current demand.
To determine whether the coordinates have been resolved, call the GetAdExtensionsByIds operation and access the GeoCodeStatus element. For a list of possible status values see BusinessGeoCodeStatus.
|PhoneNumber||The business phone number to include in the ad. The phone number is clickable on hi-fi mobile devices.
The phone number can contain a maximum of 35 characters and must be valid for the specified country.
If the campaign also includes a call extension, the phone number in the call extension, will override this phone number.
Update: Optional. If you set this element null, the previous setting will be deleted.
Inherited Elements from AdExtension
The LocationAdExtension object derives from the AdExtension object, and inherits the following elements: DevicePreference, ForwardCompatibilityMap, Id, Scheduling, Status, Type, Version. The descriptions below are specific to LocationAdExtension, and might not apply to other objects that inherit the same elements from the AdExtension object.
|DevicePreference||Not supported for this ad extension type.||long|
|ForwardCompatibilityMap||The list of key and value strings for forward compatibility to avoid otherwise breaking changes when new elements are added in the current API version.
There are currently no forward compatibility changes for the AdExtension object.
|Id||The unique Microsoft Advertising identifier of the ad extension.
Update: Read-only and Required
|Scheduling||Determines the calendar day and time ranges when the ad extension is eligible to be shown in ads.
Update: Optional. If you set this element null, any existing scheduling set for the ad extension will remain unchanged. If you set this to any non-null Schedule object, you are effectively replacing existing scheduling settings for the ad extension. To remove all scheduling set this element to an empty Schedule object.
|Status||The status of the ad extension. The value will always be Active because the Campaign Management service does not return deleted ad extensions.
|Type||The type of the ad extension. This value is LocationAdExtension when you retrieve a location ad extension.
For more information about ad extension types, see the Ad Extension Data Object Remarks.
|Version||Tracks the number of times the ad extension has been updated.
The version is set to 1 when the ad extension is created, and increments by one after each update.
Add: Not allowed
Update: Not allowed
Service: CampaignManagementService.svc v13