Utworzy wydarzenie. Wypróbuj teraz
Żądanie
Żądanie HTTP
POST https://www.googleapis.com/calendar/v3/calendars/calendarId/eventsParametry
| 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 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, a także 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.
|
eventLabelVersion |
integer |
Numer wersji funkcji etykiety zdarzenia obsługiwanej przez klienta API. Wersja 0 zakłada brak obsługi etykiety zdarzenia i przetwarza pole colorId na potrzeby zarządzania kolorami. Wersja 1 umożliwia obsługę etykiet zdarzeń i przetwarza parametr eventLabelId w treści zdarzenia. W takim przypadku pole colorId jest ignorowane. Wartość domyślna to 0.
Akceptowane wartości to od 0 do 1 włącznie.
|
maxAttendees |
integer |
Maksymalna liczba uczestników, których należy 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:
|
supportsAttachments |
boolean |
Określa, czy klient API wykonujący operację obsługuje załączniki do zdarzeń. 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 |
Godzina 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 (wycofane). 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 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 dotyczący 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:
|
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:
"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 i zakończenia wydarzenia. | z możliwością zapisu, |
eventLabelId |
string |
Identyfikator etykiety zdarzenia przypisanej do zdarzenia. Opcjonalnie. Odwołuje się do identyfikatora wpisu we właściwości labelProperties.eventLabels kalendarza (patrz punkt końcowy Calendars.get). Ta właściwość zastępuje właściwość Ustawienie pustego ciągu znaków lub nieustawienie tego pola spowoduje usunięcie z wydarzenia dotychczasowej etykiety. |
z możliwością zapisu, |
eventType |
string |
Konkretny typ zdarzenia. Po utworzeniu wydarzenia nie można zmienić tego ustawienia. Możliwe wartości:
|
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:
|
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.iconLink |
string |
Adres URL ikony gadżetu. Schemat URI adresu URL musi być HTTPS. Rola wycofana. | z możliwością zapisu, |
gadget.link |
string |
Adres URL gadżetu. Schemat URI adresu URL musi być HTTPS. 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:
Jeśli nie podasz identyfikatora, zostanie on automatycznie wygenerowany przez serwer. Pamiętaj, że tagi |
z możliwością zapisu, |
location |
string |
Położenie geograficzne 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 i zakończenia wydarzenia. | z możliwością zapisu, |
outOfOfficeProperties |
nested object |
dane wydarzeń 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:
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 40320 (4 tygodnie w minutach). Wymagane podczas dodawania przypomnienia. |
z możliwością zapisu, |
reminders.useDefault |
boolean |
Określa, czy domyślne przypomnienia z kalendarza mają zastosowanie do wydarzenia. | 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 URI 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 i zakończenia wydarzenia. | z możliwością zapisu, |
status |
string |
Stan zdarzenia. Opcjonalnie. Możliwe wartości:
|
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:
|
z możliwością zapisu, |
visibility |
string |
Widoczność wydarzenia. Opcjonalnie. Możliwe wartości:
|
z możliwością zapisu, |
workingLocationProperties |
nested object |
Dane o wydarzeniu dotyczącym lokalizacji miejsca 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:
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ź.