Cette page a été traduite par l'API Cloud Translation.

Guide de démarrage rapide pour Python

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

Les guides de démarrage rapide de Google Workspace utilisent les bibliothèques clientes des API pour gérer certaines les détails du flux d'authentification et d'autorisation. Nous vous recommandons vous utilisez les bibliothèques clientes pour vos propres applications. Ce guide de démarrage rapide utilise d'authentification simplifiée, adaptée à un test environnement. Pour un environnement de production, nous vous recommandons de vous familiariser authentification et autorisation avant Choisir les identifiants d'accès adaptés à votre application.

Créez une application de ligne de commande Python qui envoie des requêtes à l'API Google Apps Script.

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 remplir les conditions préalables suivantes:

Python 3.10.7 ou version ultérieure
La fonction pip outil de gestion des packages
Un projet Google Cloud.

Un compte Google sur lequel Google Drive est activé.

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 Apps Script.

Activer l'API

Configurer l'écran de consentement OAuth

Si vous utilisez un nouveau projet Google Cloud pour suivre ce guide de démarrage rapide, configurez l'écran de consentement OAuth et ajoutez-vous en tant qu'utilisateur test. Si vous avez déjà avez réalisé cette étape pour votre projet Cloud, passez à la section suivante.

Dans la console Google Cloud, accédez au menu . > API et Services > Écran de consentement OAuth.
Accéder à l'écran de consentement OAuth
Pour Type d'utilisateur, sélectionnez Interne, puis cliquez sur Créer.
Remplissez le formulaire d'inscription de l'application, puis cliquez sur Enregistrer et continuer.
Pour l'instant, vous pouvez ignorer l'ajout de champs d'application et cliquer sur Enregistrer et continuer. Par la suite, lorsque vous créerez une application à utiliser en dehors de votre d'une organisation Google Workspace, vous devez remplacer le Type d'utilisateur par Externe, puis : ajouter les niveaux d'autorisation requis par votre application.
Consultez le récapitulatif d'enregistrement de votre application. Pour apporter des modifications, cliquez sur Modifier. Si l'application l'inscription vous semble correcte, cliquez sur Retour 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 chaque plate-forme.

Dans la console Google Cloud, accédez à Menu > API et Services > Identifiants.
Accéder à "Identifiants"
Cliquez sur Créer des identifiants > ID client OAuth.
Cliquez sur Type d'application > Application de bureau.
Dans le champ Nom, saisissez un nom pour l'identifiant. Ce nom ne s'affiche que dans la console Google Cloud.
Cliquez sur Créer. L'écran "Client OAuth créé" s'affiche. Il contient l'ID et le code secret du client.
Cliquez sur OK. Les nouveaux identifiants s'affichent sous ID clients OAuth 2.0.
Enregistrez le fichier JSON téléchargé sous le nom credentials.json, puis déplacez le dans votre répertoire de travail.

Installer la bibliothèque cliente Google

Installez la bibliothèque cliente Google pour Python:

pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

Configurer l'exemple

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

Ajoutez le code suivant dans quickstart.py:

apps_script/quickstart/quickstart.py

Afficher sur GitHub

"""
Shows basic usage of the Apps Script API.
Call the Apps Script API to create a new script project, upload a file to the
project, and log the script's URL to the user.
"""
import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient import errors
from googleapiclient.discovery import build

# If modifying these scopes, delete the file token.json.
SCOPES = ["https://www.googleapis.com/auth/script.projects"]

SAMPLE_CODE = """
function helloWorld() {
  console.log("Hello, world!");
}
""".strip()

SAMPLE_MANIFEST = """
{
  "timeZone": "America/New_York",
  "exceptionLogging": "CLOUD"
}
""".strip()


def main():
  """Calls the Apps Script 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:
    service = build("script", "v1", credentials=creds)

    # Call the Apps Script API
    # Create a new project
    request = {"title": "My Script"}
    response = service.projects().create(body=request).execute()

    # Upload two files to the project
    request = {
        "files": [
            {"name": "hello", "type": "SERVER_JS", "source": SAMPLE_CODE},
            {
                "name": "appsscript",
                "type": "JSON",
                "source": SAMPLE_MANIFEST,
            },
        ]
    }
    response = (
        service.projects()
        .updateContent(body=request, scriptId=response["scriptId"])
        .execute()
    )
    print("https://script.google.com/d/" + response["scriptId"] + "/edit")
  except errors.HttpError as error:
    # The API encountered a problem.
    print(error.content)


if __name__ == "__main__":
  main()

Exécuter l'exemple

Dans votre répertoire de travail, créez et exécutez l'exemple:
```
python3 quickstart.py
```

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 un compte à utiliser pour l'autorisation.
2. Cliquez sur Accepter.
Votre application Python exécute et appelle l'API Google Apps Script.

Les informations d'autorisation étant stockées dans le système de fichiers, la prochaine fois que vous exécuterez l'exemple vous n'êtes pas invité à fournir d'autorisation.