Events

Calendar API cung cấp nhiều loại tài nguyên sự kiện. Bạn có thể tìm thêm thông tin trong phần Giới thiệu về sự kiện.

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

Cách trình bày 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
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
Tên tài sản Giá trị Mô tả Ghi chú
anyoneCanAddSelf boolean Liệu có ai có thể tự mời mình tham dự 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.

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

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

Đối với tệp trên Google Drive, đây là mã nhận dạng của mục tài nguyên Files tương ứng trong Drive API.

attachments[].fileUrl string Đường liên kết URL đến tệp đính kèm.

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

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

có thể ghi
attachments[].mimeType string Loại phương tiện trên Internet (loại MIME) của tệp đính kèm.
attachments[].title string Tên tệp đính kèm.
attendeesOmitted boolean Liệu người tham dự có thể đã bị bỏ qua trong biểu diễn 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 tắc hạn chế được chỉ định bằng tham số truy vấn maxAttendee. Khi cập nhật một sự kiện, bạn có thể dùng tham số này để chỉ cập nhật phản hồi của người tham dự. 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. Hãy xem hướng dẫn Sự kiện có 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 quyền uỷ quyền trên toàn miền để điền sẵ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 Bình luận 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ó). Bạn phải điền trường này khi thêm người tham dự. Đây phải là địa chỉ email hợp lệ theo RFC5322.

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

writable
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. Giá trị mặc định là False.
attendees[].resource boolean Người tham dự có phải là 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ể là:
  • "needsAction" – Người tham dự chưa phản hồi lời mời (nên dùng cho các sự kiện mới).
  • "declined" – Khách mời đã từ chối lời mời.
  • "tentative" – Khách mời đã chấp nhận lời mời (dự kiến).
  • "accepted" – Khách mời đã chấp nhận lời mời.
có thể ghi
attendees[].self boolean Liệu mục này có đại diện cho lịch mà bản sao này của sự kiện xuất hiện hay không. Chỉ đọc. Giá trị mặc định là False.
birthdayProperties nested object Dữ liệu về ngày sinh hoặc sự kiện đặc biệt. Được dùng nếu eventType"birthday". Không thể thay đổi. writable
birthdayProperties.contact string Tên tài nguyên của người liên hệ mà sự kiện sinh nhật này được liên kết. Bạn có thể dùng phương thức này để tìm nạp thông tin liên hệ từ API People. Định dạng: "people/c12345". Chỉ đọc.
birthdayProperties.customTypeName string Nhãn loại tuỳ chỉnh được chỉ định cho sự kiện này. Thông tin này sẽ được điền sẵn nếu bạn đặt birthdayProperties.type thành "custom". Chỉ đọc.
birthdayProperties.type string Loại sinh nhật hoặc sự kiện đặc biệt. Các giá trị có thể là:
  • "anniversary" – Một ngày kỷ niệm không phải là sinh nhật. Luôn có contact.
  • "birthday" – Sự kiện sinh nhật. Đây là giá trị mặc định.
  • "custom" – Một ngày đặc biệt có nhãn được chỉ định thêm trong trường customTypeName. Luôn có contact.
  • "other" – Một ngày đặc biệt không thuộc các danh mục khác và không có nhãn tuỳ chỉnh. Luôn có contact.
  • "self" – Sinh nhật của chính chủ sở hữu lịch. Không được có contact.
Calendar API chỉ hỗ trợ việc tạo sự kiện có loại "birthday". Bạn không thể thay đổi loại này sau khi tạo sự kiện.
có thể ghi
colorId string Màu của sự kiện. Đây là một mã nhận dạng đề cập đế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ị, 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 hội nghị mới, 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ã nhận dạng của hội nghị.

Nhà phát triển có thể dùng để theo dõi các hội nghị, 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 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òn được dùng nữa.)
  • eventNamedHangout: ID là tên của Hangout. (Loại hội nghị này không còn được dùng nữa.)
  • hangoutsMeet: ID 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 hội nghị, chẳng hạn như Google Meet.

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

Bạn phải cung cấp conferenceSolution và ít nhất một entryPoint, hoặc createRequest.

conferenceData.conferenceSolution.iconUri string Biểu tượng hiển thị cho người dùng của 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ị truyền hình cho sự kiện này.
conferenceData.conferenceSolution.key.type string Loại giải pháp hội nghị.

Nếu gặp phải một loại không xác định hoặc trống, thì ứng dụng vẫn có thể hiển thị các điểm truy cập. Tuy nhiên, bạn không được phép sửa đổi.

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

  • "eventHangout" 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ị này nhưng bạn không thể tạo hội nghị mới)
  • "eventNamedHangout" cho Hangouts phiên bản cũ đối với 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" đối với nhà cung cấp dịch vụ hội nghị 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. 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 hội nghị đó vào sự kiện. Dữ liệu được tạo một cách không đồng bộ. Để xem dữ liệu có xuất hiện hay không, hãy kiểm tra trường status.

Bạn phải cung cấ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ị.

Nếu gặp phải một loại không xác định hoặc trống, thì ứng dụng vẫn có thể hiển thị các điểm truy cập. Tuy nhiên, bạn không được phép sửa đổi.

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

  • "eventHangout" 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ị này nhưng bạn không thể tạo hội nghị mới)
  • "eventNamedHangout" cho Hangouts phiên bản cũ đối với 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" đối với 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 khách nên tạo lại mã nhận dạng 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ã nhận dạng 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ị.
conferenceData.createRequest.status.statusCode string Trạng thái hiện tại của yêu cầu tạo hội nghị. Chỉ đọc.

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

  • "pending": yêu cầu tạo hội nghị vẫn đang được xử lý.
  • "success": yêu cầu tạo hội nghị đã 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.

conferenceData.entryPoints[] list Thông tin về từng điểm truy cập vào hội nghị, chẳng hạn như URL hoặc số điện thoại.

Tất cả các thiết bị này phải thuộc cùng một hội nghị.

Bạn phải cung cấ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ị. Độ dài tối đa là 128 ký tự.

Khi tạo dữ liệu hội nghị mới, chỉ điền vào tập hợp con của 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ị sử dụng. Chỉ những trường đã điền thông tin mới được hiển thị.

Không bắt buộc.

conferenceData.entryPoints[].entryPointType string Loại điểm truy cập vào hội nghị.

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

  • "video" – tham gia một hội nghị qua HTTP. Một hội nghị có thể có 0 hoặc 1 điểm truy cập video.
  • "phone" – tham gia hội nghị bằng cách quay số điện thoại. Một hội nghị có thể có từ 0 điểm truy cập trở lên phone.
  • "sip" – tham gia một hội nghị qua SIP. Một hội nghị có thể có 0 hoặc 1 điểm truy cập sip.
  • "more" – hướng dẫn bổ sung về cách tham gia hội nghị, ví dụ: số điện thoại bổ sung. Một hội nghị có thể có 0 hoặc 1 điểm truy cập more. Hội nghị chỉ có một điểm truy cập more không phải là một 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. Không được bản địa hoá. Độ dài tối đa là 512 ký tự.

Ví dụ:

  • đối với video: meet.google.com/aaa-bbbb-ccc
  • cho phone: +1 123 268 2601
  • đối với sip: 12345678@altostrat.com
  • đối với more: không được đ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ị. Độ dài tối đa là 128 ký tự.

Khi tạo dữ liệu hội nghị mới, chỉ điền vào tập hợp con của 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ị sử dụng. Chỉ những trường đã điền thông tin mới được hiển thị.

Không bắt buộc.

conferenceData.entryPoints[].passcode string Mật mã để 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ị mới, chỉ điền vào tập hợp con của 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ị sử dụng. Chỉ những trường đã điền thông tin mới được hiển thị.

conferenceData.entryPoints[].password string Mật khẩu để 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ị mới, chỉ điền vào tập hợp con của 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ị sử dụng. Chỉ những trường đã điền thông tin mới được hiển thị.

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ị mới, chỉ điền vào tập hợp con của 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ị sử dụng. Chỉ những trường đã điền thông tin mới được hiển thị.

Không bắt buộc.

conferenceData.entryPoints[].uri string URI của điểm truy cập. Độ dài tối đa là 1.300 ký tự.

Định dạng:

  • bạn phải sử dụng giản đồ video, http: hoặc https:.
  • đối với phone, bạn phải có giản đồ tel:. URI phải bao gồm toàn bộ chuỗi quay số (ví dụ: tel:+12345678900,,,123456789;1234).
  • bắt buộc phải có lược đồ sip, sip:, ví dụ: sip:12345678@myprovider.com.
  • bạn phải sử dụng 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ý) để 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ị.

Đượ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 cuộc họp 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 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 mà bản sao này của sự kiện 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. writable
end nested object Thời gian kết thúc (không bao gồm) 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 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 diễn ra cả ngày. writable
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 cung cấp độ lệch múi giờ, trừ phi bạn chỉ định rõ ràng múi giờ trong timeZone. có thể ghi
end.timeZone string Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên trong Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện lặp lại, bạn phải điền trường này và chỉ định múi giờ mà trong đó sự kiện lặp lại được mở rộng. Đối với sự kiện diễn ra một lần, trường này là không bắt buộc và cho biết múi giờ tuỳ chỉnh cho thời gian bắt đầu/kết thúc sự kiện. có thể ghi
endTimeUnspecified boolean Thời gian kết thúc có thực sự không đượ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 bạn đặt thuộc tính này thành True. Giá trị mặc định là False.
etag etag 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ể là:
  • "birthday" – Một sự kiện đặc biệt kéo dài cả ngày và diễn ra hằng năm.
  • "default" – Sự kiện thông thường hoặc không được chỉ định thêm.
  • "focusTime" – Sự kiện thời gian tập trung.
  • "fromGmail" – Một sự kiện từ Gmail. Bạn không thể tạo loại sự kiện này.
  • "outOfOffice" – Sự kiện không có mặt tại văn phòng.
  • "workingLocation" – Sự kiện đị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. writable
extendedProperties.private.(key) string Tên của thuộc tính riêng tư và giá trị tương ứng.
extendedProperties.shared object Các thuộc tính được dùng chung 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. 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 Thời gian cần tập trung. Được dùng nếu eventTypefocusTime. writable
focusTimeProperties.autoDeclineMode string Có từ chối lời mời họp trùng 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, tức là không từ chối lời mời họp nào; declineAllConflictingInvitations, tức là từ chối tất cả lời mời họp xung đột với sự kiện; và declineOnlyNewConflictingInvitations, tức là chỉ từ chối những lời mời họp xung đột mới xuất hiện trong khi sự kiện Không làm phiền đ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 liên quan. Giá trị này có thể là available hoặc doNotDisturb.
focusTimeProperties.declineMessage string Thông báo phản hồi sẽ được đặt nếu Lịch tự động từ chối một sự kiện hiện có hoặc lời mời mới.
gadget object Một tiện ích mở rộng sự kiện này. Tiện ích đã ngừng hoạt động; thay vào đó, cấu trúc này chỉ được dùng để trả về siêu dữ liệu lịch ngày sinh.
gadget.display string Chế độ hiển thị của tiện ích. Không dùng nữa. Các giá trị có thể là:
  • "icon" – Tiện ích này xuất hiện bên cạnh tiêu đề của sự kiện trong chế độ xem lịch.
  • "chip" – Tiện ích này sẽ xuất hiện khi người dùng nhấp vào sự kiện.
writable
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. writable
gadget.preferences object Tùy chọn. writable
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 của 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. Giá trị mặc định là True. writable
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ể xem danh sách người tham dự sự kiện hay không. Không bắt buộc. Giá trị mặc định là True. writable
iCalUID string Giá trị nhận dạng duy nhất của sự kiện như được xác định trong RFC5545. Tham số này được dùng để xác định duy nhấ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.

Xin lưu ý rằng iCalUIDid không giống nhau và bạn chỉ nên cung cấp một trong hai giá trị này khi tạo sự kiện. Một điểm khác biệt về 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 riêng, trong khi tất cả đều dùng chung một 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 không công khai của sự kiện. Khi tạo sự kiện mới (một lần hoặc định kỳ), bạn có thể chỉ định mã nhận dạng cho các sự kiện đó. Giá trị nhận dạng bạn cung cấp phải tuân theo 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 phương thức mã hoá base32hex, tức là chữ cái thường a-v và chữ số 0-9, hãy xem phần 3.1.2 trong RFC2938
  • mã nhận dạng phải có độ dài từ 5 đến 1024 ký tự
  • mỗi lịch phải có một mã riêng biệt
Do hệ thống được phân phối trên toàn cầu, nên chúng tôi không thể đảm bảo rằng các xung đột về 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ơ xảy ra xung đột, bạn nên sử dụng một 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, thì máy chủ sẽ tự động tạo mã nhận dạng.

Xin lưu ý rằng icalUIDid không giống nhau và bạn chỉ nên cung cấp một trong hai giá trị này khi tạo sự kiện. Một điểm khác biệt về 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 riêng, trong khi tất cả đều dùng chung một icalUID.

writable
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á hay không, trong đó bạn không thể thay đổi các trường sự kiện chính "tóm tắt", "nội dung mô tả", "vị trí", "ngày bắt đầu", "ngày kết thúc" hoặc "chu kỳ lặp lại". 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ì điều này đượ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ó quyền đọc, trừ trường hợp nhập một sự kiện. writable
organizer.displayName string Tên của người tổ chức (nếu có). writable
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. writable
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 này của sự kiện xuất hiện hay không. Chỉ đọc. Giá trị mặc định là False.
originalStartTime nested object Đối với một phiên bản của sự kiện định kỳ, đây là thời gian mà sự kiện này sẽ bắt đầu theo dữ liệu định kỳ trong sự kiện định kỳ được xác định bằng recurringEventId. Mã này xác định riêng biệt phiên bản trong chuỗi sự kiện định kỳ, ngay cả khi phiên bản đó được chuyển sang một thời gian 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 diễn ra 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 cung cấp độ lệch múi giờ, trừ phi bạn chỉ định rõ ràng múi giờ trong timeZone. có thể ghi
originalStartTime.timeZone string Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên trong Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện lặp lại, bạn phải điền trường này và chỉ định múi giờ mà trong đó sự kiện lặp lại được mở rộng. Đối với sự kiện diễn ra một lần, trường này là không bắt buộc và cho biết múi giờ tuỳ chỉnh cho thời gian bắt đầu/kết thúc sự kiện. writable
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 eventTypeoutOfOffice. writable
outOfOfficeProperties.autoDeclineMode string Có từ chối lời mời họp trùng với sự kiện Không có mặt tại văn phòng hay không. Các giá trị hợp lệ là declineNone, nghĩa là không từ chối lời mời họp nào; declineAllConflictingInvitations, nghĩa là từ chối tất cả lời mời họp xung đột với sự kiện; và declineOnlyNewConflictingInvitations, nghĩa là chỉ từ chối những lời mời họp xung đột mới nhận được khi sự kiện Vắng mặt đang diễn ra.
outOfOfficeProperties.declineMessage string Thông báo phản hồi sẽ được đặt nếu Lịch tự động từ chối một sự kiện hiện có hoặc lời mời mới.
privateCopy boolean Nếu bạn đặt thành True, thì Lan truyền sự kiện sẽ bị tắt. Xin lưu ý rằng đây không phải là 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 bạn không được phép sử dụng các dòng DTSTART và DTEND 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 sẽ bị bỏ qua đối với các sự kiện diễn ra một lần hoặc các lần diễn ra của sự kiện định kỳ. writable
recurringEventId string Đối với một lần diễn ra của sự kiện định kỳ, đây là id của sự kiện định kỳ mà lần diễn ra này thuộc về. Không thể thay đổi.
reminders object Thông tin về lời nhắc của sự kiện cho 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 thay đổi thuộc tính updated của sự kiện bao quanh.
reminders.overrides[] list Nếu sự kiện không sử dụng lời nhắc mặc định, thì danh sách này sẽ liệt kê những lời nhắc dành riêng cho sự kiện đó. Nếu bạn không đặt lời nhắc, thì danh sách này sẽ cho biết rằng không 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. writable
reminders.overrides[].method string Phương thức mà lời nhắc này sử dụng. Các giá trị có thể 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.

writable
reminders.overrides[].minutes integer Số phút trước khi sự kiện bắt đầu 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 iCalendar. có thể ghi
source object Nguồn tạo sự kiện. Ví dụ: một trang web, một thư email hoặc bất kỳ tài liệu nào có thể nhận dạng bằng một URL có lượ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 một trang web hoặc tiêu đề email. có thể ghi
source.url string URL của nguồn trỏ đến một tài nguyên. Giao thức URL phải là HTTP hoặc HTTPS. có thể ghi
start nested object Thời gian bắt đầu (bao gồm cả) của sự kiện. Đối với sự kiện định kỳ, đây là thời gian bắt đầu của phiên bản đầu tiên.
start.date date Ngày ở định dạng "yyyy-mm-dd", nếu đây là sự kiện diễn ra 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 cung cấp độ lệch múi giờ, trừ phi bạn chỉ định rõ ràng múi giờ trong timeZone. có thể ghi
start.timeZone string Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên trong Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện lặp lại, bạn phải điền trường này và chỉ định múi giờ mà trong đó sự kiện lặp lại được mở rộng. Đối với sự kiện diễn ra một lần, trường này là không bắt buộc và cho biết múi giờ tuỳ chỉnh cho thời gian 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ể là:
  • "confirmed" – Sự kiện đã được xác nhận. Đây là trạng thái mặc định.
  • "tentative" – Sự kiện đã được xác nhận tạm thời.
  • "cancelled" – Sự kiện bị huỷ (bị xoá). Phương thức list chỉ trả về các sự kiện đã huỷ khi đồng bộ hoá gia tăng (khi bạn chỉ định syncToken hoặc updatedMin) hoặc nếu bạn đặt cờ showDeleted thành true. Phương thức get luôn trả về các giá trị này.

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

    1. Các trường hợp ngoại lệ đã huỷ của một sự kiện định kỳ chưa huỷ cho biết rằng người dùng sẽ không còn thấy phiên bản này 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ỳ mẹ.

      Các ngoại lệ bị huỷ chỉ được đảm bảo có giá trị cho các trường id, recurringEventIdoriginalStartTime. Các trường khác có thể bị trống.

    2. Tất cả các sự kiện bị huỷ khác đều là sự kiện đã bị xoá. Khách hàng nên xoá các bản sao được đồng bộ hoá cục bộ. Những sự kiện bị huỷ như vậy sẽ biến mất theo thời gian, vì vậy, bạn không nên dựa vào việc chúng sẽ luôn có sẵn.

      Các sự kiện đã xoá chỉ đảm bảo được đ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ỷ vẫn hiển thị thông tin chi tiết về sự kiện (nội dung tóm tắt, vị trí, v.v.) để có thể khôi phục (xoá trạng thái đã xoá). Tương tự, những sự kiện mà người dùng được mời tham gia và đã xoá theo cách thủ công vẫn sẽ 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ẽ bị huỷ và chỉ có trường id được đảm bảo sẽ được điền sẵn.

có thể ghi
summary string Tiêu đề sự kiện. có thể ghi
transparency string 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ể là:
  • "opaque" – Giá trị mặc định. Sự kiện này sẽ 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ị trạng thái của tôi là thành Bận trong giao diện người dùng Lịch.
  • "transparent" – Sự kiện này không chiếm thời gian trên lịch. Điều này tương đương với việc đặt trạng thái Hiển thị tôi là thành Rảnh trong giao diện người dùng Lịch.
writable
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 về sự kiện sẽ không làm thay đổi chế độ này. 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ể 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 ở chế độ công khai và tất cả người đọc lịch đều có thể xem thông tin chi tiết về sự kiện.
  • "private" – Sự kiện là riêng tư và chỉ 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 này là riêng tư. Giá trị này được cung cấp vì lý do tương thích.
writable
workingLocationProperties nested object Dữ liệu sự kiện về địa điểm làm việc. writable
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. writable
workingLocationProperties.customLocation.label string Nhãn bổ sung không bắt buộc để biết thêm thông tin. writable
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 không bắt buộc của toà nhà. 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 bàn (không bắt buộc). có thể ghi
workingLocationProperties.officeLocation.floorId string Giá trị nhận dạng sàn (không bắt buộc). có thể ghi
workingLocationProperties.officeLocation.floorSectionId string Mã nhận dạng phần sàn (không bắt buộc). có thể ghi
workingLocationProperties.officeLocation.label string Tên văn phòng xuất hiện trong ứng dụng Lịch trên web và thiết bị di động. Bạn nên tham khảo 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ể 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 tại một vị trí tuỳ chỉnh.
Mọi thông tin chi tiết đều được chỉ định trong một trường phụ có tên được chỉ định, nhưng trường này có thể bị thiếu nếu trống. Mọi trường khác đều 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
Xoá một sự kiện.
get
Trả về một sự kiện dựa trên mã sự kiện trên Lịch Google. Để truy xuất một sự kiện bằng mã iCalendar của sự kiện đó, hãy gọi phương thức events.list bằng cách sử dụng tham số iCalUID.
nhập
Nhập một sự kiện. Thao tác này dùng để thêm một 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 những sự kiện có eventTypedefault.

Hành vi không được dùng nữa: Nếu một sự kiện không phải là default được nhập, thì 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 loại sự kiện mà sự kiện đó có thể có sẽ bị loại bỏ.

chèn
Tạo một sự kiện.
instances
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 được chỉ định.
move
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 birthday, focusTime, fromGmail, outOfOfficeworkingLocation.
patch
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 vá sẽ tiêu thụ 3 đơn vị hạn mức; bạn nên sử dụng get, sau đó là update. Các giá trị trường mà bạn chỉ định sẽ thay thế các giá trị hiện có. Các trường mà bạn không chỉ định trong yêu cầu sẽ không thay đổi. Nếu được chỉ định, các trường mảng 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 một sự kiện dựa trên một chuỗi văn bản đơn giản.
update
Cập nhật một sự kiện. Phương thức này không hỗ trợ ngữ nghĩa vá và luôn cập nhật toàn bộ tài nguyên sự kiện. Để thực hiện một bản cập nhật một phần, hãy thực hiện thao tác get, sau đó thực hiện thao tác update bằng cách sử dụng etag để đảm bảo tính nguyên tử.
watch
Theo dõi các thay đổi đối với tài nguyên Sự kiện.