GetEstimatedPositionByKeywords 服務作業 - Ad Insight

如果指定的標定值會用於指定的關鍵詞，則取得搜尋結果中的估計位置。 此外，此作業還提供按下次數的估計值、每單擊的平均成本 (的) ，以及關鍵詞可透過預估的報價產生印象。

估計值不是預測或保證未來的效能。

注意事項

這項作業適用於使用增強型的檢定標定策略的搜尋活動。

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
AdGroupId	廣告群組的標識碼，其效能數據可用來協助判斷關鍵詞在廣告群組內容中的執行效能。 指定廣告群組有助於改善建議位置的精確度。 如果您指定廣告群組，則必須指定其所屬的營銷活動。	長
CampaignId	擁有 AdGroupId 中指定之廣告群組的行銷活動標識碼。 如果您未指定廣告群組，則會使用行銷活動的績效數據來協助判斷關鍵詞在營銷活動內容中的執行效能。 指定營銷活動和廣告群組有助於改善建議位置的精確度。 如果未指定 AdGroupId 或 CampaignId ，作業會使用指定的 CustomerAccountId 標頭元素來協助判斷關鍵詞在帳戶內容中的執行效能。	長
CurrencyCode	用於計算成本預估和建議的報價值之貨幣單位的 ISO 程式代碼。 如果未設定，服務會從 CustomerAccountId 標頭元素中指定的帳戶決定貨幣。 如果未設定 Currency 或 CustomerAccountId ，則服務會使用 USD。	CurrencyCode
關鍵字	關鍵字陣列，您想要根據指定的標價值，取得搜尋結果中的估計位置。 您最多可以指定 1,000 個關鍵詞，而且每個關鍵詞最多可以包含 100 個字元。	字串陣列
語言	與位置識別碼平行使用的語言，用於估計位置。 您在 LocationIds 中指定的每個位置都必須支援該語言。 如需可能的語言值，請參閱 廣告語言。 如果您未指定語言，服務作業會使用指定之 AdGroupId 或 CampaignId 的語言。 如果未設定這些屬性，則預設會使用 EN (英文) 。	string
LocationIds	用來估計位置的地理位置標識碼或標識碼。 所有位置都必須支援 Language 元素中指定的 語言 。 雖然您可以指定多個位置識別碼，但最佳做法是針對每個位置最精確的位置估計值，您應該針對每個服務呼叫只指定一個位置。 如需可能的位置標識碼，請參閱 地理位置代碼。 如果您未指定任何位置，服務作業會使用指定 之 AdGroupId 或 CampaignId 的位置準則。 如果未設定這些屬性，則預設會使用 190 (美國) 。	long 陣列
MatchTypes	要取得估計值的唯一比對型別數位列。 您不能指定內容比對類型。	MatchType 陣 列
MaxBid	用來判斷搜尋結果中估計位置的最大約定值。	雙

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
KeywordEstimatedPositions	KeywordEstimatedPosition 數據對象的陣列。 數位包含要求中指定之每個關鍵詞的專案。 如果關鍵詞無效，陣列中的對應專案將會是 Null。 如果關鍵詞有可用的數據， EstimatedPositionAndTraffic 會根據指定的報價值，在搜尋結果中提供廣告顯示位置的估計位置。 否則， EstimatedPositions 元素會設定為 null。	KeywordEstimatedPosition 陣列

回應標頭元素

元素	描述	資料類型
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">GetEstimatedPositionByKeywords</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>
    <GetEstimatedPositionByKeywordsRequest 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>
      <MaxBid>ValueHere</MaxBid>
      <Language i:nil="false">ValueHere</Language>
      <LocationIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LocationIds>
      <CurrencyCode i:nil="false">ValueHere</CurrencyCode>
      <MatchTypes i:nil="false">
        <MatchType>ValueHere</MatchType>
      </MatchTypes>
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
    </GetEstimatedPositionByKeywordsRequest>
  </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>
    <GetEstimatedPositionByKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedPositions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordEstimatedPosition>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <EstimatedPositions d4p1:nil="false">
            <EstimatedPositionAndTraffic>
              <MatchType>ValueHere</MatchType>
              <MinClicksPerWeek>ValueHere</MinClicksPerWeek>
              <MaxClicksPerWeek>ValueHere</MaxClicksPerWeek>
              <AverageCPC>ValueHere</AverageCPC>
              <MinImpressionsPerWeek>ValueHere</MinImpressionsPerWeek>
              <MaxImpressionsPerWeek>ValueHere</MaxImpressionsPerWeek>
              <CTR>ValueHere</CTR>
              <MinTotalCostPerWeek>ValueHere</MinTotalCostPerWeek>
              <MaxTotalCostPerWeek>ValueHere</MaxTotalCostPerWeek>
              <CurrencyCode>ValueHere</CurrencyCode>
              <EstimatedAdPosition>ValueHere</EstimatedAdPosition>
            </EstimatedPositionAndTraffic>
          </EstimatedPositions>
        </KeywordEstimatedPosition>
      </KeywordEstimatedPositions>
    </GetEstimatedPositionByKeywordsResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

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

public async Task<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

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

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

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

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

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

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)

需求

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

要求 URL

生產URL

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/EstimatedPosition/QueryByKeywords

沙箱 URL

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/EstimatedPosition/QueryByKeywords

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
AdGroupId	廣告群組的標識碼，其效能數據可用來協助判斷關鍵詞在廣告群組內容中的執行效能。 指定廣告群組有助於改善建議位置的精確度。 如果您指定廣告群組，則必須指定其所屬的營銷活動。	長
CampaignId	擁有 AdGroupId 中指定之廣告群組的行銷活動標識碼。 如果您未指定廣告群組，則會使用行銷活動的績效數據來協助判斷關鍵詞在營銷活動內容中的執行效能。 指定營銷活動和廣告群組有助於改善建議位置的精確度。 如果未指定 AdGroupId 或 CampaignId ，作業會使用指定的 CustomerAccountId 標頭元素來協助判斷關鍵詞在帳戶內容中的執行效能。	長
CurrencyCode	用於計算成本預估和建議的報價值之貨幣單位的 ISO 程式代碼。 如果未設定，服務會從 CustomerAccountId 標頭元素中指定的帳戶決定貨幣。 如果未設定 Currency 或 CustomerAccountId ，則服務會使用 USD。	CurrencyCode
關鍵字	關鍵字陣列，您想要根據指定的標價值，取得搜尋結果中的估計位置。 您最多可以指定 1,000 個關鍵詞，而且每個關鍵詞最多可以包含 100 個字元。	字串陣列
語言	與位置識別碼平行使用的語言，用於估計位置。 您在 LocationIds 中指定的每個位置都必須支援該語言。 如需可能的語言值，請參閱 廣告語言。 如果您未指定語言，服務作業會使用指定之 AdGroupId 或 CampaignId 的語言。 如果未設定這些屬性，則預設會使用 EN (英文) 。	string
LocationIds	用來估計位置的地理位置標識碼或標識碼。 所有位置都必須支援 Language 元素中指定的 語言 。 雖然您可以指定多個位置識別碼，但最佳做法是針對每個位置最精確的位置估計值，您應該針對每個服務呼叫只指定一個位置。 如需可能的位置標識碼，請參閱 地理位置代碼。 如果您未指定任何位置，服務作業會使用指定 之 AdGroupId 或 CampaignId 的位置準則。 如果未設定這些屬性，則預設會使用 190 (美國) 。	long 陣列
MatchTypes	要取得估計值的唯一比對型別數位列。 您不能指定內容比對類型。	MatchType 陣 列
MaxBid	用來判斷搜尋結果中估計位置的最大約定值。	雙

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
KeywordEstimatedPositions	KeywordEstimatedPosition 數據對象的陣列。 數位包含要求中指定之每個關鍵詞的專案。 如果關鍵詞無效，陣列中的對應專案將會是 Null。 如果關鍵詞有可用的數據， EstimatedPositionAndTraffic 會根據指定的報價值，在搜尋結果中提供廣告顯示位置的估計位置。 否則， EstimatedPositions 元素會設定為 null。	KeywordEstimatedPosition 陣列

回應標頭元素

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

要求 JSON

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

{
  "Keywords": [
    "ValueHere"
  ],
  "MaxBid": DoubleValueHere,
  "Language": "ValueHere",
  "LocationIds": [
    "LongValueHere"
  ],
  "CurrencyCode": "ValueHere",
  "MatchTypes": [
    "ValueHere"
  ],
  "CampaignId": "LongValueHere",
  "AdGroupId": "LongValueHere"
}

回應 JSON

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

{
  "KeywordEstimatedPositions": [
    {
      "EstimatedPositions": [
        {
          "AverageCPC": DoubleValueHere,
          "CTR": DoubleValueHere,
          "CurrencyCode": "ValueHere",
          "EstimatedAdPosition": DoubleValueHere,
          "MatchType": "ValueHere",
          "MaxClicksPerWeek": DoubleValueHere,
          "MaxImpressionsPerWeek": "LongValueHere",
          "MaxTotalCostPerWeek": DoubleValueHere,
          "MinClicksPerWeek": DoubleValueHere,
          "MinImpressionsPerWeek": "LongValueHere",
          "MinTotalCostPerWeek": DoubleValueHere
        }
      ],
      "Keyword": "ValueHere"
    }
  ]
}

程序代碼語法

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

public async Task<GetEstimatedPositionByKeywordsResponse> GetEstimatedPositionByKeywordsAsync(
	IList<string> keywords,
	double maxBid,
	string language,
	IList<long> locationIds,
	CurrencyCode? currencyCode,
	IList<MatchType> matchTypes,
	long? campaignId,
	long? adGroupId)
{
	var request = new GetEstimatedPositionByKeywordsRequest
	{
		Keywords = keywords,
		MaxBid = maxBid,
		Language = language,
		LocationIds = locationIds,
		CurrencyCode = currencyCode,
		MatchTypes = matchTypes,
		CampaignId = campaignId,
		AdGroupId = adGroupId
	};

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

static GetEstimatedPositionByKeywordsResponse getEstimatedPositionByKeywords(
	ArrayOfstring keywords,
	double maxBid,
	java.lang.String language,
	ArrayOflong locationIds,
	CurrencyCode currencyCode,
	ArrayOfMatchType matchTypes,
	java.lang.Long campaignId,
	java.lang.Long adGroupId) throws RemoteException, Exception
{
	GetEstimatedPositionByKeywordsRequest request = new GetEstimatedPositionByKeywordsRequest();

	request.setKeywords(keywords);
	request.setMaxBid(maxBid);
	request.setLanguage(language);
	request.setLocationIds(locationIds);
	request.setCurrencyCode(currencyCode);
	request.setMatchTypes(matchTypes);
	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);

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

static function GetEstimatedPositionByKeywords(
	$keywords,
	$maxBid,
	$language,
	$locationIds,
	$currencyCode,
	$matchTypes,
	$campaignId,
	$adGroupId)
{

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

	$request = new GetEstimatedPositionByKeywordsRequest();

	$request->Keywords = $keywords;
	$request->MaxBid = $maxBid;
	$request->Language = $language;
	$request->LocationIds = $locationIds;
	$request->CurrencyCode = $currencyCode;
	$request->MatchTypes = $matchTypes;
	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;

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

response=adinsight_service.GetEstimatedPositionByKeywords(
	Keywords=Keywords,
	MaxBid=MaxBid,
	Language=Language,
	LocationIds=LocationIds,
	CurrencyCode=CurrencyCode,
	MatchTypes=MatchTypes,
	CampaignId=CampaignId,
	AdGroupId=AdGroupId)