Operazione del servizio GetListItemsBySharedList - Gestione campagna

Articolo
12/21/2023

Ottiene le parole chiave negative di un elenco di parole chiave negative o i siti negativi di un elenco di esclusione di siti Web.

L'operazione viene usata solo per parole chiave negative e siti negativi tramite elenchi condivisi. Per ottenere parole chiave negative assegnate direttamente a campagne o gruppi di annunci, vedere GetNegativeKeywordsByEntityIds. Per ottenere siti negativi assegnati direttamente a campagne o gruppi di annunci, vedere GetNegativeSitesByCampaignIds e GetNegativeSitesByAdGroupIds.

Consiglio

Per una panoramica, vedere le guide tecniche relative a parole chiave negative e siti negativi .

Importante

Solo gli utenti dell'account manager (cliente) proprietario di un elenco di esclusione del sito Web (PlacementExclusionList) possono aggiornare o eliminare l'elenco, aggiungere o eliminare elementi dell'elenco e associarlo agli account pubblicitari. Se il tuo account pubblicitario è associato a un elenco di esclusione di siti Web che non possiedi, puoi annullare l'associazione dell'elenco dal tuo account, ma l'elenco e gli elementi dell'elenco sono di sola lettura. Il proprietario dell'elenco è determinato dall'elemento SharedEntityCustomerId dell'associazione.

Se si ha accesso a più account di gestione in una gerarchia di account, i risultati dell'operazione possono variare a seconda dell'elemento di intestazione della richiesta CustomerId impostato.

Elementi della richiesta

L'oggetto GetListItemsBySharedListRequest definisce il corpo e gli elementi di intestazione della richiesta di operazione del servizio. Gli elementi devono essere nello stesso ordine indicato nella richiesta SOAP.

Nota

Se non diversamente indicato di seguito, sono necessari tutti gli elementi della richiesta.

Elementi del corpo della richiesta

Elemento	Descrizione	Tipo di dati
SharedEntityScope	Indica se l'entità condivisa è disponibile a livello di account pubblicitario (account) o account manager (cliente). Questo elemento è facoltativo e per impostazione predefinita è Ambito account . L'ambito dell'account pubblicitario è applicabile solo agli elenchi di parole chiave negative. Impostare questo elemento su Customer per ottenere i siti negativi per un elenco di esclusione di siti Web nella raccolta condivisa dell'account manager (cliente).	EntityScope
SharedList	Elenco di parole chiave negative o elenco di esclusione di siti Web. Se SharedEntityScope è vuoto o impostato su Account e se SharedList è un oggetto NegativeKeywordList, gli elementi dell'elenco restituiti saranno oggetti parola chiave negativa (NegativeKeyword). Se SharedEntityScope è impostato su Customer e SharedList è un PlacementExclusionList, gli elementi dell'elenco restituiti saranno oggetti negativi del sito (NegativeSite). È necessario includere l'ID di SharedList quando si effettua la richiesta di servizio.	SharedList

Elementi dell'intestazione della richiesta

Elemento	Descrizione	Tipo di dati
AuthenticationToken	Token di accesso OAuth che rappresenta le credenziali di un utente che dispone delle autorizzazioni per gli account Microsoft Advertising. Per altre informazioni, vedere Autenticazione con OAuth.	Stringa
CustomerAccountId	Identificatore dell'account pubblicitario proprietario o associato alle entità nella richiesta. Questo elemento di intestazione deve avere lo stesso valore dell'elemento del corpo AccountId quando sono necessari entrambi. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente.	Stringa
Customerid	Identificatore dell'account manager (cliente) da cui l'utente accede o opera. Un utente può avere accesso a più account manager. Questo elemento è necessario per la maggior parte delle operazioni del servizio e, come procedura consigliata, è consigliabile impostarlo sempre. Per altre informazioni, vedere Ottenere l'account e gli ID cliente.	Stringa
DeveloperToken	Token di sviluppo usato per accedere all'API Bing Ads. Per altre informazioni, vedere Ottenere un token per sviluppatori.	Stringa
Password	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa
UserName	Questo elemento è riservato per l'uso interno e verrà rimosso da una versione futura dell'API. È necessario usare l'elemento AuthenticationToken per impostare le credenziali utente.	Stringa

Elementi di risposta

L'oggetto GetListItemsBySharedListResponse definisce il corpo e gli elementi di intestazione della risposta dell'operazione del servizio. Gli elementi vengono restituiti nello stesso ordine illustrato nella soap di risposta.

Elementi del corpo della risposta

Elemento	Descrizione	Tipo di dati
ListItems	Elenco di parole chiave negative o siti negativi. Se nell'elenco condiviso non sono presenti elementi di elenco, viene restituita una matrice vuota.	Matrice SharedListItem

Elementi dell'intestazione della risposta

Elemento	Descrizione	Tipo di dati
TrackingId	Identificatore della voce di log che contiene i dettagli della chiamata API.	Stringa

Richiedi SOAP

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi corpo e intestazione per la richiesta SOAP. Per i tipi supportati che è possibile usare con questa operazione del servizio, vedere il riferimento Request Body Elements sopra riportato.

<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">GetListItemsBySharedList</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>
    <GetListItemsBySharedListRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <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>
    </GetListItemsBySharedListRequest>
  </s:Body>
</s:Envelope>

SOAP della risposta

Questo modello è stato generato da uno strumento per visualizzare l'ordine degli elementi del corpo e dell'intestazione per la risposta 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>
    <GetListItemsBySharedListResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItems d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <SharedListItem d4p1:type="-- derived type specified here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e158="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e158:KeyValuePairOfstringstring>
              <e158:key d4p1:nil="false">ValueHere</e158:key>
              <e158:value d4p1:nil="false">ValueHere</e158:value>
            </e158:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
          <Id d4p1:nil="false">ValueHere</Id>
          <MatchType d4p1:nil="false">ValueHere</MatchType>
          <Text d4p1:nil="false">ValueHere</Text>
          <!--These fields are applicable if the derived type attribute is set to NegativeSite-->
          <Id d4p1:nil="false">ValueHere</Id>
          <Url d4p1:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to BrandItem-->
          <BrandId>ValueHere</BrandId>
        </SharedListItem>
      </ListItems>
    </GetListItemsBySharedListResponse>
  </s:Body>
</s:Envelope>

Sintassi del codice

La sintassi di esempio può essere usata con gli SDK di Bing Ads. Per altri esempi, vedere Esempi di codice DELL'API Bing Ads .

public async Task<GetListItemsBySharedListResponse> GetListItemsBySharedListAsync(
	SharedList sharedList,
	EntityScope? sharedEntityScope)
{
	var request = new GetListItemsBySharedListRequest
	{
		SharedList = sharedList,
		SharedEntityScope = sharedEntityScope
	};

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

static GetListItemsBySharedListResponse getListItemsBySharedList(
	SharedList sharedList,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetListItemsBySharedListRequest request = new GetListItemsBySharedListRequest();

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

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

static function GetListItemsBySharedList(
	$sharedList,
	$sharedEntityScope)
{

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

	$request = new GetListItemsBySharedListRequest();

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

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

response=campaignmanagement_service.GetListItemsBySharedList(
	SharedList=SharedList,
	SharedEntityScope=SharedEntityScope)

Requisiti

Servizio: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Condividi tramite