Guide de démarrage rapide pour Python

Les guides de démarrage rapide expliquent comment configurer et exécuter une application qui appelle une API Google Workspace.

Les démarrages rapides Google Workspace utilisent les bibliothèques clientes de l'API pour gérer certains détails du flux d'authentification et d'autorisation. Nous vous recommandons d'utiliser les bibliothèques clientes pour vos propres applications. Ce guide de démarrage rapide utilise une approche d'authentification simplifiée, adaptée à un environnement de test. Pour un environnement de production, nous vous recommandons de vous familiariser avec l'authentification et l'autorisation avant de choisir les identifiants d'accès appropriés pour votre application.

Créer une application de ligne de commande Python qui envoie des requêtes à l'API Google Chat

Objectifs

  • configurer votre environnement ;
  • Installez la bibliothèque cliente.
  • Configurez l'exemple.
  • Exécutez l'exemple.

Prérequis

Pour exécuter ce guide de démarrage rapide, vous devez disposer des conditions préalables suivantes:

Configurer votre environnement

Pour suivre ce guide de démarrage rapide, configurez votre environnement.

Activer l'API

Avant d'utiliser les API Google, vous devez les activer dans un projet Google Cloud. Vous pouvez activer une ou plusieurs API dans un même projet Google Cloud.

  • Dans la console Google Cloud, activez l'API Google Chat.

    Activer l'API

Si vous utilisez un nouveau projet Google Cloud pour suivre cet atelier Qwik Start, configurez l'écran d'autorisation OAuth et ajoutez-vous en tant qu'utilisateur test. Si vous avez déjà effectué cette étape pour votre projet Cloud, passez à la section suivante.

  1. Dans la console Google Cloud, accédez à Menu  > API et services > Écran de consentement OAuth.

    Accéder à l'écran de consentement OAuth

  2. Pour Type d'utilisateur, sélectionnez Interne, puis cliquez sur Créer.
  3. Remplissez le formulaire d'inscription de l'application, puis cliquez sur Enregistrer et continuer.

  4. Pour l'instant, vous pouvez ignorer l'ajout de champs d'application et cliquer sur Enregistrer et continuer. À l'avenir, lorsque vous créerez une application pour une utilisation en dehors de votre organisation Google Workspace, vous devrez définir le type d'utilisateur sur Externe, puis ajouter les niveaux d'autorisation requis par votre application.

  5. Consultez le récapitulatif d'enregistrement de votre application. Pour y apporter des modifications, cliquez sur Modifier. Si l'enregistrement de l'application semble correct, cliquez sur Revenir au tableau de bord.

Autoriser des identifiants pour une application de bureau

Pour authentifier les utilisateurs finaux et accéder aux données utilisateur dans votre application, vous devez créer un ou plusieurs ID client OAuth 2.0. Un ID client sert à identifier une application unique auprès des serveurs OAuth de Google. Si votre application s'exécute sur plusieurs plates-formes, vous devez créer un ID client distinct pour chacune d'elles.
  1. Dans la console Google Cloud, accédez à Menu  > API et services > Identifiants.

    Accéder à "Identifiants"

  2. Cliquez sur Créer des identifiants > ID client OAuth.
  3. Cliquez sur Type d'application > Application pour ordinateur.
  4. Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom n'apparaît que dans la console Google Cloud.
  5. Cliquez sur Créer. L'écran "Client OAuth créé" s'affiche, avec votre nouvel ID client et votre nouveau code secret.
  6. Cliquez sur OK. Les identifiants nouvellement créés s'affichent sous ID client OAuth 2.0.
  7. Enregistrez le fichier JSON téléchargé sous le nom credentials.json, puis déplacez-le dans votre répertoire de travail.

Configurer l'application Google Chat

Pour appeler l'API Google Chat, vous devez configurer une application Google Chat. Pour toutes les requêtes d'écriture, Google Chat attribue l'application Google Chat dans l'UI à l'aide des informations suivantes.

  1. Dans la console Google Cloud, accédez à la page Configuration de l'API Chat:

    Accéder à la page "Configuration de l'API Chat"

  2. Sous Informations sur l'application, saisissez les informations suivantes:

    1. Dans le champ App name (Nom de l'application), saisissez Chat API quickstart app.
    2. Dans le champ URL de l'avatar, saisissez https://developers.google.com/chat/images/quickstart-app-avatar.png.
    3. Dans le champ Description, saisissez Quickstart for calling the Chat API.

  3. Sous Fonctionnalités interactives, cliquez sur le bouton d'activation/de désactivation Activer les fonctionnalités interactives pour désactiver les fonctionnalités interactives de l'application Chat.

  4. Cliquez sur Enregistrer.

Installer la bibliothèque cliente Google

  • Installez la bibliothèque cliente Google pour Python:

    pip install --upgrade google-apps-chat google-auth-httplib2 google-auth-oauthlib

Configurer l'exemple

  1. Dans votre répertoire de travail, créez un fichier nommé quickstart.py.

  2. Incluez le code suivant dans quickstart.py:

    chat/quickstart/quickstart.py
    from __future__ import print_function

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from google.apps import chat_v1 as google_chat


# If modifying these scopes, delete the file token.json.
SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly']


def main():
    """Shows basic usage of the Google Chat API.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'credentials.json', SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open('token.json', 'w') as token:
            token.write(creds.to_json())

    try:
        # Create a client
        client = google_chat.ChatServiceClient(
            credentials = creds,
            client_options = {
                "scopes" : SCOPES
            }
        )

        # Initialize request argument(s)
        request = google_chat.ListSpacesRequest(
            # Filter spaces by space type (SPACE or GROUP_CHAT or DIRECT_MESSAGE)
            filter = 'space_type = "SPACE"'
        )

        # Make the request
        page_result = client.list_spaces(request)

        # Handle the response. Iterating over page_result will yield results and
        # resolve additional pages automatically.
        for response in page_result:
            print(response)
    except Exception as error:
        # TODO(developer) - Handle errors from Chat API.
        print(f'An error occurred: {error}')


if __name__ == '__main__':
    main()

Exécuter l'exemple

  1. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 quickstart.py
  1. La première fois que vous exécutez l'exemple, vous êtes invité à autoriser l'accès :
    1. Si vous n'êtes pas encore connecté à votre compte Google, connectez-vous lorsque vous y êtes invité. Si vous êtes connecté à plusieurs comptes, sélectionnez-en un pour l'autorisation.
    2. Cliquez sur Accepter.

    Votre application Python exécute et appelle l'API Google Chat.

    Les informations d'autorisation sont stockées dans le système de fichiers. Par conséquent, la prochaine fois que vous exécuterez l'exemple de code, vous ne serez pas invité à vous authentifier.

Étapes suivantes