GetKeywordCategories Service Operation - Ad Insight

Article
03/20/2023

Gets the keyword categories to which the specified keywords belong.

Note

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

Request Elements

The GetKeywordCategoriesRequest 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
Keywords	An array of keywords for which you want to determine the possible keyword categories that each keyword belongs to. 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. You must set this element to English.	string
MaxCategories	The number of categories to include in the results. The maximum number of categories that you can request is 5. The default is 5.	int
PublisherCountry	The country code of the country/region to use as the source of the category data. You must set this element to US.	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 GetKeywordCategoriesResponse 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
Result	An array of KeywordCategoryResult data objects. Each object contains the keyword and a list of categories to which it belongs. The list will include an item for each keyword that you specified in the request. If the keyword category cannot be determined, the KeywordCategories list will contain a single KeywordCategory. The value of Category will be Unknown Category and the value of ConfidenceScore will be 0.0.	KeywordCategoryResult 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">GetKeywordCategories</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>
    <GetKeywordCategoriesRequest 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>
      <MaxCategories i:nil="false">ValueHere</MaxCategories>
    </GetKeywordCategoriesRequest>
  </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>
    <GetKeywordCategoriesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Result d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordCategoryResult>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordCategories d4p1:nil="false">
            <KeywordCategory>
              <Category d4p1:nil="false">ValueHere</Category>
              <ConfidenceScore>ValueHere</ConfidenceScore>
            </KeywordCategory>
          </KeywordCategories>
        </KeywordCategoryResult>
      </Result>
    </GetKeywordCategoriesResponse>
  </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<GetKeywordCategoriesResponse> GetKeywordCategoriesAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	int? maxCategories)
{
	var request = new GetKeywordCategoriesRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		MaxCategories = maxCategories
	};

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

static GetKeywordCategoriesResponse getKeywordCategories(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	int maxCategories) throws RemoteException, Exception
{
	GetKeywordCategoriesRequest request = new GetKeywordCategoriesRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setMaxCategories(maxCategories);

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

static function GetKeywordCategories(
	$keywords,
	$language,
	$publisherCountry,
	$maxCategories)
{

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

	$request = new GetKeywordCategoriesRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->MaxCategories = $maxCategories;

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

response=adinsight_service.GetKeywordCategories(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	MaxCategories=MaxCategories)

Requirements

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

Share via