Export (0) Print
Expand All

GetKeywordDemographics Service Operation

Gets the age and gender of users who have searched for the specified keywords.

Request | Response

Error Codes

Service: AdIntelligenceService.svc v9 | Namespace: https://bingads.microsoft.com/AdIntelligence/v9

GetKeywordDemographicsRequest Message

Request Body

The GetKeywordDemographicsRequest object defines the elements of the request’s body. The elements must be in the same order as shown in the SOAP example.

Element

Description

Data Type

Required

Device

A list of one or more of the following device types.

  • Computers

  • NonSmartphones

  • Smartphones

  • Tablets

The response includes keyword performance data for the device types that you specify only, if available.

Used to determine the percentage of times that users of a certain age and gender searched for a keyword on the specified device types.

The default is Computers.

string array

No

Keywords

An array of keywords for which you want to get demographics data. The data is broken out by device type. 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.

For possible values, see Ad Languages.

string

Yes

PublisherCountry

The country code of the country/region to use as the source of the demographics data.

The country/region that you specify must support the language specified in the Language element.

For possible values, see Country Codes.

If null, the specified language determines the default publisher country. For a list of default publisher countries by language, see Ad Languages.

string

No

Request Header

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 OAuth access token used to manage Bing Ads accounts linked to a Microsoft Account. For more information, see Managing User Authentication with OAuth.

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.

string

DeveloperToken

The client application's developer access token.

string

Password

The Bing Ads user's sign-in password.

string

UserName

The Bing Ads user's sign-in user name. You may not set this element to a Microsoft account.

string

Request SOAP

The following example shows the complete request envelope.


<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
    <Action mustUnderstand="1">GetKeywordDemographics</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>
    <GetKeywordDemographicsRequest xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string></a1:string>
      </Keywords>
      <Language i:nil="false"></Language>
      <PublisherCountry i:nil="false"></PublisherCountry>
      <Device i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string></a1:string>
      </Device>
    </GetKeywordDemographicsRequest>
  </s:Body>
</s:Envelope>

GetKeywordDemographicsResponse Message

Response Body

Element

Description

Data Type

KeywordDemographicResult

An array of KeywordDemographicResult objects. Each object contains the keyword and the percentage of time that users of a certain age and gender searched for the specified keyword.

The list will include an item for each keyword and device type combination for which there is demographics data. The order of the items corresponds directly to the keywords and device types specified in the request. If there is no demographic data available for a keyword, the keyword will be included in the list but the Device and KeywordDemographics elements will be null.

KeywordDemographicResult array

Response Header

Element

Description

Data Type

TrackingId

The identifier of the log entry that contains the details of the API call.

string

Response SOAP

The following example shows the complete response envelope.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
    <TrackingId p4:nil="false" xmlns:p4="http://www.w3.org/2001/XMLSchema-instance"></TrackingId>
  </s:Header>
  <s:Body>
    <GetKeywordDemographicsResponse xmlns="https://bingads.microsoft.com/AdIntelligence/v9">
      <KeywordDemographicResult xmlns:e15="http://schemas.datacontract.org/2004/07/Microsoft.BingAds.Advertiser.CampaignManagement.Api.DataContracts" p5:nil="false" xmlns:p5="http://www.w3.org/2001/XMLSchema-instance">
        <e15:KeywordDemographicResult>
          <e15:Keyword p5:nil="false"></e15:Keyword>
          <e15:Device p5:nil="false"></e15:Device>
          <e15:KeywordDemographics p5:nil="false">
            <e15:Age18_24></e15:Age18_24>
            <e15:Age25_34></e15:Age25_34>
            <e15:Age35_49></e15:Age35_49>
            <e15:Age50_64></e15:Age50_64>
            <e15:Age65Plus></e15:Age65Plus>
            <e15:AgeUnknown></e15:AgeUnknown>
            <e15:Female></e15:Female>
            <e15:Male></e15:Male>
            <e15:GenderUnknown></e15:GenderUnknown>
          </e15:KeywordDemographics>
        </e15:KeywordDemographicResult>
      </KeywordDemographicResult>
    </GetKeywordDemographicsResponse>
  </s:Body>
</s:Envelope>

Error Codes

If the service operation fails, it throws a FaultException exception, which contains one or more of the Bing Ads API error data objects. For information about the fault detail objects, see Ad Intelligence Error Data Objects and Handling Service Errors and Exceptions.

The following are example error codes that the error objects can include when using this service operation. For all documented error codes, please see Bing Ads Operation Error Codes.

Error Code

InvalidCredentials

Community Additions

ADD
Show:
© 2015 Microsoft