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赤、緑、青のカラー チャンネルで定義される色。
Sessionセッション クラスは、ユーザーのメールアドレス(状況によっては)や言語設定などのセッション情報へのアクセスを提供します。
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「はい」ボタン、「いいえ」ボタン、「キャンセル」ボタン。ユーザーは「はい/いいえ」と答えるか、操作を停止します。

ColorType

プロパティ

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

Logger

Methods

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

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 画像ファイル(通常は .bmp)の MIME タイプを表します。
GIFEnumGIF 画像ファイル(通常は .gif)の MIME タイプを表します。
JPEGEnumJPEG 画像ファイル(通常は .jpg)の MIME タイプを表します。
PNGEnumPNG 画像ファイル(通常は .png)の MIME タイプを表します。
SVGEnumSVG 画像ファイル(通常は .svg)の MIME タイプを表します。
PDFEnumPDF ファイルの MIME タイプを表します(通常は .pdf)。
CSSEnumCSS テキスト ファイルの MIME タイプを表します(通常は .css)。
CSVEnumCSV テキスト ファイル(通常は .csv)の MIME タイプを表します。
HTMLEnumHTML テキスト ファイルの MIME タイプ(通常は .html)を表します。
JAVASCRIPTEnumJavaScript テキスト ファイルの MIME タイプを表します(通常は .js)。
PLAIN_TEXTEnum書式なしテキスト ファイルの MIME タイプを表します(通常は .txt)。
RTFEnumリッチ テキスト ファイルの MIME タイプを表します(通常は .rtf)。
OPENDOCUMENT_GRAPHICSEnumOpenDocument グラフィック ファイル(通常は .odg)の MIME タイプを表します。
OPENDOCUMENT_PRESENTATIONEnumOpenDocument プレゼンテーション ファイルの MIME タイプを表します(通常は .odp)。
OPENDOCUMENT_SPREADSHEETEnumOpenDocument スプレッドシート ファイルの MIME タイプ(通常は .ods)を表します。
OPENDOCUMENT_TEXTEnumOpenDocument 文書処理ファイルの MIME タイプを表します(通常は .odt)。
MICROSOFT_EXCELEnumMicrosoft Excel スプレッドシート ファイルの MIME タイプを表します(通常は .xlsx)。
MICROSOFT_EXCEL_LEGACYEnum従来の Microsoft Excel ファイル(通常は .xls)の MIME タイプを表します。
MICROSOFT_POWERPOINTEnumMicrosoft PowerPoint プレゼンテーション ファイルの MIME タイプを表します(通常は .pptx)。
MICROSOFT_POWERPOINT_LEGACYEnumMicrosoft PowerPoint の従来のファイルの MIME タイプを表します(通常は .ppt)。
MICROSOFT_WORDEnumMicrosoft Word ドキュメント ファイルの MIME タイプを表します(通常は .docx)。
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

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()void空のエラーレベルのメッセージを 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空の警告レベル メッセージを Stackdriver Logging に出力します。
warn(formatOrObject, values)voidStackdriver Logging に警告レベルのメッセージを出力します。