Interfejs Calendar API udostępnia różne rodzaje zasobów dotyczących wydarzeń. Więcej informacji znajdziesz w artykule Informacje o wydarzeniach.
Listę metod dla tego zasobu znajdziesz na końcu tej strony.
Reprezentacje zasobów
{ "kind": "calendar#event", "etag": etag, "id": string, "status": string, "htmlLink": string, "created": datetime, "updated": datetime, "summary": string, "description": string, "location": string, "colorId": string, "creator": { "id": string, "email": string, "displayName": string, "self": boolean }, "organizer": { "id": string, "email": string, "displayName": string, "self": boolean }, "start": { "date": date, "dateTime": datetime, "timeZone": string }, "end": { "date": date, "dateTime": datetime, "timeZone": string }, "endTimeUnspecified": boolean, "recurrence": [ string ], "recurringEventId": string, "originalStartTime": { "date": date, "dateTime": datetime, "timeZone": string }, "transparency": string, "visibility": string, "iCalUID": string, "sequence": integer, "attendees": [ { "id": string, "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } ], "attendeesOmitted": boolean, "extendedProperties": { "private": { (key): string }, "shared": { (key): string } }, "hangoutLink": string, "conferenceData": { "createRequest": { "requestId": string, "conferenceSolutionKey": { "type": string }, "status": { "statusCode": string } }, "entryPoints": [ { "entryPointType": string, "uri": string, "label": string, "pin": string, "accessCode": string, "meetingCode": string, "passcode": string, "password": string } ], "conferenceSolution": { "key": { "type": string }, "name": string, "iconUri": string }, "conferenceId": string, "signature": string, "notes": string, }, "gadget": { "type": string, "title": string, "link": string, "iconLink": string, "width": integer, "height": integer, "display": string, "preferences": { (key): string } }, "anyoneCanAddSelf": boolean, "guestsCanInviteOthers": boolean, "guestsCanModify": boolean, "guestsCanSeeOtherGuests": boolean, "privateCopy": boolean, "locked": boolean, "reminders": { "useDefault": boolean, "overrides": [ { "method": string, "minutes": integer } ] }, "source": { "url": string, "title": string }, "workingLocationProperties": { "type": string, "homeOffice": (value), "customLocation": { "label": string }, "officeLocation": { "buildingId": string, "floorId": string, "floorSectionId": string, "deskId": string, "label": string } }, "outOfOfficeProperties": { "autoDeclineMode": string, "declineMessage": string }, "focusTimeProperties": { "autoDeclineMode": string, "declineMessage": string, "chatStatus": string }, "attachments": [ { "fileUrl": string, "title": string, "mimeType": string, "iconLink": string, "fileId": string } ], "eventType": string }
Nazwa usługi | Wartość | Opis | Uwagi |
---|---|---|---|
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[] |
list |
Pliki załączników dla wydarzenia. Aby można było modyfikować załączniki, parametr żądania Wydarzenie może mieć maksymalnie 25 załączników. |
|
attachments[].fileId |
string |
Identyfikator załączonego pliku. Tylko do odczytu. W przypadku plików na Dysku Google jest to identyfikator odpowiedniego wpisu zasobu |
|
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 Wymagane przy dodawaniu załącznika. |
z możliwością zapisu |
attachments[].iconLink |
string |
Adres URL ikony załącznika. To pole można modyfikować tylko w przypadku niestandardowych załączników innych firm. | |
attachments[].mimeType |
string |
Internetowy typ nośnika (typ MIME) załącznika. | |
attachments[].title |
string |
Tytuł załącznika. | |
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żesz użyć tej opcji tylko do zaktualizowania odpowiedzi uczestnika. Opcjonalnie: Wartość domyślna to Fałsz. |
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[].id |
string |
Identyfikator profilu uczestnika (jeśli jest dostępny). | |
attendees[].optional |
boolean |
Określa, czy jest to opcjonalny uczestnik. Opcjonalnie: Wartość domyślna to Fałsz. | z możliwością zapisu |
attendees[].organizer |
boolean |
Określa, czy uczestnik jest organizatorem wydarzenia. Tylko do odczytu. Wartość domyślna to Fałsz. | |
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:
|
z możliwością zapisu |
attendees[].self |
boolean |
Określa, czy ten wpis reprezentuje kalendarz, w którym występuje ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to Fałsz. | |
colorId |
string |
Kolor zdarzenia. 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 |
conferenceData.conferenceId |
string |
Identyfikator konferencji. Może być używany przez deweloperów do śledzenia konferencji; nie powinien być wyświetlany użytkownikom. Wartość identyfikatora jest formatowana inaczej w zależności od typu rozwiązania do obsługi konferencji:
|
|
conferenceData.conferenceSolution |
nested object |
rozwiązanie do obsługi rozmów wideo, takie jak Google Meet; Anuluj ustawienie dla rozmowy wideo z nieudanym żądaniem utworzenia. Wymagany jest element |
|
conferenceData.conferenceSolution.iconUri |
string |
Ikona tego rozwiązania widoczna dla użytkownika. | |
conferenceData.conferenceSolution.key |
nested object |
Klucz, który umożliwia jednoznaczne zidentyfikowanie rozwiązania do obsługi konferencji dla tego wydarzenia. | |
conferenceData.conferenceSolution.key.type |
string |
Typ rozwiązania konferencyjnego. Jeśli klient napotka nieznany lub pusty typ, nadal powinien być w stanie wyświetlić punkty wejścia. Nie powinno to jednak uniemożliwić wprowadzania zmian. Możliwe wartości to:
|
|
conferenceData.conferenceSolution.name |
string |
Nazwa tego rozwiązania widoczna dla użytkowników. Brak lokalizacji. | |
conferenceData.createRequest |
nested object |
prośbę o wygenerowanie nowej rozmowy wideo i dołączenie jej do wydarzenia. Dane są generowane asynchronicznie. Aby sprawdzić, czy dane są dostępne, sprawdź pole status . Wymagany jest element |
|
conferenceData.createRequest.conferenceSolutionKey |
nested object |
rozwiązanie do obsługi konferencji, na przykład Hangouts lub Google Meet; | |
conferenceData.createRequest.conferenceSolutionKey.type |
string |
Typ rozwiązania do obsługi rozmów wideo. Jeśli klient napotka nieznany lub pusty typ, nadal powinien być w stanie wyświetlić punkty wejścia. Nie powinno to jednak uniemożliwić wprowadzania zmian. Możliwe wartości to:
|
|
conferenceData.createRequest.requestId |
string |
Wygenerowany przez klienta unikalny identyfikator dla tego żądania. Klienci powinni ponownie wygenerować ten identyfikator dla każdego nowego żądania. Jeśli podany identyfikator jest taki sam jak w poprzednim żądaniu, zostanie zignorowane. |
|
conferenceData.createRequest.status |
nested object |
Stan prośby o utworzenie rozmowy wideo. | |
conferenceData.createRequest.status.statusCode |
string |
Bieżący stan prośby o utworzenie rozmowy wideo. Tylko do odczytu. Możliwe wartości to:
|
|
conferenceData.entryPoints[] |
list |
Informacje o punktach wejścia na poszczególne konferencje, takie jak adresy URL lub numery telefonów. Wszystkie muszą należeć do tej samej konferencji. Wymagany jest element |
|
conferenceData.entryPoints[].accessCode |
string |
Kod dostępu do rozmowy wideo. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór { Opcjonalnie: |
|
conferenceData.entryPoints[].entryPointType |
string |
Typ punktu wejścia do konferencji. Możliwe wartości to:
|
|
conferenceData.entryPoints[].label |
string |
Etykieta identyfikatora URI. Widoczny dla użytkowników. Brak lokalizacji. Maksymalna długość to 512 znaków. Przykłady:
Opcjonalnie: |
|
conferenceData.entryPoints[].meetingCode |
string |
Kod spotkania umożliwiający dostęp do konferencji. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór { Opcjonalnie: |
|
conferenceData.entryPoints[].passcode |
string |
Hasło umożliwiające dostęp do konferencji. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór { |
|
conferenceData.entryPoints[].password |
string |
Hasło umożliwiające dostęp do konferencji. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór { Opcjonalnie: |
|
conferenceData.entryPoints[].pin |
string |
Kod PIN umożliwiający dostęp do konferencji. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór { Opcjonalnie: |
|
conferenceData.entryPoints[].uri |
string |
Identyfikator URI punktu wejścia. Maksymalna długość to 1300 znaków. Format:
|
|
conferenceData.notes |
string |
Dodatkowe uwagi (na przykład instrukcje od administratora domeny czy informacje prawne) do wyświetlenia użytkownikowi. Może zawierać kod HTML. Maksymalna długość to 2048 znaków. Opcjonalnie: | |
conferenceData.signature |
string |
Podpis danych rozmowy wideo. Wygenerowano po stronie serwera. Anuluj ustawienie dla rozmowy wideo z nieudanym żądaniem utworzenia. Opcjonalne w przypadku rozmowy wideo z oczekującą prośbą o utworzenie. |
|
created |
datetime |
Czas utworzenia zdarzenia (w postaci sygnatury czasowej RFC3339). Tylko do odczytu. | |
creator |
object |
Twórca wydarzenia. Tylko do odczytu. | |
creator.displayName |
string |
Nazwa twórcy (jeśli jest dostępna). | |
creator.email |
string |
Adres e-mail twórcy (jeśli jest dostępny). | |
creator.id |
string |
Identyfikator profilu twórcy (jeśli jest dostępny). | |
creator.self |
boolean |
Określa, czy twórca odpowiada kalendarzowi, w którym znajduje się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to Fałsz. | |
description |
string |
Opis wydarzenia. Może zawierać kod HTML. Opcjonalnie: | z możliwością zapisu |
end |
nested object |
Godzina zakończenia wydarzenia (wyłączna). W przypadku wydarzenia cyklicznego jest to czas zakończenia pierwszego wystąpienia. | |
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ą. |
zapisywalny |
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. | zapisywalny |
endTimeUnspecified |
boolean |
Określa, czy godzina zakończenia jest faktycznie nieokreślona. Ze względu na zgodność z zasadami godzina zakończenia jest nadal podawana, nawet jeśli ten atrybut ma wartość Prawda. Wartość domyślna to Fałsz. | |
etag |
etag |
Tag ETag zasobu. | |
eventType |
string |
Konkretny typ zdarzenia. Po utworzeniu wydarzenia nie można zmienić tej wartości. Możliwe wartości:
|
z możliwością zapisu |
extendedProperties |
object |
Rozszerzone właściwości zdarzenia. | |
extendedProperties.private |
object |
Właściwości, które są prywatne dla kopii wydarzenia widocznego w tym kalendarzu. | z możliwością zapisu |
extendedProperties.private.(key) |
string |
Nazwa właściwości prywatnej i odpowiadająca jej wartość. | |
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 |
extendedProperties.shared.(key) |
string |
Nazwa współdzielonej właściwości i odpowiadająca jej wartość. | |
focusTimeProperties |
nested object |
Dane zdarzenia typu Czas skupienia. Używana, jeśli eventType ma wartość focusTime . |
z możliwością zapisu |
focusTimeProperties.autoDeclineMode |
string |
Określa, czy odrzucać zaproszenia na spotkania, które nakładają się na wydarzenia typu czas skupienia. Prawidłowe wartości to declineNone , co oznacza, że żadne zaproszenia na spotkania nie są odrzucane. declineAllConflictingInvitations , co oznacza, że wszystkie zaproszenia na spotkania będące w konflikcie i kolidujące z wydarzeniem są odrzucane. i declineOnlyNewConflictingInvitations , co oznacza, że będą odrzucane tylko nowe zaproszenia na spotkania będące w konflikcie, które dotarły w czasie trwania wydarzenia Czas skupienia. |
|
focusTimeProperties.chatStatus |
string |
Stan umożliwiający oznaczenie użytkownika w Google Chat i powiązanych usługach. Może to być available lub doNotDisturb . |
|
focusTimeProperties.declineMessage |
string |
Komunikat z opcją określenia, czy istniejące lub nowe zaproszenie mają być automatycznie odrzucane przez Kalendarz. | |
gadget |
object |
Gadżet rozszerzający to wydarzenie. Gadżety zostały wycofane. jest używana tylko do zwracania metadanych kalendarza urodzin. | |
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. Schematem adresu URL musi być HTTPS. Rola wycofana. | z możliwością zapisu |
gadget.link |
string |
Adres URL gadżetu. Schematem adresu URL musi być HTTPS. Rola wycofana. | zapisywalny |
gadget.preferences |
object |
Ustawienia. | z możliwością zapisu |
gadget.preferences.(key) |
string |
Nazwa preferencji i odpowiadająca jej wartość. | |
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 |
hangoutLink |
string |
Bezwzględny link do spotkania Google powiązanego z tym wydarzeniem. Tylko do odczytu. | |
htmlLink |
string |
link do tego wydarzenia w interfejsie internetowym Kalendarza Google. Tylko do odczytu. | |
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 |
|
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 określisz identyfikatora, zostanie on wygenerowany automatycznie przez serwer. Pamiętaj, że właściwości |
z możliwością zapisu |
kind |
string |
Typ zasobu („calendar#event ”). |
|
location |
string |
Lokalizacja geograficzna wydarzenia jako dowolny tekst. Opcjonalnie: | z możliwością zapisu |
locked |
boolean |
Czy jest to zablokowana kopia zdarzenia, w której nie można wprowadzić żadnych zmian w głównych polach zdarzenia „podsumowanie”, „opis”, „lokalizacja”, „start”, „koniec” czy „powtarzanie”. Wartość domyślna to Fałsz. Tylko do odczytu. | |
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 |
organizer.id |
string |
Identyfikator profilu organizatora (jeśli jest dostępny). | |
organizer.self |
boolean |
Określa, czy organizator odpowiada kalendarzowi, w którym znajduje się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to False (fałsz). | |
originalStartTime |
nested object |
W przypadku wydarzenia cyklicznego jest to godzina rozpoczęcia wydarzenia zgodnie z danymi cyklicznymi wydarzenia cyklicznego identyfikowanymi przez identyfikator zdarzenia cyklicznego. Jednoznacznie identyfikuje wystąpienie w serii zdarzeń cyklicznych, nawet jeśli wystąpienie zostało przeniesione do innego momentu. Stała. | |
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ą. |
zapisywalny |
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 |
outOfOfficeProperties.autoDeclineMode |
string |
Czy odrzucać zaproszenia na spotkania, które pokrywają się z wydarzeniami poza biurem. Prawidłowe wartości to declineNone , co oznacza, że żadne zaproszenia na spotkania nie są odrzucane. declineAllConflictingInvitations , co oznacza, że wszystkie zaproszenia na spotkania będące w konflikcie i kolidujące z wydarzeniem są odrzucane. i declineOnlyNewConflictingInvitations , co oznacza, że będą odrzucane tylko nowe zaproszenia na spotkania będące w konflikcie, które otrzymasz w czasie trwania wydarzenia „Poza biurem”. |
|
outOfOfficeProperties.declineMessage |
string |
Komunikat z opcją określenia, czy istniejące lub nowe zaproszenie mają być automatycznie odrzucane przez Kalendarz. | |
privateCopy |
boolean |
Jeśli zasada ma wartość Prawda, rozpowszechnianie zdarzeń jest wyłączone. Pamiętaj, że to nie to samo co właściwości wydarzenia prywatnego. Opcjonalnie: Niezmienna. Wartość domyślna to Fałsz. | |
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 |
recurringEventId |
string |
W przypadku wystąpienia wydarzenia cyklicznego jest to pole id wydarzenia cyklicznego, do którego należy ta instancja. Stała. |
|
reminders |
object |
Informacje o przypomnieniach o wydarzeniu dla uwierzytelnionego użytkownika. Pamiętaj, że zmiana przypomnień nie powoduje zmiany właściwości updated powiązanego wydarzenia. |
|
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:
Wymagany podczas dodawania 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 |
object |
Źródło, z którego utworzono zdarzenie. Może to być na przykład strona internetowa, wiadomość e-mail lub dowolny dokument, który można rozpoznać za pomocą adresu URL zgodnego ze schematem HTTP lub HTTPS. Tylko twórca wydarzenia może je zobaczyć lub zmodyfikować. | |
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. Schemat adresu URL musi być HTTP lub HTTPS. | z możliwością zapisu |
start |
nested object |
Godzina rozpoczęcia wydarzenia (włącznie). W przypadku wydarzenia cyklicznego jest to godzina rozpoczęcia pierwszego wystąpienia. | |
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ą. |
zapisywalny |
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:
|
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:
|
z możliwością zapisu |
updated |
datetime |
Czas ostatniej modyfikacji głównych danych zdarzenia (jako sygnatura czasowa RFC 3339). Zaktualizowanie przypomnień o wydarzeniach nie spowoduje żadnych zmian. Tylko do odczytu. | |
visibility |
string |
Widoczność wydarzenia. Opcjonalnie: Możliwe wartości:
|
z możliwością zapisu |
workingLocationProperties |
nested object |
Dane zdarzenia w lokalizacji miejsca pracy. | z możliwością zapisu |
workingLocationProperties.customLocation |
object |
Jeśli ta opcja jest dostępna, oznacza, że użytkownik pracuje w lokalizacji niestandardowej. | 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 ten parametr jest dostępny, oznacza, że użytkownik pracuje w domu. | z możliwością zapisu |
workingLocationProperties.officeLocation |
object |
Jeśli ten parametr jest dostępny, oznacza, że użytkownik pracuje w biurze. | z możliwością zapisu |
workingLocationProperties.officeLocation.buildingId |
string |
Opcjonalny identyfikator budynku. Powinien 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 klientach internetowych i mobilnych. Zalecamy odwołanie do nazwy budynku w bazie danych zasobów organizacji. | zapisywalny |
workingLocationProperties.type |
string |
Typ lokalizacji miejsca pracy. Możliwe wartości:
Wymagane przy dodawaniu właściwości lokalizacji miejsca pracy. |
z możliwością zapisu |
Metody
- usuń
- Usuwanie wydarzenia.
- pobierz
- Zwraca wydarzenie na podstawie jego identyfikatora Kalendarza Google. Aby pobrać zdarzenie przy użyciu jego identyfikatora iKalendarz, wywołaj metodęevents.list przy użyciu parametru
iCalUID
. - import
- Importuje zdarzenie. Ta operacja pozwala dodać prywatną kopię istniejącego wydarzenia do kalendarza. Można importować tylko zdarzenia z
eventType
o wartościdefault
.Wycofane działanie: jeśli zaimportujesz zdarzenie inne niż
default
, jego typ zostanie zmieniony nadefault
, a wszystkie właściwości związane z typem zdarzenia zostaną usunięte. - wstaw
- Tworzy zdarzenie.
- instances
- Zwraca wystąpienia określonego wydarzenia cyklicznego.
- list
- Zwraca wydarzenia z określonego kalendarza.
- przenieś
- Przenosi wydarzenie do innego kalendarza, czyli zmienia jego organizatora. Pamiętaj, że można przenieść tylko liczbę wydarzeń (
default
). Nie można przenieść wydarzeńbirthday
,focusTime
,fromGmail
,outOfOffice
iworkingLocation
. - poprawka
- Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. preferujesz użycie ciągu
get
, po którym następujeupdate
. Określone przez Ciebie wartości pól zastępują istniejące wartości. Pola, które nie zostaną określone w żądaniu, pozostaną niezmienione. Pola tablicowe (jeśli są określone) zastępują istniejące tablice; powoduje odrzucenie wszystkich poprzednich elementów tablicy. - quickAdd
- Tworzy zdarzenie na podstawie prostego ciągu tekstowego.
- zaktualizuj
- Aktualizuje wydarzenie. Ta metoda nie obsługuje semantyki poprawki i zawsze aktualizuje cały zasób zdarzenia. Aby wykonać częściową aktualizację, wykonaj polecenie
get
, a następnie polecenieupdate
, używając étagów, aby zapewnić swobodę. - zegarek
- Wypatruj zmian w zasobach dotyczących wydarzeń.