MobileAd Data Object

MobileAd Data Object

Microsoft Advertising APIs

Represents a mobile ad. A mobile ad is displayed to a user when the ad is viewed on a mobile device. This object is derived from the Ad object.

Syntax

<xs:complexType name="MobileAd">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:Ad">
      <xs:sequence>
        <xs:element minOccurs="0" name="BusinessName" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="DisplayUrl" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="PhoneNumber" nillable="true" type="xs:string" />
        <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
        <xs:element name="Title" nillable="true" type="xs:string" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>
<xs:element name="MobileAd" nillable="true" type="tns:MobileAd" />

Elements

Element	Description	Data Type	Add	Update	Rules
`BusinessName`	Specifies the name of the business for the mobile ad.	`string`	Optional If not specified, the `DestinationUrl` and `DisplayUrl` elements are required.	Optional	BusinessName Element
`DestinationUrl`	Specifies the URL of the webpage that people visit when they click the ad.	`string`	Optional If not specified, the `BusinessName` and `PhoneNumber` elements are required.	Optional	DestinationUrl Element
`DisplayUrl`	Specifies the display URL for the ad.	`string`	Optional If not specified, the `BusinessName` and `PhoneNumber` elements are required.	Optional	DisplayUrl Element
`PhoneNumber`	Specifies the phone number for the mobile ad. This is the phone number that is dialed when the ad is clicked.	`string`	Optional If not specified, the `DestinationUrl` and `DisplayUrl` elements are required.	Optional	PhoneNumber Element
`Text`	Specifies the text of the ad.	`string`	Required	Optional	Text Element
`Title`	Specifies the title of the ad.	`string`	Required	Optional	Title Element

Inherited Elements

The elements in the following table are inherited from the Ad object.

Element	Description	Data Type	Add	Update	Rules
`EditorialStatus`	Specifies the approval status of the ad.	AdEditorialStatus	Not used	Not used	None
`Id`	Identifies the ad.	`long`	Read-only	Required Specifies the ad to update.	None
`Status`	Specifies the status of the ad.	AdStatus	Not used	Not used	Status Element
`Type`	Specifies the type of the ad.	AdType	Read-only	Read-only	Type Element

Business Rules

General Business

There can be no more than 20 ads in an ad group.

For more information, see the Business Rules section of the Ad data object.

Element Rules

BusinessName Element

The maximum length for the BusinessName element in a mobile ad is 20 characters.

DestinationUrl Element

For mobile ads, the maximum length for the DestinationUrl element is 1,022 characters.

This element can be set to the same value as the Param1 element of the Keyword data object.

You can use destination URL dynamic text strings as shown in the following table to track information for the ad that was clicked.

Dynamic Text	Description
{MatchType}	Substitutes the following letters into the destination URL: For search ads: e – Exact p – Phrase b – Broad For content ads – c
{OrderItemId}	Substitutes the keyword ID into the destination URL.
{AdId}	Substitutes the ad ID into the destination URL.
{QueryString}	Substitutes the exact search term entered by the user into the destination URL.

Note:
The previously shown dynamic text strings are case-insensitive and must include the braces. The destination URL dynamic text strings apply only to the destination URL. If you use them for the title, description, or display URL, they display as literal strings.

The dynamic text strings are replaced by the appropriate text. For example, {OrderItemId} is replaced by the keyword identifier. Likewise, {MatchType} is replaced with c for a content ad or e for an exact match type. You need to format the URL in a way that can be interpreted by the server; for example, the following is a destination URL:

http://www.northwindtraders.com/{MatchType}/default.aspx?keyword_id={OrderItemId}

If the user clicks an ad that has a keyword identifier of 12345 and a keyword that is an exact match to the query, the actual destination URL is formatted as follows:

http://www.northwindtraders.com/e/default.aspx?keyword_id=12345

The approval process doesn't resolve the parameters for the destination URL dynamic text. A destination URL that has the literal dynamic text strings must exist on your website. Otherwise, the ad is disapproved during the approval process. For example, if the destination URL is as follows:

http://www.northwindtraders.com/default.aspx?query={QueryString}&AdId={AdId}

The approval process attempts to verify the following URL:

http://www.northwindtraders.com/default.aspx?query={QueryString}&AdId={AdId}

If this URL doesn't exist, the approval process disapproves the ad association.

In addition to the dynamic text strings previously shown, the DestinationUrl element supports the {Param1} and {Keyword} dynamic text strings. For more information, see Parameters and Automatic Keyword Insertion.

DisplayUrl Element

The maximum length of the DisplayUrl element is 200 characters. The maximum length of the displayed URL after all the parameters have been expanded is 20 characters.

PhoneNumber Element

The maximum length of the PhoneNumber element is 20 characters.

Status Element

The Status element can be changed only by using either the PauseAds or the ResumeAds service operation.

Text Element

The maximum length of the Text element is 300 characters. The maximum length of the displayed mobile ad text after all the parameters have been expanded is 18 characters.

Title Element

The maximum length of the Title element is 80 characters. The maximum length of the displayed mobile ad title after all the parameters have been expanded is 18 characters.

Type Element

The Type element is read-only. It is set at creation time based on the type of derived ad object that is used to create the object. For mobile ads, this element always contains "Mobile".

Requirements

WSDL: CampaignManagementService.svc in version 6.

Reference

TextAd Data Object