Base Service

ベース

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

クラス

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

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|nullユーザーのブラウザにテキスト入力ボックスを含むダイアログ ボックスを表示します。
inputBox(prompt, buttons)String|nullユーザーのブラウザにテキスト入力ボックスを含むダイアログ ボックスを表示します。
inputBox(title, prompt, buttons)String|nullユーザーのブラウザにテキスト入力ボックスを含むダイアログ ボックスを表示します。
msgBox(prompt)String|nullユーザーのブラウザに、指定されたメッセージと [OK] ボタンを含むダイアログ ボックスを表示します。
msgBox(prompt, buttons)String|null指定されたメッセージとボタンを含むダイアログ ボックスをユーザーのブラウザにポップアップします。
msgBox(title, prompt, buttons)String|null指定されたタイトル、メッセージ、ボタンを含むダイアログ ボックスをユーザーのブラウザにポップアップ表示します。

Button

プロパティ

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

ButtonSet

プロパティ

プロパティタイプ説明
OKEnum[OK] ボタンが 1 つだけ表示され、閉じることができる情報メッセージであることを示しています。
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 画像ファイル(通常は .bmp)の MIME タイプの表現。
GIFEnumGIF 画像ファイル(通常は .gif)の MIME タイプの表現。
JPEGEnumJPEG 画像ファイル(通常は .jpg)の MIME タイプの表現。
PNGEnumPNG 画像ファイル(通常は .png)の MIME タイプの表現。
SVGEnumSVG 画像ファイル(通常は .svg)の MIME タイプの表現。
PDFEnumPDF ファイル(通常は .pdf)の MIME タイプの表現。
CSSEnumCSS テキスト ファイル(通常は .css)の MIME タイプの表現。
CSVEnumCSV テキスト ファイル(通常は .csv)の MIME タイプの表現。
HTMLEnumHTML テキスト ファイル(通常は .html)の MIME タイプの表現。
JAVASCRIPTEnumJavaScript テキスト ファイル(通常は .js)の MIME タイプの表現。
PLAIN_TEXTEnumプレーン テキスト ファイル(通常は .txt)の MIME タイプの表現。
RTFEnumリッチテキスト ファイル(通常は .rtf)の MIME タイプの表現。
OPENDOCUMENT_GRAPHICSEnumOpenDocument グラフィック ファイル(通常は .odg)の MIME タイプの表現。
OPENDOCUMENT_PRESENTATIONEnumOpenDocument プレゼンテーション ファイル(通常は .odp)の MIME タイプの表現。
OPENDOCUMENT_SPREADSHEETEnumOpenDocument スプレッドシート ファイル(通常は .ods)の MIME タイプの表現。
OPENDOCUMENT_TEXTEnumOpenDocument ワード プロセッサ ファイル(通常は .odt)の MIME タイプの表現。
MICROSOFT_EXCELEnumMicrosoft Excel スプレッドシート ファイル(通常は .xlsx)の MIME タイプの表現。
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アクティブ ユーザーに固有の一時キーを取得しますが、ユーザーの身元は明らかにしません。

Ui

プロパティ

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

メソッド

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

メソッド

メソッド戻り値の型概要
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()voidStackdriver Logging に空白の DEBUG レベルのメッセージを出力します。
log(formatOrObject, values)voidDEBUG レベルのメッセージを Stackdriver Logging に出力します。
time(label)voidオペレーションの所要時間を追跡するために使用できるタイマーを開始します。
timeEnd(label)voidconsole.time() の呼び出しによって以前に開始されたタイマーを停止します。
warn()voidStackdriver Logging に空白の WARNING レベルのメッセージを出力します。
warn(formatOrObject, values)voidWARNING レベルのメッセージを Stackdriver Logging に出力します。