このサービスを使用すると、メールアドレスやユーザー名などのユーザー情報にアクセスできます。また、Google Workspace アプリケーションのスクリプトログとダイアログ ボックスも制御します。
クラス
名前 | 概要 |
---|---|
Blob | Apps Script サービスのデータ交換オブジェクト。 |
BlobSource | データを Blob としてエクスポートできるオブジェクトのインターフェース。 |
Browser | このクラスは、Google スプレッドシートに固有のダイアログ ボックスにアクセスできるようにします。 |
Button | alert または PromptResponse.getSelectedButton() によって返される、事前定義されたローカライズされたダイアログ ボタンを表す列挙型。ユーザーがダイアログ内のどのボタンをクリックしたかを示します。 |
ButtonSet | alert または prompt に追加できる、1 つ以上のダイアログ ボタンの事前定義されたローカライズ済みセットを表す列挙型。 |
ColorType | 色の種類 |
Logger | このクラスを使用すると、デベロッパーは実行ログと Google Cloud Logging に書き込むことができます(スクリプトが標準の Cloud プロジェクトに関連付けられている場合)。 |
Menu | Google アプリのユーザー インターフェースのインスタンス内のカスタム メニュー。 |
MimeType | 文字列を明示的に入力せずに MIME タイプの宣言にアクセスできる列挙型。 |
Month | 1 年の月を表す列挙型。 |
PromptResponse | Google アプリのユーザー インターフェース環境に表示される prompt ダイアログへのレスポンス。 |
RgbColor | 赤、緑、青の色チャンネルで定義された色。 |
Session | Session クラスを使用すると、ユーザーのメールアドレス(場合によって)や言語設定などのセッション情報にアクセスできます。 |
Ui | Google アプリのユーザー インターフェース環境のインスタンスで、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。 |
User | ユーザーを表すオブジェクト。スクリプト作成に適しています。 |
Weekday | 曜日を表す列挙型。 |
console | このクラスを使用すると、デベロッパーは実行ログと Google Cloud Logging に書き込むことができます(スクリプトが標準の Cloud プロジェクトに関連付けられている場合)。 |
Blob
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copyBlob() | Blob | この blob のコピーを返します。 |
getAs(contentType) | Blob | このオブジェクト内のデータを指定したコンテンツ タイプに変換された BLOB として返します。 |
getBytes() | Byte[] | この blob に保存されているデータを取得します。 |
getContentType() | String | この blob 内のバイトのコンテンツ タイプを取得します。 |
getDataAsString() | String | この blob のデータを UTF-8 エンコードの文字列として取得します。 |
getDataAsString(charset) | String | この blob のデータを、指定されたエンコードの文字列として取得します。 |
getName() | String | この blob の名前を取得します。 |
isGoogleType() | Boolean | この Blob が Google Workspace ファイル(スプレッドシート、ドキュメントなど)かどうかを返します。 |
setBytes(data) | Blob | この blob に保存されるデータを設定します。 |
setContentType(contentType) | Blob | この blob 内のバイトのコンテンツ タイプを設定します。 |
setContentTypeFromExtension() | Blob | ファイル拡張子に基づいて、この Blob 内のバイトのコンテンツ タイプを設定します。 |
setDataFromString(string) | Blob | UTF-8 エンコードの文字列からこの blob のデータが設定されます。 |
setDataFromString(string, charset) | Blob | 指定されたエンコードの文字列からこの blob のデータを設定します。 |
setName(name) | Blob | この blob の名前を設定します。 |
BlobSource
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getAs(contentType) | Blob | このオブジェクト内のデータを指定したコンテンツ タイプに変換された BLOB として返します。 |
getBlob() | Blob | このオブジェクト内のデータを blob として返します。 |
Browser
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
Buttons | ButtonSet |
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
inputBox(prompt) | String | ユーザーのブラウザにテキスト入力ボックスを含むダイアログ ボックスをポップアップ表示します。 |
inputBox(prompt, buttons) | String | ユーザーのブラウザにテキスト入力ボックスを含むダイアログ ボックスをポップアップ表示します。 |
inputBox(title, prompt, buttons) | String | ユーザーのブラウザにテキスト入力ボックスを含むダイアログ ボックスをポップアップ表示します。 |
msgBox(prompt) | String | 指定されたメッセージと [OK] ボタンを含むダイアログ ボックスをユーザーのブラウザに表示します。 |
msgBox(prompt, buttons) | String | 指定されたメッセージと指定されたボタンを含むダイアログ ボックスをユーザーのブラウザに表示します。 |
msgBox(title, prompt, buttons) | String | 指定されたタイトル、メッセージ、ボタンを含むダイアログ ボックスをユーザーのブラウザにポップアップ表示します。 |
Button
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
CLOSE | Enum | すべてのダイアログのタイトルバーに表示される標準の閉じるボタン。 |
OK | Enum | オペレーションを続行することを示す [OK] ボタン。 |
CANCEL | Enum | オペレーションを続行しないことを示す [キャンセル] ボタン。 |
YES | Enum | 質問に対する肯定的な回答を示す [はい] ボタン。 |
NO | Enum | 質問に対する否定的な回答を示す [いいえ] ボタン。 |
ButtonSet
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
OK | Enum | 閉じるのみ可能な情報メッセージを示す 1 つの [OK] ボタン。 |
OK_CANCEL | Enum | [OK] ボタンと [キャンセル] ボタン: ユーザーがオペレーションを続行または停止できるようにします。 |
YES_NO | Enum | [はい] ボタンと [いいえ] ボタン: ユーザーがはい/いいえの質問に回答できるようにします。 |
YES_NO_CANCEL | Enum | [はい] ボタン、[いいえ] ボタン、[キャンセル] ボタン: ユーザーが「はい/いいえ」の質問に回答したり、オペレーションを停止したりできるようにします。 |
ColorType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
UNSUPPORTED | Enum | サポートされていないカラータイプ。 |
RGB | Enum | 赤、緑、青の色チャンネルで定義された色。 |
THEME | Enum | テーマのカラースキーム内のエントリを参照する色。 |
Logger
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
clear() | void | ログを消去します。 |
getLog() | String | 現在のログ内のすべてのメッセージを返します。 |
log(data) | Logger | データをログに書き込みます。 |
log(format, values) | Logger | 指定された形式と値を使用して、書式設定された文字列をロギング コンソールに書き込みます。 |
Menu
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
addItem(caption, functionName) | Menu | メニューに項目を追加します。 |
addSeparator() | Menu | メニューに視覚的な区切り線を追加します。 |
addSubMenu(menu) | Menu | メニューにサブメニューを追加します。 |
addToUi() | void | エディタのユーザー インターフェースのインスタンスにメニューを挿入します。 |
MimeType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
GOOGLE_APPS_SCRIPT | Enum | Google Apps Script プロジェクトの MIME タイプの表現。 |
GOOGLE_DRAWINGS | Enum | Google ドローファイルの MIME タイプの表現。 |
GOOGLE_DOCS | Enum | Google ドキュメント ファイルの MIME タイプの表現。 |
GOOGLE_FORMS | Enum | Google フォーム ファイルの MIME タイプの表現。 |
GOOGLE_SHEETS | Enum | Google スプレッドシート ファイルの MIME タイプの表現。 |
GOOGLE_SITES | Enum | Google サイト ファイルの MIME タイプの表現。 |
GOOGLE_SLIDES | Enum | Google スライド ファイルの MIME タイプの表現。 |
FOLDER | Enum | Google ドライブ フォルダの MIME タイプの表現。 |
SHORTCUT | Enum | Google ドライブのショートカットの MIME タイプの表現。 |
BMP | Enum | BMP 画像ファイルの MIME タイプの表現(通常は .bmp)。 |
GIF | Enum | GIF 画像ファイルの MIME タイプ(通常は .gif)の表現。 |
JPEG | Enum | JPEG 画像ファイルの MIME タイプの表現(通常は .jpg)。 |
PNG | Enum | PNG 画像ファイルの MIME タイプの表現(通常は .png)。 |
SVG | Enum | SVG 画像ファイルの MIME タイプの表現(通常は .svg)。 |
PDF | Enum | PDF ファイルの MIME タイプ(通常は .pdf)の表現。 |
CSS | Enum | CSS テキスト ファイル(通常は .css)の MIME タイプの表現。 |
CSV | Enum | CSV テキスト ファイルの MIME タイプの表現(通常は .csv)。 |
HTML | Enum | HTML テキスト ファイル(通常は .html)の MIME タイプの表現。 |
JAVASCRIPT | Enum | JavaScript テキスト ファイル(通常は .js)の MIME タイプの表現。 |
PLAIN_TEXT | Enum | プレーンテキスト ファイル(通常は .txt)の MIME タイプの表現。 |
RTF | Enum | リッチテキスト ファイル(通常は .rtf)の MIME タイプの表現。 |
OPENDOCUMENT_GRAPHICS | Enum | OpenDocument グラフィック ファイル(通常は .odg)の MIME タイプの表現。 |
OPENDOCUMENT_PRESENTATION | Enum | OpenDocument プレゼンテーション ファイルの MIME タイプの表現(通常は .odp)。 |
OPENDOCUMENT_SPREADSHEET | Enum | OpenDocument スプレッドシート ファイルの MIME タイプ(通常は .ods)の表現。 |
OPENDOCUMENT_TEXT | Enum | OpenDocument ワープロ ファイルの MIME タイプの表現(通常は .odt)。 |
MICROSOFT_EXCEL | Enum | Microsoft Excel スプレッドシート ファイルの MIME タイプ(通常は .xlsx)の表現。 |
MICROSOFT_EXCEL_LEGACY | Enum | Microsoft Excel の従来形式のファイル(通常は .xls)の MIME タイプの表現。 |
MICROSOFT_POWERPOINT | Enum | Microsoft PowerPoint プレゼンテーション ファイル(通常は .pptx)の MIME タイプの表現。 |
MICROSOFT_POWERPOINT_LEGACY | Enum | Microsoft PowerPoint の従来形式のファイル(通常は .ppt)の MIME タイプの表現。 |
MICROSOFT_WORD | Enum | Microsoft Word ドキュメント ファイル(通常は .docx)の MIME タイプの表現。 |
MICROSOFT_WORD_LEGACY | Enum | Microsoft Word の従来形式のファイル(通常は .doc)の MIME タイプの表現。 |
ZIP | Enum | ZIP アーカイブ ファイル(通常は .zip)の MIME タイプの表現。 |
Month
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
JANUARY | Enum | 1 月(月 1)。 |
FEBRUARY | Enum | 2 月(2 か月目)。 |
MARCH | Enum | 3 月(3 か月目)。 |
APRIL | Enum | 4 月(4 か月目)。 |
MAY | Enum | 5 月(5 月)。 |
JUNE | Enum | 6 月(6 か月目)。 |
JULY | Enum | 7 月(7 月)。 |
AUGUST | Enum | 8 月(8 か月目)。 |
SEPTEMBER | Enum | 9 月(9 月)。 |
OCTOBER | Enum | 10 月(10 月)。 |
NOVEMBER | Enum | 11 月(11 月)。 |
DECEMBER | Enum | 12 月(月 12)。 |
PromptResponse
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getResponseText() | String | ユーザーがダイアログの入力フィールドに入力したテキストを取得します。 |
getSelectedButton() | Button | ユーザーがクリックしてダイアログを閉じたボタンを取得します。 |
RgbColor
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
asHexString() | String | 色を CSS スタイルの 7 文字の 16 進数文字列(#rrggbb)または 9 文字の 16 進数文字列(#aarrggbb)として返します。 |
getBlue() | Integer | この色の青色チャネル(0 ~ 255 の整数)。 |
getColorType() | ColorType | この色のタイプを取得します。 |
getGreen() | Integer | この色の緑色チャネル(0 ~ 255 の数値)。 |
getRed() | Integer | この色の赤色チャネル(0 ~ 255 の整数)。 |
Session
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getActiveUser() | User | 現在のユーザーに関する情報を取得します。 |
getActiveUserLocale() | String | 現在のユーザーの言語設定を文字列として取得します(英語の場合は en など)。 |
getEffectiveUser() | User | スクリプトが実行されているユーザーの権限に関する情報を取得します。 |
getScriptTimeZone() | String | スクリプトのタイムゾーンを取得します。 |
getTemporaryActiveUserKey() | String | アクティブなユーザーに固有の、ユーザー ID を公開しない一時キーを取得します。 |
Ui
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
Button | Button | アラートまたは PromptResponse.getSelectedButton() によって返される、事前定義されたローカライズされたダイアログ ボタンを表す列挙型。ユーザーがダイアログ内のどのボタンをクリックしたかを示します。 |
ButtonSet | ButtonSet | アラートまたはプロンプトに追加できる、事前定義されたローカライズされた 1 つ以上のダイアログ ボタンのセットを表現する列挙型。 |
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
alert(prompt) | Button | 指定されたメッセージと [OK] ボタンを含むダイアログ ボックスがユーザーのエディタで開きます。 |
alert(prompt, buttons) | Button | 指定されたメッセージとボタンのセットが含まれるダイアログ ボックスをユーザーのエディタで開きます。 |
alert(title, prompt, buttons) | Button | 指定されたタイトル、メッセージ、ボタンのセットで、ユーザーのエディタにダイアログ ボックスを開きます。 |
createAddonMenu() | Menu | エディタの [Extensions] メニューにサブメニューを挿入するために使用できるビルダーを作成します。 |
createMenu(caption) | Menu | エディタのユーザー インターフェースにメニューを追加するために使用できるビルダーを作成します。 |
prompt(prompt) | PromptResponse | 指定されたメッセージと [OK] ボタンを含む入力ダイアログ ボックスがユーザーのエディタで開きます。 |
prompt(prompt, buttons) | PromptResponse | 指定されたメッセージとボタンのセットで、ユーザーのエディタに入力ダイアログ ボックスを開きます。 |
prompt(title, prompt, buttons) | PromptResponse | 指定されたタイトル、メッセージ、ボタンのセットで、ユーザーのエディタに入力ダイアログ ボックスを開きます。 |
showModalDialog(userInterface, title) | void | カスタムのクライアントサイド コンテンツを含むモーダル ダイアログ ボックスがユーザーのエディタで開きます。 |
showModelessDialog(userInterface, title) | void | ユーザーのエディタに、カスタムのクライアントサイド コンテンツを含むモーダルのないダイアログ ボックスを開きます。 |
showSidebar(userInterface) | void | ユーザーのエディタに、カスタムのクライアントサイド コンテンツを含むサイドバーが開きます。 |
User
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
getEmail() | String | ユーザーのメールアドレスを取得します(利用可能な場合)。 |
Weekday
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
SUNDAY | Enum | Sunday |
MONDAY | Enum | 月曜日。 |
TUESDAY | Enum | 火曜日です。 |
WEDNESDAY | Enum | 水曜日。 |
THURSDAY | Enum | 木曜日です。 |
FRIDAY | Enum | 金曜日。 |
SATURDAY | Enum | 指定します。 |
console
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
error() | void | 空の ERROR レベルのメッセージを Stackdriver Logging に出力します。 |
error(formatOrObject, values) | void | ERROR レベルのメッセージを Stackdriver Logging に出力します。 |
info() | void | 空の INFO レベルのメッセージを Stackdriver Logging に出力します。 |
info(formatOrObject, values) | void | INFO レベルのメッセージを Stackdriver Logging に出力します。 |
log() | void | 空の DEBUG レベルのメッセージを Stackdriver Logging に出力します。 |
log(formatOrObject, values) | void | DEBUG レベルのメッセージを Stackdriver Logging に出力します。 |
time(label) | void | オペレーションの所要時間をトラッキングするために使用できるタイマーを開始します。 |
timeEnd(label) | void | console.time() を呼び出して以前に開始したタイマーを停止します。 |
warn() | void | 空の WARNING レベルのメッセージを Stackdriver Logging に出力します。 |
warn(formatOrObject, values) | void | WARNING レベルのメッセージを Stackdriver Logging に出力します。 |