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

删除市场活动关联或广告帐户关联的网站排除列表的负面关键字 (keyword) 列表。

提示

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

重要

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

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

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
协会 市场活动关联或广告帐户关联的网站排除列表的负面关键字 (keyword) 列表。

此数组最多可以包含 10,000 个元素。
SharedEntityAssociation 数组
SharedEntityScope 指示共享实体是否在广告帐户 (帐户) 或经理帐户 (客户) 级别可用

此元素是可选的,默认为 “帐户 范围”。 广告帐户范围仅适用于市场活动关联负关键字 (keyword) 列表。

将此元素设置为 “客户” ,以删除经理帐户 (客户) 共享库中的广告帐户关联的网站排除列表。
EntityScope

请求标头元素

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

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

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

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

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

响应元素

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

响应正文元素

元素 说明 数据类型
PartialErrors BatchError 对象的数组,其中包含未成功删除的任何关联的详细信息。

错误列表直接对应于请求中的关联列表。 列表的项可能返回为 null。 对于成功删除关联的每个列表索引,相应的 error 元素将为 null。 理想情况下,所有关联都会成功删除,并且此列表中的所有元素均为 null。
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">DeleteSharedEntityAssociations</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>
    <DeleteSharedEntityAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Associations i:nil="false">
        <SharedEntityAssociation>
          <EntityId>ValueHere</EntityId>
          <EntityType i:nil="false">ValueHere</EntityType>
          <SharedEntityCustomerId i:nil="false">ValueHere</SharedEntityCustomerId>
          <SharedEntityId>ValueHere</SharedEntityId>
          <SharedEntityType i:nil="false">ValueHere</SharedEntityType>
        </SharedEntityAssociation>
      </Associations>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </DeleteSharedEntityAssociationsRequest>
  </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>
    <DeleteSharedEntityAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <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:e351="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e351:KeyValuePairOfstringstring>
              <e351:key d4p1:nil="false">ValueHere</e351:key>
              <e351:value d4p1:nil="false">ValueHere</e351:value>
            </e351: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>
    </DeleteSharedEntityAssociationsResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<DeleteSharedEntityAssociationsResponse> DeleteSharedEntityAssociationsAsync(
	IList<SharedEntityAssociation> associations,
	EntityScope? sharedEntityScope)
{
	var request = new DeleteSharedEntityAssociationsRequest
	{
		Associations = associations,
		SharedEntityScope = sharedEntityScope
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.DeleteSharedEntityAssociationsAsync(r), request));
}
static DeleteSharedEntityAssociationsResponse deleteSharedEntityAssociations(
	ArrayOfSharedEntityAssociation associations,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	DeleteSharedEntityAssociationsRequest request = new DeleteSharedEntityAssociationsRequest();

	request.setAssociations(associations);
	request.setSharedEntityScope(sharedEntityScope);

	return CampaignManagementService.getService().deleteSharedEntityAssociations(request);
}
static function DeleteSharedEntityAssociations(
	$associations,
	$sharedEntityScope)
{

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

	$request = new DeleteSharedEntityAssociationsRequest();

	$request->Associations = $associations;
	$request->SharedEntityScope = $sharedEntityScope;

	return $GLOBALS['CampaignManagementProxy']->GetService()->DeleteSharedEntityAssociations($request);
}
response=campaignmanagement_service.DeleteSharedEntityAssociations(
	Associations=Associations,
	SharedEntityScope=SharedEntityScope)

要求

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

请求 URL

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

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
协会 市场活动关联或广告帐户关联的网站排除列表的负面关键字 (keyword) 列表。

此数组最多可以包含 10,000 个元素。
SharedEntityAssociation 数组
SharedEntityScope 指示共享实体是否在广告帐户 (帐户) 或经理帐户 (客户) 级别可用

此元素是可选的,默认为 “帐户 范围”。 广告帐户范围仅适用于市场活动关联负关键字 (keyword) 列表。

将此元素设置为 “客户” ,以删除经理帐户 (客户) 共享库中的广告帐户关联的网站排除列表。
EntityScope

请求标头元素

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

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

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

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

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

响应元素

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

响应正文元素

元素 说明 数据类型
PartialErrors BatchError 对象的数组,其中包含未成功删除的任何关联的详细信息。

错误列表直接对应于请求中的关联列表。 列表的项可能返回为 null。 对于成功删除关联的每个列表索引,相应的 error 元素将为 null。 理想情况下,所有关联都会成功删除,并且此列表中的所有元素均为 null。
BatchError 数组

响应标头元素

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

请求 JSON

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

{
  "Associations": [
    {
      "EntityId": "LongValueHere",
      "EntityType": "ValueHere",
      "SharedEntityCustomerId": "LongValueHere",
      "SharedEntityId": "LongValueHere",
      "SharedEntityType": "ValueHere"
    }
  ],
  "SharedEntityScope": "ValueHere"
}

响应 JSON

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

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

{
  "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<DeleteSharedEntityAssociationsResponse> DeleteSharedEntityAssociationsAsync(
	IList<SharedEntityAssociation> associations,
	EntityScope? sharedEntityScope)
{
	var request = new DeleteSharedEntityAssociationsRequest
	{
		Associations = associations,
		SharedEntityScope = sharedEntityScope
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.DeleteSharedEntityAssociationsAsync(r), request));
}
static DeleteSharedEntityAssociationsResponse deleteSharedEntityAssociations(
	ArrayOfSharedEntityAssociation associations,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	DeleteSharedEntityAssociationsRequest request = new DeleteSharedEntityAssociationsRequest();

	request.setAssociations(associations);
	request.setSharedEntityScope(sharedEntityScope);

	return CampaignManagementService.getService().deleteSharedEntityAssociations(request);
}
static function DeleteSharedEntityAssociations(
	$associations,
	$sharedEntityScope)
{

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

	$request = new DeleteSharedEntityAssociationsRequest();

	$request->Associations = $associations;
	$request->SharedEntityScope = $sharedEntityScope;

	return $GLOBALS['CampaignManagementProxy']->GetService()->DeleteSharedEntityAssociations($request);
}
response=campaignmanagement_service.DeleteSharedEntityAssociations(
	Associations=Associations,
	SharedEntityScope=SharedEntityScope)