Events

API Lịch cung cấp nhiều loại 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.

Để xem danh sách phương thức cho tài nguyên này, hãy xem phần 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
    }
  ],
  "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 mọi người 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 thông 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ó 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.

writable
attachments[].mimeType string Loại nội dung nghe nhì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ó 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 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ể sử dụng thuộc tính 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. writable
attendees[] list Những người tham dự sự kiện. Hãy xem hướng dẫn về 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 tính năng uỷ quyền trên toàn miền để điền danh sách người tham dự. writable
attendees[].additionalGuests integer Số lượng khách bổ sung. Không bắt buộc. Giá trị mặc định là 0. writable
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. writable
attendees[].email string Địa chỉ email của người tham dự, nếu có. Trường này phải có sẵ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ự.

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

Nhà phát triển có thể sử 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: Không đặt mã nhận dạng. (Loại cuộc họp này không còn được dùng nữa.)
  • eventNamedHangout: Mã nhận dạng là tên của cuộc trò chuyện trên Hangout. (Loại cuộc họp này không còn đượ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 hội nghị, chẳng hạn như Google Meet.

Không đặt được 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 chính xác 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ị.

Nếu ứng dụng gặp một loại 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, bạn không được phép sửa đổi.

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

  • "eventHangout" cho Hangouts dành cho người 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" cho Hangouts phiên bản cũ dành 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" cho nhà cung cấp 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. 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 hội nghị đó vào sự kiện. Dữ liệu được tạo 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 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ị.

Nếu ứng dụng gặp một loại 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, bạn không được phép sửa đổi.

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

  • "eventHangout" cho Hangouts dành cho người 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" cho Hangouts phiên bản cũ dành 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ị truyền hình 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ã 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ã 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 cuộc gọi nhiều bên.
conferenceData.createRequest.status.statusCode string Trạng thái hiện tại của yêu cầu tạo cuộc gọi nhiều bên. Chỉ có thể đọc.

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

  • "pending": yêu cầu tạo cuộc họp 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ị không thành công, không có điểm truy cập nào.

conferenceData.entryPoints[] list Thông tin về từng điểm truy cập vào 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 cuộc họp đó 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ị.

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

  • "video" – tham gia 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 cuộc họp bằng cách quay số điện thoại. Một hội nghị có thể có 0 hoặc nhiều điểm truy cập phone.
  • "sip" – tham gia hội thảo 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 tham gia hội nghị khác, chẳng hạn như 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à 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. Chưa đượ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
  • 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ã truy cập để tham gia cuộc họp. Độ 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ỉ các trường đã điền mới hiển thị.

conferenceData.entryPoints[].password string Mật khẩu để truy cập vào cuộc họp. Độ 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 vào cuộc họp. Độ 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à 1.300 ký tự.

Định dạng:

  • cho video, http: hoặc https:, bạn bắt buộc phải sử dụng giản đồ.
  • đối với phone, bạn 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, bạn phải có giản đồ sip:, ví dụ: sip:12345678@myprovider.com.
  • cho more, http: hoặc https:, bạn bắt buộc phải sử dụng giản đồ.

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ủ.

Không đặ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ó 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. writable
end nested object Thời gian kết thúc (không bao gồm) của sự kiện. Đối với sự kiện định kỳ, đây là thời gian kết thúc của phiên bả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. 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 chỉ định độ lệch múi giờ trừ phi bạn chỉ định rõ múi giờ trong timeZone. writable
end.timeZone string Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện định kỳ đượ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 đ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ự 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 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 kéo dài cả ngày và 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 Các 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 thuộc tính riêng tư và giá trị tương ứng.
extendedProperties.shared object Các 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. 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 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. 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 có 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 đế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. Đó có thể là available hoặc doNotDisturb.
focusTimeProperties.declineMessage string Thư trả lời cần thiết lập 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 không còn đượ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 về 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 hiển thị bên cạnh tiêu đề sự kiện trong chế độ xem lịch.
  • "chip" – Tiện ích sẽ hiển thị 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 tuỳ chọn và giá trị tương ứng.
gadget.title string Tiêu đề của tiện ích. Không dùng nữa. writable
gadget.type string Loại tiện ích. Không dùng nữa. writable
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. writable
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. writable
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. writable
guestsCanSeeOtherGuests boolean Những người tham dự khác ngoài người tổ chức có thể xem những 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ư đị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 iCalUIDid 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. 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 khác nhau, trong khi tất cả đều có cùng 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 tham 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 sự kiện đơn lẻ 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 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ự dùng trong quá trình mã hoá base32hex, tức là chữ 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 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 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 hệ thống sẽ phát hiện được xung đột 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á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ỉ được cung cấp một trong hai giá trị này tại thời điểm 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 khác nhau, trong khi tất cả đều có cùng 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 tự do. Không bắt buộc. writable
locked boolean Liệu đây có phải là bản sao sự kiện đã khoá mà 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í", "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ó thể đọ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ó thể đọc, ngoại trừ khi nhập sự kiện. writable
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 Liệu người tổ chức có tương ứng với lịch mà bản sao của sự kiện này xuất hiện hay không. Chỉ có thể đọc. Giá trị mặc định là False.
originalStartTime nested object Đối với một thực thể của sự kiện định kỳ, đây là thời gian sự kiện này 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 giúp xác định riêng một thực thể trong chuỗi sự kiện định kỳ ngay cả khi thực thể đó đượ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 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 chỉ định độ lệch múi giờ trừ phi bạn chỉ định rõ múi giờ trong timeZone. writable
originalStartTime.timeZone string Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện định kỳ đượ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 điểm 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 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. 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 lời mời họp xung đột mới đến trong khi sự kiện Không có mặt tại văn phòng đang diễn ra.
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 thành True, thì tính năng Truyền sự kiện sẽ bị tắt. Xin lưu ý rằng thuộc tính này không giống như 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 RQU, EXRules, 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 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 trường startend. Trường này bị bỏ qua đối với các sự kiện đơn lẻ hoặc các phiên bản của sự kiện định kỳ. có thể ghi
recurringEventId string Đối với một thực thể của sự kiện định kỳ, đây là id của sự kiện định kỳ mà thực thể 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 đố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, thì trường 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, thì trường 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ể sử dụng 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 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.

writable
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 ra sự kiện. Ví dụ: một trang web, một email hoặc bất kỳ tài liệu nào có thể xác định được 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. writable
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. writable
start nested object Thời gian bắt đầu (bao gồm cả thời gian kết thúc) của sự kiện. Đối với sự kiện định kỳ, đây là thời gian bắt đầu của thực thể đầu tiên.
start.date date Ngày, ở định dạng "yyyy-mm-dd", nếu đây là sự kiện cả ngày. writable
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 bạn chỉ định rõ múi giờ trong timeZone. writable
start.timeZone string Múi giờ mà thời gian được chỉ định. (Được định dạng dưới dạng tên Cơ sở dữ liệu múi giờ IANA, ví dụ: "Europe/Zurich".) Đối với sự kiện định kỳ, trường này là bắt buộc và chỉ định múi giờ mà sự kiện định kỳ đượ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 điểm bắt đầu/kết thúc sự kiện. writable
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 được xác nhận sơ bộ.
  • "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ỷ khi đồng bộ hoá tăng dần (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 kết quả này.

    Trạng thái đã huỷ đại diện cho hai 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 thực thể này sẽ không còn được hiển thị cho người dùng nữa. Ứng dụng phải lưu trữ các sự kiện này trong suốt thời gian hoạt động của sự kiện định kỳ gốc.

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

    2. Tất cả các sự kiện bị huỷ khác đều thể hiện các sự kiện đã bị xoá. Ứng dụng phải xoá các bản sao đã đồng bộ hoá cục bộ. 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 trường id.

    Trên lịch của người tổ chức, các sự kiện đã huỷ vẫn 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 (huỷ xoá). Tương tự, những sự kiện mà người dùng được mời và đã 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.

writable
summary string Tiêu đề sự kiện. writable
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 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ị 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 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 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 ở 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ỉ 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.
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 ở một vị trí tuỳ chỉnh. writable
workingLocationProperties.customLocation.label string Một nhãn bổ sung không bắt buộc để cung cấp 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 ở nhà. writable
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. writable
workingLocationProperties.officeLocation.buildingId string Giá trị nhận dạng tòa 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 Mã nhận dạng bàn làm việc (không bắt buộc). writable
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 phần sàn (không bắt buộc). writable
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 chiếu tên toà nhà trong cơ sở dữ liệu Tài nguyên của tổ chức. writable
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 một 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 đều bị bỏ qua.

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

writable

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ã nhận dạng iCalendar, hãy gọi phương thức events.list bằ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 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 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 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ị xoá.

chèn
Tạo một sự kiện.
phiên bản
Trả về các thực thể 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 birthday, focusTime, fromGmail, outOfOfficeworkingLocation.
bản vá
Cập nhậ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; ưu tiên sử 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 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 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, theo sau là update bằng cách sử dụng etags để đảm bảo tính nguyên tử.
đồng hồ
Theo dõi các thay đổi đối với tài nguyên Sự kiện.