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

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

1. Créer un projet d'API

Pour activer l'API, vous devez d'abord créer un projet Google Cloud. Ce projet constitue la base pour la création, l'activation et l'utilisation de tous les services Google Cloud, y compris pour la gestion des API, l'activation de 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 "Console Google Cloud". Une boîte de dialogue listant les projets en cours s'affiche.

  3. Cliquez sur NOUVEAU PROJET. L'écran "Nouveau projet" s'affiche.

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

  5. (Facultatif) Cliquez sur Modifier pour modifier l'ID du projet. Une fois le projet créé, l'ID du projet ne peut plus être modifié. Par conséquent, choisissez un ID qui répond à vos besoins tout au long de la durée de vie du projet.

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

  7. Cliquez sur l'emplacement de votre projet, puis sur Sélectionner.

  8. Cliquez sur Créer. La console accède à 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 Google Cloud Search et créer un compte de service pour obtenir des identifiants.

  1. Pour vous assurer que vous êtes bien dans le projet que vous venez de créer, cliquez sur l'icône à droite de la bannière de la console Google Cloud, puis sélectionnez le projet que vous venez de créer.
  2. Cliquez sur ACTIVER DES API ET DES SERVICES. La page "Bienvenue dans la bibliothèque d'API" s'affiche.
  3. Accédez à l'API Google Cloud Search.
  4. Cliquez sur Activer. La page "Vue d'ensemble" s'affiche.

Pour en savoir plus sur l'activation et la désactivation des API, consultez la page Gérer les API dans la console Google Cloud.

3. Créer les identifiants du compte de service

  1. Dans la console Google Cloud, cliquez sur Identifiants dans le panneau 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 Créer. Un écran "Autorisations de compte de service" s'affiche.
  6. Cliquez sur Continuer. L'écran "Autoriser les utilisateurs à accéder à ce compte de service" s'affiche.
  7. Cliquez sur CRÉER UNE CLÉ, puis sur 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 plus d'informations 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 Google Cloud, 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 de la console Google Cloud.
  3. Cliquez sur IAM et administration > Comptes de service.
  4. Dans la liste, sous "ID du 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 la compatibilité tierce

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

Pour initialiser la compatibilité tierce pour Cloud Search:

  1. Votre projet Cloud Search Platform contient des identifiants de compte de service. Toutefois, afin d'initialiser la compatibilité tierce, vous devez créer des identifiants d'application Web. Pour savoir comment créer des identifiants d'application Web, consultez la page Créer des identifiants. Une fois cette étape terminée, vous devez disposer d'un fichier d'ID client et de code secret du client.

  2. Utilisez OAuth 2 Playground de Google 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 obtenus à l'étape 1.
    3. Cliquez sur Fermer.
    4. Dans le champ des champs d'application, saisissez https://www.googleapis.com/auth/cloud_search.settings, puis cliquez sur Autoriser. OAuth 2 Playground renvoie un code d'autorisation.
    5. Cliquez sur Exchange authorization code for tokens (Échanger le code 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 d'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, le champ done est défini sur true. Exemple :

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

Étapes suivantes

Voici quelques étapes supplémentaires que vous pouvez effectuer:

  1. Si vous prévoyez 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 obtenir des instructions sur l'ajout d'une source de données, consultez Ajouter une source de données pour les recherches.

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