GetHistoricalSearchCount 服務作業 - Ad Insight

取得在指定時間週期內，在搜尋中使用正規化字詞的次數。 結果會依裝置類型匯總。

要求專案

GetHistoricalSearchCountRequest物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求 SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	說明	資料類型
設備	下列一或多個裝置類型的清單：電腦、NonSmartphone、智慧型手機、平板電腦。 預設值為 [電腦]。 回應包含您僅在可用時指定之裝置類型的搜尋計數。	字串數 組
EndDate	日期範圍的結束日期，識別您想要用來判斷歷程記錄搜尋計數的資料。 日期不能晚於今天的日期，而且必須晚于或等於指定的開始日期。 如果指定的 TimePeriodRollup 是 [每週] 或 [每月]，則可以調整有效結束日期。	DayMonthAndYear
關鍵 字	關鍵字陣列，您想要判斷關鍵字在搜尋查詢中使用的次數。 陣列最多可以包含 1,000 個關鍵字，而且每個關鍵字最多可以包含 100 個字元。	字串數 組
語言	用來撰寫關鍵字的語言。 您在 PublisherCountries 元素中指定的國家/地區必須支援指定的語言。 如需可能的值，請參閱 支援的語言。	string
PublisherCountries	要作為歷史資料來源之國家/地區的國家/地區代碼。 您可以指定一或多個國家/地區代碼。 您指定的每個國家/地區都必須支援 Language 元素中指定的 語言 。 如需可能的值，請參閱 廣告語言。 如果為 Null，則預設值為支援指定語言的所有國家/地區。	字串數 組
StartDate	日期範圍的開始日期，識別您想要用來判斷歷程記錄搜尋計數的資料。 此日期必須早于或與指定的結束日期相同。 日期應該晚于對應至指定 TimePeriodRollup 元素的最大可用歷程記錄資料範圍。 如果指定的 TimePeriodRollup 是 [每週] 或 [每月]，則可以調整有效開始日期。	DayMonthAndYear
TimePeriodRollup	您可以指定要傳回每日、每週或每月匯總的資料。 For a list of supported values, see the Remarks section below.	string

要求標頭元素

元素	說明	資料類型
AuthenticationToken	OAuth 存取權杖，代表具有 Microsoft Advertising 帳戶許可權之使用者的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的識別碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶識別碼。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶識別碼。 使用者可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶識別碼。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員權杖。 如需詳細資訊 ，請參閱取得開發人員權杖。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定使用者認證。	string

Response 元素

GetHistoricalSearchCountResponse物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 SOAP中所示的順序相同。

回應本文專案

元素	說明	資料類型
KeywordSearchCounts	KeywordSearchCount資料物件的陣列。 陣列包含要求中指定之每個關鍵字的專案。 如果關鍵字無效，陣列中的對應專案將會是 Null。 每個 KeywordSearchCount 都包含 SearchCountsByAttributes的陣列。 陣列包含要求中指定之每個唯一裝置的專案。	KeywordSearchCount 數 組

回應標頭元素

元素	說明	資料類型
TrackingId	包含 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>

程式碼語法

範例語法可以與 Bing 廣告 SDK搭配使用。 如需更多範例，請參閱 Bing 廣告 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 會向前調整到月底。

支援的語言

以下是 Language 要求主體元素的支援語言：

支援的語言
丹麥文
荷蘭文
英文
芬蘭文
法文
德文
義大利文
挪威文
葡萄牙文
SimplifiedChinese
西班牙文
瑞典文
TraditionalChinese

語言和國家/地區對應

以下是語言和國家/地區對應的資料表：

語言	CountryCode	國家/地區	Language@Country
丹麥文	DK	丹麥	Danish@Denmark
荷蘭文	NL	荷蘭	Dutch@Netherlands
英文	金	澳洲	English@Australia
英文	CA	加拿大	English@Canada
英文	FR	法國	English@France
英文	DE	德國	English@Germany
英文	IN	印度	English@India
英文	ID	印尼	English@Indonesia
英文	IE	愛爾蘭	English@Ireland
英文	IT	義大利	English@Italy
英文	我	馬來西亞	English@Malaysia
英文	NL	荷蘭	English@Netherlands
英文	紐西蘭	NewZealand	English@NewZealand
英文	PH	菲律賓	English@Philippines
英文	S g	新加坡	English@Singapore
英文	ES	西班牙	English@Spain
英文	SE	瑞典	English@Sweden
英文	CH	瑞士	English@Switzerland
英文	TH	泰國	English@Thailand
英文	G b	英國	English@UK
英文	美國	美國	English@US
英文	VN	越南	英文@越南
芬蘭文	FI	芬蘭	Finnish@Finland
法文	CA	加拿大	French@Canada
法文	FR	法國	French@France
法文	CH	瑞士	French@Switzerland
法文	G b	英國	French@UK
法文	美國	美國	French@US
德文	金	澳洲	German@Australia
德文	AT	奧地利	German@Austria
德文	CA	加拿大	German@Canada
德文	FR	法國	German@France
德文	DE	德國	German@Germany
德文	CH	瑞士	German@Switzerland
德文	G b	英國	German@UK
德文	美國	美國	German@US
義大利文	IT	義大利	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	台灣	TraditionalChinese@Taiwan

需求

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