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

Écrire dans Google Sheets à partir d'un workflow

Google Sheets est une solution de feuilles de calcul dans le cloud qui favorise la collaboration en temps réel et fournit des outils pour visualiser, traiter et communiquer les données.

L'exemple suivant montre comment écrire dans Sheets à partir d'un workflow. Le workflow interroge un ensemble de données BigQuery et écrit les résultats dans une feuille de calcul Sheets. Il utilise des connecteurs Workflows pour simplifier l'appel des API Google Cloud.

Avant de commencer

Avant de tester l'exemple de ce document, assurez-vous d'avoir effectué les opérations suivantes.

activer les API Compute Engine, Google Drive, Google Sheets et Workflows ;

Console

Activer les API

gcloud

gcloud services enable \
    compute.googleapis.com \
    drive.googleapis.com \
    sheets.googleapis.com \
    workflows.googleapis.com

Notez le compte de service Compute Engine par défaut, car vous l'associerez à l'exemple de workflow à des fins de test. Pour les nouveaux projets ayant activé l'API Compute Engine, ce compte de service est créé avec le rôle IAM de base Éditeur, avec le format d'adresse e-mail suivant:
```
PROJECT_NUMBER-compute@developer.gserviceaccount.com
```
Vous pouvez trouver le numéro de votre projet sur la page Bienvenue de la console Google Cloud ou le récupérer:
```
gcloud projects describe PROJECT_ID
```
Pour les environnements de production, nous vous recommandons vivement de créer un compte de service et de lui attribuer un ou plusieurs rôles IAM contenant les autorisations minimales requises et respectant le principe du moindre privilège.

Remarque :
La contrainte liée aux règles d'administration iam.automaticIamGrantsForDefaultServiceAccounts empêche l'attribution automatique du rôle "Éditeur" aux comptes de service par défaut. Si vous avez créé votre organisation après le 3 mai 2024, cette contrainte est appliquée par défaut.

Nous vous recommandons vivement d'appliquer cette contrainte pour désactiver l'attribution automatique de rôles. Si vous désactivez l'attribution automatique de rôles, vous devez choisir les rôles à attribuer aux comptes de service par défaut, puis attribuer ces rôles vous-même.

Si le compte de service par défaut dispose déjà du rôle Éditeur, nous vous recommandons de le remplacer par des rôles moins permissifs. Pour modifier les rôles du compte de service en toute sécurité, utilisez Policy Simulator pour voir l'impact de la modification, puis attribuez et révoquez les rôles appropriés.
Créez un dossier dans Google Drive. Ce dossier est utilisé pour stocker votre feuille de calcul. En configurant une autorisation pour le dossier partagé, votre workflow est autorisé à écrire dans la feuille de calcul.
1. Accédez à drive.google.com.
2. Cliquez sur Nouveau > Nouveau dossier.
3. Attribuez un nom au dossier.
4. Cliquez sur Créer.
5. Effectuez un clic droit sur le nouveau dossier, puis sélectionnez Partager.
6. Ajoutez l'adresse e-mail du compte de service Compute Engine par défaut.
  
  Le compte de service peut ainsi accéder au dossier. Lorsque vous associez le compte de service à votre workflow, celui-ci est autorisé à modifier tous les fichiers du dossier. En savoir plus sur le partage de fichiers, de dossiers et de Drive
7. Sélectionnez le rôle Éditeur.
8. Décochez la case Envoyer une notification.
9. Cliquez sur Partager,

Créer une feuille de calcul

Vous pouvez créer une feuille de calcul de l'une des manières suivantes:

Créer une feuille de calcul avec Google Sheets
Créer une feuille de calcul à l'aide du connecteur de l'API Google Sheets

Il n'existe aucune option permettant de créer une feuille de calcul directement dans un dossier spécifié à l'aide de l'API Google Sheets. Toutefois, il existe des alternatives, comme déplacer la feuille de calcul vers un dossier spécifique après l'avoir créée, comme dans les exemples suivants. Pour en savoir plus, consultez Utiliser des dossiers Google Drive.

Créer une feuille de calcul avec Google Sheets

Lorsque vous créez une feuille de calcul avec Google Sheets, elle est enregistrée dans Google Drive. Par défaut, la feuille de calcul est enregistrée dans votre dossier racine sur Drive.

Accédez à sheets.google.com.
Cliquez sur New (Nouveau) .

Votre nouvelle feuille de calcul est alors créée. Chaque feuille de calcul possède une valeur spreadsheetId unique, contenant des lettres, des chiffres, des traits d'union ou des traits de soulignement. Vous pouvez trouver l'ID de la feuille de calcul dans une URL Google Sheets:

https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0
Notez cet ID, car vous en aurez besoin à la création du workflow.
Déplacez la feuille de calcul vers le dossier Google Drive que vous avez créé précédemment:
1. Dans la feuille de calcul, sélectionnez Fichier > Déplacer.
2. Accédez au dossier que vous avez créé.
3. Cliquez sur Déplacer.

Créer une feuille de calcul à l'aide du connecteur de l'API Google Sheets

Vous pouvez utiliser le connecteur d'API Google Sheets pour créer une feuille de calcul. Comme Workflows utilise le compte de service comme identité de déclencheur, la feuille de calcul est créée dans le dossier racine Google Drive du compte de service. Vous pouvez ensuite la déplacer vers un autre dossier.

Dans le workflow suivant, spreadsheetId est récupéré à partir du résultat resp:

YAML

main:
  steps:
    - init:
        assign:
          - folder_id: 'FOLDER_ID'
          - drive_url: 'https://www.googleapis.com/drive/v3/files/'
          - drive_auth_scope: 'https://www.googleapis.com/auth/drive'
    - create_sheet:
        call: googleapis.sheets.v4.spreadsheets.create
        args:
          body: null
          connector_params:
            scopes: 'https://www.googleapis.com/auth/drive'
        result: resp
    - get_sheet_info:
        call: http.get
        args:
          url: '${drive_url + resp.spreadsheetId}'
          query:
            fields: parents
          auth:
            type: OAuth2
            scopes: '${drive_auth_scope}'
        result: sheet_info
    - move_sheet:
        call: http.patch
        args:
          url: '${drive_url + resp.spreadsheetId}'
          query:
            addParents: '${folder_id}'
            removeParents: '${sheet_info["body"]["parents"][0]}'
          auth:
            type: OAuth2
            scopes: '${drive_auth_scope}'
        result: resp
    - return:
        return: '${resp}'

JSON

{
  "main": {
    "steps": [
      {
        "init": {
          "assign": [
            {
              "folder_id": "FOLDER_ID"
            },
            {
              "drive_url": "https://www.googleapis.com/drive/v3/files/"
            },
            {
              "drive_auth_scope": "https://www.googleapis.com/auth/drive"
            }
          ]
        }
      },
      {
        "create_sheet": {
          "call": "googleapis.sheets.v4.spreadsheets.create",
          "args": {
            "body": null,
            "connector_params": {
              "scopes": "https://www.googleapis.com/auth/drive"
            }
          },
          "result": "resp"
        }
      },
      {
        "get_sheet_info": {
          "call": "http.get",
          "args": {
            "url": "${drive_url + resp.spreadsheetId}",
            "query": {
              "fields": "parents"
            },
            "auth": {
              "type": "OAuth2",
              "scopes": "${drive_auth_scope}"
            }
          },
          "result": "sheet_info"
        }
      },
      {
        "move_sheet": {
          "call": "http.patch",
          "args": {
            "url": "${drive_url + resp.spreadsheetId}",
            "query": {
              "addParents": "${folder_id}",
              "removeParents": "${sheet_info[\"body\"][\"parents\"][0]}"
            },
            "auth": {
              "type": "OAuth2",
              "scopes": "${drive_auth_scope}"
            }
          },
          "result": "resp"
        }
      },
      {
        "return": {
          "return": "${resp}"
        }
      }
    ]
  }
}

Remplacez FOLDER_ID par l'ID du dossier vers lequel vous souhaitez déplacer la feuille de calcul. Chaque dossier Drive possède un ID unique, composé de lettres, de chiffres, de traits d'union ou de traits de soulignement. Vous trouverez l'ID du dossier dans l'URL du dossier:

https://drive.google.com/drive/folders/FOLDER_ID/edit#gid=0

Pour en savoir plus, consultez la page Créer et remplir des dossiers.

Le résultat du workflow doit ressembler à ce qui suit, où la valeur id est spreadsheetId:

"body": {
    "id": "spreadsheetId",
    "kind": "drive#file",
    "mimeType": "application/vnd.google-apps.spreadsheet",
    "name": "Untitled spreadsheet"
  }

Explorer l'ensemble de données public BigQuery

BigQuery héberge un certain nombre d'ensembles de données publics pouvant être interrogés par le grand public.

Dans BigQuery, vous pouvez exécuter une tâche de requête interactive (à la demande). Par exemple, la requête suivante renvoie les 100 noms les plus populaires d'un ensemble de données spécifique et écrit la sortie dans une table temporaire. Il s'agit de la requête que votre workflow exécutera.

Console

Dans la console Google Cloud, accédez à la page BigQuery.

Accéder à BigQuery

Saisissez la requête SQL BigQuery suivante dans la zone de texte de l'éditeur de requête:

SELECT name, gender, SUM(number) AS total
FROM `bigquery-public-data.usa_names.usa_1910_2013`
GROUP BY name, gender
ORDER BY total DESC
LIMIT 100

Cliquez sur Exécuter.

bq

Dans votre terminal, saisissez la commande bq query suivante pour exécuter une requête interactive à l'aide de la syntaxe SQL standard:

    bq query \
    --use_legacy_sql=false \
    'SELECT
      name, gender, SUM(number) AS total
    FROM
      `bigquery-public-data.usa_names.usa_1910_2013`
    GROUP BY
      name, gender
    ORDER BY
      total DESC
    LIMIT 100'

Déployer un workflow qui écrit dans Sheets

Déployez un workflow qui interroge un ensemble de données BigQuery à l'aide du connecteur d'API BigQuery et qui écrit les résultats dans une feuille de calcul Sheets à l'aide du connecteur d'API Google Sheets.

Console

Dans la console Google Cloud, accédez à la page Workflows:

Accéder à "Workflows"
Cliquez sur Créer.
Saisissez un nom pour le nouveau workflow: read-bigquery-write-sheets.
Dans la liste Région, sélectionnez us-central1 (Iowa).
Dans le champ Compte de service, sélectionnez le compte de service Compute Engine par défaut (PROJECT_NUMBER-compute@developer.gserviceaccount.com).
Cliquez sur Suivant.

Dans l'éditeur de workflow, saisissez la définition suivante pour votre workflow:

main:
    steps:
    - init:
        assign:
        # Replace with your sheetId and make sure the service account
        # for the workflow has write permissions to the sheet
        - sheetId: "1D8n7uoU8kGwQvR4rcLkF10CdAfnUKE2o0yl6P-Z7nfM"
        - limit: 100
    - runQuery:
        call: googleapis.bigquery.v2.jobs.query
        args:
            projectId: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}
            body:
                useLegacySql: false
                # Query name and gender of most popular names
                query: ${"SELECT name, gender, SUM(number) AS total
                    FROM `bigquery-public-data.usa_names.usa_1910_2013`
                    GROUP BY name, gender
                    ORDER BY total DESC
                    LIMIT " + limit}
        result: queryResult
    - init_header_row:
        assign:
        - rows:
            - ["Name", "Gender", "Total"]
    - process_query_result:
        for:
            value: row
            in: ${queryResult.rows}
            steps:
            - process_each_row:
                assign:
                - name: ${row.f[0].v}
                - gender: ${row.f[1].v}
                - total: ${row.f[2].v}
                - row: ["${name}", "${gender}", "${total}"]
                - rows: ${list.concat(rows, row)}
    - clear_existing_values:
        call: googleapis.sheets.v4.spreadsheets.values.clear
        args:
            range: "Sheet1"
            spreadsheetId: ${sheetId}
        result: clearResult
    - update_sheet:
        call: googleapis.sheets.v4.spreadsheets.values.update
        args:
            range: ${"Sheet1!A1:C" + (limit + 1)}
            spreadsheetId: ${sheetId}
            valueInputOption: RAW
            body:
                majorDimension: "ROWS"
                values: ${rows}
        result: updateResult
    - returnResult:
        return: ${updateResult}

Remplacez la valeur d'espace réservé sheetId par votre spreadsheetId.
Cliquez sur Déployer.

gcloud

Créez un fichier de code source pour votre workflow:
```
touch read-bigquery-write-sheets.yaml
```

Dans un éditeur de texte, copiez le workflow suivant dans votre fichier de code source:

main:
    steps:
    - init:
        assign:
        # Replace with your sheetId and make sure the service account
        # for the workflow has write permissions to the sheet
        - sheetId: "1D8n7uoU8kGwQvR4rcLkF10CdAfnUKE2o0yl6P-Z7nfM"
        - limit: 100
    - runQuery:
        call: googleapis.bigquery.v2.jobs.query
        args:
            projectId: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}
            body:
                useLegacySql: false
                # Query name and gender of most popular names
                query: ${"SELECT name, gender, SUM(number) AS total
                    FROM `bigquery-public-data.usa_names.usa_1910_2013`
                    GROUP BY name, gender
                    ORDER BY total DESC
                    LIMIT " + limit}
        result: queryResult
    - init_header_row:
        assign:
        - rows:
            - ["Name", "Gender", "Total"]
    - process_query_result:
        for:
            value: row
            in: ${queryResult.rows}
            steps:
            - process_each_row:
                assign:
                - name: ${row.f[0].v}
                - gender: ${row.f[1].v}
                - total: ${row.f[2].v}
                - row: ["${name}", "${gender}", "${total}"]
                - rows: ${list.concat(rows, row)}
    - clear_existing_values:
        call: googleapis.sheets.v4.spreadsheets.values.clear
        args:
            range: "Sheet1"
            spreadsheetId: ${sheetId}
        result: clearResult
    - update_sheet:
        call: googleapis.sheets.v4.spreadsheets.values.update
        args:
            range: ${"Sheet1!A1:C" + (limit + 1)}
            spreadsheetId: ${sheetId}
            valueInputOption: RAW
            body:
                majorDimension: "ROWS"
                values: ${rows}
        result: updateResult
    - returnResult:
        return: ${updateResult}

Remplacez la valeur d'espace réservé sheetId par votre spreadsheetId.
Déployez le workflow en saisissant la commande suivante :
```
gcloud workflows deploy read-bigquery-write-sheets \
    --source=read-bigquery-write-sheets.yaml \
    --location=us-central1 \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com
```
Remplacez PROJECT_NUMBER par votre numéro de projet Google Cloud. Vous trouverez le numéro de votre projet sur la page Accueil de la console Google Cloud.

Exécuter le workflow et vérifier les résultats

L'exécution d'un workflow exécute la définition actuelle du workflow associé au workflow.

Exécutez le workflow comme suit :

Console

Dans Google Cloud Console, accédez à la page Workflows :

Accéder à "Workflows"
Sur la page Workflows, sélectionnez le workflow read-bigquery-write-sheets pour accéder à sa page d'informations.
Sur la page Détails du workflow, cliquez sur Exécuter.
Cliquez à nouveau sur Exécuter.

Affichez les résultats du workflow dans le volet Output (Résultat).

La sortie devrait ressembler à ce qui suit :

{
"spreadsheetId": "1pgkNY7mWICA6o6INUNLHGnmk0Tdioh0nUghZPOYPpZA",
"updatedCells": 303,
"updatedColumns": 3,
"updatedRange": "Sheet1!A1:C101",
"updatedRows": 101
}

gcloud

Ouvrez un terminal.

Exécutez le workflow :

gcloud workflows run read-bigquery-write-sheets

Les résultats de l'exécution doivent ressembler à ce qui suit:

Waiting for execution [4dcf737b-69d9-4081-b8d9-86d39ae86bd1] to complete...done.     
argument: 'null'
duration: 3.131912897s
endTime: '2023-01-25T14:59:46.818828242Z'
name: projects/918619793306/locations/us-central1/workflows/read-bigquery-write-sheets/executions/4dcf737b-69d9-4081-b8d9-86d39ae86bd1
result: '{"spreadsheetId":"1pgkNY7mWICA6o6INUNLHGnmk0Tdioh0nUghZPOYPpZA","updatedCells":303,"updatedColumns":3,"updatedRange":"Sheet1!A1:C101","updatedRows":101}'
startTime: '2023-01-25T14:59:43.686915345Z'
state: SUCCEEDED

Vérifiez que le workflow a écrit les résultats de la requête dans votre feuille de calcul. Par exemple, le nombre de colonnes et de lignes de la feuille de calcul doit correspondre aux valeurs updatedColumns et updatedRows.

Écrire dans Google Sheets à partir d'un workflow

Avant de commencer

Console

gcloud

Créer une feuille de calcul

Créer une feuille de calcul avec Google Sheets

Créer une feuille de calcul à l'aide du connecteur de l'API Google Sheets

YAML

JSON

Explorer l'ensemble de données public BigQuery

Console

bq

Déployer un workflow qui écrit dans Sheets

Console

gcloud

Exécuter le workflow et vérifier les résultats

Console

gcloud

Étapes suivantes