Package apps.extensions.markup

目次

CalendarClientActionMarkup

フィールド
editAttendeesActionMarkup

EditAttendeesActionMarkup

Google カレンダーの予定に参加者を追加する操作。

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

Google カレンダーの予定に会議のデータを追加する操作。

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

Google カレンダーの予定に添付ファイルを追加する操作。

AddAttachmentsActionMarkup

フィールド
addonAttachments[]

AddonAttachment

AddonAttachment

フィールド
resourceUrl

string

title

string

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

mimeType

string

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

iconUrl

string

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

ConferenceDataMarkup

Google カレンダーの予定に関連付けられた会議データを定義するマークアップ。

フィールド
conferenceId

string

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

entryPoints[]

EntryPointMarkup

会議へのエントリ ポイント。最大 300 個のエントリ ポイントを使用できます。

parameters[]

Parameter

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

error

Error

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

note

string

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

conferenceSolutionId

string

会議ソリューションの ID。デプロイの calendar.conferenceSolution.id フィールドの値と一致する必要があります。

EntryPointMarkup

会議に参加する方法。

フィールド
type

Type

エントリ ポイントのタイプ。必須。

uri

string

会議に参加するための URI。電話番号と http をサポートし、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 エントリ ポイントに適用されます。発信者に対しては、フリーダイヤルへの通話は無料です。フリーダイヤルとフリーダイヤルを同時に使用することはできません。

タイプ

エントリ ポイントのタイプ。

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

エラー

会議の作成中に発生したエラーを表します。

フィールド
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 カレンダーの予定に追加する会議データ。

ChatClientActionMarkup

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

チャット クライアントが処理するアクション。

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 スペースがデフォルトでアイテムとして選択されます。

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

16 進数形式のサーバー ストレージ ID(例: 「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 [タイプ] に何も設定されていない場合のデフォルト値。
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

スプレッドシートで処理されるアクション。

chatAction

ChatClientActionMarkup

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

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