Interfejs Calendar API udostępnia różne rodzaje zasobów wydarzeń. Więcej informacji znajdziesz w artykule Informacje o wydarzeniach.
Listę metod stosowanych w przypadku 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 | Notatki |
---|---|---|---|
anyoneCanAddSelf |
boolean |
Określa, czy każdy może zaprosić siebie na wydarzenie (wycofane). Opcjonalnie. Wartością domyślną jest Fałsz. | z możliwością zapisu |
attachments[] |
list |
pliki załączników do wydarzenia, Aby można było modyfikować załączniki, parametr żądania Na wydarzenie można przesłać 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 dodawać załączniki z plików z Dysku Google, używaj 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 prezentacji wydarzenia. Gdy pobierasz zdarzenie, może to być spowodowane ograniczeniem określonym przez parametr zapytania maxAttendee . Podczas aktualizowania wydarzenia można zmienić tylko odpowiedź uczestnika. Opcjonalnie. Wartością domyślną jest 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 wypeł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 jest 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 zgodny ze standardem RFC5322. Wymagane przy dodawaniu 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ścią domyślną jest Fałsz. | z możliwością zapisu |
attendees[].organizer |
boolean |
Wskazuje, czy uczestnik jest organizatorem wydarzenia. Tylko do odczytu. Wartością domyślną jest Fałsz. | |
attendees[].resource |
boolean |
Wskazuje, czy uczestnik jest zasobem. To ustawienie można skonfigurować tylko wtedy, gdy uczestnik jest dodawany do wydarzenia po raz pierwszy. Kolejne zmiany są ignorowane. Opcjonalnie. Wartością domyślną jest 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 znajduje się dana kopia wydarzenia. Tylko do odczytu. Wartością domyślną jest Fałsz. | |
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 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 zdarzeń. |
z możliwością zapisu |
conferenceData.conferenceId |
string |
Identyfikator konferencji. Mogą być używane przez programistów do śledzenia konferencji i nie powinny być wyświetlane użytkownikom. Wartość identyfikatora jest określana inaczej w zależności od typu rozwiązania do obsługi konferencji:
|
|
conferenceData.conferenceSolution |
nested object |
rozwiązanie do obsługi konferencji, na przykład Google Meet. Anuluj ustawienie dla rozmowy wideo z nieudanym żądaniem utworzenia. Wymagana jest właściwość |
|
conferenceData.conferenceSolution.iconUri |
string |
Widoczna dla użytkownika ikona tego rozwiązania. | |
conferenceData.conferenceSolution.key |
nested object |
Klucz, który może jednoznacznie identyfikować rozwiązanie konferencyjne dla tego wydarzenia. | |
conferenceData.conferenceSolution.key.type |
string |
Typ rozwiązania do obsługi konferencji. Jeśli klient napotka nieznany lub pusty typ, nadal powinien mieć możliwość wyświetlenia punktów wejścia. Nie powinien on jednak wprowadzać zmian. Możliwe wartości to:
|
|
conferenceData.conferenceSolution.name |
string |
Widoczna dla użytkownika nazwa tego rozwiązania. Nie zlokalizowano. | |
conferenceData.createRequest |
nested object |
Prośba o wygenerowanie nowej rozmowy wideo i dołączenie jej do wydarzenia. Dane są generowane asynchronicznie. Aby zobaczyć, czy dane są dostępne, sprawdź pole status . Wymagana jest właściwość |
|
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 konferencji. Jeśli klient napotka nieznany lub pusty typ, nadal powinien mieć możliwość wyświetlenia punktów wejścia. Nie powinien on jednak wprowadzać zmian. Możliwe wartości to:
|
|
conferenceData.createRequest.requestId |
string |
Wygenerowany przez klienta unikalny identyfikator tego żądania. Klienci powinni generować go ponownie dla każdego nowego żądania. Jeśli podany identyfikator jest taki sam jak w poprzednim żądaniu, zostanie ono 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 poszczególnych punktach wejścia na konferencję, takie jak adresy URL lub numery telefonów. Wszystkie muszą należeć do tej samej konferencji. Wymagana jest właściwość |
|
conferenceData.entryPoints[].accessCode |
string |
Kod dostępu do konferencji. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmowy wideo uzupełnij tylko podzbiór pól { Opcjonalnie. |
|
conferenceData.entryPoints[].entryPointType |
string |
Typ punktu wejścia konferencji. Możliwe wartości to:
|
|
conferenceData.entryPoints[].label |
string |
Etykieta identyfikatora URI. Widoczne dla użytkowników. Nie zlokalizowano. 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 rozmowy wideo uzupełnij tylko podzbiór pól { Opcjonalnie. |
|
conferenceData.entryPoints[].passcode |
string |
Kod dostępu do konferencji. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmowy wideo uzupełnij tylko podzbiór pól { |
|
conferenceData.entryPoints[].password |
string |
Hasło umożliwiające dostęp do konferencji. Maksymalna długość to 128 znaków. Podczas tworzenia nowych danych rozmowy wideo uzupełnij tylko podzbiór pól { 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 rozmowy wideo uzupełnij tylko podzbiór pól { Opcjonalnie. |
|
conferenceData.entryPoints[].uri |
string |
Identyfikator URI punktu wejścia. Maksymalna długość to 1300 znaków. Format:
|
|
conferenceData.notes |
string |
Dodatkowe uwagi (takie jak instrukcje od administratora domeny czy informacje prawne) wyświetlane użytkownikowi. Może zawierać kod HTML. Maksymalna długość to 2048 znaków. Opcjonalnie. | |
conferenceData.signature |
string |
Podpis danych dotyczących rozmowy wideo. Wygenerowano po stronie serwera. Anuluj ustawienie dla rozmowy wideo z nieudanym żądaniem utworzenia. Opcjonalna w przypadku rozmowy wideo z oczekującą prośbą o utworzenie. |
|
created |
datetime |
Czas utworzenia zdarzenia (jako sygnatura czasowa RFC3339). Tylko do odczytu. | |
creator |
object |
Twórca wydarzenia. Tylko do odczytu. | |
creator.displayName |
string |
imię i nazwisko twórcy, jeśli są dostępne; | |
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ścią domyślną jest Fałsz. | |
description |
string |
Opis wydarzenia. Może zawierać kod HTML. Opcjonalnie. | z możliwością zapisu |
end |
nested object |
(wyłączna) godzina zakończenia wydarzenia. W przypadku wydarzenia cyklicznego jest to godzina 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 łączna wartość daty i godziny (sformatowana zgodnie ze standardem RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że jednoznacznie określisz strefę czasową w polu timeZone . |
z możliwością zapisu |
end.timeZone |
string |
Strefa czasowa, w której jest określona godzina. (Sformatowana jako nazwa bazy danych strefy czasowej IANA, np. „Europa/Zurych”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozszerzane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/zakończenia wydarzenia. | z możliwością zapisu |
endTimeUnspecified |
boolean |
Wskazuje, czy godzina zakończenia nie jest określona. W celu zapewnienia zgodności nadal podawany jest czas zakończenia, nawet jeśli ten atrybut ma wartość True. Wartością domyślną jest Fałsz. | |
etag |
etag |
ETag zasobu. | |
eventType |
string |
Konkretny typ zdarzenia. Po utworzeniu wydarzenia nie można tego zmienić. 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 w odniesieniu do 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ólne dla kopii wydarzenia w kalendarzach innych uczestników. | z możliwością zapisu |
extendedProperties.shared.(key) |
string |
Nazwa udostępnianej usługi 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 spotkanie nie są odrzucane; declineAllConflictingInvitations oznacza, że wszystkie zaproszenia na spotkania kolidujące z wydarzeniem są odrzucane; lub declineOnlyNewConflictingInvitations (oznacza to, że odrzucone są tylko nowe zaproszenia na spotkania będące w konflikcie). |
|
focusTimeProperties.chatStatus |
string |
Stan do oznaczenia użytkownika w Google Chat i w powiązanych usługach. Może to być available lub doNotDisturb . |
|
focusTimeProperties.declineMessage |
string |
Wiadomość z odpowiedzią, która ma być ustawiona, jeśli istniejące wydarzenie lub nowe zaproszenie jest automatycznie odrzucane przez Kalendarz. | |
gadget |
object |
Gadżet, który rozszerza to wydarzenie. Gadżety zostały wycofane. Ta struktura jest używana tylko do zwracania metadanych z kalendarza urodzin. | |
gadget.display |
string |
Tryb wyświetlania gadżetów. Rola wycofana. Możliwe wartości:
|
z możliwością zapisu |
gadget.height |
integer |
Wysokość widż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żetów. Schematem adresu URL musi być HTTPS. Rola wycofana. | z możliwością zapisu |
gadget.link |
string |
Adres URL gadżetów. Schematem adresu URL musi być HTTPS. Rola wycofana. | z możliwością zapisu |
gadget.preferences |
object |
Ustawienia. | z możliwością zapisu |
gadget.preferences.(key) |
string |
Nazwa ustawienia i odpowiadająca mu wartość. | |
gadget.title |
string |
Tytuł gadżetów. Rola wycofana. | z możliwością zapisu |
gadget.type |
string |
Typ gadżetów. Rola wycofana. | z możliwością zapisu |
gadget.width |
integer |
Szerokość gadżetów 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ć na wydarzenie inne osoby. Opcjonalnie. Wartość domyślna to True. | z możliwością zapisu |
guestsCanModify |
boolean |
Określa, czy uczestnicy inni niż organizator mogą modyfikować wydarzenie. Opcjonalnie. Wartością domyślną jest Fałsz. | z możliwością zapisu |
guestsCanSeeOtherGuests |
boolean |
Określa, czy uczestnicy inni niż organizator mogą zobaczyć, kto jest uczestnikiem wydarzenia. Opcjonalnie. Wartość domyślna to True. | z możliwością zapisu |
hangoutLink |
string |
Bezwzględny link do spotkania Google powiązanego z tym wydarzeniem. Tylko do odczytu. | |
htmlLink |
string |
Bezwzględny link do tego wydarzenia w interfejsie internetowym Kalendarza Google. Tylko do odczytu. | |
iCalUID |
string |
Unikalny identyfikator zdarzenia zdefiniowany w dokumencie RFC5545. Służy on do jednoznacznego identyfikowania wydarzeń w systemach kalendarzy i musi być podawany podczas importowania wydarzeń za pomocą metody import. Pamiętaj, że właściwości |
|
id |
string |
Nieprzezroczysty identyfikator zdarzenia. Podczas tworzenia nowych wydarzeń pojedynczych lub cyklicznych możesz podać 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 właściwości |
z możliwością zapisu |
kind |
string |
Typ zasobu („calendar#event ”). |
|
location |
string |
Lokalizacja geograficzna wydarzenia w postaci dowolnego tekstu. Opcjonalnie. | z możliwością zapisu |
locked |
boolean |
Określa, czy jest to zablokowana kopia zdarzenia, w której nie można wprowadzać żadnych zmian w polach „podsumowanie”, „opis”, „lokalizacja”, „rozpoczęcie”, „koniec” ani „powtarzanie”. Wartością domyślną jest Fałsz. Tylko do odczytu. | |
organizer |
object |
Organizator wydarzenia. Jeśli organizator jest też uczestnikiem, jest to wskazane w osobnym wpisie w polu attendees z polem organizer ustawionym na wartość Prawda. Aby zmienić organizatora, użyj operacji przenieś. Tylko do odczytu, z wyjątkiem importowania zdarzeń. |
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). Musi to być prawidłowy adres e-mail zgodny ze standardem 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ścią domyślną jest Fałsz. | |
originalStartTime |
nested object |
W przypadku wydarzenia cyklicznego jest to czas rozpoczęcia tego zdarzenia, określony zgodnie z danymi o powtarzaniu w wydarzeniu cyklicznego wskazywanym przez parametr singleEventId. Jednoznacznie identyfikuje wystąpienie w serii zdarzeń cyklicznych, nawet jeśli instancja została przeniesiona w inny czas. Stałe. | |
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 łączna wartość daty i godziny (sformatowana zgodnie ze standardem RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że jednoznacznie określisz strefę czasową w polu timeZone . |
z możliwością zapisu |
originalStartTime.timeZone |
string |
Strefa czasowa, w której jest określona godzina. (Sformatowana jako nazwa bazy danych strefy czasowej IANA, np. „Europa/Zurych”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozszerzane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/zakończenia wydarzenia. | z możliwością zapisu |
outOfOfficeProperties |
nested object |
Dane o wydarzeniu 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 nakładają się na wydarzenia Poza biurem. Prawidłowe wartości to declineNone , co oznacza, że żadne zaproszenia na spotkanie nie są odrzucane; declineAllConflictingInvitations oznacza, że wszystkie kolidujące zaproszenia na spotkanie będące w konflikcie z wydarzeniem są odrzucane; lub declineOnlyNewConflictingInvitations (oznacza to, że odrzucone są tylko nowe zaproszenia na spotkania będące w konflikcie). |
|
outOfOfficeProperties.declineMessage |
string |
Wiadomość z odpowiedzią, która ma być ustawiona, jeśli istniejące wydarzenie lub nowe zaproszenie jest automatycznie odrzucane przez Kalendarz. | |
privateCopy |
boolean |
Jeśli zasada ma wartość Prawda, propagacja zdarzeń jest wyłączona. Pamiętaj, że to nie to samo co właściwości wydarzenia prywatnego. Opcjonalnie. Stałe. Wartością domyślną jest 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 nie są dozwolone w tym polu. Czasy rozpoczęcia i zakończenia zdarzenia są podawane 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 wydarzenia cyklicznego jest to wartość id wydarzenia cyklicznego, do którego należy to wystąpienie. Stałe. |
|
reminders |
object |
Informacje o przypomnieniach o wydarzeniu dla uwierzytelnionego użytkownika. | |
reminders.overrides[] |
list |
Jeśli dla wydarzenia nie są używane przypomnienia domyślne, wyświetlane są przypomnienia związane z wydarzeniem lub, jeśli nie są ustawione, 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żywana przez to przypomnienie. Możliwe wartości:
Wymagane przy dodawaniu przypomnienia. |
z możliwością zapisu |
reminders.overrides[].minutes |
integer |
Liczba minut przed rozpoczęciem wydarzenia, na które powinno zostać aktywowane przypomnienie. Prawidłowe wartości to od 0 do 40320 (4 tygodnie w minutach). Wymagane przy dodawaniu przypomnienia. |
z możliwością zapisu |
reminders.useDefault |
boolean |
Określa, czy do wydarzenia mają zastosowanie domyślne przypomnienia kalendarza. | z możliwością zapisu |
sequence |
integer |
Numer sekwencyjny zgodny z iKalendarzem. | z możliwością zapisu |
source |
object |
Źródło, z którego utworzono wydarzenie. Może to być na przykład strona internetowa, e-mail lub dowolny dokument identyfikowany na podstawie adresu URL o schemacie HTTP lub HTTPS. Jest widoczne lub modyfikowane tylko przez osobę, która utworzyła wydarzenie. | |
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 |
URL źródła wskazującego zasób. Schematem adresu URL musi być HTTP lub HTTPS. | z możliwością zapisu |
start |
nested object |
Godzina rozpoczęcia (włącznie) wydarzenia. 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 łączna wartość daty i godziny (sformatowana zgodnie ze standardem RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że jednoznacznie określisz strefę czasową w polu timeZone . |
z możliwością zapisu |
start.timeZone |
string |
Strefa czasowa, w której jest określona godzina. (Sformatowana jako nazwa bazy danych strefy czasowej IANA, np. „Europa/Zurych”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozszerzane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/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 blokuje czas w kalendarzu. Opcjonalnie. Możliwe wartości:
|
z możliwością zapisu |
updated |
datetime |
Czas ostatniej modyfikacji zdarzenia (w postaci sygnatury czasowej RFC3339). Tylko do odczytu. | |
visibility |
string |
Widoczność wydarzenia. Opcjonalnie. Możliwe wartości:
|
z możliwością zapisu |
workingLocationProperties |
nested object |
Dane zdarzenia dotyczącego lokalizacji miejsca pracy. | z możliwością zapisu |
workingLocationProperties.customLocation |
object |
Jeśli występuje, określa, że użytkownik pracuje w lokalizacji niestandardowej. | z możliwością zapisu |
workingLocationProperties.customLocation.label |
string |
Opcjonalna dodatkowa etykieta dodatkowych informacji. | z możliwością zapisu |
workingLocationProperties.homeOffice |
any value |
Jeśli ta opcja jest dostępna, określa, że użytkownik pracuje w domu. | z możliwością zapisu |
workingLocationProperties.officeLocation |
object |
Jeśli ta opcja jest dostępna, określa, że użytkownik pracuje w biurze. | z możliwością zapisu |
workingLocationProperties.officeLocation.buildingId |
string |
Opcjonalny identyfikator budynku. Powinien on odnosić 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 sekcji piętra. | z możliwością zapisu |
workingLocationProperties.officeLocation.label |
string |
Nazwa biura wyświetlana w klientach w przeglądarce internetowej i aplikacjach mobilnych. Zalecamy podanie 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 przy dodawaniu właściwości lokalizacji miejsca pracy. |
z możliwością zapisu |
Metody
- usuń
- Usuwa wydarzenie.
- pobierz
- Zwraca wydarzenie na podstawie jego identyfikatora z Kalendarza Google. Aby pobrać zdarzenie przy użyciu jego identyfikatora icalendar, wywołaj metodę events.list za pomocą parametru
iCalUID
. - import
- Importuje wydarzenie. 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 zaimportowane zdarzenie inne niż
default
zostanie zaimportowane, jego typ zostanie zmieniony nadefault
, a wszelkie związane z nim właściwości zostaną pominięte. - wstaw
- Tworzy wydarzenie.
- instancje
- Zwraca wystąpienia określonego wydarzenia cyklicznego.
- list
- Zwraca wydarzenia z określonego kalendarza.
- przenieś
- Przenosi wydarzenie do innego kalendarza, np. zmienia jego organizatora. Można przenieść tylko wydarzenia
default
. Nie można przenieść wydarzeńoutOfOffice
,focusTime
,workingLocation
ifromGmail
. - poprawka
- Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. Preferowane są
get
, po którym następujeupdate
. Określone przez Ciebie wartości pól zastępują obecne. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy (jeśli zostały określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy. - quickAdd
- Tworzy zdarzenie na podstawie prostego ciągu tekstowego.
- aktualizacja
- Aktualizuje wydarzenie. Ta metoda nie obsługuje semantyki poprawki i zawsze aktualizuje cały zasób zdarzenia. Aby wykonać częściową aktualizację, wykonaj
get
, a następnieupdate
, korzystając z etagów. - zegarek
- Obserwuj zmiany w zasobach dotyczących wydarzeń.