AddKeywords 服务操作 - 市场活动管理

项目
11/14/2024

向广告组添加一个或多个关键字。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
AdGroupId	要向其添加关键字的广告组的标识符。	long
关键字	要添加到广告组的关键字列表。每个服务请求最多可以向广告组添加 1,000 个关键字。	关键字数组
ReturnInheritedBidStrategyTypes	确定服务是否应返回从父市场活动或广告组继承的出价策略类型。默认值为 false，仅当将此元素设置为 true 时，才会返回 InheritedBidStrategyTypes 元素。	boolean

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
InheritedBidStrategyTypes	每个字符串的值表示从父市场活动或广告组继承的竞价方案或出价策略类型。列表中的每个字符串都以相同的顺序返回，并且对应于请求消息中的关键字。如果关键字 (keyword) 未从广告组或市场活动继承，则列表中的相应项将为 nil。默认情况下不返回此元素。必须在请求中设置 ReturnInheritedBidStrategyTypes true。	字符串数组
KeywordIds	与添加的关键字对应的唯一系统标识符列表。标识符列表直接对应于请求中的关键字列表。列表的项可能返回为 null。对于未添加关键字 (keyword) 的每个列表索引，相应的元素将为 null。	long 数组
PartialErrors	BatchError 对象的数组，其中包含未成功的任何请求项的详细信息。错误列表与请求中的项列表不直接对应。如果没有错误，列表可以为空，也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。	BatchError 数组

响应标头元素

元素	说明	数据类型
跟踪 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/CampaignManagement/v13">
    <Action mustUnderstand="1">AddKeywords</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>
    <AddKeywordsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AdGroupId>ValueHere</AdGroupId>
      <Keywords i:nil="false">
        <Keyword>
          <Bid i:nil="false">
            <Amount i:nil="false">ValueHere</Amount>
          </Bid>
          <BiddingScheme i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
            <Type i:nil="false">ValueHere</Type>
            <!--This field is applicable if the derived type attribute is set to ManualCpcBiddingScheme-->
            <ManualCpc i:nil="false">ValueHere</ManualCpc>
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpvBiddingScheme-->
            <!--No additional fields are applicable if the derived type attribute is set to ManualCpmBiddingScheme-->
            <!--This field is applicable if the derived type attribute is set to InheritFromParentBiddingScheme-->
            <InheritedBidStrategyType i:nil="false">ValueHere</InheritedBidStrategyType>
            <!--This field is applicable if the derived type attribute is set to PercentCpcBiddingScheme-->
            <MaxPercentCpc i:nil="false">ValueHere</MaxPercentCpc>
            <!--This field is applicable if the derived type attribute is set to CommissionBiddingScheme-->
            <CommissionRate i:nil="false">ValueHere</CommissionRate>
            <!--This field is applicable if the derived type attribute is set to ManualCpaBiddingScheme-->
            <ManualCpi i:nil="false">ValueHere</ManualCpi>
            <!--This field is applicable if the derived type attribute is set to CostPerSaleBiddingScheme-->
            <TargetCostPerSale i:nil="false">ValueHere</TargetCostPerSale>
          </BiddingScheme>
          <DestinationUrl i:nil="false">ValueHere</DestinationUrl>
          <EditorialStatus i:nil="false">ValueHere</EditorialStatus>
          <FinalAppUrls i:nil="false">
            <AppUrl>
              <OsType i:nil="false">ValueHere</OsType>
              <Url i:nil="false">ValueHere</Url>
            </AppUrl>
          </FinalAppUrls>
          <FinalMobileUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </FinalMobileUrls>
          <FinalUrlSuffix i:nil="false">ValueHere</FinalUrlSuffix>
          <FinalUrls i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:string>ValueHere</a1:string>
          </FinalUrls>
          <ForwardCompatibilityMap xmlns:e249="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e249:KeyValuePairOfstringstring>
              <e249:key i:nil="false">ValueHere</e249:key>
              <e249:value i:nil="false">ValueHere</e249:value>
            </e249:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id i:nil="false">ValueHere</Id>
          <MatchType i:nil="false">ValueHere</MatchType>
          <Param1 i:nil="false">ValueHere</Param1>
          <Param2 i:nil="false">ValueHere</Param2>
          <Param3 i:nil="false">ValueHere</Param3>
          <Status i:nil="false">ValueHere</Status>
          <Text i:nil="false">ValueHere</Text>
          <TrackingUrlTemplate i:nil="false">ValueHere</TrackingUrlTemplate>
          <UrlCustomParameters i:nil="false">
            <Parameters i:nil="false">
              <CustomParameter>
                <Key i:nil="false">ValueHere</Key>
                <Value i:nil="false">ValueHere</Value>
              </CustomParameter>
            </Parameters>
          </UrlCustomParameters>
        </Keyword>
      </Keywords>
      <ReturnInheritedBidStrategyTypes i:nil="false">ValueHere</ReturnInheritedBidStrategyTypes>
    </AddKeywordsRequest>
  </s:Body>
</s:Envelope>

响应 SOAP

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <AddKeywordsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <InheritedBidStrategyTypes d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:string>ValueHere</a1:string>
      </InheritedBidStrategyTypes>
      <KeywordIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </KeywordIds>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e250="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e250:KeyValuePairOfstringstring>
              <e250:key d4p1:nil="false">ValueHere</e250:key>
              <e250:value d4p1:nil="false">ValueHere</e250:value>
            </e250:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </AddKeywordsResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<AddKeywordsResponse> AddKeywordsAsync(
	long adGroupId,
	IList<Keyword> keywords,
	bool? returnInheritedBidStrategyTypes)
{
	var request = new AddKeywordsRequest
	{
		AdGroupId = adGroupId,
		Keywords = keywords,
		ReturnInheritedBidStrategyTypes = returnInheritedBidStrategyTypes
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddKeywordsAsync(r), request));
}

static AddKeywordsResponse addKeywords(
	java.lang.Long adGroupId,
	ArrayOfKeyword keywords,
	boolean returnInheritedBidStrategyTypes) throws RemoteException, Exception
{
	AddKeywordsRequest request = new AddKeywordsRequest();

	request.setAdGroupId(adGroupId);
	request.setKeywords(keywords);
	request.setReturnInheritedBidStrategyTypes(returnInheritedBidStrategyTypes);

	return CampaignManagementService.getService().addKeywords(request);
}

static function AddKeywords(
	$adGroupId,
	$keywords,
	$returnInheritedBidStrategyTypes)
{

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

	$request = new AddKeywordsRequest();

	$request->AdGroupId = $adGroupId;
	$request->Keywords = $keywords;
	$request->ReturnInheritedBidStrategyTypes = $returnInheritedBidStrategyTypes;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddKeywords($request);
}

response=campaignmanagement_service.AddKeywords(
	AdGroupId=AdGroupId,
	Keywords=Keywords,
	ReturnInheritedBidStrategyTypes=ReturnInheritedBidStrategyTypes)

要求

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

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/Keywords

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/Keywords

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
AdGroupId	要向其添加关键字的广告组的标识符。	long
关键字	要添加到广告组的关键字列表。每个服务请求最多可以向广告组添加 1,000 个关键字。	关键字数组
ReturnInheritedBidStrategyTypes	确定服务是否应返回从父市场活动或广告组继承的出价策略类型。默认值为 false，仅当将此元素设置为 true 时，才会返回 InheritedBidStrategyTypes 元素。	boolean

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
InheritedBidStrategyTypes	每个字符串的值表示从父市场活动或广告组继承的竞价方案或出价策略类型。列表中的每个字符串都以相同的顺序返回，并且对应于请求消息中的关键字。如果关键字 (keyword) 未从广告组或市场活动继承，则列表中的相应项将为 nil。默认情况下不返回此元素。必须在请求中设置 ReturnInheritedBidStrategyTypes true。	字符串数组
KeywordIds	与添加的关键字对应的唯一系统标识符列表。标识符列表直接对应于请求中的关键字列表。列表的项可能返回为 null。对于未添加关键字 (keyword) 的每个列表索引，相应的元素将为 null。	long 数组
PartialErrors	BatchError 对象的数组，其中包含未成功的任何请求项的详细信息。错误列表与请求中的项列表不直接对应。如果没有错误，列表可以为空，也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。	BatchError 数组

响应标头元素

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

请求 JSON

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

下面是一个示例，如果 BiddingScheme 的类型为 CommissionBiddingScheme，则适用。

{
  "AdGroupId": "LongValueHere",
  "Keywords": [
    {
      "Bid": {
        "Amount": DoubleValueHere
      },
      "BiddingScheme": {
        "Type": "CommissionBiddingScheme",
        "CommissionRate": DoubleValueHere
      },
      "DestinationUrl": "ValueHere",
      "EditorialStatus": "ValueHere",
      "FinalAppUrls": [
        {
          "OsType": "ValueHere",
          "Url": "ValueHere"
        }
      ],
      "FinalMobileUrls": [
        "ValueHere"
      ],
      "FinalUrls": [
        "ValueHere"
      ],
      "FinalUrlSuffix": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "MatchType": "ValueHere",
      "Param1": "ValueHere",
      "Param2": "ValueHere",
      "Param3": "ValueHere",
      "Status": "ValueHere",
      "Text": "ValueHere",
      "TrackingUrlTemplate": "ValueHere",
      "UrlCustomParameters": {
        "Parameters": [
          {
            "Key": "ValueHere",
            "Value": "ValueHere"
          }
        ]
      }
    }
  ],
  "ReturnInheritedBidStrategyTypes": "ValueHere"
}

响应 JSON

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

以下示例适用于 BatchError 的类型为 EditorialError。

{
  "InheritedBidStrategyTypes": [
    "ValueHere"
  ],
  "KeywordIds": [
    "LongValueHere"
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

代码语法

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

public async Task<AddKeywordsResponse> AddKeywordsAsync(
	long adGroupId,
	IList<Keyword> keywords,
	bool? returnInheritedBidStrategyTypes)
{
	var request = new AddKeywordsRequest
	{
		AdGroupId = adGroupId,
		Keywords = keywords,
		ReturnInheritedBidStrategyTypes = returnInheritedBidStrategyTypes
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddKeywordsAsync(r), request));
}

static AddKeywordsResponse addKeywords(
	java.lang.Long adGroupId,
	ArrayOfKeyword keywords,
	boolean returnInheritedBidStrategyTypes) throws RemoteException, Exception
{
	AddKeywordsRequest request = new AddKeywordsRequest();

	request.setAdGroupId(adGroupId);
	request.setKeywords(keywords);
	request.setReturnInheritedBidStrategyTypes(returnInheritedBidStrategyTypes);

	return CampaignManagementService.getService().addKeywords(request);
}

static function AddKeywords(
	$adGroupId,
	$keywords,
	$returnInheritedBidStrategyTypes)
{

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

	$request = new AddKeywordsRequest();

	$request->AdGroupId = $adGroupId;
	$request->Keywords = $keywords;
	$request->ReturnInheritedBidStrategyTypes = $returnInheritedBidStrategyTypes;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddKeywords($request);
}

response=campaignmanagement_service.AddKeywords(
	AdGroupId=AdGroupId,
	Keywords=Keywords,
	ReturnInheritedBidStrategyTypes=ReturnInheritedBidStrategyTypes)

通过

AddKeywords 服务操作 - 市场活动管理

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 SOAP

响应 SOAP

代码语法

要求

请求 URL

请求元素

请求正文元素

请求标头元素

响应元素

响应正文元素

响应标头元素

请求 JSON

响应 JSON

代码语法

反馈

其他资源