Operação de Serviço DeleteListItemsFromSharedList – Gestão de Campanhas

Artigo
12/21/2023

Elimina palavras-chave negativas de uma lista de palavras-chave negativas ou sites negativos de uma lista de exclusão de sites.

A operação só é utilizada para palavras-chave negativas e sites negativos através de listas partilhadas. Para remover palavras-chave negativas atribuídas diretamente a campanhas ou grupos de anúncios, veja DeleteNegativeKeywordsFromEntities. Para definir ou substituir sites negativos atribuídos diretamente a campanhas ou grupos de anúncios, veja SetNegativeSitesToCampaigns e SetNegativeSitesToAdGroups.

Sugestão

Para obter uma descrição geral, veja os guias técnicos Palavras-chave Negativas e Sites Negativos .

Importante

Apenas os utilizadores da conta de gestor (cliente) que detém uma lista de exclusão de sites (PlacementExclusionList) podem atualizar ou eliminar a lista, adicionar ou eliminar itens de lista e associar a lista a contas de anúncios. Se a sua conta de anúncio estiver associada a uma lista de exclusão de sites da qual não é proprietário, pode desassociar a lista da sua conta, mas os itens de lista e lista são só de leitura. O proprietário da lista é determinado pelo elemento SharedEntityCustomerId da associação.

Se tiver acesso a várias contas de gestor numa hierarquia de contas, os resultados da operação podem variar consoante o elemento de cabeçalho do pedido CustomerId que definiu.

Elementos do Pedido

O objeto DeleteListItemsFromSharedListRequest 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
ListItemIds	A lista de identificadores de palavras-chave negativas a eliminar da lista de palavras-chave negativas ou os sites negativos a eliminar da lista de exclusão de sites. A lista pode conter um máximo de 5000 itens por chamada de serviço.	matriz longa
SharedEntityScope	Indica se a entidade partilhada está disponível ao nível da conta de anúncio (Conta) ou da conta de gestor (Cliente). Este elemento é opcional e é predefinido como Âmbito da conta . O âmbito da conta de anúncio só é aplicável a listas de palavras-chave negativas. Defina este elemento como Cliente para eliminar sites negativos de uma lista de exclusão de sites na biblioteca partilhada da sua conta de gestor (cliente).	EntityScope
Lista Partilhada	A lista de palavras-chave negativa ou a lista de exclusão de sites. Se o SharedEntityScope estiver vazio ou estiver definido como Conta e se a Lista Partilhada for uma NegativeKeywordList, os ListItemIds têm de identificar objetos de palavra-chave negativa (NegativeKeyword). Se o SharedEntityScope estiver definido como Cliente e se a Lista Partilhada for uma PlacementExclusionList, os ListItemIds têm de identificar objetos negativos do site (NegativeSite).	Lista Partilhada

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 DeleteListItemsFromSharedListResponse 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
PartialErrors	Uma matriz de objetos BatchError que contêm detalhes para quaisquer itens de pedido que não tenham sido bem-sucedidos. A lista de erros não corresponde diretamente à lista de itens no pedido. A lista pode estar vazia se não existirem erros ou pode incluir um ou mais objetos de erro correspondentes a cada item de lista sem êxito no pedido.	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">DeleteListItemsFromSharedList</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>
    <DeleteListItemsFromSharedListRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItemIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </ListItemIds>
      <SharedList i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
        <ItemCount i:nil="false">ValueHere</ItemCount>
        <!--No additional fields are applicable if the derived type attribute is set to NegativeKeywordList-->
        <!--No additional fields are applicable if the derived type attribute is set to PlacementExclusionList-->
        <!--No additional fields are applicable if the derived type attribute is set to AccountNegativeKeywordList-->
        <!--No additional fields are applicable if the derived type attribute is set to BrandList-->
      </SharedList>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </DeleteListItemsFromSharedListRequest>
  </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>
    <DeleteListItemsFromSharedListResponse 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:e91="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e91:KeyValuePairOfstringstring>
              <e91:key d4p1:nil="false">ValueHere</e91:key>
              <e91:value d4p1:nil="false">ValueHere</e91:value>
            </e91: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>
    </DeleteListItemsFromSharedListResponse>
  </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<DeleteListItemsFromSharedListResponse> DeleteListItemsFromSharedListAsync(
	IList<long> listItemIds,
	SharedList sharedList,
	EntityScope? sharedEntityScope)
{
	var request = new DeleteListItemsFromSharedListRequest
	{
		ListItemIds = listItemIds,
		SharedList = sharedList,
		SharedEntityScope = sharedEntityScope
	};

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

static DeleteListItemsFromSharedListResponse deleteListItemsFromSharedList(
	ArrayOflong listItemIds,
	SharedList sharedList,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	DeleteListItemsFromSharedListRequest request = new DeleteListItemsFromSharedListRequest();

	request.setListItemIds(listItemIds);
	request.setSharedList(sharedList);
	request.setSharedEntityScope(sharedEntityScope);

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

static function DeleteListItemsFromSharedList(
	$listItemIds,
	$sharedList,
	$sharedEntityScope)
{

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

	$request = new DeleteListItemsFromSharedListRequest();

	$request->ListItemIds = $listItemIds;
	$request->SharedList = $sharedList;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.DeleteListItemsFromSharedList(
	ListItemIds=ListItemIds,
	SharedList=SharedList,
	SharedEntityScope=SharedEntityScope)

Requisitos

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

Compartilhar via