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

Pour pouvoir utiliser l'API Google Cloud Search, vous devez configurer l'accès à celle-ci soit directement, soit 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. Ce projet constitue la base permettant de créer, d'activer et d'utiliser tous les services Google Cloud, entre autres pour gérer les API, activer la facturation, ajouter ou exclure des collaborateurs et gérer les 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 apparaît.

  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. Vous ne pourrez plus modifier cet ID une fois le projet créé, donc choisissez un ID répondant à vos besoins pour toute la durée de vie du projet.

  6. Pour parcourir les lieux du projet, cliquez sur PARCOURRIR.

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

  8. Cliquez sur Créer. La console vous redirige vers 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 vérifier que vous êtes bien dans le projet nouvellement créé, 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 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 Créer. L'é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 en savoir plus sur les comptes de service, consultez l'article 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 situé à 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 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 la compatibilité tierce

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

Pour initialiser la compatibilité tierce avec Cloud Search:

  1. Votre projet Cloud Search Platform contient les identifiants du compte de service. Toutefois, pour l'initialisation de la compatibilité tierce, il est généralement préférable de créer des identifiants d'application Web. Pour savoir comment créer des identifiants d'application Web, consultez l'article Create credentials (en anglais). À la fin de cette étape, vous disposerez d'un fichier contenant un ID client et un code secret client.

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

    1. Cliquez sur le bouton des paramètres, puis cochez la case Use your own auth credentials (Utiliser vos propres identifiants d'autorisation).
    2. Saisissez l'ID client et le code secret client de l'étape 1.
    3. Cliquez sur Fermer.
    4. Dans le champ "Champs d'application", saisissez https://www.googleapis.com/auth/cloud_search.settings, puis cliquez sur le bouton Authorize (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"
}

    Si la requête échoue, contactez l'assistance Cloud Search.

  4. Utilisez 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

    Lorsque la compatibilité tierce est activé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 envisagez d'utiliser Google Cloud Search avec un dépôt de données non-Google, tel que Microsoft® SharePoint®, vous devez créer une source de données. Pour ce faire, suivez les instructions de la page 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 afin d'indiquer comment Google Cloud Search doit représenter les données du dépôt.