通过

GetKeywordIdeaCategories 服务操作 - Ad Insight

  • 项目

获取关键字 (keyword) 想法类别的列表。

注意

自 2023 年 8 月 21 日起，已弃用 GetKeywordIdeaCategories 服务操作。 了解详细信息。

调用 GetKeywordIdeas 操作时，可以将 KeywordCategory 的 CategoryId 元素用作 CategorySearchParameter 的一部分。

请求元素

GetKeywordIdeaCategoriesRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

操作的请求正文中没有任何元素。

请求标头元素

元素 说明 数据类型
AuthenticationToken OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

GetKeywordIdeaCategoriesResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
KeywordIdeaCategories 关键字 (keyword) 想法类别的列表。 KeywordIdeaCategory 数组

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 SOAP

此模板由一个工具生成，用于显示 SOAP 请求的正文和标头元素的顺序。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

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

响应 SOAP

此模板由一个工具生成，用于显示 SOAP 响应的 正文 和 标头 元素的顺序。

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

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

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()

要求

服务： AdInsightService.svc v13
命名空间： https://bingads.microsoft.com/AdInsight/v13

请求 URL

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

请求元素

GetKeywordIdeaCategoriesRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

操作的请求正文中没有任何元素。

请求标头元素

元素 说明 数据类型
Authorization OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

GetKeywordIdeaCategoriesResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素 说明 数据类型
KeywordIdeaCategories 关键字 (keyword) 想法类别的列表。 KeywordIdeaCategory 数组

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

{}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

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

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

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()