Events: insert

Utworzy wydarzenie. Wypróbuj teraz

Żądanie

Żądanie HTTP

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

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 podstawowego aktualnie zalogowanego użytkownika, użyj słowa kluczowego „primary”.
Opcjonalne parametry zapytania
conferenceDataVersion integer Numer wersji danych konferencji obsługiwanych przez klienta interfejsu API. Wersja 0 zakłada brak obsługi danych konferencji i ignoruje dane konferencji w treści wydarzenia. Wersja 1 umożliwia kopiowanie obiektu ConferenceData oraz tworzenie nowych rozmów wideo za pomocą pola createRequest obiektu conferenceData. Wartość domyślna to 0. Akceptowane wartości to od 0 do 1 włącznie.
maxAttendees integer Maksymalna liczba uczestników, których można uwzględnić w odpowiedzi. Jeśli uczestników jest więcej niż określona liczba, zwracany jest tylko uczestnik. Opcjonalnie.
sendNotifications boolean Rola wycofana. Zamiast niego użyj sendUpdates.

Określa, czy wysyłać powiadomienia o utworzeniu nowego zdarzenia. Pamiętaj, że niektóre e-maile mogą być nadal wysyłane, nawet jeśli ustawisz wartość false. Wartość domyślna to false.
sendUpdates string Określa, czy wysyłać powiadomienia o utworzeniu nowego wydarzenia. Pamiętaj, że niektóre e-maile mogą nadal być wysyłane. Wartość domyślna to false.

Akceptowane wartości:
  • „all”: powiadomienia są wysyłane do wszystkich gości.
  • „externalOnly”: powiadomienia są wysyłane tylko do gości spoza Kalendarza Google.
  • „none”: nie są wysyłane żadne powiadomienia.
supportsAttachments boolean Określa, czy klient API wykonujący operację obsługuje załączniki do wydarzeń. Opcjonalnie. Wartość domyślna to False (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
https://www.googleapis.com/auth/calendar.app.created
https://www.googleapis.com/auth/calendar.events.owned

Więcej informacji znajdziesz na stronie Uwierzytelnianie i autoryzacja.

Treść żądania

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

Nazwa usługi Wartość Opis Uwagi
Wymagane właściwości
end nested object Godzina zakończenia wydarzenia (wyłącznie). W przypadku wydarzenia cyklicznego jest to czas zakończenia pierwszego wystąpienia.
start nested object Czas rozpoczęcia wydarzenia (włącznie z wartościami granicznymi). W przypadku wydarzenia cyklicznego jest to czas rozpoczęcia pierwszego wystąpienia.
Właściwości opcjonalne
anyoneCanAddSelf boolean Określa, czy każdy może zaprosić się na wydarzenie (wartość wycofana). Opcjonalnie. Wartość domyślna to False (fałsz). z możliwością zapisu,
attachments[].fileUrl string Link URL do załącznika.

Do dodawania załączników z Dysku Google używaj tego samego formatu co we właściwości alternateLink zasobu Files w interfejsie Drive API.

Wymagane podczas dodawania 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 wypełnić listę uczestników, konta usługi muszą korzystać z przekazywania dostępu 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. Musi to być prawidłowy adres e-mail zgodnie z RFC5322.

Wymagane podczas dodawania uczestnika.

 z możliwością zapisu,
attendees[].optional boolean Określ, czy uczestnik jest opcjonalny. Opcjonalnie. Wartość domyślna to False (fałsz). z możliwością zapisu,
attendees[].resource boolean Określa, czy uczestnik jest zasobem. Można ustawić tylko wtedy, gdy uczestnik jest dodawany do wydarzenia po raz pierwszy. Kolejne modyfikacje są ignorowane. Opcjonalnie. Wartość domyślna to False (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 zaakceptował zaproszenie.
  • „accepted” – uczestnik zaakceptował zaproszenie.
 z możliwością zapisu,
birthdayProperties nested object dane dotyczące urodzin lub specjalnych wydarzeń; Używane, jeśli wartość parametru eventType to "birthday". Niezmienne. z możliwością zapisu,
birthdayProperties.type string Rodzaj urodzin lub specjalnego wydarzenia. Możliwe wartości:
  • "anniversary" – rocznica inna niż urodziny. Zawsze ma contact.
  • "birthday" – wydarzenie związane z urodzinami. Jest to wartość domyślna.
  • "custom" – specjalna data, której etykieta jest określona w polu customTypeName. Zawsze ma contact.
  • "other" – specjalna data, która nie pasuje do innych kategorii i nie ma niestandardowej etykiety. Zawsze ma contact.
  • "self" – urodziny właściciela kalendarza. Nie może zawierać contact.
Interfejs Calendar API obsługuje tylko tworzenie wydarzeń typu "birthday". Po utworzeniu wydarzenia nie można zmienić jego typu.		 z możliwością zapisu,
colorId string Kolor wydarzenia. Jest 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 rozmową wideo, np. szczegóły rozmowy wideo w Google Meet. Aby utworzyć nowe szczegóły konferencji, użyj pola createRequest. Aby zachować zmiany, pamiętaj, aby w przypadku wszystkich żądań modyfikacji zdarzeń ustawić parametr żądania conferenceDataVersion na 1. 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 ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w timeZone. z możliwością zapisu,
end.timeZone string Strefa czasowa, w której podano czas. (W formacie nazwy z bazy danych stref czasowych IANA, np. „Europe/Zurich”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozwijane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia lub zakończenia wydarzenia. z możliwością zapisu,
eventType string Konkretny typ zdarzenia. Po utworzeniu wydarzenia nie można zmienić tego ustawienia. Możliwe wartości:
  • „birthday” – specjalne wydarzenie całodniowe, które powtarza się co roku.
  • „default” – zwykłe wydarzenie lub nieokreślone.
  • „focusTime” – wydarzenie czasu skupienia.
  • „fromGmail” – wydarzenie z Gmaila. Nie można utworzyć tego typu wydarzenia.
  • „outOfOffice” – wydarzenie poza biurem.
  • „workingLocation” – zdarzenie związane z lokalizacją miejsca pracy.
 z możliwością zapisu,
extendedProperties.private object Właściwości, które są prywatne w kopii wydarzenia wyświetlanej w tym kalendarzu. z możliwością zapisu,
extendedProperties.shared object Właściwości, które są udostępniane między kopiami wydarzenia w kalendarzach innych uczestników. z możliwością zapisu,
focusTimeProperties nested object dane wydarzenia typu czas skupienia; Używane, jeśli wartość parametru eventType to focusTime. z możliwością zapisu,
gadget.display string Tryb wyświetlania gadżetu. Rola wycofana. Możliwe wartości:
  • „icon” – gadżet wyświetla się obok tytułu wydarzenia w widoku kalendarza.
  • „chip” – gadżet wyświetla się po kliknięciu zdarzenia.
 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 inni niż organizator mogą zapraszać inne osoby na wydarzenie. Opcjonalnie. Wartość domyślna to True. z możliwością zapisu,
guestsCanModify boolean Czy uczestnicy inni niż organizator mogą modyfikować wydarzenie. Opcjonalnie. Wartość domyślna to False (fałsz). z możliwością zapisu,
guestsCanSeeOtherGuests boolean Określa, czy uczestnicy inni niż organizator mogą zobaczyć, kto bierze udział w wydarzeniu. Opcjonalnie. Wartość domyślna to True. z możliwością zapisu,
id string Nieprzezroczysty identyfikator zdarzenia. Podczas tworzenia nowych wydarzeń jednorazowych lub cyklicznych możesz określić ich identyfikatory. Podane identyfikatory muszą być zgodne z tymi regułami:
  • Dozwolone znaki w identyfikatorze to znaki używane w kodowaniu base32hex, czyli małe litery a–v i cyfry 0–9.Więcej informacji znajdziesz w sekcji 3. 1.2 w RFC2938.
  • długość identyfikatora musi wynosić od 5 do 1024 znaków;
  • identyfikator musi być unikalny w przypadku każdego kalendarza;
Ze względu na globalny charakter systemu nie możemy zagwarantować, że kolizje identyfikatorów zostaną wykryte w momencie tworzenia zdarzenia. Aby zminimalizować ryzyko kolizji, zalecamy używanie sprawdzonego algorytmu UUID, takiego jak opisany w dokumencie RFC4122.

Jeśli nie podasz identyfikatora, zostanie on automatycznie wygenerowany przez serwer.

Pamiętaj, że tagi icalUID i id nie są identyczne i podczas tworzenia zdarzenia należy podać tylko jeden z nich. Jedną z różnic w ich semantyce jest to, że w przypadku wydarzeń cyklicznych wszystkie wystąpienia jednego wydarzenia mają różne id, ale wszystkie mają te same icalUID.

 z możliwością zapisu,
location string Geograficzna lokalizacja wydarzenia w formie dowolnego tekstu. Opcjonalnie. 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 ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w timeZone. z możliwością zapisu,
originalStartTime.timeZone string Strefa czasowa, w której podano czas. (W formacie nazwy z bazy danych stref czasowych IANA, np. „Europe/Zurich”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozwijane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia lub zakończenia wydarzenia. z możliwością zapisu,
outOfOfficeProperties nested object Dane o wydarzeniach poza biurem. Używane, jeśli wartość parametru eventType to outOfOffice. z możliwością zapisu,
recurrence[] list Lista wierszy RRULE, EXRULE, RDATE i EXDATE dla wydarzenia cyklicznego zgodnie ze specyfikacją RFC5545. Pamiętaj, że w tym polu nie są dozwolone wiersze DTSTART i DTEND. Godziny 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 wydarzenie nie korzysta z domyślnych przypomnień, ta sekcja zawiera listę przypomnień dotyczących konkretnego wydarzenia lub informację, że dla tego wydarzenia nie ustawiono żadnych przypomnień. Maksymalna liczba przypomnień o zastąpieniu to 5. z możliwością zapisu,
reminders.overrides[].method string Metoda użyta przez to przypomnienie. Możliwe wartości:
  • „email” – przypomnienia są wysyłane e-mailem.
  • „popup” – przypomnienia są wysyłane w wyskakującym okienku interfejsu.

Wymagane podczas dodawania przypomnienia.

 z możliwością zapisu,
reminders.overrides[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, po upływie których ma się pojawić przypomnienie. Prawidłowe wartości to od 0 do 40 320 (4 tygodnie w minutach).

Wymagane podczas dodawania przypomnienia.

 z możliwością zapisu,
reminders.useDefault boolean Określa, czy do wydarzenia mają zastosowanie domyślne przypomnienia z kalendarza. z możliwością zapisu,
sequence integer Numer sekwencyjny zgodny z formatem iCalendar. z możliwością zapisu,
source.title string Tytuł źródła, np. tytuł strony internetowej lub temat e-maila. z możliwością zapisu,
source.url string Adres URL źródła wskazujący zasób. Schemat 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 ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w timeZone. z możliwością zapisu,
start.timeZone string Strefa czasowa, w której podano czas. (W formacie nazwy z bazy danych stref czasowych IANA, np. „Europe/Zurich”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozwijane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia lub zakończenia wydarzenia. z możliwością zapisu,
status string Stan zdarzenia. 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 wydarzenia tylko w przypadku synchronizacji przyrostowej (gdy określono syncToken lub updatedMin) lub jeśli flaga showDeleted ma wartość true. Metoda get zawsze je zwraca.

    Stan anulowania reprezentuje 2 różne stany w zależności od typu zdarzenia:

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

      W przypadku anulowanych wyjątków gwarantujemy tylko wypełnienie pól id, recurringEventId i originalStartTime. Pozostałe pola mogą być puste.

    2. Wszystkie inne odwołane wydarzenia to usunięte wydarzenia. Klienci powinni usunąć lokalnie zsynchronizowane kopie. Takie odwołane wydarzenia znikną z czasem, więc nie możesz zakładać, że będą dostępne bezterminowo.

      W przypadku usuniętych zdarzeń gwarantujemy tylko wypełnienie pola id.

    W kalendarzu organizatora anulowane wydarzenia nadal zawierają szczegóły (podsumowanie, lokalizacja itp.), dzięki czemu można je przywrócić (cofnąć usunięcie). Podobnie zdarzenia, na które użytkownik został zaproszony i które ręcznie usunął, nadal dostarczają szczegółowych informacji. Żądania synchronizacji przyrostowej z parametrem showDeleted ustawionym na wartość false nie zwrócą jednak tych szczegółów.

    Jeśli organizator wydarzenia zmieni się (np. w wyniku operacji move), a pierwotny organizator nie znajduje się na liście uczestników, pozostanie po nim anulowane wydarzenie, w którym tylko pole id będzie na pewno wypełnione.

z możliwością zapisu,
summary string Nazwa wydarzenia, z możliwością zapisu,
transparency string Czy wydarzenie blokuje czas w kalendarzu. Opcjonalnie. Możliwe wartości:
  • „opaque” – wartość domyślna. Wydarzenie blokuje czas w kalendarzu. Odpowiada to ustawieniu w interfejsie Kalendarza opcji Wyświetlaj mnie jako na Zajęty.
  • „transparent” – wydarzenie nie blokuje czasu w kalendarzu. Odpowiada to ustawieniu opcji Wyświetlaj mnie jako na Dostępny w interfejsie Kalendarza.
 z możliwością zapisu,
visibility string Widoczność wydarzenia. Opcjonalnie. Możliwe wartości:
  • „default” – używa domyślnej widoczności wydarzeń w kalendarzu. Jest to wartość domyślna.
  • „public” – wydarzenie jest publiczne, a szczegóły wydarzenia są widoczne dla wszystkich osób, które mają dostęp do kalendarza.
  • „private” – wydarzenie jest prywatne i tylko 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,
workingLocationProperties nested object Dane o miejscu pracy. z możliwością zapisu,
workingLocationProperties.customLocation object Jeśli jest obecny, oznacza, że użytkownik pracuje z niestandardowej lokalizacji. z możliwością zapisu,
workingLocationProperties.customLocation.label string Opcjonalna dodatkowa etykieta z dodatkowymi informacjami. z możliwością zapisu,
workingLocationProperties.homeOffice any value Jeśli jest obecny, określa, że użytkownik pracuje w domu. z możliwością zapisu,
workingLocationProperties.officeLocation object Jeśli ta opcja jest dostępna, oznacza, że użytkownik pracuje w biurze. z możliwością zapisu,
workingLocationProperties.officeLocation.buildingId string Opcjonalny identyfikator budynku. Powinien on odwoływać się do identyfikatora budynku w bazie danych zasobów organizacji. z możliwością zapisu,
workingLocationProperties.officeLocation.deskId string Opcjonalny identyfikator biurka. z możliwością zapisu,
workingLocationProperties.officeLocation.floorId string Opcjonalny identyfikator piętra. z możliwością zapisu,
workingLocationProperties.officeLocation.floorSectionId string Opcjonalny identyfikator obszaru piętra. z możliwością zapisu,
workingLocationProperties.officeLocation.label string Nazwa biura wyświetlana w Kalendarzu w przeglądarce i na urządzeniach mobilnych. Zalecamy odwoływanie się do nazwy budynku w bazie danych zasobów organizacji. z możliwością zapisu,
workingLocationProperties.type string Typ lokalizacji miejsca pracy. Możliwe wartości:
  • „homeOffice” – użytkownik pracuje w domu.
  • „officeLocation” – użytkownik pracuje w biurze.
  • „customLocation” – użytkownik pracuje z niestandardowej lokalizacji.
 Wszelkie szczegóły są podane w polu podrzędnym o określonej nazwie, ale to pole może być puste. Pozostałe pola są ignorowane.

Wymagane podczas dodawania właściwości lokalizacji miejsca pracy.

 z możliwością zapisu,

Odpowiedź

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

Wypróbuj

Użyj narzędzia APIs Explorer poniżej, aby wywołać tę metodę na danych na żywo i zobaczyć odpowiedź.