シートから読み取り処理

オペレーション名

シートから読み取り

機能概要

Googleドライブ上のスプレッドシートのデータをシート単位で読み取ります。

データモデル

本コンポーネントのデータモデルはテーブルモデル型です。

プロパティ

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
フォルダパス	省略可	使用可	Googleドライブ上のフォルダを「/」(スラッシュ)から始まる絶対パスで選択または入力します。	省略した場合、ルートフォルダ(「/」)を使用します。
ファイル名	必須	使用可	スプレッドシートのファイル名を入力します。
シート名	省略可	使用可	スプレッドシートのシートを選択または入力します。	省略した場合、または指定したシートが存在しない場合、先頭のシートが読み取り対象となります。大文字小文字を区別しません。
列一覧	省略可	-	列を指定します。列一覧の各列は以下のボタンで操作することができます。 [追加]: 列を追加します。 [上へ]: 選択している列の順序を一つ上に上げます。 [下へ]: 選択している列の順序を一つ下に下げます。 [削除]: 列を削除します。
列一覧/列名	省略可	使用可	列名を入力します。

プロパティアクション

項目名	説明	備考
フォルダパス一覧の更新	指定した接続先にあるフォルダパスを取得して、[フォルダパス]に設定します。	[接続先]を指定・変更した場合や、Googleドライブ上でフォルダの追加・変更を行った場合、本プロパティアクションを使用することでその変更を反映させることができます。
ファイル名一覧の更新	指定したフォルダパスにあるファイル名を取得して、[ファイル名]に設定します。	[フォルダパス]を指定・変更した場合や、Googleドライブ上でファイルの追加・変更を行った場合、本プロパティアクションを使用することでその変更を反映させることができます。 [フォルダパス]に変数が設定されている場合は無効になります。
シート名一覧の更新	指定したファイルからシート名を取得して、[シート名]に設定します。	[ファイル名]を指定・変更した場合や、Googleスプレッドシート上でシートの追加・変更を行った場合、本プロパティアクションを使用することでその変更を反映させることができます。 [フォルダパス]または[ファイル名]に変数が設定されている場合は無効になります。
列一覧の更新	指定したスプレッドシートの1行目の値から列名を取得して、[列一覧]に設定します。	[シート名]を指定・変更した場合や、Googleスプレッドシート上で列の追加・変更を行った場合、本プロパティアクションを使用することでその変更を反映させることができます。 [フォルダパス]、[ファイル名]または[シート名]に変数が設定されている場合は無効になります。 [開始条件]が設定されている場合には、[開始条件]にマッチする行が対象の行となります。

開始/終了条件

項目名	必須/省略可	変数の使用	説明	備考
読み取り開始条件を指定	省略可	使用不可	読み取り開始条件を指定するかどうかを選択します。 [チェックあり]: 読み取り開始条件を指定します。 [チェックなし]:(デフォルト) 読み取り開始条件を指定しません。
開始条件	省略可	使用不可	読み取り開始条件を選択します。 [指定した文字列にマッチしたセルから開始]:(デフォルト) [マッチ文字列]にマッチしたセルから読み取り処理を開始します。 [指定したセルアドレスから開始]: [セルアドレス]から読み取り処理を開始します。	[読み取り開始条件を指定]にチェックを入れた場合、有効になります。選択した指定方法により、対応した入力フィールド([マッチ文字列]/[セルアドレス])に切り替わります。
マッチ文字列	省略可	使用可	読み取り開始条件のマッチ文字列を入力します。	[開始条件]に[指定した文字列にマッチしたセルから開始]を選択した場合、有効になります。大文字小文字を区別します。
セルアドレス	省略可	使用可	読み取り開始条件のセルアドレスを入力します。例:A1	[開始条件]に[指定したセルアドレスから開始]を選択した場合、有効になります。省略した場合、A1から読み取りを開始します。大文字小文字を区別します。
読み取り終了条件を指定	省略可	使用不可	読み取り終了条件を指定するかどうかを選択します。 [チェックあり]: 読み取り終了条件を指定します。 [チェックなし]:(デフォルト) 読み取り終了条件を指定しません。
終了条件	省略可	-	読み取り終了条件を指定します。各列は以下のボタンで操作することができます。 [追加]: 列を追加します。 [上へ]: 選択している列の順序を一つ上に上げます。 [下へ]: 選択している列の順序を一つ下に下げます。 [削除]: 列を削除します。	[読み取り終了条件を指定]にチェックを入れた場合、有効になります。読み取り終了行の直前の行までが読み取り対象となります。詳細については、「読み取り終了条件について」を参照してください。
終了条件/列名	省略可	使用不可	読み取り終了条件のチェックを行う対象の[列名]を選択します。
終了条件/行番号	省略可	使用可	読み取り終了条件のチェックを行う対象の行番号を入力します。 [(指定しない)]を選択した場合、全行を対象に読み取り終了条件のチェックを行います。	省略した場合、全行を対象に読み取り終了条件のチェックを行います。
終了条件/条件値	省略可	使用可	読み取り終了条件の条件値を入力します。 [(指定しない)]を選択した場合、セルの値に関わらず[行番号]の行が読み取り終了行となります。	省略した場合、空文字を条件値としてチェックを行います。
終了条件/論理演算子	必須	使用不可	[条件値]の論理演算子を選択します。 [AND]:(デフォルト) [OR]:

読み取り設定

項目名	必須/省略可	変数の使用	説明	備考
最初の行は値として取得しない	省略可	使用不可	指定したスプレッドシートの1行目をデータとして扱うかどうかを選択します。 [チェックあり]: データとして扱いません。 [チェックなし]:(デフォルト) データとして扱います。

データ処理方式

項目名	必須/省略可	変数の使用	説明	備考
データ処理方式	必須	使用不可	データ処理方式を選択します。 [スクリプトの設定を使用する]:(デフォルト) スクリプトプロパティの大容量データ処理の設定をアダプタに使用します。 [大容量データ処理を行わない]: 大容量データ処理を行いません。 [大容量データ処理を行う]: 大容量データ処理を行います。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このアダプタの簡単な説明を記述することができます。説明を記述すると、仕様書に反映させることができます。

スキーマ

入力スキーマ

ありません。

出力スキーマ

[列一覧]の設定により、カラム数が異なります。

スキーマ構造については、「テーブルモデル型のスキーマ」を参照してください。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応しています。

大容量データ処理を行う場合でも、結果データのファイルへの保存時に、一時的にデータをメモリ中に保持します。そのためデータが大きい場合には、大容量データ処理時にもOutOfMemoryErrorが発生する可能性があります。サーバのヒープサイズを変更する場合、メモリ容量の拡大が必要になるため別途お問い合わせください。

PSPでの使用について

PSPで使用できます。

PSPについては、「パラレルストリーミング処理」を参照してください。

使用できるコンポーネント変数

コンポーネント変数名	説明	備考
count	読み取りを行った行数を返します。	デフォルト値はnullです。 PSPでは値が格納されません。
folderPath	読み取りを行ったスプレッドシートのフォルダパスを返します。	デフォルト値はnullです。
fileName	読み取りを行ったスプレッドシートのファイル名を返します。	デフォルト値はnullです。
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」 DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。 DataSpider Cloudのバージョンにより、格納される内容が変わる可能性があります。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。 DataSpider Cloudのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

読み取り終了条件について

[読み取り終了条件を指定]にチェックを入れない場合、または[終了条件]が1つも存在しない場合、スプレッドシートに存在する行すべてが読み取り対象となります。

[終了条件/論理演算子]に複数の[OR]を指定した場合、以下の行が読み取り終了行となります。
- いずれかの条件にマッチした行
[終了条件/論理演算子]に複数の[AND]を指定した場合、以下の行が読み取り終了行となります。
- [行番号]にすべて[(指定しない)]を選択した場合、同一行ですべての条件にマッチした行
- [行番号]に行番号を指定した場合、すべての条件にマッチした最終行
  例：
  
  読み取り対象スプレッドシート
  
  行番号列1 列2 列3 列4
  
  1 AAA BBB CCC DDD
  
  2 EEE FFF GGG HHH
  
  3 III JJJ KKK LLL
  
  4 AAA BBB CCC DDD
  
  5 EEE FFF GGG HHH
  
  6 III JJJ KKK LLL
  
  読み取り終了条件(行番号を指定しない場合)
  
  列名行番号条件値論理演算子
  
  列1 [(指定しない)] EEE [AND]
  
  列2 [(指定しない)] FFF [AND]
  
  読み取り終了行は2行目となり、1行目のみ読み取られます。
  読み取り終了条件(行番号・条件値を指定した場合)
  
  列名行番号条件値論理演算子
  
  列1 2 EEE [AND]
  
  列2 5 FFF [AND]
  
  読み取り終了行は5行目となり、4行目まで読み取られます。
  読み取り終了条件(行番号を指定し、条件値を指定しない場合)
  
  列名行番号条件値論理演算子
  
  列1 2 [(指定しない)] [AND]
  
  列2 7 [(指定しない)] [AND]
  
  読み取り終了行は7行目となり、6行目まで読み取られます。
  読み取り終了条件(行番号を指定した条件と指定しない条件が混在する場合)
  
  列名行番号条件値論理演算子
  
  列1 4 [(指定しない)] [AND]
  
  列2 [(指定しない)] FFF [AND]
  
  読み取り終了行は5行目となり、4行目まで読み取られます。
[行番号]と[条件値]の両方に[(指定しない)]を選択した場合、1行も読み取られず処理が終了します。

行番号	列1	列2	列3	列4
1	AAA	BBB	CCC	DDD
2	EEE	FFF	GGG	HHH
3	III	JJJ	KKK	LLL
4	AAA	BBB	CCC	DDD
5	EEE	FFF	GGG	HHH
6	III	JJJ	KKK	LLL

列名	行番号	条件値	論理演算子
列1	[(指定しない)]	EEE	[AND]
列2	[(指定しない)]	FFF	[AND]

列名	行番号	条件値	論理演算子
列1	2	EEE	[AND]
列2	5	FFF	[AND]

列名	行番号	条件値	論理演算子
列1	2	[(指定しない)]	[AND]
列2	7	[(指定しない)]	[AND]

列名	行番号	条件値	論理演算子
列1	4	[(指定しない)]	[AND]
列2	[(指定しない)]	FFF	[AND]

仕様制限

空文字はnullとして出力します。

データはすべて文字列型として出力します。
- 数値や日付/時刻などのデータの形式は、Googleスプレッドシート上で対象セルを選択した際に「数式」欄に表示される形式となります。
- 通貨形式のデータを取得した場合、円記号はUnicodeの「U+00A5」として出力します。
[終了条件/列名]について
- [読み取り終了条件を指定]にチェックを入れ[終了条件/列名]を設定し、そのあと[列一覧/列名]を直接変更した場合、該当の終了条件は列名が異なるため条件として使用されません。[列一覧/列名]を直接変更した場合は[完了]ボタンを押下してプロパティ画面を閉じ、再びプロパティ画面を開いて[列一覧/列名]を設定し直してください。
- [列一覧/列名]で同じ列名が複数設定され、[終了条件/列名]にその名前が使用されている場合、[列一覧/列名]で同じ名前のもっとも上にある列が該当の列として使用されます。
関数・数式・コメント・ガジェット・グラフ・画像・図形描画・スクリプトの読み取りはサポートしていません。
- 関数・数式が設定されたセルは、計算結果のデータを読み取ります。
同名のスプレッドシート・フォルダについて
- [ファイル名]に指定したスプレッドシートと同じフォルダパス・ファイル名のスプレッドシートが複数存在する場合、どのスプレッドシートが読み取られるかは保証されていません。
- [フォルダパス]に指定したフォルダと同じパスのフォルダが複数存在する場合、どのフォルダを使用するは保証されていません。
マイドライブに存在しないファイル/フォルダは参照できません。

主な例外

例外名	原因	対策
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[]	[接続先]が指定されていません。	[接続先]を指定してください。
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]	[接続先]で選択されたリソース定義が見つかりません。	[接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException <プロパティ名>が指定されていません。	[<プロパティ名>]が指定されていません。	[<プロパティ名>]を指定してください。
InvalidFolderPathException	[フォルダパス]に入力されたパスが不正です。	[フォルダパス]を確認してください。
SpreadsheetNotFoundException 指定されたファイル名のスプレッドシートが見つかりません。ファイル名:[:<ファイル名>]	[ファイル名]に指定されたスプレッドシートが見つかりません。	[ファイル名]で以下のことを確認してください。存在するスプレッドシートが指定されているか「スプレッドシート」または「フォーム」以外の形式のファイルが指定されていないか
InvalidCellAddressException 指定されたセルアドレスは不正です。セルアドレス:[<セルアドレス>]	[開始セルアドレス]に入力されたセルアドレスが不正です。	[開始セルアドレス]を確認して正しいセルアドレスを入力してください。
InvalidRowNumberException 指定された行番号は不正です。行番号:[<行番号>]	[終了条件/行番号]に入力された行番号が不正です。	[終了条件/行番号]を確認して正しい行番号を入力してください。
java.lang.IllegalArgumentException Invalid extended help URI: Request rate limit exceeded.	GoogleスプレッドシートAPIの同時実行数の制限を超過しています。	処理の同時実行数を減らしてください。

注意事項

Googleドライブ/Googleスプレッドシートと本アダプタとの通信は、HTTPSを使用します。

2015年1月現在、Googleドライブのサービスアップデートにより、新しい形式の「スプレッドシート」と「フォーム」が導入され、Googleドライブ上の既存のファイルは2015年内に順次新しい形式に移行されます。
- 本アダプタは新しい形式・古い形式両方の「スプレッドシート」と古い形式の「フォーム」に対応しています。
- 新しい形式の「フォーム」を使用する場合、回答先にスプレッドシートを指定することで、本アダプタで回答先のデータを処理できます。

本アダプタの処理をマルチスレッドで同時に実行した場合、GoogleスプレッドシートAPIの同時実行数の制限を超過し、以下のエラーが発生することがあります。その場合には、同時実行数を減らしてください。
- java.lang.IllegalArgumentException: Invalid extended help URI: Request rate limit exceeded.

行番号	列1	列2	列3	列4
1	AAA	BBB	CCC	DDD
2	EEE	FFF	GGG	HHH
3	III	JJJ	KKK	LLL
4	AAA	BBB	CCC	DDD
5	EEE	FFF	GGG	HHH
6	III	JJJ	KKK	LLL

行番号	列1	列2	列3	列4
1	AAA	BBB	CCC	DDD
2	EEE	FFF	GGG	HHH
3	III	JJJ	KKK	LLL
4	AAA	BBB	CCC	DDD
5	EEE	FFF	GGG	HHH
6	III	JJJ	KKK	LLL