Export (0) Print
Expand All
Ad
Bid
Expand Minimize

Keyword Data Object

Defines a keyword.

<xs:complexType name="Keyword">
  <xs:sequence>
    <xs:element minOccurs="0" name="Bid" nillable="true" type="tns:Bid" />
    <xs:element minOccurs="0" name="DestinationUrl" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="EditorialStatus" nillable="true" type="tns:KeywordEditorialStatus" />
    <xs:element minOccurs="0" name="ForwardCompatibilityMap" nillable="true" type="q30:ArrayOfKeyValuePairOfstringstring" xmlns:q30="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
    <xs:element minOccurs="0" name="Id" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="MatchType" nillable="true" type="tns:MatchType" />
    <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="Status" nillable="true" type="tns:KeywordStatus" />
    <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" />
  </xs:sequence>
</xs:complexType>

Elements

Element

Description

Data Type

Add

Update

Bid

The bid to use when the user’s search term and the keyword match.

Bid

Required

Optional

DestinationUrl

The URL of the webpage to take the user to when they click the ad. The keyword’s destination URL is used if specified; otherwise, the ad’s destination URL is used.

string

Optional

Optional

EditorialStatus

The editorial review status of the keyword, which indicates whether the keyword is pending review, has been approved, or has been disapproved.

KeywordEditorialStatus

Read-only

Read-only

ForwardCompatibilityMap

The list of key and value strings for forward compatibility. This element can be used to avoid otherwise breaking changes when new elements are added in future releases.

System_CLiX_noteNote

Forward compatibility changes will be noted here in future releases. There are currently no forward compatibility changes for the Keyword object.

KeyValuePairOfstringstring array

Optional

Optional

Id

The system-generated identifier of the keyword.

long

Read-only

Required

MatchType

The type of match to compare the keyword and the user's search term.

MatchType

Required

Read-only

Param1

The string to use as the substitution value in an ad if the ad’s title, text, display URL, or destination URL contains the {Param1:default} dynamic substitution string.

Although you can use {Param1} to specify an ad’s destination URL, you are encouraged not to. Instead, you should set the keyword's DestinationUrl element.

The string can contain a maximum of 1,022 characters. The actual limit depends on the length of the element that references the substitution string. For example, the length of a text ad’s title can contain a maximum of 25 characters. You should provide a default string that the system will use if including the substitution value will cause the expanded string to exceed the element’s limit.

string

Optional

Optional

Param2

The string to use as the substitution value in an ad if the title, text, display URL, or destination URL contains the {Param2:default} dynamic substitution string.

Typically, you use the {Param2} substitution string in the title or description elements of an ad.

The string can contain a maximum of 70 characters. The actual limit depends on the length of the element that references the substitution string. For example, the length of a text ad’s title can contain a maximum of 25 characters. If including the substitution value will cause the expanded string to exceed the element’s limit, you should provide a default string for the system to use; otherwise the ad will not serve.

string

Optional

Optional

Param3

The string to use as the substitution value in an ad if the title, text, display URL, or destination URL contains the {Param3:default} dynamic substitution string.

Typically, you use the {Param3} substitution string in the title or description elements of an ad.

The string can contain a maximum of 70 characters. The actual limit depends on the length of the element that references the substitution string. For example, the length of a text ad’s title can contain a maximum of 25 characters. If including the substitution value will cause the expanded string to exceed the element’s limit, you should provide a default string for the system to use; otherwise the ad will not serve.

string

Optional

Optional

Status

The keyword’s status. By default, the status is set to Active.

KeywordStatus

Optional

Optional

Text

The keyword text. The text can contain a maximum of 100 characters. You should specify the keyword in the locale of the Language value that you specified for the ad group to which the keyword belongs.

string

Required

Read-only

Requirements

CampaignManagementService.svc v9

Namespace: https://bingads.microsoft.com/CampaignManagement/v9

Community Additions

ADD
Show:
© 2014 Microsoft