GetSharedEntityAssociationsByEntityIds Service Operation - Campaign Management
Obtient la liste négative mot clé aux associations de campagne par ID de campagne, ou la liste d’exclusion de site web aux associations de comptes publicitaires par ID de compte publicitaire.
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 GetSharedEntityAssociationsByEntityIdsRequest 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 |
|---|---|---|
| EntityIds | Liste des identificateurs de compte de campagne ou de compte publicitaire. Ce tableau peut contenir un maximum de 100 éléments. |
tableau long |
| EntityType | Type d’entité correspondant à l’élément EntityIds spécifié. Définissez cet élément sur « Campaign » pour obtenir une liste de mot clé négative aux associations de campagne dans votre bibliothèque partagée de compte publicitaire. Définissez cet élément sur « Account » pour obtenir la liste d’exclusions de site web pour les associations de comptes publicitaires dans votre bibliothèque partagée de compte de responsable (client). |
chaîne |
| 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 aux associations de campagne. Définissez cet élément sur Client pour obtenir la liste d’exclusions de site web pour les associations de comptes publicitaires dans votre bibliothèque partagée de compte de responsable (client). |
EntityScope |
| SharedEntityType | Type d’entité partagée pour obtenir des associations. Définissez cet élément sur « NegativeKeywordList » pour obtenir une liste de mot clé négative aux associations de campagne dans votre bibliothèque partagée de compte publicitaire. Définissez cet élément sur « PlacementExclusionList » pour obtenir la liste d’exclusion de site web pour les associations de comptes publicitaires dans votre bibliothèque partagée de compte de 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 GetSharedEntityAssociationsByEntityIdsResponse 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 |
|---|---|---|
| Association | Tableau d’objets SharedEntityAssociation qui correspond directement aux identificateurs d’entité que vous avez spécifiés dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une association n’a pas été récupérée, l’élément correspondant est null. | Tableau SharedEntityAssociation |
| 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">GetSharedEntityAssociationsByEntityIds</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>
<GetSharedEntityAssociationsByEntityIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<a1:long>ValueHere</a1:long>
</EntityIds>
<EntityType i:nil="false">ValueHere</EntityType>
<SharedEntityType i:nil="false">ValueHere</SharedEntityType>
<SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
</GetSharedEntityAssociationsByEntityIdsRequest>
</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>
<GetSharedEntityAssociationsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
<Associations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
<SharedEntityAssociation>
<EntityId>ValueHere</EntityId>
<EntityType d4p1:nil="false">ValueHere</EntityType>
<SharedEntityCustomerId d4p1:nil="false">ValueHere</SharedEntityCustomerId>
<SharedEntityId>ValueHere</SharedEntityId>
<SharedEntityType d4p1:nil="false">ValueHere</SharedEntityType>
</SharedEntityAssociation>
</Associations>
<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:e355="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
<e355:KeyValuePairOfstringstring>
<e355:key d4p1:nil="false">ValueHere</e355:key>
<e355:value d4p1:nil="false">ValueHere</e355:value>
</e355: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>
</GetSharedEntityAssociationsByEntityIdsResponse>
</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<GetSharedEntityAssociationsByEntityIdsResponse> GetSharedEntityAssociationsByEntityIdsAsync(
IList<long> entityIds,
string entityType,
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntityAssociationsByEntityIdsRequest
{
EntityIds = entityIds,
EntityType = entityType,
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntityAssociationsByEntityIdsAsync(r), request));
}
static GetSharedEntityAssociationsByEntityIdsResponse getSharedEntityAssociationsByEntityIds(
ArrayOflong entityIds,
java.lang.String entityType,
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntityAssociationsByEntityIdsRequest request = new GetSharedEntityAssociationsByEntityIdsRequest();
request.setEntityIds(entityIds);
request.setEntityType(entityType);
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntityAssociationsByEntityIds(request);
}
static function GetSharedEntityAssociationsByEntityIds(
$entityIds,
$entityType,
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntityAssociationsByEntityIdsRequest();
$request->EntityIds = $entityIds;
$request->EntityType = $entityType;
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntityAssociationsByEntityIds($request);
}
response=campaignmanagement_service.GetSharedEntityAssociationsByEntityIds(
EntityIds=EntityIds,
EntityType=EntityType,
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/SharedEntityAssociations/QueryByEntityIds
Éléments de demande
L’objet GetSharedEntityAssociationsByEntityIdsRequest 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 |
|---|---|---|
| EntityIds | Liste des identificateurs de compte de campagne ou de compte publicitaire. Ce tableau peut contenir un maximum de 100 éléments. |
tableau long |
| EntityType | Type d’entité correspondant à l’élément EntityIds spécifié. Définissez cet élément sur « Campaign » pour obtenir une liste de mot clé négative aux associations de campagne dans votre bibliothèque partagée de compte publicitaire. Définissez cet élément sur « Account » pour obtenir la liste d’exclusions de site web pour les associations de comptes publicitaires dans votre bibliothèque partagée de compte de responsable (client). |
chaîne |
| 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 aux associations de campagne. Définissez cet élément sur Client pour obtenir la liste d’exclusions de site web pour les associations de comptes publicitaires dans votre bibliothèque partagée de compte de responsable (client). |
EntityScope |
| SharedEntityType | Type d’entité partagée pour obtenir des associations. Définissez cet élément sur « NegativeKeywordList » pour obtenir une liste de mot clé négative aux associations de campagne dans votre bibliothèque partagée de compte publicitaire. Définissez cet élément sur « PlacementExclusionList » pour obtenir la liste d’exclusion de site web pour les associations de comptes publicitaires dans votre bibliothèque partagée de compte de 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 GetSharedEntityAssociationsByEntityIdsResponse 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 |
|---|---|---|
| Association | Tableau d’objets SharedEntityAssociation qui correspond directement aux identificateurs d’entité que vous avez spécifiés dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une association n’a pas été récupérée, l’élément correspondant est null. | Tableau SharedEntityAssociation |
| 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 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.
{
"EntityIds": [
"LongValueHere"
],
"EntityType": "ValueHere",
"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 BatchError est EditorialError.
{
"Associations": [
{
"EntityId": "LongValueHere",
"EntityType": "ValueHere",
"SharedEntityCustomerId": "LongValueHere",
"SharedEntityId": "LongValueHere",
"SharedEntityType": "ValueHere"
}
],
"PartialErrors": [
{
"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
}
]
}
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<GetSharedEntityAssociationsByEntityIdsResponse> GetSharedEntityAssociationsByEntityIdsAsync(
IList<long> entityIds,
string entityType,
string sharedEntityType,
EntityScope? sharedEntityScope)
{
var request = new GetSharedEntityAssociationsByEntityIdsRequest
{
EntityIds = entityIds,
EntityType = entityType,
SharedEntityType = sharedEntityType,
SharedEntityScope = sharedEntityScope
};
return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntityAssociationsByEntityIdsAsync(r), request));
}
static GetSharedEntityAssociationsByEntityIdsResponse getSharedEntityAssociationsByEntityIds(
ArrayOflong entityIds,
java.lang.String entityType,
java.lang.String sharedEntityType,
EntityScope sharedEntityScope) throws RemoteException, Exception
{
GetSharedEntityAssociationsByEntityIdsRequest request = new GetSharedEntityAssociationsByEntityIdsRequest();
request.setEntityIds(entityIds);
request.setEntityType(entityType);
request.setSharedEntityType(sharedEntityType);
request.setSharedEntityScope(sharedEntityScope);
return CampaignManagementService.getService().getSharedEntityAssociationsByEntityIds(request);
}
static function GetSharedEntityAssociationsByEntityIds(
$entityIds,
$entityType,
$sharedEntityType,
$sharedEntityScope)
{
$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];
$request = new GetSharedEntityAssociationsByEntityIdsRequest();
$request->EntityIds = $entityIds;
$request->EntityType = $entityType;
$request->SharedEntityType = $sharedEntityType;
$request->SharedEntityScope = $sharedEntityScope;
return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntityAssociationsByEntityIds($request);
}
response=campaignmanagement_service.GetSharedEntityAssociationsByEntityIds(
EntityIds=EntityIds,
EntityType=EntityType,
SharedEntityType=SharedEntityType,
SharedEntityScope=SharedEntityScope)