Base Service

ベース

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

クラス

名前概要
BlobApps Script サービスのデータ交換オブジェクト。
BlobSourceデータを Blob としてエクスポートできるオブジェクトのインターフェース。
Browserこのクラスは、Google スプレッドシートに固有のダイアログ ボックスにアクセスできるようにします。
Buttonalert または PromptResponse.getSelectedButton() によって返される、事前定義されたローカライズされたダイアログ ボタンを表す列挙型。ユーザーがダイアログ内のどのボタンをクリックしたかを示します。
ButtonSetalert または prompt に追加できる、1 つ以上のダイアログ ボタンの事前定義されたローカライズ済みセットを表す列挙型。
ColorType色の種類
Loggerこのクラスを使用すると、デベロッパーは実行ログと Google Cloud Logging に書き込むことができます(スクリプトが標準の Cloud プロジェクトに関連付けられている場合)。
MenuGoogle アプリのユーザー インターフェースのインスタンス内のカスタム メニュー。
MimeType文字列を明示的に入力せずに MIME タイプの宣言にアクセスできる列挙型。
Month1 年の月を表す列挙型。
PromptResponseGoogle アプリのユーザー インターフェース環境に表示される prompt ダイアログへのレスポンス。
RgbColor赤、緑、青の色チャンネルで定義された色。
SessionSession クラスを使用すると、ユーザーのメールアドレス(場合によって)や言語設定などのセッション情報にアクセスできます。
UiGoogle アプリのユーザー インターフェース環境のインスタンスで、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。
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)BlobUTF-8 エンコードの文字列からこの blob のデータが設定されます。
setDataFromString(string, charset)Blob指定されたエンコードの文字列からこの blob のデータを設定します。
setName(name)Blobこの blob の名前を設定します。

BlobSource

メソッド

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

Browser

プロパティ

プロパティタイプ説明
ButtonsButtonSet

メソッド

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

プロパティ

プロパティタイプ説明
OKEnum閉じるのみ可能な情報メッセージを示す 1 つの [OK] ボタン。
OK_CANCELEnum[OK] ボタンと [キャンセル] ボタン: ユーザーがオペレーションを続行または停止できるようにします。
YES_NOEnum[はい] ボタンと [いいえ] ボタン: ユーザーがはい/いいえの質問に回答できるようにします。
YES_NO_CANCELEnum[はい] ボタン、[いいえ] ボタン、[キャンセル] ボタン: ユーザーが「はい/いいえ」の質問に回答したり、オペレーションを停止したりできるようにします。

ColorType

プロパティ

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

Logger

メソッド

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

メソッド

メソッド戻り値の型概要
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 画像ファイルの MIME タイプ(通常は .gif)の表現。
JPEGEnumJPEG 画像ファイルの MIME タイプの表現(通常は .jpg)。
PNGEnumPNG 画像ファイルの MIME タイプの表現(通常は .png)。
SVGEnumSVG 画像ファイルの MIME タイプの表現(通常は .svg)。
PDFEnumPDF ファイルの MIME タイプ(通常は .pdf)の表現。
CSSEnumCSS テキスト ファイル(通常は .css)の MIME タイプの表現。
CSVEnumCSV テキスト ファイルの MIME タイプの表現(通常は .csv)。
HTMLEnumHTML テキスト ファイル(通常は .html)の MIME タイプの表現。
JAVASCRIPTEnumJavaScript テキスト ファイル(通常は .js)の MIME タイプの表現。
PLAIN_TEXTEnumプレーンテキスト ファイル(通常は .txt)の MIME タイプの表現。
RTFEnumリッチテキスト ファイル(通常は .rtf)の MIME タイプの表現。
OPENDOCUMENT_GRAPHICSEnumOpenDocument グラフィック ファイル(通常は .odg)の MIME タイプの表現。
OPENDOCUMENT_PRESENTATIONEnumOpenDocument プレゼンテーション ファイルの MIME タイプの表現(通常は .odp)。
OPENDOCUMENT_SPREADSHEETEnumOpenDocument スプレッドシート ファイルの MIME タイプ(通常は .ods)の表現。
OPENDOCUMENT_TEXTEnumOpenDocument ワープロ ファイルの MIME タイプの表現(通常は .odt)。
MICROSOFT_EXCELEnumMicrosoft Excel スプレッドシート ファイルの MIME タイプ(通常は .xlsx)の表現。
MICROSOFT_EXCEL_LEGACYEnumMicrosoft Excel の従来形式のファイル(通常は .xls)の MIME タイプの表現。
MICROSOFT_POWERPOINTEnumMicrosoft PowerPoint プレゼンテーション ファイル(通常は .pptx)の MIME タイプの表現。
MICROSOFT_POWERPOINT_LEGACYEnumMicrosoft PowerPoint の従来形式のファイル(通常は .ppt)の MIME タイプの表現。
MICROSOFT_WORDEnumMicrosoft Word ドキュメント ファイル(通常は .docx)の MIME タイプの表現。
MICROSOFT_WORD_LEGACYEnumMicrosoft Word の従来形式のファイル(通常は .doc)の MIME タイプの表現。
ZIPEnumZIP アーカイブ ファイル(通常は .zip)の MIME タイプの表現。

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

メソッド

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

プロパティ

プロパティタイプ説明
ButtonButtonアラートまたは PromptResponse.getSelectedButton() によって返される、事前定義されたローカライズされたダイアログ ボタンを表す列挙型。ユーザーがダイアログ内のどのボタンをクリックしたかを示します。
ButtonSetButtonSetアラートまたはプロンプトに追加できる、事前定義されたローカライズされた 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

プロパティ

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

console

メソッド

メソッド戻り値の型概要
error()void空の ERROR レベルのメッセージを Stackdriver Logging に出力します。
error(formatOrObject, values)voidERROR レベルのメッセージを Stackdriver Logging に出力します。
info()void空の INFO レベルのメッセージを Stackdriver Logging に出力します。
info(formatOrObject, values)voidINFO レベルのメッセージを Stackdriver Logging に出力します。
log()void空の DEBUG レベルのメッセージを Stackdriver Logging に出力します。
log(formatOrObject, values)voidDEBUG レベルのメッセージを Stackdriver Logging に出力します。
time(label)voidオペレーションの所要時間をトラッキングするために使用できるタイマーを開始します。
timeEnd(label)voidconsole.time() を呼び出して以前に開始したタイマーを停止します。
warn()void空の WARNING レベルのメッセージを Stackdriver Logging に出力します。
warn(formatOrObject, values)voidWARNING レベルのメッセージを Stackdriver Logging に出力します。