Events: import

Importuje wydarzenie. Ta operacja pozwala dodać prywatną kopię istniejącego wydarzenia do kalendarza. Można importować tylko zdarzenia z eventType o wartości default.

Wycofane działanie: jeśli zaimportujesz zdarzenie inne niż default, jego typ zostanie zmieniony na default, a wszystkie właściwości związane z typem zdarzenia zostaną usunięte.

Wypróbuj lub zobacz przykład.

Żądanie

Żądanie HTTP

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

Parametry

Nazwa parametru Wartość Opis
Parametry ścieżki
calendarId string Identyfikator kalendarza. Aby pobrać identyfikatory kalendarzy, wywołaj metodę calendarList.list. Jeśli chcesz uzyskać dostęp do kalendarza głównego obecnie zalogowanego użytkownika, użyj narzędzia „primary” słowa kluczowego.
Opcjonalne parametry zapytania
conferenceDataVersion integer Numer wersji danych rozmów wideo obsługiwanych przez klienta interfejsu API. Wersja 0 zakłada brak obsługi danych rozmów wideo i ignoruje dane dotyczące konferencji w treści wydarzenia. Wersja 1 umożliwia obsługę kopiowania danych ConferenceData, jak również tworzenia nowych rozmów wideo przy użyciu pola createRequest of contactData. Wartość domyślna to 0. Akceptowane wartości to od 0 do 1 włącznie.
supportsAttachments boolean Określa, czy klient interfejsu API, który wykonuje operację, obsługuje załączniki zdarzeń. Opcjonalnie: Wartość domyślna to Fałsz.

Autoryzacja

To żądanie wymaga autoryzacji z co najmniej jednym z tych zakresów:

Zakres
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.events

Więcej informacji znajdziesz na stronie dotyczącej uwierzytelniania i autoryzacji.

Treść żądania

W treści żądania podaj zasób Zdarzenia z tymi właściwościami:

Nazwa usługi Wartość Opis Uwagi
Właściwości wymagane
end nested object Godzina zakończenia wydarzenia (wyłączna). W przypadku wydarzenia cyklicznego jest to czas zakończenia pierwszego wystąpienia.
iCalUID string Unikalny identyfikator zdarzenia określony w RFC5545. Służy do jednoznacznego identyfikowania wydarzeń w systemach kalendarzowych i należy go podawać podczas importowania wydarzeń za pomocą metody import.

Pamiętaj, że właściwości iCalUID i id nie są identyczne i tylko jeden z nich należy podać podczas tworzenia zdarzenia. Jedyna różnica w ich semantyce polega na tym, że w przypadku wydarzeń cyklicznych wszystkie wystąpienia określonego wydarzenia mają różne właściwości id, ale wszystkie mają takie same elementy iCalUID. Aby pobrać zdarzenie za pomocą parametru iCalUID, wywołaj metodę events.list za pomocą parametru iCalUID. Aby pobrać zdarzenie za pomocą parametru id, wywołaj metodę events.get.
start nested object Godzina rozpoczęcia wydarzenia (włącznie). W przypadku wydarzenia cyklicznego jest to godzina rozpoczęcia pierwszego wystąpienia.
Właściwości opcjonalne
anyoneCanAddSelf boolean Określa, czy każdy może zaprosić na wydarzenie samodzielnie (funkcja wycofana). Opcjonalnie: Wartość domyślna to Fałsz. z możliwością zapisu
attachments[].fileUrl string adres URL załącznika.

Aby dodać załączniki z plikami z Dysku Google, użyj tego samego formatu co we właściwości alternateLink zasobu Files w interfejsie Drive API.

Wymagane przy dodawaniu załącznika.

 z możliwością zapisu
attendees[] list Uczestnicy wydarzenia. Więcej informacji o planowaniu wydarzeń z innymi użytkownikami kalendarza znajdziesz w przewodniku Wydarzenia z uczestnikami. Aby zapełnić listę uczestników, konta usługi muszą korzystać z przekazywania uprawnień w całej domenie. z możliwością zapisu
attendees[].additionalGuests integer Liczba dodatkowych gości. Opcjonalnie: Wartość domyślna to 0. z możliwością zapisu
attendees[].comment string Komentarz uczestnika do odpowiedzi. Opcjonalnie: z możliwością zapisu
attendees[].displayName string Imię i nazwisko uczestnika (jeśli są dostępne). Opcjonalnie: z możliwością zapisu
attendees[].email string Adres e-mail uczestnika, jeśli jest dostępny. To pole musi być obecne podczas dodawania uczestnika. To musi być prawidłowy adres e-mail zgodnie z RFC5322.

Wymagane podczas dodawania uczestnika.

 z możliwością zapisu
attendees[].optional boolean Określa, czy jest to opcjonalny uczestnik. Opcjonalnie: Wartość domyślna to Fałsz. z możliwością zapisu
attendees[].resource boolean Określa, czy uczestnik jest zasobem. Można to ustawić tylko wtedy, gdy uczestnik jest dodawany do wydarzenia po raz pierwszy. Kolejne modyfikacje są ignorowane. Opcjonalnie: Wartość domyślna to Fałsz. z możliwością zapisu
attendees[].responseStatus string Stan odpowiedzi uczestnika. Możliwe wartości:
  • „needsAction” – Uczestnik nie odpowiedział na zaproszenie (zalecane w przypadku nowych wydarzeń).
  • „declined” - Uczestnik odrzucił zaproszenie.
  • „tentative” – Uczestnik wstępnie przyjął zaproszenie.
  • „accepted” - Uczestnik zaakceptował zaproszenie.
 z możliwością zapisu
attendeesOmitted boolean Określa, czy uczestnicy mogli zostać pominięci w reprezentacji wydarzenia. Podczas pobierania zdarzenia może to być spowodowane ograniczeniem określonym przez parametr zapytania maxAttendee. Podczas aktualizowania wydarzenia można użyć tych danych tylko do zmiany odpowiedzi uczestnika. Opcjonalnie: Wartość domyślna to Fałsz. z możliwością zapisu
colorId string Kolor wydarzenia. To identyfikator odnoszący się do wpisu w sekcji event definicji kolorów (patrz punkt końcowy kolorów). Opcjonalnie: z możliwością zapisu
conferenceData nested object informacje związane z konferencją, na przykład szczegóły rozmowy w Google Meet; Aby utworzyć nowe szczegóły rozmowy wideo, użyj pola createRequest. Aby zachować zmiany, ustaw parametr żądania conferenceDataVersion na 1 w przypadku wszystkich żądań modyfikacji zdarzenia. z możliwością zapisu
description string Opis wydarzenia. Może zawierać kod HTML. Opcjonalnie: z możliwością zapisu
end.date date Data w formacie „rrrr-mm-dd”, jeśli jest to wydarzenie całodniowe. z możliwością zapisu
end.dateTime datetime Czas jako połączona wartość daty i godziny (sformatowana zgodnie z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że w polu timeZone wyraźnie określisz strefę czasową. z możliwością zapisu
end.timeZone string Strefa czasowa, w której określono godzinę. (Sformatowana jako nazwa bazy danych strefy czasowej IANA, np. „Europa/Zurych”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, do której powtarza się. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia i zakończenia wydarzenia. z możliwością zapisu
extendedProperties.private object Właściwości, które są prywatne dla kopii wydarzenia widocznego w tym kalendarzu. z możliwością zapisu
extendedProperties.shared object Właściwości, które są współdzielone przez kopie wydarzenia dla innych uczestników kalendarze. z możliwością zapisu
focusTimeProperties nested object Dane zdarzenia Czas skupienia. Używana, jeśli eventType ma wartość focusTime. z możliwością zapisu
gadget.display string Tryb wyświetlania gadżetu. Rola wycofana. Możliwe wartości:
  • „icon” - Gadżet jest wyświetlany obok tytułu wydarzenia w widoku kalendarza.
  • „chip” - Gadżet wyświetla się po kliknięciu wydarzenia.
 z możliwością zapisu
gadget.height integer Wysokość gadżetu w pikselach. Wysokość musi być liczbą całkowitą większą od 0. Opcjonalnie: Rola wycofana. z możliwością zapisu
gadget.preferences object Ustawienia. z możliwością zapisu
gadget.title string Tytuł gadżetu. Rola wycofana. z możliwością zapisu
gadget.type string Typ gadżetu. Rola wycofana. z możliwością zapisu
gadget.width integer Szerokość gadżetu w pikselach. Szerokość musi być liczbą całkowitą większą od 0. Opcjonalnie: Rola wycofana. z możliwością zapisu
guestsCanInviteOthers boolean Określa, czy uczestnicy inne niż organizator mogą zapraszać na wydarzenie inne osoby. Opcjonalnie: Wartość domyślna to Prawda. z możliwością zapisu
guestsCanModify boolean Określa, czy uczestnicy inni niż organizator mogą modyfikować wydarzenie. Opcjonalnie: Wartość domyślna to Fałsz. z możliwością zapisu
guestsCanSeeOtherGuests boolean Określa, czy uczestnicy inni niż organizator mogą zobaczyć, kim są uczestnicy wydarzenia. Opcjonalnie: Wartość domyślna to Prawda. z możliwością zapisu
location string Lokalizacja geograficzna wydarzenia jako dowolny tekst. Opcjonalnie: z możliwością zapisu
organizer object Organizator wydarzenia. Jeśli organizator jest też uczestnikiem, jest to oznaczone osobną pozycją w usłudze attendees z polem organizer ustawionym na wartość True. Aby zmienić organizatora, użyj operacji przenoszenia. Tylko do odczytu, chyba że importujesz wydarzenie. z możliwością zapisu
organizer.displayName string Nazwa organizatora (jeśli jest dostępna). z możliwością zapisu
organizer.email string Adres e-mail organizatora (jeśli jest dostępny). To musi być prawidłowy adres e-mail zgodnie z RFC5322. z możliwością zapisu
originalStartTime.date date Data w formacie „rrrr-mm-dd”, jeśli jest to wydarzenie całodniowe. z możliwością zapisu
originalStartTime.dateTime datetime Czas jako połączona wartość daty i godziny (sformatowana zgodnie z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że w polu timeZone wyraźnie określisz strefę czasową. z możliwością zapisu
originalStartTime.timeZone string Strefa czasowa, w której określono godzinę. (Sformatowana jako nazwa bazy danych strefy czasowej IANA, np. „Europa/Zurych”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, do której powtarza się. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia i zakończenia wydarzenia. z możliwością zapisu
outOfOfficeProperties nested object Dane dotyczące wydarzeń poza biurem. Używana, jeśli eventType ma wartość outOfOffice. z możliwością zapisu
recurrence[] list Lista wierszy RRULE, EXRULE, RDATE i EXDATE dla wydarzenia cyklicznego, zgodnie z opisem w RFC5545. Pamiętaj, że wiersze DTSTART i DTEND są w tym polu niedozwolone. czasy rozpoczęcia i zakończenia wydarzenia są podane w polach start i end. To pole jest pomijane w przypadku pojedynczych wydarzeń lub wystąpień wydarzeń cyklicznych. z możliwością zapisu
reminders.overrides[] list Jeśli dla wydarzenia nie są używane przypomnienia domyślne, zobaczysz listę przypomnień związanych z tym wydarzeniem lub, jeśli nie zostanie skonfigurowana, wskazuje, że dla tego wydarzenia nie są ustawione żadne przypomnienia. Maksymalna liczba przypomnień o zastąpieniu to 5. z możliwością zapisu
reminders.overrides[].method string Metoda użyta w tym przypomnieniu. Możliwe wartości:
  • „email” - Przypomnienia są wysyłane e-mailem.
  • „popup” – Przypomnienia są wysyłane przez wyskakujące okienko interfejsu.

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
reminders.overrides[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, kiedy powinno wyświetlić się przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40 320 (4 tygodnie w minutach).

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
reminders.useDefault boolean Określa, czy domyślne przypomnienia kalendarza mają zastosowanie do wydarzenia. z możliwością zapisu
sequence integer Numer sekwencyjny zgodnie z iKalendarzem. z możliwością zapisu
source.title string Tytuł źródła; na przykład tytuł strony internetowej lub temat e-maila. z możliwością zapisu
source.url string Adres URL źródła wskazującego zasób. Schematem adresu URL musi być HTTP lub HTTPS. z możliwością zapisu
start.date date Data w formacie „rrrr-mm-dd”, jeśli jest to wydarzenie całodniowe. z możliwością zapisu
start.dateTime datetime Czas jako połączona wartość daty i godziny (sformatowana zgodnie z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że w polu timeZone wyraźnie określisz strefę czasową. z możliwością zapisu
start.timeZone string Strefa czasowa, w której określono godzinę. (Sformatowana jako nazwa bazy danych strefy czasowej IANA, np. „Europa/Zurych”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, do której powtarza się. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia i zakończenia wydarzenia. z możliwością zapisu
status string Stan wydarzenia. Opcjonalnie: Możliwe wartości:
  • „confirmed” – wydarzenie zostało potwierdzone. Jest to stan domyślny.
  • „tentative” – Wydarzenie jest wstępnie potwierdzone.
  • „cancelled” – Wydarzenie zostało anulowane (usunięte). Metoda list zwraca anulowane zdarzenia tylko przy synchronizacji przyrostowej (gdy określono syncToken lub updatedMin) lub jeśli flaga showDeleted jest ustawiona na true. Metoda get zawsze je zwraca.

    Stan anulowanego zdarzenia to 2 różne stany w zależności od jego typu:

    1. Anulowane wyjątki nieanulowanego wydarzenia cyklicznego wskazują, że ta instancja nie powinna już być prezentowana użytkownikowi. Klienci powinni przechowywać te zdarzenia przez cały okres trwania nadrzędnego wydarzenia cyklicznego.

      Gwarantowane, że anulowane wyjątki będą miały wypełnione tylko wartości w polach id, recurringEventId i originalStartTime. Pozostałe pola mogą być puste.

    2. Wszystkie inne anulowane wydarzenia odnoszą się do usuniętych wydarzeń. Klienci powinni usunąć swoje zsynchronizowane lokalnie kopie. Takie anulowane wydarzenia wkrótce znikną, więc nie czekaj, aż będą dostępne bezterminowo.

      Gwarantujemy, że w przypadku usuniętych wydarzeń tylko pole id będzie wypełnione.

    Anulowane wydarzenia w kalendarzu organizatora nadal zawierają szczegóły wydarzenia (podsumowanie, lokalizację itp.), aby można je było przywrócić (przywrócić). Szczegółowe informacje są też dostępne w przypadku wydarzeń, na które użytkownik został zaproszony i który został usunięty ręcznie. Jednak przyrostowe żądania synchronizacji z wartością fałsz (showDeleted) nie zwracają tych informacji.

    Jeśli organizator zmieni organizatora (na przykład w wyniku operacji move) i pierwotnego organizatora nie ma na liście uczestników, wydarzenie pozostawi anulowane wydarzenie, w którym tylko pole id zostanie wypełnione.

z możliwością zapisu
summary string Nazwa wydarzenia, z możliwością zapisu
transparency string Określa, czy wydarzenie ma blokować czas w kalendarzu. Opcjonalnie: Możliwe wartości:
  • „opaque” – wartość domyślna. Wydarzenie nie zablokuje czasu w kalendarzu. Odpowiada to ustawieniu Pokaż mój stan jako na Zajęty w interfejsie Kalendarza.
  • „transparent” – Wydarzenie nie blokuje czasu w kalendarzu. Jest to odpowiednik ustawienia Pokaż mój stan jako na Dostępny w interfejsie Kalendarza.
 z możliwością zapisu
visibility string Widoczność wydarzenia. Opcjonalnie: Możliwe wartości:
  • „default” – Korzysta z domyślnej widoczności wydarzeń w kalendarzu. jest to wartość domyślna
  • „public” - Wydarzenie jest publiczne, a jego szczegóły są widoczne dla wszystkich czytelników kalendarza.
  • „private” – Wydarzenie jest prywatne i tylko jego uczestnicy mogą wyświetlać jego szczegóły.
  • „confidential” – Wydarzenie jest prywatne. Ta wartość jest podawana ze względu na zgodność.
 z możliwością zapisu

Odpowiedź

Jeśli operacja się uda, metoda zwróci zasób Zdarzenia w treści odpowiedzi.

Przykłady

Uwaga: dostępne dla tej metody przykłady kodu nie odzwierciedlają wszystkich obsługiwanych języków programowania. Listę obsługiwanych języków znajdziesz na stronie z bibliotekami klienta.

Java

Używa biblioteki klienta Java.

import com.google.api.services.calendar.Calendar;
import com.google.api.services.calendar.model.Event;
import com.google.api.services.calendar.model.EventAttendee;
import com.google.api.services.calendar.model.EventDateTime;
import com.google.api.client.util.DateTime;

import java.util.Date;
// ...

// Initialize Calendar service with valid OAuth credentials
Calendar service = new Calendar.Builder(httpTransport, jsonFactory, credentials)
    .setApplicationName("applicationName").build();

// Create and initialize a new event (could also retrieve an existing event)
Event event = new Event();
event.setICalUID("originalUID");

Event.Organizer organizer = new Event.Organizer();
organizer.setEmail("organizerEmail");
organizer.setDisplayName("organizerDisplayName");
event.setOrganizer(organizer);

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

Date startDate = new Date();
Date endDate = new Date(startDate.getTime() + 3600000);
DateTime start = new DateTime(startDate, TimeZone.getTimeZone("UTC"));
event.setStart(new EventDateTime().setDateTime(start));
DateTime end = new DateTime(endDate, TimeZone.getTimeZone("UTC"));
event.setEnd(new EventDateTime().setDateTime(end));

// Import the event into a calendar
Event importedEvent = service.events().calendarImport('primary', event).execute();

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

Python

Używa biblioteki klienta w Pythonie.

event = {
  'summary': 'Appointment',
  'location': 'Somewhere',
  'organizer': {
    'email': 'organizerEmail',
    'displayName': 'organizerDisplayName'
  },
  'start': {
    'dateTime': '2011-06-03T10:00:00.000-07:00'
  },
  'end': {
    'dateTime': '2011-06-03T10:25:00.000-07:00'
  },
  'attendees': [
    {
      'email': 'attendeeEmail',
      'displayName': 'attendeeDisplayName',
    },
    # ...
  ],
  'iCalUID': 'originalUID'
}

imported_event = service.events().import_(calendarId='primary', body=event).execute()

print imported_event['id']

PHP

Używa biblioteki klienta 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');
$event->setStart($start);
$end = new Google_Service_Calendar_EventDateTime();
$end->setDateTime('2011-06-03T10:25:00.000-07:00');
$event->setEnd($end);
$attendee1 = new Google_Service_Calendar_EventAttendee();
$attendee1->setEmail('attendeeEmail');
// ...
$attendees = array($attendee1,
                   // ...,
                  );
$event->attendees = $attendees;
$organizer = new Google_Service_Calendar_EventOrganizer();
$organizer->setEmail('organizerEmail');
$organizer->setDisplayName('organizerDisplayName');
$event->setOrganizer($organizer);
$event->setICalUID('originalUID');
$importedEvent = $service->events->import('primary', $event);

echo $importedEvent->getId();

Ruby

Używa biblioteki klienta Ruby.

event = Google::Apis::CalendarV3::Event.new(
  summary: 'Appointment',
  location: 'Somewhere',
  organizer: {
    email: 'organizerEmail',
    display_name: 'organizerDisplayName'
  },
  start: {
    date_time: '2011-06-03T10:00:00.000-07:00'
  },
  end: {
    date_time: '2011-06-03T10:25:00.000-07:00'
  },
  attendees: [
    {
      email: 'attendeeEmail',
      display_name: 'attendeeDisplayName',
    },
    # ...
  ],
  i_cal_uid: 'originalUID'
)
result = client.import_event('primary', event)
print result.id

Wypróbuj

Użyj poniższego eksploratora interfejsów API, aby wywołać tę metodę na bieżących danych i wyświetlić odpowiedź.