Export (0) Print
Expand All

GetHistoricalKeywordPerformanceRequest Message

Defines the request message that the client passes to the GetHistoricalKeywordPerformance operation.

<wsdl:message name="GetHistoricalKeywordPerformanceRequest">
  <wsdl:part name="parameters" element="tns:GetHistoricalKeywordPerformanceRequest" />
</wsdl:message>

Body Elements

Element

Description

Data Type

Required

Keywords

An array of keywords for which you want to get historical performance statistics. The array can contain a maximum of 1,000 keywords, and each keyword can contain a maximum of 100 characters.

string array

Yes

Language

The language in which the keywords are written.

The countries/regions that you specify in the PublisherCountries element must support the specified language.

For possible values, see Languages.

The default value is English.

string

No

System_CLiX_noteNote

In Bing Ads API version 9, this element is required.

MatchType

The match type for which you want to get historical data.

You cannot specify the Content match type.

For possible values, see MatchType.

The default match type is Broad.

MatchType

No

PublisherCountries

The country codes of the countries/regions to use as the source of the historical data.

You can specify one or more country codes. Each country/region that you specify must support the language specified in the Language element.

For possible values, see Publisher Countries.

If Null, the default is all countries/regions that support the specified language.

string array

No

TargetAdPosition

The position of the search results for which you want to get performance data.

For example, to get performance data when ads appeared in the first position of the mainline by using the keyword and match type, set this element to MainLine1. To get performance data when ads appeared in any position of the search results by using the keyword and match type, set this element to All.

For possible values, see the AdPosition value set.

The default value is All.

AdPosition

No

TimeInterval

The time period that identifies the data to use to determine the key performance index of the specified keywords. For example, use data from the previous seven days or previous 30 days to determine the keyword performance.

For possible values, see TimeInterval.

The default value is Last7Days.

TimeInterval

No

Header Elements

For information about the values you set the DeveloperToken, Password, and UserName elements to, see Getting Started With the Bing Ads API.

Element

Description

Data Type

ApplicationToken

The application-access token. This header element is not used and should be null.

string

AuthenticationToken

The authentication token. This header element is not used and should be null.

string

CustomerAccountId

The identifier of the account that owns the entities in the request.

string

CustomerId

The identifier of the customer that owns the account. This header element is not used and should be null.

string

DeveloperToken

The caller's developer access token.

string

Password

The user's sign-in password.

string

UserName

The user's sign-in user name. You cannot set this element to a Microsoft account (formerly known as Windows Live ID).

string

SOAP

The following example shows the complete SOAP envelope for a GetHistoricalKeywordPerformanceRequest request.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://adcenter.microsoft.com/v8">
    <Action mustUnderstand="1">GetHistoricalKeywordPerformance</Action>
    <ApplicationToken i:nil="false"></ApplicationToken>
    <AuthenticationToken i:nil="false"></AuthenticationToken>
    <CustomerAccountId i:nil="false"></CustomerAccountId>
    <CustomerId i:nil="false"></CustomerId>
    <DeveloperToken i:nil="false"></DeveloperToken>
    <Password i:nil="false"></Password>
    <UserName i:nil="false"></UserName>
  </s:Header>
  <s:Body>
    <GetHistoricalKeywordPerformanceRequest xmlns="https://adcenter.microsoft.com/v8">
      <Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string></a1:string>
      </Keywords>
      <TimeInterval i:nil="false"></TimeInterval>
      <TargetAdPosition i:nil="false"></TargetAdPosition>
      <MatchType i:nil="false"></MatchType>
      <Language i:nil="false"></Language>
      <PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string></a1:string>
      </PublisherCountries>
    </GetHistoricalKeywordPerformanceRequest>
  </s:Body>
</s:Envelope>

Requirements

AdIntelligenceService.svc v8

Namespace: https://adcenter.microsoft.com/v8

Community Additions

Show:
© 2014 Microsoft