Package apps.extensions.markup

索引

カレンダー クライアント アクション マークアップ

フィールド
editAttendeesActionMarkup

EditAttendeesActionMarkup

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

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

Google カレンダーの予定に会議データを追加するアクション。

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

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

AddAttachmentsActionMarkup

フィールド
addonAttachments[]

AddonAttachment

アドオン添付ファイル

フィールド
resourceUrl

string

title

string

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

mimeType

string

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

iconUrl

string

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

カンファレンス データ マークアップ

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

フィールド
conferenceId

string

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

entryPoints[]

EntryPointMarkup

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

parameters[]

Parameter

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

error

Error

設定すると、会議の作成中にエラーが発生したことを意味します。

note

string

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

conferenceSolutionId

string

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

エントリ ポイント マークアップ

会議に参加する方法。

フィールド
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 エントリ ポイントに適用されます。フリーダイヤル番号への通話は無料です。フリーダイヤルとフリーダイヤルを同時に選択することはできません。

タイプ

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

列挙型
UNKNOWN 不明な会議タイプです。
VIDEO ビデオ会議
PHONE 電話会議。
MORE 会議に参加するための情報へのリンクを提供するために使用されます。
SIP Session Initiation Protocol を使用した会議

エラー

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

フィールド
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 文字です。必須。

AttendeesActionMarkup を編集する

フィールド
addAttendeeEmails[]

string

Google カレンダーの予定に追加する参加者のリスト。

EditConferenceDataActionMarkup

フィールド

共用体フィールド conference

conference は次のいずれかになります。

conferenceData

ConferenceDataMarkup

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

ChatClientActionMarkup

Chat クライアントによって処理されるアクション。

DriveClientActionMarkup

フィールド
requestFileScope

RequestFileScope

RequestFileScope

フィールド
itemId

string

エディタ クライアント アクション マークアップ

フィールド

共用体フィールド 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」)。

タスクのアクションのマークアップ

フィールド
reloadTasks

bool

UpdateDraftActionMarkup

フィールド
updateBody

UpdateBody

ユーザーが現在編集中の下書きの本文に対して実行する一連の更新アクションを含むフィールド。

updateToRecipients

UpdateToRecipients

設定すると、ユーザーが現在編集中の下書きの To 受信者が更新されます。

updateCcRecipients

UpdateCcRecipients

設定すると、ユーザーが現在編集中の下書きの既存の CC 受信者が置き換えられます。

updateBccRecipients

UpdateBccRecipients

設定すると、ユーザーが現在編集している下書きの既存の Bcc の宛先が置き換えられます。

updateSubject

UpdateSubject

設定すると、ユーザーが現在編集中の下書きの既存のサブジェクトに置き換えられます。

ギフトの送り先

フィールド
email

string

UpdateBcc 受信者

フィールド
bccRecipients[]

Recipient

UpdateBody

フィールド
insertContents[]

InsertContent

ユーザーが現在編集中の下書きに挿入する一連のコンテンツを含む繰り返しフィールド。コンテンツには、HTML コンテンツまたは書式なしテキストのコンテンツを使用できます。

type

Type

ContentType

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

メール MIME タイプ

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

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

コンテンツの挿入

フィールド
content

string

挿入されるコンテンツ。

mimeType
(deprecated)

EmailMimeType

contentType

ContentType

挿入されたコンテンツのタイプ。

タイプ

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

UpdateCc 受信者

フィールド
ccRecipients[]

Recipient

UpdateSubject

フィールド
subject

string

UpdateTo 受信者

フィールド
toRecipients[]

Recipient

HostAppActionMarkup

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

フィールド

共用体フィールド action

action は次のいずれかになります。

gmailAction

GmailClientActionMarkup

アクションは Gmail で処理されます。

calendarAction

CalendarClientActionMarkup

アクションがカレンダーによって処理される。

driveAction

DriveClientActionMarkup

操作はドライブで処理されます。

editorAction

EditorClientActionMarkup

アクションがドキュメント、スプレッドシート、スライドによって処理されている。

sheetsAction

SheetsClientActionMarkup

アクションがスプレッドシートによって処理される。

chatAction

ChatClientActionMarkup

アクションは Chat によって処理される。

SheetsClientActionMarkup

フィールド
customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

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

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

Value

カスタム関数の実行によって得られた値。

errorMessage

string

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