Partager via

Opération de service ApplyAssetGroupListingGroupActions - Gestion des campagnes

  • Article

Applique une action à un groupe de référencements de groupe de ressources.

Notez les règles de validation suivantes :

  • Au minimum, vous devez spécifier au moins le nœud racine pour l’arborescence de groupes de listes. La racine du groupe de référencements AssetGroupListingGroup doit avoir sa condition Operand définie sur « All » et Attribute sur Null. Si vous distribuez des publicités pour tous les produits du catalogue, définissez partitionType sur « Unit ». Si vous distribuez des publicités sur des conditions de produit plus spécifiques, définissez YPartitionTypeY sur « Subdivision », parentCriterionId sur null et Id sur une valeur négative. Vous utiliserez la valeur négative en tant que ParentCriterionId pour tous les nœuds enfants.

  • Le nœud racine est considéré comme un niveau 0, et une arborescence peut avoir des branches allant jusqu’à 7 niveaux de profondeur.

  • Vous pouvez spécifier jusqu’à 5 000 objets AssetGroupListingGroupAction par appel. L’arborescence entière créée par le biais de plusieurs appels peut avoir jusqu’à 20 000 nœuds.

  • Chacun des objets AssetGroupListingGroup doit avoir le même AssetGroupId, sinon l’appel échoue.

  • Pour mettre à jour les propriétés Condition ou Attribut , vous devez supprimer le nœud d’arborescence de partition de produit existant et ajouter un nouveau nœud d’arborescence de partition de produit qui obtiendra un nouvel identificateur. Pour effectuer une mise à jour d’un élément non exclu vers un AssetGroupListingGroup exclu ou inversement, vous devez supprimer le nœud d’arborescence de partition de produit existant et ajouter un nouveau nœud d’arborescence de partition de produit qui obtiendra un nouvel identificateur.

  • En cas d’échec d’une action, toutes les actions restantes qui auraient pu autrement avoir réussi échouent également.

  • Toutes les actions d’un appel doivent aboutir à une arborescence complète. Si vous devez appliquer plus de 5 000 actions par groupe de ressources, vous devez effectuer plusieurs appels. Obtenez les identificateurs du groupe de ressources parents à partir du premier appel, puis ajoutez d’autres enfants en fonction des besoins dans les appels suivants.

  • Chaque chemin d’accès du nœud racine à la fin d’une branche doit se terminer par un nœud feuille (ProductPartitionType=Unit).

  • Chaque sous-division doit avoir au moins un nœud feuille pour le reste des conditions de la sous-division. Par exemple, utilisez le même opérande que ses unités frères et définissez son attribut sur null.

  • Vous pouvez uniquement spécifier un nœud enfant après son parent.

  • Si vous ajoutez des partitions avec plusieurs niveaux où ni le parent ni l’enfant n’existe encore, utilisez une valeur int négative comme référence pour identifier le parent. Par exemple, définissez l’ID du parent et l’élément ParentListingGroupId de l’enfant sur la même valeur négative. Les ID négatifs ne sont valides que pour la durée de l’appel. Les identificateurs système uniques pour chaque groupe de listes de groupes de ressources ajoutés avec succès sont retournés dans le message de réponse.

  • Pour suspendre une partition de produit, vous devez suspendre l’ensemble du groupe de ressources en appelant UpdateAssetGroups. Vous pouvez appeler UpdateCampaigns pour suspendre la campagne entière.

  • Pour une action Supprimer, vous devez uniquement spécifier l’ID et l’AssetGroupId dans assetGroupListingGroup.

  • Si vous supprimez une partition de produit parent, tous ses enfants et descendants sont également supprimés.

  • Vous ne pouvez pas spécifier de conditions de produit en double dans une branche.

Éléments de demande

L’objet ApplyAssetGroupListingGroupActionsRequest 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
ListingGroupActions Liste d’objets AssetGroupListingGroupAction qui contiennent chacun un élément Action et un élément ListingGroup . Toutes les actions de groupe de référencement de groupe de ressources doivent être pour le même groupe de ressources.

Vous pouvez passer 5 000 AssetGroupListingGroupAction par appel et appliquer un maximum de 20 000 groupes de référencement à chaque groupe de ressources.		 Tableau AssetGroupListingGroupAction

É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 ApplyAssetGroupListingGroupActionsResponse 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
AssetGroupListingGroupIds Liste des ID correspondant aux groupes de liste auxquels l’action a été appliquée. La liste des ID correspond directement à la liste des groupes listants dans la demande.

Si une action de groupe de liste a échoué, toutes les actions de groupe de référencement restantes échouent et tous les éléments de cette liste sont null.		 tableau long
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi. 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">ApplyAssetGroupListingGroupActions</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>
    <ApplyAssetGroupListingGroupActionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListingGroupActions i:nil="false">
        <AssetGroupListingGroupAction>
          <Action>ValueHere</Action>
          <ListingGroup i:nil="false">
            <AssetGroupId>ValueHere</AssetGroupId>
            <AssetGroupListingType>ValueHere</AssetGroupListingType>
            <Dimension i:nil="false">
              <Attribute i:nil="false">ValueHere</Attribute>
              <Operand i:nil="false">ValueHere</Operand>
              <Operator i:nil="false">ValueHere</Operator>
            </Dimension>
            <Id i:nil="false">ValueHere</Id>
            <IsExcluded>ValueHere</IsExcluded>
            <ParentListingGroupId i:nil="false">ValueHere</ParentListingGroupId>
          </ListingGroup>
        </AssetGroupListingGroupAction>
      </ListingGroupActions>
    </ApplyAssetGroupListingGroupActionsRequest>
  </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>
    <ApplyAssetGroupListingGroupActionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AssetGroupListingGroupIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </AssetGroupListingGroupIds>
      <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:e131="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e131:KeyValuePairOfstringstring>
              <e131:key d4p1:nil="false">ValueHere</e131:key>
              <e131:value d4p1:nil="false">ValueHere</e131:value>
            </e131: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>
    </ApplyAssetGroupListingGroupActionsResponse>
  </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<ApplyAssetGroupListingGroupActionsResponse> ApplyAssetGroupListingGroupActionsAsync(
	IList<AssetGroupListingGroupAction> listingGroupActions)
{
	var request = new ApplyAssetGroupListingGroupActionsRequest
	{
		ListingGroupActions = listingGroupActions
	};

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

static ApplyAssetGroupListingGroupActionsResponse applyAssetGroupListingGroupActions(
	ArrayOfAssetGroupListingGroupAction listingGroupActions) throws RemoteException, Exception
{
	ApplyAssetGroupListingGroupActionsRequest request = new ApplyAssetGroupListingGroupActionsRequest();

	request.setListingGroupActions(listingGroupActions);

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

static function ApplyAssetGroupListingGroupActions(
	$listingGroupActions)
{

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

	$request = new ApplyAssetGroupListingGroupActionsRequest();

	$request->ListingGroupActions = $listingGroupActions;

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

response=campaignmanagement_service.ApplyAssetGroupListingGroupActions(
	ListingGroupActions=ListingGroupActions)

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/AssetGroupListingGroupActions/Apply

Éléments de demande

L’objet ApplyAssetGroupListingGroupActionsRequest 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
ListingGroupActions Liste d’objets AssetGroupListingGroupAction qui contiennent chacun un élément Action et un élément ListingGroup . Toutes les actions de groupe de référencement de groupe de ressources doivent être pour le même groupe de ressources.

Vous pouvez passer 5 000 AssetGroupListingGroupAction par appel et appliquer un maximum de 20 000 groupes de référencement à chaque groupe de ressources.		 Tableau AssetGroupListingGroupAction

É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 ApplyAssetGroupListingGroupActionsResponse 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
AssetGroupListingGroupIds Liste des ID correspondant aux groupes de liste auxquels l’action a été appliquée. La liste des ID correspond directement à la liste des groupes listants dans la demande.

Si une action de groupe de liste a échoué, toutes les actions de groupe de référencement restantes échouent et tous les éléments de cette liste sont null.		 tableau long
PartialErrors Tableau d’objets BatchError qui contiennent des détails pour tous les éléments de demande qui n’ont pas réussi. 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.

{
  "ListingGroupActions": [
    {
      "Action": "ValueHere",
      "ListingGroup": {
        "AssetGroupId": "LongValueHere",
        "AssetGroupListingType": "ValueHere",
        "Dimension": {
          "Attribute": "ValueHere",
          "Operand": "ValueHere",
          "Operator": "ValueHere"
        },
        "Id": "LongValueHere",
        "IsExcluded": "ValueHere",
        "ParentListingGroupId": "LongValueHere"
      }
    }
  ]
}

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.

{
  "AssetGroupListingGroupIds": [
    "LongValueHere"
  ],
  "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<ApplyAssetGroupListingGroupActionsResponse> ApplyAssetGroupListingGroupActionsAsync(
	IList<AssetGroupListingGroupAction> listingGroupActions)
{
	var request = new ApplyAssetGroupListingGroupActionsRequest
	{
		ListingGroupActions = listingGroupActions
	};

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

static ApplyAssetGroupListingGroupActionsResponse applyAssetGroupListingGroupActions(
	ArrayOfAssetGroupListingGroupAction listingGroupActions) throws RemoteException, Exception
{
	ApplyAssetGroupListingGroupActionsRequest request = new ApplyAssetGroupListingGroupActionsRequest();

	request.setListingGroupActions(listingGroupActions);

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

static function ApplyAssetGroupListingGroupActions(
	$listingGroupActions)
{

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

	$request = new ApplyAssetGroupListingGroupActionsRequest();

	$request->ListingGroupActions = $listingGroupActions;

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

response=campaignmanagement_service.ApplyAssetGroupListingGroupActions(
	ListingGroupActions=ListingGroupActions)