Printer Friendly Version      Send     
Click to Rate and Give Feedback
MSDN
MSDN Library
Web Development
Windows Live
 Keyword Data Object (V5.1)
Windows Live
Keyword Data Object (V5.1)

Represents a Microsoft adCenter keyword.

Elements

Business Rules

Element Rules

<xs:complexType name="Keyword">
    <xs:sequence>
        <xs:element minOccurs="0" name="BroadMatchBid" nillable="true" type="xs:double"/>
        <xs:element minOccurs="0" name="ContentMatchBid" nillable="true" type="xs:double"/>
        <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:KeywordEditorialStatus"/>
        <xs:element minOccurs="0" name="ExactMatchBid" nillable="true" type="xs:double"/>
        <xs:element minOccurs="0" name="ExemptionRequest" nillable="true" type="xs:string"/>
        <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long"/>
        <xs:element minOccurs="0" name="NegativeKeywords" nillable="true" type="q16:ArrayOfstring" xmlns:q16="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
        <xs:element minOccurs="0" name="Param1" nillable="true" type="xs:string"/>
        <xs:element minOccurs="0" name="Param2" nillable="true" type="xs:string"/>
        <xs:element minOccurs="0" name="Param3" nillable="true" type="xs:string"/>
        <xs:element minOccurs="0" name="PhraseMatchBid" nillable="true" type="xs:double"/>
        <xs:element minOccurs="0" name="Status" nillable="true" type="tns:KeywordStatus"/>
        <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string"/>
    </xs:sequence>
</xs:complexType>

<xs:complexType name="ArrayOfKeyword">
    <xs:sequence>
        <xs:element minOccurs="0" maxOccurs="unbounded" name="Keyword" nillable="true" type="tns:Keyword"/>
    </xs:sequence>
</xs:complexType>

Element Description Data Type Add Update Business Rules

BroadMatchBid

Specifies the amount of the broad match bid for a keyword.

double

Optional

Optional

To remove this match type, set this property to zero.

Bid Amounts

ContentMatchBid

Specifies the amount of the content match bid for a keyword.

double

Optional

Optional

To remove this match type, set this property to zero.

ContentMatchBid Element

Bid Amounts

EditorialStatus

Not used. Reserved for future use.

KeywordEditorialStatus

Not used

Not used

None

ExactMatchBid

Specifies the amount of the exact match bid for a keyword.

double

Optional

Optional

To remove this match type, set this property to zero.

Bid Amounts

ExemptionRequest

Not used. Reserved for future use.

string

Not used

Not used

None

Id

Identifies the keyword.

long

Read-only

Required; Identifies the keyword to update.

None

NegativeKeywords

Specifies one or more negative keywords.

string array

Optional

Optional

NegativeKeywords Element

Param1

Specifies the first substitute parameter that can be inserted into an ad title, description, display URL, or destination URL.

string

Optional

Optional

Param1 Element

Param2

Specifies the second substitute parameter that can be inserted into an ad title, description, display URL, or destination URL.

string

Optional

Optional

Param2 Element

Param3

Specifies the third substitute parameter that can be inserted into an ad title, description, display URL, or destination URL.

string

Optional

Optional

Param3 Element

PhraseMatchBid

Specifies the amount of the phrase match bid for a keyword.

double

Optional

Optional

To remove this match type, set this property to zero.

Bid Amounts

Status

Specifies the status of the keyword.

KeywordStatus

Not used

Not used

Status Element

Text

Specifies the text of the keyword.

string

Required.

Read-only

None

Bid Amounts

You can specify up to two decimal places for the BroadMatchBid, ContentMatchBid, ExactMatchBid, and PhraseMatchBid elements.

For more information, see Minimum and Maximum Amounts for Bids.

ContentMatchBid Element

To display Microsoft Content Ads with the Microsoft adCenter API, your ad group must target the United States distribution region.

If you use the adCenter API Content Ads properties and your ad group doesn't target the United States distribution region, your service operation calls will return successfully. However, no action will be taken for the values of the content ads.

Only the search ads values are used by adCenter if your ad group doesn't target the United States distribution region.

Param1 Element

The maximum length of this element is 1,022 characters. Because the maximum length of this parameter matches the maximum length of the destination URL, this substitute parameter is especially useful for inserting keywords into a destination URL.

Param2 Element

The maximum length of this element is 70 characters. Because of this limitation, you should use this substitute parameter only for descriptive text. For destination URLs, you should use only the Param1 element.

Param3 Element

The maximum length of this element is 70 characters. Because of this limitation, you should use this substitute parameter only for descriptive text. For destination URLs, you should use only the Param1 element.

NegativeKeywords Element

Negative keywords are keywords that, if included in a search, prevent a match with the keyword. For more information about negative keywords, see Negative Keywords.

You can apply negative keywords to a keyword only if a broad or phrase match type has been specified and no exact match bid has been specified.

The maximum length of a single string in this array is 100 characters.

The maximum combined length for all strings in this array is 1,022 characters.

Status Element

This element can be changed only by using either the CampaignManagementServiceClient.PauseKeywords or the CampaignManagementServiceClient.ResumeKeywords service operation.

WSDL: CampaignManagement.svc in version 5.1.

© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker