GetKeywordIdeaCategories Service Operation - Ad Insight

Gets the list of keyword idea categories.

Note

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

You can use the CategoryId element of a KeywordCategory as a part of the CategorySearchParameter when calling the GetKeywordIdeas operation.

Request Elements

The GetKeywordIdeaCategoriesRequest 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

There are not any elements in the operation's request body.

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 GetKeywordIdeaCategoriesResponse 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
KeywordIdeaCategories	The list of keyword idea categories.	KeywordIdeaCategory 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">GetKeywordIdeaCategories</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>
    <GetKeywordIdeaCategoriesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13" />
  </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>
    <GetKeywordIdeaCategoriesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordIdeaCategories d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordIdeaCategory>
          <CategoryId>ValueHere</CategoryId>
          <CategoryName d4p1:nil="false">ValueHere</CategoryName>
        </KeywordIdeaCategory>
      </KeywordIdeaCategories>
    </GetKeywordIdeaCategoriesResponse>
  </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<GetKeywordIdeaCategoriesResponse> GetKeywordIdeaCategoriesAsync()
{
	var request = new GetKeywordIdeaCategoriesRequest
	{
	};

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

static GetKeywordIdeaCategoriesResponse getKeywordIdeaCategories() throws RemoteException, Exception
{
	GetKeywordIdeaCategoriesRequest request = new GetKeywordIdeaCategoriesRequest();


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

static function GetKeywordIdeaCategories()
{

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

	$request = new GetKeywordIdeaCategoriesRequest();


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

response=adinsight_service.GetKeywordIdeaCategories()

Requirements

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

Request Url

Production URL

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

Sandbox URL

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

Request Elements

The GetKeywordIdeaCategoriesRequest 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

There are not any elements in the operation's request body.

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 GetKeywordIdeaCategoriesResponse 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
KeywordIdeaCategories	The list of keyword idea categories.	KeywordIdeaCategory 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.

{}

Response JSON

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

{
  "KeywordIdeaCategories": [
    {
      "CategoryId": "LongValueHere",
      "CategoryName": "ValueHere"
    }
  ]
}

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<GetKeywordIdeaCategoriesResponse> GetKeywordIdeaCategoriesAsync()
{
	var request = new GetKeywordIdeaCategoriesRequest
	{
	};

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

static GetKeywordIdeaCategoriesResponse getKeywordIdeaCategories() throws RemoteException, Exception
{
	GetKeywordIdeaCategoriesRequest request = new GetKeywordIdeaCategoriesRequest();


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

static function GetKeywordIdeaCategories()
{

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

	$request = new GetKeywordIdeaCategoriesRequest();


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

response=adinsight_service.GetKeywordIdeaCategories()