Events

API Lịch cung cấp nhiều phiên bản tài nguyên sự kiện. Bạn có thể xem thêm thông tin trong bài viết Giới thiệu về sự kiện.

Để biết danh sách các phương thức cho tài nguyên này, hãy xem ở cuối trang.

Biểu diễn tài nguyên

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "eventType": string
}
Tên tài sản Giá trị Mô tả Ghi chú
anyoneCanAddSelf boolean Liệu bất kỳ ai cũng có thể tự mời mình tham gia sự kiện hay không (không dùng nữa). Không bắt buộc. Giá trị mặc định là False. có thể ghi
attachments[] list Tệp đính kèm cho sự kiện.

Để sửa đổi tệp đính kèm, bạn phải đặt tham số yêu cầu supportsAttachments thành true.

Bạn có thể có tối đa 25 tệp đính kèm cho mỗi sự kiện,
attachments[].fileId string Mã của tệp đính kèm. Chỉ có thể đọc.

Đối với các tệp trên Google Drive, đây là mã nhận dạng của mục nhập tài nguyên Files tương ứng trong API Drive.
attachments[].fileUrl string Đường liên kết URL đến tệp đính kèm.

Để thêm tệp đính kèm trên Google Drive, hãy sử dụng định dạng giống như trong thuộc tính alternateLink của tài nguyên Files trong API Drive.

Bắt buộc khi thêm tệp đính kèm.

 có thể ghi
attachments[].mimeType string Loại phương tiện Internet (loại MIME) của tệp đính kèm.
attachments[].title string Tiêu đề tệp đính kèm.
attendeesOmitted boolean Liệu người tham dự có bị bỏ qua khỏi nội dung trình bày sự kiện hay không. Khi truy xuất một sự kiện, điều này có thể là do hạn chế được chỉ định bởi tham số truy vấn maxAttendee. Khi cập nhật một sự kiện, bạn chỉ có thể dùng tính năng này để cập nhật câu trả lời của người tham gia. Không bắt buộc. Giá trị mặc định là False. có thể ghi
attendees[] list Những người tham dự sự kiện. Xem hướng dẫn Sự kiện với người tham dự để biết thêm thông tin về cách lên lịch sự kiện với những người dùng lịch khác. Các tài khoản dịch vụ cần sử dụng tính năng uỷ quyền trên toàn miền để điền danh sách người tham dự. có thể ghi
attendees[].additionalGuests integer Số lượng khách bổ sung. Không bắt buộc. Giá trị mặc định là 0. có thể ghi
attendees[].comment string Nhận xét của người tham dự về phản hồi của họ. Không bắt buộc. có thể ghi
attendees[].displayName string Tên của người tham dự, nếu có. Không bắt buộc. có thể ghi
attendees[].email string Địa chỉ email của người tham dự (nếu có). Trường này phải xuất hiện khi thêm người tham dự. Đó phải là một địa chỉ email hợp lệ theo RFC5322.

Bắt buộc khi thêm một người tham dự.

 có thể ghi
attendees[].id string Mã hồ sơ của người tham dự, nếu có.
attendees[].optional boolean Đây có phải là người tham dự không bắt buộc hay không. Không bắt buộc. Giá trị mặc định là False. có thể ghi
attendees[].organizer boolean Người tham dự có phải là người tổ chức sự kiện hay không. Chỉ có thể đọc. Giá trị mặc định là False.
attendees[].resource boolean Liệu người tham dự có phải là một tài nguyên hay không. Chỉ có thể đặt khi người tham dự được thêm vào sự kiện lần đầu tiên. Các nội dung sửa đổi tiếp theo sẽ bị bỏ qua. Không bắt buộc. Giá trị mặc định là False. writable
attendees[].responseStatus string Trạng thái phản hồi của người tham dự. Các giá trị có thể có là:
  • "needsAction" – Người tham dự chưa trả lời thư mời (được đề xuất cho các sự kiện mới).
  • "declined" – Người tham dự đã từ chối lời mời.
  • "tentative" – Người tham dự đã tạm thời chấp nhận lời mời.
  • "accepted" – Người tham dự đã chấp nhận lời mời.
 có thể ghi
attendees[].self boolean Mục nhập này có đại diện cho lịch xuất hiện bản sao sự kiện này hay không. Chỉ có thể đọc. Giá trị mặc định là False.
colorId string Màu của sự kiện. Đây là mã nhận dạng tham chiếu đến một mục trong phần event của định nghĩa màu (xem điểm cuối màu). Không bắt buộc. có thể ghi
conferenceData nested object Thông tin liên quan đến hội nghị truyền hình, chẳng hạn như thông tin chi tiết về một hội nghị truyền hình trên Google Meet. Để tạo thông tin chi tiết mới về hội nghị truyền hình, hãy sử dụng trường createRequest. Để duy trì các thay đổi, hãy nhớ đặt tham số yêu cầu conferenceDataVersion thành 1 cho tất cả các yêu cầu sửa đổi sự kiện. có thể ghi
conferenceData.conferenceId string Mã của hội nghị truyền hình.

Có thể dùng cho nhà phát triển để theo dõi hội nghị và không được hiển thị cho người dùng.

Giá trị mã nhận dạng được tạo theo cách khác nhau đối với từng loại giải pháp hội nghị truyền hình:

  • eventHangout: Bạn chưa đặt mã nhận dạng. (Loại hội nghị này không được dùng nữa.)
  • eventNamedHangout: ID là tên của Hangout. (Loại hội nghị này không được dùng nữa.)
  • hangoutsMeet: Mã nhận dạng là mã cuộc họp gồm 10 chữ cái, ví dụ như aaa-bbbb-ccc.
  • addOn: Mã nhận dạng do nhà cung cấp bên thứ ba xác định.
Không bắt buộc.
conferenceData.conferenceSolution nested object Giải pháp hội nghị, chẳng hạn như Google Meet.

Không đặt cho hội nghị có yêu cầu tạo không thành công.

Bạn phải nhập conferenceSolution và ít nhất một entryPoint hoặc createRequest.
conferenceData.conferenceSolution.iconUri string Biểu tượng mà người dùng nhìn thấy cho giải pháp này.
conferenceData.conferenceSolution.key nested object Khoá có thể xác định riêng biệt giải pháp hội nghị cho sự kiện này.
conferenceData.conferenceSolution.key.type string Loại giải pháp hội nghị truyền hình.

Nếu ứng dụng gặp một kiểu không quen thuộc hoặc trống, thì ứng dụng vẫn có thể hiển thị điểm truy cập. Tuy nhiên, thao tác này sẽ không cho phép sửa đổi.

Các giá trị có thể có là:

  • "eventHangout" dành cho Hangouts dành cho người tiêu dùng (không dùng nữa; các sự kiện hiện có có thể hiển thị loại giải pháp hội nghị truyền hình này nhưng không thể tạo hội nghị mới)
  • "eventNamedHangout" dành cho người dùng Hangouts phiên bản cũ của Google Workspace (không dùng nữa; các sự kiện hiện có có thể hiển thị loại giải pháp hội nghị này nhưng không thể tạo hội nghị mới)
  • "hangoutsMeet" dành cho Google Meet (http://meet.google.com)
  • "addOn" dành cho nhà cung cấp dịch vụ hội nghị truyền hình bên thứ ba

conferenceData.conferenceSolution.name string Tên hiển thị cho người dùng của giải pháp này. Chưa được bản địa hoá.
conferenceData.createRequest nested object Yêu cầu tạo một hội nghị mới và đính kèm vào sự kiện. Dữ liệu này được tạo không đồng bộ. Để xem dữ liệu có hiện diện hay không, hãy kiểm tra trường status.

Bạn phải nhập conferenceSolution và ít nhất một entryPoint hoặc createRequest.
conferenceData.createRequest.conferenceSolutionKey nested object Giải pháp hội nghị, chẳng hạn như Hangouts hoặc Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Loại giải pháp hội nghị truyền hình.

Nếu ứng dụng gặp một kiểu không quen thuộc hoặc trống, thì ứng dụng vẫn có thể hiển thị điểm truy cập. Tuy nhiên, thao tác này sẽ không cho phép sửa đổi.

Các giá trị có thể có là:

  • "eventHangout" dành cho Hangouts dành cho người tiêu dùng (không dùng nữa; các sự kiện hiện có có thể hiển thị loại giải pháp hội nghị truyền hình này nhưng không thể tạo hội nghị mới)
  • "eventNamedHangout" dành cho người dùng Hangouts phiên bản cũ của Google Workspace (không dùng nữa; các sự kiện hiện có có thể hiển thị loại giải pháp hội nghị này nhưng không thể tạo hội nghị mới)
  • "hangoutsMeet" dành cho Google Meet (http://meet.google.com)
  • "addOn" cho nhà cung cấp hội nghị bên thứ ba

conferenceData.createRequest.requestId string Mã nhận dạng duy nhất do ứng dụng tạo cho yêu cầu này.

Ứng dụng khách phải tạo lại mã này cho mỗi yêu cầu mới. Nếu mã nhận dạng được cung cấp giống với mã của yêu cầu trước đó, thì yêu cầu đó sẽ bị bỏ qua.
conferenceData.createRequest.status nested object Trạng thái của yêu cầu tạo hội nghị truyền hình.
conferenceData.createRequest.status.statusCode string Trạng thái hiện tại của yêu cầu tạo hội nghị truyền hình. Chỉ có thể đọc.

Các giá trị có thể có là:

  • "pending": yêu cầu tạo hội nghị truyền hình vẫn đang được xử lý.
  • "success": yêu cầu tạo hội nghị truyền hình đã thành công, các điểm truy cập đã được điền sẵn.
  • "failure": yêu cầu tạo hội nghị truyền hình không thành công, không có điểm truy cập nào.

conferenceData.entryPoints[] list Thông tin về các điểm truy cập riêng lẻ của hội nghị, chẳng hạn như URL hoặc số điện thoại.

Tất cả các hội nghị đó phải thuộc cùng một hội nghị.

Bạn phải nhập conferenceSolution và ít nhất một entryPoint hoặc createRequest.
conferenceData.entryPoints[].accessCode string Mã truy cập để truy cập vào hội nghị truyền hình. Độ dài tối đa là 128 ký tự.

Khi tạo dữ liệu hội nghị truyền hình mới, chỉ điền tập hợp con các trường {meetingCode, accessCode, passcode, password, pin} khớp với thuật ngữ mà nhà cung cấp dịch vụ hội nghị truyền hình sử dụng. Chỉ hiển thị các trường đã điền sẵn.

Không bắt buộc.
conferenceData.entryPoints[].entryPointType string Loại điểm truy cập hội nghị truyền hình.

Các giá trị có thể là:

  • "video" – tham gia một hội nghị qua HTTP. Một hội nghị có thể không có hoặc có một điểm truy cập video.
  • "phone" – tham gia một hội nghị bằng cách quay một số điện thoại. Một hội nghị có thể không có hoặc có nhiều điểm truy cập phone.
  • "sip" – tham gia một hội nghị qua SIP. Một hội nghị có thể không có hoặc có một điểm truy cập sip.
  • "more" - hướng dẫn tham gia hội nghị khác, ví dụ như số điện thoại bổ sung. Một hội nghị có thể không có hoặc có một điểm truy cập more. Hội nghị chỉ có điểm truy cập more không phải là hội nghị hợp lệ.

conferenceData.entryPoints[].label string Nhãn cho URI. Người dùng cuối có thể nhìn thấy tên này. Chưa bản địa hoá. Độ dài tối đa là 512 ký tự.

Ví dụ:

  • cho video: meet.google.com/aaa-bbbb-policy
  • cho phone: +1 123 268 2601
  • cho sip: 12345678@altostrat.com
  • cho more: không nên điền

Không bắt buộc.
conferenceData.entryPoints[].meetingCode string Mã cuộc họp để truy cập vào hội nghị truyền hình này. Độ dài tối đa là 128 ký tự.

Khi tạo dữ liệu hội nghị truyền hình mới, chỉ điền tập hợp con các trường {meetingCode, accessCode, passcode, password, pin} khớp với thuật ngữ mà nhà cung cấp dịch vụ hội nghị truyền hình sử dụng. Chỉ hiển thị các trường đã điền sẵn.

Không bắt buộc.
conferenceData.entryPoints[].passcode string Mật mã để truy cập hội nghị truyền hình. Độ dài tối đa là 128 ký tự.

Khi tạo dữ liệu hội nghị truyền hình mới, chỉ điền tập hợp con các trường {meetingCode, accessCode, passcode, password, pin} khớp với thuật ngữ mà nhà cung cấp dịch vụ hội nghị truyền hình sử dụng. Chỉ hiển thị các trường đã điền sẵn.
conferenceData.entryPoints[].password string Mật khẩu để truy cập hội nghị truyền hình. Độ dài tối đa là 128 ký tự.

Khi tạo dữ liệu hội nghị truyền hình mới, chỉ điền tập hợp con các trường {meetingCode, accessCode, passcode, password, pin} khớp với thuật ngữ mà nhà cung cấp dịch vụ hội nghị truyền hình sử dụng. Chỉ hiển thị các trường đã điền sẵn.

Không bắt buộc.
conferenceData.entryPoints[].pin string Mã PIN để truy cập hội nghị truyền hình. Độ dài tối đa là 128 ký tự.

Khi tạo dữ liệu hội nghị truyền hình mới, chỉ điền tập hợp con các trường {meetingCode, accessCode, passcode, password, pin} khớp với thuật ngữ mà nhà cung cấp dịch vụ hội nghị truyền hình sử dụng. Chỉ hiển thị các trường đã điền sẵn.

Không bắt buộc.
conferenceData.entryPoints[].uri string URI của điểm truy cập. Độ dài tối đa là 1300 ký tự.

Định dạng:

  • cho giản đồ video, http: hoặc https:.
  • cho phone, giản đồ tel: là bắt buộc. URI phải bao gồm toàn bộ chuỗi quay số (ví dụ: tel:+12345678900,,,123456789;1234).
  • đối với sip, giản đồ sip: là bắt buộc, ví dụ: sip:12345678@myprovider.com.
  • cho giản đồ more, http: hoặc https:.

conferenceData.notes string Ghi chú bổ sung (chẳng hạn như hướng dẫn của quản trị viên miền, thông báo pháp lý) sẽ hiển thị cho người dùng. Có thể chứa HTML. Độ dài tối đa là 2048 ký tự. Không bắt buộc.
conferenceData.signature string Chữ ký của dữ liệu hội nghị truyền hình.

Được tạo ở phía máy chủ.

Chưa đặt cho một hội nghị có yêu cầu tạo không thành công.

Không bắt buộc đối với hội nghị có yêu cầu tạo đang chờ xử lý.
created datetime Thời gian tạo sự kiện (dưới dạng dấu thời gian RFC3339). Chỉ có thể đọc.
creator object Người tạo sự kiện. Chỉ có thể đọc.
creator.displayName string Tên của nhà sáng tạo (nếu có).
creator.email string Địa chỉ email của nhà sáng tạo (nếu có).
creator.id string Mã hồ sơ của nhà sáng tạo, nếu có.
creator.self boolean Liệu người tạo có tương ứng với lịch xuất hiện bản sao sự kiện này hay không. Chỉ có thể đọc. Giá trị mặc định là False.
description string Mô tả về sự kiện. Có thể chứa HTML. Không bắt buộc. có thể ghi
end nested object Thời gian kết thúc (loại trừ) của sự kiện. Đối với một sự kiện định kỳ, đây là thời gian kết thúc của lần diễn ra đầu tiên.
end.date date Ngày, ở định dạng "yyyy-mm-dd", nếu đây là sự kiện cả ngày. có thể ghi
end.dateTime datetime Thời gian, dưới dạng một giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bắt buộc phải có chênh lệch múi giờ trừ phi múi giờ được chỉ định rõ ràng trong timeZone. có thể ghi
end.timeZone string Múi giờ mà giờ được chỉ định. (Định dạng thành tên của Cơ sở dữ liệu múi giờ IANA, ví dụ: "Châu Âu/Zurich".) Đối với các sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện lặp lại được mở rộng. Đối với các sự kiện đơn lẻ, trường này là không bắt buộc và biểu thị múi giờ tùy chỉnh cho thời điểm bắt đầu/kết thúc sự kiện. writable
endTimeUnspecified boolean Liệu thời gian kết thúc có thực sự được xác định hay không. Thời gian kết thúc vẫn được cung cấp vì lý do tương thích, ngay cả khi thuộc tính này được đặt thành True. Giá trị mặc định là False.
etag etag ETag của tài nguyên.
eventType string Loại sự kiện cụ thể. Bạn không thể sửa đổi chế độ này sau khi tạo sự kiện. Các giá trị có thể có là:
  • "birthday" – Một sự kiện đặc biệt diễn ra cả ngày, lặp lại hằng năm.
  • "default" – Một sự kiện thông thường hoặc không được chỉ định thêm.
  • "focusTime" – Một sự kiện thời gian cần tập trung.
  • "fromGmail" – Một sự kiện từ Gmail. Không thể tạo loại sự kiện này.
  • "outOfOffice" – Một sự kiện không có mặt tại văn phòng.
  • "workingLocation" – Một sự kiện tại địa điểm làm việc.
 writable
extendedProperties object Thuộc tính mở rộng của sự kiện.
extendedProperties.private object Các thuộc tính riêng tư đối với bản sao của sự kiện xuất hiện trên lịch này. có thể ghi
extendedProperties.private.(key) string Tên của khu vực tư nhân và giá trị tương ứng.
extendedProperties.shared object Những thuộc tính được chia sẻ giữa các bản sao của sự kiện trên trang của những người tham dự khác lịch. writable
extendedProperties.shared.(key) string Tên của thuộc tính dùng chung và giá trị tương ứng.
focusTimeProperties nested object Dữ liệu sự kiện trong Thời gian cần tập trung. Được dùng nếu eventType là focusTime. có thể ghi
focusTimeProperties.autoDeclineMode string Liệu có từ chối lời mời họp chồng chéo với sự kiện Thời gian cần tập trung hay không. Các giá trị hợp lệ là declineNone, có nghĩa là không từ chối lời mời họp nào; declineAllConflictingInvitations, có nghĩa là từ chối tất cả lời mời họp xung đột với sự kiện; và declineOnlyNewConflictingInvitations, có nghĩa là chỉ từ chối lời mời họp xung đột mới đến trong khi sự kiện Thời gian cần tập trung đang diễn ra.
focusTimeProperties.chatStatus string Trạng thái để đánh dấu người dùng trong Chat và các sản phẩm có liên quan. Đó có thể là available hoặc doNotDisturb.
focusTimeProperties.declineMessage string Tin nhắn phản hồi để thiết lập nếu sự kiện hiện có hoặc lời mời mới bị Lịch tự động từ chối.
gadget object Tiện ích mở rộng sự kiện này. Các tiện ích không được dùng nữa; thay vào đó, cấu trúc này chỉ được dùng để trả về siêu dữ liệu lịch sinh nhật.
gadget.display string Chế độ hiển thị của tiện ích. Không dùng nữa. Các giá trị có thể có là:
  • "icon" - Tiện ích này hiển thị bên cạnh tiêu đề sự kiện trong chế độ xem lịch.
  • "chip" - Tiện ích này hiển thị khi sự kiện được nhấp vào.
 có thể ghi
gadget.height integer Chiều cao của tiện ích tính bằng pixel. Chiều cao phải là số nguyên lớn hơn 0. Không bắt buộc. Không dùng nữa. writable
gadget.preferences object Tùy chọn. có thể ghi
gadget.preferences.(key) string Tên lựa chọn ưu tiên và giá trị tương ứng.
gadget.title string Tiêu đề của tiện ích. Không dùng nữa. có thể ghi
gadget.type string Loại tiện ích. Không dùng nữa. có thể ghi
gadget.width integer Chiều rộng của tiện ích tính bằng pixel. Chiều rộng phải là một số nguyên lớn hơn 0. Không bắt buộc. Không dùng nữa. có thể ghi
guestsCanInviteOthers boolean Liệu người tham dự không phải người tổ chức có thể mời người khác tham gia sự kiện hay không. Không bắt buộc. Giá trị mặc định là "True". có thể ghi
guestsCanModify boolean Liệu người tham dự không phải người tổ chức có thể sửa đổi sự kiện hay không. Không bắt buộc. Giá trị mặc định là False. có thể ghi
guestsCanSeeOtherGuests boolean Liệu người tham dự không phải là người tổ chức có thể biết người tham dự sự kiện là ai không. Không bắt buộc. Giá trị mặc định là "True". có thể ghi
iCalUID string Giá trị nhận dạng duy nhất của sự kiện như định nghĩa trong RFC5545. Mã này được dùng để xác định riêng biệt các sự kiện trên nhiều hệ thống lịch và phải được cung cấp khi nhập sự kiện qua phương thức import.

Xin lưu ý rằng iCalUID và id không giống nhau và chỉ được cung cấp một trong hai thuộc tính này tại thời điểm tạo sự kiện. Có một điểm khác biệt về ngữ nghĩa là trong các sự kiện định kỳ, tất cả những lần xuất hiện của một sự kiện đều có id khác nhau nhưng tất cả đều có cùng iCalUID. Để truy xuất một sự kiện bằng iCalUID, hãy gọi phương thức events.list bằng cách sử dụng tham số iCalUID. Để truy xuất một sự kiện bằng id, hãy gọi phương thức events.get.
id string Giá trị nhận dạng mờ của sự kiện. Khi tạo sự kiện đơn lẻ hoặc định kỳ mới, bạn có thể chỉ định mã của các sự kiện đó. Giấy tờ tuỳ thân được cung cấp phải tuân theo các quy tắc sau:
  • ký tự được phép sử dụng trong mã nhận dạng là những ký tự dùng trong bộ mã hoá base32hex, tức là chữ cái a-v viết thường và các chữ số 0-9. Vui lòng xem mục 3.1.2 trong RFC2938
  • độ dài của mã nhận dạng phải nằm trong khoảng từ 5 đến 1024 ký tự
  • mã nhận dạng phải là duy nhất cho mỗi lịch
Do tính chất được phân phối trên toàn cầu của hệ thống, chúng tôi không thể đảm bảo sẽ phát hiện được các xung đột của mã nhận dạng tại thời điểm tạo sự kiện. Để giảm thiểu nguy cơ xung đột, bạn nên sử dụng thuật toán UUID đã được thiết lập, chẳng hạn như thuật toán được mô tả trong RFC4122.

Nếu bạn không chỉ định mã nhận dạng, mã này sẽ do máy chủ tạo tự động.

Xin lưu ý rằng icalUID và id không giống nhau và chỉ được cung cấp một trong hai thuộc tính này tại thời điểm tạo sự kiện. Có một điểm khác biệt về ngữ nghĩa là trong các sự kiện định kỳ, tất cả những lần xuất hiện của một sự kiện đều có id khác nhau nhưng tất cả đều có cùng icalUID.

 có thể ghi
kind string Loại tài nguyên ("calendar#event").
location string Vị trí địa lý của sự kiện dưới dạng văn bản tự do. Không bắt buộc. có thể ghi
locked boolean Liệu đây có phải là bản sao sự kiện bị khoá hay không mà không thể thay đổi các trường sự kiện chính "summary", "description", "location", "start", "end" hoặc "Lặp lại". Giá trị mặc định là False. Chỉ có thể đọc.
organizer object Người tổ chức sự kiện. Nếu người tổ chức cũng là một người tham dự, thì điều này sẽ được thể hiện bằng một mục riêng trong attendees, trong đó trường organizer được đặt thành True. Để thay đổi người tổ chức, hãy sử dụng thao tác di chuyển. Chỉ có thể đọc, trừ phi nhập một sự kiện. có thể ghi
organizer.displayName string Tên của người tổ chức, nếu có. có thể ghi
organizer.email string Địa chỉ email của người tổ chức, nếu có. Đây phải là địa chỉ email hợp lệ theo RFC5322. có thể ghi
organizer.id string Mã hồ sơ của người tổ chức, nếu có.
organizer.self boolean Người tổ chức có tương ứng với lịch xuất hiện bản sao sự kiện này hay không. Chỉ có thể đọc. Giá trị mặc định là False.
originalStartTime nested object Đối với một sự kiện định kỳ, đây là thời điểm mà sự kiện này sẽ bắt đầu, tính theo dữ liệu lặp lại trong sự kiện định kỳ được xác định bằng hàm navigationEventId. Thuộc tính này xác định duy nhất một trường hợp trong chuỗi sự kiện định kỳ ngay cả khi phiên bản đó được chuyển sang một thời điểm khác. Không thể thay đổi.
originalStartTime.date date Ngày, ở định dạng "yyyy-mm-dd", nếu đây là sự kiện cả ngày. có thể ghi
originalStartTime.dateTime datetime Thời gian, dưới dạng một giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bắt buộc phải có chênh lệch múi giờ trừ phi múi giờ được chỉ định rõ ràng trong timeZone. có thể ghi
originalStartTime.timeZone string Múi giờ mà giờ được chỉ định. (Định dạng thành tên của Cơ sở dữ liệu múi giờ IANA, ví dụ: "Châu Âu/Zurich".) Đối với các sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện lặp lại được mở rộng. Đối với các sự kiện đơn lẻ, trường này là không bắt buộc và biểu thị múi giờ tùy chỉnh cho thời điểm bắt đầu/kết thúc sự kiện. có thể ghi
outOfOfficeProperties nested object Dữ liệu sự kiện không có mặt tại văn phòng. Được dùng nếu eventType là outOfOffice. có thể ghi
outOfOfficeProperties.autoDeclineMode string Liệu có từ chối lời mời họp chồng chéo với sự kiện Không có mặt tại văn phòng hay không. Giá trị hợp lệ là declineNone, nghĩa là không có lời mời họp nào bị từ chối; declineAllConflictingInvitations, nghĩa là tất cả lời mời họp xung đột và xung đột với sự kiện đều bị từ chối; và declineOnlyNewConflictingInvitations, nghĩa là chỉ những lời mời họp xung đột mới được gửi đến khi có sự kiện Không có mặt tại văn phòng mới bị từ chối.
outOfOfficeProperties.declineMessage string Tin nhắn phản hồi để thiết lập nếu sự kiện hiện có hoặc lời mời mới bị Lịch tự động từ chối.
privateCopy boolean Nếu bạn đặt chính sách này thành True, thì tính năng Truyền tải sự kiện sẽ bị tắt. Xin lưu ý rằng đây không phải là Tài sản sự kiện riêng tư. Không bắt buộc. Không thể thay đổi. Giá trị mặc định là False.
recurrence[] list Danh sách các dòng RQU, EXRules, RDATE và EXDATE cho một sự kiện định kỳ, như được chỉ định trong RFC5545. Lưu ý rằng các đường DTSTART và DTEND không được phép trong trường này; thời gian bắt đầu và kết thúc của sự kiện được chỉ định trong trường start và end. Trường này bị bỏ qua đối với các sự kiện đơn lẻ hoặc lần diễn ra sự kiện định kỳ. có thể ghi
recurringEventId string Đối với một sự kiện định kỳ, đây là id của sự kiện định kỳ có chứa thực thể này. Không thể thay đổi.
reminders object Thông tin về lời nhắc của sự kiện đối với người dùng đã xác thực. Xin lưu ý rằng việc thay đổi lời nhắc cũng không làm thay đổi thuộc tính updated của sự kiện bao gồm.
reminders.overrides[] list Nếu sự kiện không sử dụng lời nhắc mặc định, tuỳ chọn này sẽ liệt kê các lời nhắc dành riêng cho sự kiện hoặc nếu không được đặt, cho biết rằng chưa có lời nhắc nào được đặt cho sự kiện này. Số lượng lời nhắc ghi đè tối đa là 5. có thể ghi
reminders.overrides[].method string Phương thức mà lời nhắc này sử dụng. Các giá trị có thể có là:
  • "email" – Lời nhắc được gửi qua email.
  • "popup" – Lời nhắc được gửi qua cửa sổ bật lên trên giao diện người dùng.

Bắt buộc khi thêm lời nhắc.

 có thể ghi
reminders.overrides[].minutes integer Số phút trước khi bắt đầu sự kiện mà lời nhắc sẽ kích hoạt. Các giá trị hợp lệ nằm trong khoảng từ 0 đến 40320 (4 tuần tính bằng phút).

Bắt buộc khi thêm lời nhắc.

 có thể ghi
reminders.useDefault boolean Liệu lời nhắc mặc định của lịch có áp dụng cho sự kiện hay không. có thể ghi
sequence integer Số thứ tự theo iLịch. writable
source object Nguồn mà sự kiện được tạo. Ví dụ: trang web, nội dung email hoặc bất kỳ tài liệu nào có thể nhận dạng bởi URL có giao thức HTTP hoặc HTTPS. Chỉ người tạo sự kiện mới có thể xem hoặc sửa đổi.
source.title string Tiêu đề của nguồn tin; ví dụ như tiêu đề của một trang web hoặc chủ đề email. có thể ghi
source.url string URL của nguồn trỏ đến một tài nguyên. Lược đồ URL phải là HTTP hoặc HTTPS. có thể ghi
start nested object Thời gian bắt đầu (bao gồm) sự kiện. Đối với một sự kiện định kỳ, đây là thời gian bắt đầu sự kiện đầu tiên.
start.date date Ngày, ở định dạng "yyyy-mm-dd", nếu đây là sự kiện cả ngày. có thể ghi
start.dateTime datetime Thời gian, dưới dạng một giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bắt buộc phải có chênh lệch múi giờ trừ phi múi giờ được chỉ định rõ ràng trong timeZone. có thể ghi
start.timeZone string Múi giờ mà giờ được chỉ định. (Định dạng thành tên của Cơ sở dữ liệu múi giờ IANA, ví dụ: "Châu Âu/Zurich".) Đối với các sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện lặp lại được mở rộng. Đối với các sự kiện đơn lẻ, trường này là không bắt buộc và biểu thị múi giờ tùy chỉnh cho thời điểm bắt đầu/kết thúc sự kiện. có thể ghi
status string Trạng thái của sự kiện. Không bắt buộc. Các giá trị có thể có là:
  • "confirmed" – Sự kiện đã được xác nhận. Đây là trạng thái mặc định.
  • "tentative" – Sự kiện này sẽ tạm thời được xác nhận.
  • "cancelled" – Sự kiện bị huỷ (đã xoá). Phương thức list (danh sách) chỉ trả về các sự kiện bị huỷ trong quá trình đồng bộ hoá gia tăng (khi syncToken hoặc updatedMin được chỉ định) hoặc nếu cờ showDeleted được đặt thành true. Phương thức get luôn trả về các kết quả này.

    Trạng thái đã huỷ thể hiện hai trạng thái khác nhau, tuỳ thuộc vào loại sự kiện:

    1. Các ngoại lệ bị hủy của một sự kiện định kỳ chưa bị hủy cho biết rằng bạn không nên hiển thị phiên bản này cho người dùng nữa. Ứng dụng cần lưu trữ các sự kiện này trong suốt thời gian diễn ra sự kiện định kỳ gốc.

      Các trường hợp ngoại lệ đã huỷ chỉ được đảm bảo có giá trị cho các trường id, recurringEventId và originalStartTime được điền sẵn. Các trường khác có thể trống.

    2. Tất cả các sự kiện bị huỷ khác biểu thị cho các sự kiện đã bị xoá. Ứng dụng nên xoá các bản sao đã đồng bộ hoá cục bộ của chúng. Những sự kiện bị huỷ như vậy cuối cùng sẽ biến mất, vì vậy, đừng dựa vào việc chúng sẽ có sẵn vô thời hạn.

      Các sự kiện đã xoá chỉ được đảm bảo điền sẵn trường id.

    Trên lịch của người tổ chức, các sự kiện đã bị huỷ sẽ tiếp tục hiển thị thông tin chi tiết về sự kiện (tóm tắt, vị trí, v.v.) để có thể khôi phục (bỏ xoá). Tương tự, các sự kiện mà người dùng được mời và sự kiện mà người dùng đã xoá theo cách thủ công sẽ tiếp tục cung cấp thông tin chi tiết. Tuy nhiên, các yêu cầu đồng bộ hoá gia tăng với showDeleted được đặt thành false sẽ không trả về những thông tin chi tiết này.

    Nếu một sự kiện thay đổi người tổ chức (ví dụ: thông qua thao tác di chuyển) và người tổ chức ban đầu không có trong danh sách người tham dự, thì sự kiện đó sẽ để lại một sự kiện đã huỷ, trong đó chỉ đảm bảo điền trường id.

có thể ghi
summary string Tiêu đề sự kiện. có thể ghi
transparency string Liệu sự kiện có chặn thời gian trên lịch hay không. Không bắt buộc. Các giá trị có thể có là:
  • "opaque" – Giá trị mặc định. Sự kiện không chặn thời gian trên lịch. Điều này tương đương với việc đặt chế độ Hiển thị tôi ở trạng thái thành Bận trong giao diện người dùng Lịch.
  • "transparent" – Sự kiện không bị chặn thời gian trên lịch. Điều này tương đương với việc đặt chế độ Hiển thị tôi là thành Có sẵn trong giao diện người dùng Lịch.
 có thể ghi
updated datetime Thời gian sửa đổi gần đây nhất của dữ liệu sự kiện chính (dưới dạng dấu thời gian RFC3339). Việc cập nhật lời nhắc sự kiện sẽ không làm thay đổi điều này. Chỉ có thể đọc.
visibility string Chế độ hiển thị của sự kiện. Không bắt buộc. Các giá trị có thể sử dụng là:
  • "default" – Sử dụng chế độ hiển thị mặc định cho các sự kiện trên lịch. Đây là giá trị mặc định.
  • "public" – Sự kiện là công khai và thông tin chi tiết về sự kiện sẽ hiển thị cho tất cả người đọc lịch.
  • "private" – Sự kiện là riêng tư và chỉ những người tham dự sự kiện mới có thể xem thông tin chi tiết về sự kiện.
  • "confidential" – Sự kiện là riêng tư. Giá trị này được cung cấp vì lý do tương thích.
 có thể ghi
workingLocationProperties nested object Dữ liệu sự kiện tại địa điểm làm việc. có thể ghi
workingLocationProperties.customLocation object Nếu có, hãy chỉ định rằng người dùng đang làm việc tại một vị trí tuỳ chỉnh. có thể ghi
workingLocationProperties.customLocation.label string Một nhãn bổ sung không bắt buộc để cung cấp thêm thông tin. có thể ghi
workingLocationProperties.homeOffice any value Nếu có, hãy chỉ định rằng người dùng đang làm việc tại nhà. có thể ghi
workingLocationProperties.officeLocation object Nếu có, hãy chỉ rõ rằng người dùng đang làm việc tại văn phòng. có thể ghi
workingLocationProperties.officeLocation.buildingId string Giá trị nhận dạng toà nhà (không bắt buộc). Mã này phải tham chiếu đến mã toà nhà trong cơ sở dữ liệu Tài nguyên của tổ chức. có thể ghi
workingLocationProperties.officeLocation.deskId string Giá trị nhận dạng không gian làm việc (không bắt buộc). có thể ghi
workingLocationProperties.officeLocation.floorId string Giá trị nhận dạng tầng (không bắt buộc). writable
workingLocationProperties.officeLocation.floorSectionId string Giá trị nhận dạng mục giá sàn (không bắt buộc). có thể ghi
workingLocationProperties.officeLocation.label string Tên văn phòng được hiển thị trong các ứng dụng khách của Lịch trên web và dành cho thiết bị di động. Bạn nên tham chiếu tên toà nhà trong cơ sở dữ liệu Tài nguyên của tổ chức. có thể ghi
workingLocationProperties.type string Loại địa điểm làm việc. Các giá trị có thể có là:
  • "homeOffice" – Người dùng đang làm việc tại nhà.
  • "officeLocation" – Người dùng đang làm việc tại văn phòng.
  • "customLocation" – Người dùng đang làm việc ở một vị trí tuỳ chỉnh.
Mọi thông tin chi tiết đều được chỉ định trong trường phụ của tên đã chỉ định, nhưng trường này có thể bị thiếu nếu trống. Mọi trường khác sẽ bị bỏ qua.

Bắt buộc khi thêm các thuộc tính về địa điểm làm việc.

 có thể ghi

Phương thức

xóa
Xoá một sự kiện.
nhận
Trả về một sự kiện dựa trên mã Lịch Google của sự kiện đó. Để truy xuất một sự kiện bằng mã icalendar của sự kiện đó, hãy gọi phương thứcevents.list bằng cách dùng tham số iCalUID.
import
Nhập một sự kiện. Thao tác này dùng để thêm bản sao riêng tư của sự kiện hiện có vào lịch. Bạn chỉ có thể nhập những sự kiện có eventType là default.

Hành vi không dùng nữa: Nếu một sự kiện không phải default được nhập, loại của sự kiện đó sẽ được thay đổi thành default và mọi thuộc tính dành riêng cho từng loại sự kiện có thể đã bị loại bỏ.

chèn
Tạo một sự kiện.
instances
Trả về các bản sao của sự kiện định kỳ đã chỉ định.
list
Trả về các sự kiện trên lịch đã chỉ định.
di chuyển
Di chuyển một sự kiện sang một lịch khác, tức là thay đổi người tổ chức sự kiện. Xin lưu ý rằng bạn chỉ có thể di chuyển default sự kiện; Bạn không thể di chuyển các sự kiện birthday, focusTime, fromGmail, outOfOffice và workingLocation.
bản vá
Cập nhật một sự kiện. Phương thức này hỗ trợ ngữ nghĩa của bản vá. Lưu ý rằng mỗi yêu cầu bản vá cần 3 đơn vị hạn mức; thích dùng get theo sau là update. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Những trường bạn không chỉ định trong yêu cầu sẽ không thay đổi. Các trường mảng, nếu được chỉ định, sẽ ghi đè các mảng hiện có; thao tác này sẽ loại bỏ mọi phần tử mảng trước đó.
quickAdd
Tạo sự kiện dựa trên một chuỗi văn bản đơn giản.
cập nhật
Cập nhật một sự kiện. Phương thức này không hỗ trợ ngữ nghĩa bản vá và luôn cập nhật toàn bộ tài nguyên sự kiện. Để cập nhật một phần, hãy thực hiện get, sau đó là update bằng cách sử dụng các thẻ điện tử để đảm bảo tính tỉ mỉ.
đồng hồ
Chú ý theo dõi những thay đổi đối với tài nguyên về Sự kiện.