Package apps.extensions.markup

インデックス

CalendarClientActionMarkup

フィールド
editAttendeesActionMarkup

EditAttendeesActionMarkup

Google カレンダーの予定に参加者を追加するアクション。

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

Google カレンダーの予定に会議データを追加するアクション。サードパーティ製会議アドオンは、Apps Script でのみ作成できます。

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

Google カレンダーの予定に添付ファイルを追加するアクション。

AddAttachmentsActionMarkup

フィールド
addonAttachments[]

AddonAttachment

AddonAttachment

フィールド
resourceUrl

string

title

string

添付ファイルのタイトル。

mimeType

string

resourceUrl のコンテンツの MIME タイプ。

iconUrl

string

リソースのアイコンへのリンク。

ConferenceDataMarkup

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

フィールド
conferenceId

string

この会議データの一意の識別子。最大 512 文字。

entryPoints[]

EntryPointMarkup

会議へのエントリ ポイント。エントリ ポイントは最大 300 個まで指定できます。

parameters[]

Parameter

追加のアドオン パラメータ。使用できるパラメータは最大 300 個です。

error

Error

設定されている場合は、会議の作成中にエラーが発生したことを意味します。

note

string

ユーザーに表示する追加のメモ(管理者からの指示、法的通知など)。HTML を含めることができます。最大長は 2,048 文字です。

conferenceSolutionId

string

会議ソリューションの ID。デプロイの 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 エントリ ポイントに適用されます。通話料金は発信者に請求されます。1 つの番号を同時に通話料有料と通話料無料にすることはできません。
TOLL_FREE PHONE エントリ ポイントに適用されます。フリーダイヤルへの発信は、発信側から無料で行えます。1 つの番号を同時期に有料電話番号と通話料無料番号にすることはできません。

タイプ

エントリ ポイントのタイプ。サードパーティ製会議アドオンは、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 文字です。必須。

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 のインターフェースを作成するをご覧ください。

フィールド
共用体フィールド actionGoogle Chat のアクションaction は次のいずれかになります。
createMessageAction

CreateMessageAction

Google Chat アプリとしてメッセージを送信します。

updateMessageAction

UpdateMessageAction

Google Chat アプリのメッセージを更新します。

updateInlinePreviewAction

UpdateInlinePreviewAction

リンクをプレビューするには、Google Chat ユーザーのメッセージに 1 つ以上のカードを追加します。

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

複数選択メニューを使用する SelectionInput ウィジェットの場合は、Google Workspace アプリケーションのデータソース。データソースから、複数選択メニューの選択項目が入力されます。

Google Chat アプリで利用可能。Google Workspace アドオンでは利用できません。

フィールド
共用体フィールド data_source。複数選択メニューの項目を入力する Google Workspace アプリケーション。data_source は次のいずれかになります。
chatDataSource

ChatClientDataSourceMarkup

Google Chat のデータソース。

SheetsClientActionMarkup

フィールド
customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

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

フィールド
共用体フィールド result。カスタム関数の実行結果。result は次のいずれかになります。
value

Value

カスタム関数の実行結果の値。

errorMessage

string

エラーが発生した場合にユーザーに表示するエラー メッセージ。