Opération de service DeleteListItemsFromSharedList - Gestion des campagnes
Supprime les mots clés négatifs d’une liste de mot clé négative ou les sites négatifs d’une liste d’exclusion de sites web.
L’opération est utilisée uniquement pour les mots clés négatifs et les sites négatifs via des listes partagées. Pour supprimer les mots clés négatifs qui sont affectés directement à des campagnes ou des groupes d’annonces, consultez DeleteNegativeKeywordsFromEntities. Pour définir ou remplacer des sites négatifs affectés directement à des campagnes ou des groupes d’annonces, consultez SetNegativeSitesToCampaigns et SetNegativeSitesToAdGroups.
Conseil
Pour obtenir une vue d’ensemble, consultez les guides techniques Mots clés négatifs et Sites négatifs .
Importante
Seuls les utilisateurs du compte de gestionnaire (client) qui possède une liste d’exclusion de site web (PlacementExclusionList) peuvent mettre à jour ou supprimer la liste, ajouter ou supprimer des éléments de liste et associer la liste à des comptes publicitaires. Si votre compte publicitaire est associé à une liste d’exclusion de sites web que vous ne possédez pas, vous pouvez dissocier la liste de votre compte, mais la liste et les éléments de liste sont en lecture seule. Le propriétaire de la liste est déterminé par l’élément SharedEntityCustomerId de l’association.
Si vous avez accès à plusieurs comptes de gestionnaire dans une hiérarchie de comptes, les résultats de l’opération peuvent varier en fonction de l’élément d’en-tête de requête CustomerId que vous définissez.
Éléments de demande
L’objet DeleteListItemsFromSharedListRequest définit le corps et les éléments d’en-tête de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.
Remarque
Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.
Éléments du corps de la requête
Élément | Description | Type de données |
---|---|---|
ListItemIds | Liste des identificateurs de mots clés négatifs à supprimer de la liste des mot clé négatifs, ou des sites négatifs à supprimer de la liste d’exclusion de sites web. La liste peut contenir un maximum de 5 000 éléments par appel de service. |
tableau long |
SharedEntityScope | Indique si l’entité partagée est disponible au niveau du compte publicitaire (Compte) ou du compte de responsable (Client). Cet élément est facultatif et est défini par défaut sur Étendue du compte . L’étendue du compte publicitaire s’applique uniquement aux listes de mot clé négatives. Définissez cet élément sur Client pour supprimer les sites négatifs d’une liste d’exclusion de sites web dans votre bibliothèque partagée de compte de responsable (client). |
EntityScope |
SharedList | Liste de mot clé négative ou liste d’exclusion de sites web. Si l’objet SharedEntityScope est vide ou défini sur Account, et si SharedList est un NegativeKeywordList, les ListItemIds doivent identifier les objets mot clé négatifs (NegativeKeyword). Si SharedEntityScope est défini sur Customer et si SharedList est un PlacementExclusionList, les ListItemIds doivent identifier les objets de site négatif (NegativeSite). |
SharedList |
Éléments d’en-tête de requête
Élément | Description | Type de données |
---|---|---|
AuthenticationToken | Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Pour plus d’informations, consultez Authentification avec OAuth. |
chaîne |
CustomerAccountId | Identificateur du compte publicitaire qui possède ou est associé aux entités dans la demande. Cet élément d’en-tête doit avoir la même valeur que l’élément de corps AccountId lorsque les deux sont nécessaires. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
Customerid | Identificateur du compte de responsable (client) auquel l’utilisateur accède ou à partir duquel il opère. Un utilisateur peut avoir accès à plusieurs comptes de gestionnaire. Cet élément est requis pour la plupart des opérations de service et, à titre de bonne pratique, vous devez toujours le définir. Pour plus d’informations, consultez Obtenir votre compte et ID de client. |
chaîne |
DeveloperToken | Jeton de développeur utilisé pour accéder à l’API Bing Ads. Pour plus d’informations, consultez Obtenir un jeton de développeur. |
chaîne |
Password | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
UserName | Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. | chaîne |
Éléments Response
L’objet DeleteListItemsFromSharedListResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.
Response Body, éléments
Élément | Description | Type de données |
---|---|---|
PartialErrors | Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi. La liste des erreurs ne correspond pas directement à la liste des éléments de la demande. La liste peut être vide s’il n’y a pas d’erreur, ou peut inclure un ou plusieurs objets d’erreur correspondant à chaque élément de liste ayant échoué dans la demande. |
Tableau BatchError |
Éléments d’en-tête de réponse
Élément | Description | Type de données |
---|---|---|
TrackingId | Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. | chaîne |
Requête SOAP
Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.
<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 réponse
Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>
Syntaxe du code
L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .
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)
Configuration requise
Service : CampaignManagementService.svc v13
Noms: https://bingads.microsoft.com/CampaignManagement/v13