Écrire dans Google Sheets à partir d'un workflow

Google Sheets est un service de feuilles de calcul qui favorise la collaboration en temps réel et fournit des outils pour visualiser, traiter et communiquer des 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. Elle utilise des connecteurs Workflows pour simplifier les appels d'API Google Cloud.

Avant de commencer

Avant de tester l'exemple présenté dans ce document, assurez-vous d'avoir suivi comme suit.

  1. activer Compute Engine, Google Drive, Google Sheets et API Workflows.

    Console

    Activer les API

    gcloud

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

  2. Notez les Compte de service Compute Engine par défaut compte de service, car vous l'associerez à l'exemple de workflow pour les tests objectifs. Les nouveaux projets pour lesquels l'API Compute Engine est activée présentent ce compte de service créé avec le rôle IAM "Éditeur de base", et au format d'adresse e-mail suivant:

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Vous trouverez le numéro de votre projet dans la Bienvenue de la console Google Cloud, ou vous pouvez récupérer votre numéro de projet:

    gcloud projects describe PROJECT_ID

    Pour les environnements de production, nous vous recommandons vivement Créer un compte de service et lui attribuer un ou plusieurs rôles IAM contenant autorisations minimales requises et suivez le principe de moindre privilège.

  3. Créez un dossier dans Google Drive. Ce dossier est utilisé pour stocker vos 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. Ajouter l'adresse e-mail du service Compute Engine par défaut Google Cloud.

      Le compte de service peut ainsi accéder au dossier. Lorsque vous associez compte de service avec votre workflow, celui-ci disposera à tous les fichiers du dossier. En savoir plus sur le partage de fichiers, de dossiers et 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:

Il n’y a pas d’option pour créer une feuille de calcul directement dans un dossier spécifié à l'aide de l'API Google Sheets. Cependant, il existe des alternatives, y compris déplacer la feuille de calcul vers un emplacement spécifique après l'avoir créé, comme dans les exemples suivants. Pour plus pour en savoir plus, consultez Utiliser les 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.

  1. Accédez à sheets.google.com.

  2. Cliquez sur New (Nouveau) Plus.

    Votre nouvelle feuille de calcul est alors créée. Chaque feuille de calcul a une spreadsheetId, contenant des lettres, des chiffres, des traits d'union ou des traits de soulignement. Vous trouverez ID de feuille de calcul dans une URL Google Sheets:

    https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0

  3. Notez cet ID, car vous en aurez besoin à la création du workflow.

  4. Déplacez la feuille de calcul dans 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 Connecteur d'API Google Sheets pour créer une feuille de calcul. Workflows utilise le compte de service en tant qu'identité du déclencheur, la feuille de calcul est créée dans le Dossier racine Google Drive. Vous pouvez ensuite déplacer la feuille de calcul .

Dans le workflow suivant, spreadsheetId est récupérée à 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 dans lequel déplacer la feuille de calcul. Chaque dossier Drive possède un un identifiant, contenant des lettres, des chiffres, des traits d'union ou des traits de soulignement. Vous trouverez ID du dossier dans l'URL du dossier:

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

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

Le résultat du workflow doit ressembler à ce qui suit, où id la valeur 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. mis à la disposition du grand public pour effectuer des requêtes.

Dans BigQuery, vous pouvez exécuter tâche de requête interactive (à la demande). Pour exemple, la requête suivante renvoie les 100 noms les plus populaires dans une et écrit la sortie dans une table temporaire. C'est la requête que votre le workflow s'exécute.

Console

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

    Accéder à BigQuery

  2. Saisissez la requête SQL BigQuery suivante dans le champ 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

  3. Cliquez sur Exécuter.

bq

Dans votre terminal, saisissez la commande bq query suivante pour exécuter une interactive utilisant 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éployer un workflow qui interroge un ensemble de données BigQuery à l'aide de la Connecteur d'API BigQuery Les résultats sont alors écrits dans une feuille de calcul Sheets Connecteur d'API Google Sheets :

Console

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

    Accéder à "Workflows"

  2. Cliquez sur  Créer.

  3. Saisissez un nom pour le nouveau workflow: read-bigquery-write-sheets.

  4. Dans la liste Région, sélectionnez us-central1 (Iowa).

  5. Dans le champ Compte de service, sélectionnez la valeur par défaut de Compute Engine. compte de service (PROJECT_NUMBER-compute@developer.gserviceaccount.com).

  6. Cliquez sur Suivant.

  7. 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}

  8. Remplacez la valeur de l'espace réservé sheetId par votre spreadsheetId

  9. Cliquez sur Déployer.

gcloud

  1. Créez un fichier de code source pour votre workflow:

    touch read-bigquery-write-sheets.yaml

  2. 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}

  3. Remplacez la valeur de l'espace réservé sheetId par votre spreadsheetId

  4. 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 dans la Bienvenue 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.

  1. Exécutez le workflow comme suit :

    Console

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

      Accéder à "Workflows"

    2. Sur la page Workflows, sélectionnez l'icône read-bigquery-write-sheets pour accéder à sa page d'informations.

    3. Sur la page Détails du workflow, cliquez sur Exécuter.

    4. Cliquez à nouveau sur Exécuter.

    5. 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

    1. Ouvrez un terminal.

    2. 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

  2. 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 dans la feuille de calcul doit correspondre aux valeurs updatedColumns et updatedRows.

Étape suivante