Events

Interfejs Calendar API zapewnia różne rodzaje zasobów wydarzeń. Więcej informacji znajdziesz w sekcji Informacje o wydarzeniach.

Listę metod dostępnych 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": {
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": 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 zapraszać do udziału w wydarzeniu (wycofany). Opcjonalnie. Wartość domyślna to Fałsz. zapisywalny
attachments[] list Załączone pliki dotyczące wydarzenia.

Aby można było modyfikować załączniki, parametr żądania supportsAttachments powinien być ustawiony na true.

Każde 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 Files w interfejsie Drive API.

attachments[].fileUrl string Adres URL załącznika.

Dodaj pliki z Dysku Google, używając tego samego formatu co we właściwości alternateLink zasobu Files w interfejsie Drive API.

Wymagane podczas dodawania załącznika.

zapisywalny
attachments[].mimeType string Typ nośnika internetowego (typ MIME) załącznika.
attachments[].title string Tytuł załącznika.
attendeesOmitted boolean Wskazuje, czy uczestnicy mogli nie być reprezentowani przez wydarzenie. Gdy pobierasz zdarzenie, może to być spowodowane ograniczeniami określonym przez parametr zapytania maxAttendee. Podczas aktualizowania wydarzenia można za jego pomocą zaktualizować tylko odpowiedź uczestnika. Opcjonalnie. Wartość domyślna to Fałsz. zapisywalny
attendees[] list Uczestnicy wydarzenia. Przeczytaj przewodnik Wydarzenia z uczestnikami, aby dowiedzieć się więcej o planowaniu wydarzeń z innymi użytkownikami kalendarza. Aby wypełnić listę uczestników, konta usługi muszą korzystać z przekazywania uprawnień w całej domenie. zapisywalny
attendees[].additionalGuests integer Liczba dodatkowych gości. Opcjonalnie. Wartość domyślna to 0. zapisywalny
attendees[].comment string Komentarz do odpowiedzi uczestnika. Opcjonalnie. zapisywalny
attendees[].displayName string Imię i nazwisko uczestnika (jeśli jest dostępne). Opcjonalnie. zapisywalny
attendees[].email string Adres e-mail uczestnika (jeśli jest dostępny). To pole musi być widoczne podczas dodawania uczestnika. Podaj prawidłowy adres e-mail zgodnie z normą RFC5322.

Wymagane przy dodawaniu uczestnika.

zapisywalny
attendees[].id string Identyfikator profilu uczestnika, jeśli jest dostępny.
attendees[].optional boolean Określa, czy jest to uczestnik opcjonalny. Opcjonalnie. Wartość domyślna to Fałsz. zapisywalny
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 ją ustawić tylko wtedy, gdy uczestnik zostanie dodany do wydarzenia po raz pierwszy. Kolejne zmiany są ignorowane. Opcjonalnie. Wartość domyślna to Fałsz. zapisywalny
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” – osoba wstępna zaakceptowała zaproszenie.
  • accepted” – uczestnik zaakceptował zaproszenie.
zapisywalny
attendees[].self boolean Określa, czy ten wpis dotyczy kalendarza, w którym znajduje się kopia danego wydarzenia. Tylko do odczytu. Wartość domyślna to 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. zapisywalny
conferenceData nested object informacje związane z konferencją, na przykład szczegóły konferencji w Google Meet; Aby utworzyć nowe szczegóły rozmowy wideo, użyj pola createRequest. Aby zachować zmiany, ustaw dla wszystkich żądań modyfikacji zdarzeń parametr conferenceDataVersion na 1. zapisywalny
conferenceData.conferenceId string Identyfikator konferencji.

Może być używana przez deweloperów do śledzenia konferencji i nie powinna być wyświetlana użytkownikom.

W przypadku każdego typu rozwiązania konferencyjnego wartość identyfikatora jest tworzona inaczej:

  • eventHangout: identyfikator nie jest ustawiony. (Ten typ rozmowy został wycofany).
  • eventNamedHangout: identyfikator jest nazwą spotkania. (Ten typ rozmowy został wycofany).
  • hangoutsMeet: identyfikator to 10-literowy kod spotkania, na przykład aaa-bbbb-ccc.
  • addOn: identyfikator jest określany przez dostawcę zewnętrznego.
Opcjonalnie.

conferenceData.conferenceSolution nested object rozwiązanie konferencyjne, takie jak Google Meet;

Cofnij ustawienie dla rozmowy wideo, której nie udało się utworzyć.

Wymagana jest właściwość conferenceSolution i co najmniej jedna właściwość entryPoint lub createRequest.

conferenceData.conferenceSolution.iconUri string Ikona widoczna dla użytkownika.
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, klient powinien nadal wyświetlać punkty wejścia. Nie powinny one jednak umożliwiać wprowadzania modyfikacji.

Możliwe wartości:

  • "eventHangout" dla klientów indywidualnych (wycofane – ten typ rozwiązania do obsługi rozmów wideo może być używany w istniejących wydarzeniach, ale nie można tworzyć nowych)
  • "eventNamedHangout" w przypadku klasycznej wersji Hangouts dla użytkowników Google Workspace (wycofane – ten typ rozwiązania do obsługi rozmów wideo może istnieć w istniejących wydarzeniach, ale nie można tworzyć nowych)
  • "hangoutsMeet" w Google Meet (http://meet.google.com)
  • "addOn" dla zewnętrznych organizatorów rozmów wideo

conferenceData.conferenceSolution.name string Nazwa widoczna dla użytkownika. Niezlokalizowane.
conferenceData.createRequest nested object Żądanie utworzenia nowej rozmowy wideo i załączenia jej do wydarzenia. Dane są generowane asynchronicznie. Aby dowiedzieć się, czy dane są dostępne, sprawdź pole status.

Wymagana jest właściwość conferenceSolution i co najmniej jedna właściwość entryPoint lub createRequest.

conferenceData.createRequest.conferenceSolutionKey nested object rozwiązanie konferencyjne, takie jak Hangouts czy Google Meet;
conferenceData.createRequest.conferenceSolutionKey.type string Typ rozwiązania do obsługi konferencji.

Jeśli klient napotka nieznany lub pusty typ, klient powinien nadal wyświetlać punkty wejścia. Nie powinny one jednak umożliwiać wprowadzania modyfikacji.

Możliwe wartości:

  • "eventHangout" dla klientów indywidualnych (wycofane – ten typ rozwiązania do obsługi rozmów wideo może być używany w istniejących wydarzeniach, ale nie można tworzyć nowych)
  • "eventNamedHangout" w przypadku klasycznej wersji Hangouts dla użytkowników Google Workspace (wycofane – ten typ rozwiązania do obsługi rozmów wideo może istnieć w istniejących wydarzeniach, ale nie można tworzyć nowych)
  • "hangoutsMeet" w Google Meet (http://meet.google.com)
  • "addOn" dla zewnętrznych organizatorów rozmów wideo

conferenceData.createRequest.requestId string Wygenerowany przez klienta unikalny identyfikator tego żądania.

Klienci powinni ponownie generować ten identyfikator dla każdego nowego żądania. Jeśli podany identyfikator będzie taki sam jak w poprzednim żądaniu, zostanie ono zignorowane.

conferenceData.createRequest.status nested object Stan żądania utworzenia rozmowy wideo.
conferenceData.createRequest.status.statusCode string Bieżący stan prośby o utworzenie rozmowy wideo. Tylko do odczytu.

Możliwe wartości:

  • "pending": żądanie utworzenia rozmowy wideo jest nadal przetwarzane.
  • "success": żądanie utworzenia rozmowy wideo zostało zrealizowane. Punkty wejściowe są wypełnione.
  • "failure": nie udało się utworzyć połączenia konferencyjnego, brak punktów wejścia.

conferenceData.entryPoints[] list Informacje o poszczególnych punktach wejścia konferencji, takich jak adresy URL lub numery telefonów.

Każda z nich musi należeć do tej samej rozmowy.

Wymagana jest właściwość conferenceSolution i co najmniej jedna właściwość entryPoint lub createRequest.

conferenceData.entryPoints[].accessCode string Kod dostępu umożliwiający dostęp do konferencji. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych konferencyjnych wypełnij tylko pola pól {meetingCode, accessCode, passcode, password, pin}, które są zgodne z terminologią używaną przez dostawcę. Powinny być wyświetlane tylko wypełnione pola.

Opcjonalnie.

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

Możliwe wartości to:

  • "video" – dołączanie do konferencji przez HTTP. W konferencji może występować zero lub jeden punkt wejścia video.
  • "phone" – dołączanie do konferencji przez wybranie numeru telefonu. Maksymalna liczba punktów wejścia to phone.
  • "sip" – dołączanie do konferencji za pomocą SIP. W konferencji może występować zero lub jeden punkt wejścia sip.
  • "more" – kolejne instrukcje dołączania do konferencji, na przykład dodatkowe numery telefonów. W konferencji może występować zero lub jeden punkt wejścia more. Rozmowa wideo z punktem wejścia more nie jest prawidłowa.

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

Przykłady:

  • video – meet.google.com/aaa-bbbb-ccc
  • phone: +1 123 268 2601
  • sip: 12345678@altostrat.com
  • w przypadku 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 konferencyjnych wypełnij tylko pola pól {meetingCode, accessCode, passcode, password, pin}, które są zgodne z terminologią używaną przez dostawcę. Powinny być wyświetlane tylko wypełnione pola.

Opcjonalnie.

conferenceData.entryPoints[].passcode string Kod dostępu do rozmowy wideo. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych konferencyjnych wypełnij tylko pola pól {meetingCode, accessCode, passcode, password, pin}, które są zgodne z terminologią używaną przez dostawcę. Powinny być wyświetlane 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 konferencyjnych wypełnij tylko pola pól {meetingCode, accessCode, passcode, password, pin}, które są zgodne z terminologią używaną przez dostawcę. Powinny być wyświetlane 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 konferencyjnych wypełnij tylko pola pól {meetingCode, accessCode, passcode, password, pin}, które są zgodne z terminologią używaną przez dostawcę. Powinny być wyświetlane tylko wypełnione pola.

Opcjonalnie.

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

Format:

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

conferenceData.notes string Dodatkowe informacje (na przykład instrukcje od administratora domeny czy informacje prawne), które użytkownik musi zobaczyć. Może zawierać kod HTML. Maksymalna długość to 2048 znaków. Opcjonalnie.
conferenceData.signature string Podpis danych rozmowy wideo.

Wygenerowano po stronie serwera.

Cofnij ustawienie dla rozmowy wideo, której nie udało się utworzyć.

Opcjonalne w przypadku konferencji 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 jest 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 pojawia się kopia wydarzenia. Tylko do odczytu. Wartość domyślna to Fałsz.
description string Opis wydarzenia. Może zawierać kod HTML. Opcjonalnie. zapisywalny
end nested object Godzina zakończenia wydarzenia (wyłącznie). 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. zapisywalny
end.dateTime datetime Godzina w postaci połączonej wartości daty i godziny (w formacie RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że w polu timeZone wyraźnie określono strefę czasową. zapisywalny
end.timeZone string Strefa czasowa określonej strefy czasowej. Sformatowana jako nazwa bazy danych stref czasowych IANA, np. „Europa/Zurych”. W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której rozwija się powtarzanie. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/zakończenia wydarzenia. zapisywalny
endTimeUnspecified boolean To, czy godzina zakończenia jest nieokreślona. Ze względu na zgodność podany jest czas zakończenia, nawet jeśli ten atrybut ma wartość Prawda. Wartość domyślna to Fałsz.
etag etag ETag zasobu.
eventType string Konkretny typ wydarzenia. Tylko do odczytu. Możliwe wartości:
  • default” – zwykłe wydarzenie lub nieokreślone.
  • outOfOffice” – wydarzenie poza biurem.
  • focusTime” – wydarzenie w czasie skupienia.
  • workingLocation” – zdarzenie lokalizacji miejsca pracy.
extendedProperties object Rozszerzone właściwości zdarzenia.
extendedProperties.private object Właściwości prywatne dotyczące kopii wydarzenia wyświetlanego w tym kalendarzu. zapisywalny
extendedProperties.private.(key) string Nazwa właściwości prywatnej i odpowiadająca jej wartość.
extendedProperties.shared object Usługi współdzielone między kopiami wydarzenia w kalendarzach innych uczestników. zapisywalny
extendedProperties.shared.(key) string Nazwa współdzielonej usługi i odpowiadająca jej wartość.
gadget object Gadżet wydłużający to wydarzenie. Gadżety nie są używane. Ta struktura służy tylko do zwracania metadanych kalendarza urodzin.
gadget.display string Tryb wyświetlania gadżetu. Rola wycofana. Możliwe wartości:
  • icon” – gadżet jest wyświetlany obok tytułu wydarzenia w widoku kalendarza.
  • chip” – gadżet jest wyświetlany po kliknięciu zdarzenia.
zapisywalny
gadget.height integer Wysokość gadżetu dla pikseli. Wysokość musi być liczbą całkowitą większą od 0. Opcjonalnie. Rola wycofana. zapisywalny
gadget.preferences object Ustawienia. zapisywalny
gadget.preferences.(key) string Nazwa ustawienia i odpowiadająca mu wartość.
gadget.title string Tytuł gadżetu. Rola wycofana. zapisywalny
gadget.type string Typ gadżetu. Rola wycofana. zapisywalny
gadget.width integer Szerokość gadżetu w pikselach. Szerokość musi być liczbą całkowitą większą niż 0. Opcjonalnie. Rola wycofana. zapisywalny
guestsCanInviteOthers boolean Określa, czy uczestnicy mogą brać udział w wydarzeniu. Opcjonalnie. Wartość domyślna to True. zapisywalny
guestsCanModify boolean Określa, czy uczestnicy mogą modyfikować wydarzenie inne niż organizator. Opcjonalnie. Wartość domyślna to Fałsz. zapisywalny
guestsCanSeeOtherGuests boolean Określa, czy uczestnicy inni niż organizatorzy mogą zobaczyć listę uczestników wydarzenia. Opcjonalnie. Wartość domyślna to True. zapisywalny
iCalUID string Unikalny identyfikator zdarzenia określony w specyfikacji RFC5545. Służą one do jednoznacznej identyfikacji wydarzeń w różnych kalendarzach i należy je podawać podczas importowania wydarzeń przy użyciu metody importu.

Pamiętaj, że iCalUID i id nie są identyczne i tylko jeden z nich należy podać podczas tworzenia zdarzenia. Jedną z ich semantyk jest to, że w wydarzeniach cyklicznych wszystkie wystąpienia jednego wydarzenia mają różne id, ale wszystkie mają te same iCalUID. Aby pobrać zdarzenie za pomocą jego iCalUID, wywołaj metodę events.list za pomocą parametru iCalUID. Aby pobrać zdarzenie za pomocą jego wywołania id, wywołaj metodę events.get.

id string Nieprzezroczysty identyfikator zdarzenia. Tworząc nowe wydarzenia cykliczne lub pojedyncze, możesz określić ich identyfikatory. Podane identyfikatory muszą być zgodne z tymi regułami:
  • W identyfikatorze dozwolone są znaki używane w kodowaniu szesnastkowym base32, czyli małe litery a–v i cyfry 0–9. Więcej informacji znajdziesz w sekcji 3.1.2 w RFC2938
  • długość identyfikatora musi wynosić od 5 do 1024 znaków
  • identyfikator musi być unikalny dla każdego kalendarza
Ze względu na globalny charakter systemu nie możemy zagwarantować, że w momencie tworzenia zdarzenia pojawią się konflikty identyfikatorów. Aby zminimalizować ryzyko kolizji, zalecamy korzystanie z istniejącego algorytmu UUID, takiego jak opisany w RFC4122.

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

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

zapisywalny
kind string Typ zasobu („calendar#event”).
location string Położenie geograficzne zdarzenia w dowolnym formacie tekstu. Opcjonalnie. zapisywalny
locked boolean Określa, czy jest to blokowana kopia wydarzenia, w której nie można wprowadzać zmian w głównych polach „Podsumowanie”, „Opis”, „Lokalizacja”, „Początek”, „Koniec” ani „Powtarzanie”. Wartość domyślna to Fałsz. Tylko do odczytu.
organizer object Organizator wydarzenia. Jeśli uczestnik jest też uczestnikiem, w attendees jest to wskazywane z oddzielnym wpisem z polem organizer ustawionym na True. Aby zmienić organizatora, użyj operacji move. Tylko do odczytu, z wyjątkiem importu zdarzenia. zapisywalny
organizer.displayName string Nazwa organizatora, jeśli jest dostępna. zapisywalny
organizer.email string Adres e-mail organizatora (jeśli jest dostępny). Podaj prawidłowy adres e-mail zgodnie z normą RFC5322. zapisywalny
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 Fałsz.
originalStartTime nested object W przypadku wydarzenia cyklicznego jest to czas, w którym wydarzenie rozpoczęłoby się zgodnie z danymi cyklicznymi w wydarzeniu cyklicznym identyfikowanym przez zdarzenie cykliczne. Jednoznacznie identyfikuje instancję w serii wydarzeń cyklicznych, nawet jeśli została przeniesiona do innej godziny. Niezmienne.
originalStartTime.date date Data w formacie „rrrr-mm-dd”, jeśli jest to wydarzenie całodniowe. zapisywalny
originalStartTime.dateTime datetime Godzina w postaci połączonej wartości daty i godziny (w formacie RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że w polu timeZone wyraźnie określono strefę czasową. zapisywalny
originalStartTime.timeZone string Strefa czasowa określonej strefy czasowej. Sformatowana jako nazwa bazy danych stref czasowych IANA, np. „Europa/Zurych”. W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której rozwija się powtarzanie. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/zakończenia wydarzenia. zapisywalny
privateCopy boolean Jeśli ma wartość Prawda, propagacja zdarzeń jest wyłączona. Pamiętaj, że to nie to samo co Właściwości prywatnego zdarzenia. Opcjonalnie. Niezmienne. Wartość domyślna to Fałsz.
recurrence[] list Lista wierszy RRULE, EXRULE, RDATE i EXDATE wydarzeń cyklicznych, jak określono w RFC5545. Pamiętaj, że wiersze DTSTART i DTEND w tym polu nie są dozwolone. Godziny rozpoczęcia i zakończenia wydarzenia są określone w polach start i end. To pole jest pomijane w przypadku pojedynczych wydarzeń lub wystąpień cyklicznych. zapisywalny
recurringEventId string W przypadku wydarzenia cyklicznego jest to id wydarzenia cyklicznego, do którego należy ta instancja. Niezmienne.
reminders object Informacje o przypomnieniach o zdarzeniu dla uwierzytelnionego użytkownika.
reminders.overrides[] list Jeśli wydarzenie nie korzysta z przypomnień domyślnych, wyświetlają się przypomnienia dotyczące tego wydarzenia. Jeśli nie są ustawione, oznacza to, że dla tego wydarzenia nie są ustawione żadne przypomnienia. Maksymalna liczba przypomnień o zastąpieniu to 5. zapisywalny
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 interfejsu.

Wymagane podczas dodawania przypomnienia.

zapisywalny
reminders.overrides[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, w którym powinno się włączyć przypomnienie. Prawidłowe wartości to 0 – 40320 (4 tygodnie w minutach).

Wymagane podczas dodawania przypomnienia.

zapisywalny
reminders.useDefault boolean Określa, czy domyślne przypomnienia kalendarza mają zastosowanie do wydarzenia. zapisywalny
sequence integer Numer sekwencyjny według iCalendar. zapisywalny
source object Źródło, z którego zostało utworzone zdarzenie. Może to być na przykład strona internetowa, e-mail lub dowolny dokument, który można rozpoznać po adresie URL ze schematem HTTP lub HTTPS. Mogą być wyświetlane lub modyfikowane tylko przez twórcę wydarzenia.
source.title string Tytuł źródła, np. tytuł strony internetowej lub tematu e-maila. zapisywalny
source.url string Adres URL źródła wskazującego zasób. Schemat adresu URL musi zawierać protokół HTTP lub HTTPS. zapisywalny
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. zapisywalny
start.dateTime datetime Godzina w postaci połączonej wartości daty i godziny (w formacie RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że w polu timeZone wyraźnie określono strefę czasową. zapisywalny
start.timeZone string Strefa czasowa określonej strefy czasowej. Sformatowana jako nazwa bazy danych stref czasowych IANA, np. „Europa/Zurych”. W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której rozwija się powtarzanie. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/zakończenia wydarzenia. zapisywalny
status string Stan wydarzenia. Opcjonalnie. Możliwe wartości:
  • confirmed” – wydarzenie zostało potwierdzone. Jest to stan domyślny.
  • tentative” – wstępne wydarzenie zostało potwierdzone.
  • cancelled” – wydarzenie zostało anulowane (usunięte). Metoda list zwraca anulowane zdarzenia tylko podczas przyrostowej synchronizacji (gdy syncToken lub updatedMin) jest określona, lub jeśli flaga showDeleted jest ustawiona na true. Metoda get zawsze je zwraca.

    Stan „Anulowano” wskazuje dwa różne stany w zależności od typu zdarzenia:

    1. Anulowane wyjątki nieodwołanego wydarzenia cyklicznego wskazują, że ta instancja nie powinna być już widoczna dla użytkownika. Klienci powinni przechowywać te zdarzenia w czasie trwania nadrzędnego wydarzenia cyklicznego.

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

    2. Wszystkie inne anulowane wydarzenia odpowiadają usuniętym. Klienci powinni usunąć kopie zsynchronizowane lokalnie. Takie anulowane wydarzenia z czasem znikną, więc nie oczekuj, że będą dostępne bezterminowo.

      Usunięte wydarzenia mogą mieć tylko pole id.

    W kalendarzu organizatora anulowane wydarzenia nadal są ujawniane szczegóły wydarzenia (podsumowanie, lokalizacja itp.), dzięki czemu można je przywrócić. Analogicznie zdarzenia, na które użytkownik został zaproszony i które zostały ręcznie usunięte, nadal zawierają szczegóły. Jednak przyrostowe żądania synchronizacji z ustawieniem showDeleted ustawionym na fałsz nie spowodują wyświetlenia tych szczegółów.

    Jeśli organizator zmieni swojego organizatora (na przykład w wyniku wykonania operacji move), a pierwotny organizator nie znajduje się na liście uczestników, pozostanie w nim anulowane wydarzenie, w którym gwarantowane jest wypełnienie tylko pola id.

zapisywalny
summary string Nazwa wydarzenia, zapisywalny
transparency string Określa, czy wydarzenie blokuje czas w kalendarzu. Opcjonalnie. Możliwe wartości:
  • opaque” – wartość domyślna. To wydarzenie blokuje czas w kalendarzu. Odpowiada to ustawieniu Pokaż mój stan jako na Zajęty w interfejsie Kalendarza.
  • transparent” – wydarzenie nie blokuje czasu w kalendarzu. Odpowiada to ustawieniu Pokaż mi jako na wartość Dostępna w interfejsie Kalendarza.
zapisywalny
updated datetime Czas ostatniej modyfikacji zdarzenia (jako sygnatura czasowa 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 jego uczestnicy mogą wyświetlać szczegóły wydarzenia.
  • confidential” – jest prywatne. Ta wartość jest podana ze względu na zgodność.
zapisywalny
workingLocationProperties nested object Dane o lokalizacji miejsca pracy. Tylko do odczytu.
workingLocationProperties.customLocation object Ten parametr wskazuje, że użytkownik pracuje w lokalizacji niestandardowej.
workingLocationProperties.customLocation.label string Opcjonalna dodatkowa etykieta dla dodatkowych informacji.
workingLocationProperties.homeOffice any value Jeśli ta opcja jest dostępna, określa, że użytkownik pracuje w domu.
workingLocationProperties.officeLocation object Jeśli ta opcja jest dostępna, wskazuje, że użytkownik pracuje w biurze.
workingLocationProperties.officeLocation.buildingId string Opcjonalny identyfikator budynku. Powinien on odwoływać się do identyfikatora budynku w bazie danych zasobów organizacji.
workingLocationProperties.officeLocation.deskId string Opcjonalny identyfikator dowolnego biurka.
workingLocationProperties.officeLocation.floorId string Opcjonalny identyfikator dowolnego piętra.
workingLocationProperties.officeLocation.floorSectionId string Opcjonalny identyfikator dowolnego piętra.
workingLocationProperties.officeLocation.label string Opcjonalna dodatkowa etykieta dla dodatkowych informacji.

Metody

usuń
Usuwa wydarzenie.
pobierz
Zwraca wydarzenie na podstawie identyfikatora Kalendarza Google. Aby pobrać wydarzenie za pomocą jego identyfikatora iCalendar, wywołaj events.list przy użyciu parametru iCalUID.
import
Importuje wydarzenie. Ta operacja służy do dodawania do kalendarza prywatnej kopii istniejącego wydarzenia.
wstaw
Utworzy wydarzenie.
instancje
Zwraca wystąpienia określonego wydarzenia cyklicznego.
list
Zwraca wydarzenia z określonego kalendarza.
przenieś
Przenosi wydarzenie do innego kalendarza, tj. zmienia organizatora wydarzenia.
poprawka
Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Zwróć uwagę na to, że każde żądanie poprawki zużywa trzy jednostki limitu. Zalecamy użycie get, a następnie update. Podane wartości pól zastępują istniejące wartości. Pola, których nie określisz w żądaniu, pozostaną bez zmian. Pola tablicowe (jeśli zostały określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich poprzednich elementów tablicy.
szybkiedodawanie
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 get, a następnie update za pomocą tagów, aby zyskać uwagę.
zegarek
Śledź zmiany w zasobach dotyczących wydarzeń.