スプレッドシート - バッチ取得タスク

スプレッドシート - バッチ取得タスクを使用すると、Google スプレッドシートから複数の不連続な値の範囲を読み取り、取得できます。

Google スプレッドシートGoogle Workspace の多くのクラウドベースの生産性向上ソリューションの一つです。リアルタイムの共同編集機能を使用して、オンライン スプレッドシートの作成と編集を行うことができます。

始める前に

スプレッドシート - バッチ取得タスクを構成する前に、Google Cloud プロジェクトで次のタスクを行う必要があります。

  1. Google Sheets API(sheets.googleapis.com)を有効にします。

    Google Sheets API を有効にする

  2. 認証プロファイルを作成します。Apigee Integration は、認証プロファイルを使用して、スプレッドシート - バッチ取得タスクの認証エンドポイントに接続します。

    サービス アカウントへの追加のロールや権限の付与については、アクセス権の付与、変更、取り消しをご覧ください。

  3. Google スプレッドシートで使用されている一般的な用語を理解し、学習します。

スプレッドシート - バッチ取得タスクを構成する

  1. Apigee UI で、Apigee 組織を選択します。
  2. [Develop] > [Integrations] の順にクリックします。
  3. 既存のインテグレーションを選択するか、[Create Integration] をクリックして新しいインテグレーションを作成します。

    新しいインテグレーションを作成する場合:

    1. [Create Integration] ダイアログで名前と説明を入力します。
    2. サポートされているリージョンのリストから、インテグレーションのリージョンを選択します。
    3. [Create] をクリックします。

    インテグレーション デザイナーでインテグレーションが開きます。

  4. インテグレーション デザイナーのナビゲーション バーで、[+ Add a task/trigger] > [Tasks] の順にクリックして、使用可能なタスクのリストを表示します。
  5. インテグレーション デザイナーで、スプレッドシート - バッチ取得要素をクリックして配置します。
  6. デザイナーの [スプレッドシート - バッチ取得] 要素をクリックして、[スプレッドシート - バッチ取得] タスク構成ペインを表示します。
  7. [Authentication] に移動し、使用する既存の認証プロファイルを選択します。

    省略可。タスクを構成する前に認証プロファイルを作成していない場合は、[+ New authentication profile] をクリックし、新しい認証プロファイルを作成するに記載されている手順に沿って操作します。

  8. [Task Input] に移動し、次の「タスクの入力パラメータ」の表を使用して表示される入力フィールドを構成します。

    入力フィールドの変更は自動的に保存されます。

タスク入力パラメータ

次の表に、スプレッドシート - バッチ取得タスクの入力パラメータを示します。

プロパティ データ型 説明
SpreadsheetId 文字列 スプレッドシートの ID。

スプレッドシートの ID はウェブ URL で確認できます。例: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit#gid=0

MajorDimension enum (Dimension) 適用するメインカテゴリまたはディメンション。たとえば、ROWSCOLUMNS です。

デフォルト値: DIMENSION_UNSPECIFIED

範囲 文字列 値を取得する範囲の A1 表記または R1C1 表記
DateTimeRenderOption enum (DateTimeRenderOption) 日付、時刻、期間に関連する値が出力でどのように表されるかを示します。

デフォルト値: SERIAL_NUMBER

ValueRenderOption enum (ValueRenderOption) 取得した値が出力でどのように表されるかを示します。

デフォルト値: FORMATTED_VALUE

タスク出力

スプレッドシート - バッチ取得タスクは、スプレッドシート ID を持つオブジェクトと、リクエストされた順番に対応する各リクエスト範囲に対応する ValueRange オブジェクトの配列を含むレスポンス出力を返します。出力例を次に示します。

{
        "spreadsheetId": SPREADSHEET_ID,
        "valueRanges": [
          {
            "range": "Sheet1!B1:B1000",
            "majorDimension": "COLUMNS",
            "values": [
              ["Cost",20.5,15,100,135.5]
            ]
          },
          {
            "range": "Sheet1!D1:D1000",
            "majorDimension": "COLUMNS",
            "values": [
              ["Ship Date",42430,42444,42449,42449]
            ]
          }
        ]
      }

エラー処理方法

タスクのエラー処理方法では、一時的なエラーによってタスクが失敗した場合のアクションを指定します。エラー処理方式の使用方法と、さまざまな種類のエラー処理方式の詳細については、エラー処理の方式をご覧ください。

次のステップ

  1. エッジとエッジの条件を追加する。
  2. インテグレーションをテストして公開する。
  3. トリガーを構成する。
  4. データ マッピング タスクを追加する。
  5. Google Cloud サービス向けのすべてのタスクを確認する。