SuggestKeywordsFromExistingKeywords 服務作業 - Ad Insight

建議效能優於指定關鍵詞的關鍵詞。

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
AdGroupId	建議關鍵詞的廣告群組標識碼。 尚不支援此元素，而且可用來影響未來版本中的關鍵詞建議	長
CampaignId	建議關鍵詞的營銷活動標識碼。 尚不支援此元素，而且可用來影響未來版本中的關鍵詞建議	長
ExcludeBrand	值，判斷結果是否排除 brand 關鍵詞。 若要在結果中排除品牌關鍵詞，請將 設定為 true。 默認值為 false。	布爾
關鍵字	關鍵詞的陣列，您想要為其取得可執行更佳的建議關鍵詞。 陣列最多可以包含1,000個關鍵詞，而且每個關鍵詞最多可以包含100個字元。	字串陣列
語言	撰寫關鍵詞的語言。 可能區分大小寫的值為 英文、 法文和 德文。 See the Remarks section below for a list of providers that are supported for each language. 預設值為英文。	string
MaxSuggestionsPerKeyword	每個指定關鍵詞傳回的關鍵詞建議數目上限。 如果 SuggestionType 設定為 4，則每個關鍵詞最多可以要求 200 個建議;否則，您可以要求的最大建議為 100。 預設值為 50。	int
PublisherCountries	國家/地區的國家/地區代碼，用來作為判斷建議關鍵詞的數據源。 您可以指定一或多個國家/地區代碼。 您指定的每個國家/地區都必須支援您在 Language 元素中指定的 語言 。 For supported values, see the Remarks section below. 預設值是支援指定語言的所有國家/地區。	字串陣列
RemoveDuplicates	布爾值，決定是否要從建議的關鍵詞清單中移除重複的關鍵詞。 若要移除重複專案，請將 設定為 true。 默認值為 false。	布爾
SuggestionType	用來產生關鍵詞建議的提供者。 For a list of possible providers, the language and country/region restrictions of each provider, and the default provider by country/region, see the Remarks section below.	int

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
KeywordSuggestions	KeywordSuggestion 數據對象的陣列。 數位包含要求中指定之每個關鍵詞的專案。 物件包含建議的關鍵詞清單，其效能可能優於指定的關鍵詞。 針對每個建議的關鍵詞，物件包含一個分數，指出使用 關鍵詞會導致廣告包含在搜尋查詢結果中的機率。 如果關鍵詞沒有任何建議，則 SuggestionsAndConfidence 元素會是 Null。	KeywordSuggestion 陣 列

回應標頭元素

元素	描述	資料類型
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">SuggestKeywordsFromExistingKeywords</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>
    <SuggestKeywordsFromExistingKeywordsRequest 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>
      <MaxSuggestionsPerKeyword i:nil="false">ValueHere</MaxSuggestionsPerKeyword>
      <SuggestionType i:nil="false">ValueHere</SuggestionType>
      <RemoveDuplicates i:nil="false">ValueHere</RemoveDuplicates>
      <ExcludeBrand i:nil="false">ValueHere</ExcludeBrand>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <CampaignId i:nil="false">ValueHere</CampaignId>
    </SuggestKeywordsFromExistingKeywordsRequest>
  </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>
    <SuggestKeywordsFromExistingKeywordsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordSuggestions d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordSuggestion>
          <Keyword d4p1:nil="false">ValueHere</Keyword>
          <SuggestionsAndConfidence d4p1:nil="false">
            <KeywordAndConfidence>
              <SuggestedKeyword d4p1:nil="false">ValueHere</SuggestedKeyword>
              <ConfidenceScore>ValueHere</ConfidenceScore>
            </KeywordAndConfidence>
          </SuggestionsAndConfidence>
        </KeywordSuggestion>
      </KeywordSuggestions>
    </SuggestKeywordsFromExistingKeywordsResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

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

public async Task<SuggestKeywordsFromExistingKeywordsResponse> SuggestKeywordsFromExistingKeywordsAsync(
	IList<string> keywords,
	string language,
	IList<string> publisherCountries,
	int? maxSuggestionsPerKeyword,
	int? suggestionType,
	bool? removeDuplicates,
	bool? excludeBrand,
	long? adGroupId,
	long? campaignId)
{
	var request = new SuggestKeywordsFromExistingKeywordsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountries = publisherCountries,
		MaxSuggestionsPerKeyword = maxSuggestionsPerKeyword,
		SuggestionType = suggestionType,
		RemoveDuplicates = removeDuplicates,
		ExcludeBrand = excludeBrand,
		AdGroupId = adGroupId,
		CampaignId = campaignId
	};

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

static SuggestKeywordsFromExistingKeywordsResponse suggestKeywordsFromExistingKeywords(
	ArrayOfstring keywords,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	int maxSuggestionsPerKeyword,
	int suggestionType,
	boolean removeDuplicates,
	boolean excludeBrand,
	java.lang.Long adGroupId,
	java.lang.Long campaignId) throws RemoteException, Exception
{
	SuggestKeywordsFromExistingKeywordsRequest request = new SuggestKeywordsFromExistingKeywordsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setMaxSuggestionsPerKeyword(maxSuggestionsPerKeyword);
	request.setSuggestionType(suggestionType);
	request.setRemoveDuplicates(removeDuplicates);
	request.setExcludeBrand(excludeBrand);
	request.setAdGroupId(adGroupId);
	request.setCampaignId(campaignId);

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

static function SuggestKeywordsFromExistingKeywords(
	$keywords,
	$language,
	$publisherCountries,
	$maxSuggestionsPerKeyword,
	$suggestionType,
	$removeDuplicates,
	$excludeBrand,
	$adGroupId,
	$campaignId)
{

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

	$request = new SuggestKeywordsFromExistingKeywordsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->MaxSuggestionsPerKeyword = $maxSuggestionsPerKeyword;
	$request->SuggestionType = $suggestionType;
	$request->RemoveDuplicates = $removeDuplicates;
	$request->ExcludeBrand = $excludeBrand;
	$request->AdGroupId = $adGroupId;
	$request->CampaignId = $campaignId;

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

response=adinsight_service.SuggestKeywordsFromExistingKeywords(
	Keywords=Keywords,
	Language=Language,
	PublisherCountries=PublisherCountries,
	MaxSuggestionsPerKeyword=MaxSuggestionsPerKeyword,
	SuggestionType=SuggestionType,
	RemoveDuplicates=RemoveDuplicates,
	ExcludeBrand=ExcludeBrand,
	AdGroupId=AdGroupId,
	CampaignId=CampaignId)

註解

以下是您可以指定的可能建議提供者。

建議類型	描述
1	傳回包含 關鍵詞的搜尋查詢。
2	從包含指定關鍵詞的其他廣告群組傳回關鍵詞。
3	傳回與指定關鍵詞相關的搜尋查詢。
4	傳回其他提供者的最佳建議。

以下是每個國家/地區支援的提供者。

國家/地區	語言	支援的提供者類型	預設提供者類型
澳大利亞 (AU)	英文	2,3,4	4
加拿大 (CA)	英文	2,3,4	4
法國 (FR)	法文	2,3,4	4
德國 (DE)	德文	1,2,3,4	4

需求

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

要求 URL

生產URL

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

沙箱 URL

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

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
AdGroupId	建議關鍵詞的廣告群組標識碼。 尚不支援此元素，而且可用來影響未來版本中的關鍵詞建議	長
CampaignId	建議關鍵詞的營銷活動標識碼。 尚不支援此元素，而且可用來影響未來版本中的關鍵詞建議	長
ExcludeBrand	值，判斷結果是否排除 brand 關鍵詞。 若要在結果中排除品牌關鍵詞，請將 設定為 true。 默認值為 false。	布爾
關鍵字	關鍵詞的陣列，您想要為其取得可執行更佳的建議關鍵詞。 陣列最多可以包含1,000個關鍵詞，而且每個關鍵詞最多可以包含100個字元。	字串陣列
語言	撰寫關鍵詞的語言。 可能區分大小寫的值為 英文、 法文和 德文。 See the Remarks section below for a list of providers that are supported for each language. 預設值為英文。	string
MaxSuggestionsPerKeyword	每個指定關鍵詞傳回的關鍵詞建議數目上限。 如果 SuggestionType 設定為 4，則每個關鍵詞最多可以要求 200 個建議;否則，您可以要求的最大建議為 100。 預設值為 50。	int
PublisherCountries	國家/地區的國家/地區代碼，用來作為判斷建議關鍵詞的數據源。 您可以指定一或多個國家/地區代碼。 您指定的每個國家/地區都必須支援您在 Language 元素中指定的 語言 。 For supported values, see the Remarks section below. 預設值是支援指定語言的所有國家/地區。	字串陣列
RemoveDuplicates	布爾值，決定是否要從建議的關鍵詞清單中移除重複的關鍵詞。 若要移除重複專案，請將 設定為 true。 默認值為 false。	布爾
SuggestionType	用來產生關鍵詞建議的提供者。 For a list of possible providers, the language and country/region restrictions of each provider, and the default provider by country/region, see the Remarks section below.	int

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
KeywordSuggestions	KeywordSuggestion 數據對象的陣列。 數位包含要求中指定之每個關鍵詞的專案。 物件包含建議的關鍵詞清單，其效能可能優於指定的關鍵詞。 針對每個建議的關鍵詞，物件包含一個分數，指出使用 關鍵詞會導致廣告包含在搜尋查詢結果中的機率。 如果關鍵詞沒有任何建議，則 SuggestionsAndConfidence 元素會是 Null。	KeywordSuggestion 陣 列

回應標頭元素

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

要求 JSON

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

{
  "Keywords": [
    "ValueHere"
  ],
  "Language": "ValueHere",
  "PublisherCountries": [
    "ValueHere"
  ],
  "MaxSuggestionsPerKeyword": IntValueHere,
  "SuggestionType": IntValueHere,
  "RemoveDuplicates": "ValueHere",
  "ExcludeBrand": "ValueHere",
  "AdGroupId": "LongValueHere",
  "CampaignId": "LongValueHere"
}

回應 JSON

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

{
  "KeywordSuggestions": [
    {
      "Keyword": "ValueHere",
      "SuggestionsAndConfidence": [
        {
          "ConfidenceScore": DoubleValueHere,
          "SuggestedKeyword": "ValueHere"
        }
      ]
    }
  ]
}

程序代碼語法

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

public async Task<SuggestKeywordsFromExistingKeywordsResponse> SuggestKeywordsFromExistingKeywordsAsync(
	IList<string> keywords,
	string language,
	IList<string> publisherCountries,
	int? maxSuggestionsPerKeyword,
	int? suggestionType,
	bool? removeDuplicates,
	bool? excludeBrand,
	long? adGroupId,
	long? campaignId)
{
	var request = new SuggestKeywordsFromExistingKeywordsRequest
	{
		Keywords = keywords,
		Language = language,
		PublisherCountries = publisherCountries,
		MaxSuggestionsPerKeyword = maxSuggestionsPerKeyword,
		SuggestionType = suggestionType,
		RemoveDuplicates = removeDuplicates,
		ExcludeBrand = excludeBrand,
		AdGroupId = adGroupId,
		CampaignId = campaignId
	};

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

static SuggestKeywordsFromExistingKeywordsResponse suggestKeywordsFromExistingKeywords(
	ArrayOfstring keywords,
	java.lang.String language,
	ArrayOfstring publisherCountries,
	int maxSuggestionsPerKeyword,
	int suggestionType,
	boolean removeDuplicates,
	boolean excludeBrand,
	java.lang.Long adGroupId,
	java.lang.Long campaignId) throws RemoteException, Exception
{
	SuggestKeywordsFromExistingKeywordsRequest request = new SuggestKeywordsFromExistingKeywordsRequest();

	request.setKeywords(keywords);
	request.setLanguage(language);
	request.setPublisherCountries(publisherCountries);
	request.setMaxSuggestionsPerKeyword(maxSuggestionsPerKeyword);
	request.setSuggestionType(suggestionType);
	request.setRemoveDuplicates(removeDuplicates);
	request.setExcludeBrand(excludeBrand);
	request.setAdGroupId(adGroupId);
	request.setCampaignId(campaignId);

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

static function SuggestKeywordsFromExistingKeywords(
	$keywords,
	$language,
	$publisherCountries,
	$maxSuggestionsPerKeyword,
	$suggestionType,
	$removeDuplicates,
	$excludeBrand,
	$adGroupId,
	$campaignId)
{

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

	$request = new SuggestKeywordsFromExistingKeywordsRequest();

	$request->Keywords = $keywords;
	$request->Language = $language;
	$request->PublisherCountries = $publisherCountries;
	$request->MaxSuggestionsPerKeyword = $maxSuggestionsPerKeyword;
	$request->SuggestionType = $suggestionType;
	$request->RemoveDuplicates = $removeDuplicates;
	$request->ExcludeBrand = $excludeBrand;
	$request->AdGroupId = $adGroupId;
	$request->CampaignId = $campaignId;

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

response=adinsight_service.SuggestKeywordsFromExistingKeywords(
	Keywords=Keywords,
	Language=Language,
	PublisherCountries=PublisherCountries,
	MaxSuggestionsPerKeyword=MaxSuggestionsPerKeyword,
	SuggestionType=SuggestionType,
	RemoveDuplicates=RemoveDuplicates,
	ExcludeBrand=ExcludeBrand,
	AdGroupId=AdGroupId,
	CampaignId=CampaignId)

註解

以下是您可以指定的可能建議提供者。

建議類型	描述
1	傳回包含 關鍵詞的搜尋查詢。
2	從包含指定關鍵詞的其他廣告群組傳回關鍵詞。
3	傳回與指定關鍵詞相關的搜尋查詢。
4	傳回其他提供者的最佳建議。

以下是每個國家/地區支援的提供者。

國家/地區	語言	支援的提供者類型	預設提供者類型
澳大利亞 (AU)	英文	2,3,4	4
加拿大 (CA)	英文	2,3,4	4
法國 (FR)	法文	2,3,4	4
德國 (DE)	德文	1,2,3,4	4