GoogleSheetsOutput

GoogleSheetsOutput - Google Sheetsへデータを書き込む

入力ストリームのデータをGoogle Sheetsの指定したセルやレコード範囲に書き込みます。
このコンポーネントはGoogle Sheets APIを使用します。データの書き込み範囲やフィールドとの関連付けは、専用のExcelビルダーで行います。
認証にはGoogleSheetsコネクションで設定されたサービスアカウントを使用します。詳細は「認証と設定」を参照してください。

■ストリーム情報

入力	フォーマット	Record
	接続数	無制限
	説明	未定義のDescription:書き込むデータを持つレコードストリーム
出力	フォーマット	Record
出力	説明	入力ストリームがそのまま出力されます。

■コンポーネントプロパティ

名前

プロパティ型

マッピング

説明

コネクション

connection

Google Sheetsへの接続に使用するGoogleSheetsコネクションを指定します。このプロパティの指定は必須です。事前に管理コンソールで有効なGoogleSheetsコネクションを作成しておく必要があります。
各コネクションの詳細については、「はじめに」-「詳細なトピック」-「フローの構成要素」-「コネクションプロパティ」を参照してください。

シート作成方法

choice

入力＆出力

データの書き込み先となるスプレッドシートの作成方法を指定します。

テンプレート上書き [TemplateOverride]: マッピング定義時に使用したテンプレートのスプレッドシートに上書きします。
テンプレートから新規作成 [TemplateNewFile]: マッピング定義時に使用したテンプレートをコピーして、新しいスプレッドシートを作成します。
新規作成 [NewFile]: 空の新しいスプレッドシートを作成します。

スプレッドシートID

string

入力＆出力

書き込み対象のスプレッドシートのIDを指定します。
シート作成方法が「テンプレート上書き」の場合に、このプロパティで指定したスプレッドシートに書き込みます。
スプレッドシートIDは、スプレッドシートのURLから取得できます。例えば、URLが「https://docs.google.com/spreadsheets/d/1234567890abcdefghijklmnopqrstuvwxyz/edit」の場合、IDは「1234567890abcdefghijklmnopqrstuvwxyz」です。

スプレッドシート名

string

入力＆出力

シート作成方法が「テンプレートから新規作成」または「新規作成」の場合に、作成される新しいスプレッドシートの名前を指定します。

書出し処理

choice

入力＆出力

Excelビルダーで定義した「レコード」領域への書き込み方法を指定します。

クリア＆上書き [Override]	-	指定されたレコード領域を一度クリアしてから、入力ストリームのデータを先頭から書き込みます。
上書き [OverrideNonClear]	-	指定されたレコード領域をクリアせず、先頭からデータを上書きします。入力ストリームのレコード数が行数より多い場合、行が追加されます。
追加 [Append]	-	指定されたレコード領域の最終行の後ろに、入力ストリームのデータを追加します。

Mapping

excelmapping

データを書き込むセルやレコードの範囲を定義するためのExcelビルダーを開きます。
Excelビルダーでは、以下の2種類のデータ領域を定義できます。

セル: 固定値や入力ストリームの値を個別のセルに書き込む定義をします。
レコード: 入力ストリームのデータを表形式で書き込む範囲と、ストリームフィールドと列のマッピングを定義します。

ファイルパスの起点

pathResolver

Excelビルダーで画像などのファイルパスを指定する際に、相対パスの起点となるフォルダーを指定します。

■エラー処理

タイプ	パラメーター	エラー処理フローへのストリーム	エラーコード	説明
汎用	なし	コンポーネントの入力ストリーム	1	Google Sheets APIの実行に失敗した場合に発生します。(API実行時エラー、タイムアウトなど)
			2	入力ストリームのフィールドとマッピング定義が一致しない場合に発生します。
			3	書き込み先のシートが存在しない場合に発生します。

■使用方法

このコンポーネントは、入力レコードストリームをGoogle Sheetsに書き込みます。

接続の準備: 管理コンソールでGoogleSheetsコネクションを作成します。詳細な設定方法は「認証と設定」を参照してください。
入力ストリームの接続: 書き込みたいデータを持つコンポーネント(DBGetやMapperなど)の出力ストリームをこのコンポーネントの入力に接続します。
コンポーネントの設定:
- コネクションプロパティで作成したコネクションを選択します。
- シート作成方法やスプレッドシートIDなどを設定し、書き込み対象のスプレッドシートを決定します。
- 書出し処理プロパティで書き込みモードを選択します。
マッピングの定義 (Excelビルダー):
- コンポーネントをダブルクリックすると、**Excelビルダー**が起動します。
- ビルダー内で、スプレッドシートIDで指定したスプレッドシートが読み込まれ、内容がプレビューされます。
- シート上のデータを直接クリックして、書き込みたい「セル」領域や「レコード」領域(表)の範囲を指定します。
- 「レコード」領域には入力ストリームのフィールドをマッピングし、「セル」領域には固定値やストリーム変数などを設定します。
フローの実行: フローを実行すると、入力ストリームのデータが指定のGoogle Sheetsに書き込まれます。

■制限事項

APIの利用について

本コンポーネントはGoogle Sheets APIを利用してデータを書き込みます。Google Cloud Platformで設定されているAPIの利用割り当て(Quota)にご注意ください。短時間に大量のリクエストを行うと、APIの実行が制限される場合があります。
詳細はGoogle Cloud Platformのドキュメントを参照してください。

データ書き込みについて

本コンポーネントで書き込みができるのはセルの値のみです。フォント、色、罫線などの書式設定を書き込むことはできません。書式を保持したい場合は、シート作成方法で「テンプレートから新規作成」を選択するなどして、あらかじめ書式が設定されたテンプレートを元にファイルを作成してください。
計算式(Formula)を書き込むことはできますが、正常に計算されるかはGoogle Sheetsの仕様に依存します。
グラフやピボットテーブルが含まれるシートへの書き込みは、意図しない結果になる可能性があるためサポートされません。
画像をセルに挿入することはできません。(画像の挿入位置をセルの位置に合わせることは可能ですが、セル内に埋め込むことはできません。)

■認証と設定

本コンポーネントを使用するには、Google Cloud Platform (GCP) およびフローサービスが稼働する環境の両方で事前の設定が必要です。

必要なライブラリの配置
1. 以下のjarファイルをダウンロードして、[DATA_DIR]/system/lib/userlibフォルダーにコピーしてください。
2. フローサービスを再起動してください。
Google Cloud Platform (GCP) での準備
1. APIの有効化:
  - GCP ConsoleのAPIダッシュボードにアクセスし、使用するプロジェクトで以下のAPIが有効になっていることを確認してください。
    - Google Apps Script API
    - Google Drive API
  - Apps Scriptにアクセスし、画面左のメニューから「設定」を開き、「Google Apps Script API」をオンにします。
2. OAuth 2.0 クライアント ID の作成:
  1. GCP Consoleの「認証情報」ページにアクセスします。
  2. 「+ 認証情報を作成」をクリックし、「OAuth クライアント ID」を選択します。
  3. アプリケーションの種類として「デスクトップアプリ」を選択します。
  4. 作成後、表示される「クライアント ID」と「クライアントシークレット」をメモ帳などにコピーします。これらはコネクション設定で使用します。
コネクションの作成
1. 管理コンソールの「設定 > コネクション > GoogleSheets」で新しいコネクションを作成します。
2. メモ帳などに保存した「クライアント ID」と「クライアントシークレット」をコネクション設定の「OAuthクライアントID」と「OAuthクライアントシークレット」に入力します。
3. 設定を保存し、接続テストを実行します。
4. 初めて接続テストを行う場合は接続テストが失敗するため、次の手順を実行します。
  1. Apps Scriptで「[GoogleSheets Connector]」プロジェクトを開き、画面左のメニューから「プロジェクトの設定」を開きます。
  2. 「Google Cloud Platform(GCP)プロジェクト」に表示される手順に従ってGCPプロジェクト番号を設定します。
5. 再度コネクションの接続テストを実行し、成功することを確認します。

これらの設定が完了して初めて、フローデザイナー上のコンポーネントが正常に動作します。