Partager via

Opération de service AddNegativeKeywordsToEntities - Gestion des campagnes

  • Article

Ajoute des mots clés négatifs à la campagne ou au groupe d’annonces spécifié.

L’opération n’ajoute pas de mots clés négatifs à une liste de mot clé négative partagée. Pour plus d’informations, consultez AddListItemsToSharedList .

Conseil

Pour obtenir une vue d’ensemble, consultez le guide technique des mots clés négatifs .

Éléments de demande

L’objet AddNegativeKeywordsToEntitiesRequest définit les éléments body et header 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
EntityNegativeKeywords Tableau de mot clé négatives avec une entité associée, telle qu’une campagne ou un groupe d’annonces.

Les mots clés négatifs spécifiés sont ajoutés à tous les mots clés négatifs existants si la limite de 20 000 mots clés négatifs par campagne ou groupe d’annonces associé n’est pas dépassée.

Le EntityType spécifié dans chaque EntityNegativeKeyword doit être défini sur la même valeur.

Ce tableau peut contenir un maximum de 1 élément EntityNegativeKeyword , qui contient jusqu’à 20 000 mots clés négatifs.		 Tableau EntityNegativeKeyword

É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
Mot de passe 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 AddNegativeKeywordsToEntitiesResponse 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
NegativeKeywordIds Liste d’IdCollection correspondant aux mots clés négatifs qui ont été ajoutés pour l’entité correspondante.

Dans un IdCollection, la liste des ID correspond directement à la liste des mots clés négatifs dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où un mot clé négatif n’a pas été ajouté, l’élément correspondant est null.		 Tableau IdCollection
NestedPartialErrors Tableau d’objets BatchErrorCollection qui contiennent les détails des mot clé négatifs qui n’ont pas été correctement ajoutés. L’erreur de niveau supérieur dans chaque objet BatchErrorCollection correspond à des erreurs potentielles de campagne ou de groupe d’annonces. La liste imbriquée d’objets BatchError inclut toutes les erreurs spécifiques aux mots clés négatifs que vous avez tenté d’ajouter à la campagne ou au groupe d’annonces.

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 BatchErrorCollection

É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">AddNegativeKeywordsToEntities</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>
    <AddNegativeKeywordsToEntitiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityNegativeKeywords i:nil="false">
        <EntityNegativeKeyword>
          <EntityId>ValueHere</EntityId>
          <EntityType i:nil="false">ValueHere</EntityType>
          <NegativeKeywords i:nil="false">
            <NegativeKeyword>
              <Id i:nil="false">ValueHere</Id>
              <MatchType i:nil="false">ValueHere</MatchType>
              <Text i:nil="false">ValueHere</Text>
            </NegativeKeyword>
          </NegativeKeywords>
        </EntityNegativeKeyword>
      </EntityNegativeKeywords>
    </AddNegativeKeywordsToEntitiesRequest>
  </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>
    <AddNegativeKeywordsToEntitiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <NegativeKeywordIds d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <IdCollection>
          <Ids d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a1:long>ValueHere</a1:long>
          </Ids>
        </IdCollection>
      </NegativeKeywordIds>
      <NestedPartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchErrorCollection d4p1:type="-- derived type specified here with the appropriate prefix --">
          <BatchErrors d4p1:nil="false">
            <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:e113="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
                <e113:KeyValuePairOfstringstring>
                  <e113:key d4p1:nil="false">ValueHere</e113:key>
                  <e113:value d4p1:nil="false">ValueHere</e113:value>
                </e113: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>
          </BatchErrors>
          <Code d4p1:nil="false">ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e114="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e114:KeyValuePairOfstringstring>
              <e114:key d4p1:nil="false">ValueHere</e114:key>
              <e114:value d4p1:nil="false">ValueHere</e114:value>
            </e114: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 EditorialErrorCollection-->
          <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>
        </BatchErrorCollection>
      </NestedPartialErrors>
    </AddNegativeKeywordsToEntitiesResponse>
  </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<AddNegativeKeywordsToEntitiesResponse> AddNegativeKeywordsToEntitiesAsync(
	IList<EntityNegativeKeyword> entityNegativeKeywords)
{
	var request = new AddNegativeKeywordsToEntitiesRequest
	{
		EntityNegativeKeywords = entityNegativeKeywords
	};

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

static AddNegativeKeywordsToEntitiesResponse addNegativeKeywordsToEntities(
	ArrayOfEntityNegativeKeyword entityNegativeKeywords) throws RemoteException, Exception
{
	AddNegativeKeywordsToEntitiesRequest request = new AddNegativeKeywordsToEntitiesRequest();

	request.setEntityNegativeKeywords(entityNegativeKeywords);

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

static function AddNegativeKeywordsToEntities(
	$entityNegativeKeywords)
{

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

	$request = new AddNegativeKeywordsToEntitiesRequest();

	$request->EntityNegativeKeywords = $entityNegativeKeywords;

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

response=campaignmanagement_service.AddNegativeKeywordsToEntities(
	EntityNegativeKeywords=EntityNegativeKeywords)

Configuration requise

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

URL de la demande

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/EntityNegativeKeywords

Éléments de demande

L’objet AddNegativeKeywordsToEntitiesRequest définit les éléments body et header de la demande d’opération de service.

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
EntityNegativeKeywords Tableau de mot clé négatives avec une entité associée, telle qu’une campagne ou un groupe d’annonces.

Les mots clés négatifs spécifiés sont ajoutés à tous les mots clés négatifs existants si la limite de 20 000 mots clés négatifs par campagne ou groupe d’annonces associé n’est pas dépassée.

Le EntityType spécifié dans chaque EntityNegativeKeyword doit être défini sur la même valeur.

Ce tableau peut contenir un maximum de 1 élément EntityNegativeKeyword , qui contient jusqu’à 20 000 mots clés négatifs.		 Tableau EntityNegativeKeyword

Éléments d’en-tête de requête

Élément Description Type de données
Autorisation Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée.

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
Mot de passe 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 AddNegativeKeywordsToEntitiesResponse 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 le json de réponse.

Response Body, éléments

Élément Description Type de données
NegativeKeywordIds Liste d’IdCollection correspondant aux mots clés négatifs qui ont été ajoutés pour l’entité correspondante.

Dans un IdCollection, la liste des ID correspond directement à la liste des mots clés négatifs dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où un mot clé négatif n’a pas été ajouté, l’élément correspondant est null.		 Tableau IdCollection
NestedPartialErrors Tableau d’objets BatchErrorCollection qui contiennent les détails des mot clé négatifs qui n’ont pas été correctement ajoutés. L’erreur de niveau supérieur dans chaque objet BatchErrorCollection correspond à des erreurs potentielles de campagne ou de groupe d’annonces. La liste imbriquée d’objets BatchError inclut toutes les erreurs spécifiques aux mots clés négatifs que vous avez tenté d’ajouter à la campagne ou au groupe d’annonces.

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 BatchErrorCollection

É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 JSON

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. 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.

{
  "EntityNegativeKeywords": [
    {
      "EntityId": "LongValueHere",
      "EntityType": "ValueHere",
      "NegativeKeywords": [
        {
          "Id": "LongValueHere",
          "MatchType": "ValueHere",
          "Text": "ValueHere"
        }
      ]
    }
  ]
}

JSON de réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse JSON.

Voici un exemple qui s’applique si le type de BatchErrorCollection est EditorialErrorCollection, BatchError est EditorialError.

{
  "NegativeKeywordIds": [
    {
      "Ids": [
        "LongValueHere"
      ]
    }
  ],
  "NestedPartialErrors": [
    {
      "BatchErrors": [
        {
          "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
        }
      ],
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialErrorCollection",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. 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<AddNegativeKeywordsToEntitiesResponse> AddNegativeKeywordsToEntitiesAsync(
	IList<EntityNegativeKeyword> entityNegativeKeywords)
{
	var request = new AddNegativeKeywordsToEntitiesRequest
	{
		EntityNegativeKeywords = entityNegativeKeywords
	};

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

static AddNegativeKeywordsToEntitiesResponse addNegativeKeywordsToEntities(
	ArrayOfEntityNegativeKeyword entityNegativeKeywords) throws RemoteException, Exception
{
	AddNegativeKeywordsToEntitiesRequest request = new AddNegativeKeywordsToEntitiesRequest();

	request.setEntityNegativeKeywords(entityNegativeKeywords);

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

static function AddNegativeKeywordsToEntities(
	$entityNegativeKeywords)
{

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

	$request = new AddNegativeKeywordsToEntitiesRequest();

	$request->EntityNegativeKeywords = $entityNegativeKeywords;

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

response=campaignmanagement_service.AddNegativeKeywordsToEntities(
	EntityNegativeKeywords=EntityNegativeKeywords)