Configurer l'accès à l'API REST Google Cloud Search

Vous devez configurer l'accès à l'API REST de Google Cloud Search pour pouvoir l'utiliser directement ou via un SDK. Ce document décrit la procédure à suivre pour utiliser l'API REST Google Cloud Search.

1. Créer un projet d'API

Pour activer l'API, vous devez d'abord créer un projet Google Cloud Platform. Ce projet constitue la base pour la création, l'activation et l'utilisation de tous les services Google Cloud Platform (GCP), y compris la gestion des API, la facturation, l'ajout et la suppression de collaborateurs et la gestion des autorisations.

  1. Ouvrez Google Cloud Console.

  2. En haut de la page, cliquez sur à droite de "Google Cloud Console". Une boîte de dialogue répertoriant les projets en cours s'affiche.

  3. Cliquez sur NOUVEAU PROJET. L'écran "New Project" (Nouveau projet) s'affiche.

  4. Saisissez un nom dans le champ Project Name (Nom du projet).

  5. (Facultatif) Cliquez sur Modifier pour modifier l'ID du projet. L'ID de projet ne peut pas être modifié après la création du projet. Choisissez-en donc un qui répond à vos besoins pendant toute la durée de vie du projet.

  6. Pour parcourir les emplacements du projet, cliquez sur PARCOURIR.

  7. Cliquez sur un emplacement pour votre projet, puis sur Sélectionner.

  8. Cliquez sur Create (Créer). La console vous permet d'accéder à la page "Tableau de bord". Le projet est créé en quelques minutes.

Pour en savoir plus sur la création et la gestion de projets, consultez la page Créer et gérer des projets.

2. Activer l'API

Vous devez activer l'API REST de Cloud Search et créer un compte de service pour obtenir des identifiants.

  1. Pour vérifier que vous êtes bien dans le projet nouvellement créé, cliquez sur l'icône à droite de la bannière Google Cloud Console et sélectionnez le projet que vous venez de créer.
  2. Cliquez sur ACTIVER DES API ET DES SERVICES. La page "Welcome to API Library" (Bienvenue dans l'API) s'affiche.
  3. Accédez à l'API Google Cloud Search.
  4. Cliquez sur Activer. La page "Vue d'ensemble" s'affiche.

Pour plus d'informations sur l'activation et la désactivation des API, consultez la page Gérer des API dans Google Cloud Console.

3. Créer les identifiants du compte de service

  1. Dans la console Cloud Platform, cliquez sur Identifiants dans le menu de navigation de gauche. La page "Identifiants" s'affiche.
  2. Dans la liste déroulante Créer des identifiants, sélectionnez Compte de service. La page "Créer un compte de service" s'affiche.
  3. Saisissez un nom dans le champ Nom du compte de service.
  4. (Facultatif) Modifiez l'ID du compte de service.
  5. Cliquez sur Create (Créer). Un écran "Autorisations de compte de service" s'affiche.
  6. Cliquez sur Continuer. Un écran "Autoriser les utilisateurs à accéder à ce compte de service" s'affiche.
  7. Cliquez sur CREATE KEY (Créer une clé), puis sur Done (OK). Une boîte de dialogue "Clé privée enregistrée sur votre ordinateur" s'affiche, et une copie de la clé privée est téléchargée sur votre ordinateur.
  8. Cliquez sur Fermer.

Pour en savoir plus sur les comptes de service, consultez la page Comptes de service, applications Web et applications installées.

4. Identifier l'adresse e-mail

  1. Dans la console Cloud Platform, sélectionnez le projet que vous avez créé en haut de la page.
  2. Cliquez sur le menu de navigation à gauche de la bannière Google Cloud Console.
  3. Cliquez sur IAM and Admin > Service accounts (IAM et administration > Comptes de service).
  4. Dans la liste, sous "ID de compte de service", notez l'adresse e-mail générée qui identifie le compte de service que vous avez configuré. Cette adresse e-mail est utilisée lors de l'ajout d'une source de données à Cloud Search.

5. Initialiser l'assistance tierce

Avant de pouvoir appeler d'autres API Cloud Search, vous devez initialiser la compatibilité tierce avec Google Cloud Search.

.

Pour initialiser la compatibilité tierce avec Cloud Search, procédez comme suit:

  1. Le projet Cloud Search Platform contient des identifiants de compte de service. Toutefois, pour l'initialisation de la compatibilité tierce, vous devez créer des identifiants d'application Web. Pour obtenir des instructions sur la création des identifiants d'application Web, consultez la page Créer des identifiants. À la fin de cette étape, vous devez disposer d'un ID client et d'un fichier de code secret client.

  2. Utilisez Google OAuth 2 Playground pour obtenir un jeton d'accès:

    1. Cliquez sur "Settings" (Paramètres) et cochez la case User your own auth credentials (Utiliser vos propres identifiants d'authentification).
    2. Saisissez l'ID client et le code secret du client de l'étape 1.
    3. Cliquez sur Fermer.
    4. Dans le champ "Niveaux d'accès", saisissez https://www.googleapis.com/auth/cloud_search.settings, puis cliquez sur Autoriser. Le terrain de jeu OAuth 2 renvoie un code d'autorisation.
    5. Cliquez sur Échanger les codes d'autorisation contre des jetons. Un jeton est renvoyé.
  3. Pour initialiser la compatibilité tierce avec Cloud Search, utilisez la commande curl suivante. Veillez à remplacer [YOUR_ACCESS_TOKEN] par le jeton obtenu à l'étape 2.

    curl --request POST \
    'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{}' \
      --compressed
    

    Si la requête aboutit, le corps de la réponse contient une instance de operation. Exemple :

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    }
    

    En cas d'échec, contactez l'assistance Cloud Search.

  4. Utilisez la méthode operations.get pour vérifier que la compatibilité tierce est initialisée:

    curl \
    'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
    [YOUR_API_KEY]' \
    --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
    --header 'Accept: application/json' \
    --compressed
    

    Une fois l'initialisation tierce terminée, elle contient le champ done défini sur true. Exemple :

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    done: true
    }
    

Étapes suivantes

Voici ce que vous pouvez faire:

  1. Si vous envisagez d'utiliser Google Cloud Search avec un dépôt de données autre que Google, tel que Microsoft® SharePoint, vous devez créer une source de données. Pour savoir comment ajouter une source de données, consultez l'article Ajouter une source de données pour la recherche.

  2. Une fois que vous avez configuré votre source de données, vous pouvez créer et enregistrer un schéma pour identifier la manière dont Google Cloud Search doit représenter les données du dépôt.