Package apps.extensions.markup

インデックス

• CalendarClientActionMarkup（メッセージ）
• CalendarClientActionMarkup.AddAttachmentsActionMarkup（メッセージ）
• CalendarClientActionMarkup.AddAttachmentsActionMarkup.AddonAttachment（メッセージ）
• CalendarClientActionMarkup.CalendarSubscriptionActionMarkup（メッセージ）
• CalendarClientActionMarkup.CalendarSubscriptionActionMarkup.Operation（列挙型）
• CalendarClientActionMarkup.ConferenceDataMarkup（メッセージ）
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup（メッセージ）
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Feature（列挙型）
• CalendarClientActionMarkup.ConferenceDataMarkup.EntryPointMarkup.Type（列挙型）
• CalendarClientActionMarkup.ConferenceDataMarkup.Error（メッセージ）
• CalendarClientActionMarkup.ConferenceDataMarkup.Error.Type（列挙型）
• CalendarClientActionMarkup.ConferenceDataMarkup.Parameter（メッセージ）
• CalendarClientActionMarkup.CreateConferenceDataActionMarkup（メッセージ）
• CalendarClientActionMarkup.CreateConferenceSettingUrlActionMarkup（メッセージ）
• CalendarClientActionMarkup.EditAttendeesActionMarkup（メッセージ）
• CalendarClientActionMarkup.EditConferenceDataActionMarkup（メッセージ）
• ChatClientDataSourceMarkup（メッセージ）
• ChatClientDataSourceMarkup.SpaceDataSource（メッセージ）
• ChatDataActionMarkup（メッセージ）
• ChatDataActionMarkup.CreateMessageAction（メッセージ）
• ChatDataActionMarkup.UpdateInlinePreviewAction（メッセージ）
• ChatDataActionMarkup.UpdateMessageAction（メッセージ）
• DriveClientActionMarkup（メッセージ）
• DriveClientActionMarkup.RequestFileScope（メッセージ）
• EditorClientActionMarkup（メッセージ）
• EditorClientActionMarkup.RequestFileScopeForActiveDocument（メッセージ）
• GmailClientActionMarkup（メッセージ）
• GmailClientActionMarkup.AddonComposeUiActionMarkup（メッセージ）
• GmailClientActionMarkup.AddonComposeUiActionMarkup.AddonComposeUiActionType（列挙型）
• GmailClientActionMarkup.OpenCreatedDraftActionMarkup（メッセージ）
• GmailClientActionMarkup.TaskActionMarkup（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup.Recipient（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBccRecipients（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.ContentType（列挙型）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.EmailMimeType（列挙型）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.InsertContent（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateBody.Type（列挙型）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateCcRecipients（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateSubject（メッセージ）
• GmailClientActionMarkup.UpdateDraftActionMarkup.UpdateToRecipients（メッセージ）
• HostAppActionMarkup（メッセージ）
• HostAppDataActionMarkup（メッセージ）
• HostAppDataSourceMarkup（メッセージ）
• SheetsClientActionMarkup（メッセージ）
• SheetsClientActionMarkup.CustomFunctionReturnValueMarkup（メッセージ）

CalendarClientActionMarkup

フィールド
editAttendeesActionMarkup	EditAttendeesActionMarkup Google カレンダーの予定に参加者を追加するアクション。
editConferenceDataActionMarkup	EditConferenceDataActionMarkup 会議データを Google カレンダーの予定に追加するアクション。サードパーティ製会議アドオンは Apps Script でのみ構築できます。
addAttachmentsActionMarkup	AddAttachmentsActionMarkup Google カレンダーの予定に添付ファイルを追加するアクション。
createConferenceDataActionMarkup	CreateConferenceDataActionMarkup Google カレンダーの予定を作成する際に会議データを表示するアクション。
createConferenceSettingUrlActionMarkup	CreateConferenceSettingUrlActionMarkup createconference 設定 URL を生成するアクション。
calendarSubscriptionActionMarkup	CalendarSubscriptionActionMarkup カレンダーの定期購入を管理するアクション。HTTP エンドポイント アドオンでのみサブスクリプションの作成をサポートします。Apps Script アドオンには適用されません。

AddAttachmentsActionMarkup

フィールド
addonAttachments[]	AddonAttachment

AddonAttachment

フィールド
resourceUrl	string
title	string 添付ファイルのタイトル。
mimeType	string resourceUrl のコンテンツの MIME タイプ。
iconUrl	string リソースのアイコンへのリンク。

CalendarSubscriptionActionMarkup

フィールド
operation	Operation 実行するオペレーション。現在、サポートされているのは CREATE のみです。
calendarId	string 登録するカレンダーの ID。

オペレーション

列挙型
OPERATION_UNSPECIFIED
CREATE

ConferenceDataMarkup

Google カレンダーの予定に関連付けられた会議データを定義するマークアップ。サードパーティ製会議アドオンは Apps Script でのみ構築できます。

フィールド
conferenceId	string この会議データの一意の識別子。最大 512 文字。
entryPoints[]	EntryPointMarkup 会議へのエントリ ポイント。最大 300 個のエントリ ポイントを指定できます。
parameters[]	Parameter アドオンの追加パラメータ。パラメータは最大 300 個まで指定できます。
error	Error 設定されている場合、会議の作成中にエラーが発生したことを意味します。
note	string ユーザーに表示する追加のメモ（管理者からの指示、法的通知など）。HTML を含めることができます。最大長は 2,048 文字です。
conferenceSolutionId	string 会議ソリューションの識別子。デプロイの calendar.conferenceSolution.id フィールドの値と一致する必要があります。

EntryPointMarkup

会議に参加する方法。サードパーティ製会議アドオンは Apps Script でのみ構築できます。

フィールド
type	Type エントリ ポイントのタイプ。必須。
uri	string 会議に参加するための URI。tel: と http(s): をサポートしており、1,300 文字以内で指定する必要があります。必須。
label	string ユーザーに表示するエントリ ポイントのラベル。最大 512 文字。
meetingCode	string 会議にアクセスするための会議コード。最大 128 文字。
accessCode	string 会議にアクセスするためのアクセスコード。最大 128 文字。
passcode	string 会議にアクセスするためのパスコード。最大 128 文字。
password	string 会議にアクセスするためのパスワード。最大 128 文字。
pin	string 会議にアクセスするための PIN。最大 128 文字。
regionCode	string このエントリ ポイントに関連付けられている国の CLDR/ISO 3166 地域コード。Type.PHONE にのみ適用されます。
features[]	Feature エントリ ポイントの機能（有料か無料かなど）。1 つのエントリ ポイントに複数の機能を含めることができます。

機能

エントリ ポイントの機能。一部の機能は、特定の入り口にのみ適用される場合があります。

列挙型
UNKNOWN_FEATURE	不明な機能。
TOLL	PHONE エントリ ポイントに適用されます。有料番号への通話は、発信者に課金されます。有料と無料の電話番号を同時に設定することはできません。
TOLL_FREE	PHONE エントリ ポイントに適用されます。発信者にとって、フリーダイヤルへの通話は無料です。有料と無料の電話番号を同時に設定することはできません。

タイプ

エントリ ポイントのタイプ。サードパーティ製会議アドオンは Apps Script でのみ構築できます。

列挙型
UNKNOWN	不明な会議タイプ。
VIDEO	ビデオ会議。
PHONE	電話会議。
MORE	会議への参加に関する詳細情報へのリンクを提供するために使用されます。
SIP	セッション開始プロトコルを使用する会議

エラー

会議の作成中に発生したエラーを表します。サードパーティ製会議アドオンは Apps Script でのみ構築できます。

フィールド
type	Type エラーのタイプ。必須。
authenticationUrl	string エラータイプが AUTHENTICATION の場合、アドオンはユーザーがログインできる URL を提供できます。最大 1,300 文字。

タイプ

列挙型
UNKNOWN	不明なエラーです。
AUTHENTICATION	認証エラー。
TEMPORARY	一時的なエラーです。
PERMANENT	永続的なエラーです。
PERMISSION_DENIED	ユーザーは、サードパーティ製会議システムで一部のアクションを実行できません。
CONFERENCE_SOLUTION_FORBIDDEN	選択した会議ソリューションを使用できない（ただし、アドオンが提供する他のソリューションは使用できる場合がある）。

パラメータ

イベントデータとともに保持され、更新または削除が必要な場合はアドオンに渡されるソリューション固有のパラメータ。例: [{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

フィールド
key	string パラメータのキー。最大 50 文字。必須。
value	string パラメータ値。最大 1,024 文字。必須。

CreateConferenceDataActionMarkup

フィールド
createConferenceData	ConferenceDataMarkup 会議データ。作成時に Google カレンダーの予定に追加されます。

CreateConferenceSettingUrlActionMarkup

フィールド
settingsUrl	string アドオンによって生成された設定ページの URI。

EditAttendeesActionMarkup

フィールド
addAttendeeEmails[]	string Google カレンダーの予定に追加する参加者のリスト。

EditConferenceDataActionMarkup

フィールド
共用体フィールド conference。 conference は次のいずれかになります。
conferenceData	ConferenceDataMarkup Google カレンダーの予定に追加する会議データ。サードパーティ製会議アドオンは Apps Script でのみ構築できます。

ChatClientDataSourceMarkup

マルチセレクト メニューを使用する SelectionInput ウィジェットの場合、Google Chat のデータソース。データソースは、複数選択メニューの選択項目を設定します。たとえば、ユーザーは自分がメンバーになっている Google Chat スペースを選択できます。

Google Chat アプリでは利用できますが、Google Workspace アドオンでは利用できません。

フィールド
共用体フィールド source。Google Chat データソース。source は次のいずれかになります。
spaceDataSource	SpaceDataSource ユーザーがメンバーになっている Google Chat スペース。

SpaceDataSource

Google Chat スペースをマルチセレクト メニューの選択項目として入力するデータソース。ユーザーがメンバーであるスペースのみが入力されます。

Google Chat アプリでは利用できますが、Google Workspace アドオンでは利用できません。

フィールド
defaultToCurrentSpace	bool true に設定すると、マルチ選択メニューで現在の Google Chat スペースがデフォルトで項目として選択されます。

ChatDataActionMarkup

Google Chat でメッセージを作成または更新します。詳しくは、Google Chat インターフェースを構築するをご覧ください。

フィールド
共用体フィールド action。Google Chat アクション。action は次のいずれかになります。
createMessageAction	CreateMessageAction Google Chat アプリとしてメッセージを送信します。
updateMessageAction	UpdateMessageAction Google Chat アプリのメッセージを更新します。
updateInlinePreviewAction	UpdateInlinePreviewAction リンクをプレビューするには、1 つ以上のカードを Google Chat ユーザーのメッセージに追加します。

CreateMessageAction

Chat 用アプリがメッセージを送信します。詳しくは、Google Chat メッセージを送信するをご覧ください。

フィールド
message	Message Google Chat のメッセージ。

UpdateInlinePreviewAction

Chat 用アプリは、1 つ以上のカードを追加または更新することで、メッセージ内のリンクをプレビューします。詳しくは、Google Chat メッセージでリンクをプレビューするをご覧ください。

フィールド
cardsV2[]	CardWithId 1 つ以上のカードの配列。

UpdateMessageAction

Chat 用アプリは、メッセージ内のテキストまたはカードを更新します。詳しくは、Google Chat メッセージを送信するをご覧ください。

フィールド
message	Message 更新されたメッセージ。

DriveClientActionMarkup

フィールド
requestFileScope	RequestFileScope

RequestFileScope

フィールド
itemId	string

EditorClientActionMarkup

フィールド
共用体フィールド action。 action は次のいずれかになります。
requestFileScopeForActiveDocument	RequestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

この型にはフィールドがありません。

GmailClientActionMarkup

フィールド
共用体フィールド type。 type は次のいずれかになります。
taskAction	TaskActionMarkup
updateDraftActionMarkup	UpdateDraftActionMarkup
openCreatedDraftActionMarkup	OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup	AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

フィールド
type	AddonComposeUiActionType

AddonComposeUiActionType

列挙型
UNSPECIFIED	デフォルト。指定しない場合、アクションは実行されません。
DISMISS	アドオンの作成 UI を閉じます。

OpenCreatedDraftActionMarkup

フィールド
draftId	string 新しく作成された下書きの ID（「r123」形式）。
draftStorageId	string サーバー ストレージ ID（16 進形式）。例: 「15e9fa622ce1029d」。
draftThreadServerPermId	string 下書きのスレッドのサーバー永続 ID。このフィールドはどこにも設定されておらず、OpenCreatedDraftActionMarkup の処理時に無視されます。代わりに draftThreadStorageId を指定して使用してください。
draftThreadId	string 新しく作成された下書きを含むスレッドの ID（例: 「15e9fa622ce1029d」）。

TaskActionMarkup

フィールド
reloadTasks	bool

UpdateDraftActionMarkup

フィールド
updateBody	UpdateBody ユーザーが現在編集している下書きの本文に対して実行する一連の更新アクションを含むフィールド。
updateToRecipients	UpdateToRecipients 設定されている場合、ユーザーが現在編集している下書きの既存の宛先が置き換えられます。
updateCcRecipients	UpdateCcRecipients 設定されている場合、ユーザーが現在編集している下書きの既存の Cc 受信者を置き換えます。
updateBccRecipients	UpdateBccRecipients 設定されている場合、ユーザーが現在編集している下書きの既存の Bcc 受信者を置き換えます。
updateSubject	UpdateSubject 設定されている場合、ユーザーが現在編集している下書きの既存の件名が置き換えられます。

受信者

フィールド
email	string

UpdateBccRecipients

フィールド
bccRecipients[]	Recipient

UpdateBody

フィールド
insertContents[]	InsertContent ユーザーが現在編集している下書きに挿入する一連のコンテンツを含む繰り返しフィールド。コンテンツには、HTML コンテンツまたはプレーン テキスト コンテンツを含めることができます。
type	Type

ContentType

列挙型
UNSPECIFIED_CONTENT_TYPE	ContentType に何も設定されていない場合のデフォルト値。
TEXT	コンテンツがプレーン テキストであることを指定します。
MUTABLE_HTML	コンテンツが HTML であり、変更可能（編集可能）であることを指定します。
IMMUTABLE_HTML	コンテンツが HTML であり、変更不可（編集不可）であることを指定します。

EmailMimeType

EmailMimeType は非推奨になりました。ContentType を使用してください。

列挙型
UNSPECIFIED_EMAIL_MIME_TYPE	EmailMimeType に何も設定されていない場合のデフォルト値。
PLAIN_TEXT	挿入されたコンテンツがプレーン テキストであることを指定します。
HTML	挿入されたコンテンツが HTML であることを指定します。

InsertContent

フィールド
content	string 挿入するコンテンツ。
mimeType (deprecated)	EmailMimeType この項目は非推奨です。
contentType	ContentType 挿入されたコンテンツのタイプ。

タイプ

列挙型
UNSPECIFIED_ACTION_TYPE	Type に何も設定されていない場合のデフォルト値。
IN_PLACE_INSERT	このアクションがインプレース挿入を実行することを示します。デフォルトでは、コンテンツは現在のカーソル位置に挿入されます。コンテンツが選択されている場合は、選択されたコンテンツが置き換えられます。
INSERT_AT_START	このアクションがメッセージ本文の先頭に挿入を実行することを示します。
INSERT_AT_END	このアクションは、メッセージ本文の末尾に挿入を実行することを示します。
REPLACE	このアクションがメッセージ本文を置き換えることを示します。

UpdateCcRecipients

フィールド
ccRecipients[]	Recipient

UpdateSubject

フィールド
subject	string

UpdateToRecipients

フィールド
toRecipients[]	Recipient

HostAppActionMarkup

個々のホストアプリによって処理されるアクション。

フィールド
共用体フィールド action。 action は次のいずれかになります。
gmailAction	GmailClientActionMarkup Gmail で処理されるアクション。
calendarAction	CalendarClientActionMarkup カレンダーで処理されるアクション。
driveAction	DriveClientActionMarkup ドライブで処理されるアクション。
editorAction	EditorClientActionMarkup ドキュメント、スプレッドシート、スライドで処理されるアクション。
sheetsAction	SheetsClientActionMarkup スプレッドシートで処理されるアクション。

HostAppDataActionMarkup

Google Workspace データを更新する方法を定義します。

フィールド
共用体フィールド action。特定の Google Workspace ホスト アプリケーションのアドオン アクション。action は次のいずれかになります。
chatDataAction	ChatDataActionMarkup メッセージ内のテキストまたはカードを作成または更新する Google Chat アクション。

HostAppDataSourceMarkup

Google Workspace アプリケーションのデータソース。データソースは、ウィジェットで使用可能なアイテムを設定します。

フィールド
共用体フィールド data_source。ウィジェットで利用可能なアイテムを設定する Google Workspace アプリケーション。data_source は次のいずれかになります。
chatDataSource	ChatClientDataSourceMarkup Google Chat のデータソース。

SheetsClientActionMarkup

次の ID: 5。

フィールド
共用体フィールド action。 action は次のいずれかになります。
customFunctionReturnValueMarkup	CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

ユーザーがカスタム関数を実行した結果。

フィールド
共用体フィールド result。カスタム関数の実行結果。result は次のいずれかになります。
value	Value カスタム関数を実行した結果の値。
errorMessage	string エラーが発生した場合にユーザーに表示するエラー メッセージ。