通过

GetKeywordTrafficEstimates 服务操作 - Ad Insight

  • 项目

提供关键字的流量估算，例如平均 CPC、平均排名、点击次数、点击率、展示次数和总成本。 作为输入，提供出价、语言、位置和网络，以及可选的市场活动预算和负面关键字 (keyword) 筛选器。

提示

有关概述，请参阅 关键字创意和流量估算 技术指南。

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
CampaignEstimators 为请求的关键字 (keyword) 流量估算定义市场活动、广告组和关键字 (keyword) 级别条件和筛选器。 CampaignEstimator 数组

请求标头元素

元素 说明 数据类型
AuthenticationToken OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

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

响应正文元素

元素 说明 数据类型
CampaignEstimates 市场活动估算列表。 在每个市场活动估算中，每个广告组关键字 (keyword) 流量估算的嵌套列表。

可以检查 BatchError Details 元素，找出哪些请求的列表项失败。 例如，如果 Details 包含“CampaignEstimators[0]， AdGroupEstimators[1]，KeywordEstimators 为 null 或不包含任何值”，则提交列表中的第 2 个 AdGroupEstimator 发生错误。 BatchError 的 Index 元素只是返回的批处理错误的有序计数，不能用于确定错误在请求中的位置发生。		 CampaignEstimate 数组

响应标头元素

元素 说明 数据类型
跟踪 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">GetKeywordTrafficEstimates</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>
    <GetKeywordTrafficEstimatesRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CampaignEstimators i:nil="false">
        <CampaignEstimator>
          <AdGroupEstimators i:nil="false">
            <AdGroupEstimator>
              <AdGroupId i:nil="false">ValueHere</AdGroupId>
              <KeywordEstimators i:nil="false">
                <KeywordEstimator>
                  <Keyword i:nil="false">
                    <Id i:nil="false">ValueHere</Id>
                    <MatchType>ValueHere</MatchType>
                    <Text i:nil="false">ValueHere</Text>
                  </Keyword>
                  <MaxCpc i:nil="false">ValueHere</MaxCpc>
                </KeywordEstimator>
              </KeywordEstimators>
              <MaxCpc>ValueHere</MaxCpc>
            </AdGroupEstimator>
          </AdGroupEstimators>
          <CampaignId i:nil="false">ValueHere</CampaignId>
          <Criteria i:nil="false">
            <Criterion i:type="-- derived type specified here with the appropriate prefix --">
              <!--This field is applicable if the derived type attribute is set to LocationCriterion-->
              <LocationId>ValueHere</LocationId>
              <!--This field is applicable if the derived type attribute is set to LanguageCriterion-->
              <Language i:nil="false">ValueHere</Language>
              <!--This field is applicable if the derived type attribute is set to NetworkCriterion-->
              <Network>ValueHere</Network>
              <!--This field is applicable if the derived type attribute is set to DeviceCriterion-->
              <DeviceName i:nil="false">ValueHere</DeviceName>
            </Criterion>
          </Criteria>
          <DailyBudget i:nil="false">ValueHere</DailyBudget>
          <NegativeKeywords i:nil="false">
            <NegativeKeyword>
              <Id i:nil="false">ValueHere</Id>
              <MatchType>ValueHere</MatchType>
              <Text i:nil="false">ValueHere</Text>
            </NegativeKeyword>
          </NegativeKeywords>
        </CampaignEstimator>
      </CampaignEstimators>
    </GetKeywordTrafficEstimatesRequest>
  </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>
    <GetKeywordTrafficEstimatesResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <CampaignEstimates d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <CampaignEstimate>
          <AdGroupEstimates d4p1:nil="false">
            <AdGroupEstimate>
              <AdGroupId d4p1:nil="false">ValueHere</AdGroupId>
              <KeywordEstimates d4p1:nil="false">
                <KeywordEstimate>
                  <Keyword d4p1:nil="false">
                    <Id d4p1:nil="false">ValueHere</Id>
                    <MatchType>ValueHere</MatchType>
                    <Text d4p1:nil="false">ValueHere</Text>
                  </Keyword>
                  <Maximum d4p1:nil="false">
                    <AverageCpc>ValueHere</AverageCpc>
                    <AveragePosition>ValueHere</AveragePosition>
                    <Clicks>ValueHere</Clicks>
                    <Ctr>ValueHere</Ctr>
                    <Impressions>ValueHere</Impressions>
                    <TotalCost>ValueHere</TotalCost>
                  </Maximum>
                  <Minimum d4p1:nil="false">
                    <AverageCpc>ValueHere</AverageCpc>
                    <AveragePosition>ValueHere</AveragePosition>
                    <Clicks>ValueHere</Clicks>
                    <Ctr>ValueHere</Ctr>
                    <Impressions>ValueHere</Impressions>
                    <TotalCost>ValueHere</TotalCost>
                  </Minimum>
                </KeywordEstimate>
              </KeywordEstimates>
            </AdGroupEstimate>
          </AdGroupEstimates>
          <CampaignId d4p1:nil="false">ValueHere</CampaignId>
        </CampaignEstimate>
      </CampaignEstimates>
    </GetKeywordTrafficEstimatesResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<GetKeywordTrafficEstimatesResponse> GetKeywordTrafficEstimatesAsync(
	IList<CampaignEstimator> campaignEstimators)
{
	var request = new GetKeywordTrafficEstimatesRequest
	{
		CampaignEstimators = campaignEstimators
	};

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

static GetKeywordTrafficEstimatesResponse getKeywordTrafficEstimates(
	ArrayOfCampaignEstimator campaignEstimators) throws RemoteException, Exception
{
	GetKeywordTrafficEstimatesRequest request = new GetKeywordTrafficEstimatesRequest();

	request.setCampaignEstimators(campaignEstimators);

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

static function GetKeywordTrafficEstimates(
	$campaignEstimators)
{

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

	$request = new GetKeywordTrafficEstimatesRequest();

	$request->CampaignEstimators = $campaignEstimators;

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

response=adinsight_service.GetKeywordTrafficEstimates(
	CampaignEstimators=CampaignEstimators)

要求

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

请求 URL

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

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
CampaignEstimators 为请求的关键字 (keyword) 流量估算定义市场活动、广告组和关键字 (keyword) 级别条件和筛选器。 CampaignEstimator 数组

请求标头元素

元素 说明 数据类型
Authorization OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
CustomerAccountId 拥有或与请求中的实体关联的广告帐户的标识符。 如果需要这两个元素，此标头元素必须与 AccountId 正文元素具有相同的值。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
CustomerId 用户正在访问或操作的客户) 经理帐户 (标识符。 用户可以访问多个经理帐户。 此元素是大多数服务操作所必需的，作为最佳做法，应始终设置它。

有关详细信息，请参阅 获取帐户和客户 ID。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

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

响应正文元素

元素 说明 数据类型
CampaignEstimates 市场活动估算列表。 在每个市场活动估算中，每个广告组关键字 (keyword) 流量估算的嵌套列表。

可以检查 BatchError Details 元素，找出哪些请求的列表项失败。 例如，如果 Details 包含“CampaignEstimators[0]， AdGroupEstimators[1]，KeywordEstimators 为 null 或不包含任何值”，则提交列表中的第 2 个 AdGroupEstimator 发生错误。 BatchError 的 Index 元素只是返回的批处理错误的有序计数，不能用于确定错误在请求中的位置发生。		 CampaignEstimate 数组

响应标头元素

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

请求 JSON

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

{
  "CampaignEstimators": [
    {
      "AdGroupEstimators": [
        {
          "AdGroupId": "LongValueHere",
          "KeywordEstimators": [
            {
              "Keyword": {
                "Id": "LongValueHere",
                "MatchType": "ValueHere",
                "Text": "ValueHere"
              },
              "MaxCpc": DoubleValueHere
            }
          ],
          "MaxCpc": DoubleValueHere
        }
      ],
      "CampaignId": "LongValueHere",
      "Criteria": [
        "ValueHere"
      ],
      "DailyBudget": DoubleValueHere,
      "NegativeKeywords": [
        {
          "Id": "LongValueHere",
          "MatchType": "ValueHere",
          "Text": "ValueHere"
        }
      ]
    }
  ]
}

响应 JSON

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

{
  "CampaignEstimates": [
    {
      "AdGroupEstimates": [
        {
          "AdGroupId": "LongValueHere",
          "KeywordEstimates": [
            {
              "Keyword": {
                "Id": "LongValueHere",
                "MatchType": "ValueHere",
                "Text": "ValueHere"
              },
              "Maximum": {
                "AverageCpc": DoubleValueHere,
                "AveragePosition": DoubleValueHere,
                "Clicks": DoubleValueHere,
                "Ctr": DoubleValueHere,
                "Impressions": DoubleValueHere,
                "TotalCost": DoubleValueHere
              },
              "Minimum": {
                "AverageCpc": DoubleValueHere,
                "AveragePosition": DoubleValueHere,
                "Clicks": DoubleValueHere,
                "Ctr": DoubleValueHere,
                "Impressions": DoubleValueHere,
                "TotalCost": DoubleValueHere
              }
            }
          ]
        }
      ],
      "CampaignId": "LongValueHere"
    }
  ]
}

代码语法

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

public async Task<GetKeywordTrafficEstimatesResponse> GetKeywordTrafficEstimatesAsync(
	IList<CampaignEstimator> campaignEstimators)
{
	var request = new GetKeywordTrafficEstimatesRequest
	{
		CampaignEstimators = campaignEstimators
	};

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

static GetKeywordTrafficEstimatesResponse getKeywordTrafficEstimates(
	ArrayOfCampaignEstimator campaignEstimators) throws RemoteException, Exception
{
	GetKeywordTrafficEstimatesRequest request = new GetKeywordTrafficEstimatesRequest();

	request.setCampaignEstimators(campaignEstimators);

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

static function GetKeywordTrafficEstimates(
	$campaignEstimators)
{

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

	$request = new GetKeywordTrafficEstimatesRequest();

	$request->CampaignEstimators = $campaignEstimators;

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

response=adinsight_service.GetKeywordTrafficEstimates(
	CampaignEstimators=CampaignEstimators)