Events

Calendar API มีทรัพยากรกิจกรรมหลายประเภท ดูข้อมูลเพิ่มเติมได้ที่เกี่ยวกับกิจกรรม

ดูรายการวิธีการสำหรับแหล่งข้อมูลนี้ได้ที่ท้ายหน้า

การนําเสนอทรัพยากร

{
  "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
}
ชื่อพร็อพเพอร์ตี้ ค่า คำอธิบาย หมายเหตุ
anyoneCanAddSelf boolean ทุกคนสามารถเชิญตัวเองให้เข้าร่วมกิจกรรมได้หรือไม่ (เลิกใช้งานแล้ว) ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
attachments[] list ไฟล์แนบของกิจกรรม

หากต้องการแก้ไขไฟล์แนบ คุณควรตั้งค่าพารามิเตอร์คำขอ supportsAttachments เป็น true

โดยไฟล์แนบต่อกิจกรรมมีได้สูงสุด 25 รายการ

attachments[].fileId string รหัสของไฟล์แนบ อ่านอย่างเดียว

สำหรับไฟล์ Google ไดรฟ์ รหัสนี้คือรหัสของรายการทรัพยากร Files ที่เกี่ยวข้องใน Drive API

attachments[].fileUrl string ลิงก์ URL ไปยังไฟล์แนบ

สำหรับการเพิ่มไฟล์แนบของ Google ไดรฟ์ ให้ใช้รูปแบบเดียวกับในพร็อพเพอร์ตี้ alternateLink ของทรัพยากร Files ใน Drive API

ต้องระบุเมื่อเพิ่มไฟล์แนบ

เขียนได้
attachments[].mimeType string ประเภทสื่ออินเทอร์เน็ต (ประเภท MIME) ของไฟล์แนบ
attachments[].title string ชื่อไฟล์แนบ
attendeesOmitted boolean ระบุว่ามีการละเว้นผู้เข้าร่วมจากการนำเสนอกิจกรรมหรือไม่ เมื่อดึงข้อมูลเหตุการณ์ ปัญหานี้อาจเกิดจากข้อจํากัดที่ระบุโดยพารามิเตอร์การค้นหา maxAttendee เมื่ออัปเดตกิจกรรม คุณจะสามารถใช้ตัวเลือกนี้เพื่ออัปเดตเฉพาะคำตอบของผู้เข้าร่วมได้ ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
attendees[] list ผู้เข้าร่วมกิจกรรม ดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดเวลากิจกรรมร่วมกับผู้ใช้ปฏิทินคนอื่นๆ ได้ในคู่มือกิจกรรมที่มีผู้เข้าร่วม บัญชีบริการต้องใช้การมอบสิทธิ์ทั่วทั้งโดเมนเพื่อเติมข้อมูลรายชื่อผู้เข้าร่วม เขียนได้
attendees[].additionalGuests integer จำนวนแขกเพิ่มเติม ไม่บังคับ ค่าเริ่มต้นคือ 0 เขียนได้
attendees[].comment string ความคิดเห็นตอบกลับของผู้เข้าร่วม ไม่บังคับ เขียนได้
attendees[].displayName string ชื่อผู้เข้าร่วม (หากมี) ไม่บังคับ เขียนได้
attendees[].email string อีเมลของผู้เข้าร่วม (หากมี) ต้องมีฟิลด์นี้เมื่อเพิ่มผู้เข้าร่วม ต้องเป็นอีเมลที่ถูกต้องตาม RFC5322

ต้องระบุเมื่อเพิ่มผู้เข้าร่วม

เขียนได้
attendees[].id string รหัสโปรไฟล์ของผู้เข้าร่วม หากมี
attendees[].optional boolean ระบุว่าผู้เข้าร่วมรายนี้เป็นตัวเลือกหรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
attendees[].organizer boolean ระบุว่าผู้เข้าร่วมเป็นผู้จัดกิจกรรมหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False
attendees[].resource boolean ระบุว่าผู้เข้าร่วมเป็นทรัพยากรหรือไม่ ตั้งค่าได้เมื่อเพิ่มผู้เข้าร่วมไปยังกิจกรรมเป็นครั้งแรกเท่านั้น ระบบจะไม่สนใจการแก้ไขหลังจากนั้น ไม่บังคับ ค่าเริ่มต้นคือ "เท็จ" เขียนได้
attendees[].responseStatus string สถานะการตอบกลับของผู้เข้าร่วม ค่าที่เป็นไปได้มีดังนี้
  • "needsAction" - ผู้เข้าร่วมยังไม่ตอบกลับคำเชิญ (แนะนำสำหรับกิจกรรมใหม่)
  • "declined" - ผู้เข้าร่วมปฏิเสธคำเชิญ
  • "tentative" - ผู้เข้าร่วมตอบรับคําเชิญชั่วคราวแล้ว
  • "accepted" - ผู้เข้าร่วมยอมรับคำเชิญแล้ว
เขียนได้
attendees[].self boolean รายการนี้แสดงปฏิทินที่มีสำเนาของกิจกรรมนี้หรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False
birthdayProperties nested object ข้อมูลวันเกิดหรือกิจกรรมพิเศษ ใช้เมื่อ eventType คือ "birthday" เปลี่ยนแปลงไม่ได้ เขียนได้
birthdayProperties.contact string ชื่อทรัพยากรของรายชื่อติดต่อที่ลิงก์กับกิจกรรมวันเกิดนี้ ซึ่งสามารถใช้เพื่อดึงข้อมูลติดต่อจาก People API รูปแบบ: "people/c12345" อ่านอย่างเดียว
birthdayProperties.customTypeName string ป้ายกํากับประเภทที่กําหนดเองสําหรับเหตุการณ์นี้ ระบบจะป้อนข้อมูลนี้หากตั้งค่า birthdayProperties.type เป็น "custom" อ่านอย่างเดียว
birthdayProperties.type string ประเภทวันเกิดหรือกิจกรรมพิเศษ ค่าที่เป็นไปได้มีดังนี้
  • "anniversary" - วันครบรอบวันเกิดที่ไม่ใช่วันเกิด มี contact เสมอ
  • "birthday" - กิจกรรมวันเกิด นี่คือค่าเริ่มต้น
  • "custom" - วันที่พิเศษซึ่งมีป้ายกำกับที่ระบุเพิ่มเติมในช่อง customTypeName มี contact เสมอ
  • "other" - วันที่พิเศษซึ่งไม่อยู่ในหมวดหมู่อื่นๆ และไม่มีป้ายกำกับที่กำหนดเอง มี contact เสมอ
  • "self" - วันเกิดของเจ้าของปฏิทิน ต้องไม่มี contact
Calendar API รองรับเฉพาะการสร้างกิจกรรมประเภท "birthday" คุณจะเปลี่ยนประเภทหลังจากสร้างกิจกรรมแล้วไม่ได้
เขียนได้
colorId string สีของกิจกรรม รหัสนี้หมายถึงรายการในส่วน event ของคำจำกัดความสี (ดู ปลายทางสี) ไม่บังคับ เขียนได้
conferenceData nested object ข้อมูลที่เกี่ยวข้องกับการประชุม เช่น รายละเอียดของการประชุม Google Meet หากต้องการสร้างรายละเอียดการประชุมใหม่ ให้ใช้ช่อง createRequest หากต้องการเก็บการเปลี่ยนแปลงไว้ โปรดตั้งค่าพารามิเตอร์คําขอ conferenceDataVersion เป็น 1 สําหรับคําขอแก้ไขเหตุการณ์ทั้งหมด เขียนได้
conferenceData.conferenceId string รหัสของการประชุม

นักพัฒนาแอปสามารถใช้เพื่อติดตามการประชุมได้ แต่ไม่ควรแสดงต่อผู้ใช้

ค่ารหัสจะแตกต่างกันไปตามประเภทโซลูชันการประชุมแต่ละประเภท ดังนี้

  • eventHangout: ไม่ได้ตั้งค่ารหัส (เลิกใช้งานการประชุมประเภทนี้แล้ว)
  • eventNamedHangout: รหัสคือชื่อของ Hangouts (เลิกใช้งานการประชุมประเภทนี้แล้ว)
  • hangoutsMeet: รหัสคือรหัสการประชุม 10 อักขระ เช่น aaa-bbbb-ccc
  • addOn: รหัสที่ผู้ให้บริการบุคคลที่สามกำหนด
ไม่บังคับ

conferenceData.conferenceSolution nested object โซลูชันการประชุม เช่น Google Meet

ยกเลิกการตั้งค่าสำหรับการประชุมที่มีคำขอสร้างไม่สำเร็จ

ต้องระบุ conferenceSolution และ entryPoint อย่างน้อย 1 รายการ หรือ createRequest

conferenceData.conferenceSolution.iconUri string ไอคอนที่ผู้ใช้มองเห็นได้สำหรับโซลูชันนี้
conferenceData.conferenceSolution.key nested object คีย์ที่ระบุโซลูชันการประชุมสำหรับกิจกรรมนี้ได้อย่างไม่ซ้ำกัน
conferenceData.conferenceSolution.key.type string ประเภทโซลูชันการประชุม

หากไคลเอ็นต์พบประเภทที่ไม่คุ้นเคยหรือว่างเปล่า ก็ควรจะยังแสดงจุดแรกเข้าได้ แต่ไม่ควรอนุญาตให้แก้ไข

โดยค่าที่เป็นไปได้มีดังนี้

  • "eventHangout" สำหรับ Hangouts สำหรับผู้บริโภค (เลิกใช้งานแล้ว กิจกรรมที่มีอยู่อาจแสดงประเภทโซลูชันการประชุมนี้ แต่จะสร้างการประชุมใหม่ไม่ได้)
  • "eventNamedHangout" สำหรับ Hangouts แบบคลาสสิกสำหรับผู้ใช้ Google Workspace (เลิกใช้งานแล้ว กิจกรรมที่มีอยู่อาจแสดงโซลูชันการประชุมประเภทนี้ แต่สร้างการประชุมใหม่ไม่ได้)
  • "hangoutsMeet" สำหรับ Google Meet (http://meet.google.com)
  • "addOn" สำหรับผู้ให้บริการการประชุมของบุคคลที่สาม

conferenceData.conferenceSolution.name string ชื่อที่ผู้ใช้มองเห็นได้ของโซลูชันนี้ ไม่ได้แปล
conferenceData.createRequest nested object คำขอสร้างการประชุมใหม่และแนบไปกับกิจกรรม ระบบจะสร้างข้อมูลแบบไม่พร้อมกัน หากต้องการตรวจสอบว่าข้อมูลมีหรือไม่ ให้ตรวจสอบช่อง status

ต้องระบุ conferenceSolution และ entryPoint อย่างน้อย 1 รายการ หรือ createRequest

conferenceData.createRequest.conferenceSolutionKey nested object โซลูชันการประชุม เช่น Hangouts หรือ Google Meet
conferenceData.createRequest.conferenceSolutionKey.type string ประเภทโซลูชันการประชุม

หากไคลเอ็นต์พบประเภทที่ไม่คุ้นเคยหรือว่างเปล่า ก็ควรจะยังแสดงจุดแรกเข้าได้ แต่ไม่ควรอนุญาตให้แก้ไข

โดยค่าที่เป็นไปได้มีดังนี้

  • "eventHangout" สำหรับ Hangouts สำหรับผู้บริโภค (เลิกใช้งานแล้ว กิจกรรมที่มีอยู่อาจแสดงประเภทโซลูชันการประชุมนี้ แต่จะสร้างการประชุมใหม่ไม่ได้)
  • "eventNamedHangout" สำหรับ Hangouts แบบคลาสสิกสำหรับผู้ใช้ Google Workspace (เลิกใช้งานแล้ว กิจกรรมที่มีอยู่อาจแสดงโซลูชันการประชุมประเภทนี้ แต่สร้างการประชุมใหม่ไม่ได้)
  • "hangoutsMeet" สำหรับ Google Meet (http://meet.google.com)
  • "addOn" สำหรับผู้ให้บริการประชุม 3P

conferenceData.createRequest.requestId string รหัสที่ไม่ซ้ำกันที่ลูกค้าสร้างขึ้นสำหรับคำขอนี้

ลูกค้าควรสร้างรหัสนี้ใหม่สำหรับคำขอใหม่ทุกรายการ หากรหัสที่ระบุตรงกับรหัสสำหรับคำขอก่อนหน้า ระบบจะไม่สนใจคำขอ

conferenceData.createRequest.status nested object สถานะคำขอสร้างการประชุม
conferenceData.createRequest.status.statusCode string สถานะปัจจุบันของคำขอสร้างการประชุม อ่านอย่างเดียว

โดยค่าที่เป็นไปได้มีดังนี้

  • "pending": ยังคงประมวลผลคำขอสร้างการประชุมอยู่
  • "success": คําขอสร้างการประชุมสําเร็จ ระบบจะสร้างจุดแรกเข้า
  • "failure": คำขอสร้างการประชุมล้มเหลว ไม่มีจุดแรกเข้า

conferenceData.entryPoints[] list ข้อมูลเกี่ยวกับจุดแรกเข้าของการประชุมแต่ละรายการ เช่น URL หรือหมายเลขโทรศัพท์

ทุกคนต้องอยู่ในการประชุมเดียวกัน

ต้องระบุ conferenceSolution และ entryPoint อย่างน้อย 1 รายการ หรือ createRequest

conferenceData.entryPoints[].accessCode string รหัสเข้าถึงเพื่อเข้าร่วมการประชุม ความยาวสูงสุด 128 อักขระ

เมื่อสร้างข้อมูลการประชุมใหม่ ให้ป้อนข้อมูลเฉพาะชุดย่อยของ {meetingCode, accessCode, passcode, password, pin} ที่ตรงกับคำศัพท์ที่ผู้ให้บริการประชุมใช้ โดยจะแสดงเฉพาะฟิลด์ที่ป้อนข้อมูลแล้วเท่านั้น

ไม่บังคับ

conferenceData.entryPoints[].entryPointType string ประเภทของจุดแรกเข้าของการประชุม

ค่าที่เป็นไปได้มีดังนี้

  • "video" - การเข้าร่วมการประชุมผ่าน HTTP การประชุมอาจมีจุดเข้าใช้งาน video 0 หรือ 1 จุด
  • "phone" - เข้าร่วมการประชุมด้วยการกดหมายเลขโทรศัพท์ การประชุมอาจมีจุดแรกเข้า phone ตั้งแต่ 0 จุดขึ้นไป
  • "sip" - เข้าร่วมการประชุมผ่าน SIP การประชุมอาจมีจุดแรกเข้าของ sip 0 หรือ 1 จุด
  • "more" - วิธีการเข้าร่วมการประชุมเพิ่มเติม เช่น หมายเลขโทรศัพท์เพิ่มเติม การประชุมอาจมีจุดเข้าใช้งาน more 0 หรือ 1 จุด การประชุมที่มีเฉพาะจุดเข้าใช้งาน more ไม่ใช่การประชุมที่ถูกต้อง

conferenceData.entryPoints[].label string ป้ายกํากับสําหรับ URI แสดงต่อผู้ใช้ปลายทาง ไม่ได้แปล ความยาวสูงสุด 512 อักขระ

ตัวอย่าง

  • สำหรับ video: meet.google.com/aaa-bbbb-ccc
  • สำหรับ phone: +1 123 268 2601
  • สำหรับ sip: 12345678@altostrat.com
  • สำหรับ more: ต้องไม่กรอก

ไม่บังคับ

conferenceData.entryPoints[].meetingCode string รหัสการประชุมสำหรับเข้าถึงการประชุม ความยาวสูงสุด 128 อักขระ

เมื่อสร้างข้อมูลการประชุมใหม่ ให้ป้อนข้อมูลเฉพาะชุดย่อยของ {meetingCode, accessCode, passcode, password, pin} ที่ตรงกับคำศัพท์ที่ผู้ให้บริการประชุมใช้ โดยจะแสดงเฉพาะฟิลด์ที่ป้อนข้อมูลแล้วเท่านั้น

ไม่บังคับ

conferenceData.entryPoints[].passcode string รหัสผ่านเพื่อเข้าถึงการประชุม มีความยาวได้สูงสุดไม่เกิน 128 อักขระ

เมื่อสร้างข้อมูลการประชุมใหม่ ให้ป้อนข้อมูลในช่อง {meetingCode, accessCode, passcode, password, pin} เฉพาะชุดย่อยที่ตรงกับคำศัพท์ที่ผู้ให้บริการการประชุมใช้ โดยจะแสดงเฉพาะฟิลด์ที่ป้อนข้อมูลแล้วเท่านั้น

conferenceData.entryPoints[].password string รหัสผ่านเพื่อเข้าถึงการประชุม ความยาวสูงสุด 128 อักขระ

เมื่อสร้างข้อมูลการประชุมใหม่ ให้ป้อนข้อมูลเฉพาะชุดย่อยของ {meetingCode, accessCode, passcode, password, pin} ที่ตรงกับคำศัพท์ที่ผู้ให้บริการประชุมใช้ โดยจะแสดงเฉพาะฟิลด์ที่ป้อนข้อมูลแล้วเท่านั้น

ไม่บังคับ

conferenceData.entryPoints[].pin string PIN สำหรับเข้าถึงการประชุม ความยาวสูงสุด 128 อักขระ

เมื่อสร้างข้อมูลการประชุมใหม่ ให้ป้อนข้อมูลเฉพาะชุดย่อยของ {meetingCode, accessCode, passcode, password, pin} ที่ตรงกับคำศัพท์ที่ผู้ให้บริการประชุมใช้ โดยจะแสดงเฉพาะฟิลด์ที่ป้อนข้อมูลแล้วเท่านั้น

ไม่บังคับ

conferenceData.entryPoints[].uri string URI ของจุดแรกเข้า ความยาวสูงสุด 1,300 อักขระ

รูปแบบ:

  • สำหรับสคีมา video, http: หรือ https:
  • สำหรับ phone ต้องใช้สคีมา tel: URI ควรมีลำดับการโทรทั้งหมด (เช่น tel:+12345678900,,,123456789;1234)
  • สำหรับ sip ต้องมีสคีมา sip: เช่น sip:12345678@myprovider.com
  • สำหรับสคีมา more, http: หรือ https:

conferenceData.notes string หมายเหตุเพิ่มเติม (เช่น คำแนะนำจากผู้ดูแลระบบโดเมน ประกาศทางกฎหมาย) ที่จะแสดงต่อผู้ใช้ มี HTML ได้ ความยาวสูงสุดคือ 2,048 อักขระ ไม่บังคับ
conferenceData.signature string ลายเซ็นของข้อมูลการประชุม

สร้างขึ้นในฝั่งเซิร์ฟเวอร์

ยกเลิกการตั้งค่าสำหรับการประชุมที่มีคำขอสร้างไม่สำเร็จ

ตัวเลือกสำหรับการประชุมที่มีคำขอสร้างที่รอดำเนินการ

created datetime เวลาสร้างเหตุการณ์ (เป็นการประทับเวลา RFC3339) อ่านอย่างเดียว
creator object ผู้สร้างกิจกรรม อ่านอย่างเดียว
creator.displayName string ชื่อผู้สร้าง (หากมี)
creator.email string อีเมลของผู้สร้าง (หากมี)
creator.id string รหัสโปรไฟล์ของครีเอเตอร์ (หากมี)
creator.self boolean ข้อมูลว่าครีเอเตอร์เกี่ยวข้องกับปฏิทินที่กิจกรรมสำเนานี้ปรากฏหรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False
description string คำอธิบายกิจกรรม มี HTML ได้ ไม่บังคับ เขียนได้
end nested object เวลาสิ้นสุด (ไม่รวม) ของกิจกรรม สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาสิ้นสุดของอินสแตนซ์แรก
end.date date วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดวัน เขียนได้
end.dateTime datetime เวลาเป็นค่าวันที่และเวลาแบบรวม (จัดรูปแบบตาม RFC3339) ต้องระบุเขตเวลาออฟเซ็ต เว้นแต่จะมีการระบุเขตเวลาอย่างชัดเจนใน timeZone เขียนได้
end.timeZone string เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สำหรับกิจกรรมที่เกิดซ้ำ คุณต้องกรอกข้อมูลในช่องนี้และระบุเขตเวลาที่ขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ฟิลด์นี้จะใส่หรือไม่ก็ได้ และจะระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม เขียนได้
endTimeUnspecified boolean ไม่ได้ระบุเวลาสิ้นสุดจริงหรือไม่ ระบบจะยังคงระบุเวลาสิ้นสุดไว้เพื่อเหตุผลด้านความเข้ากันได้ แม้ว่าจะตั้งค่าแอตทริบิวต์นี้เป็น "จริง" ก็ตาม ค่าเริ่มต้นคือ False
etag etag ETag ของทรัพยากร
eventType string ประเภทเหตุการณ์ที่เฉพาะเจาะจง คุณจะแก้ไขส่วนนี้หลังจากที่สร้างกิจกรรมแล้วไม่ได้ ค่าที่เป็นไปได้มีดังนี้
  • "birthday" - กิจกรรมพิเศษตลอดทั้งวันที่เกิดซ้ำทุกปี
  • "default" - กิจกรรมปกติหรือไม่ระบุเพิ่มเติม
  • "focusTime" - กิจกรรมที่ต้องการสมาธิ
  • "fromGmail" - กิจกรรมจาก Gmail สร้างเหตุการณ์ประเภทนี้ไม่ได้
  • "outOfOffice" - กิจกรรมลางาน
  • "workingLocation" - เหตุการณ์สถานที่ทํางาน
เขียนได้
extendedProperties object พร็อพเพอร์ตี้เพิ่มเติมของเหตุการณ์
extendedProperties.private object พร็อพเพอร์ตี้ที่เป็นส่วนตัวสำหรับสำเนาของกิจกรรมที่ปรากฏในปฏิทินนี้ เขียนได้
extendedProperties.private.(key) string ชื่อของพร็อพเพอร์ตี้ส่วนตัวและค่าที่เกี่ยวข้อง
extendedProperties.shared object พร็อพเพอร์ตี้ที่แชร์ระหว่างสำเนาของกิจกรรมในปฏิทินของผู้เข้าร่วมคนอื่น เขียนได้
extendedProperties.shared.(key) string ชื่อของพร็อพเพอร์ตี้ที่แชร์และค่าที่เกี่ยวข้อง
focusTimeProperties nested object ข้อมูลกิจกรรมที่ต้องการสมาธิ ใช้ในกรณีที่ eventType เป็น focusTime เขียนได้
focusTimeProperties.autoDeclineMode string ปฏิเสธคำเชิญเข้าร่วมการประชุมที่ทับซ้อนกับกิจกรรมที่ต้องการสมาธิหรือไม่ ค่าที่ถูกต้องคือ declineNone ซึ่งหมายความว่าระบบจะไม่ปฏิเสธคำเชิญเข้าร่วมการประชุม, declineAllConflictingInvitations หมายความว่าระบบจะปฏิเสธคำเชิญเข้าร่วมการประชุมที่ขัดแย้งกันทั้งหมดซึ่งขัดแย้งกับกิจกรรม และ declineOnlyNewConflictingInvitations หมายความว่าระบบจะปฏิเสธเฉพาะคำเชิญเข้าร่วมการประชุมใหม่ที่ขัดแย้งกันซึ่งมาถึงในขณะที่กิจกรรมที่ต้องการสมาธิอยู่เท่านั้น
focusTimeProperties.chatStatus string สถานะสำหรับทําเครื่องหมายผู้ใช้ใน Chat และผลิตภัณฑ์ที่เกี่ยวข้อง ซึ่งอาจเป็น available หรือ doNotDisturb
focusTimeProperties.declineMessage string ข้อความตอบกลับที่กำหนดว่าปฏิทินจะปฏิเสธกิจกรรมที่มีอยู่หรือคำเชิญใหม่โดยอัตโนมัติ
gadget object แก็ดเจ็ตที่ขยายเหตุการณ์นี้ ระบบเลิกใช้งานแกดเจ็ตแล้ว โครงสร้างนี้จะใช้เพื่อแสดงผลข้อมูลเมตาของปฏิทินวันเกิดเท่านั้น
gadget.display string โหมดการแสดงผลของอุปกรณ์ เลิกใช้งานแล้ว ค่าที่เป็นไปได้คือ
  • "icon" - แกดเจ็ตจะแสดงข้างชื่อกิจกรรมในมุมมองปฏิทิน
  • "chip" - แกดเจ็ตจะแสดงเมื่อคลิกเหตุการณ์
เขียนได้
gadget.height integer ความสูงของแก็ดเจ็ตในหน่วยพิกเซล ความสูงต้องเป็นจำนวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว เขียนได้
gadget.preferences object ค่ากำหนด เขียนได้
gadget.preferences.(key) string ชื่อค่ากำหนดและค่าที่เกี่ยวข้อง
gadget.title string ชื่อแกดเจ็ต เลิกใช้งานแล้ว เขียนได้
gadget.type string ประเภทของแก็ดเจ็ต เลิกใช้งานแล้ว เขียนได้
gadget.width integer ความกว้างของแก็ดเจ็ตในหน่วยพิกเซล ความกว้างต้องเป็นจํานวนเต็มที่มากกว่า 0 ไม่บังคับ เลิกใช้งานแล้ว เขียนได้
guestsCanInviteOthers boolean ผู้เข้าร่วมที่ไม่ใช่ผู้จัดจะเชิญผู้อื่นให้เข้าร่วมกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ True เขียนได้
guestsCanModify boolean กำหนดว่าผู้เข้าร่วมที่ไม่ใช่ผู้จัดงานจะแก้ไขกิจกรรมได้หรือไม่ ไม่บังคับ ค่าเริ่มต้นคือ False เขียนได้
guestsCanSeeOtherGuests boolean ผู้เข้าร่วมที่ไม่ใช่ผู้จัดสามารถดูว่ามีใครผู้เข้าร่วมกิจกรรมได้บ้าง ไม่บังคับ ค่าเริ่มต้นคือ True เขียนได้
iCalUID string ตัวระบุที่ไม่ซ้ำของเหตุการณ์ตามที่กําหนดไว้ใน RFC5545 ซึ่งจะใช้เพื่อระบุกิจกรรมในระบบปฏิทินต่างๆ โดยไม่ซ้ำกัน และต้องระบุเมื่อนำเข้ากิจกรรมผ่านเมธอด import

โปรดทราบว่า iCalUID และ id ไม่เหมือนกันและควรระบุเพียง 1 รายการเท่านั้นเมื่อสร้างกิจกรรม ความแตกต่างอย่างหนึ่งในความหมายคือในกิจกรรมที่เกิดซ้ำ ทุกรายการของกิจกรรมหนึ่งจะมี id ที่แตกต่างกัน ในขณะที่ทั้งหมดใช้ iCalUID เดียวกัน หากต้องการเรียกข้อมูลเหตุการณ์โดยใช้ iCalUID ให้เรียกเมธอด events.list โดยใช้พารามิเตอร์ iCalUID หากต้องการเรียกข้อมูลเหตุการณ์โดยใช้ id ให้เรียกใช้เมธอด events.get

id string ตัวระบุแบบทึบแสงของเหตุการณ์ เมื่อสร้างเหตุการณ์ใหม่แบบครั้งเดียวหรือแบบที่เกิดซ้ำ คุณสามารถระบุรหัสของเหตุการณ์ได้ รหัสที่ระบุต้องเป็นไปตามกฎต่อไปนี้
  • อักขระที่อนุญาตในรหัสคืออักขระที่ใช้ในการเข้ารหัส base32hex เช่น อักษรตัวพิมพ์เล็ก a-v และตัวเลข 0-9 โปรดดูส่วนที่ 3.1.2 ใน RFC2938
  • รหัสต้องมีความยาวระหว่าง 5 ถึง 1,024 อักขระ
  • รหัสต้องไม่ซ้ำกันในแต่ละปฏิทิน
เนื่องจากระบบมีการกระจายอยู่ทั่วโลก เราจึงไม่สามารถรับประกันได้ว่าระบบจะตรวจพบการชนกันของรหัส ณ เวลาสร้างเหตุการณ์ เราขอแนะนำให้ใช้อัลกอริทึม UUID ที่กำหนดไว้ เช่น อัลกอริทึมที่อธิบายไว้ใน RFC4122 เพื่อลดความเสี่ยงที่จะมี UUID ซ้ำกัน

หากคุณไม่ระบุรหัส เซิร์ฟเวอร์จะสร้างรหัสให้โดยอัตโนมัติ

โปรดทราบว่า icalUID และ id จะไม่เหมือนกัน และควรระบุเพียงรายการเดียวเมื่อสร้างเหตุการณ์ ความแตกต่างอย่างหนึ่งของความหมายคือในเหตุการณ์ที่เกิดซ้ำ เหตุการณ์หนึ่งๆ ที่เกิดขึ้นทั้งหมดจะมี id ต่างกัน แต่ใช้ icalUID เดียวกัน

เขียนได้
kind string ประเภททรัพยากร ("calendar#event")
location string สถานที่ตั้งทางภูมิศาสตร์ของกิจกรรมเป็นข้อความรูปแบบใดก็ได้ ไม่บังคับ เขียนได้
locked boolean ไม่ว่าจะเป็นสำเนาเหตุการณ์ที่ล็อกไว้ซึ่งไม่สามารถทำการเปลี่ยนแปลงในช่องกิจกรรมหลักได้ เช่น "สรุป", "คำอธิบาย", "สถานที่", "เริ่มต้น", "สิ้นสุด" หรือ "การเกิดซ้ำ" ค่าเริ่มต้นคือ False อ่านอย่างเดียว
organizer object ผู้จัดกิจกรรม หากผู้จัดเป็นผู้เข้าร่วมด้วย ระบบจะระบุข้อมูลนี้ด้วยรายการแยกต่างหากใน attendees โดยตั้งค่าช่อง organizer เป็น "จริง" หากต้องการเปลี่ยนผู้จัด ให้ใช้การดำเนินการย้าย อ่านอย่างเดียว ยกเว้นเมื่อนําเข้าเหตุการณ์ เขียนได้
organizer.displayName string ชื่อผู้จัด (หากมี) เขียนได้
organizer.email string อีเมลของผู้จัด (หากมี) ต้องเป็นอีเมลที่ถูกต้องตาม RFC5322 เขียนได้
organizer.id string รหัสโปรไฟล์ของผู้จัด (หากมี)
organizer.self boolean ผู้จัดเกี่ยวข้องกับปฏิทินที่มีสำเนากิจกรรมนี้ปรากฏอยู่หรือไม่ อ่านอย่างเดียว ค่าเริ่มต้นคือ False
originalStartTime nested object สําหรับอินสแตนซ์ของกิจกรรมที่เกิดซ้ำ ข้อมูลนี้คือเวลาที่กิจกรรมนี้จะเริ่มตามข้อมูลการเกิดซ้ำในกิจกรรมที่เกิดซ้ำซึ่งระบุโดย recurringEventId ซึ่งจะระบุอินสแตนซ์ภายในชุดเหตุการณ์ที่เกิดซ้ำโดยไม่ซ้ำกัน แม้ว่าระบบจะย้ายอินสแตนซ์ไปยังเวลาอื่นก็ตาม เปลี่ยนแปลงไม่ได้
originalStartTime.date date วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดวัน เขียนได้
originalStartTime.dateTime datetime เวลาเป็นค่าวันที่และเวลาแบบรวม (จัดรูปแบบตาม RFC3339) ต้องระบุเขตเวลาออฟเซ็ต เว้นแต่จะมีการระบุเขตเวลาอย่างชัดเจนใน timeZone เขียนได้
originalStartTime.timeZone string เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สำหรับกิจกรรมที่เกิดซ้ำ คุณต้องกรอกข้อมูลในช่องนี้และระบุเขตเวลาที่ขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ฟิลด์นี้จะใส่หรือไม่ก็ได้ และจะระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม เขียนได้
outOfOfficeProperties nested object ข้อมูลกิจกรรมลางาน ใช้ในกรณีที่ eventType เป็น outOfOffice เขียนได้
outOfOfficeProperties.autoDeclineMode string ปฏิเสธคำเชิญเข้าร่วมการประชุมที่ทับซ้อนกับกิจกรรมลางานหรือไม่ ค่าที่ถูกต้องคือ declineNone ซึ่งหมายความว่าระบบจะไม่ปฏิเสธคําเชิญเข้าร่วมการประชุม declineAllConflictingInvitations ซึ่งหมายความว่าระบบจะปฏิเสธคําเชิญเข้าร่วมการประชุมทั้งหมดที่ขัดแย้งกับกิจกรรม และ declineOnlyNewConflictingInvitations ซึ่งหมายความว่าระบบจะปฏิเสธเฉพาะคําเชิญเข้าร่วมการประชุมใหม่ซึ่งขัดแย้งกันซึ่งมาถึงขณะที่กิจกรรม "ไม่อยู่ที่สำนักงาน" ปรากฏอยู่
outOfOfficeProperties.declineMessage string ข้อความตอบกลับที่กำหนดว่าปฏิทินจะปฏิเสธกิจกรรมที่มีอยู่หรือคำเชิญใหม่โดยอัตโนมัติ
privateCopy boolean หากตั้งค่าเป็น "จริง" ระบบจะปิดใช้การนำไปใช้งานเหตุการณ์ โปรดทราบว่าพร็อพเพอร์ตี้นี้ไม่เหมือนกับพร็อพเพอร์ตี้กิจกรรมส่วนตัว ไม่บังคับ เปลี่ยนแปลงไม่ได้ ค่าเริ่มต้นคือ "เท็จ"
recurrence[] list รายการบรรทัด RRULE, EXRULE, RDATE และ EXDATE สำหรับเหตุการณ์ที่เกิดซ้ำตามที่ระบุไว้ใน RFC5545 โปรดทราบว่าระบบไม่อนุญาตให้ใช้บรรทัด DTSTART และ DTEND ในช่องนี้ คุณต้องระบุเวลาเริ่มต้นและเวลาสิ้นสุดของกิจกรรมในช่อง start และ end เว้นช่องนี้ไว้สำหรับกิจกรรมรายการเดียวหรือกิจกรรมที่เกิดซ้ำ เขียนได้
recurringEventId string สำหรับอินสแตนซ์ของกิจกรรมที่เกิดซ้ำ id นี้คือกิจกรรมที่เกิดซ้ำซึ่งอินสแตนซ์นี้อยู่ เปลี่ยนแปลงไม่ได้
reminders object ข้อมูลเกี่ยวกับการช่วยเตือนของกิจกรรมสําหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว โปรดทราบว่าการเปลี่ยนการช่วยเตือนจะไม่เปลี่ยนพร็อพเพอร์ตี้ updated ของเหตุการณ์ที่ล้อมรอบด้วย
reminders.overrides[] list หากกิจกรรมไม่ได้ใช้การช่วยเตือนเริ่มต้น รายการนี้จะแสดงการช่วยเตือนสำหรับกิจกรรมนั้นๆ หรือหากไม่ได้ตั้งค่าไว้ ก็จะระบุว่าไม่ได้ตั้งค่าการช่วยเตือนสำหรับกิจกรรมนี้ จำนวนการช่วยเตือนการลบล้างสูงสุดคือ 5 รายการ เขียนได้
reminders.overrides[].method string วิธีการที่การช่วยเตือนนี้ใช้ ค่าที่เป็นไปได้มีดังนี้
  • "email" - ระบบจะส่งการช่วยเตือนทางอีเมล
  • "popup" - การช่วยเตือนจะส่งผ่านทางป๊อปอัป UI

ต้องระบุเมื่อเพิ่มการช่วยเตือน

เขียนได้
reminders.overrides[].minutes integer จำนวนนาทีก่อนเริ่มกิจกรรมซึ่งระบบควรเรียกใช้การช่วยเตือน ค่าที่ใช้ได้คือระหว่าง 0 ถึง 40320 (4 สัปดาห์เป็นนาที)

ต้องระบุเมื่อเพิ่มการช่วยเตือน

เขียนได้
reminders.useDefault boolean การแจ้งเตือนเริ่มต้นของปฏิทินมีผลกับกิจกรรมหรือไม่ เขียนได้
sequence integer หมายเลขลำดับตาม iCalendar เขียนได้
source object แหล่งที่มาของเหตุการณ์ที่สร้าง เช่น หน้าเว็บ ข้อความอีเมล หรือเอกสารใดๆ ที่ระบุได้ด้วย URL ที่มีรูปแบบ HTTP หรือ HTTPS มีเพียงผู้สร้างกิจกรรมเท่านั้นที่จะเห็นหรือแก้ไขได้
source.title string ชื่อแหล่งที่มา เช่น ชื่อหน้าเว็บหรือเรื่องอีเมล เขียนได้
source.url string URL ของแหล่งที่มาที่ชี้ไปยังทรัพยากร รูปแบบ URL ต้องเป็น HTTP หรือ HTTPS เขียนได้
start nested object เวลาเริ่มต้น (รวมวันที่เริ่มต้น) ของกิจกรรม สำหรับกิจกรรมที่เกิดซ้ำ นี่คือเวลาเริ่มต้นของอินสแตนซ์แรก
start.date date วันที่ในรูปแบบ "yyyy-mm-dd" หากเป็นกิจกรรมตลอดวัน เขียนได้
start.dateTime datetime เวลาเป็นค่าวันที่และเวลาแบบรวม (จัดรูปแบบตาม RFC3339) ต้องระบุเขตเวลาออฟเซ็ต เว้นแต่จะมีการระบุเขตเวลาอย่างชัดเจนใน timeZone เขียนได้
start.timeZone string เขตเวลาที่ระบุเวลา (จัดรูปแบบเป็นชื่อฐานข้อมูลเขตเวลาของ IANA เช่น "Europe/Zurich") สำหรับกิจกรรมที่เกิดซ้ำ คุณต้องกรอกข้อมูลในช่องนี้และระบุเขตเวลาที่ขยายการเกิดซ้ำ สำหรับกิจกรรมเดียว ฟิลด์นี้จะใส่หรือไม่ก็ได้ และจะระบุเขตเวลาที่กำหนดเองสำหรับเวลาเริ่มต้น/สิ้นสุดของกิจกรรม เขียนได้
status string สถานะของกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้
  • "confirmed" - ยืนยันกิจกรรมแล้ว สถานะนี้เป็นสถานะเริ่มต้น
  • "tentative" - กิจกรรมได้รับการยืนยันอย่างไม่แน่นอน
  • "cancelled" - กิจกรรมถูกยกเลิก (ลบแล้ว) เมธอด list จะแสดงเหตุการณ์ที่ยกเลิกในการซิงค์แบบเพิ่มเท่านั้น (เมื่อระบุ syncToken หรือ updatedMin) หรือหากตั้งค่า Flag showDeleted เป็น true เมธอด get จะแสดงผลลัพธ์เสมอ

    สถานะ "ยกเลิกแล้ว" แสดงสถานะ 2 สถานะที่แตกต่างกันโดยขึ้นอยู่กับประเภทกิจกรรม ดังนี้

    1. ข้อยกเว้นที่ยกเลิกแล้วของกิจกรรมที่เกิดขึ้นซ้ำซึ่งยังไม่ได้ยกเลิกบ่งชี้ว่าไม่ควรแสดงอินสแตนซ์นี้ต่อผู้ใช้อีกต่อไป ไคลเอ็นต์ควรจัดเก็บเหตุการณ์เหล่านี้ตลอดอายุของกิจกรรมที่เกิดซ้ำหลัก

      การยกเว้นที่ถูกยกเลิกรับประกันว่าจะมีการเติมข้อมูลให้กับช่อง id, recurringEventId และ originalStartTime เท่านั้น ช่องอื่นๆ อาจว่างเปล่า

    2. กิจกรรมอื่นๆ ทั้งหมดที่ยกเลิกแล้วแสดงถึงกิจกรรมที่ถูกลบ ลูกค้าควรนำสำเนาที่ซิงค์ในเครื่องออก กิจกรรมที่ยกเลิกดังกล่าวจะหายไปในที่สุด ดังนั้นอย่าคิดว่ากิจกรรมดังกล่าวจะพร้อมใช้งานตลอดไป

      ระบบรับประกันว่าเหตุการณ์ที่ลบไปแล้วจะมีข้อมูลในช่อง id เท่านั้น

    ในปฏิทินของผู้จัดการประชุม กิจกรรมที่ยกเลิกจะยังคงแสดงรายละเอียดกิจกรรม (สรุป สถานที่ ฯลฯ) เพื่อให้กู้คืนได้ (ยกเลิกการลบ) ในทำนองเดียวกัน กิจกรรมที่ผู้ใช้ได้รับเชิญและผู้ใช้ที่นำออกด้วยตนเองจะมีรายละเอียดเพิ่มเติมเหมือนเดิม อย่างไรก็ตาม คำขอซิงค์แบบเพิ่มที่ตั้งค่า showDeleted เป็นเท็จจะไม่แสดงรายละเอียดเหล่านี้

    หากกิจกรรมเปลี่ยนผู้จัด (เช่น ผ่านการดำเนินการย้าย) และผู้จัดเดิมไม่ได้อยู่ในรายชื่อผู้เข้าร่วม ระบบจะทิ้งกิจกรรมที่ยกเลิกไว้โดยระบบจะป้อนข้อมูลในช่อง id เท่านั้น

เขียนได้
summary string ชื่อกิจกรรม เขียนได้
transparency string กิจกรรมบล็อกเวลาในปฏิทินหรือไม่ ไม่บังคับ ค่าที่เป็นไปได้มีดังนี้
  • "opaque" - ค่าเริ่มต้น กิจกรรมจะบล็อกเวลาในปฏิทิน ซึ่งเทียบเท่ากับการตั้งค่าแสดงฉันเป็นเป็นไม่ว่างใน UI ของปฏิทิน
  • "transparent" - กิจกรรมไม่ได้บล็อกเวลาในปฏิทิน ซึ่งเทียบเท่ากับการตั้งค่าแสดงฉันเป็นเป็นว่างใน UI ของปฏิทิน
เขียนได้
updated datetime เวลาแก้ไขล่าสุดของข้อมูลเหตุการณ์หลัก (เป็นการประทับเวลา RFC3339) การอัปเดตการแจ้งเตือนกิจกรรมจะไม่ทำให้การเปลี่ยนแปลงนี้มีผล อ่านอย่างเดียว
visibility string ระดับการเข้าถึงของกิจกรรม ไม่บังคับ ค่าที่เป็นไปได้คือ
  • "default" - ใช้ระดับการเข้าถึงเริ่มต้นสำหรับกิจกรรมในปฏิทิน นี่คือค่าเริ่มต้น
  • "public" - กิจกรรมนี้เป็นแบบสาธารณะและผู้อ่านปฏิทินทุกคนจะเห็นรายละเอียดกิจกรรม
  • "private" - กิจกรรมเป็นแบบส่วนตัว และมีเพียงผู้เข้าร่วมกิจกรรมเท่านั้นที่ดูรายละเอียดกิจกรรมได้
  • "confidential" - กิจกรรมเป็นแบบส่วนตัว ค่านี้มีไว้เพื่อเหตุผลด้านความเข้ากันได้
เขียนได้
workingLocationProperties nested object ข้อมูลเหตุการณ์ของสถานที่ทำงาน เขียนได้
workingLocationProperties.customLocation object หากมี ให้ระบุว่าผู้ใช้กำลังทำงานจากตำแหน่งที่ตั้งที่กำหนดเอง เขียนได้
workingLocationProperties.customLocation.label string ป้ายกำกับเพิ่มเติมที่ไม่บังคับสำหรับข้อมูลเพิ่มเติม เขียนได้
workingLocationProperties.homeOffice any value หากมี ให้ระบุว่าผู้ใช้กำลังทำงานที่บ้าน เขียนได้
workingLocationProperties.officeLocation object (หากมี) ระบุว่าผู้ใช้ทํางานจากสำนักงาน เขียนได้
workingLocationProperties.officeLocation.buildingId string ตัวระบุอาคาร (ไม่บังคับ) ซึ่งควรอ้างอิงรหัสอาคารในฐานข้อมูลทรัพยากรขององค์กร เขียนได้
workingLocationProperties.officeLocation.deskId string ตัวระบุฝ่ายดูแลลูกค้า (ไม่บังคับ) เขียนได้
workingLocationProperties.officeLocation.floorId string ตัวระบุชั้น (ไม่บังคับ) เขียนได้
workingLocationProperties.officeLocation.floorSectionId string ตัวระบุส่วนของชั้น (ไม่บังคับ) เขียนได้
workingLocationProperties.officeLocation.label string ชื่อสำนักงานที่แสดงในไคลเอ็นต์ปฏิทินบนเว็บและอุปกรณ์เคลื่อนที่ เราขอแนะนำให้คุณอ้างอิงชื่ออาคารในฐานข้อมูลทรัพยากรขององค์กร เขียนได้
workingLocationProperties.type string ประเภทสถานที่ทํางาน ค่าที่เป็นไปได้คือ
  • "homeOffice" - ผู้ใช้กำลังทำงานที่บ้าน
  • "officeLocation" ผู้ใช้กำลังทำงานจากสำนักงาน
  • "customLocation" - ผู้ใช้ทํางานจากสถานที่ที่กำหนดเอง
รายละเอียดทั้งหมดจะระบุไว้ในช่องย่อยของชื่อที่ระบุ แต่ช่องนี้อาจหายไปหากไม่มีข้อมูล ระบบจะไม่สนใจช่องอื่นๆ

ต้องระบุเมื่อเพิ่มพร็อพเพอร์ตี้สถานที่ทํางาน

เขียนได้

เมธอด

ลบ
ลบกิจกรรม
get
แสดงผลกิจกรรมตามรหัส Google ปฏิทิน หากต้องการเรียกข้อมูลกิจกรรมโดยใช้รหัส iCalendar ให้เรียกเมธอด events.list โดยใช้พารามิเตอร์ iCalUID
import
นำเข้ากิจกรรม การทำงานนี้ใช้เพื่อเพิ่มสำเนาส่วนตัวของกิจกรรมที่มีอยู่ลงในปฏิทิน นำเข้าได้เฉพาะเหตุการณ์ที่มี eventType เป็น default เท่านั้น

ลักษณะการทำงานที่เลิกใช้งานแล้ว: หากนําเข้าเหตุการณ์ที่ไม่ใช่ default ระบบจะเปลี่ยนประเภทของเหตุการณ์เป็น default และระบบจะทิ้งพร็อพเพอร์ตี้เฉพาะประเภทเหตุการณ์ที่เหตุการณ์นั้นอาจมี

แทรก
สร้างเหตุการณ์
instances
แสดงผลอินสแตนซ์ของกิจกรรมที่เกิดซ้ำที่ระบุ
list
แสดงผลกิจกรรมในปฏิทินที่ระบุ
move
ย้ายกิจกรรมไปยังปฏิทินอื่น เช่น เปลี่ยนผู้จัดกิจกรรม โปรดทราบว่าคุณย้ายได้เฉพาะเหตุการณ์ default เท่านั้น ไม่สามารถย้ายเหตุการณ์ birthday, focusTime, fromGmail, outOfOffice และ workingLocation
แพตช์
อัปเดตกิจกรรม วิธีนี้รองรับความหมายของแพตช์ โปรดทราบว่าคําขอแพตช์แต่ละรายการจะใช้โควต้า 3 หน่วย เราขอแนะนำให้ใช้ get ตามด้วย update ค่าของช่องที่คุณระบุจะแทนที่ค่าที่มีอยู่ ช่องที่คุณไม่ได้ระบุในคำขอจะไม่มีการเปลี่ยนแปลง ช่องอาร์เรย์ (หากระบุ) จะเขียนทับอาร์เรย์ที่มีอยู่ การดำเนินการนี้จะยกเลิกองค์ประกอบอาร์เรย์ก่อนหน้า
quickAdd
สร้างเหตุการณ์ตามสตริงข้อความธรรมดา
update
อัปเดตกิจกรรม วิธีนี้ไม่รองรับความหมายของแพตช์และจะอัปเดตทรัพยากรเหตุการณ์ทั้งหมดเสมอ หากต้องการอัปเดตบางส่วน ให้ทำ get ตามด้วย update โดยใช้ etags เพื่อให้แน่ใจว่าเป็นการดำเนินการแบบอะตอม
watch
เฝ้าดูการเปลี่ยนแปลงในทรัพยากรกิจกรรม