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 phần Giới thiệu về sự kiện.

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

Biểu thị 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ị Nội dung mô tả Ghi chú
anyoneCanAddSelf boolean Liệu bất kỳ ai cũng có thể mời chính mình tham gia sự kiện (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.

Mỗi sự kiện có thể có tối đa 25 tệp đính kèm,

attachments[].fileId string Mã của tệp đính kèm. Chỉ đọc.

Đối với các tệp trên Google Drive, đây là mã 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ó thể đã bị loại khỏi nội dung trình bày tại sự kiện hay không. Khi truy xuất một sự kiện, điều này có thể là do một quy định hạn chế do tham số truy vấn maxAttendee chỉ định. Khi cập nhật một sự kiện, bạn có thể dùng tính năng này để chỉ 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 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. 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 về phản hồi của người tham dự. 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à địa chỉ email hợp lệ theo tiêu chuẩn RFC5322.

Bắt buộc khi thêm 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 Liệu người tham dự có phải là người tổ chức sự kiện hay không. Chỉ đọ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ể thiết lập khi người tham dự được thêm vào sự kiện lần đầu tiên. Các lần sửa đổi tiếp theo sẽ bị bỏ qua. Không bắt buộc. Giá trị mặc định là False. có thể ghi
attendees[].responseStatus string Trạng thái phản hồi của người tham dự. Các giá trị có thể sử dụng là:
  • "needsAction" – Người tham dự chưa phản hồi lời mời (được đề xuất cho sự kiện mới).
  • "declined" – Người tham dự đã từ chối lời mời.
  • "tentative" – Người tham dự đã tạm 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 Liệu mục nhập này có đại diện cho lịch mà bản sao sự kiện này xuất hiện hay không. Chỉ đọ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 nhập trong phần event của định nghĩa màu (xem điểm cuối của 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ể được nhà phát triển sử dụng để theo dõi hội nghị, không được hiển thị cho người dùng.

Giá trị mã nhận dạng được hình thành khác nhau cho từng loại giải pháp hội nghị:

  • eventHangout: Chưa đặt mã nhận dạng. (Loại hội nghị này không được dùng nữa.)
  • eventNamedHangout: Mã nhận dạng 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ụ: 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 dành cho hội nghị truyền hình, chẳng hạn như Google Meet.

Huỷ đặt cho một hội nghị truyền hình 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 duy nhấ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 gặp phải một loại không quen thuộc hoặc trống, ứng dụng vẫn có thể hiển thị các điểm truy cập. Tuy nhiên, hệ thống sẽ không cho phép chỉnh sửa.

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

  • "eventHangout" cho Hangouts 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ị này nhưng không thể tạo hội nghị mới)
  • "eventNamedHangout" của Hangouts phiên bản cũ cho người dùng 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" cho Google Meet (http://meet.google.com)
  • "addOn" dành cho nhà cung cấp dịch vụ hội nghị bên thứ ba

conferenceData.conferenceSolution.name string Tên mà người dùng nhìn thấy của giải pháp này. Không đượ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 được tạo không đồng bộ. Để xem liệu dữ liệu có hiển thị 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ị truyền hình, 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 gặp phải một loại không quen thuộc hoặc trống, ứng dụng vẫn có thể hiển thị các điểm truy cập. Tuy nhiên, hệ thống sẽ không cho phép chỉnh sửa.

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

  • "eventHangout" cho Hangouts 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ị này nhưng không thể tạo hội nghị mới)
  • "eventNamedHangout" của Hangouts phiên bản cũ cho người dùng 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" cho Google Meet (http://meet.google.com)
  • "addOn" dành cho nhà cung cấp dịch vụ 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 nên tạo lại mã này cho mỗi yêu cầu mới. Nếu một mã nhận dạng được cung cấp giống với mã 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.

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 của từng hội nghị truyền hình, chẳng hạn như URL hoặc số điện thoại.

Tất cả các phiên này 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 sẵn vào 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 hội nghị sử dụng. Bạn chỉ nên 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ị.

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

  • "video" – tham gia một hội nghị truyền hình qua HTTP. Một hội nghị truyền hình có thể không có hoặc có một điểm truy cập video.
  • "phone" - tham gia một hội nghị truyền hình bằng cách quay một số điện thoại. Một hội nghị truyền hình có thể không có hoặc có nhiều phone điểm truy cập.
  • "sip" – tham gia một hội nghị qua SIP. Một hội nghị truyền hình 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ụ: số điện thoại bổ sung. Một hội nghị truyền hình có thể không có hoặc có một điểm truy cập more. Hội nghị truyền hình 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. Hiển thị với người dùng cuối. Không được bản địa hoá. Độ dài tối đa là 512 ký tự.

Ví dụ:

  • cho video: meet.google.com/aaa-bbbb- mở
  • 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ị 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 sẵn vào 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 hội nghị sử dụng. Bạn chỉ nên 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 vào hội nghị 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 sẵn vào 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 hội nghị sử dụng. Bạn chỉ nên hiển thị các trường đã điền sẵn.

conferenceData.entryPoints[].password string Mật khẩu để truy cập vào hội nghị 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 sẵn vào 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 hội nghị sử dụng. Bạn chỉ nên 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 vào hội nghị. Độ 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 sẵn vào 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 hội nghị sử dụng. Bạn chỉ nên 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: là bắt buộc.
  • đối với phone, bắt buộc phải có giản đồ tel:. URI phải bao gồm toàn bộ trình tự quay số (ví dụ: tel:+12345678900,,123456789;1234).
  • đối với sip, cần có giản đồ sip:, ví dụ: sip:12345678@myprovider.com.
  • cho giản đồ more, http: hoặc https: là bắt buộc.

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ý) cần hiển thị cho người dùng. Có thể chứa HTML. Độ dài tối đa là 2.048 ký tự. Không bắt buộc.
conferenceData.signature string Chữ ký của dữ liệu hội nghị.

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

Huỷ đặt cho một hội nghị truyền hình 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ị truyền hình 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.
creator object Người tạo sự kiện. Chỉ đọc.
creator.displayName string Tên của người 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 mà bản sao sự kiện này xuất hiện hay không. Chỉ đọ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 (độc quyền) của sự kiện. Đối với sự kiện định kỳ, đây là thời gian kết thúc của lần xuất hiện đầ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 giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bạn phải chênh lệch múi giờ trừ phi múi giờ được chỉ định rõ trong timeZone. có thể ghi
end.timeZone string Múi giờ mà bạn chỉ định thời gian. (Định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Châu Âu/Zurich".) Đối với các sự kiện lặp lại, 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 sự kiện đơn lẻ, trường này là trường không bắt buộc và cho biết múi giờ tuỳ chỉnh cho sự kiện bắt đầu/kết thúc. có thể ghi
endTimeUnspecified boolean Liệu thời gian kết thúc có thực sự chưa được chỉ đị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 Thẻ ETag của tài nguyên.
eventType string Loại cụ thể của sự kiện. Bạn không thể sửa đổi chế độ này sau khi tạo sự kiện. Các giá trị có thể sử dụng là:
  • "default" – Một sự kiện thông thường hoặc không được chỉ định thêm.
  • "outOfOffice" – Sự kiện không có mặt tại văn phòng.
  • "focusTime" – Một sự kiện thời gian cần tập trung.
  • "workingLocation" – Một sự kiện về địa điểm làm việc.
có thể ghi
extendedProperties object Thuộc tính mở rộng của sự kiện.
extendedProperties.private object Những thuộc tính dành riêng cho 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 Thuộc tính được chia sẻ giữa các bản sao của sự kiện trên lịch của những người tham dự khác. có thể ghi
extendedProperties.shared.(key) string Tên của tài sản dùng chung và giá trị tương ứng.
focusTimeProperties nested object Dữ liệu sự kiện Thời gian cần tập trung. Được sử dụng nếu eventTypefocusTime. có thể ghi
focusTimeProperties.autoDeclineMode string Liệu có từ chối lời mời họp trùng lặp với các sự kiện Thời gian cần tập trung 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ả những lời mời họp xung đột với sự kiện này đều bị từ chối; và declineOnlyNewConflictingInvitations, nghĩa là chỉ những lời mời họp mới có xung đột được gửi đến khi có sự kiện Thời gian cần tập trung mới bị từ chối.
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. Giá trị này có thể là available hoặc doNotDisturb.
focusTimeProperties.declineMessage string Thư phản hồi để đặt nếu một 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; cấu trúc này chỉ được dùng để trả về siêu dữ liệu của 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ể sử dụng là:
  • "icon" - Tiện ích hiển thị bên cạnh tên sự kiện trong chế độ xem lịch.
  • "chip" – Tiện ích hiển thị khi người dùng nhấp vào sự kiện.
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à 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
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 Tên 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 những người tham dự không phải là 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. Lựa chọn mặc định là True. có thể ghi
guestsCanModify boolean Liệu những người tham dự không phải là 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 những 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 hay không. Không bắt buộc. Lựa chọn 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ư được xác định trong RFC5545. Trường này được dùng để xác định riêng biệt các sự kiện trên các hệ thống lịch và phải được cung cấp khi nhập sự kiện thông qua phương thức import.

Lưu ý rằng iCalUIDid không giống hệt 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ề mặt ngữ nghĩa là trong các sự kiện định kỳ, tất cả các lần xuất hiện của một sự kiện đều có id khác nhau nhưng đều có cùng iCalUID. Để truy xuất một sự kiện bằng iCalUID của sự kiện đó, hãy gọi phương thức sự kiện.list bằng cách sử dụng thông số iCalUID. Để truy xuất một sự kiện bằng id của sự kiện đó, 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 một sự kiện đơn hoặc sự kiện định kỳ mới, bạn có thể chỉ định mã nhận dạng của các sự kiện đó. Mã nhận dạng được cung cấp phải tuân thủ các quy tắc sau:
  • các ký tự được phép trong mã nhận dạng là những ký tự được dùng trong mã hóa base32hex, tức là chữ cái viết thường a-v và chữ số 0-9, xem mục 3.1.2 trong RFC2938
  • độ dài của mã nhận dạng phải dài từ 5 đến 1024 ký tự
  • mỗi lịch phải có mã riêng
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 rằng các xung đột mã nhận dạng sẽ được phát hiện 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 đã 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ẽ được máy chủ tạo tự động.

Lưu ý rằng icalUIDid không giống hệt 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ề mặt ngữ nghĩa là trong các sự kiện định kỳ, tất cả các lần xuất hiện của một sự kiện đều có id khác nhau nhưng đề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 dạng 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á khi không thể thay đổi các trường sự kiện chính "tóm tắt", "mô tả", "vị trí", "bắt đầu", "kết thúc" hoặc "lặp lại" hay không. Giá trị mặc định là False. Chỉ đọc.
organizer object Người tổ chức sự kiện. Nếu người tổ chức cũng là người tham dự, thì thông tin này sẽ được biểu thị bằng một mục riêng trong attendees với 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, 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ó. Đó phải là địa chỉ email hợp lệ theo tiêu chuẩn RFC5322. có thể ghi
organizer.id string Mã hồ sơ của người tổ chức, nếu có.
organizer.self boolean Liệu người tổ chức có tương ứng với lịch mà bản sao sự kiện này xuất hiện hay không. Chỉ đọc. Giá trị mặc định là False.
originalStartTime nested object Đối với trường hợp sự kiện định kỳ, đây là thời điểm sự kiện này bắt đầu theo dữ liệu lặp lại trong sự kiện định kỳ được xác định bằng repeatEventId. Thuộc tính này xác định duy nhất thực thể trong chuỗi sự kiện định kỳ ngay cả khi sự kiệ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 giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bạn phải chênh lệch múi giờ trừ phi múi giờ được chỉ định rõ trong timeZone. có thể ghi
originalStartTime.timeZone string Múi giờ mà bạn chỉ định thời gian. (Định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Châu Âu/Zurich".) Đối với các sự kiện lặp lại, 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 sự kiện đơn lẻ, trường này là trường không bắt buộc và cho biết múi giờ tuỳ chỉnh cho sự kiện bắt đầu/kết thúc. có thể ghi
outOfOfficeProperties nested object Dữ liệu sự kiện không có mặt tại văn phòng. Được sử dụng nếu eventTypeoutOfOffice. có thể ghi
outOfOfficeProperties.autoDeclineMode string Liệu có từ chối lời mời họp trùng lặp với các 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ả những lời mời họp xung đột với sự kiện này đều bị từ chối; và declineOnlyNewConflictingInvitations, nghĩa là chỉ những lời mời họp mới có xung đột đượ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 Thư phản hồi để đặt nếu một 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 thuộc tính này không giống với Thuộc tính 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 RRULE, EXRULE, RDATE và EXDATE cho một sự kiện định kỳ như được chỉ định trong RFC5545. Xin lưu ý rằng các dò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 sự kiện được chỉ định trong các trường startend. Trường này bị bỏ qua đối với các sự kiện đơn lẻ hoặc bản sao của sự kiện định kỳ. có thể ghi
recurringEventId string Đối với phiên bản của sự kiện định kỳ, đây là id của sự kiện định kỳ chứa phiên bản này. Không thể thay đổi.
reminders object Thông tin về lời nhắc của sự kiện dành cho người dùng đã xác thực.
reminders.overrides[] list Nếu sự kiện không sử dụng lời nhắc mặc định, thì lời nhắc sẽ liệt kê dành riêng cho sự kiện hoặc nếu không được đặt, cho biết rằng không có lời nhắc nào được đặt cho sự kiện này. Số 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ể sử dụng là:
  • "email" – Lời nhắc được gửi qua email.
  • "popup" – Lời nhắc được gửi qua một 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. 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. có thể ghi
source object Nguồn mà sự kiện được tạo. Ví dụ: trang web, thông báo qua email hoặc bất kỳ tài liệu nào có thể nhận dạng qua một URL bằng 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; ví dụ: tiêu đề của 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 của lần xuất hiệ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 giá trị ngày-giờ kết hợp (được định dạng theo RFC3339). Bạn phải chênh lệch múi giờ trừ phi múi giờ được chỉ định rõ trong timeZone. có thể ghi
start.timeZone string Múi giờ mà bạn chỉ định thời gian. (Định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Châu Âu/Zurich".) Đối với các sự kiện lặp lại, 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 sự kiện đơn lẻ, trường này là trường không bắt buộc và cho biết múi giờ tuỳ chỉnh cho sự kiện bắt đầu/kết thúc. 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ể sử dụng 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 được dự kiến sẽ được xác nhận.
  • "cancelled" – Sự kiện đã bị huỷ (bị xoá). Phương thức list (danh sách) chỉ trả về các sự kiện đã huỷ khi đồ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 giá trị đó.

    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ị huỷ của một sự kiện lặp lại đã bị huỷ cho biết rằng trường hợp này sẽ không còn được hiển thị cho người dùng nữa. Ứng dụng nê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ỳ chính.

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

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

      Những sự kiện đã bị 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 (thông tin tóm tắt, vị trí, v.v.) để có thể khôi phục (chưa xoá). Tương tự như vậy, các sự kiện mà người dùng được mời tham gia và những sự kiện mà họ đã xoá theo cách thủ công vẫn 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 có 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ẽ chỉ có trường id được đảm bảo điền sẵn.

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ể sử dụng là:
  • "opaque" – Giá trị mặc định. Sự kiện này chặn thời gian trên lịch. Điều này tương đương với việc đặt tuỳ chọn Hiển thị tôi là thành Bận trong giao diện người dùng của Lịch.
  • "transparent" – 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 tuỳ chọn Hiển thị tôi là thành Có sẵn trong giao diện người dùng của Lịch.
có thể ghi
updated datetime Thời gian sửa đổi gần đây nhất của sự kiện (dưới dạng dấu thời gian RFC3339). Chỉ đọ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à chi tiết về sự kiện hiển thị cho tất cả người đọc lịch.
  • "private" – Sự kiện này là riêng tư và chỉ người tham dự sự kiện mới có thể xem thông tin chi tiết của 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 đị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 ở 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ỉ định 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ã nhận dạng 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 giá sàn không bắt buộc. có thể ghi
workingLocationProperties.officeLocation.floorSectionId string Giá trị nhận dạng mục sàn không bắt buộc. có thể ghi
workingLocationProperties.officeLocation.label string Tên văn phòng hiển thị trong ứng dụng Lịch trên web và ứng dụng 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ể sử dụng 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 đượ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 thuộc tính địa điểm làm việc.

có thể ghi

Phương thức

xóa
Xóa 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ã iLịch của sự kiện đó, hãy gọi phương thức events.list bằng cách sử dụng thông 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 một sự kiện hiện có vào lịch. Bạn chỉ có thể nhập các sự kiện có eventTypedefault.

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

chèn
Tạo sự kiện.
thực thể
Trả về các phiên bản 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 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 các sự kiện default; không thể di chuyển các sự kiện outOfOffice, focusTimeworkingLocation.
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á. Xin lưu ý rằng mỗi yêu cầu bản vá sử dụng 3 đơn vị hạn mức; hãy ưu tiên sử dụng get trước update. Các giá trị của trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các 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 củ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, theo sau là update bằng cách sử dụng thẻ điện tử để đảm bảo tính nguyên âm.
đồng hồ
Chú ý đến những thay đổi trong tài nguyên về Sự kiện.