สร้างเหตุการณ์

ลองนึกภาพแอปที่ช่วยผู้ใช้ค้นหาเส้นทางเดินป่าที่ดีที่สุด เมื่อเพิ่มแผนการเดินป่าเป็นกิจกรรมในปฏิทิน ผู้ใช้จะได้รับการช่วยเหลือให้จัดระเบียบได้โดยอัตโนมัติ Google ปฏิทินช่วยให้ผู้ใช้แชร์แผนและเตือนแผนดังกล่าวเพื่อให้ผู้ใช้เตรียมตัวได้โดยไม่เครียด นอกจากนี้ Google Maps ยังนำทางผู้ใช้ไปยังจุดนัดพบได้ตรงเวลาด้วยการผสานรวมผลิตภัณฑ์ของ Google อย่างราบรื่น

บทความนี้จะอธิบายวิธีสร้างกิจกรรมในปฏิทินและเพิ่มกิจกรรมเหล่านั้นลงในปฏิทินของผู้ใช้

เพิ่มกิจกรรม

หากต้องการสร้างกิจกรรม ให้เรียกใช้เมธอด events.insert โดยระบุพารามิเตอร์ต่อไปนี้อย่างน้อย

  • calendarId คือตัวระบุปฏิทิน และอาจเป็นอีเมลแอดเดรสของปฏิทินที่จะสร้างกิจกรรม หรือคีย์เวิร์ดพิเศษ 'primary' ซึ่งใช้ปฏิทินหลักของผู้ใช้ที่ลงชื่อเข้าใช้ หากไม่ทราบอีเมลของปฏิทินที่ต้องการใช้ คุณ สามารถตรวจสอบได้ในการตั้งค่าปฏิทินใน UI เว็บของปฏิทิน (ในส่วน "อีเมลของปฏิทิน") หรือค้นหาในผลลัพธ์ของการเรียก calendarList.list
  • event คือกิจกรรมที่จะสร้างพร้อมรายละเอียดที่จำเป็นทั้งหมด เช่น เวลาเริ่มต้นและเวลาสิ้นสุด ฟิลด์ที่ต้องระบุมีเพียงเวลา start และ end เท่านั้น ดูชุดฟิลด์กิจกรรมทั้งหมดได้ที่ข้อมูลอ้างอิงทรัพยากร Events

วิธีสร้างกิจกรรม

  • ตั้งค่าขอบเขต OAuth เป็น https://www.googleapis.com/auth/calendar เพื่อให้คุณมีสิทธิ์เข้าถึงเพื่อแก้ไขปฏิทินของผู้ใช้
  • ตรวจสอบว่าผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์มีสิทธิ์เขียนในปฏิทินที่มี calendarIdที่คุณระบุ (เช่น โดยการเรียก calendarList.get สำหรับ calendarId และตรวจสอบ accessRole)

เพิ่มข้อมูลเมตาของกิจกรรม

คุณสามารถเลือกเพิ่มข้อมูลเมตาของกิจกรรมเมื่อสร้างกิจกรรมในปฏิทิน หากเลือกไม่เพิ่มข้อมูลเมตาระหว่างการสร้าง คุณจะอัปเดตฟิลด์จำนวนมากได้โดยใช้ events.update อย่างไรก็ตาม บางฟิลด์ เช่น รหัสกิจกรรม จะตั้งค่าได้ระหว่างการดำเนินการ events.insert เท่านั้น

ตำแหน่ง
การเพิ่มที่อยู่ในฟิลด์ตำแหน่งจะเปิดใช้ฟีเจอร์ต่างๆ เช่น "เวลาออกเดินทาง" หรือการแสดงแผนที่พร้อมเส้นทาง
รหัสเหตุการณ์
เมื่อสร้างกิจกรรม คุณสามารถเลือกสร้างรหัสกิจกรรมของคุณเองที่สอดคล้องกับข้อกำหนดด้านรูปแบบ ซึ่งจะช่วยให้คุณซิงค์เอนทิตีในฐานข้อมูลภายในกับกิจกรรมในปฏิทินได้ นอกจากนี้ยังป้องกันการสร้างกิจกรรมซ้ำหากการดำเนินการล้มเหลวในบางจุดหลังจากดำเนินการสำเร็จในแบ็กเอนด์ของปฏิทิน หากคุณไม่ระบุรหัสกิจกรรม เซิร์ฟเวอร์จะสร้างรหัสให้ ดูข้อมูลเพิ่มเติมได้ที่ข้อมูลอ้างอิงรหัสกิจกรรม
ผู้เข้าร่วม
กิจกรรมที่คุณสร้างจะปรากฏในปฏิทินหลักทั้งหมดของผู้เข้าร่วมที่คุณรวมไว้ด้วยรหัสกิจกรรมเดียวกัน หากคุณตั้งค่า sendUpdates เป็น "all" หรือ "externalOnly" ในคำขอแทรก ผู้เข้าร่วมที่เกี่ยวข้องจะได้รับการแจ้งเตือนทางอีเมลสำหรับกิจกรรมของคุณ ดู ข้อมูลเพิ่มเติมได้ที่ กิจกรรมที่มีผู้เข้าร่วมหลายคน

ตัวอย่างต่อไปนี้แสดงวิธีสร้างกิจกรรมและตั้งค่าข้อมูลเมตาของกิจกรรม

Go

// Refer to the Go quickstart on how to setup the environment:
// https://developers.google.com/workspace/calendar/quickstart/go
// Change the scope to calendar.CalendarScope and delete any stored credentials.

event := &calendar.Event{
  Summary: "Google I/O 2015",
  Location: "800 Howard St., San Francisco, CA 94103",
  Description: "A chance to hear more about Google's developer products.",
  Start: &calendar.EventDateTime{
    DateTime: "2015-05-28T09:00:00-07:00",
    TimeZone: "America/Los_Angeles",
  },
  End: &calendar.EventDateTime{
    DateTime: "2015-05-28T17:00:00-07:00",
    TimeZone: "America/Los_Angeles",
  },
  Recurrence: []string{"RRULE:FREQ=DAILY;COUNT=2"},
  Attendees: []*calendar.EventAttendee{
    &calendar.EventAttendee{Email:"lpage@example.com"},
    &calendar.EventAttendee{Email:"sbrin@example.com"},
  },
}

calendarId := "primary"
event, err = srv.Events.Insert(calendarId, event).Do()
if err != nil {
  log.Fatalf("Unable to create event. %v\n", err)
}
fmt.Printf("Event created: %s\n", event.HtmlLink)

Java

// Refer to the Java quickstart on how to setup the environment:
// https://developers.google.com/workspace/calendar/quickstart/java
// Change the scope to CalendarScopes.CALENDAR and delete any stored
// credentials.

Event event = new Event()
    .setSummary("Google I/O 2015")
    .setLocation("800 Howard St., San Francisco, CA 94103")
    .setDescription("A chance to hear more about Google's developer products.");

DateTime startDateTime = new DateTime("2015-05-28T09:00:00-07:00");
EventDateTime start = new EventDateTime()
    .setDateTime(startDateTime)
    .setTimeZone("America/Los_Angeles");
event.setStart(start);

DateTime endDateTime = new DateTime("2015-05-28T17:00:00-07:00");
EventDateTime end = new EventDateTime()
    .setDateTime(endDateTime)
    .setTimeZone("America/Los_Angeles");
event.setEnd(end);

String[] recurrence = new String[] {"RRULE:FREQ=DAILY;COUNT=2"};
event.setRecurrence(Arrays.asList(recurrence));

EventAttendee[] attendees = new EventAttendee[] {
    new EventAttendee().setEmail("lpage@example.com"),
    new EventAttendee().setEmail("sbrin@example.com"),
};
event.setAttendees(Arrays.asList(attendees));

EventReminder[] reminderOverrides = new EventReminder[] {
    new EventReminder().setMethod("email").setMinutes(24 * 60),
    new EventReminder().setMethod("popup").setMinutes(10),
};
Event.Reminders reminders = new Event.Reminders()
    .setUseDefault(false)
    .setOverrides(Arrays.asList(reminderOverrides));
event.setReminders(reminders);

String calendarId = "primary";
event = service.events().insert(calendarId, event).execute();
System.out.printf("Event created: %s\n", event.getHtmlLink());

JavaScript

// Refer to the JavaScript quickstart on how to setup the environment:
// https://developers.google.com/workspace/calendar/quickstart/js
// Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
// stored credentials.

const event = {
  'summary': 'Google I/O 2015',
  'location': '800 Howard St., San Francisco, CA 94103',
  'description': 'A chance to hear more about Google\'s developer products.',
  'start': {
    'dateTime': '2015-05-28T09:00:00-07:00',
    'timeZone': 'America/Los_Angeles'
  },
  'end': {
    'dateTime': '2015-05-28T17:00:00-07:00',
    'timeZone': 'America/Los_Angeles'
  },
  'recurrence': [
    'RRULE:FREQ=DAILY;COUNT=2'
  ],
  'attendees': [
    {'email': 'lpage@example.com'},
    {'email': 'sbrin@example.com'}
  ],
  'reminders': {
    'useDefault': false,
    'overrides': [
      {'method': 'email', 'minutes': 24 * 60},
      {'method': 'popup', 'minutes': 10}
    ]
  }
};

const request = gapi.client.calendar.events.insert({
  'calendarId': 'primary',
  'resource': event
});

request.execute(function(event) {
  appendPre('Event created: ' + event.htmlLink);
});

Node.js

// Refer to the Node.js quickstart on how to setup the environment:
// https://developers.google.com/workspace/calendar/quickstart/node
// Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
// stored credentials.

const event = {
  'summary': 'Google I/O 2015',
  'location': '800 Howard St., San Francisco, CA 94103',
  'description': 'A chance to hear more about Google\'s developer products.',
  'start': {
    'dateTime': '2015-05-28T09:00:00-07:00',
    'timeZone': 'America/Los_Angeles',
  },
  'end': {
    'dateTime': '2015-05-28T17:00:00-07:00',
    'timeZone': 'America/Los_Angeles',
  },
  'recurrence': [
    'RRULE:FREQ=DAILY;COUNT=2'
  ],
  'attendees': [
    {'email': 'lpage@example.com'},
    {'email': 'sbrin@example.com'},
  ],
  'reminders': {
    'useDefault': false,
    'overrides': [
      {'method': 'email', 'minutes': 24 * 60},
      {'method': 'popup', 'minutes': 10},
    ],
  },
};

calendar.events.insert({
  auth: auth,
  calendarId: 'primary',
  resource: event,
}, function(err, event) {
  if (err) {
    console.log('There was an error contacting the Calendar service: ' + err);
    return;
  }
  console.log('Event created: %s', event.htmlLink);
});

PHP

$event = new Google_Service_Calendar_Event(array(
  'summary' => 'Google I/O 2015',
  'location' => '800 Howard St., San Francisco, CA 94103',
  'description' => 'A chance to hear more about Google\'s developer products.',
  'start' => array(
    'dateTime' => '2015-05-28T09:00:00-07:00',
    'timeZone' => 'America/Los_Angeles',
  ),
  'end' => array(
    'dateTime' => '2015-05-28T17:00:00-07:00',
    'timeZone' => 'America/Los_Angeles',
  ),
  'recurrence' => array(
    'RRULE:FREQ=DAILY;COUNT=2'
  ),
  'attendees' => array(
    array('email' => 'lpage@example.com'),
    array('email' => 'sbrin@example.com'),
  ),
  'reminders' => array(
    'useDefault' => FALSE,
    'overrides' => array(
      array('method' => 'email', 'minutes' => 24 * 60),
      array('method' => 'popup', 'minutes' => 10),
    ),
  ),
));

$calendarId = 'primary';
$event = $service->events->insert($calendarId, $event);
printf('Event created: %s\n', $event->htmlLink);

Python

# Refer to the Python quickstart on how to setup the environment:
# https://developers.google.com/workspace/calendar/quickstart/python
# Change the scope to 'https://www.googleapis.com/auth/calendar' and delete any
# stored credentials.

event = {
  'summary': 'Google I/O 2015',
  'location': '800 Howard St., San Francisco, CA 94103',
  'description': 'A chance to hear more about Google\'s developer products.',
  'start': {
    'dateTime': '2015-05-28T09:00:00-07:00',
    'timeZone': 'America/Los_Angeles',
  },
  'end': {
    'dateTime': '2015-05-28T17:00:00-07:00',
    'timeZone': 'America/Los_Angeles',
  },
  'recurrence': [
    'RRULE:FREQ=DAILY;COUNT=2'
  ],
  'attendees': [
    {'email': 'lpage@example.com'},
    {'email': 'sbrin@example.com'},
  ],
  'reminders': {
    'useDefault': False,
    'overrides': [
      {'method': 'email', 'minutes': 24 * 60},
      {'method': 'popup', 'minutes': 10},
    ],
  },
}

event = service.events().insert(calendarId='primary', body=event).execute()
print 'Event created: %s' % (event.get('htmlLink'))

Ruby

event = Google::Apis::CalendarV3::Event.new(
  summary: 'Google I/O 2015',
  location: '800 Howard St., San Francisco, CA 94103',
  description: 'A chance to hear more about Google\'s developer products.',
  start: Google::Apis::CalendarV3::EventDateTime.new(
    date_time: '2015-05-28T09:00:00-07:00',
    time_zone: 'America/Los_Angeles'
  ),
  end: Google::Apis::CalendarV3::EventDateTime.new(
    date_time: '2015-05-28T17:00:00-07:00',
    time_zone: 'America/Los_Angeles'
  ),
  recurrence: [
    'RRULE:FREQ=DAILY;COUNT=2'
  ],
  attendees: [
    Google::Apis::CalendarV3::EventAttendee.new(
      email: 'lpage@example.com'
    ),
    Google::Apis::CalendarV3::EventAttendee.new(
      email: 'sbrin@example.com'
    )
  ],
  reminders: Google::Apis::CalendarV3::Event::Reminders.new(
    use_default: false,
    overrides: [
      Google::Apis::CalendarV3::EventReminder.new(
        reminder_method: 'email',
        minutes: 24 * 60
      ),
      Google::Apis::CalendarV3::EventReminder.new(
        reminder_method: 'popup',
        minutes: 10
      )
    ]
  )
)

result = client.insert_event('primary', event)
puts "Event created: #{result.html_link}"

เพิ่มไฟล์แนบจากไดรฟ์ลงในกิจกรรม

คุณสามารถแนบGoogle Drive ไฟล์ เช่น บันทึกการประชุมใน Google เอกสาร งบประมาณใน Google ชีต งานนำเสนอใน Google สไลด์ หรือไฟล์อื่นๆ ที่ เกี่ยวข้องจากไดรฟ์ลงในกิจกรรมในปฏิทิน คุณสามารถเพิ่มไฟล์แนบเมื่อสร้างกิจกรรมด้วย events.insert หรือเพิ่มในภายหลังเป็นส่วนหนึ่งของการอัปเดต เช่น ด้วย events.patch

การแนบไฟล์จากไดรฟ์ลงในกิจกรรมมี 2 ส่วน ดังนี้

  1. รับ URL alternateLink title และ mimeType ของไฟล์จาก ทรัพยากร Files ของ Google Drive API โดยปกติจะใช้ files.get เมธอด
  2. สร้างหรืออัปเดตกิจกรรมโดยตั้งค่าฟิลด์ attachments ในเนื้อหาของคำขอและตั้งค่าพารามิเตอร์ supportsAttachments เป็น true

ตัวอย่างโค้ดต่อไปนี้แสดงวิธีอัปเดตกิจกรรมที่มีอยู่เพื่อเพิ่มไฟล์แนบ

Java

public static void addAttachment(Calendar calendarService, Drive driveService, String calendarId,
    String eventId, String fileId) throws IOException {
  File file = driveService.files().get(fileId).execute();
  Event event = calendarService.events().get(calendarId, eventId).execute();

  List<EventAttachment> attachments = event.getAttachments();
  if (attachments == null) {
    attachments = new ArrayList<EventAttachment>();
  }
  attachments.add(new EventAttachment()
      .setFileUrl(file.getAlternateLink())
      .setMimeType(file.getMimeType())
      .setTitle(file.getTitle()));

  Event changes = new Event()
      .setAttachments(attachments);
  calendarService.events().patch(calendarId, eventId, changes)
      .setSupportsAttachments(true)
      .execute();
}

PHP

function addAttachment($calendarService, $driveService, $calendarId, $eventId, $fileId) {
  $file = $driveService->files->get($fileId);
  $event = $calendarService->events->get($calendarId, $eventId);
  $attachments = $event->attachments;

  $attachments[] = array(
    'fileUrl' => $file->alternateLink,
    'mimeType' => $file->mimeType,
    'title' => $file->title
  );
  $changes = new Google_Service_Calendar_Event(array(
    'attachments' => $attachments
  ));

  $calendarService->events->patch($calendarId, $eventId, $changes, array(
    'supportsAttachments' => TRUE
  ));
}

Python

def add_attachment(calendarService, driveService, calendarId, eventId, fileId):
    file = driveService.files().get(fileId=fileId).execute()
    event = calendarService.events().get(calendarId=calendarId,
                                         eventId=eventId).execute()

    attachments = event.get('attachments', [])
    attachments.append({
        'fileUrl': file['alternateLink'],
        'mimeType': file['mimeType'],
        'title': file['title']
    })

    changes = {
        'attachments': attachments
    }
    calendarService.events().patch(calendarId=calendarId, eventId=eventId,
                                   body=changes,
                                   supportsAttachments=True).execute()

เพิ่มการประชุมทางโทรศัพท์และการประชุมทางวิดีโอลงในกิจกรรม

คุณสามารถเชื่อมโยงกิจกรรมกับ การประชุม Google Meet เพื่อ ให้ผู้ใช้ประชุมจากระยะไกลผ่านการโทรหรือวิดีโอคอลได้

ฟิลด์ conferenceData ช่วยให้คุณอ่าน คัดลอก และล้างรายละเอียดการประชุมที่มีอยู่ หรือขอให้ สร้างการประชุมใหม่ได้ หากต้องการอนุญาตให้สร้างและแก้ไขรายละเอียดการประชุม ให้ตั้งค่าพารามิเตอร์คำขอ conferenceDataVersion เป็น 1

ระบบรองรับการประชุมประเภทต่อไปนี้ ซึ่งระบุโดย conferenceData.conferenceSolution.key.type

  1. Google Meet (hangoutsMeet)

คุณสามารถดูประเภทการประชุมที่รองรับสำหรับปฏิทินของผู้ใช้ที่ต้องการได้โดยดูที่ conferenceProperties.allowedConferenceSolutionTypes ใน คอลเล็กชัน calendars และ calendarList

นอกเหนือจาก type แล้ว conferenceSolution ยังมีฟิลด์ name และ iconUri ที่คุณใช้เพื่อแสดงโซลูชันการประชุมได้ดังที่แสดงด้านล่าง

JavaScript

const solution = event.conferenceData.conferenceSolution;

const content = document.getElementById("content");
const text = document.createTextNode("Join " + solution.name);
const icon = document.createElement("img");
icon.src = solution.iconUri;

content.appendChild(icon);
content.appendChild(text);

คุณสามารถสร้างการประชุมใหม่สำหรับกิจกรรมได้โดยระบุ createRequest ที่มี requestId ที่สร้างขึ้นใหม่เป็นสตริงแบบสุ่ม ระบบจะสร้างการประชุมแบบไม่พร้อมกัน แต่คุณสามารถตรวจสอบสถานะของคำขอได้ทุกเมื่อเพื่อแจ้งให้ผู้ใช้ทราบถึงสิ่งที่เกิดขึ้น

ตัวอย่างเช่น หากต้องการขอให้สร้างการประชุมสำหรับกิจกรรมที่มีอยู่ ให้ทำดังนี้

JavaScript

const eventPatch = {
  conferenceData: {
    createRequest: {requestId: "7qxalsvy0e"}
  }
};

gapi.client.calendar.events.patch({
  calendarId: "primary",
  eventId: "7cbh8rpc10lrc0ckih9tafss99",
  resource: eventPatch,
  sendUpdates: "all",
  conferenceDataVersion: 1
}).execute(function(event) {
  console.log("Conference created for event: %s", event.htmlLink);
});

การตอบกลับทันทีต่อการเรียกนี้อาจยังไม่มี conferenceDataที่กรอกข้อมูลครบถ้วน ฟิลด์สถานะ จะมีค่า pending รหัสสถานะจะเปลี่ยนเป็น success หลังจากกรอกข้อมูลการประชุมแล้ว ฟิลด์ entryPoints มีข้อมูลเกี่ยวกับ URI ของวิดีโอและโทรศัพท์ที่ผู้ใช้สามารถโทรเข้าได้

หากต้องการกำหนดเวลาจัดกิจกรรมในปฏิทินหลายรายการด้วยรายละเอียดการประชุมเดียวกัน คุณสามารถคัดลอก conferenceData ทั้งหมดจากกิจกรรมหนึ่งไปยังอีกกิจกรรมหนึ่งได้

การคัดลอกมีประโยชน์ในบางสถานการณ์ เช่น สมมติว่าคุณกำลังพัฒนาแอปพลิเคชันการสรรหาบุคลากรที่ตั้งค่ากิจกรรมแยกกันสำหรับผู้สมัครและผู้สัมภาษณ์ คุณต้องการปกป้องข้อมูลประจำตัวของผู้สัมภาษณ์ แต่ก็ต้องการให้ผู้เข้าร่วมทั้งหมดเข้าร่วมการประชุมสายเดียวกัน