GetKeywordLocations 服務作業 - Ad Insight

取得搜尋指定關鍵詞之使用者的地理位置。

注意事項

GetKeywordLocations 服務作業自 2023 年 8 月 21 日起已被取代。 深入了解。

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
裝置	您想要取得地理位置資訊的裝置陣列。 支援的裝置類型包括：計算機、非智慧型手機、智慧型手機、智慧型手機、平板電腦。 預設值為 [計算機]。 如果可用，回應只會包含您指定之裝置類型的關鍵詞位置數據。	字串陣列
關鍵字	要取得地理位置資訊的關鍵字陣列。 數據也會依 裝置 類型細分。 陣列最多可以包含1,000個關鍵詞，而且每個關鍵詞最多可以包含100個字元。	字串陣列
語言	用來撰寫關鍵詞的語言。 如需可能的值，請參閱 廣告語言。	string
層級	要匯總地理位置數據的層級。 可能的值如下： 0 - 國家/地區 1 - 州/省 2 - 都市區域 3 - 城市 預設值為 1 (州/省) 。	int
MaxLocations	要傳回的位置數目上限。 您最多可以要求10個位置。 預設值為 10。	int
ParentCountry	搜尋的來源國家/地區。 如需可能的值，請參閱 地理位置代碼。 預設值為 US。	string
PublisherCountry	要作為位置數據來源之國家/地區的國家/地區代碼。 您指定的國家/地區必須支援 Language 元素中指定的 語言 。 如需可能的值，請參閱 廣告語言。	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 元素

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

回應本文專案

元素	描述	資料類型
KeywordLocationResult	KeywordLocationResult 數據對象的陣列。 項目的順序會直接對應至要求中指定的關鍵詞。 如果關鍵詞沒有可用的位置數據，關鍵詞會包含在清單中，但是對應KeywordLocationResult物件的KeywordLocations元素會是 Null。 每個 KeywordLocationResult 資料物件都包含 KeywordLocation 的陣列。 數位包含要求中指定之每個裝置的專案。 每個 KeywordLocation 都包含地理位置，以及地理位置中的用戶搜尋指定關鍵詞的時間百分比。	KeywordLocationResult 陣 列

回應標頭元素

元素	描述	資料類型
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">GetKeywordLocations</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>
    <GetKeywordLocationsRequest 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>
      <Level i:nil="false">ValueHere</Level>
      <ParentCountry i:nil="false">ValueHere</ParentCountry>
      <MaxLocations i:nil="false">ValueHere</MaxLocations>
    </GetKeywordLocationsRequest>
  </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>
    <GetKeywordLocationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordLocationResult d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordLocationResult>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <KeywordLocations d4p1:nil="false">
            <KeywordLocation>
              <Device d4p1:nil="false">ValueHere</Device>
              <Location d4p1:nil="false">ValueHere</Location>
              <Percentage>ValueHere</Percentage>
            </KeywordLocation>
          </KeywordLocations>
        </KeywordLocationResult>
      </KeywordLocationResult>
    </GetKeywordLocationsResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device,
	int? level,
	string parentCountry,
	int? maxLocations)
{
	var request = new GetKeywordLocationsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device,
		Level = level,
		ParentCountry = parentCountry,
		MaxLocations = maxLocations
	};

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

static GetKeywordLocationsResponse getKeywordLocations(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device,
	int level,
	java.lang.String parentCountry,
	int maxLocations) throws RemoteException, Exception
{
	GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);
	request.setLevel(level);
	request.setParentCountry(parentCountry);
	request.setMaxLocations(maxLocations);

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

static function GetKeywordLocations(
	$keywords,
	$language,
	$publisherCountry,
	$device,
	$level,
	$parentCountry,
	$maxLocations)
{

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

	$request = new GetKeywordLocationsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;
	$request->Level = $level;
	$request->ParentCountry = $parentCountry;
	$request->MaxLocations = $maxLocations;

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

response=adinsight_service.GetKeywordLocations(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device,
	Level=Level,
	ParentCountry=ParentCountry,
	MaxLocations=MaxLocations)

需求

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

要求 URL

生產URL

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

沙箱 URL

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

要求專案

GetKeywordLocationsRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

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

要求本文專案

元素	描述	資料類型
裝置	您想要取得地理位置資訊的裝置陣列。 支援的裝置類型包括：計算機、非智慧型手機、智慧型手機、智慧型手機、平板電腦。 預設值為 [計算機]。 如果可用，回應只會包含您指定之裝置類型的關鍵詞位置數據。	字串陣列
關鍵字	要取得地理位置資訊的關鍵字陣列。 數據也會依 裝置 類型細分。 陣列最多可以包含1,000個關鍵詞，而且每個關鍵詞最多可以包含100個字元。	字串陣列
語言	用來撰寫關鍵詞的語言。 如需可能的值，請參閱 廣告語言。	string
層級	要匯總地理位置數據的層級。 可能的值如下： 0 - 國家/地區 1 - 州/省 2 - 都市區域 3 - 城市 預設值為 1 (州/省) 。	int
MaxLocations	要傳回的位置數目上限。 您最多可以要求10個位置。 預設值為 10。	int
ParentCountry	搜尋的來源國家/地區。 如需可能的值，請參閱 地理位置代碼。 預設值為 US。	string
PublisherCountry	要作為位置數據來源之國家/地區的國家/地區代碼。 您指定的國家/地區必須支援 Language 元素中指定的 語言 。 如需可能的值，請參閱 廣告語言。	string

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
KeywordLocationResult	KeywordLocationResult 數據對象的陣列。 項目的順序會直接對應至要求中指定的關鍵詞。 如果關鍵詞沒有可用的位置數據，關鍵詞會包含在清單中，但是對應KeywordLocationResult物件的KeywordLocations元素會是 Null。 每個 KeywordLocationResult 資料物件都包含 KeywordLocation 的陣列。 數位包含要求中指定之每個裝置的專案。 每個 KeywordLocation 都包含地理位置，以及地理位置中的用戶搜尋指定關鍵詞的時間百分比。	KeywordLocationResult 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "Keywords": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountry": "ValueHere",
  "Device": [
    "ValueHere"
  ],
  "Level": IntValueHere,
  "ParentCountry": "ValueHere",
  "MaxLocations": IntValueHere
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

{
  "KeywordLocationResult": [
    {
      "Keyword": "ValueHere",
      "KeywordLocations": [
        {
          "Device": "ValueHere",
          "Location": "ValueHere",
          "Percentage": DoubleValueHere
        }
      ]
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<GetKeywordLocationsResponse> GetKeywordLocationsAsync(
	IList<string> keywords,
	string language,
	string publisherCountry,
	IList<string> device,
	int? level,
	string parentCountry,
	int? maxLocations)
{
	var request = new GetKeywordLocationsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountry = publisherCountry,
		Device = device,
		Level = level,
		ParentCountry = parentCountry,
		MaxLocations = maxLocations
	};

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

static GetKeywordLocationsResponse getKeywordLocations(
	ArrayOfstring keywords,
	java.lang.String language,
	java.lang.String publisherCountry,
	ArrayOfstring device,
	int level,
	java.lang.String parentCountry,
	int maxLocations) throws RemoteException, Exception
{
	GetKeywordLocationsRequest request = new GetKeywordLocationsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountry(publisherCountry);
	request.setDevice(device);
	request.setLevel(level);
	request.setParentCountry(parentCountry);
	request.setMaxLocations(maxLocations);

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

static function GetKeywordLocations(
	$keywords,
	$language,
	$publisherCountry,
	$device,
	$level,
	$parentCountry,
	$maxLocations)
{

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

	$request = new GetKeywordLocationsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountry = $publisherCountry;
	$request->Device = $device;
	$request->Level = $level;
	$request->ParentCountry = $parentCountry;
	$request->MaxLocations = $maxLocations;

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

response=adinsight_service.GetKeywordLocations(
	Keywords=Keywords,
	Language=Language,
	PublisherCountry=PublisherCountry,
	Device=Device,
	Level=Level,
	ParentCountry=ParentCountry,
	MaxLocations=MaxLocations)