SuggestKeywordsFromExistingKeywords 服务操作 - Ad Insight

建议性能可能优于指定关键字的关键字。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
AdGroupId	建议关键字的广告组标识符。 此元素尚不受支持，可用于影响未来版本中关键字 (keyword) 建议	long
CampaignId	建议关键字的市场活动标识符。 此元素尚不受支持，可用于影响未来版本中关键字 (keyword) 建议	long
ExcludeBrand	一个 值，该值确定结果是否排除品牌关键字。 若要在结果中排除品牌关键字，请将 设置为 true。 默认值为 false。	boolean
关键字	要获取性能更好的建议关键字的关键字数组。 数组最多可以包含 1,000 个关键字，每个关键字 (keyword) 最多可以包含 100 个字符。	字符串 数组
语言	编写关键字 (keyword) 时使用的语言。 可能区分大小写的值为 英语、 法语和 德语。 有关每种语言支持的提供程序的列表，请参阅下面的 “备注 ”部分。 默认值为英语。	string
MaxSuggestionsPerKeyword	根据指定的关键字 (keyword) 返回的最大关键字 (keyword) 建议数。 如果 SuggestionType 设置为 4，则每个关键字 (keyword) 最多可以请求 200 个建议;否则，可以请求的最大建议数为 100。 默认值为 50。	int
PublisherCountries	要用作确定建议关键字的数据来源的国家/地区的国家/地区代码。 可以指定一个或多个国家/地区代码。 指定的每个国家/地区都必须支持在 Language 元素中指定的 语言 。 有关支持的值，请参阅下面的 “备注 ”部分。 默认值为支持指定语言的所有国家/地区。	字符串 数组
RemoveDuplicates	一个布尔值，该值确定是否从建议的关键字列表中删除重复关键字。 若要删除重复项，请将 设置为 true。 默认值为 false。	boolean
SuggestionType	用于生成关键字 (keyword) 建议的提供程序。 有关可能的提供程序列表、每个提供程序的语言和国家/地区限制以及按国家/地区列出的默认提供程序，请参阅下面的 “备注 ”部分。	int

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

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

响应正文元素

元素	说明	数据类型
KeywordSuggestions	KeywordSuggestion 数据对象的数组。 数组包含请求中指定的每个关键字 (keyword) 的项。 对象包含可能比指定关键字 (keyword) 更好的建议关键字列表。 对于每个建议的关键字 (keyword) ，对象都包含一个分数，该分数指示使用关键字 (keyword) 会导致在搜索查询结果中包含广告的概率。 如果没有有关关键字 (keyword) 的建议，则 SuggestionsAndConfidence 元素将为 null。	KeywordSuggestion 数组

响应标头元素

元素	说明	数据类型
跟踪 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">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>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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	返回包含关键字 (keyword) 的搜索查询。
2	返回包含指定关键字 (keyword) 的其他广告组中的关键字。
3	返回与指定关键字 (keyword) 相关的搜索查询。
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	建议关键字的广告组标识符。 此元素尚不受支持，可用于影响未来版本中关键字 (keyword) 建议	long
CampaignId	建议关键字的市场活动标识符。 此元素尚不受支持，可用于影响未来版本中关键字 (keyword) 建议	long
ExcludeBrand	一个 值，该值确定结果是否排除品牌关键字。 若要在结果中排除品牌关键字，请将 设置为 true。 默认值为 false。	boolean
关键字	要获取性能更好的建议关键字的关键字数组。 数组最多可以包含 1,000 个关键字，每个关键字 (keyword) 最多可以包含 100 个字符。	字符串 数组
语言	编写关键字 (keyword) 时使用的语言。 可能区分大小写的值为 英语、 法语和 德语。 有关每种语言支持的提供程序的列表，请参阅下面的 “备注 ”部分。 默认值为英语。	string
MaxSuggestionsPerKeyword	根据指定的关键字 (keyword) 返回的最大关键字 (keyword) 建议数。 如果 SuggestionType 设置为 4，则每个关键字 (keyword) 最多可以请求 200 个建议;否则，可以请求的最大建议数为 100。 默认值为 50。	int
PublisherCountries	要用作确定建议关键字的数据来源的国家/地区的国家/地区代码。 可以指定一个或多个国家/地区代码。 指定的每个国家/地区都必须支持在 Language 元素中指定的 语言 。 有关支持的值，请参阅下面的 “备注 ”部分。 默认值为支持指定语言的所有国家/地区。	字符串 数组
RemoveDuplicates	一个布尔值，该值确定是否从建议的关键字列表中删除重复关键字。 若要删除重复项，请将 设置为 true。 默认值为 false。	boolean
SuggestionType	用于生成关键字 (keyword) 建议的提供程序。 有关可能的提供程序列表、每个提供程序的语言和国家/地区限制以及按国家/地区列出的默认提供程序，请参阅下面的 “备注 ”部分。	int

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
CustomerAccountId	拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
CustomerId	用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。 有关详细信息，请参阅 获取帐户和客户 ID。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

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

响应正文元素

元素	说明	数据类型
KeywordSuggestions	KeywordSuggestion 数据对象的数组。 数组包含请求中指定的每个关键字 (keyword) 的项。 对象包含可能比指定关键字 (keyword) 更好的建议关键字列表。 对于每个建议的关键字 (keyword) ，对象都包含一个分数，该分数指示使用关键字 (keyword) 会导致在搜索查询结果中包含广告的概率。 如果没有有关关键字 (keyword) 的建议，则 SuggestionsAndConfidence 元素将为 null。	KeywordSuggestion 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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	返回包含关键字 (keyword) 的搜索查询。
2	返回包含指定关键字 (keyword) 的其他广告组中的关键字。
3	返回与指定关键字 (keyword) 相关的搜索查询。
4	返回其他提供程序的最佳建议。

以下是每个国家/地区支持的提供程序。

国家/地区	语言	支持的提供程序类型	默认提供程序类型
澳大利亚 (AU)	英语	2,3,4	4
加拿大 (CA)	英语	2,3,4	4
法国 (FR)	法语	2,3,4	4
德国 (DE)	德语	1,2,3,4	4