GetKeywordLocations Service Operation - Ad Insight

Gets the geographical locations of users who have searched for the specified keywords.

Note

The GetKeywordLocations service operation is deprecated as of August 21, 2023. Learn more.

Request Elements

The GetKeywordLocationsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
Device	An array of devices for which you want to get geographical location information. Supported device types include the following: Computers, NonSmartphones, Smartphones, Tablets. The default is Computers. The response includes keyword locations data for only the device types that you specify, if available.	string array
Keywords	An array of keywords for which you want to get geographical location information. The data is also 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
Language	The language in which the keywords are written. For possible values, see Ad Languages.	string
Level	The level at which to aggregate the geographical location data. The following are the possible values: 0 - Country 1 - State/Province 2 - Metropolitan area 3 - City The default value is 1 (State/Province).	int
MaxLocations	The maximum number of locations to return. You can request a maximum of 10 locations. The default value is 10.	int
ParentCountry	The country/region from which the search originated. For possible values, see Geographical Location Codes. The default is US.	string
PublisherCountry	The country code of the country/region to use as the source of the location data. The country/region that you specify must support the language specified in the Language element. For possible values, see Ad Languages.	string

Request Header Elements

Element	Description	Data Type
AuthenticationToken	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The GetKeywordLocationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element	Description	Data Type
KeywordLocationResult	An array of KeywordLocationResult data objects. The order of the items corresponds directly to the keywords specified in the request. If there is no location data available for a keyword, the keyword will be included in the list, but the KeywordLocations element of the corresponding KeywordLocationResult object will be null. Each KeywordLocationResult data object contains an array of KeywordLocation. The array contains an item for each device specified in the request. Each KeywordLocation contains the geographical location and percentage of time that users in the geographical location searched for the specified keyword.	KeywordLocationResult array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<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/AdInsight/v13">
    <Action mustUnderstand="1">GetKeywordLocations</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetKeywordLocationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Keywords i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Keywords>
      <Language i:nil="false">ValueHere</Language>
      <PublisherCountry i:nil="false">ValueHere</PublisherCountry>
      <Device i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Device>
      <Level i:nil="false">ValueHere</Level>
      <ParentCountry i:nil="false">ValueHere</ParentCountry>
      <MaxLocations i:nil="false">ValueHere</MaxLocations>
    </GetKeywordLocationsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/AdInsight/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <GetKeywordLocationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordLocationResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordLocationResult>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordLocations d4p1:nil="false">
            <KeywordLocation>
              <Device d4p1:nil="false">ValueHere</Device>
              <Location d4p1:nil="false">ValueHere</Location>
              <Percentage>ValueHere</Percentage>
            </KeywordLocation>
          </KeywordLocations>
        </KeywordLocationResult>
      </KeywordLocationResult>
    </GetKeywordLocationsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device,
	int? level,
	string parentCountry,
	int? maxLocations)
{
	var request = new GetKeywordLocationsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device,
		Level = level,
		ParentCountry = parentCountry,
		MaxLocations = maxLocations
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetKeywordLocationsAsync(r), request));
}

static GetKeywordLocationsResponse getKeywordLocations(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device,
	int level,
	java.lang.String parentCountry,
	int maxLocations) throws RemoteException, Exception
{
	GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);
	request.setLevel(level);
	request.setParentCountry(parentCountry);
	request.setMaxLocations(maxLocations);

	return AdInsightService.getService().getKeywordLocations(request);
}

static function GetKeywordLocations(
	$keywords,
	$language,
	$publisherCountry,
	$device,
	$level,
	$parentCountry,
	$maxLocations)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetKeywordLocationsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;
	$request->Level = $level;
	$request->ParentCountry = $parentCountry;
	$request->MaxLocations = $maxLocations;

	return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordLocations($request);
}

response=adinsight_service.GetKeywordLocations(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device,
	Level=Level,
	ParentCountry=ParentCountry,
	MaxLocations=MaxLocations)

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

Request Url

Production URL

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/KeywordLocations/Query

Sandbox URL

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/KeywordLocations/Query

Request Elements

The GetKeywordLocationsRequest object defines the body and header elements of the service operation request.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element	Description	Data Type
Device	An array of devices for which you want to get geographical location information. Supported device types include the following: Computers, NonSmartphones, Smartphones, Tablets. The default is Computers. The response includes keyword locations data for only the device types that you specify, if available.	string array
Keywords	An array of keywords for which you want to get geographical location information. The data is also 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
Language	The language in which the keywords are written. For possible values, see Ad Languages.	string
Level	The level at which to aggregate the geographical location data. The following are the possible values: 0 - Country 1 - State/Province 2 - Metropolitan area 3 - City The default value is 1 (State/Province).	int
MaxLocations	The maximum number of locations to return. You can request a maximum of 10 locations. The default value is 10.	int
ParentCountry	The country/region from which the search originated. For possible values, see Geographical Location Codes. The default is US.	string
PublisherCountry	The country code of the country/region to use as the source of the location data. The country/region that you specify must support the language specified in the Language element. For possible values, see Ad Languages.	string

Request Header Elements

Element	Description	Data Type
Authorization	The OAuth access token that represents the credentials of a user who has permissions to Microsoft Advertising accounts. Please ensure that the token is prefixed with "Bearer ", this is necessary for proper authentication. For more information see Authentication with OAuth.	string
CustomerAccountId	The identifier of the ad account that owns or is associated with the entities in the request. This header element must have the same value as the AccountId body element when both are required. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
CustomerId	The identifier of the manager account (customer) the user is accessing or operating from. A user can have access to multiple manager accounts. This element is required for most service operations, and as a best practice you should always set it. For more information see Get Your Account and Customer IDs.	string
DeveloperToken	The developer token used to access the Bing Ads API. For more information see Get a Developer Token.	string
Password	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string
UserName	This element is reserved for internal use and will be removed from a future version of the API. You must use the AuthenticationToken element to set user credentials.	string

Response Elements

The GetKeywordLocationsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response JSON.

Response Body Elements

Element	Description	Data Type
KeywordLocationResult	An array of KeywordLocationResult data objects. The order of the items corresponds directly to the keywords specified in the request. If there is no location data available for a keyword, the keyword will be included in the list, but the KeywordLocations element of the corresponding KeywordLocationResult object will be null. Each KeywordLocationResult data object contains an array of KeywordLocation. The array contains an item for each device specified in the request. Each KeywordLocation contains the geographical location and percentage of time that users in the geographical location searched for the specified keyword.	KeywordLocationResult array

Response Header Elements

Element	Description	Data Type
TrackingId	The identifier of the log entry that contains the details of the API call.	string

Request JSON

This template was generated by a tool to show the body and header elements for the JSON request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

{
  "Keywords": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountry": "ValueHere",
  "Device": [
    "ValueHere"
  ],
  "Level": IntValueHere,
  "ParentCountry": "ValueHere",
  "MaxLocations": IntValueHere
}

Response JSON

This template was generated by a tool to show the body and header elements for the JSON response.

{
  "KeywordLocationResult": [
    {
      "Keyword": "ValueHere",
      "KeywordLocations": [
        {
          "Device": "ValueHere",
          "Location": "ValueHere",
          "Percentage": DoubleValueHere
        }
      ]
    }
  ]
}

Code Syntax

To call REST API through SDKs, you need to upgrade SDK to a certain version and configure the system parameters.The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device,
	int? level,
	string parentCountry,
	int? maxLocations)
{
	var request = new GetKeywordLocationsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device,
		Level = level,
		ParentCountry = parentCountry,
		MaxLocations = maxLocations
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetKeywordLocationsAsync(r), request));
}

static GetKeywordLocationsResponse getKeywordLocations(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device,
	int level,
	java.lang.String parentCountry,
	int maxLocations) throws RemoteException, Exception
{
	GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);
	request.setLevel(level);
	request.setParentCountry(parentCountry);
	request.setMaxLocations(maxLocations);

	return AdInsightService.getService().getKeywordLocations(request);
}

static function GetKeywordLocations(
	$keywords,
	$language,
	$publisherCountry,
	$device,
	$level,
	$parentCountry,
	$maxLocations)
{

	$GLOBALS['Proxy'] = $GLOBALS['AdInsightProxy'];

	$request = new GetKeywordLocationsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;
	$request->Level = $level;
	$request->ParentCountry = $parentCountry;
	$request->MaxLocations = $maxLocations;

	return $GLOBALS['AdInsightProxy']->GetService()->GetKeywordLocations($request);
}

response=adinsight_service.GetKeywordLocations(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device,
	Level=Level,
	ParentCountry=ParentCountry,
	MaxLocations=MaxLocations)