シート名一覧取得処理

オペレーション名

シート名一覧取得

機能概要

Googleドライブ上のスプレッドシートに含まれるシート名一覧を取得します。

データモデル

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

プロパティ

変数の使用については、「変数」を参照してください。
基本設定
項目名 必須/省略可 変数の使用 説明 備考
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  
必須設定
項目名 必須/省略可 変数の使用 説明 備考
接続先 必須 使用不可 グローバルリソースを選択します。
  • [追加]:
    新規にグローバルリソースを追加します。
  • [一覧の編集]:
    「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。
 
フォルダパス 省略可 使用可 Googleドライブ上のフォルダを「/」(スラッシュ)から始まる絶対パスで選択または入力します。
  • 省略した場合、ルートフォルダ(「/」)を使用します。
ファイル名 必須 使用可 スプレッドシートのファイル名を入力します。  
プロパティアクション
項目名 説明 備考
フォルダパス一覧の更新 指定した接続先にあるフォルダパスを取得して、[フォルダパス]に設定します。
  • [接続先]を指定・変更した場合や、Googleドライブ上でフォルダの追加・変更を行った場合、本プロパティアクションを使用することでその変更を反映させることができます。
ファイル名一覧の更新 指定したフォルダパスにあるファイル名を取得して、[ファイル名]に設定します。
  • [フォルダパス]を指定・変更した場合や、Googleドライブ上でファイルの追加・変更を行った場合、本プロパティアクションを使用することでその変更を反映させることができます。
  • [フォルダパス]に変数が設定されている場合は無効になります。
コメント
項目名 必須/省略可 変数の使用 説明 備考
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。
 

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0" encoding="UTF-8"?>
<book>
 <sheet><![CDATA[シート名]]></sheet>
</book>
要素名 属性名 説明 備考
book
-
   
sheet
-
取得したシート名ごとに出現します。  

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。
詳細については、「スキーマ編集」を参照してください。

大容量データ処理

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

PSPでの使用について

PSPでは使用できません。

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

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

仕様制限

主な例外

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

注意事項