通过

GetKeywordDemographics 服务操作 - Ad Insight

  • 项目

获取搜索指定关键字的用户的年龄和性别。

注意

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

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
设备 要获取其人口统计数据的设备数组。

支持的设备类型包括：计算机、非智能手机、智能手机、平板电脑。 默认值为“计算机”。

如果可用，则响应仅包括指定的设备类型的关键字 (keyword) 人口统计数据。		 字符串 数组
关键字 要获取其人口统计数据的关键字数组。

数据还会按 设备 类型进行细分。 数组最多可以包含 1,000 个关键字，每个关键字 (keyword) 最多可以包含 100 个字符。		 字符串 数组
语言 编写关键字时使用的语言。

有关可能的值，请参阅 广告语言。		 string
PublisherCountry 要用作人口统计数据源的国家/地区的国家/地区代码。

指定的国家/地区必须支持 Language 元素中指定的 语言 。

有关可能的值，请参阅 广告语言。		 string

请求标头元素

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

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

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

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

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

响应元素

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

响应正文元素

元素 说明 数据类型
KeywordDemographicResult KeywordDemographicResult 数据对象的数组。 项的顺序直接与请求中指定的关键字相对应。 如果没有可用于关键字 (keyword) 的人口统计数据，关键字 (keyword) 将包含在列表中，但相应 KeywordDemographicResult 的 KeywordDemographics 元素将为 null。

每个 KeywordDemographicResult 都包含 KeywordDemographic 数据对象的数组。 数组包含请求中指定的每个设备的项。 每个 KeywordDemographic 都包含特定年龄和性别的用户搜索指定关键字 (keyword) 的时间百分比。		 KeywordDemographicResult 数组

响应标头元素

元素 说明 数据类型
跟踪 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">GetKeywordDemographics</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>
    <GetKeywordDemographicsRequest 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>
    </GetKeywordDemographicsRequest>
  </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>
    <GetKeywordDemographicsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordDemographicResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordDemographicResult>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordDemographics d4p1:nil="false">
            <KeywordDemographic>
              <Device d4p1:nil="false">ValueHere</Device>
              <EighteenToTwentyFour>ValueHere</EighteenToTwentyFour>
              <TwentyFiveToThirtyFour>ValueHere</TwentyFiveToThirtyFour>
              <ThirtyFiveToFourtyNine>ValueHere</ThirtyFiveToFourtyNine>
              <FiftyToSixtyFour>ValueHere</FiftyToSixtyFour>
              <SixtyFiveAndAbove>ValueHere</SixtyFiveAndAbove>
              <AgeUnknown>ValueHere</AgeUnknown>
              <Female>ValueHere</Female>
              <Male>ValueHere</Male>
              <GenderUnknown>ValueHere</GenderUnknown>
            </KeywordDemographic>
          </KeywordDemographics>
        </KeywordDemographicResult>
      </KeywordDemographicResult>
    </GetKeywordDemographicsResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<GetKeywordDemographicsResponse> GetKeywordDemographicsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device)
{
	var request = new GetKeywordDemographicsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device
	};

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

static GetKeywordDemographicsResponse getKeywordDemographics(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device) throws RemoteException, Exception
{
	GetKeywordDemographicsRequest request = new GetKeywordDemographicsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);

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

static function GetKeywordDemographics(
	$keywords,
	$language,
	$publisherCountry,
	$device)
{

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

	$request = new GetKeywordDemographicsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;

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

response=adinsight_service.GetKeywordDemographics(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device)

要求

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

请求 URL

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

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
设备 要获取其人口统计数据的设备数组。

支持的设备类型包括：计算机、非智能手机、智能手机、平板电脑。 默认值为“计算机”。

如果可用，则响应仅包括指定的设备类型的关键字 (keyword) 人口统计数据。		 字符串 数组
关键字 要获取其人口统计数据的关键字数组。

数据还会按 设备 类型进行细分。 数组最多可以包含 1,000 个关键字，每个关键字 (keyword) 最多可以包含 100 个字符。		 字符串 数组
语言 编写关键字时使用的语言。

有关可能的值，请参阅 广告语言。		 string
PublisherCountry 要用作人口统计数据源的国家/地区的国家/地区代码。

指定的国家/地区必须支持 Language 元素中指定的 语言 。

有关可能的值，请参阅 广告语言。		 string

请求标头元素

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

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

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

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

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

响应元素

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

响应正文元素

元素 说明 数据类型
KeywordDemographicResult KeywordDemographicResult 数据对象的数组。 项的顺序直接与请求中指定的关键字相对应。 如果没有可用于关键字 (keyword) 的人口统计数据，关键字 (keyword) 将包含在列表中，但相应 KeywordDemographicResult 的 KeywordDemographics 元素将为 null。

每个 KeywordDemographicResult 都包含 KeywordDemographic 数据对象的数组。 数组包含请求中指定的每个设备的项。 每个 KeywordDemographic 都包含特定年龄和性别的用户搜索指定关键字 (keyword) 的时间百分比。		 KeywordDemographicResult 数组

响应标头元素

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

请求 JSON

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

{
  "Keywords": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountry": "ValueHere",
  "Device": [
    "ValueHere"
  ]
}

响应 JSON

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

{
  "KeywordDemographicResult": [
    {
      "Keyword": "ValueHere",
      "KeywordDemographics": [
        {
          "AgeUnknown": DoubleValueHere,
          "Device": "ValueHere",
          "EighteenToTwentyFour": DoubleValueHere,
          "Female": DoubleValueHere,
          "FiftyToSixtyFour": DoubleValueHere,
          "GenderUnknown": DoubleValueHere,
          "Male": DoubleValueHere,
          "SixtyFiveAndAbove": DoubleValueHere,
          "ThirtyFiveToFourtyNine": DoubleValueHere,
          "TwentyFiveToThirtyFour": DoubleValueHere
        }
      ]
    }
  ]
}

代码语法

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

public async Task<GetKeywordDemographicsResponse> GetKeywordDemographicsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device)
{
	var request = new GetKeywordDemographicsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device
	};

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

static GetKeywordDemographicsResponse getKeywordDemographics(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device) throws RemoteException, Exception
{
	GetKeywordDemographicsRequest request = new GetKeywordDemographicsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);

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

static function GetKeywordDemographics(
	$keywords,
	$language,
	$publisherCountry,
	$device)
{

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

	$request = new GetKeywordDemographicsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;

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

response=adinsight_service.GetKeywordDemographics(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device)