Partager via


Opération de service GetLabelAssociationsByLabelIds - Gestion des campagnes

Obtient les associations d’étiquettes par identificateurs d’étiquette.

Éléments de demande

L’objet GetLabelAssociationsByLabelIdsRequest 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
EntityType Filtre les associations retournées par type d’entité.

Les valeurs de type d’entité prises en charge sont Campaign, AdGroup, Ad et Keyword.
EntityType
LabelIds Liste des identificateurs d’étiquette utilisés pour demander des associations d’étiquettes.

Vous devez inclure exactement un identificateur d’étiquette dans la liste.
tableau long
PageInfo Détermine l’index et la taille des résultats d’association d’étiquettes par page.

Jusqu’à 1 000 associations d’étiquettes seront retournées par page, vous devrez peut-être demander plusieurs pages pour obtenir toutes les associations d’étiquettes.

Si cet élément n’est pas spécifié, l’index de la page defaut est 0 et la valeur par défaut Size est 1 000.
Pagination

É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 GetLabelAssociationsByLabelIdsResponse 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
LabelAssociations Tableau d’associations d’étiquettes.

Pour chaque identificateur d’étiquette spécifié dans la requête, aucun ou plusieurs objets LabelAssociation sont retournés. Alors que l’ordre des objets LabelAssociation retournés est garanti dans l’ordre des identificateurs d’étiquette demandés, notez que plusieurs objets LabelAssociation peuvent être retournés pour le même identificateur d’étiquette. Les identificateurs d’entité sont dans l’ordre croissant pour les associations d’une étiquette donnée.

Il est possible de recevoir des associations en double sur plusieurs pages. Vous devez donc case activée pour les résultats en double.
LabelAssociation array
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour toutes les associations qui n’ont pas été récupérées avec succès.

La liste des erreurs correspond directement à la liste des associations dans la requête. Les éléments de la liste peuvent être retournés comme null. Pour chaque index de liste où une association a été récupérée avec succès, l’élément error correspondant est null. Dans l’idéal, toutes les associations sont récupérées correctement et tous les éléments de cette liste sont null.
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">GetLabelAssociationsByLabelIds</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>
    <GetLabelAssociationsByLabelIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityType>ValueHere</EntityType>
      <LabelIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LabelIds>
      <PageInfo i:nil="false">
        <Index>ValueHere</Index>
        <Size>ValueHere</Size>
      </PageInfo>
    </GetLabelAssociationsByLabelIdsRequest>
  </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>
    <GetLabelAssociationsByLabelIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <LabelAssociations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <LabelAssociation>
          <EntityId>ValueHere</EntityId>
          <LabelId>ValueHere</LabelId>
        </LabelAssociation>
      </LabelAssociations>
      <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:e156="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e156:KeyValuePairOfstringstring>
              <e156:key d4p1:nil="false">ValueHere</e156:key>
              <e156:value d4p1:nil="false">ValueHere</e156:value>
            </e156: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>
    </GetLabelAssociationsByLabelIdsResponse>
  </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<GetLabelAssociationsByLabelIdsResponse> GetLabelAssociationsByLabelIdsAsync(
	EntityType entityType,
	IList<long> labelIds,
	Paging pageInfo)
{
	var request = new GetLabelAssociationsByLabelIdsRequest
	{
		EntityType = entityType,
		LabelIds = labelIds,
		PageInfo = pageInfo
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetLabelAssociationsByLabelIdsAsync(r), request));
}
static GetLabelAssociationsByLabelIdsResponse getLabelAssociationsByLabelIds(
	EntityType entityType,
	ArrayOflong labelIds,
	Paging pageInfo) throws RemoteException, Exception
{
	GetLabelAssociationsByLabelIdsRequest request = new GetLabelAssociationsByLabelIdsRequest();

	request.setEntityType(entityType);
	request.setLabelIds(labelIds);
	request.setPageInfo(pageInfo);

	return CampaignManagementService.getService().getLabelAssociationsByLabelIds(request);
}
static function GetLabelAssociationsByLabelIds(
	$entityType,
	$labelIds,
	$pageInfo)
{

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

	$request = new GetLabelAssociationsByLabelIdsRequest();

	$request->EntityType = $entityType;
	$request->LabelIds = $labelIds;
	$request->PageInfo = $pageInfo;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetLabelAssociationsByLabelIds($request);
}
response=campaignmanagement_service.GetLabelAssociationsByLabelIds(
	EntityType=EntityType,
	LabelIds=LabelIds,
	PageInfo=PageInfo)

Configuration requise

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