このページは Cloud Translation API によって翻訳されました。

イベントを作成する

ユーザーが最適なハイキングルートを見つけるのに役立つアプリについて考えてみましょう。ハイキングプランをカレンダーの予定として追加すると、自動的に予定を管理できます。Google カレンダーで計画を共有してリマインダーを受け取ることで、ストレスなく準備を整えることができます。また、Google サービスがシームレスに統合されているため、Google Now がユーザーに出発時刻を通知し、Google マップが時間通りにミーティングの場所を案内します。

この記事では、カレンダーの予定を作成してユーザーのカレンダーに追加する方法について説明します。

予定の追加

イベントを作成するには、少なくとも次のパラメータを指定して events.insert() メソッドを呼び出します。

calendarId はカレンダー ID で、イベントを作成するカレンダーのメールアドレスか、ログインユーザーのメインカレンダーを使用する特別なキーワード 'primary' のいずれかです。使用するカレンダーのメールアドレスがわからない場合は、Google カレンダーウェブ UI のカレンダー設定（[カレンダーのアドレス] セクション内）または calendarList.list() 呼び出しの結果で確認できます。
event は、開始や終了など、必要なすべての詳細情報を指定して作成するイベントです。必須フィールドは、start と end の 2 つだけです。すべてのイベントフィールドについては、event リファレンスをご覧ください。
start.dateTime フィールドと end.dateTime フィールドを使用して、時間指定イベントを指定します。終日の予定には、代わりに start.date と end.date を使用します。

イベントを正常に作成するには、以下を行う必要があります。

OAuth スコープを https://www.googleapis.com/auth/calendar に設定して、ユーザーのカレンダーの編集権限を付与します。
認証されたユーザーに、指定した calendarId を使用してカレンダーへの書き込みアクセス権があることを確認します（たとえば、calendarId に対して calendarList.get() を呼び出し、accessRole を確認します）。

イベントメタデータを追加する

必要に応じて、カレンダーの予定の作成時にイベントのメタデータを追加できます。作成時にメタデータを追加しない場合は、events.update() を使用して多くのフィールドを更新できますが、イベント ID など、一部のフィールドは events.insert() オペレーションでのみ設定できます。

ロケーション

場所の項目に住所を追加すると、次のような機能が利用できるようになります。

「出発時刻」などの指示を出すこともできます。

イベント ID

イベントの作成時に、独自のイベント ID を生成するように選択できます。

画像アセットを追加します。これにより、ローカルデータベースのエンティティと Google カレンダーの予定の同期を維持できます。また、カレンダーバックエンドで正常に実行された後のある時点でオペレーションが失敗しても、イベントの重複作成が防止されます。イベント ID が指定されていない場合は、サーバーが生成します。詳しくは、イベント ID のリファレンスをご覧ください。

参加者

作成した予定は、組織内のすべてのメインの Google カレンダーに表示されます。

同じ予定 ID の参加者に表示されます。挿入リクエストで sendNotifications を true に設定すると、参加者に予定のメール通知も届きます。詳しくは、複数の参加者が参加するイベントのガイドをご覧ください。

次の例は、イベントを作成してそのメタデータを設定する方法を示しています。

Go

// Refer to the Go quickstart on how to setup the environment:
// https://developers.google.com/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/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/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/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/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 ドライブのファイルをカレンダーの予定に添付できます。アタッチメントは、events.insert() 以降でイベントを作成するときに（events.patch() など）更新の一環として追加できます。

Google ドライブのファイルを予定に添付するには、次の 2 つの操作を行います。

Drive API Files リソースからファイルの alternateLink の URL、title、mimeType を取得します。通常は files.get() メソッドを使用します。
リクエスト本文で 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 で示されているように、現在サポートされている 3 種類の conferenceData があります。

一般ユーザー向けハングアウト（eventHangout）
ユーザー Google Workspace 向け従来のハングアウト（サポート終了、eventNamedHangout）
Google Meet（hangoutsMeet）

ユーザーのカレンダーでサポートされている会議の種類は、calendars コレクションと calendarList コレクションの conferenceProperties.allowedConferenceSolutionTypes で確認できます。また、settings コレクションの autoAddHangouts 設定をチェックして、新たに作成したすべての予定に対してユーザーがハングアウトを作成するように選択することもできます。

conferenceSolution には、type に加えて、会議ソリューションを表すために使用できる 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);

イベントの新しい会議を作成するには、新しく生成された requestId（ランダムな string でも可）を createRequest に指定します。会議は非同期で作成されますが、リクエストのステータスをいつでもチェックして、ユーザーに状況を知らせることができます。

たとえば、既存のイベントの会議生成をリクエストするには、次のようにします。

JavaScript

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

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

この呼び出しの即時レスポンスに、まだデータが入力されていない conferenceData が含まれている可能性があります。その場合は、status フィールドにステータスコード pending が示されます。会議の情報が入力されると、ステータスコードが success に変わります。entryPoints フィールドには、ユーザーがダイヤルインできる動画 URI と電話 URI に関する情報が含まれます。

同じ会議の詳細で複数のカレンダーの予定をスケジュールする場合は、conferenceData 全体をある予定から別の予定にコピーできます。

コピーは特定の状況で役立ちます。たとえば、候補者と面接官に別々のイベントを設定する採用アプリケーションを開発しているとします。この場合、面接担当者の ID を保護しつつ、すべての参加者が同じ電話会議に参加できるようにする必要があります。

イベントを作成する

予定の追加

イベント メタデータを追加する

Go

Java

JavaScript

Node.js

PHP

Python

Ruby

予定にドライブの添付ファイルを追加する

Java

PHP

Python

予定にビデオ会議や電話会議を追加する

JavaScript

JavaScript

イベントメタデータを追加する