Base Service

ベース

このサービスでは、メールアドレスやユーザー名などのユーザー情報にアクセスできます。また、Google Workspace アプリケーションのスクリプトのログとダイアログ ボックスも制御します。

クラス

名前概要
BlobApps Script サービス用のデータ交換オブジェクト。
BlobSourceデータを Blob としてエクスポートできるオブジェクトのインターフェース。
Browserこのクラスを使用すると、Google スプレッドシート固有のダイアログ ボックスにアクセスできます。
Buttonalert または PromptResponse.getSelectedButton() によって返される、ローカライズされた事前定義のダイアログ ボタンを表す列挙型。ダイアログ内のどのボタンをクリックしたかを示します。
ButtonSetalert または prompt に追加できる 1 つ以上のダイアログ ボタンのローカライズされた事前定義済みのセットを表す列挙型。
ColorType色の種類
Loggerこのクラスを使用すると、デベロッパーはデバッグログにテキストを書き出すことができます。
MenuGoogle アプリのユーザー インターフェースのインスタンス内のカスタム メニュー。
MimeType文字列を明示的に入力せずに MIME タイプ宣言にアクセスできるようにする列挙型。
Month月を表す列挙型。
PromptResponseGoogle アプリのユーザー インターフェース環境に表示される prompt ダイアログへのレスポンス。
RgbColor赤、緑、青のカラー チャネルで定義される色。
SessionSession クラスは、ユーザーのメールアドレス(状況によっては)や言語設定などのセッション情報へのアクセスを提供します。
Uiスクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できるようにする Google アプリのユーザー インターフェース環境のインスタンス。
Userスクリプトの作成に適した、ユーザーを表します。
Weekday曜日を表す列挙型。
consoleデベロッパーはこのクラスを使用して、Google Cloud Platform の Stackdriver Logging サービスにログを書き込むことができます。

Blob

Methods

メソッド戻り値の型概要
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)BlobUTF-8 エンコードの文字列からこの blob のデータを設定します。
setDataFromString(string, charset)Blob指定されたエンコードを使用して、文字列からこの blob のデータを設定します。
setName(name)Blobこの blob の名前を設定します。

BlobSource

Methods

メソッド戻り値の型概要
getAs(contentType)Blobこのオブジェクト内のデータを、指定されたコンテンツ タイプに変換された blob として返します。
getBlob()Blobこのオブジェクト内のデータを blob として返します。

Browser

プロパティ

プロパティ種類説明
ButtonsButtonSet

Methods

メソッド戻り値の型概要
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

プロパティ

プロパティ種類説明
CLOSEEnumすべてのダイアログのタイトルバーに表示される標準の閉じるボタン。
OKEnum操作の続行が必要であることを示す「OK」ボタン。
CANCELEnumオペレーションを続行しないことを示す [キャンセル] ボタン。
YESEnum質問に肯定的な回答が得られたことを示す [はい] ボタン。
NOEnum質問に対して否定的な回答があることを示す [いいえ] ボタン。

ButtonSet

プロパティ

プロパティ種類説明
OKEnum1 つの「OK」ボタン。閉じることのみ可能な情報メッセージがあることを示します。
OK_CANCELEnum「OK」ボタンと「キャンセル」ボタン。ユーザーが操作を続行することも、中止することもできます。
YES_NOEnumユーザーが「はい」か「いいえ」で回答できる「はい」ボタンと「いいえ」ボタン。
YES_NO_CANCELEnum[はい] ボタン、[いいえ] ボタン、[キャンセル] ボタンの 3 つのボタンで、ユーザーが「はい/いいえ」の質問に答えるか、オペレーションを中止できます。

ColorType

プロパティ

プロパティ種類説明
UNSUPPORTEDEnumサポートされていない色タイプ。
RGBEnum赤、緑、青のカラー チャネルで定義される色。
THEMEEnumテーマのカラーパターンのエントリを表す色。

Logger

Methods

メソッド戻り値の型概要
clear()voidログを消去します。
getLog()String現在のログ内のすべてのメッセージのリストを返します。
log(data)Logger文字列をロギング コンソールに書き込みます。
log(format, values)Logger指定された形式と値を使用して、書式設定された文字列をロギング コンソールに書き込みます。

Methods

メソッド戻り値の型概要
addItem(caption, functionName)Menuメニューにアイテムを追加します。
addSeparator()Menuメニューに視覚的な区切り文字を追加します。
addSubMenu(menu)Menuメニューにサブメニューを追加します。
addToUi()voidエディタのユーザー インターフェースのインスタンスにメニューを挿入します。

MimeType

プロパティ

プロパティ種類説明
GOOGLE_APPS_SCRIPTEnumGoogle Apps Script プロジェクトの MIME タイプを表します。
GOOGLE_DRAWINGSEnumGoogle 図形描画 ファイルの MIME タイプを表します。
GOOGLE_DOCSEnumGoogle ドキュメント ファイルの MIME タイプを表します。
GOOGLE_FORMSEnumGoogle フォーム ファイルの MIME タイプを表します。
GOOGLE_SHEETSEnumGoogle スプレッドシート ファイルの MIME タイプを表します。
GOOGLE_SITESEnumGoogle サイト ファイルの MIME タイプを表します。
GOOGLE_SLIDESEnumGoogle スライド ファイルの MIME タイプを表します。
FOLDEREnumGoogle ドライブ フォルダの MIME タイプを表します。
SHORTCUTEnumGoogle ドライブのショートカットの MIME タイプを表します。
BMPEnumBMP 画像ファイルの MIME タイプ(通常は .bmp)を表します。
GIFEnumGIF 画像ファイル(通常は .gif)の MIME タイプを表します。
JPEGEnumJPEG 画像ファイルの MIME タイプ(通常は .jpg)の表現。
PNGEnumPNG 画像ファイルの MIME タイプ(通常は .png)を表します。
SVGEnumSVG 画像ファイル(通常は .svg)の MIME タイプを表します。
PDFEnumPDF ファイル(通常は .pdf)の MIME タイプを表します。
CSSEnumCSS テキスト ファイル(通常は .css)の MIME タイプを表します。
CSVEnumCSV テキスト ファイル(通常は .csv)の MIME タイプを表します。
HTMLEnumHTML テキスト ファイルの MIME タイプ(通常は .html)を表します。
JAVASCRIPTEnumJavaScript テキスト ファイル(通常は .js)の MIME タイプを表します。
PLAIN_TEXTEnum書式なしテキスト ファイルの MIME タイプ(通常は .txt)を表します。
RTFEnumリッチテキスト ファイル(通常は .rtf)の MIME タイプを表します。
OPENDOCUMENT_GRAPHICSEnumOpenDocument グラフィック ファイルの MIME タイプ(通常は .odg)を表します。
OPENDOCUMENT_PRESENTATIONEnumOpenDocument プレゼンテーション ファイルの MIME タイプを表します(通常は .odp)。
OPENDOCUMENT_SPREADSHEETEnumOpenDocument スプレッドシート ファイルの MIME タイプを表します(通常は .ods)。
OPENDOCUMENT_TEXTEnumOpenDocument ワープロ ファイルの MIME タイプ(通常は .odt)の表現。
MICROSOFT_EXCELEnumMicrosoft Excel スプレッドシート ファイル(通常は .xlsx)の MIME タイプを表します。
MICROSOFT_EXCEL_LEGACYEnum以前の Microsoft Excel ファイル(通常は .xls)の MIME タイプを表します。
MICROSOFT_POWERPOINTEnumMicrosoft PowerPoint プレゼンテーション ファイルの MIME タイプ(通常は .pptx)を表します。
MICROSOFT_POWERPOINT_LEGACYEnumMicrosoft PowerPoint のレガシー ファイル(通常は .ppt)の MIME タイプを表します。
MICROSOFT_WORDEnumMicrosoft Word ドキュメント ファイルの MIME タイプ(通常は .docx)を表します。
MICROSOFT_WORD_LEGACYEnum以前の Microsoft Word ファイル(通常は .doc)の MIME タイプを表します。
ZIPEnumZIP アーカイブ ファイルの MIME タイプ(通常は .zip)を表します。

Month

プロパティ

プロパティ種類説明
JANUARYEnum1 月(1 か月目)
FEBRUARYEnum2 月(2 か月目)
MARCHEnum3 月(3 か月目)
APRILEnum4 月(4 か月目)
MAYEnum5 月(5 か月目)
JUNEEnum6 月(6 か月目)
JULYEnum7 月(7 か月目)
AUGUSTEnum8 月(8 か月目)
SEPTEMBEREnum9 月(9 か月目)
OCTOBEREnum10 月(10 か月目)
NOVEMBEREnum11 月(11 か月目)
DECEMBEREnum12 月(12 か月目)

PromptResponse

Methods

メソッド戻り値の型概要
getResponseText()Stringユーザーがダイアログの入力フィールドに入力したテキストを取得します。
getSelectedButton()Buttonユーザーがダイアログを閉じるためにクリックしたボタンを取得します。

RgbColor

Methods

メソッド戻り値の型概要
asHexString()String色を CSS スタイルの 7 文字の 16 進文字列(#rrggbb)または 9 文字の 16 進文字列(#aarrggbb)として返します。
getBlue()Integerこの色の青色チャネル(0 ~ 255 の数値)。
getColorType()ColorTypeこの色のタイプを取得します。
getGreen()Integerこの色の緑のチャネル(0 ~ 255 の数値)。
getRed()Integerこの色の赤チャネル(0 ~ 255 の数値)。

Session

Methods

メソッド戻り値の型概要
getActiveUser()User現在のユーザーに関する情報を取得します。
getActiveUserLocale()String現在のユーザーの言語設定を文字列として取得します。たとえば、英語の場合は en です。
getEffectiveUser()Userスクリプトを実行しているユーザーの権限を取得します。
getScriptTimeZone()Stringスクリプトのタイムゾーンを取得します。
getTemporaryActiveUserKey()Stringアクティブ ユーザーに固有の一時キーを取得しますが、ユーザー ID は公開しません。

Ui

プロパティ

プロパティ種類説明
ButtonButtonアラートまたは PromptResponse.getSelectedButton() によって返される、ローカライズされた事前定義のダイアログ ボタンを表す列挙型。ダイアログ内でユーザーがクリックしたボタンを示します。
ButtonSetButtonSetアラートまたはプロンプトに追加できる 1 つ以上のダイアログ ボタンのローカライズされた事前定義済みセットを表す列挙型。

Methods

メソッド戻り値の型概要
alert(prompt)Buttonユーザーのエディタでダイアログ ボックスが開き、指定したメッセージと [OK] ボタンが表示されます。
alert(prompt, buttons)Buttonユーザーのエディタでダイアログ ボックスを開き、指定したメッセージと一連のボタンを表示します。
alert(title, prompt, buttons)Buttonユーザーのエディタでダイアログ ボックスが開き、指定されたタイトル、メッセージ、一連のボタンが表示されます。
createAddonMenu()Menuエディタの拡張機能メニューにサブメニューを挿入するために使用できるビルダーを作成します。
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

Methods

メソッド戻り値の型概要
getEmail()Stringユーザーのメールアドレスを取得します(利用可能な場合)。

Weekday

プロパティ

プロパティ種類説明
SUNDAYEnumSunday
MONDAYEnum月曜日
TUESDAYEnum火曜日
WEDNESDAYEnum水曜日
THURSDAYEnum木曜日
FRIDAYEnum金曜日
SATURDAYEnum指定します。

console

Methods

メソッド戻り値の型概要
error()voidStackdriver Logging に空のエラー レベルのメッセージを出力します。
error(formatOrObject, values)voidStackdriver Logging にエラーレベルのメッセージを出力します。
info()void空の INFO レベルのメッセージを Stackdriver Logging に出力します。
info(formatOrObject, values)voidStackdriver Logging に INFO レベルのメッセージを出力します。
log()void空の DEBUG レベルのメッセージを Stackdriver Logging に出力します。
log(formatOrObject, values)voidStackdriver Logging に DEBUG レベルのメッセージを出力します。
time(label)void操作にかかった時間をトラッキングするためのタイマーを開始します。
timeEnd(label)void以前に console.time() を呼び出して開始したタイマーを停止します。
warn()voidStackdriver Logging に空の警告レベルのメッセージを出力します。
warn(formatOrObject, values)voidStackdriver Logging に警告レベルのメッセージを出力します。