Ce document concerne Recommendations AI, Retail Search et la nouvelle console Retail.

Avant de commencer

Créer un projet Google Cloud

  1. Sur la page Gérer les ressources de la console, sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Gérer les ressources"

  2. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier si la facturation est activée sur un projet.

Configurer l'API Retail

Pour utiliser l'API Retail et l'IA de recommandations, vous devez activer l'API Retail et accepter les Conditions d'utilisation des données Discovery Solutions. Si vous utilisez également Retail Search, vous devez l'activer. L'utilisation de Retail Search entraîne des coûts supplémentaires en fonction du nombre de requêtes. Pour en savoir plus, consultez la section Frais Retail Search.

Pour configurer l'API Retail, procédez comme suit:

  1. Accédez à la page Commerce de détail de la console.

    Accéder à la page "Commerce"

  2. Sur la page Configurer l'API Retail, cliquez sur Activer l'API.

  3. Lorsque les options API Retail et Recommandations IA s'affichent comme Activées, cliquez sur Continuer.

  4. Lisez les Conditions d'utilisation des données des solutions Discovery, puis cliquez sur Accepter si vous les acceptez.

    Lorsque vous acceptez les conditions d'utilisation des données, la console indique que les conditions d'utilisation des données par Retail API sont acceptées.

  5. Si vous souhaitez utiliser le projet avec Recommendations AI uniquement, cliquez sur Commencer.

  6. Si vous souhaitez activer Retail Search en plus de Recommendations AI, procédez comme suit:

    1. Sur la page Activer la recherche pour les marchands (facultatif), cliquez sur Continuer, puis sur Activer.
    2. Cliquez sur Commencer.

La console affiche les composants de l'API Retail que vous avez activés. Vous pouvez désormais configurer les paramètres initiaux de votre projet.

Configurer l'API Retail pour un projet existant

Si vous avez configuré l'API Retail pour un projet Google Cloud avant l'entrée en vigueur des conditions d'utilisation des données le 4 avril 2022, vous devez accepter les conditions d'utilisation de Discovery Solutions pour continuer à utiliser l'API Retail avec ce projet. Vous devez également activer Retail Search pour ce projet, si nécessaire.

Pour accepter les conditions d'utilisation des données des solutions Discovery pour un projet existant, procédez comme suit:

  1. Accédez à la page Commerce de détail de la console de votre projet.

    Accéder à la page "Commerce"

  2. Sur la page Conditions d'utilisation des données, consultez les conditions d'utilisation des données Discovery Solutions et cliquez sur Accepter si vous les acceptez.

  3. Si vous souhaitez utiliser le projet avec Recommendations AI uniquement, cliquez sur Commencer.

  4. Si vous souhaitez activer Retail Search en plus de Recommendations AI, procédez comme suit:

    1. Sur la page Activer la recherche pour les marchands (facultatif), cliquez sur Continuer, puis sur Activer.
    2. Cliquez sur Commencer.

Désactiver Retail Search ou l'API Retail

Désactiver Retail Search

Si vous ne souhaitez plus utiliser le moteur de recherche, vous pouvez envoyer une demande d'assistance.

Pour définir votre demande d'assistance pour le composant approprié, sélectionnez les champs suivants:

  • Catégorie : Machine Learning
  • Composant: Solutions pour le commerce: Retail Search
  • Sous-composant : "Administration du compte", "Facturation"

Pour en savoir plus sur la création d'une demande d'assistance, consultez la page Obtenir de l'aide.

Désactiver Retail API

Vous pouvez la désactiver à tout moment en la désactivant et dans Recommendations AI. Cela désactive également Retail Search.

Pour désactiver l'API Retail, procédez comme suit:

  1. Accédez à la page Détails du service API Retail dans la console.

    Accéder à la page d'informations sur le service de l'API Retail

  2. Cliquez sur Désactiver l'API.

  3. Dans la zone Désactiver l'API Retail, cliquez sur Désactiver.

  4. Dans la zone Désactiver les recommandations ?, cliquez sur Désactiver.

Premiers pas avec l'API Retail

Lorsque vous configurez l'API Retail pour un nouveau projet, Google Cloud Console affiche les trois panneaux suivants pour vous aider à configurer le projet de l'API Retail:

  • Catalogue : affiche votre catalogue de produits et un lien d'importation.

  • Événement: affiche les événements utilisateur et un lien permettant d'importer l'historique des événements utilisateur.

  • Configurations de diffusion : contient des informations sur votre configuration de diffusion et un lien permettant de créer une configuration de diffusion.

Vous pouvez utiliser ces panneaux pour importer vos données et créer une configuration initiale pour votre projet d'API Retail.

Importer votre catalogue de produits

Pour importer votre catalogue de produits, suivez la procédure correspondante pour votre source de données. Pour en savoir plus sur les catalogues de produits, consultez la page Importer des informations sur les catalogues.

Synchronisation Merchant Center

  1. Cliquez sur Import product catalog (Importer le catalogue de produits) pour ouvrir le panneau Import Data (Importer les données).
  2. Sélectionnez Catalogue de produits.
  3. Sélectionnez Merchant Center Sync comme source de données.
  4. Sélectionnez votre compte Merchant Center.
  5. Sélectionnez la branche dans laquelle vous allez importer votre catalogue.
  6. Cliquez sur Importer.

Cloud Storage

  1. Cliquez sur Import product catalog (Importer le catalogue de produits) pour ouvrir le panneau Import Data (Importer les données).
  2. Choisissez Catalogue de produits comme source de données.
  3. Sélectionnez la branche dans laquelle vous allez importer votre catalogue.
  4. Choisissez le schéma Commerce Product Catalogs Schema.
  5. Saisissez l'emplacement Cloud Storage de vos données.
  6. Si la recherche de détail n'est pas activée, sélectionnez les niveaux de produit.

    Vous devez sélectionner les niveaux de produit si vous importez votre catalogue pour la première fois ou si vous le réimportez après l'avoir supprimé. En savoir plus sur les niveaux de produit Modifier les niveaux de produit après avoir importé des données nécessite un effort considérable.

    Important : Vous ne pouvez pas activer Retail Search pour les projets dont le catalogue de produits a été ingéré en tant que variantes.
  7. Cliquez sur Importer.

BigQuery

  1. Cliquez sur Import product catalog (Importer le catalogue de produits) pour ouvrir le panneau Import Data (Importer les données).
  2. Sélectionnez Catalogue de produits.
  3. Sélectionnez BigQuery comme source de données.
  4. Sélectionnez la branche dans laquelle vous allez importer votre catalogue.
  5. Choisissez l'un des schémas suivants :
  6. Renseignez la table BigQuery dans laquelle se trouvent vos données.
  7. (Facultatif) Sous Afficher les options avancées, saisissez l'emplacement d'un bucket Cloud Storage dans votre projet en tant qu'emplacement temporaire de vos données.

    Si aucune valeur n'est spécifiée, un emplacement par défaut est utilisé. Si cet attribut est spécifié, le bucket BigQuery et Cloud Storage doivent se trouver dans la même région.
  8. Si vous n'avez pas activé Retail Search et que vous utilisez le schéma Merchant Center, sélectionnez le niveau de produit.

    Vous devez sélectionner le niveau de produit si vous importez le catalogue pour la première fois ou si vous le réimportez après l'avoir supprimé. En savoir plus sur les niveaux de produit Modifier les niveaux de produit après avoir importé des données nécessite un effort considérable.

    Important:Vous ne pouvez pas activer Retail Search pour les projets dont le catalogue de produits a été ingéré en tant que variantes.
  9. Cliquez sur Importer.

Importer les événements utilisateur historiques

Pour importer vos événements utilisateur historiques, suivez la procédure correspondante pour votre source de données. Pour en savoir plus sur les événements utilisateur historiques, consultez Importer des événements utilisateur historiques.

Cloud Storage

  1. Cliquez sur Import user events (Importer les événements utilisateur) pour ouvrir le panneau Import Data (Importer les données).
  2. Sélectionnez Événements utilisateur.
  3. Sélectionnez Google Cloud Storage en tant que source de données.
  4. Choisissez le schéma Commerce des événements de l'utilisateur.
  5. Saisissez l'emplacement Cloud Storage de vos données.
  6. Cliquez sur Importer.

BigQuery

  1. Cliquez sur Import user events (Importer les événements utilisateur) pour ouvrir le panneau Import Data (Importer les données).
  2. Sélectionnez Événements utilisateur.
  3. Sélectionnez BigQuery comme source de données.
  4. Choisissez le schéma Commerce des événements de l'utilisateur.
  5. Renseignez la table BigQuery dans laquelle se trouvent vos données.
  6. (Facultatif) Indiquez l'emplacement d'un bucket Cloud Storage dans votre projet en tant qu'emplacement temporaire de vos données.
    Si ce paramètre n'est pas spécifié, un emplacement par défaut est utilisé. Si cet attribut est spécifié, le bucket BigQuery et Cloud Storage doivent se trouver dans la même région.
  7. (Facultatif) Sous Afficher les options avancées, saisissez l'emplacement d'un bucket Cloud Storage dans votre projet en tant qu'emplacement temporaire de vos données.

    Si aucune valeur n'est spécifiée, un emplacement par défaut est utilisé. Si cet attribut est spécifié, le bucket BigQuery et Cloud Storage doivent se trouver dans la même région.
  8. Cliquez sur Importer.

Créer une configuration de diffusion

Une configuration d'inférence est une entité de diffusion qui associe un modèle ou un ensemble de commandes permettant de générer des résultats de recherche ou de recommandations.

Pour créer une configuration de diffusion, procédez comme suit:

  1. Dans le panneau Configurations de diffusion, cliquez sur Créer une configuration de diffusion.
  2. Sur la page Créer une configuration de diffusion, sélectionnez Rechercher comme produit de configuration de diffusion.
  3. Indiquez un nom pour la configuration de diffusion.

    Le nom ne doit pas comporter plus de 1 024 caractères. Il ne peut contenir que des caractères alphanumériques, des traits de soulignement, des traits d'union et des espaces.
  4. (Facultatif) Mettez à jour l'ID, si nécessaire.

    Il est généré à partir du nom que vous fournissez et doit être unique dans votre projet. Il doit comporter 50 caractères au maximum et ne peut pas contenir d'espaces.
  5. Cliquez sur Continuer.
  6. Indiquez si vous souhaitez activer l'attribut dynamique pour cette configuration de diffusion.
  7. Choisissez ou créez des commandes de diffusion pour optimiser vos recherches.

    Pour en savoir plus sur les commandes, consultez la page Créer et gérer des commandes.

Tableau de bord Vente au détail

Une fois la configuration initiale du projet terminée, la console Retail affiche l'état du système de votre projet d'API Retail. La console Commerce vous permet de gérer les ressources Retail et de surveiller son activité.

Accéder à la console Retail

Pour en savoir plus sur la console Retail, consultez la page Console d'administration commerciale.

Configurer l'authentification pour votre application

Vous devez configurer les deux méthodes d'authentification suivantes pour accéder à l'API Retail :

Créer un compte de service

  1. Accédez à la page Identifiants de la console.

  2. Sélectionnez le projet pour lequel vous créez des identifiants (il est peut-être déjà sélectionné).

  3. Cliquez sur Créer des identifiants, puis sélectionnez Clé de compte de service.

  4. Renseignez les champs suivants :

    Champ Value
    Compte de service Nouveau compte de service
    Service account name (Nom du compte de service) enter a name for your service account
    Rôle Comptes de service > Créateur de jetons du compte de service
    Retail > Éditeur Retail
    Type de clé JSON
  5. Cliquez sur Créer pour créer le compte de service.

    Le fichier JSON contenant la clé publique/privée du nouveau compte de service est automatiquement téléchargé sur votre ordinateur. Ce fichier JSON constitue la seule copie de la clé associée à votre compte de service. Assurez-vous de le conserver en lieu sûr. Le fichier de clé JSON doit être stocké dans un emplacement accessible depuis votre application (voir your-service-account-json-key-file dans S'authentifier à l'aide d'un compte de service (OAuth 2.0)).

Ajouter le compte de service à votre environnement local

Si vous souhaitez appeler l'API du Réseau de Recherche pour le commerce à l'aide de l'outil de ligne de commande cURL, vous devez rendre votre compte de service disponible dans votre environnement local. cURL utilise la commande gcloud auth application-default print-access-token pour obtenir un jeton d'accès à votre compte de service à l'aide de la CLI Google Cloud. Pour télécharger et installer la CLI gcloud, consultez la page CLI gcloud. Si vous utilisez Cloud Shell, la CLI gcloud est déjà installée.

La variable d'environnement GOOGLE_APPLICATION_CREDENTIALS ne sera pas conservée si vous fermez votre fenêtre de commande. Pour vous assurer que la variable est définie sur le chemin d'accès au fichier de votre compte de service à chaque ouverture d'une nouvelle fenêtre de commande, définissez la valeur dans un script shell d'initialisation.

  export GOOGLE_APPLICATION_CREDENTIALS=path-to-service-account-json-key-file

Créer une clé API

  1. Accédez à la page Identifiants de la console.

  2. Dans la liste déroulante des projets en haut de la page Google Cloud Console, sélectionnez votre projet (il est peut-être déjà sélectionné).

  3. Cliquez sur Créer des identifiants, puis sélectionnez Clé API. N'ajoutez aucune restriction de référent. Il est connu que certains paramètres de confidentialité de l'utilisateur ne transmettent pas l'URL de provenance.

    • Prenez note de la clé API générée, que vous utiliserez lors des appels à l'API de journalisation des événements utilisateur.
  4. Pour renforcer la sécurité, ajoutez une restriction HTTP à votre clé API afin de restreindre l'accès au service Retail à l'adresse https://retail.googleapis.com/*.

Examples

S'authentifier avec un compte de service (OAuth 2.0)

Voici un exemple Java d'authentification OAuth 2.0 utilisant un compte de service. Vous trouverez des instructions plus détaillées dans la documentation de l'authentification. Google dispose de bibliothèques clientes dans 7 langages que vous pouvez utiliser pour mettre en œuvre l'authentification OAuth2 dans votre application. Si vous préférez mettre en œuvre directement HTTP/REST, suivez les instructions d'authentification REST.

Dans l'exemple, remplacez your-service-account-json-key-file par le chemin d'accès au fichier de clé JSON de votre compte de service.

// Simple Java example of using Google Cloud OAuth client library.
//
// Please see here for the list of libraries in different languages:
// https://developers.google.com/identity/protocols/OAuth2#libraries
//
// The following example depends on the google api client library.
//
// Maven:
//    <dependency>
//      <groupId>com.google.api-client</groupId>
//      <artifactId>google-api-client</artifactId>
//      <version>1.22.0</version>
//    </dependency>
import com.google.api.client.googleapis.auth.oauth2.GoogleCredential;
import com.google.api.client.googleapis.javanet.GoogleNetHttpTransport;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpTransport;
import com.google.api.client.http.json.JsonHttpContent;
import com.google.api.client.json.GenericJson;
import com.google.api.client.json.jackson2.JacksonFactory;
import java.io.FileInputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public class RetailApiSample {
  public static final String CREATE_PRODUCT_URL =
     "https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/branches/0/products";

  public static GoogleCredential authorize() throws Exception {
    return GoogleCredential.fromStream(new FileInputStream("your-service-account-json-key-file"))
        .createScoped(Collections.singleton("https://www.googleapis.com/auth/cloud-platform"))
        .setExpirationTimeMilliseconds(new Long(3600 * 1000));;
  }

  // Build an example product.
  public static GenericJson getProduct() {
    GenericJson categories = new GenericJson()
        .set("categories", Arrays.asList("Electronics > Computers", "Laptops"));
    GenericJson priceInfo = new GenericJson()
        .set("currency_code", "USD")
        .set("price", 800.00)
        .set("original_price", 1000.00);

    return new GenericJson()
        .set("name", "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/branches/0/products/[ProductName]")
        .set("title", "Sample Laptop")
        .set("description", "Indisputably the most fantastic laptop ever created.")
        .set("categories", categories)
        .set("price_info", priceInfo)
        .set("availability", "IN_STOCK")
        .set("available_quantity", 1219);
  }

  public static void main(String[] args) {
    try {
      GoogleCredential credential = RetailApiSample.authorize();

      HttpTransport httpTransport = GoogleNetHttpTransport.newTrustedTransport();
      HttpRequestFactory requestFactory = httpTransport.createRequestFactory();
      HttpRequest request = requestFactory.buildPostRequest(new GenericUrl(CREATE_PRODUCT_URL),
          new JsonHttpContent(new JacksonFactory(), RetailApiSample.getProduct()));
      credential.initialize(request);
      HttpResponse response = request.execute();
      System.out.println("Response content: " + response.parseAsString());
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Étapes suivantes