Operação do Serviço ApplyAssetGroupListingGroupActions – Gestão de Campanhas

Artigo
04/01/2024

Aplica uma ação a um grupo de recursos que lista o grupo.

Tenha em atenção as seguintes regras de validação:

No mínimo, tem de especificar, pelo menos, o nó raiz para a estrutura de árvore do grupo de listagem. O AssetGroupListingGroup raiz do grupo de listagem tem de ter a condição Operando definida como "Tudo" e Atributo como nulo. Se estiver a servir anúncios para todos os produtos no catálogo, defina o PartitionType como "Unidade". Se estiver a apresentar anúncios em condições de produto mais específicas, defina YPartitionTypeY como "Subdivisão", ParentCriterionId como nulo e o ID para um valor negativo. Irá utilizar o valor negativo como ParentCriterionId para todos os nós subordinados.
O nó raiz é considerado nível 0 e uma árvore pode ter ramos até 7 níveis de profundidade.
Pode especificar até 5000 objetos AssetGroupListingGroupAction por chamada. Toda a árvore criada através de várias chamadas pode ter até 20 000 nós.
Cada um dos objetos AssetGroupListingGroup tem de ter o mesmo AssetGroupId. Caso contrário, a chamada falhará.
Para atualizar as propriedades Condição ou Atributo , tem de eliminar o nó de árvore de partição de produto existente e adicionar um novo nó de árvore de partição de produto que irá obter um novo identificador. Para atualizar de um não excluído para um AssetGroupListingGroup excluído ou ao contrário, tem de eliminar o nó de árvore de partição de produto existente e adicionar um novo nó de árvore de partição de produto que irá obter um novo identificador.
Se alguma ação falhar, todas as ações restantes que possam ter sido bem-sucedidas também falharão.
Todas as ações numa chamada têm de resultar numa estrutura de árvore completa. Se precisar de aplicar mais de 5000 ações por grupo de recursos, tem de efetuar várias chamadas. Obtenha os identificadores do grupo de elementos principais da primeira chamada e, em seguida, adicione mais subordinados conforme necessário nas chamadas subsequentes.
Todos os caminhos do nó de raiz até ao fim de um ramo têm de terminar com um nó de folha (ProductPartitionType=Unit).
Cada subdivisão deve ter, pelo menos, um nó de folha para o resto das condições da subdivisão. Por exemplo, utilize o mesmo operando que as unidades entre irmãos e defina o atributo como nulo.
Só pode especificar um nó subordinado após o respetivo principal.
Se estiver a adicionar partições com vários níveis em que o elemento principal ou o subordinado ainda não existem, utilize um valor int negativo como referência para identificar o elemento principal. Por exemplo, defina o ID do principal e o elemento ParentListingGroupId do menor para o mesmo valor negativo. Os IDs negativos só são válidos durante a chamada. Os identificadores de sistema exclusivos para cada grupo de listagem de grupos de recursos adicionados com êxito são devolvidos na mensagem de resposta.
Para colocar em pausa qualquer partição de produto, tem de colocar todo o grupo de recursos em pausa ao chamar UpdateAssetGroups. Pode chamar UpdateCampaigns para colocar toda a campanha em pausa.
Para uma ação Eliminar , só tem de especificar o ID e o AssetGroupId no AssetGroupListingGroup.
Se eliminar uma partição de produto principal, todos os respetivos subordinados e descendentes também serão eliminados.
Não pode especificar condições de produto duplicadas num ramo.

Elementos do Pedido

O objeto ApplyAssetGroupListingGroupActionsRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento	Descrição	Tipo de Dados
ListingGroupActions	Uma lista de objetos AssetGroupListingGroupAction que contêm um elemento Action e um elemento ListingGroup . Todas as ações do grupo de recursos que listam o grupo têm de ser para o mesmo grupo de recursos. Pode transmitir 5000 AssetGroupListingGroupAction por chamada e aplicar um máximo de 20 000 grupos de listagem a cada grupo de recursos.	Matriz AssetGroupListingGroupAction

Elementos do Cabeçalho do Pedido

Elemento	Descrição	Tipo de Dados
AuthenticationToken	O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).	cadeia
CustomerAccountId	O identificador da conta de anúncio que detém ou está associada às entidades no pedido. Este elemento de cabeçalho tem de ter o mesmo valor que o elemento do corpo AccountId quando ambos são necessários. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.	cadeia
CustomerId	O identificador da conta de gestor (cliente) a partir da qual o utilizador está a aceder ou a operar. Um utilizador pode ter acesso a várias contas de gestor. Este elemento é necessário para a maioria das operações de serviço e, como melhor prática, deve sempre defini-lo. Para obter mais informações, veja Obter a Sua Conta e IDs de Cliente.	cadeia
DeveloperToken	O token de programador utilizado para aceder à API de Anúncios do Bing. Para obter mais informações, veja Obter um Token de Programador.	cadeia
Palavra-passe	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia
Nome de Utilizador	Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador.	cadeia

Elementos de Resposta

O objeto ApplyAssetGroupListingGroupActionsResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento	Descrição	Tipo de Dados
AssetGroupListingGroupIds	Uma lista de IDs para os grupos de listagem que tinham a ação aplicada. A lista de IDs corresponde diretamente à lista de grupos de listagem no pedido. Se alguma ação do grupo de listagem falhar, todas as restantes ações do grupo de listagem falharão e todos os elementos nesta lista serão nulos.	matriz longa
PartialErrors	Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não foram bem-sucedidos.	Matriz BatchError

Elementos do Cabeçalho de Resposta

Elemento	Descrição	Tipo de Dados
TrackingId	O identificador da entrada de registo que contém os detalhes da chamada à API.	cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<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 de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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:e63="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e63:KeyValuePairOfstringstring>
              <e63:key d4p1:nil="false">ValueHere</e63:key>
              <e63:value d4p1:nil="false">ValueHere</e63:value>
            </e63: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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: CampaignManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/CampaignManagement/v13

Partilhar via