กิจกรรมที่เกิดซ้ํา

เอกสารนี้จะอธิบายวิธีจัดการกับกิจกรรมที่เกิดซ้ำและอินสแตนซ์ของกิจกรรมดังกล่าว

สร้างกิจกรรมที่เกิดซ้ำ

การสร้างกิจกรรมที่เกิดซ้ำจะคล้ายกับการสร้างกิจกรรมทั่วไป (กิจกรรมเดียว) ด้วยการตั้งค่าช่อง recurrence ของทรัพยากร event

โปรโตคอล

POST /calendar/v3/calendars/primary/events
...

{
  "summary": "Appointment",
  "location": "Somewhere",
  "start": {
    "dateTime": "2011-06-03T10:00:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "dateTime": "2011-06-03T10:25:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "recurrence": [
    "RRULE:FREQ=WEEKLY;UNTIL=20110701T170000Z",
  ],
  "attendees": [
    {
      "email": "attendeeEmail",
      # Other attendee's data...
    },
    # ...
  ],
}

Java

Event event = new Event();

event.setSummary("Appointment");
event.setLocation("Somewhere");

ArrayList<EventAttendee> attendees = new ArrayList<EventAttendee>();
attendees.add(new EventAttendee().setEmail("attendeeEmail"));
// ...
event.setAttendees(attendees);

DateTime start = DateTime.parseRfc3339("2011-06-03T10:00:00.000-07:00");
DateTime end = DateTime.parseRfc3339("2011-06-03T10:25:00.000-07:00");
event.setStart(new EventDateTime().setDateTime(start).setTimeZone("America/Los_Angeles"));
event.setEnd(new EventDateTime().setDateTime(end).setTimeZone("America/Los_Angeles"));
event.setRecurrence(Arrays.asList("RRULE:FREQ=WEEKLY;UNTIL=20110701T170000Z"));

Event recurringEvent = service.events().insert("primary", event).execute();

System.out.println(createdEvent.getId());

.NET

Event event = new Event()
    {
      Summary = "Appointment",
      Location = "Somewhere",
      Start = new EventDateTime() {
          DateTime = new DateTime("2011-06-03T10:00:00.000:-07:00")
          TimeZone = "America/Los_Angeles"
      },
      End = new EventDateTime() {
          DateTime = new DateTime("2011-06-03T10:25:00.000:-07:00")
          TimeZone = "America/Los_Angeles"
      },
      Recurrence = new String[] {
          "RRULE:FREQ=WEEKLY;UNTIL=20110701T170000Z"
      },
      Attendees = new List<EventAttendee>()
          {
            new EventAttendee() { Email: "attendeeEmail" },
            // ...
          }
    };

Event recurringEvent = service.Events.Insert(event, "primary").Fetch();

Console.WriteLine(recurringEvent.Id);

Python

event = {
  'summary': 'Appointment',
  'location': 'Somewhere',
  'start': {
    'dateTime': '2011-06-03T10:00:00.000-07:00',
    'timeZone': 'America/Los_Angeles'
  },
  'end': {
    'dateTime': '2011-06-03T10:25:00.000-07:00',
    'timeZone': 'America/Los_Angeles'
  },
  'recurrence': [
    'RRULE:FREQ=WEEKLY;UNTIL=20110701T170000Z',
  ],
  'attendees': [
    {
      'email': 'attendeeEmail',
      # Other attendee's data...
    },
    # ...
  ],
}

recurring_event = service.events().insert(calendarId='primary', body=event).execute()

print recurring_event['id']

PHP

$event = new Google_Service_Calendar_Event();
$event->setSummary('Appointment');
$event->setLocation('Somewhere');
$start = new Google_Service_Calendar_EventDateTime();
$start->setDateTime('2011-06-03T10:00:00.000-07:00');
$start->setTimeZone('America/Los_Angeles');
$event->setStart($start);
$end = new Google_Service_Calendar_EventDateTime();
$end->setDateTime('2011-06-03T10:25:00.000-07:00');
$end->setTimeZone('America/Los_Angeles');
$event->setEnd($end);
$event->setRecurrence(array('RRULE:FREQ=WEEKLY;UNTIL=20110701T170000Z'));
$attendee1 = new Google_Service_Calendar_EventAttendee();
$attendee1->setEmail('attendeeEmail');
// ...
$attendees = array($attendee1,
                   // ...
                   );
$event->attendees = $attendees;
$recurringEvent = $service->events->insert('primary', $event);

echo $recurringEvent->getId();

Ruby

event = Google::Apis::CalendarV3::Event.new(
  summary: 'Appointment',
  location: 'Somewhere',
  start: {
    date_time: '2011-06-03T10:00:00.000-07:00',
    time_zone:  'America/Los_Angeles'
  },
  end: {
    date_time: '2011-06-03T10:25:00.000-07:00',
    time_zone: 'America/Los_Angeles'
  },
  recurrence: ['RRULE:FREQ=WEEKLY;UNTIL=20110701T170000Z']
  attendees: [
    {
      email: 'attendeeEmail'
    },
    #...
  ]
)
response = client.insert_event('primary', event)
print response.id

เข้าถึงอินสแตนซ์

วิธีดูอินสแตนซ์ทั้งหมดของ กิจกรรมที่เกิดซ้ำ คุณใช้คำขอ events.instances() ได้

คำขอ events.list() โดยค่าเริ่มต้น แสดงเฉพาะกิจกรรมรายการเดียว กิจกรรมที่เกิดซ้ำ และ ข้อยกเว้น ระบบจะไม่แสดงผลอินสแตนซ์ที่ไม่ใช่ข้อยกเว้น หากพารามิเตอร์ singleEvents ได้รับการตั้งค่าเป็น true อินสแตนซ์แต่ละรายการทั้งหมดจะปรากฏในผลลัพธ์ แต่กิจกรรมที่เกิดซ้ำที่เกี่ยวข้องจะไม่ปรากฏ เมื่อผู้ใช้ที่มีสิทธิ์ว่าง/ไม่ว่างค้นหา events.list() ระบบจะทํางานเหมือนกับว่า singleEvent คือ true โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับกฎของรายการควบคุมการเข้าถึงที่หัวข้อ Acl

คำเตือน: อย่าแก้ไขอินสแตนซ์ทีละรายการเมื่อคุณต้องการแก้ไข กิจกรรมที่เกิดซ้ำทั้งหมด หรืออินสแตนซ์ "นี้และหลังจากนี้" กรณีนี้จะก่อให้เกิดข้อยกเว้นจำนวนมากที่ทำให้ปฏิทินดูรกตา ทำให้การเข้าถึงช้าลงและการส่งผู้ใช้จำนวนมาก ของการแจ้งเตือนการเปลี่ยนแปลงไปยังผู้ใช้

อินสแตนซ์แต่ละรายการจะคล้ายกับเหตุการณ์เดียว สิ่งที่ต่างจากกิจกรรมที่เกิดซ้ำของพ่อแม่ อินสแตนซ์ไม่ได้ตั้งค่าช่อง recurrence

ช่องเหตุการณ์ต่อไปนี้มีไว้สำหรับอินสแตนซ์เท่านั้น

• recurringEventId — รหัสกิจกรรมระดับบนสุดของกิจกรรมที่เกิดซ้ำของอินสแตนซ์นี้
• originalStartTime — เวลาที่อินสแตนซ์นี้เริ่มต้นตามข้อมูลการเกิดซ้ำในกิจกรรมที่เกิดซ้ำระดับบนสุด ซึ่งอาจแตกต่างจากเวลาจริงใน start หากมีกำหนดการใหม่ของอินสแตนซ์ ซึ่งจะระบุอินสแตนซ์ในชุดกิจกรรมที่เกิดซ้ำโดยไม่ซ้ำกัน แม้ว่าอินสแตนซ์จะถูกย้ายก็ตาม

แก้ไขหรือลบอินสแตนซ์

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

https://www.googleapis.com/calendar/v3/calendars/calendarId/events/instanceId

ใช้ค่าที่เหมาะสมแทน calendarId และ instanceId

หมายเหตุ: ค่า calendarId พิเศษ primary สามารถใช้เพื่ออ้างถึงปฏิทินหลักของผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

เมื่อสำเร็จ เซิร์ฟเวอร์จะตอบสนองด้วยรหัสสถานะ HTTP 200 OK ด้วยอินสแตนซ์ที่อัปเดตแล้ว ตัวอย่างต่อไปนี้แสดงวิธียกเลิกอินสแตนซ์ของกิจกรรมที่เกิดซ้ำ

โปรโตคอล

PUT /calendar/v3/calendars/primary/events/instanceId
...

{
  "kind": "calendar#event",
  "id": "instanceId",
  "etag": "instanceEtag",
  "status": "cancelled",
  "htmlLink": "https://www.google.com/calendar/event?eid=instanceEid",
  "created": "2011-05-23T22:27:01.000Z",
  "updated": "2011-05-23T22:27:01.000Z",
  "summary": "Recurring event",
  "location": "Somewhere",
  "creator": {
    "email": "userEmail"
  },
  "recurringEventId": "recurringEventId",
  "originalStartTime": "2011-06-03T10:00:00.000-07:00",
  "organizer": {
    "email": "userEmail",
    "displayName": "userDisplayName"
  },
  "start": {
    "dateTime": "2011-06-03T10:00:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "dateTime": "2011-06-03T10:25:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "iCalUID": "eventUID",
  "sequence": 0,
  "attendees": [
    {
      "email": "attendeeEmail",
      "displayName": "attendeeDisplayName",
      "responseStatus": "needsAction"
    },
    # ...
    {
      "email": "userEmail",
      "displayName": "userDisplayName",
      "responseStatus": "accepted",
      "organizer": true,
      "self": true
    }
  ],
  "guestsCanInviteOthers": false,
  "guestsCanSeeOtherGuests": false,
  "reminders": {
    "useDefault": true
  }
}

Java

// First retrieve the instances from the API.
Events instances = service.events().instances("primary", "recurringEventId").execute();

// Select the instance to cancel.
Event instance = instances.getItems().get(0);
instance.setStatus("cancelled");

Event updatedInstance = service.events().update("primary", instance.getId(), instance).execute();

// Print the updated date.
System.out.println(updatedInstance.getUpdated());

.NET

// First retrieve the instances from the API.
Events instances = service.Events.Instances("primary", "recurringEventId").Fetch();

// Select the instance to cancel.
Event instance = instances.Items[0];
instance.Status = "cancelled";

Event updatedInstance = service.Events.Update(instance, "primary", instance.Id).Fetch();

// Print the updated date.
Console.WriteLine(updatedInstance.Updated);

Python

# First retrieve the instances from the API.
instances = service.events().instances(calendarId='primary', eventId='recurringEventId').execute()

# Select the instance to cancel.
instance = instances['items'][0]
instance['status'] = 'cancelled'

updated_instance = service.events().update(calendarId='primary', eventId=instance['id'], body=instance).execute()

# Print the updated date.
print updated_instance['updated']

PHP

$events = $service->events->instances("primary", "eventId");

// Select the instance to cancel.
$instance = $events->getItems()[0];
$instance->setStatus('cancelled');

$updatedInstance = $service->events->update('primary', $instance->getId(), $instance);

// Print the updated date.
echo $updatedInstance->getUpdated();

Ruby

# First retrieve the instances from the API.
instances = client.list_event_instances('primary', 'recurringEventId')

# Select the instance to cancel.
instance = instances.items[0]
instance.status = 'cancelled'

response = client.update_event('primary', instance.id, instance)
print response.updated

แก้ไขอินสแตนซ์ต่อไปนี้ทั้งหมด

หากต้องการเปลี่ยนอินสแตนซ์ทั้งหมดของกิจกรรมที่เกิดซ้ำในหรือหลังจากอินสแตนซ์ (เป้าหมาย) หนึ่งๆ คุณต้องสร้างคำขอ API 2 รายการแยกกัน คำขอเหล่านี้แยกกิจกรรมที่เกิดซ้ำแต่เดิมออกเป็น 2 อย่าง อินสแตนซ์เดิมซึ่งเก็บรักษาอินสแตนซ์โดยไม่มีการเปลี่ยนแปลง และกิจกรรมที่เกิดซ้ำใหม่มี อินสแตนซ์ที่ใช้การเปลี่ยนแปลง

1. โทรหา events.update() ถึง ตัดกิจกรรมที่เกิดซ้ำเดิมของอินสแตนซ์ที่จะอัปเดต โดยตั้งค่า คอมโพเนนต์ UNTIL ของ RRULE ที่จะชี้ก่อนเวลาเริ่มต้นของ อินสแตนซ์เป้าหมายแรก คุณสามารถตั้งค่าคอมโพเนนต์ COUNT แทน UNTIL
2. โทรหา events.insert() ถึง สร้างกิจกรรมที่เกิดซ้ำใหม่โดยใช้ข้อมูลทั้งหมดเหมือนกับต้นฉบับ ยกเว้น การเปลี่ยนแปลงที่คุณพยายามทำ กิจกรรมที่เกิดซ้ำใหม่ต้องมีเวลาเริ่มต้นเป็น อินสแตนซ์เป้าหมาย

ตัวอย่างนี้แสดงวิธีเปลี่ยนตำแหน่งเป็น "ที่อื่น" โดยเริ่มจากที่ 3 กิจกรรมที่เกิดซ้ำจากตัวอย่างก่อนหน้านี้

โปรโตคอล

# Updating the original recurring event to trim the instance list:

PUT /calendar/v3/calendars/primary/events/recurringEventId
...

{
  "summary": "Appointment",
  "location": "Somewhere",
  "start": {
    "dateTime": "2011-06-03T10:00:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "dateTime": "2011-06-03T10:25:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "recurrence": [
    "RRULE:FREQ=WEEKLY;UNTIL=20110617T065959Z",
  ],
  "attendees": [
    {
      "email": "attendeeEmail",
      # Other attendee's data...
    },
    # ...
  ],
}


# Creating a new recurring event with the change applied:

POST /calendar/v3/calendars/primary/events
...

{
  "summary": "Appointment",
  "location": "Somewhere else",
  "start": {
    "dateTime": "2011-06-17T10:00:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "end": {
    "dateTime": "2011-06-17T10:25:00.000-07:00",
    "timeZone": "America/Los_Angeles"
  },
  "recurrence": [
    "RRULE:FREQ=WEEKLY;UNTIL=20110617T065959Z",
  ],
  "attendees": [
    {
      "email": "attendeeEmail",
      # Other attendee's data...
    },
    # ...
  ],
}

หมายเหตุ: การเปลี่ยนแปลงอินสแตนซ์ต่อไปนี้ทั้งหมดจะรีเซ็ตข้อยกเว้นที่เกิดขึ้น หลังอินสแตนซ์เป้าหมาย