GetHistoricalSearchCount 服务操作 - Ad Insight

获取指定时间段内在搜索中使用规范化字词的次数。 结果按设备类型聚合。

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
设备 以下一种或多种设备类型的列表:计算机、非智能手机、智能手机、平板电脑。 默认值为“计算机”。

响应包括仅指定的设备类型的搜索计数(如果可用)。
字符串 数组
EndDate 日期范围的结束日期,用于标识要用于确定历史搜索计数的数据。

该日期不能晚于今天的日期,并且必须晚于或等于指定的开始日期。

如果指定的 TimePeriodRollup 为“每周”或“每月”,则可能会调整生效结束日期。
DayMonthAndYear
关键字 要确定搜索查询中使用关键字 (keyword) 次数的关键字数组。 数组最多可以包含 1,000 个关键字,每个关键字 (keyword) 最多可以包含 100 个字符。 字符串 数组
语言 编写关键字时使用的语言。

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

有关可能的值,请参阅 支持的语言
string
PublisherCountries 要用作历史数据源的国家/地区的国家/地区代码。

可以指定一个或多个国家/地区代码。 指定的每个国家/地区都必须支持 Language 元素中指定的 语言

有关可能的值,请参阅 广告语言

如果为 Null,则默认值为支持指定语言的所有国家/地区。
字符串 数组
StartDate 日期范围的开始日期,用于标识要用于确定历史搜索计数的数据。

此日期必须早于或等于指定的结束日期。 该日期应晚于与指定的 TimePeriodRollup 元素对应的最大可用历史数据范围。

如果指定的 TimePeriodRollup 为“每周”或“每月”,则可能会调整生效开始日期。
DayMonthAndYear
TimePeriodRollup 可以指定是每天、每周还是每月返回聚合的数据。

有关支持值的列表,请参阅下面的 “备注 ”部分。
string

请求标头元素

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

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

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

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

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

响应元素

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

响应正文元素

元素 说明 数据类型
KeywordSearchCounts KeywordSearchCount 数据对象的数组。 数组包含请求中指定的每个关键字 (keyword) 的项。 如果关键字 (keyword) 无效,则数组中的相应项将为 null。

每个 KeywordSearchCount 都包含 SearchCountsByAttributes 数组。 数组包含请求中指定的每个唯一设备的项。
KeywordSearchCount 数组

响应标头元素

元素 说明 数据类型
跟踪 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">GetHistoricalSearchCount</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>
    <GetHistoricalSearchCountRequest 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>
      <PublisherCountries i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </PublisherCountries>
      <StartDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </StartDate>
      <EndDate i:nil="false">
        <Day>ValueHere</Day>
        <Month>ValueHere</Month>
        <Year>ValueHere</Year>
      </EndDate>
      <TimePeriodRollup i:nil="false">ValueHere</TimePeriodRollup>
      <Devices i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:string>ValueHere</a1:string>
      </Devices>
    </GetHistoricalSearchCountRequest>
  </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>
    <GetHistoricalSearchCountResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordSearchCounts d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordSearchCount>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <SearchCountsByAttributes d4p1:nil="false">
            <SearchCountsByAttributes>
              <Device d4p1:nil="false">ValueHere</Device>
              <HistoricalSearchCounts d4p1:nil="false">
                <HistoricalSearchCountPeriodic>
                  <SearchCount>ValueHere</SearchCount>
                  <DayMonthAndYear d4p1:nil="false">
                    <Day>ValueHere</Day>
                    <Month>ValueHere</Month>
                    <Year>ValueHere</Year>
                  </DayMonthAndYear>
                </HistoricalSearchCountPeriodic>
              </HistoricalSearchCounts>
            </SearchCountsByAttributes>
          </SearchCountsByAttributes>
        </KeywordSearchCount>
      </KeywordSearchCounts>
    </GetHistoricalSearchCountResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<GetHistoricalSearchCountResponse> GetHistoricalSearchCountAsync(
	IList<string> keywords,
	string language,
	IList<string> publisherCountries,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate,
	string timePeriodRollup,
	IList<string> devices)
{
	var request = new GetHistoricalSearchCountRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountries = publisherCountries,
		StartDate = startDate,
		EndDate = endDate,
		TimePeriodRollup = timePeriodRollup,
		Devices = devices
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetHistoricalSearchCountAsync(r), request));
}
static GetHistoricalSearchCountResponse getHistoricalSearchCount(
	ArrayOfstring keywords,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate,
	java.lang.String timePeriodRollup,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalSearchCountRequest request = new GetHistoricalSearchCountRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setStartDate(startDate);
	request.setEndDate(endDate);
	request.setTimePeriodRollup(timePeriodRollup);
	request.setDevices(devices);

	return AdInsightService.getService().getHistoricalSearchCount(request);
}
static function GetHistoricalSearchCount(
	$keywords,
	$language,
	$publisherCountries,
	$startDate,
	$endDate,
	$timePeriodRollup,
	$devices)
{

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

	$request = new GetHistoricalSearchCountRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;
	$request->TimePeriodRollup = $timePeriodRollup;
	$request->Devices = $devices;

	return $GLOBALS['AdInsightProxy']->GetService()->GetHistoricalSearchCount($request);
}
response=adinsight_service.GetHistoricalSearchCount(
	Keywords=Keywords,
	Language=Language,
	PublisherCountries=PublisherCountries,
	StartDate=StartDate,
	EndDate=EndDate,
	TimePeriodRollup=TimePeriodRollup,
	Devices=Devices)

备注

可以指定以下区分大小写的值,并且数据将回到相应的最大可用历史数据范围。

TimePeriodRollup 可用历史数据
每天 最晚于最近完成日期之前的 45 天。
每周 最早于最近完成的一周的 15 周。

指定的 StartDate 调整回最近的星期日, EndDate 将向前调整为最近的星期六。
每月 最早于最近完成月份的 24 个月。

指定的 StartDate 调整回月头, EndDate 将向前调整到月末。

支持的语言

下面是 语言 请求正文元素支持的语言:

支持的语言
丹麦语
荷兰语
英语
芬兰语
法语
德语
意大利语
挪威语
葡萄牙语
SimplifiedChinese
西班牙语
瑞典语
TraditionalChinese

语言和国家/地区映射

下面是语言和国家/地区映射表:

语言 CountryCode 国家/地区 Language@Country
丹麦语 DK 丹麦 Danish@Denmark
荷兰语 NL 荷兰 Dutch@Netherlands
英语 AU 澳大利亚 English@Australia
英语 加利福尼亚州 加拿大 English@Canada
英语 FR 法国 English@France
英语 DE 德国 English@Germany
英语 IN 印度 English@India
英语 ID 印度尼西亚 English@Indonesia
英语 IE 爱尔兰 English@Ireland
英语 IT Italy(意大利) English@Italy
英语 马来西亚 English@Malaysia
英语 NL 荷兰 English@Netherlands
英语 新西兰 NewZealand English@NewZealand
英语 PH 菲律宾 English@Philippines
英语 SG 新加坡 English@Singapore
英语 ES 西班牙 English@Spain
英语 SE 瑞典 English@Sweden
英语 CH 瑞士 English@Switzerland
英语 TH 泰国 English@Thailand
英语 GB 英国 English@UK
英语 美国 美国 English@US
英语 VN 越南 英语@越南
芬兰语 FI 芬兰 Finnish@Finland
法语 加利福尼亚州 加拿大 French@Canada
法语 FR 法国 French@France
法语 CH 瑞士 French@Switzerland
法语 GB 英国 French@UK
法语 美国 美国 French@US
德语 AU 澳大利亚 German@Australia
德语 AT 奥地利 German@Austria
德语 加利福尼亚州 加拿大 German@Canada
德语 FR 法国 German@France
德语 DE 德国 German@Germany
德语 CH 瑞士 German@Switzerland
德语 GB 英国 German@UK
德语 美国 美国 German@US
意大利语 IT Italy(意大利) Italian@Italy
挪威语 挪威 Norwegian@Norway
葡萄牙语 BR 巴西 Portuguese@Brazil
SimplifiedChinese 快递 之 家 中国 SimplifiedChinese@China
西班牙语 AR 阿根廷 Spanish@Argentina
西班牙语 CL 智利 Spanish@Chile
西班牙语 CO 哥伦比亚 Spanish@Colombia
西班牙语 MX 墨西哥 Spanish@Mexico
西班牙语 体育 秘鲁 Spanish@Peru
西班牙语 ES 西班牙 Spanish@Spain
西班牙语 美国 美国 Spanish@US
西班牙语 VE 委内瑞拉 Spanish@Venezuela
瑞典语 SE 瑞典 Swedish@Sweden
TraditionalChinese 香港 香港特区 TraditionalChinese@HongKongSAR
TraditionalChinese TW Taiwan(台湾) TraditionalChinese@Taiwan

要求

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

请求 URL

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

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
设备 以下一种或多种设备类型的列表:计算机、非智能手机、智能手机、平板电脑。 默认值为“计算机”。

响应包括仅指定的设备类型的搜索计数(如果可用)。
字符串 数组
EndDate 日期范围的结束日期,用于标识要用于确定历史搜索计数的数据。

该日期不能晚于今天的日期,并且必须晚于或等于指定的开始日期。

如果指定的 TimePeriodRollup 为“每周”或“每月”,则可能会调整生效结束日期。
DayMonthAndYear
关键字 要确定搜索查询中使用关键字 (keyword) 次数的关键字数组。 数组最多可以包含 1,000 个关键字,每个关键字 (keyword) 最多可以包含 100 个字符。 字符串 数组
语言 编写关键字时使用的语言。

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

有关可能的值,请参阅 支持的语言
string
PublisherCountries 要用作历史数据源的国家/地区的国家/地区代码。

可以指定一个或多个国家/地区代码。 指定的每个国家/地区都必须支持 Language 元素中指定的 语言

有关可能的值,请参阅 广告语言

如果为 Null,则默认值为支持指定语言的所有国家/地区。
字符串 数组
StartDate 日期范围的开始日期,用于标识要用于确定历史搜索计数的数据。

此日期必须早于或等于指定的结束日期。 该日期应晚于与指定的 TimePeriodRollup 元素对应的最大可用历史数据范围。

如果指定的 TimePeriodRollup 为“每周”或“每月”,则可能会调整生效开始日期。
DayMonthAndYear
TimePeriodRollup 可以指定是每天、每周还是每月返回聚合的数据。

有关支持值的列表,请参阅下面的 “备注 ”部分。
string

请求标头元素

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

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

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

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

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

响应元素

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

响应正文元素

元素 说明 数据类型
KeywordSearchCounts KeywordSearchCount 数据对象的数组。 数组包含请求中指定的每个关键字 (keyword) 的项。 如果关键字 (keyword) 无效,则数组中的相应项将为 null。

每个 KeywordSearchCount 都包含 SearchCountsByAttributes 数组。 数组包含请求中指定的每个唯一设备的项。
KeywordSearchCount 数组

响应标头元素

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

请求 JSON

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

{
  "Keywords": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountries": [
    "ValueHere"
  ],
  "StartDate": {
    "Day": IntValueHere,
    "Month": IntValueHere,
    "Year": IntValueHere
  },
  "EndDate": {
    "Day": IntValueHere,
    "Month": IntValueHere,
    "Year": IntValueHere
  },
  "TimePeriodRollup": "ValueHere",
  "Devices": [
    "ValueHere"
  ]
}

响应 JSON

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

{
  "KeywordSearchCounts": [
    {
      "Keyword": "ValueHere",
      "SearchCountsByAttributes": [
        {
          "Device": "ValueHere",
          "HistoricalSearchCounts": [
            {
              "DayMonthAndYear": {
                "Day": IntValueHere,
                "Month": IntValueHere,
                "Year": IntValueHere
              },
              "SearchCount": "LongValueHere"
            }
          ]
        }
      ]
    }
  ]
}

代码语法

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

public async Task<GetHistoricalSearchCountResponse> GetHistoricalSearchCountAsync(
	IList<string> keywords,
	string language,
	IList<string> publisherCountries,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate,
	string timePeriodRollup,
	IList<string> devices)
{
	var request = new GetHistoricalSearchCountRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountries = publisherCountries,
		StartDate = startDate,
		EndDate = endDate,
		TimePeriodRollup = timePeriodRollup,
		Devices = devices
	};

	return (await AdInsightService.CallAsync((s, r) => s.GetHistoricalSearchCountAsync(r), request));
}
static GetHistoricalSearchCountResponse getHistoricalSearchCount(
	ArrayOfstring keywords,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	DayMonthAndYear startDate,
	DayMonthAndYear endDate,
	java.lang.String timePeriodRollup,
	ArrayOfstring devices) throws RemoteException, Exception
{
	GetHistoricalSearchCountRequest request = new GetHistoricalSearchCountRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setStartDate(startDate);
	request.setEndDate(endDate);
	request.setTimePeriodRollup(timePeriodRollup);
	request.setDevices(devices);

	return AdInsightService.getService().getHistoricalSearchCount(request);
}
static function GetHistoricalSearchCount(
	$keywords,
	$language,
	$publisherCountries,
	$startDate,
	$endDate,
	$timePeriodRollup,
	$devices)
{

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

	$request = new GetHistoricalSearchCountRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->StartDate = $startDate;
	$request->EndDate = $endDate;
	$request->TimePeriodRollup = $timePeriodRollup;
	$request->Devices = $devices;

	return $GLOBALS['AdInsightProxy']->GetService()->GetHistoricalSearchCount($request);
}
response=adinsight_service.GetHistoricalSearchCount(
	Keywords=Keywords,
	Language=Language,
	PublisherCountries=PublisherCountries,
	StartDate=StartDate,
	EndDate=EndDate,
	TimePeriodRollup=TimePeriodRollup,
	Devices=Devices)

备注

可以指定以下区分大小写的值,并且数据将回到相应的最大可用历史数据范围。

TimePeriodRollup 可用历史数据
每天 最晚于最近完成日期之前的 45 天。
每周 最早于最近完成的一周的 15 周。

指定的 StartDate 调整回最近的星期日, EndDate 将向前调整为最近的星期六。
每月 最早于最近完成月份的 24 个月。

指定的 StartDate 调整回月头, EndDate 将向前调整到月末。

支持的语言

下面是 语言 请求正文元素支持的语言:

支持的语言
丹麦语
荷兰语
英语
芬兰语
法语
德语
意大利语
挪威语
葡萄牙语
SimplifiedChinese
西班牙语
瑞典语
TraditionalChinese

语言和国家/地区映射

下面是语言和国家/地区映射表:

语言 CountryCode 国家/地区 Language@Country
丹麦语 DK 丹麦 Danish@Denmark
荷兰语 NL 荷兰 Dutch@Netherlands
英语 AU 澳大利亚 English@Australia
英语 加利福尼亚州 加拿大 English@Canada
英语 FR 法国 English@France
英语 DE 德国 English@Germany
英语 IN 印度 English@India
英语 ID 印度尼西亚 English@Indonesia
英语 IE 爱尔兰 English@Ireland
英语 IT Italy(意大利) English@Italy
英语 马来西亚 English@Malaysia
英语 NL 荷兰 English@Netherlands
英语 新西兰 NewZealand English@NewZealand
英语 PH 菲律宾 English@Philippines
英语 SG 新加坡 English@Singapore
英语 ES 西班牙 English@Spain
英语 SE 瑞典 English@Sweden
英语 CH 瑞士 English@Switzerland
英语 TH 泰国 English@Thailand
英语 GB 英国 English@UK
英语 美国 美国 English@US
英语 VN 越南 英语@越南
芬兰语 FI 芬兰 Finnish@Finland
法语 加利福尼亚州 加拿大 French@Canada
法语 FR 法国 French@France
法语 CH Switzerland(瑞士) French@Switzerland
法语 GB 英国 French@UK
法语 美国 美国 French@US
德语 AU 澳大利亚 German@Australia
德语 AT 奥地利 German@Austria
德语 加利福尼亚州 加拿大 German@Canada
德语 FR 法国 German@France
德语 DE 德国 German@Germany
德语 CH 瑞士 German@Switzerland
德语 GB 英国 German@UK
德语 美国 美国 German@US
意大利语 IT Italy(意大利) Italian@Italy
挪威语 挪威 Norwegian@Norway
葡萄牙语 BR 巴西 Portuguese@Brazil
SimplifiedChinese 快递 之 家 中国 SimplifiedChinese@China
西班牙语 AR 阿根廷 Spanish@Argentina
西班牙语 CL 智利 Spanish@Chile
西班牙语 CO 哥伦比亚 Spanish@Colombia
西班牙语 MX 墨西哥 Spanish@Mexico
西班牙语 体育 秘鲁 Spanish@Peru
西班牙语 ES 西班牙 Spanish@Spain
西班牙语 美国 美国 Spanish@US
西班牙语 VE 委内瑞拉 Spanish@Venezuela
瑞典语 SE 瑞典 Swedish@Sweden
TraditionalChinese 香港 香港特区 TraditionalChinese@HongKongSAR
TraditionalChinese TW Taiwan(台湾) TraditionalChinese@Taiwan