Cette page explique comment afficher, modifier, supprimer, exporter et importer des commandes de diffusion.
Pour obtenir des informations générales sur les commandes de diffusion et des instructions sur la façon de créer des commandes de diffusion, consultez À propos des commandes de diffusion et Créer des commandes de diffusion.
Afficher et modifier des commandes de diffusion
Vous pouvez afficher les commandes de diffusion pour Vertex AI Search pour le commerce à l'aide de la console et de l'API.
Afficher et modifier des commandes de diffusion dans la console
L'onglet Commandes de diffusion de la page "Contrôles" répertorie toutes vos commandes de diffusion ainsi que les configurations de diffusion associées. Cliquez sur l'icône editModifier la commande pour modifier ses paramètres et les configurations de diffusion associées dans le panneau Modifier la commande. Cliquez sur l'icône deleteSupprimer la commande pour la supprimer, ce qui la supprime également de toutes les configurations de diffusion.
Vous pouvez également consulter et modifier les commandes d'une configuration de diffusion spécifique sur la page Configurations de diffusion. Cliquez sur une configuration de diffusion pour afficher sa page Détails, qui répertorie toutes les commandes de diffusion pour cette configuration. Cliquez sur l'icône editModifier la commande pour modifier ses paramètres dans le panneau Modifier la commande. Cliquez sur l'icône do_not_disturb_onSupprimer la commande pour dissocier la commande de la configuration de diffusion (cela ne supprime pas la commande).
Il faut quelques minutes pour que les commandes nouvellement créées ou mises à jour puissent diffuser le trafic en direct. Vous pouvez vérifier si vos modifications ont été appliquées sur la page Évaluer de la console.
Afficher les commandes de diffusion en ligne
Pour afficher une seule commande de diffusion en ligne, utilisez Control.get.
Pour en savoir plus sur cette méthode, consultez la
Control.get documentation de référence de l'API.
curl -X GET \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ 'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID'
Pour répertorier plusieurs commandes de diffusion en ligne, utilisez Controls.list.
Vous pouvez également utiliser le paramètre pageSize pour définir un nombre maximal de résultats à renvoyer. Si d'autres résultats sont disponibles, la réponse list inclut un jeton de page. Vous pouvez transmettre un jeton de page dans le paramètre pageToken d'une requête list pour récupérer la page de résultats suivante.
Pour ne répertorier que les commandes associées à une configuration de diffusion spécifique, utilisez le paramètre de requête filter pour spécifier l'ID de la configuration de diffusion.
Pour en savoir plus sur cette méthode, consultez la documentation de référence de l'API
Control.list.
curl -X GET \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ 'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN&filter=servingConfig=SERVING_CONFIG_ID
Appliquer un correctif aux commandes de diffusion en ligne
Pour mettre à jour des champs dans une commande de diffusion, utilisez Controls.patch
et incluez une instance de Control dans le corps de la requête. Spécifiez les champs à mettre à jour avec le paramètre updateMask, ou laissez-le non défini pour mettre à jour tous les champs compatibles.
Pour en savoir plus sur cette méthode, consultez la documentation de référence de l'API
Controls.patch.
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d '{ "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID", "FIELD_NAME_1": "NEW_FIELD_VALUE_1" "FIELD_NAME_2": "NEW_FIELD_VALUE_2" }' \ 'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID?updateMask=FIELD_NAME_1,FIELD_NAME_2'
Ajouter des commandes aux configurations de diffusion en ligne
Pour ajouter une commande à une configuration de diffusion, utilisez ServingConfig.addControl.
Pour en savoir plus sur cette méthode, consultez la
ServingConfig.addControl documentation de référence de l'API.
Pour obtenir un exemple de cette méthode, consultez Gérer les configurations de diffusion.
Supprimer des commandes des configurations de diffusion en ligne
Pour supprimer une commande d'une configuration de diffusion, utilisez ServingConfig.removeControl.
Pour en savoir plus sur cette méthode, consultez la
ServingConfig.addControl documentation de référence de l'API.
Pour obtenir un exemple de cette méthode, consultez Gérer les configurations de diffusion.
Supprimer une commande de diffusion
Vous pouvez supprimer une commande de diffusion à partir de la console ou en ligne à l'aide de la méthode Controls.delete.
Supprimer une commande de diffusion dans la console
Supprimez une commande de diffusion pour la supprimer de toutes les configurations de diffusion qui l'utilisent.
Accédez à la page Contrôles dans la console Search pour le commerce.
Accéder à la page "Contrôles"Dans la ligne du tableau correspondant au contrôle que vous souhaitez supprimer, cliquez sur deleteSupprimer.
Dans la fenêtre de confirmation, cliquez sur Supprimer pour terminer la suppression.
Supprimer une commande de diffusion en ligne
Pour supprimer des commandes de diffusion en ligne, utilisez Controls.delete.
Pour en savoir plus sur cette méthode, consultez la
Controls.delete documentation de référence de l'API.
curl -X DELETE \ -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ 'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/SERVING_CONTROL_ID'
Exporter des commandes de diffusion
Vous pouvez exporter vos commandes de diffusion vers un fichier dans un bucket Cloud Storage.
Vous pouvez exporter et importer des commandes de diffusion pour deux raisons :
Pour déplacer des commandes de diffusion d'un projet à un autre.
Pour effectuer une modification groupée sur tout ou partie des commandes de diffusion. Exportez les commandes de diffusion, modifiez le fichier exporté, puis importez-le pour modifier ou ajouter des commandes de diffusion.
Vous pouvez exporter et importer des commandes de diffusion via la console Search pour le commerce. Lorsque vous exportez des commandes de diffusion, vous exportez toutes les commandes de diffusion du projet.
Pour exporter des commandes de diffusion, procédez comme suit :
Accédez à la page Contrôles dans la console Search pour le commerce.
Accéder à la page "Contrôles"Dans l'onglet Commandes de diffusion, cliquez sur Exporter les commandes.
Dans la fenêtre Exporter les commandes de diffusion, sélectionnez le bucket Cloud Storage dans lequel vous souhaitez exporter le fichier de commandes.
Cliquez sur Exporter.
Les commandes exportées sont enregistrées dans un fichier NDJSON dans le bucket sélectionné avec un nom au format suivant :
projects_PROJECT_ID_TIMESTAMP_exported_controls.ndjson
Une fois l'opération d'exportation terminée, vous pouvez afficher son état dans la liste Activités d'importation, d'exportation et de suppression groupées de la fenêtre Activité d'exportation. Ouvrez la fenêtre Activité d'exportation en cliquant sur Afficher dans la fenêtre de message ou en suivant les instructions de la section Afficher l'état d'une opération d'intégration spécifique.
Importer des commandes de diffusion
Pour ajouter des commandes de diffusion ou modifier des commandes existantes en bloc, vous pouvez apporter vos modifications dans un fichier de commandes exporté. Vous pouvez ensuite les importer dans le projet d'origine ou dans un autre projet.
Points à connaître concernant l'importation de commandes de diffusion :
Vous ne pouvez pas importer un fichier de commandes de diffusion s'il contient à la fois des commandes de diffusion de recherche et de recommandations.
Lorsque vous importez des commandes de diffusion, toutes les commandes de diffusion du fichier sont associées à la configuration de diffusion que vous spécifiez lors de l'importation. Si une commande de diffusion est déjà associée à une autre configuration de diffusion dans le projet, cette association est également conservée.
Pour importer des commandes de diffusion, procédez comme suit :
Modifiez et examinez un fichier de commandes de diffusion exporté, puis placez-le dans un bucket Cloud Storage. (Pour exporter des commandes de diffusion, consultez la tâche précédente Exporter des commandes de diffusion.)
Assurez-vous que le fichier ne contient que des commandes de diffusion de recherche ou uniquement des commandes de diffusion de recommandations. Vous ne pouvez pas importer un fichier contenant les deux types.
Accédez à la page Contrôles dans la console Search pour le commerce.
Accéder à la page "Contrôles"Dans l'onglet Commandes de diffusion, cliquez sur Importer les commandes.
Dans la fenêtre Importer les commandes de diffusion :
Parcourez et sélectionnez le bucket Cloud Storage et le fichier NDJSON contenant les commandes que vous souhaitez importer.
Sélectionnez la configuration de diffusion à laquelle vous souhaitez associer les commandes de diffusion importées.
Examinez le plan d'aperçu de l'importation. Les commandes qui seront créées s'affichent dans l'onglet Nouveau , et celles qui seront modifiées dans l'onglet Modifié.
Cliquez sur Importer.
Une opération de longue durée est lancée pour importer les commandes nouvelles et modifiées.
Une fois l'opération d'importation terminée, vous pouvez afficher son état dans l'onglet Commandes de la fenêtre État de l'activité. Ouvrez la fenêtre État de l'activité en cliquant sur Afficher dans la fenêtre de message ou en suivant les instructions de la section Afficher l'état d'une opération d'intégration spécifique.