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

将负面关键字 (keyword) 列表添加到广告帐户库，或将网站排除列表添加到经理帐户 (客户) 库。

提示

有关概述，请参阅 负面关键字 和 负面网站 技术指南。

重要

只有经理帐户 (拥有网站排除列表 (PlacementExclusionList) 的客户) 用户才能更新或删除列表、添加或删除列表项，并将列表与广告帐户关联。 如果你的广告帐户与你不拥有的网站排除列表相关联，则可以取消关联该列表与你的帐户，但列表和列表项是只读的。 列表的所有者由关联的 SharedEntityCustomerId 元素确定。

如果有权访问一个帐户层次结构中的多个经理帐户，则操作的结果可能会因设置的 CustomerId 请求标头 元素而异。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
ListItems	负关键字 (新的负面关键字 (keyword) 列表中包含的总最大) 5,000 个，或负面网站 (10,000 个总最大) 包含在新的网站排除列表中。 每个服务调用最多可以包含 5,000 个项。 若要添加更多列表项，请调用 AddListItemsToSharedList 操作。	SharedListItem 数组
SharedEntity	负关键字 (keyword) 列表或网站排除列表。 如果 SharedEntityScope 为空或设置为 Account，并且 SharedEntity 为 NegativeKeywordList，则 ListItems 必须为负关键字 (keyword) (NegativeKeyword) 对象。 如果 SharedEntityScope 设置为 Customer，并且 SharedEntity 为 PlacementExclusionList，则 ListItems 必须是负站点 (NegativeSite) 对象。	SharedEntity
SharedEntityScope	指示共享实体是否在广告帐户 (帐户) 或经理帐户 (客户) 级别可用。 此元素是可选的，默认为 “帐户 范围”。 广告帐户范围仅适用于负关键字 (keyword) 列表。 将此元素设置为 Customer ，以在经理帐户 (客户) 共享库中添加网站排除列表。	EntityScope

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
ListItemIds	一个长值列表，表示已添加的列表项的标识符。 列表的项可能返回为 null。 对于未添加列表项的每个列表索引，相应的元素将为 null。	long 数组
PartialErrors	BatchError 对象的数组，其中包含未成功的任何请求项的详细信息。 错误列表与请求中的项列表不直接对应。 如果没有错误，列表可以为空，也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。	BatchError 数组
SharedEntityId	已添加的共享实体的标识符。	long

响应标头元素

元素	说明	数据类型
跟踪 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">AddSharedEntity</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>
    <AddSharedEntityRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntity i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
        <AssociationCount i:nil="false">ValueHere</AssociationCount>
        <ForwardCompatibilityMap xmlns:e265="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e265:KeyValuePairOfstringstring>
            <e265:key i:nil="false">ValueHere</e265:key>
            <e265:value i:nil="false">ValueHere</e265:value>
          </e265:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <Id i:nil="false">ValueHere</Id>
        <Name i:nil="false">ValueHere</Name>
        <Type i:nil="false">ValueHere</Type>
        <!--This field is applicable if the derived type attribute is set to SharedList-->
        <ItemCount i:nil="false">ValueHere</ItemCount>
      </SharedEntity>
      <ListItems i:nil="false">
        <SharedListItem i:type="-- derived type specified here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e266="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e266:KeyValuePairOfstringstring>
              <e266:key i:nil="false">ValueHere</e266:key>
              <e266:value i:nil="false">ValueHere</e266:value>
            </e266:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type i:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
          <Id i:nil="false">ValueHere</Id>
          <MatchType i:nil="false">ValueHere</MatchType>
          <Text i:nil="false">ValueHere</Text>
          <!--These fields are applicable if the derived type attribute is set to NegativeSite-->
          <Id i:nil="false">ValueHere</Id>
          <Url i:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to BrandItem-->
          <BrandId>ValueHere</BrandId>
        </SharedListItem>
      </ListItems>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </AddSharedEntityRequest>
  </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>
    <AddSharedEntityResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItemIds 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>
      </ListItemIds>
      <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:e267="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e267:KeyValuePairOfstringstring>
              <e267:key d4p1:nil="false">ValueHere</e267:key>
              <e267:value d4p1:nil="false">ValueHere</e267:value>
            </e267: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>
      <SharedEntityId>ValueHere</SharedEntityId>
    </AddSharedEntityResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<AddSharedEntityResponse> AddSharedEntityAsync(
	SharedEntity sharedEntity,
	IList<SharedListItem> listItems,
	EntityScope? sharedEntityScope)
{
	var request = new AddSharedEntityRequest
	{
		SharedEntity = sharedEntity,
		ListItems = listItems,
		SharedEntityScope = sharedEntityScope
	};

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

static AddSharedEntityResponse addSharedEntity(
	SharedEntity sharedEntity,
	ArrayOfSharedListItem listItems,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	AddSharedEntityRequest request = new AddSharedEntityRequest();

	request.setSharedEntity(sharedEntity);
	request.setListItems(listItems);
	request.setSharedEntityScope(sharedEntityScope);

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

static function AddSharedEntity(
	$sharedEntity,
	$listItems,
	$sharedEntityScope)
{

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

	$request = new AddSharedEntityRequest();

	$request->SharedEntity = $sharedEntity;
	$request->ListItems = $listItems;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.AddSharedEntity(
	SharedEntity=SharedEntity,
	ListItems=ListItems,
	SharedEntityScope=SharedEntityScope)

要求

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

请求 URL

生产 URL

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

沙盒 URL

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

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
ListItems	负关键字 (新的负面关键字 (keyword) 列表中包含的总最大) 5,000 个，或负面网站 (10,000 个总最大) 包含在新的网站排除列表中。 每个服务调用最多可以包含 5,000 个项。 若要添加更多列表项，请调用 AddListItemsToSharedList 操作。	SharedListItem 数组
SharedEntity	负关键字 (keyword) 列表或网站排除列表。 如果 SharedEntityScope 为空或设置为 Account，并且 SharedEntity 为 NegativeKeywordList，则 ListItems 必须为负关键字 (keyword) (NegativeKeyword) 对象。 如果 SharedEntityScope 设置为 Customer，并且 SharedEntity 为 PlacementExclusionList，则 ListItems 必须是负站点 (NegativeSite) 对象。	SharedEntity
SharedEntityScope	指示共享实体是否在广告帐户 (帐户) 或经理帐户 (客户) 级别可用。 此元素是可选的，默认为 “帐户 范围”。 广告帐户范围仅适用于负关键字 (keyword) 列表。 将此元素设置为 Customer ，以在经理帐户 (客户) 共享库中添加网站排除列表。	EntityScope

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
ListItemIds	一个长值列表，表示已添加的列表项的标识符。 列表的项可能返回为 null。 对于未添加列表项的每个列表索引，相应的元素将为 null。	long 数组
PartialErrors	BatchError 对象的数组，其中包含未成功的任何请求项的详细信息。 错误列表与请求中的项列表不直接对应。 如果没有错误，列表可以为空，也可以包含与请求中每个不成功的列表项对应的一个或多个错误对象。	BatchError 数组
SharedEntityId	已添加的共享实体的标识符。	long

响应标头元素

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

请求 JSON

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

下面是一个示例，如果 SharedListItem 的类型为 BrandItem，SharedEntity 为 SharedList，则适用。

{
  "SharedEntity": {
    "AssociationCount": IntValueHere,
    "ForwardCompatibilityMap": [
      {
        "key": "ValueHere",
        "value": "ValueHere"
      }
    ],
    "Id": "LongValueHere",
    "Name": "ValueHere",
    "Type": "SharedList",
    "ItemCount": IntValueHere
  },
  "ListItems": [
    {
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Type": "BrandItem",
      "BrandId": "LongValueHere"
    }
  ],
  "SharedEntityScope": "ValueHere"
}

响应 JSON

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

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

{
  "ListItemIds": [
    "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
    }
  ],
  "SharedEntityId": "LongValueHere"
}

代码语法

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

public async Task<AddSharedEntityResponse> AddSharedEntityAsync(
	SharedEntity sharedEntity,
	IList<SharedListItem> listItems,
	EntityScope? sharedEntityScope)
{
	var request = new AddSharedEntityRequest
	{
		SharedEntity = sharedEntity,
		ListItems = listItems,
		SharedEntityScope = sharedEntityScope
	};

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

static AddSharedEntityResponse addSharedEntity(
	SharedEntity sharedEntity,
	ArrayOfSharedListItem listItems,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	AddSharedEntityRequest request = new AddSharedEntityRequest();

	request.setSharedEntity(sharedEntity);
	request.setListItems(listItems);
	request.setSharedEntityScope(sharedEntityScope);

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

static function AddSharedEntity(
	$sharedEntity,
	$listItems,
	$sharedEntityScope)
{

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

	$request = new AddSharedEntityRequest();

	$request->SharedEntity = $sharedEntity;
	$request->ListItems = $listItems;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.AddSharedEntity(
	SharedEntity=SharedEntity,
	ListItems=ListItems,
	SharedEntityScope=SharedEntityScope)