Partager via

Opération de service GetSharedEntities - Gestion des campagnes

  • Article

Obtient des listes mot clé négatives ou des listes d’exclusion de sites web.

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 GetSharedEntitiesRequest 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
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 obtenir les listes d’exclusion de site web dans votre bibliothèque partagée de compte de responsable (client).		 EntityScope
SharedEntityType Type d’entité partagée à obtenir à partir de la bibliothèque de compte publicitaire ou de compte de responsable (client).

Définissez cet élément sur NegativeKeywordList pour obtenir des listes de mot clé négatives (NegativeKeywordList) dans votre bibliothèque partagée de compte publicitaire.

Définissez cet élément sur PlacementExclusionList pour obtenir les listes d’exclusion de site web (PlacementExclusionList) dans votre bibliothèque partagée de compte responsable (client).		 chaîne

É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 GetSharedEntitiesResponse 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
SharedEntities Listes de mot clé négatives ou listes d’exclusion de sites web. Tableau SharedEntity

É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">GetSharedEntities</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>
    <GetSharedEntitiesRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntityType i:nil="false">ValueHere</SharedEntityType>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </GetSharedEntitiesRequest>
  </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>
    <GetSharedEntitiesResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntities d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <SharedEntity d4p1:type="-- derived type specified here with the appropriate prefix --">
          <AssociationCount d4p1:nil="false">ValueHere</AssociationCount>
          <ForwardCompatibilityMap xmlns:e351="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e351:KeyValuePairOfstringstring>
              <e351:key d4p1:nil="false">ValueHere</e351:key>
              <e351:value d4p1:nil="false">ValueHere</e351:value>
            </e351:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Id d4p1:nil="false">ValueHere</Id>
          <Name d4p1:nil="false">ValueHere</Name>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--This field is applicable if the derived type attribute is set to SharedList-->
          <ItemCount d4p1:nil="false">ValueHere</ItemCount>
        </SharedEntity>
      </SharedEntities>
    </GetSharedEntitiesResponse>
  </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<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
	string sharedEntityType,
	EntityScope? sharedEntityScope)
{
	var request = new GetSharedEntitiesRequest
	{
		SharedEntityType = sharedEntityType,
		SharedEntityScope = sharedEntityScope
	};

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

static GetSharedEntitiesResponse getSharedEntities(
	java.lang.String sharedEntityType,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();

	request.setSharedEntityType(sharedEntityType);
	request.setSharedEntityScope(sharedEntityScope);

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

static function GetSharedEntities(
	$sharedEntityType,
	$sharedEntityScope)
{

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

	$request = new GetSharedEntitiesRequest();

	$request->SharedEntityType = $sharedEntityType;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.GetSharedEntities(
	SharedEntityType=SharedEntityType,
	SharedEntityScope=SharedEntityScope)

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/SharedEntities/Query

Éléments de demande

L’objet GetSharedEntitiesRequest 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
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 obtenir les listes d’exclusion de site web dans votre bibliothèque partagée de compte de responsable (client).		 EntityScope
SharedEntityType Type d’entité partagée à obtenir à partir de la bibliothèque de compte publicitaire ou de compte de responsable (client).

Définissez cet élément sur NegativeKeywordList pour obtenir des listes de mot clé négatives (NegativeKeywordList) dans votre bibliothèque partagée de compte publicitaire.

Définissez cet élément sur PlacementExclusionList pour obtenir les listes d’exclusion de site web (PlacementExclusionList) dans votre bibliothèque partagée de compte responsable (client).		 chaîne

É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 GetSharedEntitiesResponse 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
SharedEntities Listes de mot clé négatives ou listes d’exclusion de sites web. Tableau SharedEntity

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

{
  "SharedEntityType": "ValueHere",
  "SharedEntityScope": "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 SharedEntity est SharedList.

{
  "SharedEntities": [
    {
      "AssociationCount": IntValueHere,
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Type": "SharedList",
      "ItemCount": 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<GetSharedEntitiesResponse> GetSharedEntitiesAsync(
	string sharedEntityType,
	EntityScope? sharedEntityScope)
{
	var request = new GetSharedEntitiesRequest
	{
		SharedEntityType = sharedEntityType,
		SharedEntityScope = sharedEntityScope
	};

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

static GetSharedEntitiesResponse getSharedEntities(
	java.lang.String sharedEntityType,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetSharedEntitiesRequest request = new GetSharedEntitiesRequest();

	request.setSharedEntityType(sharedEntityType);
	request.setSharedEntityScope(sharedEntityScope);

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

static function GetSharedEntities(
	$sharedEntityType,
	$sharedEntityScope)
{

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

	$request = new GetSharedEntitiesRequest();

	$request->SharedEntityType = $sharedEntityType;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.GetSharedEntities(
	SharedEntityType=SharedEntityType,
	SharedEntityScope=SharedEntityScope)