GetRecommendations 服务操作 - Ad Insight

项目
11/14/2024

发现建议。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
AdGroupId	要确定其响应式搜索广告机会的广告组的标识符。如果此元素为 nil 或空，则操作将返回指定市场活动的特定建议类型的所有机会。	long
CampaignId	拥有 AdGroupId 元素中指定的广告组的活动的标识符。如果此元素为 nil 或空，则 AdGroupId 也必须为 nil 或空，并且该操作将返回帐户的特定建议类型的所有机会。	long
RecommendationType	要获取的建议类型的标识符。此元素不能为零或空。每个请求一个建议类型，例如 ResponsiveSearchAdsOpportunity。	string

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
建议	建议对象的数组。最多可以返回 2,000 个列表项。	建议数组

响应标头元素

元素	说明	数据类型
跟踪 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">GetRecommendations</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>
    <GetRecommendationsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CampaignId i:nil="false">ValueHere</CampaignId>
      <AdGroupId i:nil="false">ValueHere</AdGroupId>
      <RecommendationType i:nil="false">ValueHere</RecommendationType>
    </GetRecommendationsRequest>
  </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>
    <GetRecommendationsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <Recommendations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <Recommendation d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AccountId>ValueHere</AccountId>
          <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
          <CampaignId d4p1:nil="false">ValueHere</CampaignId>
          <CurrentClicks>ValueHere</CurrentClicks>
          <CurrentConversions>ValueHere</CurrentConversions>
          <CurrentCost>ValueHere</CurrentCost>
          <CurrentImpressions>ValueHere</CurrentImpressions>
          <EstimatedIncreaseInClicks>ValueHere</EstimatedIncreaseInClicks>
          <EstimatedIncreaseInConversions>ValueHere</EstimatedIncreaseInConversions>
          <EstimatedIncreaseInCost>ValueHere</EstimatedIncreaseInCost>
          <EstimatedIncreaseInImpressions>ValueHere</EstimatedIncreaseInImpressions>
          <RecommendationHash d4p1:nil="false">ValueHere</RecommendationHash>
          <RecommendationId d4p1:nil="false">ValueHere</RecommendationId>
          <RecommendationType d4p1:nil="false">ValueHere</RecommendationType>
          <!--This field is applicable if the derived type attribute is set to ResponsiveSearchAdsRecommendation-->
          <SuggestedAd d4p1:nil="false">
            <Descriptions d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <a1:string>ValueHere</a1:string>
            </Descriptions>
            <FinalUrl d4p1:nil="false">ValueHere</FinalUrl>
            <Headlines d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <a1:string>ValueHere</a1:string>
            </Headlines>
            <Path1 d4p1:nil="false">ValueHere</Path1>
            <Path2 d4p1:nil="false">ValueHere</Path2>
          </SuggestedAd>
        </Recommendation>
      </Recommendations>
    </GetRecommendationsResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于必应广告 SDK。有关更多示例，请参阅必应广告 API 代码示例。

public async Task<GetRecommendationsResponse> GetRecommendationsAsync(
	long? campaignId,
	long? adGroupId,
	string recommendationType)
{
	var request = new GetRecommendationsRequest
	{
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		RecommendationType = recommendationType
	};

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

static GetRecommendationsResponse getRecommendations(
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String recommendationType) throws RemoteException, Exception
{
	GetRecommendationsRequest request = new GetRecommendationsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setRecommendationType(recommendationType);

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

static function GetRecommendations(
	$campaignId,
	$adGroupId,
	$recommendationType)
{

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

	$request = new GetRecommendationsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->RecommendationType = $recommendationType;

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

response=adinsight_service.GetRecommendations(
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	RecommendationType=RecommendationType)

要求

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

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

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

请求元素

GetRecommendationsRequest 对象定义服务操作请求的正文和标头元素。

注意

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

请求正文元素

元素	说明	数据类型
AdGroupId	要确定其响应式搜索广告机会的广告组的标识符。如果此元素为 nil 或空，则操作将返回指定市场活动的特定建议类型的所有机会。	long
CampaignId	拥有 AdGroupId 元素中指定的广告组的活动的标识符。如果此元素为 nil 或空，则 AdGroupId 也必须为 nil 或空，并且该操作将返回帐户的特定建议类型的所有机会。	long
RecommendationType	要获取的建议类型的标识符。此元素不能为零或空。每个请求一个建议类型，例如 ResponsiveSearchAdsOpportunity。	string

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
建议	建议对象的数组。最多可以返回 2,000 个列表项。	建议数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 API 调用详细信息的日志条目的标识符。	string

请求 JSON

此模板由显示 JSON 请求的正文和标头元素的工具生成。有关可用于此服务操作的支持类型，请参阅上面的请求正文元素参考。

{
  "CampaignId": "LongValueHere",
  "AdGroupId": "LongValueHere",
  "RecommendationType": "ValueHere"
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的正文和标头元素。

下面是建议类型为 ResponsiveSearchAdsRecommendation 时适用的示例。

{
  "Recommendations": [
    {
      "AccountId": "LongValueHere",
      "AdGroupId": "LongValueHere",
      "CampaignId": "LongValueHere",
      "CurrentClicks": "LongValueHere",
      "CurrentConversions": "LongValueHere",
      "CurrentCost": DoubleValueHere,
      "CurrentImpressions": "LongValueHere",
      "EstimatedIncreaseInClicks": "LongValueHere",
      "EstimatedIncreaseInConversions": "LongValueHere",
      "EstimatedIncreaseInCost": DoubleValueHere,
      "EstimatedIncreaseInImpressions": "LongValueHere",
      "RecommendationHash": "ValueHere",
      "RecommendationId": "ValueHere",
      "RecommendationType": "ValueHere",
      "Type": "ResponsiveSearchAdsRecommendation",
      "SuggestedAd": {
        "Descriptions": [
          "ValueHere"
        ],
        "FinalUrl": "ValueHere",
        "Headlines": [
          "ValueHere"
        ],
        "Path1": "ValueHere",
        "Path2": "ValueHere"
      }
    }
  ]
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于必应广告 SDK。有关更多示例，请参阅必应广告 API 代码示例。

public async Task<GetRecommendationsResponse> GetRecommendationsAsync(
	long? campaignId,
	long? adGroupId,
	string recommendationType)
{
	var request = new GetRecommendationsRequest
	{
		CampaignId = campaignId,
		AdGroupId = adGroupId,
		RecommendationType = recommendationType
	};

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

static GetRecommendationsResponse getRecommendations(
	java.lang.Long campaignId,
	java.lang.Long adGroupId,
	java.lang.String recommendationType) throws RemoteException, Exception
{
	GetRecommendationsRequest request = new GetRecommendationsRequest();

	request.setCampaignId(campaignId);
	request.setAdGroupId(adGroupId);
	request.setRecommendationType(recommendationType);

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

static function GetRecommendations(
	$campaignId,
	$adGroupId,
	$recommendationType)
{

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

	$request = new GetRecommendationsRequest();

	$request->CampaignId = $campaignId;
	$request->AdGroupId = $adGroupId;
	$request->RecommendationType = $recommendationType;

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

response=adinsight_service.GetRecommendations(
	CampaignId=CampaignId,
	AdGroupId=AdGroupId,
	RecommendationType=RecommendationType)

通过

GetRecommendations 服务操作 - Ad Insight

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 SOAP

响应 SOAP

代码语法

要求

请求 URL

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 JSON

响应 JSON

代码语法

反馈

其他资源