KAC Google カレンダー
イベントやその他のカレンダー データを操作します。
リリース予定:済
最新バージョン:1.0
最新バージョンリリース日:2024/11/01
カスタムコネクタJSONダウンロードURL:https://drive.google.com/uc?export=download&id=1HtiM1mmEWpsU75wlp6-IY-FwggzC5YgT
仕様・制限事項
KAC のカウントは getToken アクションの1リクエストごとに1回カウントアップされます。
詳細な仕様については公式ドキュメントを参照してください。https://developers.google.com/calendar/api/v3/reference
サインインに必要な情報
Google アカウントによるサインインと認証
getToken
アクセストークンを取得します。
パラメータ
なし
レスポンス
access_token: アクセストークン
payedCheck: カウント情報
count: 総カウント数
maxCount: 当月の限度カウント数
count_カスタムコネクタ名: コネクタの総カウント数
mSec: 総実行時間
maxMSec: 当月の限度実行時間
calendar_acl_delete
アクセス制御ルールを削除します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
ruleId: ACL ルールの識別子。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Acl: delete」 参照: https://developers.google.com/calendar/api/v3/reference/acl/delete
calendar_acl_get
アクセス制御ルールを返します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
ruleId: ACL ルールの識別子。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Acl: get」 参照: https://developers.google.com/calendar/api/v3/reference/acl/get
calendar_acl_insert
アクセス制御ルールを作成します。
パラメータ
etag: リソースの ETag。
id: アクセス制御リスト (ACL) ルールの識別子。 「カレンダーの共有」を参照してください。
kind: リソースのタイプ (「calendar#aclRule」)。
role: スコープに割り当てられた役割。可能な値は次のとおりです。
- "none" - アクセスを提供しません。
- 「freeBusyReader」 - 空き時間情報への読み取りアクセスを提供します。
- 「リーダー」 - カレンダーへの読み取りアクセスを提供します。非公開イベントは読者アクセス権を持つユーザーに表示されますが、イベントの詳細は非表示になります。
- "writer" - カレンダーへの読み取りおよび書き込みアクセスを提供します。プライベート イベントはライター アクセスを持つユーザーに表示され、イベントの詳細が表示されます。
- "owner" - カレンダーの所有権を提供します。このロールには、ライター ロールのすべての権限があり、ACL を表示および操作する追加の
scope.type: スコープのタイプ。可能な値は次のとおりです。
- "default" - パブリック スコープ。これがデフォルト値です。
- "user" - 範囲を 1 人のユーザーに制限します。
- "group" - 範囲をグループに制限します。
- "domain" - 範囲をドメインに制限します。 注: 「デフォルト」またはパブリックのスコープに付与された権限は、認証されているかどうかに関係なく、すべてのユーザーに適用されます。
scope.value: スコープのタイプに応じて、ユーザーまたはグループの電子メール アドレス、またはドメインの名前。タイプ「デフォルト」の場合は省略されます。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
sendNotifications: カレンダー共有の変更に関する通知を送信するかどうか。オプション。デフォルトは True です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Acl: insert」 参照: https://developers.google.com/calendar/api/v3/reference/acl/insert
calendar_acl_list
カレンダーのアクセス制御リスト内のルールを返します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
maxResults: 1 つの結果ページで返されるエントリの最大数。デフォルトの値は 100 エントリです。ページ サイズは 250 エントリを超えることはできません。オプション。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
showDeleted: 削除された ACL を結果に含めるかどうか。削除された ACL は、「なし」に等しい役割で表されます。 syncToken が提供されている場合、削除された ACL は常に含まれます。オプション。デフォルトは False です。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。前回のリスト要求以降に削除されたすべてのエントリは常に結果セットに含まれるため、showDeleted を False に設定することはできません。
syncToken の有効期限が切れると、サーバーは 410 GONE 応答コードで応答し、クライアントはストレージをクリアして、syncToken を使用せずに完全な同期を実行する必要があります。増分同期について詳しくは、こちらをご覧ください。オプション。デフォルトでは、すべてのエントリが返されます。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Acl: list」 参照: https://developers.google.com/calendar/api/v3/reference/acl/list
calendar_acl_patch
アクセス制御ルールを更新します。このメソッドはパッチのセマンティクスをサポートします。
パラメータ
etag: リソースの ETag。
id: アクセス制御リスト (ACL) ルールの識別子。 「カレンダーの共有」を参照してください。
kind: リソースのタイプ (「calendar#aclRule」)。
role: スコープに割り当てられた役割。可能な値は次のとおりです。
- "none" - アクセスを提供しません。
- 「freeBusyReader」 - 空き時間情報への読み取りアクセスを提供します。
- 「リーダー」 - カレンダーへの読み取りアクセスを提供します。非公開イベントは読者アクセス権を持つユーザーに表示されますが、イベントの詳細は非表示になります。
- "writer" - カレンダーへの読み取りおよび書き込みアクセスを提供します。プライベート イベントはライター アクセスを持つユーザーに表示され、イベントの詳細が表示されます。
- "owner" - カレンダーの所有権を提供します。このロールには、ライター ロールのすべての権限があり、ACL を表示および操作する追加の
scope.type: スコープのタイプ。可能な値は次のとおりです。
- "default" - パブリック スコープ。これがデフォルト値です。
- "user" - 範囲を 1 人のユーザーに制限します。
- "group" - 範囲をグループに制限します。
- "domain" - 範囲をドメインに制限します。 注: 「デフォルト」またはパブリックのスコープに付与された権限は、認証されているかどうかに関係なく、すべてのユーザーに適用されます。
scope.value: スコープのタイプに応じて、ユーザーまたはグループの電子メール アドレス、またはドメインの名前。タイプ「デフォルト」の場合は省略されます。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
ruleId: ACL ルールの識別子。
sendNotifications: カレンダー共有の変更に関する通知を送信するかどうか。アクセスの削除については通知がないことに注意してください。オプション。デフォルトは True です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Acl: patch」 参照: https://developers.google.com/calendar/api/v3/reference/acl/patch
calendar_acl_update
アクセス制御ルールを更新します。
パラメータ
etag: リソースの ETag。
id: アクセス制御リスト (ACL) ルールの識別子。 「カレンダーの共有」を参照してください。
kind: リソースのタイプ (「calendar#aclRule」)。
role: スコープに割り当てられた役割。可能な値は次のとおりです。
- "none" - アクセスを提供しません。
- 「freeBusyReader」 - 空き時間情報への読み取りアクセスを提供します。
- 「リーダー」 - カレンダーへの読み取りアクセスを提供します。非公開イベントは読者アクセス権を持つユーザーに表示されますが、イベントの詳細は非表示になります。
- "writer" - カレンダーへの読み取りおよび書き込みアクセスを提供します。プライベート イベントはライター アクセスを持つユーザーに表示され、イベントの詳細が表示されます。
- "owner" - カレンダーの所有権を提供します。このロールには、ライター ロールのすべての権限があり、ACL を表示および操作する追加の
scope.type: スコープのタイプ。可能な値は次のとおりです。
- "default" - パブリック スコープ。これがデフォルト値です。
- "user" - 範囲を 1 人のユーザーに制限します。
- "group" - 範囲をグループに制限します。
- "domain" - 範囲をドメインに制限します。 注: 「デフォルト」またはパブリックのスコープに付与された権限は、認証されているかどうかに関係なく、すべてのユーザーに適用されます。
scope.value: スコープのタイプに応じて、ユーザーまたはグループの電子メール アドレス、またはドメインの名前。タイプ「デフォルト」の場合は省略されます。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
ruleId: ACL ルールの識別子。
sendNotifications: カレンダー共有の変更に関する通知を送信するかどうか。アクセスの削除については通知がないことに注意してください。オプション。デフォルトは True です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Acl: update」 参照: https://developers.google.com/calendar/api/v3/reference/acl/update
calendar_acl_watch
ACL リソースへの変更を監視します。
パラメータ
address: このチャネルの通知が配信されるアドレス。
expiration: 通知チャネルの有効期限の日付と時刻。Unix タイムスタンプとしてミリ秒単位で表されます。オプション。
id: このチャネルを識別する UUID または同様の一意の文字列。
kind: これを、リソースへの変更を監視するために使用される通知チャネル (「api#channel」) として識別します。
params.additionalProperties: 新しいパラメータを名前で宣言します。
payload: ペイロードが必要かどうかを示すブール値。オプション。
resourceId: このチャネルで監視されているリソースを識別する不透明な ID。さまざまな API バージョンにわたって安定しています。
resourceUri: 監視対象リソースのバージョン固有の識別子。
token: このチャネル経由で配信される各通知とともにターゲット アドレスに配信される任意の文字列。オプション。
type: このチャネルに使用される配信メカニズムのタイプ。有効な値は「web_hook」(または「webhook」)です。どちらの値も、HTTP リクエストがメッセージの配信に使用されるチャネルを指します。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
maxResults: 1 つの結果ページで返されるエントリの最大数。デフォルトの値は 100 エントリです。ページ サイズは 250 エントリを超えることはできません。オプション。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
showDeleted: 削除された ACL を結果に含めるかどうか。削除された ACL は、「なし」に等しい役割で表されます。 syncToken が提供されている場合、削除された ACL は常に含まれます。オプション。デフォルトは False です。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。前回のリスト要求以降に削除されたすべてのエントリは常に結果セットに含まれるため、showDeleted を False に設定することはできません。
syncToken の有効期限が切れると、サーバーは 410 GONE 応答コードで応答し、クライアントはストレージをクリアして、syncToken を使用せずに完全な同期を実行する必要があります。増分同期について詳しくは、こちらをご覧ください。オプション。デフォルトでは、すべてのエントリが返されます。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Acl: watch」 参照: https://developers.google.com/calendar/api/v3/reference/acl/watch
calendar_calendarList_delete
ユーザーのカレンダーリストからカレンダーを削除します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「CalendarList: delete」 参照: https://developers.google.com/calendar/api/v3/reference/calendarList/delete
calendar_calendarList_get
ユーザーのカレンダーリストからカレンダーを返します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「CalendarList: get」 参照: https://developers.google.com/calendar/api/v3/reference/calendarList/get
calendar_calendarList_insert
既存のカレンダーをユーザーのカレンダー リストに挿入します。
パラメータ
accessRole: 認証されたユーザーがカレンダー上で持つ有効なアクセス役割。読み取り専用。可能な値は次のとおりです。
- 「freeBusyReader」 - 空き時間情報への読み取りアクセスを提供します。
- 「リーダー」 - カレンダーへの読み取りアクセスを提供します。非公開イベントは読者アクセス権を持つユーザーに表示されますが、イベントの詳細は非表示になります。
- "writer" - カレンダーへの読み取りおよび書き込みアクセスを提供します。プライベート イベントはライター アクセスを持つユーザーに表示され、イベントの詳細が表示されます。
- "owner" - カレンダーの所有権を提供します。このロールには、ライター ロールのすべての権限があり、ACL を表示および操作する追加の機能も備
backgroundColor: 16 進数形式のカレンダーのメインカラー「#0088aa」。このプロパティは、インデックスベースの colorId プロパティに優先します。このプロパティを設定または変更するには、insert、update、および patch メソッドのパラメーターで colorRgbFormat=true を指定する必要があります。オプション。
colorId: カレンダーの色です。これは、色定義のカレンダー セクションのエントリを参照する ID です (色のエンドポイントを参照)。このプロパティは、backgroundColor プロパティと foregroundColor プロパティによって置き換えられるため、これらのプロパティを使用する場合は無視できます。オプション。
conferenceProperties.allowedConferenceSolutionTypes: このカレンダーでサポートされている会議ソリューションの種類。可能な値は次のとおりです。
- 「イベントハングアウト」
- 「ハングアウトという名前のイベント」
- 「ハングアウトミート」 オプション。
defaultReminders: 認証されたユーザーがこのカレンダーに対して持つデフォルトのリマインダー。
method: このリマインダーで使用されるメソッド。可能な値は次のとおりです。
- 「電子メール」 - リマインダーは電子メールで送信されます。
- 「ポップアップ」 - リマインダーは UI ポップアップ経由で送信されます。 リマインダーを追加する場合は必須です。
minutes: イベント開始の何分前にリマインダーをトリガーするかを指定します。有効な値は 0 ~ 40320 (4 週間分) です。リマインダーを追加する場合は必須です。
deleted: このカレンダー リスト エントリがカレンダー リストから削除されているかどうか。読み取り専用。オプション。デフォルトは False です。
description: カレンダーの説明。オプション。読み取り専用。
etag: リソースの ETag。
foregroundColor: 16 進形式「#ffffff」のカレンダーの前景色。このプロパティは、インデックスベースの colorId プロパティに優先します。このプロパティを設定または変更するには、insert、update、および patch メソッドのパラメーターで colorRgbFormat=true を指定する必要があります。オプション。
hidden: カレンダーがリストから非表示になっているかどうか。オプション。この属性は、カレンダーが非表示の場合にのみ返され、その場合の値は true です。
id: カレンダーの識別子。
kind: リソースのタイプ (「calendar#calendarListEntry」)。
location: 自由形式のテキストとしてのカレンダーの地理的位置。オプション。読み取り専用。
notificationSettings.notifications: このカレンダーに設定されている通知のリスト。
method: 通知の配信に使用される方法。可能な値は次のとおりです。
- 「メール」 - 通知はメールで送信されます。 通知を追加する場合に必要です。
type: 通知の種類。可能な値は次のとおりです。
- "eventCreation" - 新しいイベントがカレンダーに追加されたときに送信される通知。
- "eventChange" - イベントが変更されたときに送信される通知。
- "eventCancel" - イベントがキャンセルされたときに送信される通知。
- "eventResponse" - 出席者がイベントの招待に応答したときに送信される通知。
- 「アジェンダ」 - その日の出来事が記載されたアジェンダ(午前中に送信されます)。 通知を追加する場合に必要です。
primary: カレンダーが認証されたユーザーのプライマリカレンダーであるかどうか。読み取り専用。オプション。デフォルトは False です。
selected: カレンダーのコンテンツがカレンダー UI に表示されるかどうか。オプション。デフォルトは False です。
summary: カレンダーのタイトル。読み取り専用。
summaryOverride: 認証されたユーザーがこのカレンダーに設定した概要。オプション。
timeZone: カレンダーのタイムゾーン。オプション。読み取り専用。
colorRgbFormat: foregroundColor フィールドと backgroundColor フィールドを使用してカレンダーの色 (RGB) を書き込むかどうか。この機能を使用すると、インデックスベースの colorId フィールドが最適なオプションに自動的に設定されます。オプション。デフォルトは False です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「CalendarList: insert」 参照: https://developers.google.com/calendar/api/v3/reference/calendarList/insert
calendar_calendarList_list
ユーザーのカレンダー リストにあるカレンダーを返します。
パラメータ
maxResults: 1 つの結果ページで返されるエントリの最大数。デフォルトの値は 100 エントリです。ページ サイズは 250 エントリを超えることはできません。オプション。
minAccessRole: 返されたエントリ内のユーザーの最小アクセス ロール。オプション。デフォルトでは制限はありません。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
showDeleted: 削除されたカレンダー リストのエントリを結果に含めるかどうか。オプション。デフォルトは False です。
showHidden: 非表示のエントリを表示するかどうか。オプション。デフォルトは False です。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。カレンダーのプロパティや ACL などの読み取り専用フィールドのみが変更された場合、エントリは返されません。前回のリスト要求以降に削除および非表示になったすべてのエントリは常に結果セットに含まれ、showDeleted も showHidden も False に設定することはできません。クライアント状態の一貫性を確保するため、minAccessRole クエリ パラメーターを nextSyncToken と一緒に指定することはできません。
syncToken の有効期限が切れると、サーバーは 410
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「CalendarList: list」 参照: https://developers.google.com/calendar/api/v3/reference/calendarList/list
calendar_calendarList_patch
ユーザーのカレンダー リストにある既存のカレンダーを更新します。このメソッドはパッチのセマンティクスをサポートします。
パラメータ
accessRole: 認証されたユーザーがカレンダー上で持つ有効なアクセス役割。読み取り専用。可能な値は次のとおりです。
- 「freeBusyReader」 - 空き時間情報への読み取りアクセスを提供します。
- 「リーダー」 - カレンダーへの読み取りアクセスを提供します。非公開イベントは読者アクセス権を持つユーザーに表示されますが、イベントの詳細は非表示になります。
- "writer" - カレンダーへの読み取りおよび書き込みアクセスを提供します。プライベート イベントはライター アクセスを持つユーザーに表示され、イベントの詳細が表示されます。
- "owner" - カレンダーの所有権を提供します。このロールには、ライター ロールのすべての権限があり、ACL を表示および操作する追加の機能も備
backgroundColor: 16 進数形式のカレンダーのメインカラー「#0088aa」。このプロパティは、インデックスベースの colorId プロパティに優先します。このプロパティを設定または変更するには、insert、update、および patch メソッドのパラメーターで colorRgbFormat=true を指定する必要があります。オプション。
colorId: カレンダーの色です。これは、色定義のカレンダー セクションのエントリを参照する ID です (色のエンドポイントを参照)。このプロパティは、backgroundColor プロパティと foregroundColor プロパティによって置き換えられるため、これらのプロパティを使用する場合は無視できます。オプション。
conferenceProperties.allowedConferenceSolutionTypes: このカレンダーでサポートされている会議ソリューションの種類。可能な値は次のとおりです。
- 「イベントハングアウト」
- 「ハングアウトという名前のイベント」
- 「ハングアウトミート」 オプション。
defaultReminders: 認証されたユーザーがこのカレンダーに対して持つデフォルトのリマインダー。
method: このリマインダーで使用されるメソッド。可能な値は次のとおりです。
- 「電子メール」 - リマインダーは電子メールで送信されます。
- 「ポップアップ」 - リマインダーは UI ポップアップ経由で送信されます。 リマインダーを追加する場合は必須です。
minutes: イベント開始の何分前にリマインダーをトリガーするかを指定します。有効な値は 0 ~ 40320 (4 週間分) です。リマインダーを追加する場合は必須です。
deleted: このカレンダー リスト エントリがカレンダー リストから削除されているかどうか。読み取り専用。オプション。デフォルトは False です。
description: カレンダーの説明。オプション。読み取り専用。
etag: リソースの ETag。
foregroundColor: 16 進形式「#ffffff」のカレンダーの前景色。このプロパティは、インデックスベースの colorId プロパティに優先します。このプロパティを設定または変更するには、insert、update、および patch メソッドのパラメーターで colorRgbFormat=true を指定する必要があります。オプション。
hidden: カレンダーがリストから非表示になっているかどうか。オプション。この属性は、カレンダーが非表示の場合にのみ返され、その場合の値は true です。
id: カレンダーの識別子。
kind: リソースのタイプ (「calendar#calendarListEntry」)。
location: 自由形式のテキストとしてのカレンダーの地理的位置。オプション。読み取り専用。
notificationSettings.notifications: このカレンダーに設定されている通知のリスト。
method: 通知の配信に使用される方法。可能な値は次のとおりです。
- 「メール」 - 通知はメールで送信されます。 通知を追加する場合に必要です。
type: 通知の種類。可能な値は次のとおりです。
- "eventCreation" - 新しいイベントがカレンダーに追加されたときに送信される通知。
- "eventChange" - イベントが変更されたときに送信される通知。
- "eventCancel" - イベントがキャンセルされたときに送信される通知。
- "eventResponse" - 出席者がイベントの招待に応答したときに送信される通知。
- 「アジェンダ」 - その日の出来事が記載されたアジェンダ(午前中に送信されます)。 通知を追加する場合に必要です。
primary: カレンダーが認証されたユーザーのプライマリカレンダーであるかどうか。読み取り専用。オプション。デフォルトは False です。
selected: カレンダーのコンテンツがカレンダー UI に表示されるかどうか。オプション。デフォルトは False です。
summary: カレンダーのタイトル。読み取り専用。
summaryOverride: 認証されたユーザーがこのカレンダーに設定した概要。オプション。
timeZone: カレンダーのタイムゾーン。オプション。読み取り専用。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
colorRgbFormat: foregroundColor フィールドと backgroundColor フィールドを使用してカレンダーの色 (RGB) を書き込むかどうか。この機能を使用すると、インデックスベースの colorId フィールドが最適なオプションに自動的に設定されます。オプション。デフォルトは False です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「CalendarList: patch」 参照: https://developers.google.com/calendar/api/v3/reference/calendarList/patch
calendar_calendarList_update
ユーザーのカレンダー リストにある既存のカレンダーを更新します。
パラメータ
accessRole: 認証されたユーザーがカレンダー上で持つ有効なアクセス役割。読み取り専用。可能な値は次のとおりです。
- 「freeBusyReader」 - 空き時間情報への読み取りアクセスを提供します。
- 「リーダー」 - カレンダーへの読み取りアクセスを提供します。非公開イベントは読者アクセス権を持つユーザーに表示されますが、イベントの詳細は非表示になります。
- "writer" - カレンダーへの読み取りおよび書き込みアクセスを提供します。プライベート イベントはライター アクセスを持つユーザーに表示され、イベントの詳細が表示されます。
- "owner" - カレンダーの所有権を提供します。このロールには、ライター ロールのすべての権限があり、ACL を表示および操作する追加の機能も備
backgroundColor: 16 進数形式のカレンダーのメインカラー「#0088aa」。このプロパティは、インデックスベースの colorId プロパティに優先します。このプロパティを設定または変更するには、insert、update、および patch メソッドのパラメーターで colorRgbFormat=true を指定する必要があります。オプション。
colorId: カレンダーの色です。これは、色定義のカレンダー セクションのエントリを参照する ID です (色のエンドポイントを参照)。このプロパティは、backgroundColor プロパティと foregroundColor プロパティによって置き換えられるため、これらのプロパティを使用する場合は無視できます。オプション。
conferenceProperties.allowedConferenceSolutionTypes: このカレンダーでサポートされている会議ソリューションの種類。可能な値は次のとおりです。
- 「イベントハングアウト」
- 「ハングアウトという名前のイベント」
- 「ハングアウトミート」 オプション。
defaultReminders: 認証されたユーザーがこのカレンダーに対して持つデフォルトのリマインダー。
method: このリマインダーで使用されるメソッド。可能な値は次のとおりです。
- 「電子メール」 - リマインダーは電子メールで送信されます。
- 「ポップアップ」 - リマインダーは UI ポップアップ経由で送信されます。 リマインダーを追加する場合は必須です。
minutes: イベント開始の何分前にリマインダーをトリガーするかを指定します。有効な値は 0 ~ 40320 (4 週間分) です。
リマインダーを追加する場合は必須です。
deleted: このカレンダー リスト エントリがカレンダー リストから削除されているかどうか。読み取り専用。オプション。デフォルトは False です。
description: カレンダーの説明。オプション。読み取り専用。
etag: リソースの ETag。
foregroundColor: 16 進形式「#ffffff」のカレンダーの前景色。このプロパティは、インデックスベースの colorId プロパティに優先します。このプロパティを設定または変更するには、insert、update、および patch メソッドのパラメーターで colorRgbFormat=true を指定する必要があります。オプション。
hidden: カレンダーがリストから非表示になっているかどうか。オプション。この属性は、カレンダーが非表示の場合にのみ返され、その場合の値は true です。
id: カレンダーの識別子。
kind: リソースのタイプ (「calendar#calendarListEntry」)。
location: 自由形式のテキストとしてのカレンダーの地理的位置。オプション。読み取り専用。
notificationSettings.notifications: このカレンダーに設定されている通知のリスト。
method: 通知の配信に使用される方法。可能な値は次のとおりです。
- 「メール」 - 通知はメールで送信されます。 通知を追加する場合に必要です。
type: 通知の種類。可能な値は次のとおりです。
- "eventCreation" - 新しいイベントがカレンダーに追加されたときに送信される通知。
- "eventChange" - イベントが変更されたときに送信される通知。
- "eventCancel" - イベントがキャンセルされたときに送信される通知。
- "eventResponse" - 出席者がイベントの招待に応答したときに送信される通知。
- 「アジェンダ」 - その日の出来事が記載されたアジェンダ(午前中に送信されます)。 通知を追加する場合に必要です。
primary: カレンダーが認証されたユーザーのプライマリカレンダーであるかどうか。読み取り専用。オプション。デフォルトは False です。
selected: カレンダーのコンテンツがカレンダー UI に表示されるかどうか。オプション。デフォルトは False です。
summary: カレンダーのタイトル。読み取り専用。
summaryOverride: 認証されたユーザーがこのカレンダーに設定した概要。オプション。
timeZone: カレンダーのタイムゾーン。オプション。読み取り専用。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
colorRgbFormat: foregroundColor フィールドと backgroundColor フィールドを使用してカレンダーの色 (RGB) を書き込むかどうか。この機能を使用すると、インデックスベースの colorId フィールドが最適なオプションに自動的に設定されます。オプション。デフォルトは False です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「CalendarList: update」 参照: https://developers.google.com/calendar/api/v3/reference/calendarList/update
calendar_calendarList_watch
CalendarList リソースへの変更を監視します。
パラメータ
address: このチャネルの通知が配信されるアドレス。
expiration: 通知チャネルの有効期限の日付と時刻。Unix タイムスタンプとしてミリ秒単位で表されます。オプション。
id: このチャネルを識別する UUID または同様の一意の文字列。
kind: これを、リソースへの変更を監視するために使用される通知チャネル (「api#channel」) として識別します。
params.additionalProperties: 新しいパラメータを名前で宣言します。
payload: ペイロードが必要かどうかを示すブール値。オプション。
resourceId: このチャネルで監視されているリソースを識別する不透明な ID。さまざまな API バージョンにわたって安定しています。
resourceUri: 監視対象リソースのバージョン固有の識別子。
token: このチャネル経由で配信される各通知とともにターゲット アドレスに配信される任意の文字列。オプション。
type: このチャネルに使用される配信メカニズムのタイプ。有効な値は「web_hook」(または「webhook」)です。どちらの値も、HTTP リクエストがメッセージの配信に使用されるチャネルを指します。
maxResults: 1 つの結果ページで返されるエントリの最大数。デフォルトの値は 100 エントリです。ページ サイズは 250 エントリを超えることはできません。オプション。
minAccessRole: 返されたエントリ内のユーザーの最小アクセス ロール。オプション。デフォルトでは制限はありません。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
showDeleted: 削除されたカレンダー リストのエントリを結果に含めるかどうか。オプション。デフォルトは False です。
showHidden: 非表示のエントリを表示するかどうか。オプション。デフォルトは False です。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。カレンダーのプロパティや ACL などの読み取り専用フィールドのみが変更された場合、エントリは返されません。前回のリスト要求以降に削除および非表示になったすべてのエントリは常に結果セットに含まれ、showDeleted も showHidden も False に設定することはできません。クライアント状態の一貫性を確保するため、minAccessRole クエリ パラメーターを nextSyncToken と一緒に指定することはできません。
syncToken の有効期限が切れると、サーバーは 410
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「CalendarList: watch」 参照: https://developers.google.com/calendar/api/v3/reference/calendarList/watch
calendar_calendars_clear
プライマリカレンダーをクリアします。この操作により、アカウントのプライマリ カレンダーに関連付けられたすべてのイベントが削除されます。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Calendars: clear」 参照: https://developers.google.com/calendar/api/v3/reference/calendars/clear
calendar_calendars_delete
セカンダリカレンダーを削除します。プライマリ カレンダーのすべてのイベントをクリアするには、calendars.clear を使用します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Calendars: delete」 参照: https://developers.google.com/calendar/api/v3/reference/calendars/delete
calendar_calendars_get
カレンダーのメタデータを返します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Calendars: get」 参照: https://developers.google.com/calendar/api/v3/reference/calendars/get
calendar_calendars_insert
二次カレンダーを作成します。
パラメータ
conferenceProperties.allowedConferenceSolutionTypes: このカレンダーでサポートされている会議ソリューションの種類。可能な値は次のとおりです。
- 「イベントハングアウト」
- 「ハングアウトという名前のイベント」
- 「ハングアウトミート」 オプション。
description: カレンダーの説明。オプション。
etag: リソースの ETag。
id: カレンダーの識別子。 ID を取得するには、calendarList.list() メソッドを呼び出します。
kind: リソースのタイプ (「calendar#calendar」)。
location: 自由形式のテキストとしてのカレンダーの地理的位置。オプション。
summary: カレンダーのタイトル。
timeZone: カレンダーのタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: "Europe/Zurich"。) オプション。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Calendars: insert」 参照: https://developers.google.com/calendar/api/v3/reference/calendars/insert
calendar_calendars_patch
カレンダーのメタデータを更新します。このメソッドはパッチのセマンティクスをサポートします。
パラメータ
conferenceProperties.allowedConferenceSolutionTypes: このカレンダーでサポートされている会議ソリューションの種類。可能な値は次のとおりです。
- 「イベントハングアウト」
- 「ハングアウトという名前のイベント」
- 「ハングアウトミート」 オプション。
description: カレンダーの説明。オプション。
etag: リソースの ETag。
id: カレンダーの識別子。 ID を取得するには、calendarList.list() メソッドを呼び出します。
kind: リソースのタイプ (「calendar#calendar」)。
location: 自由形式のテキストとしてのカレンダーの地理的位置。オプション。
summary: カレンダーのタイトル。
timeZone: カレンダーのタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: "Europe/Zurich"。) オプション。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Calendars: patch」 参照: https://developers.google.com/calendar/api/v3/reference/calendars/patch
calendar_calendars_update
カレンダーのメタデータを更新します。
パラメータ
conferenceProperties.allowedConferenceSolutionTypes: このカレンダーでサポートされている会議ソリューションの種類。可能な値は次のとおりです。
- 「イベントハングアウト」
- 「ハングアウトという名前のイベント」
- 「ハングアウトミート」 オプション。
description: カレンダーの説明。オプション。
etag: リソースの ETag。
id: カレンダーの識別子。 ID を取得するには、calendarList.list() メソッドを呼び出します。
kind: リソースのタイプ (「calendar#calendar」)。
location: 自由形式のテキストとしてのカレンダーの地理的位置。オプション。
summary: カレンダーのタイトル。
timeZone: カレンダーのタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: "Europe/Zurich"。) オプション。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Calendars: update」 参照: https://developers.google.com/calendar/api/v3/reference/calendars/update
calendar_channels_stop
このチャンネルを通じてリソースの視聴を停止する
パラメータ
address: このチャネルの通知が配信されるアドレス。
expiration: 通知チャネルの有効期限の日付と時刻。Unix タイムスタンプとしてミリ秒単位で表されます。オプション。
id: このチャネルを識別する UUID または同様の一意の文字列。
kind: これを、リソースへの変更を監視するために使用される通知チャネル (「api#channel」) として識別します。
params.additionalProperties: 新しいパラメータを名前で宣言します。
payload: ペイロードが必要かどうかを示すブール値。オプション。
resourceId: このチャネルで監視されているリソースを識別する不透明な ID。さまざまな API バージョンにわたって安定しています。
resourceUri: 監視対象リソースのバージョン固有の識別子。
token: このチャネル経由で配信される各通知とともにターゲット アドレスに配信される任意の文字列。オプション。
type: このチャネルに使用される配信メカニズムのタイプ。有効な値は「web_hook」(または「webhook」)です。どちらの値も、HTTP リクエストがメッセージの配信に使用されるチャネルを指します。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Channels: stop」 参照: https://developers.google.com/calendar/api/v3/reference/channels/stop
calendar_colors_get
カレンダーとイベントの色の定義を返します。
パラメータ
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Colors: get」 参照: https://developers.google.com/calendar/api/v3/reference/colors/get
calendar_events_delete
イベントを削除します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
eventId: イベント識別子。
sendNotifications: 廃止されました。代わりにsendUpdatesを使用してください。イベントの削除に関する通知を送信するかどうか。値を false に設定した場合でも、一部の電子メールは送信される可能性があることに注意してください。デフォルトは false です。
sendUpdates: イベントの削除に関する通知を受け取る必要があるゲスト。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: delete」 参照: https://developers.google.com/calendar/api/v3/reference/events/delete
calendar_events_get
Google カレンダー ID に基づいてイベントを返します。 iCalendar ID を使用してイベントを取得するには、iCalUID パラメーターを使用して events.list メソッドを呼び出します。
パラメータ
alwaysIncludeEmail: 非推奨となり無視されました。実際の電子メール アドレスが利用できない場合でも、主催者、作成者、および参加者の電子メール フィールドには常に値が返されます (つまり、生成された機能しない値が提供されます)。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
eventId: イベント識別子。
maxAttendees: 応答に含める出席者の最大数。指定された数を超える参加者がいる場合は、参加者のみが返されます。オプション。
timeZone: 応答で使用されるタイムゾーン。オプション。デフォルトはカレンダーのタイムゾーンです。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: get」 参照: https://developers.google.com/calendar/api/v3/reference/events/get
calendar_events_import
イベントをインポートします。この操作は、既存のイベントのプライベート コピーをカレンダーに追加するために使用されます。デフォルトのeventTypeを持つイベントのみをインポートできます。
非推奨の動作: デフォルト以外のイベントがインポートされる場合、そのタイプはデフォルトに変更され、そのイベントが持つ可能性のあるイベント タイプ固有のプロパティはすべて削除されます。
パラメータ
anyoneCanAddSelf: 誰でもイベントに自分を招待できるかどうか (非推奨)。オプション。デフォルトは False です。
attachments: イベントの添付ファイル。添付ファイルを変更するには、supportsAttachments リクエスト パラメーターを true に設定する必要があります。イベントごとに最大 25 個の添付ファイルを追加できます。
fileId: 添付ファイルのID。読み取り専用。Google ドライブ ファイルの場合、これは Drive API の対応するファイル リソース エントリの ID です。
fileUrl: 添付ファイルへの URL リンク。Google ドライブの添付ファイルを追加するには、Drive API の Files リソースの alterLink プロパティと同じ形式を使用します。添付ファイルを追加する場合に必要です。
iconLink: 添付ファイルのアイコンへの URL リンク。このフィールドは、カスタムのサードパーティ添付ファイルに対してのみ変更できます。
mimeType: 添付ファイルのインターネット メディア タイプ (MIME タイプ)。
title: 添付ファイルのタイトル。
attendees: イベントの参加者。他のカレンダー ユーザーとのイベントのスケジュール設定の詳細については、「出席者とのイベント」ガイドを参照してください。サービス アカウントは、ドメイン全体の権限の委任を使用して、出席者リストにデータを入力する必要があります。
additionalGuests: 追加ゲストの数。オプション。デフォルトは 0 です。
comment: 参加者の返答コメント。オプション。
displayName: 参加者の名前(可能な場合)。オプション。
email: 参加者の電子メール アドレス (可能な場合)。出席者を追加する場合、このフィールドが存在する必要があります。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。出席者を追加する場合に必要です。
id: 参加者のプロフィール ID (利用可能な場合)。
optional: これが任意の出席者であるかどうか。オプション。デフォルトは False です。
organizer: 出席者がイベントの主催者であるかどうか。読み取り専用。デフォルトは False です。
resource: 出席者がリソースであるかどうか。参加者を初めてイベントに追加する場合にのみ設定できます。それ以降の変更は無視されます。オプション。デフォルトは False です。
responseStatus: 出席者の応答ステータス。可能な値は次のとおりです。
- "needsAction" - 出席者は招待に応答していません (新しいイベントに推奨)。
- 「拒否しました」 - 出席者は招待を拒否しました。
- "暫定" - 出席者は招待を暫定的に受け入れました。
- 「承諾」 - 出席者は招待を承諾しました。 警告: 拒否、暫定、または承認の値を使用してイベントを追加した場合、[カレンダーに招待状を追加する] 設定が [電子メールでの招待状に応答するとき] に設定されている出席者には、参加者が参加しない限り、カレンダーにイベントが表示されません。イベント招待メールで招待の応答を変更することを選択します。
self: このエントリが、イベントのこのコピーが表示されるカレンダーを表すかどうか。読み取り専用。デフォルトは False です。
attendeesOmitted: 出席者がイベントの表現から省略された可能性があるかどうか。イベントを取得するとき、これは maxAttendee クエリ パラメーターで指定された制限が原因である可能性があります。イベントを更新する場合、これは参加者の応答を更新するためにのみ使用できます。オプション。デフォルトは False です。
colorId: イベントの色。これは、カラー定義のイベント セクションのエントリを参照する ID です (カラー エンドポイントを参照)。オプション。
conferenceData.conferenceId: 会議のID。開発者が会議を追跡するために使用できますが、ユーザーには表示しないでください。ID 値は、会議ソリューションのタイプごとに異なる方法で形成されます。
- eventHangout:IDが設定されていません。 (この会議タイプは廃止されました。)
- eventNamedHangout: ID はハングアウトの名前です。 (この会議タイプは廃止されました。)
- HangoutsMeet: ID は 10 文字の会議コードです (例: aaa-bbbb-ccc)。
- addOn: ID はサードパーティプロバイダーによって定義されます。 オプション。
conferenceData.conferenceSolution.iconUri: このソリューションのユーザーに表示されるアイコン。
conferenceData.conferenceSolution.key.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.conferenceSolution.name: ユーザーに表示されるこのソリューションの名前。ローカライズされていません。
conferenceData.createRequest.conferenceSolutionKey.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.createRequest.requestId: このリクエストに対してクライアントが生成した一意の ID。クライアントは、新しいリクエストごとにこの ID を再生成する必要があります。指定された ID が前のリクエストと同じである場合、リクエストは無視されます。
conferenceData.createRequest.status.statusCode: 会議作成リクエストの現在のステータス。読み取り専用。可能な値は次のとおりです。
- 「保留中」: 会議作成リクエストはまだ処理中です。
- "success": 会議作成リクエストが成功し、エントリ ポイントが設定されます。
- 「失敗」: 会議作成リクエストが失敗しました。エントリ ポイントがありません。
conferenceData.entryPoints: URL や電話番号など、個々の会議のエントリ ポイントに関する情報。それらはすべて同じ会議に属している必要があります。
ConferenceSolution と少なくとも 1 つのentryPoint、または createRequest のいずれかが必要です。
accessCode: 会議にアクセスするためのアクセス コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
entryPointFeatures: 有料か無料かなどのエントリ ポイントの機能。 1 つのエントリ ポイントに複数の機能を持たせることができます。ただし、有料と無料の両方を同じエントリ ポイントに設定することはできません。
entryPointType: 会議エントリポイントのタイプ。可能な値は次のとおりです。
- 「ビデオ」 - HTTP 経由で会議に参加します。会議には、0 または 1 つのビデオ エントリ ポイントを含めることができます。
- 「電話」 - 電話番号をダイヤルして会議に参加します。会議には、0 個以上の電話エントリ ポイントを含めることができます。
- 「sip」 - SIP 経由で会議に参加します。会議には 0 または 1 つの SIP エントリ ポイントを含めることができます。
- 「詳細」 - 追加の電話番号など、さらに詳しい会議参加手順。会議には、ゼロまたは 1 つ以上のエントリ ポイントを含めることができます。エントリ ポイントが 1 つだけ多い会議は有効な会議ではありません。
label: URIのラベル。エンドユーザーに表示されます。ローカライズされていません。最大長は 512 文字です。例:
- ビデオの場合: meets.google.com/aaa-bbbb-ccc
- 電話の場合: +1 123 268 2601
- SIP の場合: 12345678@altostrat.com
- 詳細: 記入しないでください オプション。
meetingCode: 会議にアクセスするための会議コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
passcode: 会議にアクセスするためのパスコード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。
password: 会議にアクセスするためのパスワード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
pin: 会議にアクセスするための PIN。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
regionCode: この電話アクセスに関連付けられている国の CLDR/ISO 3166 地域コード。例: スウェーデンの場合は「SE」。カレンダー バックエンドは、EntryPointType.PHONE に対してのみこのフィールドに値を入力します。
uri: エントリポイントのURI。最大長は 1300 文字です。形式:
- ビデオの場合、http: または https: スキーマが必要です。
- 電話の場合、tel: スキーマが必要です。 URI にはダイヤル シーケンス全体が含まれている必要があります (例: tel:+12345678900,,,123456789;1234)。
- sip の場合、sip: スキーマが必要です (例: sip:12345678@myprovider.com)。
- 詳細については、http: または https: スキーマが必要です。
conferenceData.notes: ユーザーに表示する追加のメモ (ドメイン管理者からの指示、法的通知など)。 HTMLを含めることができます。最大長は 2048 文字です。オプション。
conferenceData.parameters.addOnParameters.parameters.additionalProperties:
conferenceData.signature: 会議データの署名。サーバー側で生成されます。作成リクエストが失敗した会議の設定は解除されます。作成リクエストが保留中の会議の場合はオプションです。
created: イベントの作成時刻 (RFC3339 タイムスタンプとして)。読み取り専用。
creator.displayName: 可能な場合は作成者の名前。
creator.email: 作成者の電子メール アドレス (可能な場合)。
creator.id: 作成者のプロフィール ID (利用可能な場合)。
creator.self: 作成者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
description: イベントの説明。 HTMLを含めることができます。オプション。
end.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
end.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
end.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
endTimeUnspecified: 終了時刻が実際に未指定であるかどうか。この属性が True に設定されている場合でも、互換性の理由から終了時刻が提供されます。デフォルトは False です。
etag: リソースの ETag。
eventType: イベントの特定の種類。イベントの作成後にこれを変更することはできません。可能な値は次のとおりです。
- "default" - 定期的なイベント、または詳細は指定されていません。
- 「outOfOffice」 - 不在時のイベント。
- "focusTime" - フォーカス時間イベント。
- "workingLocation" - 作業場所イベント。
- 「fromGmail」 - Gmail からのイベント。このタイプのイベントは作成できません。
extendedProperties.private.additionalProperties: プライベート プロパティの名前と対応する値。
extendedProperties.shared.additionalProperties: 共有プロパティの名前と対応する値。
focusTimeProperties.autoDeclineMode: フォーカス タイム イベントと重なる会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。これは、フォーカス タイム イベントが存在する間に到着した、競合する新しい会議への招待のみが拒否されることを意味します。
focusTimeProperties.chatStatus: チャットおよび関連製品でユーザーをマークするステータス。これは利用可能であるか、または妨害しない可能性があります。
focusTimeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
gadget.display: ガジェットの表示モード。廃止されました。可能な値は次のとおりです。
- "アイコン" - ガジェットは、カレンダー ビューのイベントのタイトルの横に表示されます。
- "chip" - イベントをクリックするとガジェットが表示されます。
gadget.height: ガジェットの高さ (ピクセル単位)。高さは 0 より大きい整数である必要があります。オプション。廃止されました。
gadget.iconLink: ガジェットのアイコンの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.link: ガジェットの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.preferences.additionalProperties: 設定名と対応する値。
gadget.title: ガジェットのタイトル。廃止されました。
gadget.type: ガジェットのタイプ。廃止されました。
gadget.width: ガジェットの幅 (ピクセル単位)。幅は 0 より大きい整数である必要があります。オプションです。廃止されました。
guestsCanInviteOthers: 主催者以外の出席者が他の人をイベントに招待できるかどうか。オプション。デフォルトは True です。
guestsCanModify: 主催者以外の参加者がイベントを変更できるかどうか。オプション。デフォルトは False です。
guestsCanSeeOtherGuests: 主催者以外の参加者がイベントの参加者を確認できるかどうか。オプション。デフォルトは True です。
hangoutLink: このイベントに関連付けられた Google ハングアウトへの絶対リンク。読み取り専用。
htmlLink: Google カレンダー Web UI のこのイベントへの絶対リンク。読み取り専用。
iCalUID: RFC5545 で定義されているイベントの一意の識別子。これは、カレンダー システム全体でイベントを一意に識別するために使用され、インポート メソッドを介してイベントをインポートするときに指定する必要があります。iCalUID と ID は同一ではなく、イベント作成時にどちらか 1 つだけを指定する必要があることに注意してください。セマンティクスの 1 つの違いは、定期的なイベントでは、1 つのイベントのすべての発生が異なる ID を持ち、すべてが同じ iCalUID を共有することです。 iCalUID を使用してイベントを取得するには、iCalUID パラメーターを使用して events.list メソッドを呼び出します。 ID を使用してイベントを取得するには、events.get
id: イベントの不透明な識別子。新しい単一イベントまたは定期的なイベントを作成するときに、その ID を指定できます。提供される ID は次のルールに従う必要があります。
- ID で許可される文字は、base32hex エンコードで使用される文字、つまり小文字の a ~ v と数字 0 ~ 9 です。RFC2938 のセクション 3.1.2 を参照してください。
- ID の長さは 5 ~ 1024 文字である必要があります
- ID はカレンダーごとに一意である必要があります。システムはグローバルに分散しているため、イベント作成時に ID の衝突が検出されることは保証できません。衝突のリスクを最小限に抑えるために、RFC4122 で説明されているような確立された UUID アルゴリズム
kind: リソースのタイプ (「calendar#event」)。
location: 自由形式のテキストとしてのイベントの地理的位置。オプション。
locked: これが、メイン イベント フィールドの「概要」、「説明」、「場所」、「開始」、「終了」、または「繰り返し」に変更を加えることができないロックされたイベント コピーであるかどうか。デフォルトは False です。読み取り専用。
organizer.displayName: 可能な場合は主催者の名前。
organizer.email: 主催者の電子メール アドレス (可能な場合)。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。
organizer.id: 主催者のプロフィール ID (利用可能な場合)。
organizer.self: 主催者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
originalStartTime.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
originalStartTime.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
originalStartTime.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
outOfOfficeProperties.autoDeclineMode: 外出中のイベントと重複する会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。および、declarOnlyNewConflictingInvitations。これは、不在時のイベントが存在する間に到着した、競合する新しい会議出席依頼のみが拒否されることを意味します。
outOfOfficeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
privateCopy: True に設定すると、イベントの伝播が無効になります。これはプライベート イベント プロパティと同じものではないことに注意してください。オプション。不変。デフォルトは False です。
recurrence: RFC5545 で指定されている、定期的なイベントの RRULE、EXRULE、RDATE、および EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行は許可されないことに注意してください。イベントの開始時刻と終了時刻は、開始フィールドと終了フィールドに指定されます。このフィールドは、単一のイベントまたは定期的なイベントのインスタンスでは省略されます。
recurringEventId: 定期的なイベントのインスタンスの場合、これは、このインスタンスが属する定期的なイベントの ID です。不変。
reminders.overrides: イベントでデフォルトのリマインダーが使用されていない場合、イベント固有のリマインダーが一覧表示されます。設定されていない場合は、このイベントにリマインダーが設定されていないことが示されます。上書きリマインダーの最大数は 5 です。
method: このリマインダーで使用されるメソッド。可能な値は次のとおりです。
- 「電子メール」 - リマインダーは電子メールで送信されます。
- 「ポップアップ」 - リマインダーは UI ポップアップ経由で送信されます。 リマインダーを追加する場合は必須です。
minutes: イベント開始の何分前にリマインダーをトリガーするかを指定します。有効な値は 0 ~ 40320 (4 週間分) です。リマインダーを追加する場合は必須です。
reminders.useDefault: カレンダーのデフォルトのリマインダーをイベントに適用するかどうか。
sequence: iCalendar によるシーケンス番号。
source.title: 情報源のタイトル。たとえば、Web ページのタイトルや電子メールの件名などです。
source.url: リソースを指すソースの URL。 URL スキームは HTTP または HTTPS である必要があります。
start.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
start.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
start.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
status: イベントのステータス。オプション。可能な値は次のとおりです。
- 「確認済み」 - イベントが確認されました。これがデフォルトのステータスです。
- 「暫定」 - イベントは暫定的に確認されています。
- 「キャンセル」 - イベントはキャンセル(削除)されます。 list メソッドは、増分同期時 (syncToken または updatedMin が指定されている場合)、または showDeleted フラグが true に設定されている場合にのみ、キャンセルされたイベントを返します。 get メソッドは常にそれらを返します。キャンセルされたステータスは、イベント タイプに応じて 2 つの異なる状態を表します。
- キャンセルされていない定期的なイベントのキャンセルされた例外
summary: イベントのタイトル。
transparency: イベントがカレンダー上の時間をブロックするかどうか。オプション。可能な値は次のとおりです。
- 「不透明」 - デフォルト値。イベントはカレンダー上の時間をブロックします。これは、カレンダー UI で「予定あり」を表示するように設定するのと同じです。
- 「透明」 - イベントはカレンダー上の時間をブロックしません。これは、カレンダー UI で [表示] を [利用可能] に設定するのと同じです。
updated: メイン イベント データの最終変更時刻 (RFC3339 タイムスタンプとして)。イベントリマインダーを更新してもこれは変わりません。読み取り専用。
visibility: イベントの可視性。オプション。可能な値は次のとおりです。
- "default" - カレンダー上のイベントのデフォルトの表示設定を使用します。これがデフォルト値です。
- "public" - イベントは公開されており、イベントの詳細はカレンダーのすべての読者に表示されます。
- 「プライベート」 - イベントはプライベートであり、イベントの参加者のみがイベントの詳細を表示できます。
- 「機密」 - イベントは非公開です。この値は互換性の理由から提供されています。
workingLocationProperties.customLocation.label: 追加情報用のオプションの追加ラベル。
workingLocationProperties.homeOffice: 存在する場合、ユーザーが在宅勤務していることを指定します。
workingLocationProperties.officeLocation.buildingId: オプションの建物識別子。これは、組織のリソース データベース内の建物 ID を参照する必要があります。
workingLocationProperties.officeLocation.deskId: オプションのデスク識別子。
workingLocationProperties.officeLocation.floorId: オプションのフロア識別子。
workingLocationProperties.officeLocation.floorSectionId: オプションのフロアセクション識別子。
workingLocationProperties.officeLocation.label: カレンダー Web クライアントおよびモバイル クライアントに表示されるオフィス名。組織のリソース データベースで建物名を参照することをお勧めします。
workingLocationProperties.type: 勤務場所のタイプ。可能な値は次のとおりです。
- 「homeOffice」 - ユーザーは自宅で仕事をしています。
- "officeLocation" - ユーザーはオフィスで働いています。
- "customLocation" - ユーザーはカスタムの場所から作業しています。 詳細は指定された名前のサブフィールドに指定されますが、このフィールドが空の場合は欠落している可能性があります。他のフィールドは無視されます。作業場所のプロパティを追加する場合に必要です。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
conferenceDataVersion: API クライアントがサポートする会議データのバージョン番号。バージョン 0 は会議データのサポートがないことを前提としており、イベント本文内の会議データを無視します。バージョン 1 では、ConferenceData のコピーと、conferenceData の createRequest フィールドを使用した新しい会議の作成のサポートが有効になります。デフォルトは 0 です。
supportsAttachments: 操作を実行する API クライアントがイベントの添付ファイルをサポートするかどうか。オプション。デフォルトは False です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: import」 参照: https://developers.google.com/calendar/api/v3/reference/events/import
calendar_events_insert
イベントを作成します。
パラメータ
anyoneCanAddSelf: 誰でもイベントに自分を招待できるかどうか (非推奨)。オプション。デフォルトは False です。
attachments: イベントの添付ファイル。添付ファイルを変更するには、supportsAttachments リクエスト パラメーターを true に設定する必要があります。イベントごとに最大 25 個の添付ファイルを追加できます。
fileId: 添付ファイルのID。読み取り専用。Google ドライブ ファイルの場合、これは Drive API の対応するファイル リソース エントリの ID です。
fileUrl: 添付ファイルへの URL リンク。Google ドライブの添付ファイルを追加するには、Drive API の Files リソースの alterLink プロパティと同じ形式を使用します。添付ファイルを追加する場合に必要です。
iconLink: 添付ファイルのアイコンへの URL リンク。このフィールドは、カスタムのサードパーティ添付ファイルに対してのみ変更できます。
mimeType: 添付ファイルのインターネット メディア タイプ (MIME タイプ)。
title: 添付ファイルのタイトル。
attendees: イベントの参加者。他のカレンダー ユーザーとのイベントのスケジュール設定の詳細については、「出席者とのイベント」ガイドを参照してください。サービス アカウントは、ドメイン全体の権限の委任を使用して、出席者リストにデータを入力する必要があります。
additionalGuests: 追加ゲストの数。オプション。デフォルトは 0 です。
comment: 参加者の返答コメント。オプション。
displayName: 参加者の名前(可能な場合)。オプション。
email: 参加者の電子メール アドレス (可能な場合)。出席者を追加する場合、このフィールドが存在する必要があります。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。出席者を追加する場合に必要です。
id: 参加者のプロフィール ID (利用可能な場合)。
optional: これが任意の出席者であるかどうか。オプション。デフォルトは False です。
organizer: 出席者がイベントの主催者であるかどうか。読み取り専用。デフォルトは False です。
resource: 出席者がリソースであるかどうか。参加者を初めてイベントに追加する場合にのみ設定できます。それ以降の変更は無視されます。オプション。デフォルトは False です。
responseStatus: 出席者の応答ステータス。可能な値は次のとおりです。
- "needsAction" - 出席者は招待に応答していません (新しいイベントに推奨)。
- 「拒否しました」 - 出席者は招待を拒否しました。
- "暫定" - 出席者は招待を暫定的に受け入れました。
- 「承諾」 - 出席者は招待を承諾しました。 警告: 拒否、暫定、または承認の値を使用してイベントを追加した場合、[カレンダーに招待状を追加する] 設定が [電子メールでの招待状に応答するとき] に設定されている出席者には、参加者が参加しない限り、カレンダーにイベントが表示されません。イベント招待メールで招待の応答を変更することを選択します。
self: このエントリが、イベントのこのコピーが表示されるカレンダーを表すかどうか。読み取り専用。デフォルトは False です。
attendeesOmitted: 出席者がイベントの表現から省略された可能性があるかどうか。イベントを取得するとき、これは maxAttendee クエリ パラメーターで指定された制限が原因である可能性があります。イベントを更新する場合、これは参加者の応答を更新するためにのみ使用できます。オプション。デフォルトは False です。
colorId: イベントの色。これは、カラー定義のイベント セクションのエントリを参照する ID です (カラー エンドポイントを参照)。オプション。
conferenceData.conferenceId: 会議のID。開発者が会議を追跡するために使用できますが、ユーザーには表示しないでください。ID 値は、会議ソリューションのタイプごとに異なる方法で形成されます。
- eventHangout:IDが設定されていません。 (この会議タイプは廃止されました。)
- eventNamedHangout: ID はハングアウトの名前です。 (この会議タイプは廃止されました。)
- HangoutsMeet: ID は 10 文字の会議コードです (例: aaa-bbbb-ccc)。
- addOn: ID はサードパーティプロバイダーによって定義されます。 オプション。
conferenceData.conferenceSolution.iconUri: このソリューションのユーザーに表示されるアイコン。
conferenceData.conferenceSolution.key.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.conferenceSolution.name: ユーザーに表示されるこのソリューションの名前。ローカライズされていません。
conferenceData.createRequest.conferenceSolutionKey.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.createRequest.requestId: このリクエストに対してクライアントが生成した一意の ID。
クライアントは、新しいリクエストごとにこの ID を再生成する必要があります。指定された ID が前のリクエストと同じである場合、リクエストは無視されます。
conferenceData.createRequest.status.statusCode: 会議作成リクエストの現在のステータス。読み取り専用。可能な値は次のとおりです。
- 「保留中」: 会議作成リクエストはまだ処理中です。
- "success": 会議作成リクエストが成功し、エントリ ポイントが設定されます。
- 「失敗」: 会議作成リクエストが失敗しました。エントリ ポイントがありません。
conferenceData.entryPoints: URL や電話番号など、個々の会議のエントリ ポイントに関する情報。それらはすべて同じ会議に属している必要があります。
ConferenceSolution と少なくとも 1 つのentryPoint、または createRequest のいずれかが必要です。
accessCode: 会議にアクセスするためのアクセス コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
entryPointFeatures: 有料か無料かなどのエントリ ポイントの機能。 1 つのエントリ ポイントに複数の機能を持たせることができます。ただし、有料と無料の両方を同じエントリ ポイントに設定することはできません。
entryPointType: 会議エントリポイントのタイプ。可能な値は次のとおりです。
- 「ビデオ」 - HTTP 経由で会議に参加します。会議には、0 または 1 つのビデオ エントリ ポイントを含めることができます。
- 「電話」 - 電話番号をダイヤルして会議に参加します。会議には、0 個以上の電話エントリ ポイントを含めることができます。
- 「sip」 - SIP 経由で会議に参加します。会議には 0 または 1 つの SIP エントリ ポイントを含めることができます。
- 「詳細」 - 追加の電話番号など、さらに詳しい会議参加手順。会議には、ゼロまたは 1 つ以上のエントリ ポイントを含めることができます。エントリ ポイントが 1 つだけ多い会議は有効な会議ではありません。
label: URIのラベル。エンドユーザーに表示されます。ローカライズされていません。最大長は 512 文字です。例:
- ビデオの場合: meets.google.com/aaa-bbbb-ccc
- 電話の場合: +1 123 268 2601
- SIP の場合: 12345678@altostrat.com
- 詳細: 記入しないでください オプション。
meetingCode: 会議にアクセスするための会議コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
passcode: 会議にアクセスするためのパスコード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。
password: 会議にアクセスするためのパスワード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
pin: 会議にアクセスするための PIN。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
regionCode: この電話アクセスに関連付けられている国の CLDR/ISO 3166 地域コード。例: スウェーデンの場合は「SE」。カレンダー バックエンドは、EntryPointType.PHONE に対してのみこのフィールドに値を入力します。
uri: エントリポイントのURI。最大長は 1300 文字です。形式:
- ビデオの場合、http: または https: スキーマが必要です。
- 電話の場合、tel: スキーマが必要です。 URI にはダイヤル シーケンス全体が含まれている必要があります (例: tel:+12345678900,,,123456789;1234)。
- sip の場合、sip: スキーマが必要です (例: sip:12345678@myprovider.com)。
- 詳細については、http: または https: スキーマが必要です。
conferenceData.notes: ユーザーに表示する追加のメモ (ドメイン管理者からの指示、法的通知など)。 HTMLを含めることができます。最大長は 2048 文字です。オプション。
conferenceData.parameters.addOnParameters.parameters.additionalProperties:
conferenceData.signature: 会議データの署名。サーバー側で生成されます。作成リクエストが失敗した会議の設定は解除されます。作成リクエストが保留中の会議の場合はオプションです。
created: イベントの作成時刻 (RFC3339 タイムスタンプとして)。読み取り専用。
creator.displayName: 可能な場合は作成者の名前。
creator.email: 作成者の電子メール アドレス (可能な場合)。
creator.id: 作成者のプロフィール ID (利用可能な場合)。
creator.self: 作成者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
description: イベントの説明。 HTMLを含めることができます。オプション。
end.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
end.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
end.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
endTimeUnspecified: 終了時刻が実際に未指定であるかどうか。この属性が True に設定されている場合でも、互換性の理由から終了時刻が提供されます。デフォルトは False です。
etag: リソースの ETag。
eventType: イベントの特定の種類。イベントの作成後にこれを変更することはできません。可能な値は次のとおりです。
- "default" - 定期的なイベント、または詳細は指定されていません。
- 「outOfOffice」 - 不在時のイベント。
- "focusTime" - フォーカス時間イベント。
- "workingLocation" - 作業場所イベント。
- 「fromGmail」 - Gmail からのイベント。このタイプのイベントは作成できません。
extendedProperties.private.additionalProperties: プライベート プロパティの名前と対応する値。
extendedProperties.shared.additionalProperties: 共有プロパティの名前と対応する値。
focusTimeProperties.autoDeclineMode: フォーカス タイム イベントと重なる会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。これは、フォーカス タイム イベントが存在する間に到着した、競合する新しい会議への招待のみが拒否されることを意味します。
focusTimeProperties.chatStatus: チャットおよび関連製品でユーザーをマークするステータス。これは利用可能であるか、または妨害しない可能性があります。
focusTimeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
gadget.display: ガジェットの表示モード。廃止されました。可能な値は次のとおりです。
- "アイコン" - ガジェットは、カレンダー ビューのイベントのタイトルの横に表示されます。
- "chip" - イベントをクリックするとガジェットが表示されます。
gadget.height: ガジェットの高さ (ピクセル単位)。高さは 0 より大きい整数である必要があります。オプション。廃止されました。
gadget.iconLink: ガジェットのアイコンの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.link: ガジェットの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.preferences.additionalProperties: 設定名と対応する値。
gadget.title: ガジェットのタイトル。廃止されました。
gadget.type: ガジェットのタイプ。廃止されました。
gadget.width: ガジェットの幅 (ピクセル単位)。幅は 0 より大きい整数である必要があります。オプションです。廃止されました。
guestsCanInviteOthers: 主催者以外の出席者が他の人をイベントに招待できるかどうか。オプション。デフォルトは True です。
guestsCanModify: 主催者以外の参加者がイベントを変更できるかどうか。オプション。デフォルトは False です。
guestsCanSeeOtherGuests: 主催者以外の参加者がイベントの参加者を確認できるかどうか。オプション。デフォルトは True です。
hangoutLink: このイベントに関連付けられた Google ハングアウトへの絶対リンク。読み取り専用。
htmlLink: Google カレンダー Web UI のこのイベントへの絶対リンク。読み取り専用。
iCalUID: RFC5545 で定義されているイベントの一意の識別子。これは、カレンダー システム全体でイベントを一意に識別するために使用され、インポート メソッドを介してイベントをインポートするときに指定する必要があります。iCalUID と ID は同一ではなく、イベント作成時にどちらか 1 つだけを指定する必要があることに注意してください。セマンティクスの 1 つの違いは、定期的なイベントでは、1 つのイベントのすべての発生が異なる ID を持ち、すべてが同じ iCalUID を共有することです。 iCalUID を使用してイベントを取得するには、iCalUID パラメーターを使用して events.list メソッドを呼び出します。 ID を使用してイベントを取得するには、events.get
id: イベントの不透明な識別子。新しい単一イベントまたは定期的なイベントを作成するときに、その ID を指定できます。提供される ID は次のルールに従う必要があります。
- ID で許可される文字は、base32hex エンコードで使用される文字、つまり小文字の a ~ v と数字 0 ~ 9 です。RFC2938 のセクション 3.1.2 を参照してください。
- ID の長さは 5 ~ 1024 文字である必要があります
- ID はカレンダーごとに一意である必要があります。システムはグローバルに分散しているため、イベント作成時に ID の衝突が検出されることは保証できません。衝突のリスクを最小限に抑えるために、RFC4122 で説明されているような確立された UUID アルゴリズム
kind: リソースのタイプ (「calendar#event」)。
location: 自由形式のテキストとしてのイベントの地理的位置。オプション。
locked: これが、メイン イベント フィールドの「概要」、「説明」、「場所」、「開始」、「終了」、または「繰り返し」に変更を加えることができないロックされたイベント コピーであるかどうか。デフォルトは False です。読み取り専用。
organizer.displayName: 可能な場合は主催者の名前。
organizer.email: 主催者の電子メール アドレス (可能な場合)。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。
organizer.id: 主催者のプロフィール ID (利用可能な場合)。
organizer.self: 主催者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
originalStartTime.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
originalStartTime.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
originalStartTime.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
outOfOfficeProperties.autoDeclineMode: 外出中のイベントと重複する会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。および、declarOnlyNewConflictingInvitations。これは、不在時のイベントが存在する間に到着した、競合する新しい会議出席依頼のみが拒否されることを意味します。
outOfOfficeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
privateCopy: True に設定すると、イベントの伝播が無効になります。これはプライベート イベント プロパティと同じものではないことに注意してください。オプション。不変。デフォルトは False です。
recurrence: RFC5545 で指定されている、定期的なイベントの RRULE、EXRULE、RDATE、および EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行は許可されないことに注意してください。イベントの開始時刻と終了時刻は、開始フィールドと終了フィールドに指定されます。このフィールドは、単一のイベントまたは定期的なイベントのインスタンスでは省略されます。
recurringEventId: 定期的なイベントのインスタンスの場合、これは、このインスタンスが属する定期的なイベントの ID です。不変。
reminders.overrides: イベントでデフォルトのリマインダーが使用されていない場合、イベント固有のリマインダーが一覧表示されます。設定されていない場合は、このイベントにリマインダーが設定されていないことが示されます。上書きリマインダーの最大数は 5 です。
method: このリマインダーで使用されるメソッド。可能な値は次のとおりです。
- 「電子メール」 - リマインダーは電子メールで送信されます。
- 「ポップアップ」 - リマインダーは UI ポップアップ経由で送信されます。 リマインダーを追加する場合は必須です。
minutes: イベント開始の何分前にリマインダーをトリガーするかを指定します。有効な値は 0 ~ 40320 (4 週間分) です。リマインダーを追加する場合は必須です。
reminders.useDefault: カレンダーのデフォルトのリマインダーをイベントに適用するかどうか。
sequence: iCalendar によるシーケンス番号。
source.title: 情報源のタイトル。たとえば、Web ページのタイトルや電子メールの件名などです。
source.url: リソースを指すソースの URL。 URL スキームは HTTP または HTTPS である必要があります。
start.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
start.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
start.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
status: イベントのステータス。オプション。可能な値は次のとおりです。
- 「確認済み」 - イベントが確認されました。これがデフォルトのステータスです。
- 「暫定」 - イベントは暫定的に確認されています。
- 「キャンセル」 - イベントはキャンセル(削除)されます。 list メソッドは、増分同期時 (syncToken または updatedMin が指定されている場合)、または showDeleted フラグが true に設定されている場合にのみ、キャンセルされたイベントを返します。 get メソッドは常にそれらを返します。キャンセルされたステータスは、イベント タイプに応じて 2 つの異なる状態を表します。
- キャンセルされていない定期的なイベントのキャンセルされた例外
summary: イベントのタイトル。
transparency: イベントがカレンダー上の時間をブロックするかどうか。オプション。可能な値は次のとおりです。
- 「不透明」 - デフォルト値。イベントはカレンダー上の時間をブロックします。これは、カレンダー UI で「予定あり」を表示するように設定するのと同じです。
- 「透明」 - イベントはカレンダー上の時間をブロックしません。これは、カレンダー UI で [表示] を [利用可能] に設定するのと同じです。
updated: メイン イベント データの最終変更時刻 (RFC3339 タイムスタンプとして)。イベントリマインダーを更新してもこれは変わりません。読み取り専用。
visibility: イベントの可視性。オプション。可能な値は次のとおりです。
- "default" - カレンダー上のイベントのデフォルトの表示設定を使用します。これがデフォルト値です。
- "public" - イベントは公開されており、イベントの詳細はカレンダーのすべての読者に表示されます。
- 「プライベート」 - イベントはプライベートであり、イベントの参加者のみがイベントの詳細を表示できます。
- 「機密」 - イベントは非公開です。この値は互換性の理由から提供されています。
workingLocationProperties.customLocation.label: 追加情報用のオプションの追加ラベル。
workingLocationProperties.homeOffice: 存在する場合、ユーザーが在宅勤務していることを指定します。
workingLocationProperties.officeLocation.buildingId: オプションの建物識別子。これは、組織のリソース データベース内の建物 ID を参照する必要があります。
workingLocationProperties.officeLocation.deskId: オプションのデスク識別子。
workingLocationProperties.officeLocation.floorId: オプションのフロア識別子。
workingLocationProperties.officeLocation.floorSectionId: オプションのフロアセクション識別子。
workingLocationProperties.officeLocation.label: カレンダー Web クライアントおよびモバイル クライアントに表示されるオフィス名。組織のリソース データベースで建物名を参照することをお勧めします。
workingLocationProperties.type: 勤務場所のタイプ。可能な値は次のとおりです。
- 「homeOffice」 - ユーザーは自宅で仕事をしています。
- "officeLocation" - ユーザーはオフィスで働いています。
- "customLocation" - ユーザーはカスタムの場所から作業しています。 詳細は指定された名前のサブフィールドに指定されますが、このフィールドが空の場合は欠落している可能性があります。他のフィールドは無視されます。作業場所のプロパティを追加する場合に必要です。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
conferenceDataVersion: API クライアントがサポートする会議データのバージョン番号。バージョン 0 は会議データのサポートがないことを前提としており、イベント本文内の会議データを無視します。バージョン 1 では、ConferenceData のコピーと、conferenceData の createRequest フィールドを使用した新しい会議の作成のサポートが有効になります。デフォルトは 0 です。
maxAttendees: 応答に含める出席者の最大数。指定された数を超える参加者がいる場合は、参加者のみが返されます。オプション。
sendNotifications: 廃止されました。代わりにsendUpdatesを使用してください。新しいイベントの作成に関する通知を送信するかどうか。値を false に設定した場合でも、一部の電子メールは送信される可能性があることに注意してください。デフォルトは false です。
sendUpdates: 新しいイベントの作成に関する通知を送信するかどうか。一部の電子メールは引き続き送信される可能性があることに注意してください。デフォルトは false です。
supportsAttachments: 操作を実行する API クライアントがイベントの添付ファイルをサポートするかどうか。オプション。デフォルトは False です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: insert」 参照: https://developers.google.com/calendar/api/v3/reference/events/insert
calendar_events_instances
指定された定期的なイベントのインスタンスを返します。
パラメータ
alwaysIncludeEmail: 非推奨となり無視されました。実際の電子メール アドレスが利用できない場合でも、主催者、作成者、および参加者の電子メール フィールドには常に値が返されます (つまり、生成された機能しない値が提供されます)。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
eventId: 定期的なイベントの識別子。
maxAttendees: 応答に含める出席者の最大数。指定された数を超える参加者がいる場合は、参加者のみが返されます。オプション。
maxResults: 1 つの結果ページで返されるイベントの最大数。デフォルトの値は 250 イベントです。ページ サイズは 2500 イベントを超えることはできません。オプション。
originalStart: 結果内のインスタンスの元の開始時刻。オプション。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
showDeleted: 削除されたイベント (ステータスが「キャンセル」に等しい) を結果に含めるかどうか。 singleEvents が False の場合、定期的なイベントのキャンセルされたインスタンスは引き続き含まれます。オプション。デフォルトは False です。
timeMax: フィルタリングするイベントの開始時間の上限 (排他的)。オプション。デフォルトでは、開始時間によるフィルタリングは行われません。タイムゾーンオフセットが必須の RFC3339 タイムスタンプである必要があります。
timeMin: フィルタリングするイベントの終了時間の下限 (両端を含む)。オプション。デフォルトでは、終了時間によるフィルタリングは行われません。タイムゾーンオフセットが必須の RFC3339 タイムスタンプである必要があります。
timeZone: 応答で使用されるタイムゾーン。オプション。デフォルトはカレンダーのタイムゾーンです。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: instances」 参照: https://developers.google.com/calendar/api/v3/reference/events/instances
calendar_events_list
指定されたカレンダーのイベントを返します。
パラメータ
alwaysIncludeEmail: 非推奨となり無視されました。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
eventTypes: 返されるイベントのタイプ。オプション。このパラメーターを複数回繰り返して、さまざまなタイプのイベントを返すことができます。設定されていない場合は、すべてのイベント タイプを返します。
iCalUID: 応答で提供されるイベント ID を iCalendar 形式で指定します。オプション。 iCalendar ID でイベントを検索する場合は、これを使用します。
maxAttendees: 応答に含める出席者の最大数。指定された数を超える参加者がいる場合は、参加者のみが返されます。オプション。
maxResults: 1 つの結果ページで返されるイベントの最大数。クエリに一致するイベントがさらにある場合でも、結果のページ内のイベントの数はこの値より少ない場合や、まったくない場合があります。不完全なページは、応答内の空でない nextPageToken フィールドによって検出できます。デフォルトの値は 250 イベントです。ページ サイズは 2500 イベントを超えることはできません。オプション。
orderBy: 結果として返されるイベントの順序。オプション。デフォルトは、指定されていない安定した順序です。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
privateExtendedProperty: propertyName=value として指定された拡張プロパティ制約。プライベート プロパティのみに一致します。このパラメーターは、指定されたすべての制約に一致するイベントを返すために複数回繰り返される場合があります。
q: フリー テキストの検索用語を使用すると、次のフィールドでこれらの用語に一致するイベントを検索できます。
- まとめ
- 説明
- 位置
- 出席者の表示名
- 参加者のメールアドレス
- 主催者の表示名
- 主催者のメール
- workingLocationProperties.officeLocation.buildingId
- workingLocationProperties.officeLocation.deskId
- workingLocationProperties.officeLocation.label
- workingLocationProperties.customLocation.label
これらの検索語は、勤務場所、外出中、集中時間のイ
sharedExtendedProperty: propertyName=value として指定された拡張プロパティ制約。共有プロパティのみに一致します。このパラメーターは、指定されたすべての制約に一致するイベントを返すために複数回繰り返される場合があります。
showDeleted: 削除されたイベント (ステータスが「キャンセル」に等しい) を結果に含めるかどうか。 showDeleted と singleEvents が両方とも False の場合、定期的なイベントのキャンセルされたインスタンス (ただし、基礎となる定期的なイベントは含まれません) は引き続き含まれます。 showDeleted と singleEvents が両方とも True の場合、削除されたイベントの単一インスタンスのみが返されます (ただし、基礎となる定期的なイベントは返されません)。オプション。デフォルトは False です。
showHiddenInvitations: 非表示の招待状を結果に含めるかどうか。オプション。デフォルトは False です。
singleEvents: 定期的なイベントをインスタンスに拡張し、単一の 1 回限りのイベントと定期的なイベントのインスタンスのみを返しますが、基になる繰り返しイベント自体は返さないかどうか。オプション。デフォルトは False です。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。前回のリスト要求以降に削除されたすべてのイベントは常に結果セットに含まれるため、showDeleted を False に設定することはできません。クライアント状態の一貫性を確保するために nextSyncToken と一緒に指定できないクエリ パラメーターがいくつかあります。
これらは:
- iCalUID
- 注文方法
- privateExtendedProperty
-q
- 共有拡張プロパティ
- 最小時間
- 最大時間
- updatedMin 未定義の動作を避けるために
timeMax: フィルタリングするイベントの開始時間の上限 (排他的)。オプション。デフォルトでは、開始時間によるフィルタリングは行われません。必須のタイム ゾーン オフセットを含む RFC3339 タイムスタンプである必要があります (例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定すwることもできますが、無視されます。 timeMin が設定されている場合、timeMax は timeMin より大きくなければなりません。
timeMin: フィルタリングするイベントの終了時間の下限 (排他的)。オプション。デフォルトでは、終了時間によるフィルタリングは行われません。必須のタイム ゾーン オフセットを含む RFC3339 タイムスタンプである必要があります (例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定することもできますが、無視されます。 timeMax が設定されている場合、timeMin は timeMax より小さくなければなりません。
timeZone: 応答で使用されるタイムゾーン。オプション。デフォルトはカレンダーのタイムゾーンです。
updatedMin: フィルターに使用するイベントの最終変更時刻 (RFC3339 タイムスタンプとして) の下限。指定すると、showDeleted に関係なく、今回以降に削除されたエントリが常に含まれます。オプション。デフォルトでは、最終変更時刻によるフィルタリングは行われません。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: list」 参照: https://developers.google.com/calendar/api/v3/reference/events/list
calendar_events_move
イベントを別のカレンダーに移動します。つまり、イベントの主催者を変更します。移動できるのはデフォルトのイベントのみであることに注意してください。 outOfOffice、focusTime、workingLocation、fromGmail イベントは移動できません。
パラメータ
calendarId: イベントが現在開催されているソース カレンダーのカレンダー識別子。
destination: イベントの移動先となるターゲットカレンダーのカレンダー識別子。
eventId: イベント識別子。
sendNotifications: 廃止されました。代わりにsendUpdatesを使用してください。イベントの主催者の変更に関する通知を送信するかどうか。値を false に設定した場合でも、一部の電子メールは送信される可能性があることに注意してください。デフォルトは false です。
sendUpdates: イベント主催者の変更に関する通知を受け取る必要があるゲスト。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: move」 参照: https://developers.google.com/calendar/api/v3/reference/events/move
calendar_events_patch
イベントを更新します。このメソッドはパッチのセマンティクスをサポートします。
パラメータ
anyoneCanAddSelf: 誰でもイベントに自分を招待できるかどうか (非推奨)。オプション。デフォルトは False です。
attachments: イベントの添付ファイル。添付ファイルを変更するには、supportsAttachments リクエスト パラメーターを true に設定する必要があります。イベントごとに最大 25 個の添付ファイルを追加できます。
fileId: 添付ファイルのID。読み取り専用。Google ドライブ ファイルの場合、これは Drive API の対応するファイル リソース エントリの ID です。
fileUrl: 添付ファイルへの URL リンク。Google ドライブの添付ファイルを追加するには、Drive API の Files リソースの alterLink プロパティと同じ形式を使用します。添付ファイルを追加する場合に必要です。
iconLink: 添付ファイルのアイコンへの URL リンク。このフィールドは、カスタムのサードパーティ添付ファイルに対してのみ変更できます。
mimeType: 添付ファイルのインターネット メディア タイプ (MIME タイプ)。
title: 添付ファイルのタイトル。
attendees: イベントの参加者。他のカレンダー ユーザーとのイベントのスケジュール設定の詳細については、「出席者とのイベント」ガイドを参照してください。サービス アカウントは、ドメイン全体の権限の委任を使用して、出席者リストにデータを入力する必要があります。
additionalGuests: 追加ゲストの数。オプション。デフォルトは 0 です。
comment: 参加者の返答コメント。オプション。
displayName: 参加者の名前(可能な場合)。オプション。
email: 参加者の電子メール アドレス (可能な場合)。出席者を追加する場合、このフィールドが存在する必要があります。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。出席者を追加する場合に必要です。
id: 参加者のプロフィール ID (利用可能な場合)。
optional: これが任意の出席者であるかどうか。オプション。デフォルトは False です。
organizer: 出席者がイベントの主催者であるかどうか。読み取り専用。デフォルトは False です。
resource: 出席者がリソースであるかどうか。参加者を初めてイベントに追加する場合にのみ設定できます。それ以降の変更は無視されます。オプション。デフォルトは False です。
responseStatus: 出席者の応答ステータス。可能な値は次のとおりです。
- "needsAction" - 出席者は招待に応答していません (新しいイベントに推奨)。
- 「拒否しました」 - 出席者は招待を拒否しました。
- "暫定" - 出席者は招待を暫定的に受け入れました。
- 「承諾」 - 出席者は招待を承諾しました。 警告: 拒否、暫定、または承認の値を使用してイベントを追加した場合、[カレンダーに招待状を追加する] 設定が [電子メールでの招待状に応答するとき] に設定されている出席者には、参加者が参加しない限り、カレンダーにイベントが表示されません。イベント招待メールで招待の応答を変更することを選択します。
self: このエントリが、イベントのこのコピーが表示されるカレンダーを表すかどうか。読み取り専用。デフォルトは False です。
attendeesOmitted: 出席者がイベントの表現から省略された可能性があるかどうか。イベントを取得するとき、これは maxAttendee クエリ パラメーターで指定された制限が原因である可能性があります。イベントを更新する場合、これは参加者の応答を更新するためにのみ使用できます。オプション。デフォルトは False です。
colorId: イベントの色。これは、カラー定義のイベント セクションのエントリを参照する ID です (カラー エンドポイントを参照)。オプション。
conferenceData.conferenceId: 会議のID。開発者が会議を追跡するために使用できますが、ユーザーには表示しないでください。ID 値は、会議ソリューションのタイプごとに異なる方法で形成されます。
- eventHangout:IDが設定されていません。 (この会議タイプは廃止されました。)
- eventNamedHangout: ID はハングアウトの名前です。 (この会議タイプは廃止されました。)
- HangoutsMeet: ID は 10 文字の会議コードです (例: aaa-bbbb-ccc)。
- addOn: ID はサードパーティプロバイダーによって定義されます。 オプション。
conferenceData.conferenceSolution.iconUri: このソリューションのユーザーに表示されるアイコン。
conferenceData.conferenceSolution.key.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.conferenceSolution.name: ユーザーに表示されるこのソリューションの名前。ローカライズされていません。
conferenceData.createRequest.conferenceSolutionKey.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.createRequest.requestId: このリクエストに対してクライアントが生成した一意の ID。クライアントは、新しいリクエストごとにこの ID を再生成する必要があります。指定された ID が前のリクエストと同じである場合、リクエストは無視されます。
conferenceData.createRequest.status.statusCode: 会議作成リクエストの現在のステータス。読み取り専用。可能な値は次のとおりです。
- 「保留中」: 会議作成リクエストはまだ処理中です。
- "success": 会議作成リクエストが成功し、エントリ ポイントが設定されます。
- 「失敗」: 会議作成リクエストが失敗しました。エントリ ポイントがありません。
conferenceData.entryPoints: URL や電話番号など、個々の会議のエントリ ポイントに関する情報。それらはすべて同じ会議に属している必要があります。
ConferenceSolution と少なくとも 1 つのentryPoint、または createRequest のいずれかが必要です。
accessCode: 会議にアクセスするためのアクセス コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
entryPointFeatures: 有料か無料かなどのエントリ ポイントの機能。 1 つのエントリ ポイントに複数の機能を持たせることができます。ただし、有料と無料の両方を同じエントリ ポイントに設定することはできません。
entryPointType: 会議エントリポイントのタイプ。可能な値は次のとおりです。
- 「ビデオ」 - HTTP 経由で会議に参加します。会議には、0 または 1 つのビデオ エントリ ポイントを含めることができます。
- 「電話」 - 電話番号をダイヤルして会議に参加します。会議には、0 個以上の電話エントリ ポイントを含めることができます。
- 「sip」 - SIP 経由で会議に参加します。会議には 0 または 1 つの SIP エントリ ポイントを含めることができます。
- 「詳細」 - 追加の電話番号など、さらに詳しい会議参加手順。会議には、ゼロまたは 1 つ以上のエントリ ポイントを含めることができます。エントリ ポイントが 1 つだけ多い会議は有効な会議ではありません。
label: URIのラベル。エンドユーザーに表示されます。ローカライズされていません。最大長は 512 文字です。例:
- ビデオの場合: meets.google.com/aaa-bbbb-ccc
- 電話の場合: +1 123 268 2601
- SIP の場合: 12345678@altostrat.com
- 詳細: 記入しないでください オプション。
meetingCode: 会議にアクセスするための会議コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
passcode: 会議にアクセスするためのパスコード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。
password: 会議にアクセスするためのパスワード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
pin: 会議にアクセスするための PIN。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
regionCode: この電話アクセスに関連付けられている国の CLDR/ISO 3166 地域コード。例: スウェーデンの場合は「SE」。カレンダー バックエンドは、EntryPointType.PHONE に対してのみこのフィールドに値を入力します。
uri: エントリポイントのURI。最大長は 1300 文字です。形式:
- ビデオ の場合、http: または https: スキーマが必要です。
- 電話の場合、tel: スキーマが必要です。 URI にはダイヤル シーケンス全体が含まれている必要があります (例: tel:+12345678900,,,123456789;1234)。
- sip の場合、sip: スキーマが必要です (例: sip:12345678@myprovider.com)。
- 詳細については、http: または https: スキーマが必要です。
conferenceData.notes: ユーザーに表示する追加のメモ (ドメイン管理者からの指示、法的通知など)。 HTMLを含めることができます。最大長は 2048 文字です。オプション。
conferenceData.parameters.addOnParameters.parameters.additionalProperties:
conferenceData.signature: 会議データの署名。サーバー側で生成されます。作成リクエストが失敗した会議の設定は解除されます。作成リクエストが保留中の会議の場合はオプションです。
created: イベントの作成時刻 (RFC3339 タイムスタンプとして)。読み取り専用。
creator.displayName: 可能な場合は作成者の名前。
creator.email: 作成者の電子メール アドレス (可能な場合)。
creator.id: 作成者のプロフィール ID (利用可能な場合)。
creator.self: 作成者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
description: イベントの説明。 HTMLを含めることができます。オプション。
end.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
end.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
end.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
endTimeUnspecified: 終了時刻が実際に未指定であるかどうか。この属性が True に設定されている場合でも、互換性の理由から終了時刻が提供されます。デフォルトは False です。
etag: リソースの ETag。
eventType: イベントの特定の種類。イベントの作成後にこれを変更することはできません。可能な値は次のとおりです。
- "default" - 定期的なイベント、または詳細は指定されていません。
- 「outOfOffice」 - 不在時のイベント。
- "focusTime" - フォーカス時間イベント。
- "workingLocation" - 作業場所イベント。
- 「fromGmail」 - Gmail からのイベント。このタイプのイベントは作成できません。
extendedProperties.private.additionalProperties: プライベート プロパティの名前と対応する値。
extendedProperties.shared.additionalProperties: 共有プロパティの名前と対応する値。
focusTimeProperties.autoDeclineMode: フォーカス タイム イベントと重なる会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。これは、フォーカス タイム イベントが存在する間に到着した、競合する新しい会議への招待のみが拒否されることを意味します。
focusTimeProperties.chatStatus: チャットおよび関連製品でユーザーをマークするステータス。これは利用可能であるか、または妨害しない可能性があります。
focusTimeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
gadget.display: ガジェットの表示モード。廃止されました。可能な値は次のとおりです。
- "アイコン" - ガジェットは、カレンダー ビューのイベントのタイトルの横に表示されます。
- "chip" - イベントをクリックするとガジェットが表示されます。
gadget.height: ガジェットの高さ (ピクセル単位)。高さは 0 より大きい整数である必要があります。オプション。廃止されました。
gadget.iconLink: ガジェットのアイコンの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.link: ガジェットの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.preferences.additionalProperties: 設定名と対応する値。
gadget.title: ガジェットのタイトル。廃止されました。
gadget.type: ガジェットのタイプ。廃止されました。
gadget.width: ガジェットの幅 (ピクセル単位)。幅は 0 より大きい整数である必要があります。オプションです。廃止されました。
guestsCanInviteOthers: 主催者以外の出席者が他の人をイベントに招待できるかどうか。オプション。デフォルトは True です。
guestsCanModify: 主催者以外の参加者がイベントを変更できるかどうか。オプション。デフォルトは False です。
guestsCanSeeOtherGuests: 主催者以外の参加者がイベントの参加者を確認できるかどうか。オプション。デフォルトは True です。
hangoutLink: このイベントに関連付けられた Google ハングアウトへの絶対リンク。読み取り専用。
htmlLink: Google カレンダー Web UI のこのイベントへの絶対リンク。読み取り専用。
iCalUID: RFC5545 で定義されているイベントの一意の識別子。これは、カレンダー システム全体でイベントを一意に識別するために使用され、インポート メソッドを介してイベントをインポートするときに指定する必要があります。
iCalUID と ID は同一ではなく、イベント作成時にどちらか 1 つだけを指定する必要があることに注意してください。セマンティクスの 1 つの違いは、定期的なイベントでは、1 つのイベントのすべての発生が異なる ID を持ち、すべてが同じ iCalUID を共有することです。 iCalUID を使用してイベントを取得するには、iCalUID パラメーターを使用して events.list メソッドを呼び出します。 ID を使用してイベントを取得するには、events.get
id: イベントの不透明な識別子。新しい単一イベントまたは定期的なイベントを作成するときに、その ID を指定できます。提供される ID は次のルールに従う必要があります。
- ID で許可される文字は、base32hex エンコードで使用される文字、つまり小文字の a ~ v と数字 0 ~ 9 です。RFC2938 のセクション 3.1.2 を参照してください。
- ID の長さは 5 ~ 1024 文字である必要があります
- ID はカレンダーごとに一意である必要があります。システムはグローバルに分散しているため、イベント作成時に ID の衝突が検出されることは保証できません。衝突のリスクを最小限に抑えるために、RFC4122 で説明されているような確立された UUID アルゴリズム
kind: リソースのタイプ (「calendar#event」)。
location: 自由形式のテキストとしてのイベントの地理的位置。オプション。
locked: これが、メイン イベント フィールドの「概要」、「説明」、「場所」、「開始」、「終了」、または「繰り返し」に変更を加えることができないロックされたイベント コピーであるかどうか。デフォルトは False です。読み取り専用。
organizer.displayName: 可能な場合は主催者の名前。
organizer.email: 主催者の電子メール アドレス (可能な場合)。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。
organizer.id: 主催者のプロフィール ID (利用可能な場合)。
organizer.self: 主催者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
originalStartTime.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
originalStartTime.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
originalStartTime.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
outOfOfficeProperties.autoDeclineMode: 外出中のイベントと重複する会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。および、declarOnlyNewConflictingInvitations。これは、不在時のイベントが存在する間に到着した、競合する新しい会議出席依頼のみが拒否されることを意味します。
outOfOfficeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
privateCopy: True に設定すると、イベントの伝播が無効になります。これはプライベート イベント プロパティと同じものではないことに注意してください。オプション。不変。デフォルトは False です。
recurrence: RFC5545 で指定されている、定期的なイベントの RRULE、EXRULE、RDATE、および EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行は許可されないことに注意してください。イベントの開始時刻と終了時刻は、開始フィールドと終了フィールドに指定されます。このフィールドは、単一のイベントまたは定期的なイベントのインスタンスでは省略されます。
recurringEventId: 定期的なイベントのインスタンスの場合、これは、このインスタンスが属する定期的なイベントの ID です。不変。
reminders.overrides: イベントでデフォルトのリマインダーが使用されていない場合、イベント固有のリマインダーが一覧表示されます。設定されていない場合は、このイベントにリマインダーが設定されていないことが示されます。上書きリマインダーの最大数は 5 です。
method: このリマインダーで使用されるメソッド。可能な値は次のとおりです。
- 「電子メール」 - リマインダーは電子メールで送信されます。
- 「ポップアップ」 - リマインダーは UI ポップアップ経由で送信されます。 リマインダーを追加する場合は必須です。
minutes: イベント開始の何分前にリマインダーをトリガーするかを指定します。有効な値は 0 ~ 40320 (4 週間分) です。リマインダーを追加する場合は必須です。
reminders.useDefault: カレンダーのデフォルトのリマインダーをイベントに適用するかどうか。
sequence: iCalendar によるシーケンス番号。
source.title: 情報源のタイトル。たとえば、Web ページのタイトルや電子メールの件名などです。
source.url: リソースを指すソースの URL。 URL スキームは HTTP または HTTPS である必要があります。
start.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
start.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
start.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
status: イベントのステータス。オプション。可能な値は次のとおりです。
- 「確認済み」 - イベントが確認されました。これがデフォルトのステータスです。
- 「暫定」 - イベントは暫定的に確認されています。
- 「キャンセル」 - イベントはキャンセル(削除)されます。 list メソッドは、増分同期時 (syncToken または updatedMin が指定されている場合)、または showDeleted フラグが true に設定されている場合にのみ、キャンセルされたイベントを返します。 get メソッドは常にそれらを返します。キャンセルされたsummary: イベントのタイトル。
transparency: イベントがカレンダー上の時間をブロックするかどうか。オプション。可能な値は次のとおりです。
- 「不透明」 - デフォルト値。イベントはカレンダー上の時間をブロックします。これは、カレンダー UI で「予定あり」を表示するように設定するのと同じです。
- 「透明」 - イベントはカレンダー上の時間をブロックしません。これは、カレンダー UI で [表示] を [利用可能] に設定するのと同じです。
updated: メイン イベント データの最終変更時刻 (RFC3339 タイムスタンプとして)。イベントリマインダーを更新してもこれは変わりません。読み取り専用。
visibility: イベントの可視性。オプション。可能な値は次のとおりです。
- "default" - カレンダー上のイベントのデフォルトの表示設定を使用します。これがデフォルト値です。
- "public" - イベントは公開されており、イベントの詳細はカレンダーのすべての読者に表示されます。
- 「プライベート」 - イベントはプライベートであり、イベントの参加者のみがイベントの詳細を表示できます。
- 「機密」 - イベントは非公開です。この値は互換性の理由から提供されています。
workingLocationProperties.customLocation.label: 追加情報用のオプションの追加ラベル。
workingLocationProperties.homeOffice: 存在する場合、ユーザーが在宅勤務していることを指定します。
workingLocationProperties.officeLocation.buildingId: オプションの建物識別子。これは、組織のリソース データベース内の建物 ID を参照する必要があります。
workingLocationProperties.officeLocation.deskId: オプションのデスク識別子。
workingLocationProperties.officeLocation.floorId: オプションのフロア識別子。
workingLocationProperties.officeLocation.floorSectionId: オプションのフロアセクション識別子。
workingLocationProperties.officeLocation.label: カレンダー Web クライアントおよびモバイル クライアントに表示されるオフィス名。組織のリソース データベースで建物名を参照することをお勧めします。
workingLocationProperties.type: 勤務場所のタイプ。可能な値は次のとおりです。
- 「homeOffice」 - ユーザーは自宅で仕事をしています。
- "officeLocation" - ユーザーはオフィスで働いています。
- "customLocation" - ユーザーはカスタムの場所から作業しています。 詳細は指定された名前のサブフィールドに指定されますが、このフィールドが空の場合は欠落している可能性があります。他のフィールドは無視されます。作業場所のプロパティを追加する場合に必要です。
alwaysIncludeEmail: 非推奨となり無視されました。実際の電子メール アドレスが利用できない場合でも、主催者、作成者、および参加者の電子メール フィールドには常に値が返されます (つまり、生成された機能しない値が提供されます)。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
conferenceDataVersion: API クライアントがサポートする会議データのバージョン番号。バージョン 0 は会議データのサポートがないことを前提としており、イベント本文内の会議データを無視します。バージョン 1 では、ConferenceData のコピーと、conferenceData の createRequest フィールドを使用した新しい会議の作成のサポートが有効になります。デフォルトは 0 です。
eventId: イベント識別子。
maxAttendees: 応答に含める出席者の最大数。指定された数を超える参加者がいる場合は、参加者のみが返されます。オプション。
sendNotifications: 廃止されました。代わりにsendUpdatesを使用してください。イベントの更新 (説明の変更など) に関する通知を送信するかどうか。値を false に設定した場合でも、一部の電子メールは送信される可能性があることに注意してください。デフォルトは false です。
sendUpdates: イベントの更新に関する通知を受け取る必要があるゲスト (タイトルの変更など)。
supportsAttachments: 操作を実行する API クライアントがイベントの添付ファイルをサポートするかどうか。オプション。デフォルトは False です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: patch」 参照: https://developers.google.com/calendar/api/v3/reference/events/patch
calendar_events_quickAdd
単純なテキスト文字列に基づいてイベントを作成します。
パラメータ
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
sendNotifications: 廃止されました。代わりにsendUpdatesを使用してください。イベントの作成に関する通知を送信するかどうか。値を false に設定した場合でも、一部の電子メールは送信される可能性があることに注意してください。デフォルトは false です。
sendUpdates: 新しいイベントの作成に関する通知を受け取るゲスト。
text: 作成されるイベントを説明するテキスト。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: quickAdd」 参照: https://developers.google.com/calendar/api/v3/reference/events/quickAdd
calendar_events_update
イベントを更新します。
パラメータ
anyoneCanAddSelf: 誰でもイベントに自分を招待できるかどうか (非推奨)。オプション。デフォルトは False です。
attachments: イベントの添付ファイル。添付ファイルを変更するには、supportsAttachments リクエスト パラメーターを true に設定する必要があります。イベントごとに最大 25 個の添付ファイルを追加できます。
fileId: 添付ファイルのID。読み取り専用。Google ドライブ ファイルの場合、これは Drive API の対応するファイル リソース エントリの ID です。
fileUrl: 添付ファイルへの URL リンク。Google ドライブの添付ファイルを追加するには、Drive API の Files リソースの alterLink プロパティと同じ形式を使用します。添付ファイルを追加する場合に必要です。
iconLink: 添付ファイルのアイコンへの URL リンク。このフィールドは、カスタムのサードパーティ添付ファイルに対してのみ変更できます。
mimeType: 添付ファイルのインターネット メディア タイプ (MIME タイプ)。
title: 添付ファイルのタイトル。
attendees: イベントの参加者。他のカレンダー ユーザーとのイベントのスケジュール設定の詳細については、「出席者とのイベント」ガイドを参照してください。サービス アカウントは、ドメイン全体の権限の委任を使用して、出席者リストにデータを入力する必要があります。
additionalGuests: 追加ゲストの数。オプション。デフォルトは 0 です。
comment: 参加者の返答コメント。オプション。
displayName: 参加者の名前(可能な場合)。オプション。
email: 参加者の電子メール アドレス (可能な場合)。出席者を追加する場合、このフィールドが存在する必要があります。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。出席者を追加する場合に必要です。
id: 参加者のプロフィール ID (利用可能な場合)。
optional: これが任意の出席者であるかどうか。オプション。デフォルトは False です。
organizer: 出席者がイベントの主催者であるかどうか。読み取り専用。デフォルトは False です。
resource: 出席者がリソースであるかどうか。参加者を初めてイベントに追加する場合にのみ設定できます。それ以降の変更は無視されます。オプション。デフォルトは False です。
responseStatus: 出席者の応答ステータス。可能な値は次のとおりです。
- "needsAction" - 出席者は招待に応答していません (新しいイベントに推奨)。
- 「拒否しました」 - 出席者は招待を拒否しました。
- "暫定" - 出席者は招待を暫定的に受け入れました。
- 「承諾」 - 出席者は招待を承諾しました。 警告: 拒否、暫定、または承認の値を使用してイベントを追加した場合、[カレンダーに招待状を追加する] 設定が [電子メールでの招待状に応答するとき] に設定されている出席者には、参加者が参加しない限り、カレンダーにイベントが表示されません。イベント招待メールで招待の応答を変更することを選択します。
self: このエントリが、イベントのこのコピーが表示されるカレンダーを表すかどうか。読み取り専用。デフォルトは False です。
attendeesOmitted: 出席者がイベントの表現から省略された可能性があるかどうか。イベントを取得するとき、これは maxAttendee クエリ パラメーターで指定された制限が原因である可能性があります。イベントを更新する場合、これは参加者の応答を更新するためにのみ使用できます。オプション。デフォルトは False です。
colorId: イベントの色。これは、カラー定義のイベント セクションのエントリを参照する ID です (カラー エンドポイントを参照)。オプション。
conferenceData.conferenceId: 会議のID。開発者が会議を追跡するために使用できますが、ユーザーには表示しないでください。ID 値は、会議ソリューションのタイプごとに異なる方法で形成されます。
- eventHangout:IDが設定されていません。 (この会議タイプは廃止されました。)
- eventNamedHangout: ID はハングアウトの名前です。 (この会議タイプは廃止されました。)
- HangoutsMeet: ID は 10 文字の会議コードです (例: aaa-bbbb-ccc)。
- addOn: ID はサードパーティプロバイダーによって定義されます。 オプション。
conferenceData.conferenceSolution.iconUri: このソリューションのユーザーに表示されるアイコン。
conferenceData.conferenceSolution.key.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.conferenceSolution.name: ユーザーに表示されるこのソリューションの名前。ローカライズされていません。
conferenceData.createRequest.conferenceSolutionKey.type: 会議ソリューションのタイプ。クライアントが見慣れない型または空の型に遭遇した場合でも、エントリ ポイントを表示できるはずです。ただし、変更は禁止する必要があります。可能な値は次のとおりです。
- 消費者向けハングアウトの「eventHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Workspace ユーザー向けの従来のハングアウトの場合は「eventNamedHangout」(非推奨。既存のイベントにはこの会議ソリューション タイプが表示される場合がありますが、新しい会議は作成できません)
- Google Meet の「hangoutsMeet」(http://meet.goog
conferenceData.createRequest.requestId: このリクエストに対してクライアントが生成した一意の ID。
クライアントは、新しいリクエストごとにこの ID を再生成する必要があります。指定された ID が前のリクエストと同じである場合、リクエストは無視されます。
conferenceData.createRequest.status.statusCode: 会議作成リクエストの現在のステータス。読み取り専用。可能な値は次のとおりです。
- 「保留中」: 会議作成リクエストはまだ処理中です。
- "success": 会議作成リクエストが成功し、エントリ ポイントが設定されます。
- 「失敗」: 会議作成リクエストが失敗しました。エントリ ポイントがありません。
conferenceData.entryPoints: URL や電話番号など、個々の会議のエントリ ポイントに関する情報。それらはすべて同じ会議に属している必要があります。ConferenceSolution と少なくとも 1 つのentryPoint、または createRequest のいずれかが必要です。
accessCode: 会議にアクセスするためのアクセス コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
entryPointFeatures: 有料か無料かなどのエントリ ポイントの機能。 1 つのエントリ ポイントに複数の機能を持たせることができます。ただし、有料と無料の両方を同じエントリ ポイントに設定することはできません。
entryPointType: 会議エントリポイントのタイプ。可能な値は次のとおりです。
- 「ビデオ」 - HTTP 経由で会議に参加します。会議には、0 または 1 つのビデオ エントリ ポイントを含めることができます。
- 「電話」 - 電話番号をダイヤルして会議に参加します。会議には、0 個以上の電話エントリ ポイントを含めることができます。
- 「sip」 - SIP 経由で会議に参加します。会議には 0 または 1 つの SIP エントリ ポイントを含めることができます。
- 「詳細」 - 追加の電話番号など、さらに詳しい会議参加手順。会議には、ゼロまたは 1 つ以上のエントリ ポイントを含めることができます。エントリ ポイントが 1 つだけ多い会議は有効な会議ではありません。
label: URIのラベル。エンドユーザーに表示されます。ローカライズされていません。最大長は 512 文字です。例:
- ビデオの場合: meets.google.com/aaa-bbbb-ccc
- 電話の場合: +1 123 268 2601
- SIP の場合: 12345678@altostrat.com
- 詳細: 記入しないでください オプション。
meetingCode: 会議にアクセスするための会議コード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
passcode: 会議にアクセスするためのパスコード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。
password: 会議にアクセスするためのパスワード。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
pin: 会議にアクセスするための PIN。最大長は 128 文字です。新しい会議データを作成するときは、会議プロバイダーが使用する用語に一致する {meetingCode、accessCode、passcode、password、pin} フィールドのサブセットのみを入力します。入力されたフィールドのみが表示されます。オプション。
regionCode: この電話アクセスに関連付けられている国の CLDR/ISO 3166 地域コード。例: スウェーデンの場合は「SE」。カレンダー バックエンドは、EntryPointType.PHONE に対してのみこのフィールドに値を入力します。
uri: エントリポイントのURI。最大長は 1300 文字です。形式:
- ビデオの場合、http: または https: スキーマが必要です。
- 電話の場合、tel: スキーマが必要です。 URI にはダイヤル シーケンス全体が含まれている必要があります (例: tel:+12345678900,,,123456789;1234)。
- sip の場合、sip: スキーマが必要です (例: sip:12345678@myprovider.com)。
- 詳細については、http: または https: スキーマが必要です。
conferenceData.notes: ユーザーに表示する追加のメモ (ドメイン管理者からの指示、法的通知など)。 HTMLを含めることができます。最大長は 2048 文字です。オプション。
conferenceData.parameters.addOnParameters.parameters.additionalProperties:
conferenceData.signature: 会議データの署名。サーバー側で生成されます。作成リクエストが失敗した会議の設定は解除されます。作成リクエストが保留中の会議の場合はオプションです。
created: イベントの作成時刻 (RFC3339 タイムスタンプとして)。読み取り専用。
creator.displayName: 可能な場合は作成者の名前。
creator.email: 作成者の電子メール アドレス (可能な場合)。
creator.id: 作成者のプロフィール ID (利用可能な場合)。
creator.self: 作成者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
description: イベントの説明。 HTMLを含めることができます。オプション。
end.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
end.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
end.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
endTimeUnspecified: 終了時刻が実際に未指定であるかどうか。この属性が True に設定されている場合でも、互換性の理由から終了時刻が提供されます。デフォルトは False です。
etag: リソースの ETag。
eventType: イベントの特定の種類。イベントの作成後にこれを変更することはできません。可能な値は次のとおりです。
- "default" - 定期的なイベント、または詳細は指定されていません。
- 「outOfOffice」 - 不在時のイベント。
- "focusTime" - フォーカス時間イベント。
- "workingLocation" - 作業場所イベント。
- 「fromGmail」 - Gmail からのイベント。このタイプのイベントは作成できません。
extendedProperties.private.additionalProperties: プライベート プロパティの名前と対応する値。
extendedProperties.shared.additionalProperties: 共有プロパティの名前と対応する値。
focusTimeProperties.autoDeclineMode: フォーカス タイム イベントと重なる会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。これは、フォーカス タイム イベントが存在する間に到着した、競合する新しい会議への招待のみが拒否されることを意味します。
focusTimeProperties.chatStatus: チャットおよび関連製品でユーザーをマークするステータス。これは利用可能であるか、または妨害しない可能性があります。
focusTimeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
gadget.display: ガジェットの表示モード。廃止されました。可能な値は次のとおりです。
- "アイコン" - ガジェットは、カレンダー ビューのイベントのタイトルの横に表示されます。
- "chip" - イベントをクリックするとガジェットが表示されます。
gadget.height: ガジェットの高さ (ピクセル単位)。高さは 0 より大きい整数である必要があります。オプション。廃止されました。
gadget.iconLink: ガジェットのアイコンの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.link: ガジェットの URL。 URL スキームは HTTPS である必要があります。廃止されました。
gadget.preferences.additionalProperties: 設定名と対応する値。
gadget.title: ガジェットのタイトル。廃止されました。
gadget.type: ガジェットのタイプ。廃止されました。
gadget.width: ガジェットの幅 (ピクセル単位)。幅は 0 より大きい整数である必要があります。オプションです。廃止されました。
guestsCanInviteOthers: 主催者以外の出席者が他の人をイベントに招待できるかどうか。オプション。デフォルトは True です。
guestsCanModify: 主催者以外の参加者がイベントを変更できるかどうか。オプション。デフォルトは False です。
guestsCanSeeOtherGuests: 主催者以外の参加者がイベントの参加者を確認できるかどうか。オプション。デフォルトは True です。
hangoutLink: このイベントに関連付けられた Google ハングアウトへの絶対リンク。読み取り専用。
htmlLink: Google カレンダー Web UI のこのイベントへの絶対リンク。読み取り専用。
iCalUID: RFC5545 で定義されているイベントの一意の識別子。これは、カレンダー システム全体でイベントを一意に識別するために使用され、インポート メソッドを介してイベントをインポートするときに指定する必要があります。iCalUID と ID は同一ではなく、イベント作成時にどちらか 1 つだけを指定する必要があることに注意してください。セマンティクスの 1 つの違いは、定期的なイベントでは、1 つのイベントのすべての発生が異なる ID を持ち、すべてが同じ iCalUID を共有することです。 iCalUID を使用してイベントを取得するには、iCalUID パラメーターを使用して events.list メソッドを呼び出します。 ID を使用してイベントを取得するには、events.get
id: イベントの不透明な識別子。新しい単一イベントまたは定期的なイベントを作成するときに、その ID を指定できます。提供される ID は次のルールに従う必要があります。
- ID で許可される文字は、base32hex エンコードで使用される文字、つまり小文字の a ~ v と数字 0 ~ 9 です。RFC2938 のセクション 3.1.2 を参照してください。
- ID の長さは 5 ~ 1024 文字である必要があります
- ID はカレンダーごとに一意である必要があります。システムはグローバルに分散しているため、イベント作成時に ID の衝突が検出されることは保証できません。衝突のリスクを最小限に抑えるために、RFC4122 で説明されているような確立された UUID アルゴリズム
kind: リソースのタイプ (「calendar#event」)。
location: 自由形式のテキストとしてのイベントの地理的位置。オプション。
locked: これが、メイン イベント フィールドの「概要」、「説明」、「場所」、「開始」、「終了」、または「繰り返し」に変更を加えることができないロックされたイベント コピーであるかどうか。デフォルトは False です。読み取り専用。
organizer.displayName: 可能な場合は主催者の名前。
organizer.email: 主催者の電子メール アドレス (可能な場合)。 RFC5322 に準拠した有効な電子メール アドレスである必要があります。
organizer.id: 主催者のプロフィール ID (利用可能な場合)。
organizer.self: 主催者が、このイベントのコピーが表示されるカレンダーに対応しているかどうか。読み取り専用。デフォルトは False です。
originalStartTime.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
originalStartTime.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
originalStartTime.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
outOfOfficeProperties.autoDeclineMode: 外出中のイベントと重複する会議への招待を拒否するかどうか。有効な値はdecendNoneです。これは、会議への招待が拒否されないことを意味します。 DecorAllConflictingInvitations。イベントと競合するすべての競合する会議への招待が拒否されることを意味します。および、declarOnlyNewConflictingInvitations。これは、不在時のイベントが存在する間に到着した、競合する新しい会議出席依頼のみが拒否されることを意味します。
outOfOfficeProperties.declineMessage: 既存のイベントまたは新しい招待がカレンダーによって自動的に拒否された場合に設定する応答メッセージ。
privateCopy: True に設定すると、イベントの伝播が無効になります。これはプライベート イベント プロパティと同じものではないことに注意してください。オプション。不変。デフォルトは False です。
recurrence: RFC5545 で指定されている、定期的なイベントの RRULE、EXRULE、RDATE、および EXDATE 行のリスト。このフィールドでは DTSTART 行と DTEND 行は許可されないことに注意してください。イベントの開始時刻と終了時刻は、開始フィールドと終了フィールドに指定されます。このフィールドは、単一のイベントまたは定期的なイベントのインスタンスでは省略されます。
recurringEventId: 定期的なイベントのインスタンスの場合、これは、このインスタンスが属する定期的なイベントの ID です。不変。
reminders.overrides: イベントでデフォルトのリマインダーが使用されていない場合、イベント固有のリマインダーが一覧表示されます。設定されていない場合は、このイベントにリマインダーが設定されていないことが示されます。上書きリマインダーの最大数は 5 です。
method: このリマインダーで使用されるメソッド。可能な値は次のとおりです。
- 「電子メール」 - リマインダーは電子メールで送信されます。
- 「ポップアップ」 - リマインダーは UI ポップアップ経由で送信されます。 リマインダーを追加する場合は必須です。
minutes: イベント開始の何分前にリマインダーをトリガーするかを指定します。有効な値は 0 ~ 40320 (4 週間分) です。リマインダーを追加する場合は必須です。
reminders.useDefault: カレンダーのデフォルトのリマインダーをイベントに適用するかどうか。
sequence: iCalendar によるシーケンス番号。
source.title: 情報源のタイトル。たとえば、Web ページのタイトルや電子メールの件名などです。
source.url: リソースを指すソースの URL。 URL スキームは HTTP または HTTPS である必要があります。
start.date: 終日イベントの場合は、「yyyy-mm-dd」形式の日付。
start.dateTime: 日付と時刻を組み合わせた値としての時刻 (RFC3339 に従ってフォーマット)。 timeZone でタイムゾーンが明示的に指定されていない限り、タイムゾーンオフセットが必要です。
start.timeZone: 時刻を指定するタイムゾーン。 (IANA タイム ゾーン データベース名としてフォーマットされます。例: 「ヨーロッパ/チューリッヒ」)。定期的なイベントの場合、このフィールドは必須であり、繰り返しが展開されるタイム ゾーンを指定します。単一イベントの場合、このフィールドはオプションであり、イベントの開始/終了のカスタム タイム ゾーンを示します。
status: イベントのステータス。オプション。可能な値は次のとおりです。
- 「確認済み」 - イベントが確認されました。これがデフォルトのステータスです。
- 「暫定」 - イベントは暫定的に確認されています。
- 「キャンセル」 - イベントはキャンセル(削除)されます。 list メソッドは、増分同期時 (syncToken または updatedMin が指定されている場合)、または showDeleted フラグが true に設定されている場合にのみ、キャンセルされたイベントを返します。 get メソッドは常にそれらを返します。キャンセルされたステータスは、イベント タイプに応じて 2 つの異なる状態を表します。
- キャンセルされていない定期的なイベントのキャンセルされた例外
summary: イベントのタイトル。
transparency: イベントがカレンダー上の時間をブロックするかどうか。オプション。可能な値は次のとおりです。
- 「不透明」 - デフォルト値。イベントはカレンダー上の時間をブロックします。これは、カレンダー UI で「予定あり」を表示するように設定するのと同じです。
- 「透明」 - イベントはカレンダー上の時間をブロックしません。これは、カレンダー UI で [表示] を [利用可能] に設定するのと同じです。
updated: メイン イベント データの最終変更時刻 (RFC3339 タイムスタンプとして)。イベントリマインダーを更新してもこれは変わりません。読み取り専用。
visibility: イベントの可視性。オプション。可能な値は次のとおりです。
- "default" - カレンダー上のイベントのデフォルトの表示設定を使用します。これがデフォルト値です。
- "public" - イベントは公開されており、イベントの詳細はカレンダーのすべての読者に表示されます。
- 「プライベート」 - イベントはプライベートであり、イベントの参加者のみがイベントの詳細を表示できます。
- 「機密」 - イベントは非公開です。この値は互換性の理由から提供されています。
workingLocationProperties.customLocation.label: 追加情報用のオプションの追加ラベル。
workingLocationProperties.homeOffice: 存在する場合、ユーザーが在宅勤務していることを指定します。
workingLocationProperties.officeLocation.buildingId: オプションの建物識別子。これは、組織のリソース データベース内の建物 ID を参照する必要があります。
workingLocationProperties.officeLocation.deskId: オプションのデスク識別子。
workingLocationProperties.officeLocation.floorId: オプションのフロア識別子。
workingLocationProperties.officeLocation.floorSectionId: オプションのフロアセクション識別子。
workingLocationProperties.officeLocation.label: カレンダー Web クライアントおよびモバイル クライアントに表示されるオフィス名。組織のリソース データベースで建物名を参照することをお勧めします。
workingLocationProperties.type: 勤務場所のタイプ。可能な値は次のとおりです。
- 「homeOffice」 - ユーザーは自宅で仕事をしています。
- "officeLocation" - ユーザーはオフィスで働いています。
- "customLocation" - ユーザーはカスタムの場所から作業しています。 詳細は指定された名前のサブフィールドに指定されますが、このフィールドが空の場合は欠落している可能性があります。他のフィールドは無視されます。作業場所のプロパティを追加する場合に必要です。
alwaysIncludeEmail: 非推奨となり無視されました。実際の電子メール アドレスが利用できない場合でも、主催者、作成者、および参加者の電子メール フィールドには常に値が返されます (つまり、生成された機能しない値が提供されます)。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
conferenceDataVersion: API クライアントがサポートする会議データのバージョン番号。バージョン 0 は会議データのサポートがないことを前提としており、イベント本文内の会議データを無視します。バージョン 1 では、ConferenceData のコピーと、conferenceData の createRequest フィールドを使用した新しい会議の作成のサポートが有効になります。デフォルトは 0 です。
eventId: イベント識別子。
maxAttendees: 応答に含める出席者の最大数。指定された数を超える参加者がいる場合は、参加者のみが返されます。オプション。
sendNotifications: 廃止されました。代わりにsendUpdatesを使用してください。
イベントの更新 (説明の変更など) に関する通知を送信するかどうか。値を false に設定した場合でも、一部の電子メールは送信される可能性があることに注意してください。デフォルトは false です。
sendUpdates: イベントの更新に関する通知を受け取る必要があるゲスト (タイトルの変更など)。
supportsAttachments: 操作を実行する API クライアントがイベントの添付ファイルをサポートするかどうか。オプション。デフォルトは False です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: update」 参照: https://developers.google.com/calendar/api/v3/reference/events/update
calendar_events_watch
イベント リソースへの変更を監視します。
パラメータ
address: このチャネルの通知が配信されるアドレス。
expiration: 通知チャネルの有効期限の日付と時刻。Unix タイムスタンプとしてミリ秒単位で表されます。オプション。
id: このチャネルを識別する UUID または同様の一意の文字列。
kind: これを、リソースへの変更を監視するために使用される通知チャネル (「api#channel」) として識別します。
params.additionalProperties: 新しいパラメータを名前で宣言します。
payload: ペイロードが必要かどうかを示すブール値。オプション。
resourceId: このチャネルで監視されているリソースを識別する不透明な ID。さまざまな API バージョンにわたって安定しています。
resourceUri: 監視対象リソースのバージョン固有の識別子。
token: このチャネル経由で配信される各通知とともにターゲット アドレスに配信される任意の文字列。オプション。
type: このチャネルに使用される配信メカニズムのタイプ。有効な値は「web_hook」(または「webhook」)です。どちらの値も、HTTP リクエストがメッセージの配信に使用されるチャネルを指します。
alwaysIncludeEmail: 非推奨となり無視されました。
calendarId: カレンダーの識別子。カレンダー ID を取得するには、calendarList.list メソッドを呼び出します。現在ログインしているユーザーのプライマリ カレンダーにアクセスする場合は、「primary」キーワードを使用します。
eventTypes: 返されるイベントのタイプ。オプション。このパラメーターを複数回繰り返して、さまざまなタイプのイベントを返すことができます。設定されていない場合は、すべてのイベント タイプを返します。
iCalUID: 応答で提供されるイベント ID を iCalendar 形式で指定します。オプション。 iCalendar ID でイベントを検索する場合は、これを使用します。
maxAttendees: 応答に含める出席者の最大数。指定された数を超える参加者がいる場合は、参加者のみが返されます。オプション。
maxResults: 1 つの結果ページで返されるイベントの最大数。クエリに一致するイベントがさらにある場合でも、結果のページ内のイベントの数はこの値より少ない場合や、まったくない場合があります。不完全なページは、応答内の空でない nextPageToken フィールドによって検出できます。デフォルトの値は 250 イベントです。ページ サイズは 2500 イベントを超えることはできません。オプション。
orderBy: 結果として返されるイベントの順序。オプション。デフォルトは、指定されていない安定した順序です。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
privateExtendedProperty: propertyName=value として指定された拡張プロパティ制約。プライベート プロパティのみに一致します。このパラメーターは、指定されたすべての制約に一致するイベントを返すために複数回繰り返される場合があります。
q: フリー テキストの検索用語を使用すると、次のフィールドでこれらの用語に一致するイベントを検索できます。
- まとめ
- 説明
- 位置
- 出席者の表示名
- 参加者のメールアドレス
- 主催者の表示名
- 主催者のメール
- workingLocationProperties.officeLocation.buildingId
- workingLocationProperties.officeLocation.deskId
- workingLocationProperties.officeLocation.label
- workingLocationProperties.customLocation.label
sharedExtendedProperty: propertyName=value として指定された拡張プロパティ制約。共有プロパティのみに一致します。このパラメーターは、指定されたすべての制約に一致するイベントを返すために複数回繰り返される場合があります。
showDeleted: 削除されたイベント (ステータスが「キャンセル」に等しい) を結果に含めるかどうか。 showDeleted と singleEvents が両方とも False の場合、定期的なイベントのキャンセルされたインスタンス (ただし、基礎となる定期的なイベントは含まれません) は引き続き含まれます。 showDeleted と singleEvents が両方とも True の場合、削除されたイベントの単一インスタンスのみが返されます (ただし、基礎となる定期的なイベントは返されません)。オプション。デフォルトは False です。
showHiddenInvitations: 非表示の招待状を結果に含めるかどうか。オプション。デフォルトは False です。
singleEvents: 定期的なイベントをインスタンスに拡張し、単一の 1 回限りのイベントと定期的なイベントのインスタンスのみを返しますが、基になる繰り返しイベント自体は返さないかどうか。オプション。デフォルトは False です。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。前回のリスト要求以降に削除されたすべてのイベントは常に結果セットに含まれるため、showDeleted を False に設定することはできません。クライアント状態の一貫性を確保するために nextSyncToken と一緒に指定できないクエリ パラメーターがいくつかあります。
- iCalUID
- 注文方法
- privateExtendedProperty
-q
- 共有拡張プロパティ
- 最小時間
- 最大時間
- updatedMin 未定義の動作を避けるために
timeMax: フィルタリングするイベントの開始時間の上限 (排他的)。オプション。デフォルトでは、開始時間によるフィルタリングは行われません。必須のタイム ゾーン オフセットを含む RFC3339 タイムスタンプである必要があります (例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定することもできますが、無視されます。 timeMin が設定されている場合、timeMax は timeMin より大きくなければなりません。
timeMin: フィルタリングするイベントの終了時間の下限 (排他的)。オプション。デフォルトでは、終了時間によるフィルタリングは行われません。必須のタイム ゾーン オフセットを含む RFC3339 タイムスタンプである必要があります (例: 2011-06-03T10:00:00-07:00、2011-06-03T10:00:00Z)。ミリ秒を指定することもできますが、無視されます。 timeMax が設定されている場合、timeMin は timeMax より小さくなければなりません。
timeZone: 応答で使用されるタイムゾーン。オプション。デフォルトはカレンダーのタイムゾーンです。
updatedMin: フィルターに使用するイベントの最終変更時刻 (RFC3339 タイムスタンプとして) の下限。指定すると、showDeleted に関係なく、今回以降に削除されたエントリが常に含まれます。オプション。デフォルトでは、最終変更時刻によるフィルタリングは行われません。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Events: watch」 参照: https://developers.google.com/calendar/api/v3/reference/events/watch
calendar_freebusy_query
一連のカレンダーの空き時間情報を返します。
パラメータ
calendarExpansionMax: FreeBusy 情報が提供されるカレンダーの最大数。オプション。最大値は 50 です。
groupExpansionMax: 単一グループに提供されるカレンダー識別子の最大数。オプション。この値を超えるメンバーがいるグループの場合、エラーが返されます。最大値は 100 です。
items: クエリするカレンダーおよび/またはグループのリスト。
id: カレンダーまたはグループの識別子。
timeMax: RFC3339 に従ってフォーマットされたクエリの間隔の終了。
timeMin: RFC3339 に従ってフォーマットされたクエリの間隔の開始。
timeZone: 応答で使用されるタイムゾーン。オプション。デフォルトは UTC です。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Freebusy: query」 参照: https://developers.google.com/calendar/api/v3/reference/freebusy/query
calendar_settings_get
単一のユーザー設定を返します。
パラメータ
setting: ユーザー設定の ID。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Settings: get」 参照: https://developers.google.com/calendar/api/v3/reference/settings/get
calendar_settings_list
認証されたユーザーのすべてのユーザー設定を返します。
パラメータ
maxResults: 1 つの結果ページで返されるエントリの最大数。デフォルトの値は 100 エントリです。ページ サイズは 250 エントリを超えることはできません。オプション。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。
syncToken の有効期限が切れると、サーバーは 410 GONE 応答コードで応答し、クライアントはストレージをクリアして、syncToken を使用せずに完全な同期を実行する必要があります。増分同期について詳しくは、こちらをご覧ください。オプション。デフォルトでは、すべてのエントリが返されます。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Settings: list」 参照: https://developers.google.com/calendar/api/v3/reference/settings/list
calendar_settings_watch
設定リソースへの変更を監視します。
パラメータ
address: このチャネルの通知が配信されるアドレス。
expiration: 通知チャネルの有効期限の日付と時刻。Unix タイムスタンプとしてミリ秒単位で表されます。オプション。
id: このチャネルを識別する UUID または同様の一意の文字列。
kind: これを、リソースへの変更を監視するために使用される通知チャネル (「api#channel」) として識別します。
params.additionalProperties: 新しいパラメータを名前で宣言します。
payload: ペイロードが必要かどうかを示すブール値。オプション。
resourceId: このチャネルで監視されているリソースを識別する不透明な ID。さまざまな API バージョンにわたって安定しています。
resourceUri: 監視対象リソースのバージョン固有の識別子。
token: このチャネル経由で配信される各通知とともにターゲット アドレスに配信される任意の文字列。オプション。
type: このチャネルに使用される配信メカニズムのタイプ。有効な値は「web_hook」(または「webhook」)です。どちらの値も、HTTP リクエストがメッセージの配信に使用されるチャネルを指します。
maxResults: 1 つの結果ページで返されるエントリの最大数。デフォルトの値は 100 エントリです。ページ サイズは 250 エントリを超えることはできません。オプション。
pageToken: どの結果ページを返すかを指定するトークン。オプション。
syncToken: 前のリスト要求の結果の最後のページで返された nextSyncToken フィールドから取得されたトークン。このリスト要求の結果には、それ以降に変更されたエントリのみが含まれるようになります。
syncToken の有効期限が切れると、サーバーは 410 GONE 応答コードで応答し、クライアントはストレージをクリアして、syncToken を使用せずに完全な同期を実行する必要があります。
増分同期について詳しくは、こちらをご覧ください。
オプション。デフォルトでは、すべてのエントリが返されます。
alt: レスポンスのデータ形式。
fields: 部分応答に含めるフィールドを指定するセレクター。
key: APIキー。 API キーはプロジェクトを識別し、API アクセス、割り当て、レポートを提供します。 OAuth 2.0 トークンを指定しない場合は必須です。
oauth_token: 現在のユーザーの OAuth 2.0 トークン。
prettyPrint: インデントと改行を含む応答を返します。
quotaUser: クォータ目的でユーザーを表す不透明な文字列。 40 文字を超えてはなりません。
userIp: 廃止されました。代わりにquotaUserを使用してください。
レスポンス
Google Calendar リファレンス 「Settings: watch」 参照: https://developers.google.com/calendar/api/v3/reference/settings/watch