CalendarList

The collection of calendars in the user's calendar list. See also Calendars vs CalendarList.ユーザーのカレンダーリスト内のカレンダーのコレクション。カレンダーvsカレンダーリストも参照してください。

For a list of methods for this resource, see the end of this page.このリソースのメソッドのリストについては、このページの終わりを参照してください。

Resource representationsリソース表現

{
  "kind": "calendar#calendarListEntry",
  "etag": etag,
  "id": string,
  "summary": string,
  "description": string,
  "location": string,
  "timeZone": string,
  "summaryOverride": string,
  "colorId": string,
  "backgroundColor": string,
  "foregroundColor": string,
  "hidden": boolean,
  "selected": boolean,
  "accessRole": string,
  "defaultReminders": [
    {
      "method": string,
      "minutes": integer
    }
  ],
  "notificationSettings": {
    "notifications": [
      {
        "type": string,
        "method": string
      }
    ]
  },
  "primary": boolean,
  "deleted": boolean,
  "conferenceProperties": {
    "allowedConferenceSolutionTypes": [
      string
    ]
  }
}
Property nameプロパティ名 Value値 Description説明 Notesノート
accessRole string The effective access role that the authenticated user has on the calendar. Read-only. Possible values are:
  • "freeBusyReader" - Provides read access to free/busy information." freeBusyReader" - 空き時間情報への読み取りアクセスを提供します。
  • "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden." reader" - カレンダーへの読み取りアクセスを提供します。非公開の予定は閲覧者アクセス権を持つユーザーに表示されますが、予定の詳細は非表示になります。
  • "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible." writer" - カレンダーへの読み書きアクセスを提供します。非公開のイベントは、書き込み権限を持つユーザーに表示され、イベントの詳細が表示されます。
  • "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs." owner" - カレンダーの所有権を提供します。この役割には、ACLを表示および操作するための追加機能を持つ、作成者役割のすべての許可があります。
backgroundColor string The main color of the calendar in the hexadecimal format "#0088aa". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.カレンダーのメインカラー（16進数形式 " #0088aa"）。このプロパティは、インデックスベースのプロパティよりも優先されcolorIdます。このプロパティを設定または変更するcolorRgbFormat=trueには、insert、update、およびpatchメソッドのパラメータで指定する必要があります。オプションです。 writable 書き込み可能
colorId string The color of the calendar. This is an ID referring to an entry in the calendar section of the colors definition (see the colors endpoint). This property is superseded by the backgroundColor and foregroundColor properties and can be ignored when using these properties. Optional.カレンダーの色 これはcalendar色の定義のセクションのエントリを参照するIDです（色の終点を参照）。このプロパティはbackgroundColorand foregroundColorプロパティに置き換えられており、これらのプロパティを使用する場合は無視できます。オプションです。 writable 書き込み可能
conferenceProperties nested object Conferencing properties for this calendar, for example what types of conferences are allowed.許可されている会議の種類など、このカレンダーの会議プロパティ。
conferenceProperties.allowedConferenceSolutionTypes[] list The types of conference solutions that are supported for this calendar.

The possible values are:

  • "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet" "eventHangout"
  • "eventNamedHangout"
  • "hangoutsMeet"
Optional.
defaultReminders[] list The default reminders that the authenticated user has for this calendar.認証済みユーザーがこのカレンダーに対して持っていることを示すデフォルトの通知。 writable 書き込み可能
defaultReminders[].method string The method used by this reminder. Possible values are:
  • "email" - Reminders are sent via email." email" - リマインダは電子メールで送信されます。
  • "sms" - Deprecated. Once this feature is shutdown, the API will no longer return reminders using this method. Any newly added SMS reminders will be ignored. See Google Calendar SMS notifications to be removed for more information.

    Reminders are sent via SMS. These are only available for G Suite customers. Requests to set SMS reminders for other account types are ignored.通知はSMS経由で送信されます。これらはG Suiteのお客様のみご利用いただけます。他の種類のアカウントにSMSリマインダーを設定する要求は無視されます。

  • "popup" - Reminders are sent via a UI popup." popup" - リマインダーはUIポップアップを介して送信されます。

Required when adding a reminder.アラームを追加するときに必要です。

 writable 書き込み可能
defaultReminders[].minutes integer Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes).

Required when adding a reminder.アラームを追加するときに必要です。

 writable 書き込み可能
deleted boolean Whether this calendar list entry has been deleted from the calendar list. Read-only. Optional. The default is False.このカレンダーリストエントリがカレンダーリストから削除されたかどうか。読み取り専用 オプションです。デフォルトはFalseです。
description string Description of the calendar. Optional. Read-only.カレンダーの説明 オプションです。読み取り専用
etag etag ETag of the resource.リソースのETag。
foregroundColor string The foreground color of the calendar in the hexadecimal format "#ffffff". This property supersedes the index-based colorId property. To set or change this property, you need to specify colorRgbFormat=true in the parameters of the insert, update and patch methods. Optional.カレンダーの前景色（16進数形式 " #ffffff"）。このプロパティは、インデックスベースのプロパティよりも優先されcolorIdます。このプロパティを設定または変更するcolorRgbFormat=trueには、insert、update、およびpatchメソッドのパラメータで指定する必要があります。オプションです。 writable 書き込み可能
hidden boolean Whether the calendar has been hidden from the list. Optional. The default is False.カレンダーがリストから隠されているかどうか。オプションです。デフォルトはFalseです。 writable 書き込み可能
id string Identifier of the calendar.カレンダーの識別子
kind string Type of the resource ("calendar#calendarListEntry").リソースの種類（ "calendar＃calendarListEntry"）。
location string Geographic location of the calendar as free-form text. Optional. Read-only.自由形式のテキストとしてのカレンダーの地理的位置。オプションです。読み取り専用
notificationSettings object The notifications that the authenticated user is receiving for this calendar.認証済みユーザーがこのカレンダーに関して受信している通知。 writable 書き込み可能
notificationSettings.notifications[] list The list of notifications set for this calendar.このカレンダーに設定されている通知のリスト。
notificationSettings.notifications[].method string The method used to deliver the notification. Possible values are:
  • "email" - Notifications are sent via email." email" - 通知はEメールで送信されます。
  • "sms" - Deprecated. Once this feature is shutdown, the API will no longer return notifications using this method. Any newly added SMS notifications will be ignored. See Google Calendar SMS notifications to be removed for more information.

    Notifications are sent via SMS. This value is read-only and is ignored on inserts and updates. SMS notifications are only available for G Suite customers.通知はSMS経由で送信されます。この値は読み取り専用であり、挿入および更新時には無視されます。SMS通知はG Suiteのお客様のみ利用可能です。

Required when adding a notification.通知を追加するときに必要です。

 writable 書き込み可能
notificationSettings.notifications[].type string The type of notification. Possible values are:
  • "eventCreation" - Notification sent when a new event is put on the calendar." eventCreation" - 新しい予定がカレンダーに追加されたときに通知が送信されます。
  • "eventChange" - Notification sent when an event is changed." eventChange" - イベントが変更されたときに送信される通知。
  • "eventCancellation" - Notification sent when an event is cancelled." eventCancellation" - イベントがキャンセルされたときに通知が送信されます。
  • "eventResponse" - Notification sent when an attendee responds to the event invitation." eventResponse" - 出席者がイベントの招待状に返信したときに送信される通知。
  • "agenda" - An agenda with the events of the day (sent out in the morning)." agenda" - 当日のイベントに関する議題（午前中に送信されます）。

Required when adding a notification.通知を追加するときに必要です。

 writable 書き込み可能
primary boolean Whether the calendar is the primary calendar of the authenticated user. Read-only. Optional. The default is False.カレンダーが認証されたユーザーの主要カレンダーかどうか。読み取り専用 オプションです。デフォルトはFalseです。
selected boolean Whether the calendar content shows up in the calendar UI. Optional. The default is False.カレンダーのコンテンツがカレンダーのUIに表示されるかどうか。オプションです。デフォルトはFalseです。 writable 書き込み可能
summary string Title of the calendar. Read-only.カレンダーのタイトル 読み取り専用
summaryOverride string The summary that the authenticated user has set for this calendar. Optional.認証済みユーザーがこのカレンダーに設定した要約。オプションです。 writable 書き込み可能
timeZone string The time zone of the calendar. Optional. Read-only.カレンダーのタイムゾーン。オプションです。読み取り専用

Methods方法

delete削除する
Removes a calendar from the user's calendar list.ユーザーのカレンダーリストからカレンダーを削除します。
get取得する
Returns a calendar from the user's calendar list.ユーザーのカレンダーリストからカレンダーを返します。
insertインサート
Inserts an existing calendar into the user's calendar list.既存のカレンダーをユーザーのカレンダーリストに挿入します。
listリスト
Returns the calendars on the user's calendar list.ユーザーのカレンダーリストにあるカレンダーを返します。
patchパッチ
Updates an existing calendar on the user's calendar list. This method supports patch semantics.ユーザーのカレンダーリストにある既存のカレンダーを更新します。このメソッドはパッチのセマンティクスをサポートしています。
update更新
Updates an existing calendar on the user's calendar list.ユーザーのカレンダーリストにある既存のカレンダーを更新します。
watch時計
Watch for changes to CalendarList resources.CalendarListリソースへの変更を監視します。

関連記事

スポンサーリンク

Line - 線を描画する

ホームページ製作・web系アプリ系の製作案件募集中です。

上に戻る