Events

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 Uwagi
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 supportsAttachments powinien być ustawiony na true.

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 Files w interfejsie Drive API.
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 alternateLink zasobu Files w interfejsie Drive API.

Wymagane przy dodawaniu załącznika.

 z możliwością zapisu
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:
  • „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
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:

  • eventHangout: identyfikator nie jest ustawiony. (Ten typ rozmowy wideo został wycofany).
  • eventNamedHangout: ID to nazwa spotkania. (Ten typ rozmowy wideo został wycofany).
  • hangoutsMeet: identyfikator to 10-literowy kod spotkania, na przykład aaa-bbbb-ccc.
  • addOn: identyfikator jest definiowany przez zewnętrznego dostawcę.
Opcjonalna.
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ść conferenceSolution i co najmniej 1 element entryPoint lub createRequest.
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:

  • "eventHangout" dla użytkowników indywidualnych Hangouts (wycofane; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania do obsługi rozmów wideo, ale nie będzie można tworzyć nowych rozmów wideo)
  • "eventNamedHangout" dla użytkowników Google Workspace klasycznej wersji Hangouts (funkcja wycofana; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania do obsługi rozmów wideo, ale nie będzie można tworzyć nowych rozmów wideo)
  • "hangoutsMeet" w Google Meet (http://meet.google.com)
  • "addOn" w przypadku dostawców zewnętrznych

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ść conferenceSolution i co najmniej 1 element entryPoint lub createRequest.
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:

  • "eventHangout" dla użytkowników indywidualnych Hangouts (wycofane; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania do obsługi rozmów wideo, ale nie będzie można tworzyć nowych rozmów wideo)
  • "eventNamedHangout" dla użytkowników Google Workspace klasycznej wersji Hangouts (funkcja wycofana; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania do obsługi rozmów wideo, ale nie będzie można tworzyć nowych rozmów wideo)
  • "hangoutsMeet" w Google Meet (http://meet.google.com)
  • "addOn" w przypadku dostawców zewnętrznych

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:

  • "pending": prośba o utworzenie rozmowy wideo jest nadal przetwarzana.
  • "success": prośba o utworzenie konferencji została zrealizowana, punkty wejścia zostały wypełnione.
  • "failure": nie udało się utworzyć rozmowy wideo. Brak punktów wejścia.

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ść conferenceSolution i co najmniej 1 element entryPoint lub createRequest.
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 {meetingCode, accessCode, passcode, password, pin} zgodny z terminologią używaną przez usługodawcę. Powinny się wyświetlać tylko wypełnione pola.

Opcjonalnie.
conferenceData.entryPoints[].entryPointType string Typ punktu wejścia konferencji.

Możliwe wartości to:

  • "video" – dołączanie do rozmowy wideo przez HTTP. Konferencja może mieć 0 lub 1 punkt wejścia video.
  • "phone" – dołączenie do rozmowy wideo przez wybranie numeru telefonu. Konferencja nie może mieć żadnych punktów wejścia phone.
  • "sip" – dołączanie do rozmowy wideo przez SIP. Konferencja może mieć 0 lub 1 punkt wejścia sip.
  • "more" – dalsze instrukcje dołączania do konferencji, np. dodatkowe numery telefonów. Konferencja może mieć 0 lub 1 punkt wejścia more. Rozmowa wideo mająca tylko punkt wejścia more nie jest prawidłową konferencją.

conferenceData.entryPoints[].label string Etykieta identyfikatora URI. Widoczne dla użytkowników. Nie zlokalizowano. Maksymalna długość to 512 znaków.

Przykłady:

  • video: meet.google.com/aaa-bbbb-ccc
  • dla phone: +1 123 268 2601
  • dla sip: 12345678@altostrat.com
  • dla pola more: nie należy wypełniać

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 {meetingCode, accessCode, passcode, password, pin} zgodny z terminologią używaną przez usługodawcę. Powinny się wyświetlać tylko wypełnione pola.

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 {meetingCode, accessCode, passcode, password, pin} zgodny z terminologią używaną przez usługodawcę. Powinny się wyświetlać tylko wypełnione pola.
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 {meetingCode, accessCode, passcode, password, pin} zgodny z terminologią używaną przez usługodawcę. Powinny się wyświetlać tylko wypełnione pola.

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 {meetingCode, accessCode, passcode, password, pin} zgodny z terminologią używaną przez usługodawcę. Powinny się wyświetlać tylko wypełnione pola.

Opcjonalnie.
conferenceData.entryPoints[].uri string Identyfikator URI punktu wejścia. Maksymalna długość to 1300 znaków.

Format:

  • dla schematu video, http: lub https: jest wymagany.
  • dla zakresu phone, wymagany jest schemat tel:. Identyfikator URI powinien zawierać całą sekwencję wybierania numeru (np. tel:+12345678900,,123456789;1234).
  • dla funkcji sip wymagany jest schemat sip:, np. sip:12345678@mydostawca.com.
  • dla schematu more, http: lub https: jest wymagany.

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:
  • „default” – zwykłe wydarzenie lub nieokreślone bardziej szczegółowo.
  • „outOfOffice” – wydarzenie poza biurem.
  • „focusTime” – wydarzenie typu czas skupienia.
  • „workingLocation” – zdarzenie związane z lokalizacją miejsca pracy.
 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:
  • „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ść widż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.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
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 iCalUID i id nie są identyczne i w momencie tworzenia zdarzenia należy podać tylko jeden z nich. Jedyna różnica w ich semantyce polega na tym, że w przypadku wydarzeń cyklicznych wszystkie wystąpienia jednego zdarzenia mają różne id, a wszystkie te same zdarzenia iCalUID. Aby pobrać zdarzenie za pomocą parametru iCalUID, wywołaj metodę events.list za pomocą parametru iCalUID. Aby pobrać zdarzenie za pomocą jego atrybutu id, wywołaj metodę events.get.
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:
  • Dozwolone w identyfikatorze są te używane w kodowaniu base32hex, tj.małe litery a-v i cyfry 0-9, patrz sekcja 3. 1.2 w RFC2938.
  • identyfikator musi mieć od 5 do 1024 znaków
  • identyfikator musi być niepowtarzalny w każdym kalendarzu
Ze względu na fakt, że system jest rozproszony globalnie, nie możemy zagwarantować, że konflikty identyfikatorów będą wykrywane w momencie tworzenia wydarzenia. Aby zminimalizować ryzyko kolizji, zalecamy użycie uznanego algorytmu UUID, takiego jak opisany w dokumencie RFC4122.

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

Pamiętaj, że właściwości icalUID i id nie są identyczne i w momencie tworzenia zdarzenia należy podać tylko jeden z nich. Jedyna różnica w ich semantyce polega na tym, że w przypadku wydarzeń cyklicznych wszystkie wystąpienia jednego zdarzenia mają różne id, a wszystkie te same zdarzenia icalUID.

 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:
  • „email” – przypomnienia są wysyłane e-mailem.
  • „popup” – przypomnienia są wysyłane w wyskakującym okienku UI.

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:
  • „confirmed” – wydarzenie zostało potwierdzone. Jest to stan domyślny.
  • „tentative” – wydarzenie zostało wstępnie potwierdzone.
  • „cancelled” – wydarzenie zostało anulowane (usunięte). Metoda list zwraca anulowane zdarzenia tylko podczas synchronizacji przyrostowej (gdy są określone wartości syncToken lub updatedMin) lub jeśli flaga showDeleted jest ustawiona na true. Metoda get zawsze je zwraca.

    Anulowanie ma 2 stany w zależności od typu zdarzenia:

    1. Anulowane wyjątki dotyczące nieanulowanego wydarzenia cyklicznego wskazują, że to wystąpienie nie powinno już być prezentowane użytkownikowi. Klienci powinni przechowywać te zdarzenia przez cały okres trwania nadrzędnego zdarzenia cyklicznego.

      Anulowane wyjątki mogą mieć wypełnione tylko wartości w polach id, recurringEventId i originalStartTime. Pozostałe pola mogą być puste.

    2. Pozostałe anulowane wydarzenia to wydarzenia usunięte. Klient powinien usunąć swoje kopie zsynchronizowane lokalnie. Takie anulowane wydarzenia z czasem znikną, więc nie należy polegać na tym, że będą dostępne bezterminowo.

      Usunięte wydarzenia mają tylko wypełnione pole id.

    W kalendarzu organizatora anulowane wydarzenia nadal ujawniają szczegóły wydarzenia (podsumowanie, lokalizację itp.), dzięki czemu można je przywrócić (przywrócić). Analogicznie szczegóły są dostępne w przypadku wydarzeń, na które użytkownik został zaproszony i który usunięty ręcznie. Jednak przyrostowe żądania synchronizacji z parametrem showDeleted ustawionym na wartość Fałsz nie zwrócą tych informacji.

    Jeśli wydarzenie zmieni organizatora (na przykład przez operację przenoszenia), a pierwotnego organizatora nie ma na liście uczestników, pozostanie anulowane wydarzenie, w którym gwarantowane będzie tylko pole id.

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:
  • „opaque” – wartość domyślna. Wydarzenie zablokuje czas w kalendarzu. Jest to odpowiednik ustawienia Pokaż mój stan jako na Zajęty w interfejsie Kalendarza.
  • „transparent” – wydarzenie nie blokuje czasu w kalendarzu. Jest to odpowiednik ustawienia Pokaż jako na Dostępny w interfejsie Kalendarza.
 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:
  • „default” – stosuje domyślną widoczność 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 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 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:
  • „homeOffice” – użytkownik pracuje w domu.
  • „officeLocation” – użytkownik pracuje w biurze.
  • „customLocation” – użytkownik pracuje w lokalizacji niestandardowej.
W polu podrzędnym określonej nazwy znajdują się wszystkie szczegóły, ale jeśli to pole jest puste, może ich brakować. Pozostałe pola są ignorowane.

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ści default.

Wycofane działanie: jeśli zaimportowane zdarzenie inne niż default zostanie zaimportowane, jego typ zostanie zmieniony na default, 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. Pamiętaj, że można przenieść tylko default wydarzenia; outOfOffice, focusTime i workingLocation nie można przenieść.
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ępuje update. 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ępnie update, korzystając z etagów.
zegarek
Obserwuj zmiany w zasobach dotyczących wydarzeń.