Cette page explique comment importer des données d'événements utilisateur passés de façon groupée. Les événements utilisateur sont requis pour les applications multimédias. Si vous n'utilisez pas d'applications multimédias, l'importation d'événements utilisateur n'est pas obligatoire. Toutefois, nous vous recommandons d'enregistrer les événements utilisateur pour les applications de recherche et de recommandations personnalisées.
Pour connaître les types d'événements utilisateur que vous pouvez importer, consultez le eventType champ de l'
userEvents objet. En important des événements utilisateur, vous pouvez améliorer la qualité de vos résultats. Par exemple, les événements utilisateur ont une incidence sur le classement des résultats de recherche. Les résultats avec des taux de clics plus élevés sont mis en avant, tandis que ceux avec des taux de clics plus faibles sont relégués au bas de la liste. N'importez que les événements utilisateur pour les documents que vous avez déjà importés dans votre data store.
Si un événement comporte des documents listés dans userEvents.Documents, la recherche d'agent joint automatiquement les événements à ce document.
La jointure permet à la recherche d'agent d'attribuer des événements tels que les clics et les vues au bon document dans un résultat de recherche ou une recommandation. Pour
les applications de recherche et de recommandations personnalisées, la jointure est asynchrone , c'est-à-dire que les événements utilisateur
sont joints aux documents une fois l'importation par lot terminée (généralement
en quelques minutes).
Pour les applications multimédias, la jointure est synchrone,
la recherche d'agent commence à joindre les événements utilisateur aux documents pendant que
l'importation par lot est toujours en cours.
Pour savoir comment afficher les métriques d'événements non joints dans la console, consultez la section
Afficher les informations agrégées concernant les événements utilisateur.
Si vous utilisez une application de recherche avec plusieurs datastores associés, importez les événements utilisateur au niveau de l'emplacement plutôt qu'au niveau du datastore. Cela permet d'envoyer un événement utilisateur donné au data store auquel il est associé. Lorsque vous importez des événements utilisateur au niveau d'un emplacement, incluez le champ engine dans l'événement utilisateur pour associer l'événement à l'application appropriée. Pour obtenir des exemples d'événements utilisateur incluant le champ engine, consultez les sections suivantes :
- Exemples et schémas de types d'événements utilisateur pour les applications personnalisées
- Exemples et schémas de types d'événements utilisateur pour les applications multimédias
Pour en savoir plus sur la méthode d'importation, consultez
userEvents.import.
Pour importer des événements utilisateur en temps réel, consultez la section Enregistrer des événements utilisateur en temps réel.
Vous pouvez importer des événements historiques de différentes manières :
Pour obtenir la représentation JSON des événements utilisateur, consultez
userEvents
dans la documentation de référence de l'API.
Avant de commencer
Avant d'importer des événements utilisateur :
- Créez un data store et une application.
- Consultez À propos des événements utilisateur multimédias ou À propos des événements utilisateur pour les applications personnalisées pour connaître les exigences concernant les événements utilisateur.
Importer des événements utilisateur historiques depuis Cloud Storage
Si vous disposez d'une application multimédia, vous pouvez importer des événements utilisateur à l'aide de la Google Cloud console ou de l'API. Pour les autres types d'applications, vous ne pouvez importer des événements qu'à l'aide de l'API.Console
Pour importer des événements utilisateur pour des applications multimédias à l'aide de la console, procédez comme suit :
Dans la Google Cloud console, accédez à la page AI Applications.
Sur la page Apps (Applications), cliquez sur votre application multimédia.
Accédez à la page Data (Données).
Pour les applications de recommandations multimédias, l'onglet Requirements (Exigences) affiche les documents multimédias et les événements utilisateur que vous devez importer.
Cliquez sur l'onglet Events (Événements). Si vous avez déjà importé des événements, des informations les concernant s'affichent dans cet onglet.
Cliquez sur Import events (Importer des événements).
Sélectionnez Cloud Storage comme source de données.
Saisissez ou sélectionnez l'emplacement Cloud Storage de vos événements utilisateur.
Cliquez sur Import (Importer).
L'onglet Activity (Activité) affiche l'état de votre importation.
Si des erreurs d'importation se produisent, dans l'onglet Activity (Activité) :
Développez l'erreur dans la colonne Details (Détails), puis cliquez sur View details (Afficher les détails) pour afficher plus d'informations dans le volet Activity log details (Détails du journal d'activité).
Dans le volet Activity log details (Détails du journal d'activité), cliquez sur View full error logs (Afficher les journaux d'erreurs complets) pour afficher l'erreur dans l'explorateur de journaux.
REST
Pour importer des événements utilisateur historiques de manière groupée depuis Cloud Storage, procédez comme suit :
Créez un ou plusieurs fichiers de données pour les paramètres d'entrée de l'importation. Utilisez l'
gcsSourceobjet pour pointer vers votre bucket Cloud Storage.{ "gcsSource": { "inputUris": ["INPUT_FILE_1", "INPUT_FILE_2"], "dataSchema": "user_event" }, "errorConfig":{ "gcsPrefix":"ERROR_DIRECTORY" } }Remplacez les éléments suivants :
INPUT_FILE: un fichier Cloud Storage contenant vos données d'événements utilisateur. Assurez-vous que chaque événement utilisateur se trouve sur sa propre ligne, sans saut de ligne. Pour obtenir la représentation JSON des événements utilisateur, consultezuserEventsdans la documentation de référence de l'API. Les champs du fichier d'entrée doivent être au format suivant :gs://<bucket>/<path-to-file>/.ERROR_DIRECTORY: facultatif. Un répertoire Cloud Storage contenant des informations sur les erreurs d'importation, par exemplegs://<your-gcs-bucket>/directory/import_errors. Google vous recommande de laisser ce champ vide pour permettre à la recherche d'agent de créer automatiquement un répertoire temporaire.
Importez vos événements en envoyant une requête POST à la
userEvents.importméthode, en indiquant le nom du fichier de données.curl -X POST \ -v \ -H "Content-Type: application/json; charset=utf-8" \ -H "Authorization: Bearer "$(gcloud auth print-access-token)"" \ --data @DATA_FILE.json \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/userEvents:import"
Importer des événements utilisateur historiques depuis BigQuery
Lorsque vous créez des tables pour des événements utilisateur dans BigQuery, utilisez les schémas
décrits dans À propos des événements utilisateur multimédias
et À propos des événements utilisateur pour les applications personnalisées.
Chaque search événement utilisateur doit inclure un engine champ pour associer l'événement à une
application. Pour en savoir plus, consultez engine.
Configurer l'accès à BigQuery
Si votre ensemble de données BigQuery se trouve dans un projet différent de celui de votre data store, procédez comme suit pour configurer l'accès à BigQuery.
- Ouvrez la page IAM et administration dans la Google Cloud console.
- Sélectionnez le projet contenant le data store dans lequel vous souhaitez importer des événements utilisateur.
- Cochez la case Inclure les attributions de rôles fournies par Google.
- Recherchez le compte de service intitulé Compte de service Discovery Engine.
- Si vous n'avez pas encore lancé d'opération d'importation avec Discovery Engine, ce compte de service peut ne pas être répertorié. Si vous ne voyez pas ce compte de service, revenez à la tâche d'importation et lancez l'importation. Si la tâche échoue en raison d'erreurs d'autorisation, revenez sur la page et cherchez à nouveau le compte de service. Le compte de service Discovery Engine s'affiche.
- Copiez l'identifiant du compte de service, qui ressemble à une adresse e-mail, par exemple
service-525@gcp-sa-discoveryengine.iam.gserviceaccount.com. - Basculez vers votre projet BigQuery (sur la même page IAM et administration), puis cliquez sur Accorder l'accès.
- Pour Nouveaux comptes principaux, saisissez l'identifiant du compte de service et sélectionnez le rôle BigQuery > Lecteur de données BigQuery.
- Cliquez sur Enregistrer.
Pour en savoir plus sur l'accès à BigQuery, consultez la section Contrôler l'accès aux ensembles de données dans la documentation BigQuery.
Importer des événements depuis BigQuery
Si vous disposez d'une application multimédia, vous pouvez importer des événements utilisateur à l'aide de la Google Cloud console ou de l'API. Pour les autres types d'applications, vous ne pouvez importer des événements qu'à l'aide de l'API.Console
Pour importer des événements utilisateur pour des applications multimédias à l'aide de la console, procédez comme suit :
Dans la Google Cloud console, accédez à la page AI Applications.
Sur la page Apps (Applications), cliquez sur votre application multimédia.
Accédez à la page Data (Données).
Pour les applications de recommandations multimédias, l'onglet Requirements (Exigences) affiche les documents multimédias et les événements utilisateur que vous devez importer.
Cliquez sur l'onglet Events (Événements). Si vous avez déjà importé des événements, des informations les concernant s'affichent dans cet onglet.
Cliquez sur Import events (Importer des événements).
Sélectionnez BigQuery comme source de données.
Saisissez ou sélectionnez le chemin d'accès BigQuery pour vos événements utilisateur.
Cliquez sur Import (Importer).
L'onglet Activity (Activité) affiche l'état de votre importation.
Si des erreurs d'importation se produisent, dans l'onglet Activity (Activité) :
Développez l'erreur dans la colonne Details (Détails), puis cliquez sur View details (Afficher les détails) pour afficher plus d'informations dans le volet Activity log details (Détails du journal d'activité).
Dans le volet Activity log details (Détails du journal d'activité), cliquez sur View full error logs (Afficher les journaux d'erreurs complets) pour afficher l'erreur dans l'explorateur de journaux.
REST
Pour importer des événements utilisateur historiques de manière groupée depuis BigQuery, procédez comme suit :
Importez vos événements utilisateur en envoyant une requête POST à la
userEvents.importméthode, en indiquant le nom du projet BigQuery, l'ID de l'ensemble de données et l'ID de la table.Lorsque vous importez vos événements, utilisez la valeur
user_eventpourdataSchema.curl \ -v \ -X POST \ -H "Content-Type: application/json; charset=utf-8" \ -H "Authorization: Bearer "$(gcloud auth print-access-token)"" \ "https://discoveryengine.googleapis.com/v1/projects/[PROJECT_NUMBER]/locations/global/userEvents:import" \ --data '{ "bigquerySource": { "projectId":"PROJECT_ID", "datasetId": "DATASET_ID", "tableId": "TABLE_ID", "dataSchema": "user_event" } }'
Importer des événements utilisateur historiques en tant que données JSON locales
Vous pouvez importer des événements utilisateur en incluant des données JSON locales pour les
événements dans votre appel à la userEvents.import méthode.
Pour placer des données d'événements utilisateur dans un fichier JSON et spécifier le fichier dans une requête API, procédez comme suit :
Créez un fichier JSON contenant vos données d'événements utilisateur. Pour obtenir la représentation JSON des événements utilisateur, consultez
userEventsdans la documentation de référence de l'API.{ "inlineSource": { "userEvents": [ { USER_EVENT_1 }, { USER_EVENT_2 } ] } }Importez vos événements en envoyant une requête POST à la
userEvents.importméthode, en indiquant le nom du fichier de données.curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ --data @[JSON_FILE] \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_NUMBER/locations/global/userEvents:import"