GetEstimatedBidByKeywordIds 服务操作 - Ad Insight

获取一个或多个关键字（由关键字 (keyword) 标识符指定）的估计出价值，这些关键字可能导致广告在过去 7 天内出现在搜索结果中的目标位置。 此外，该操作还提供点击次数的估计值、平均每次点击成本 (CPC) ，以及关键字可能随估计出价生成的展示次数。

估算基于过去 7 天的性能数据，而不是对未来性能的预测或保证。

注意

此操作适用于使用增强的 CPC 出价策略的搜索市场活动。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
KeywordIds	要获取建议的出价值的关键字标识符数组，这些值可能导致广告出现在搜索结果中的目标位置。 最多可指定 1,000 个关键字。	long 数组
TargetPositionForAds	希望在搜索结果中显示广告的位置。 默认值为 MainLine1。	TargetAdPosition

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
KeywordEstimatedBids	KeywordIdEstimatedBid 数据对象的数组。 数组包含请求中指定的每个关键字 (keyword) 对应的项。 如果关键字 (keyword) ID 无效，则数组中的相应项将为 null。 每个 KeywordIdEstimatedBid 都包含关键字 (keyword) 标识符和 KeywordEstimatedBid。 如果有可用于关键字 (keyword) 的数据，KeywordEstimatedBid 将提供一个建议的出价值，该值可能导致广告出现在搜索结果的目标位置。 否则， KeywordEstimatedBid 元素将设置为 null。	KeywordIdEstimatedBid 数组

响应标头元素

元素	说明	数据类型
跟踪 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">GetEstimatedBidByKeywordIds</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>
    <GetEstimatedBidByKeywordIdsRequest xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </KeywordIds>
      <TargetPositionForAds>ValueHere</TargetPositionForAds>
    </GetEstimatedBidByKeywordIdsRequest>
  </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>
    <GetEstimatedBidByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <KeywordEstimatedBids d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordIdEstimatedBid>
          <KeywordId>ValueHere</KeywordId>
          <KeywordEstimatedBid d4p1:nil="false">
            <Keyword d4p1:nil="false">ValueHere</Keyword>
            <EstimatedBids d4p1:nil="false">
              <EstimatedBidAndTraffic>
                <MinClicksPerWeek d4p1:nil="false">ValueHere</MinClicksPerWeek>
                <MaxClicksPerWeek d4p1:nil="false">ValueHere</MaxClicksPerWeek>
                <AverageCPC d4p1:nil="false">ValueHere</AverageCPC>
                <MinImpressionsPerWeek d4p1:nil="false">ValueHere</MinImpressionsPerWeek>
                <MaxImpressionsPerWeek d4p1:nil="false">ValueHere</MaxImpressionsPerWeek>
                <CTR d4p1:nil="false">ValueHere</CTR>
                <MinTotalCostPerWeek d4p1:nil="false">ValueHere</MinTotalCostPerWeek>
                <MaxTotalCostPerWeek d4p1:nil="false">ValueHere</MaxTotalCostPerWeek>
                <CurrencyCode>ValueHere</CurrencyCode>
                <MatchType>ValueHere</MatchType>
                <EstimatedMinBid>ValueHere</EstimatedMinBid>
              </EstimatedBidAndTraffic>
            </EstimatedBids>
          </KeywordEstimatedBid>
        </KeywordIdEstimatedBid>
      </KeywordEstimatedBids>
    </GetEstimatedBidByKeywordIdsResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<GetEstimatedBidByKeywordIdsResponse> GetEstimatedBidByKeywordIdsAsync(
	IList<long> keywordIds,
	TargetAdPosition targetPositionForAds)
{
	var request = new GetEstimatedBidByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		TargetPositionForAds = targetPositionForAds
	};

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

static GetEstimatedBidByKeywordIdsResponse getEstimatedBidByKeywordIds(
	ArrayOflong keywordIds,
	TargetAdPosition targetPositionForAds) throws RemoteException, Exception
{
	GetEstimatedBidByKeywordIdsRequest request = new GetEstimatedBidByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setTargetPositionForAds(targetPositionForAds);

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

static function GetEstimatedBidByKeywordIds(
	$keywordIds,
	$targetPositionForAds)
{

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

	$request = new GetEstimatedBidByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->TargetPositionForAds = $targetPositionForAds;

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

response=adinsight_service.GetEstimatedBidByKeywordIds(
	KeywordIds=KeywordIds,
	TargetPositionForAds=TargetPositionForAds)

要求

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

请求 URL

生产 URL

https://adinsight.api.bingads.microsoft.com/AdInsight/v13/EstimatedBid/QueryByKeywordIds

沙盒 URL

https://adinsight.api.sandbox.bingads.microsoft.com/AdInsight/v13/EstimatedBid/QueryByKeywordIds

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
KeywordIds	要获取建议的出价值的关键字标识符数组，这些值可能导致广告出现在搜索结果中的目标位置。 最多可指定 1,000 个关键字。	long 数组
TargetPositionForAds	希望在搜索结果中显示广告的位置。 默认值为 MainLine1。	TargetAdPosition

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
KeywordEstimatedBids	KeywordIdEstimatedBid 数据对象的数组。 数组包含请求中指定的每个关键字 (keyword) 对应的项。 如果关键字 (keyword) ID 无效，则数组中的相应项将为 null。 每个 KeywordIdEstimatedBid 都包含关键字 (keyword) 标识符和 KeywordEstimatedBid。 如果有可用于关键字 (keyword) 的数据，KeywordEstimatedBid 将提供一个建议的出价值，该值可能导致广告出现在搜索结果的目标位置。 否则， KeywordEstimatedBid 元素将设置为 null。	KeywordIdEstimatedBid 数组

响应标头元素

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

请求 JSON

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

{
  "KeywordIds": [
    "LongValueHere"
  ],
  "TargetPositionForAds": "ValueHere"
}

响应 JSON

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

{
  "KeywordEstimatedBids": [
    {
      "KeywordEstimatedBid": {
        "EstimatedBids": [
          {
            "AverageCPC": DoubleValueHere,
            "CTR": DoubleValueHere,
            "CurrencyCode": "ValueHere",
            "EstimatedMinBid": DoubleValueHere,
            "MatchType": "ValueHere",
            "MaxClicksPerWeek": DoubleValueHere,
            "MaxImpressionsPerWeek": "LongValueHere",
            "MaxTotalCostPerWeek": DoubleValueHere,
            "MinClicksPerWeek": DoubleValueHere,
            "MinImpressionsPerWeek": "LongValueHere",
            "MinTotalCostPerWeek": DoubleValueHere
          }
        ],
        "Keyword": "ValueHere"
      },
      "KeywordId": "LongValueHere"
    }
  ]
}

代码语法

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

public async Task<GetEstimatedBidByKeywordIdsResponse> GetEstimatedBidByKeywordIdsAsync(
	IList<long> keywordIds,
	TargetAdPosition targetPositionForAds)
{
	var request = new GetEstimatedBidByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		TargetPositionForAds = targetPositionForAds
	};

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

static GetEstimatedBidByKeywordIdsResponse getEstimatedBidByKeywordIds(
	ArrayOflong keywordIds,
	TargetAdPosition targetPositionForAds) throws RemoteException, Exception
{
	GetEstimatedBidByKeywordIdsRequest request = new GetEstimatedBidByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setTargetPositionForAds(targetPositionForAds);

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

static function GetEstimatedBidByKeywordIds(
	$keywordIds,
	$targetPositionForAds)
{

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

	$request = new GetEstimatedBidByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->TargetPositionForAds = $targetPositionForAds;

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

response=adinsight_service.GetEstimatedBidByKeywordIds(
	KeywordIds=KeywordIds,
	TargetPositionForAds=TargetPositionForAds)