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

将操作应用于资产组列表组。

请注意以下验证规则：

• 至少必须为列表组树结构指定根节点。 列表组的根 AssetGroupListingGroup 必须将其条件 操作数 设置为“All”， 并将“属性” 设置为 null。 如果要为目录中的所有产品投放广告，请将 PartitionType 设置为“Unit”。 如果要根据更具体的产品条件投放广告，请将 YPartitionTypeY 设置为“Subdivision”， 将 ParentCriterionId 设置为 null，并将 Id 设置为负值。 将负值用作任何子节点的 ParentCriterionId 。

• 根节点被视为级别 0，树最多可以有 7 个级别深的分支。

• 每次调用最多可以指定 5,000 个 AssetGroupListingGroupAction 对象。 通过多个调用创建的整个树最多可以有 20,000 个节点。

• 每个 AssetGroupListingGroup 对象必须具有相同的 AssetGroupId，否则调用将失败。

• 若要更新 Condition 或 Attribute 属性，必须删除现有的产品分区树节点，并添加新的产品分区树节点，该节点将获取新的标识符。 若要从未排除的更新到已排除的 AssetGroupListingGroup 或相反，必须删除现有的产品分区树节点，并添加一个新的产品分区树节点，该节点将获取新的标识符。

• 如果任何操作失败，则可能已成功的所有剩余操作也将失败。

• 一次调用中的所有操作都必须生成完整的树结构。 如果需要为每个资产组应用超过 5,000 个操作，则必须进行多次调用。 从第一次调用中获取父资产组标识符，然后在后续调用中根据需要添加更多子级。

• 从根节点到分支末尾的每个路径都必须以一个叶节点 (ProductPartitionType=Unit) 终止。

• 对于细分条件的其余部分，每个细分必须至少有一个叶节点。 例如，使用与其同级单位相同的操作数 () ，并将其 “属性” 设置为 null。

• 只能在其父节点之后指定子节点。

• 如果要添加具有多个级别的分区，其中父级或子级尚不存在，请使用负 int 值作为引用来标识父级。 例如，将父级的 Id 和子级的 ParentListingGroupId 元素设置为同一负值。 负 ID 仅在调用期间有效。 响应消息中返回每个成功添加的资产组列表组的唯一系统标识符。

• 若要暂停任何产品分区，必须通过调用 UpdateAssetGroups 来暂停整个资产组。 可以调用 UpdateCampaigns 来暂停整个市场活动。

• 对于“删除”操作，只需在 AssetGroupListingGroup 中指定 ID 和 AssetGroupId。

• 如果删除父产品分区，也会删除其所有子级和子级。

• 不能在分支中指定重复的产品条件。

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
ListingGroupActions	AssetGroupListingGroupAction 对象的列表，每个对象都包含一个 Action 元素和一个 ListingGroup 元素。 所有资产组列表组操作都必须针对同一资产组。 每次调用可以传递 5,000 个 AssetGroupListingGroupAction ，并为每个资产组应用最多 20,000 个列表组。	AssetGroupListingGroupAction 数组

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
AssetGroupListingGroupIds	应用了操作的列表组的 ID 列表。 ID 列表直接对应于请求中的列表组列表。 如果任何列表组操作失败，则所有剩余列表组操作都将失败，并且此列表中的所有元素都将为 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">ApplyAssetGroupListingGroupActions</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>
    <ApplyAssetGroupListingGroupActionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListingGroupActions i:nil="false">
        <AssetGroupListingGroupAction>
          <Action>ValueHere</Action>
          <ListingGroup i:nil="false">
            <AssetGroupId>ValueHere</AssetGroupId>
            <AssetGroupListingType>ValueHere</AssetGroupListingType>
            <Dimension i:nil="false">
              <Attribute i:nil="false">ValueHere</Attribute>
              <Operand i:nil="false">ValueHere</Operand>
              <Operator i:nil="false">ValueHere</Operator>
            </Dimension>
            <Id i:nil="false">ValueHere</Id>
            <IsExcluded>ValueHere</IsExcluded>
            <ParentListingGroupId i:nil="false">ValueHere</ParentListingGroupId>
          </ListingGroup>
        </AssetGroupListingGroupAction>
      </ListingGroupActions>
    </ApplyAssetGroupListingGroupActionsRequest>
  </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>
    <ApplyAssetGroupListingGroupActionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AssetGroupListingGroupIds 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>
      </AssetGroupListingGroupIds>
      <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:e277="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e277:KeyValuePairOfstringstring>
              <e277:key d4p1:nil="false">ValueHere</e277:key>
              <e277:value d4p1:nil="false">ValueHere</e277:value>
            </e277: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>
    </ApplyAssetGroupListingGroupActionsResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<ApplyAssetGroupListingGroupActionsResponse> ApplyAssetGroupListingGroupActionsAsync(
	IList<AssetGroupListingGroupAction> listingGroupActions)
{
	var request = new ApplyAssetGroupListingGroupActionsRequest
	{
		ListingGroupActions = listingGroupActions
	};

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

static ApplyAssetGroupListingGroupActionsResponse applyAssetGroupListingGroupActions(
	ArrayOfAssetGroupListingGroupAction listingGroupActions) throws RemoteException, Exception
{
	ApplyAssetGroupListingGroupActionsRequest request = new ApplyAssetGroupListingGroupActionsRequest();

	request.setListingGroupActions(listingGroupActions);

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

static function ApplyAssetGroupListingGroupActions(
	$listingGroupActions)
{

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

	$request = new ApplyAssetGroupListingGroupActionsRequest();

	$request->ListingGroupActions = $listingGroupActions;

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

response=campaignmanagement_service.ApplyAssetGroupListingGroupActions(
	ListingGroupActions=ListingGroupActions)

要求

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

请求 URL

生产 URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/AssetGroupListingGroupActions/Apply

沙盒 URL

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

请求元素

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

注意

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

请求正文元素

元素	说明	数据类型
ListingGroupActions	AssetGroupListingGroupAction 对象的列表，每个对象都包含一个 Action 元素和一个 ListingGroup 元素。 所有资产组列表组操作都必须针对同一资产组。 每次调用可以传递 5,000 个 AssetGroupListingGroupAction ，并为每个资产组应用最多 20,000 个列表组。	AssetGroupListingGroupAction 数组

请求标头元素

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

响应元素

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

响应正文元素

元素	说明	数据类型
AssetGroupListingGroupIds	应用了操作的列表组的 ID 列表。 ID 列表直接对应于请求中的列表组列表。 如果任何列表组操作失败，则所有剩余列表组操作都将失败，并且此列表中的所有元素都将为 null。	long 数组
PartialErrors	BatchError 对象的数组，其中包含任何未成功请求项的详细信息。	BatchError 数组

响应标头元素

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

请求 JSON

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

{
  "ListingGroupActions": [
    {
      "Action": "ValueHere",
      "ListingGroup": {
        "AssetGroupId": "LongValueHere",
        "AssetGroupListingType": "ValueHere",
        "Dimension": {
          "Attribute": "ValueHere",
          "Operand": "ValueHere",
          "Operator": "ValueHere"
        },
        "Id": "LongValueHere",
        "IsExcluded": "ValueHere",
        "ParentListingGroupId": "LongValueHere"
      }
    }
  ]
}

响应 JSON

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

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

{
  "AssetGroupListingGroupIds": [
    "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<ApplyAssetGroupListingGroupActionsResponse> ApplyAssetGroupListingGroupActionsAsync(
	IList<AssetGroupListingGroupAction> listingGroupActions)
{
	var request = new ApplyAssetGroupListingGroupActionsRequest
	{
		ListingGroupActions = listingGroupActions
	};

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

static ApplyAssetGroupListingGroupActionsResponse applyAssetGroupListingGroupActions(
	ArrayOfAssetGroupListingGroupAction listingGroupActions) throws RemoteException, Exception
{
	ApplyAssetGroupListingGroupActionsRequest request = new ApplyAssetGroupListingGroupActionsRequest();

	request.setListingGroupActions(listingGroupActions);

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

static function ApplyAssetGroupListingGroupActions(
	$listingGroupActions)
{

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

	$request = new ApplyAssetGroupListingGroupActionsRequest();

	$request->ListingGroupActions = $listingGroupActions;

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

response=campaignmanagement_service.ApplyAssetGroupListingGroupActions(
	ListingGroupActions=ListingGroupActions)