GetDomainCategories 服务操作 - Ad Insight

获取可用于网站域和语言的类别列表。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
CategoryName	类别名称筛选器。 如果已知道一个或多个类别，则可以选择按子类别筛选结果列表。 最多可以指定三个类别级别，并且必须用正斜杠 (“/”) 分隔。 例如，可以将筛选器的格式设置为 CategoryL1/CategoryL2/CategoryL3。 如果不包含任何类别名称，则将返回域和语言的所有类别。	string
DomainName	与广告要定位的页面对应的网站名称。 域的最大长度为 2,048 个字符。 无需包含 http、 https 或 www 前缀。	string
语言	网站域的语言。 目前仅支持英语，因此必须将此元素设置为 EN。	string

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

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

响应正文元素

元素	说明	数据类型
类别	域类别列表。	DomainCategory 数组

响应标头元素

元素	说明	数据类型
跟踪 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">GetDomainCategories</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>
    <GetDomainCategoriesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CategoryName i:nil="false">ValueHere</CategoryName>
      <DomainName i:nil="false">ValueHere</DomainName>
      <Language i:nil="false">ValueHere</Language>
    </GetDomainCategoriesRequest>
  </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>
    <GetDomainCategoriesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Categories d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <DomainCategory>
          <Bid>ValueHere</Bid>
          <CategoryName d4p1:nil="false">ValueHere</CategoryName>
          <Coverage>ValueHere</Coverage>
        </DomainCategory>
      </Categories>
    </GetDomainCategoriesResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<GetDomainCategoriesResponse> GetDomainCategoriesAsync(
	string categoryName,
	string domainName,
	string language)
{
	var request = new GetDomainCategoriesRequest
	{
		CategoryName = categoryName,
		DomainName = domainName,
		Language = language
	};

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

static GetDomainCategoriesResponse getDomainCategories(
	java.lang.String categoryName,
	java.lang.String domainName,
	java.lang.String language) throws RemoteException, Exception
{
	GetDomainCategoriesRequest request = new GetDomainCategoriesRequest();

	request.setCategoryName(categoryName);
	request.setDomainName(domainName);
	request.setLanguage(language);

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

static function GetDomainCategories(
	$categoryName,
	$domainName,
	$language)
{

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

	$request = new GetDomainCategoriesRequest();

	$request->CategoryName = $categoryName;
	$request->DomainName = $domainName;
	$request->Language = $language;

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

response=adinsight_service.GetDomainCategories(
	CategoryName=CategoryName,
	DomainName=DomainName,
	Language=Language)

要求

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

请求 URL

生产 URL

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

沙盒 URL

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

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
CategoryName	类别名称筛选器。 如果已知道一个或多个类别，则可以选择按子类别筛选结果列表。 最多可以指定三个类别级别，并且必须用正斜杠 (“/”) 分隔。 例如，可以将筛选器的格式设置为 CategoryL1/CategoryL2/CategoryL3。 如果不包含任何类别名称，则将返回域和语言的所有类别。	string
DomainName	与广告要定位的页面对应的网站名称。 域的最大长度为 2,048 个字符。 无需包含 http、 https 或 www 前缀。	string
语言	网站域的语言。 目前仅支持英语，因此必须将此元素设置为 EN。	string

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

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

响应正文元素

元素	说明	数据类型
类别	域类别列表。	DomainCategory 数组

响应标头元素

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

请求 JSON

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

{
  "CategoryName": "ValueHere",
  "DomainName": "ValueHere",
  "Language": "ValueHere"
}

响应 JSON

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

{
  "Categories": [
    {
      "Bid": DoubleValueHere,
      "CategoryName": "ValueHere",
      "Coverage": DoubleValueHere
    }
  ]
}

代码语法

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

public async Task<GetDomainCategoriesResponse> GetDomainCategoriesAsync(
	string categoryName,
	string domainName,
	string language)
{
	var request = new GetDomainCategoriesRequest
	{
		CategoryName = categoryName,
		DomainName = domainName,
		Language = language
	};

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

static GetDomainCategoriesResponse getDomainCategories(
	java.lang.String categoryName,
	java.lang.String domainName,
	java.lang.String language) throws RemoteException, Exception
{
	GetDomainCategoriesRequest request = new GetDomainCategoriesRequest();

	request.setCategoryName(categoryName);
	request.setDomainName(domainName);
	request.setLanguage(language);

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

static function GetDomainCategories(
	$categoryName,
	$domainName,
	$language)
{

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

	$request = new GetDomainCategoriesRequest();

	$request->CategoryName = $categoryName;
	$request->DomainName = $domainName;
	$request->Language = $language;

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

response=adinsight_service.GetDomainCategories(
	CategoryName=CategoryName,
	DomainName=DomainName,
	Language=Language)