GetBidLandscapeByKeywordIds 服务操作 - Ad Insight

给定现有关键字的列表，此操作将为每个返回建议的出价列表以及 1 到 7 天的估计性能统计信息。 此操作不基于目标位置，而是返回多个出价选项，这些选项会产生不同的估计点击次数、展示次数和成本。 可以使用多个出价点的横向视图以及同一关键字 (keyword) 的估计流量，帮助做出有关如何调整关键字 (keyword) 出价以优化点击次数、展示次数和成本的决策。 例如，可以使用生成的数据来可视化点击成本曲线或对展示次数曲线的出价。

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

注意

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

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
IncludeCurrentBid	设置为 false 时，建议的出价值可能不包括关键字 (keyword) 的当前出价。 默认值为 false。 设置为 true 时，建议的出价值之一将等于关键字 (keyword) 的当前出价。	boolean
KeywordIds	要获取具有估计性能统计信息的建议出价值列表的关键字标识符数组。 最多可指定 1,000 个关键字。	long 数组

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
BidLandscape	KeywordBidLandscape 对象的数组。 数组包含与请求中指定的每个关键字 (keyword) 对应的 KeywordBidLandscape。 在同一调用中允许重复关键字 (keyword) 标识符，并将返回相同的结果。 如果指定的关键字 (keyword) 标识符无效或没有关联的数据结果，则 KeywordBidLandscape 中的所有元素都将为零，但 KeywordId 除外，该关键字 Id 反映了请求中指定的关键字 (keyword) 标识符。 如果有可用于关键字 (keyword) 的数据，KeywordBidLandscape 对象将提供建议的出价和估计性能统计信息的列表。	KeywordBidLandscape 数组

响应标头元素

元素	说明	数据类型
跟踪 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">GetBidLandscapeByKeywordIds</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>
    <GetBidLandscapeByKeywordIdsRequest 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>
      <IncludeCurrentBid i:nil="false">ValueHere</IncludeCurrentBid>
    </GetBidLandscapeByKeywordIdsRequest>
  </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>
    <GetBidLandscapeByKeywordIdsResponse xmlns="https://bingads.microsoft.com/AdInsight/v13">
      <BidLandscape d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <KeywordBidLandscape>
          <KeywordId>ValueHere</KeywordId>
          <StartDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </StartDate>
          <EndDate d4p1:nil="false">
            <Day>ValueHere</Day>
            <Month>ValueHere</Month>
            <Year>ValueHere</Year>
          </EndDate>
          <BidLandscapePoints d4p1:nil="false">
            <BidLandscapePoint>
              <Bid>ValueHere</Bid>
              <Clicks d4p1:nil="false">ValueHere</Clicks>
              <Impressions>ValueHere</Impressions>
              <TopImpressions d4p1:nil="false">ValueHere</TopImpressions>
              <CurrencyCode>ValueHere</CurrencyCode>
              <Cost d4p1:nil="false">ValueHere</Cost>
              <MarginalCPC d4p1:nil="false">ValueHere</MarginalCPC>
            </BidLandscapePoint>
          </BidLandscapePoints>
        </KeywordBidLandscape>
      </BidLandscape>
    </GetBidLandscapeByKeywordIdsResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
	IList<long> keywordIds,
	bool? includeCurrentBid)
{
	var request = new GetBidLandscapeByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		IncludeCurrentBid = includeCurrentBid
	};

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

static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
	ArrayOflong keywordIds,
	boolean includeCurrentBid) throws RemoteException, Exception
{
	GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setIncludeCurrentBid(includeCurrentBid);

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

static function GetBidLandscapeByKeywordIds(
	$keywordIds,
	$includeCurrentBid)
{

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

	$request = new GetBidLandscapeByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->IncludeCurrentBid = $includeCurrentBid;

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

response=adinsight_service.GetBidLandscapeByKeywordIds(
	KeywordIds=KeywordIds,
	IncludeCurrentBid=IncludeCurrentBid)

要求

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

请求 URL

生产 URL

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

沙盒 URL

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

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
IncludeCurrentBid	设置为 false 时，建议的出价值可能不包括关键字 (keyword) 的当前出价。 默认值为 false。 设置为 true 时，建议的出价值之一将等于关键字 (keyword) 的当前出价。	boolean
KeywordIds	要获取具有估计性能统计信息的建议出价值列表的关键字标识符数组。 最多可指定 1,000 个关键字。	long 数组

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
BidLandscape	KeywordBidLandscape 对象的数组。 数组包含与请求中指定的每个关键字 (keyword) 对应的 KeywordBidLandscape。 在同一调用中允许重复关键字 (keyword) 标识符，并将返回相同的结果。 如果指定的关键字 (keyword) 标识符无效或没有关联的数据结果，则 KeywordBidLandscape 中的所有元素都将为零，但 KeywordId 除外，该关键字 Id 反映了请求中指定的关键字 (keyword) 标识符。 如果有可用于关键字 (keyword) 的数据，KeywordBidLandscape 对象将提供建议的出价和估计性能统计信息的列表。	KeywordBidLandscape 数组

响应标头元素

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

请求 JSON

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

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

响应 JSON

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

{
  "BidLandscape": [
    {
      "BidLandscapePoints": [
        {
          "Bid": DoubleValueHere,
          "Clicks": DoubleValueHere,
          "Cost": DoubleValueHere,
          "CurrencyCode": "ValueHere",
          "Impressions": "LongValueHere",
          "MarginalCPC": DoubleValueHere,
          "TopImpressions": "LongValueHere"
        }
      ],
      "EndDate": {
        "Day": IntValueHere,
        "Month": IntValueHere,
        "Year": IntValueHere
      },
      "KeywordId": "LongValueHere",
      "StartDate": {
        "Day": IntValueHere,
        "Month": IntValueHere,
        "Year": IntValueHere
      }
    }
  ]
}

代码语法

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

public async Task<GetBidLandscapeByKeywordIdsResponse> GetBidLandscapeByKeywordIdsAsync(
	IList<long> keywordIds,
	bool? includeCurrentBid)
{
	var request = new GetBidLandscapeByKeywordIdsRequest
	{
		KeywordIds = keywordIds,
		IncludeCurrentBid = includeCurrentBid
	};

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

static GetBidLandscapeByKeywordIdsResponse getBidLandscapeByKeywordIds(
	ArrayOflong keywordIds,
	boolean includeCurrentBid) throws RemoteException, Exception
{
	GetBidLandscapeByKeywordIdsRequest request = new GetBidLandscapeByKeywordIdsRequest();

	request.setKeywordIds(keywordIds);
	request.setIncludeCurrentBid(includeCurrentBid);

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

static function GetBidLandscapeByKeywordIds(
	$keywordIds,
	$includeCurrentBid)
{

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

	$request = new GetBidLandscapeByKeywordIdsRequest();

	$request->KeywordIds = $keywordIds;
	$request->IncludeCurrentBid = $includeCurrentBid;

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

response=adinsight_service.GetBidLandscapeByKeywordIds(
	KeywordIds=KeywordIds,
	IncludeCurrentBid=IncludeCurrentBid)