Events

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

Listę metod dostępnych 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 (funkcja wycofana). Opcjonalnie. Wartością domyślną jest False (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.

Każde wydarzenie może zawierać 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.

Przy dodawaniu załączników z Dysku Google używaj tego samego formatu co we właściwości alternateLink zasobu Files w interfejsie Drive API.

Wymagane podczas dodawania 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 reprezentacji wydarzenia. Podczas pobierania zdarzenia może to być spowodowane ograniczeniem określonym przez parametr zapytania maxAttendee. Podczas aktualizowania wydarzenia te opcje mogą być używane tylko do aktualizowania odpowiedzi uczestnika. Opcjonalnie. Wartością domyślną jest False (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. Opcjonalnie. z możliwością zapisu
attendees[].displayName string Imię i nazwisko uczestnika, jeśli są dostępne. Opcjonalnie. z możliwością zapisu
attendees[].email string Adres e-mail uczestnika, jeśli jest dostępny. To pole musi być obecne podczas dodawania uczestnika. Musi to być prawidłowy adres e-mail zgodny ze standardem RFC5322.

Wymagane podczas dodawania uczestnika.

z możliwością zapisu
attendees[].id string Identyfikator profilu uczestnika, jeśli jest dostępny.
attendees[].optional boolean Określa, czy jest to opcjonalny uczestnik. Opcjonalnie. Wartością domyślną jest False (Fałsz). z możliwością zapisu
attendees[].organizer boolean Określa, czy uczestnik jest organizatorem wydarzenia. Tylko do odczytu. Wartością domyślną jest False (Fałsz).
attendees[].resource boolean Określa, czy uczestnik jest zasobem. To ustawienie można skonfigurować tylko wtedy, gdy uczestnik jest dodawany do wydarzenia po raz pierwszy. Kolejne modyfikacje są ignorowane. Opcjonalnie. Wartością domyślną jest False (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 Czy wpis reprezentuje kalendarz, w którym znajduje się dana kopia wydarzenia. Tylko do odczytu. Wartością domyślną jest False (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 rozmową wideo, np. szczegóły rozmowy wideo 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, np. aaa-bbbb-ccc.
  • addOn: identyfikator jest definiowany przez zewnętrznego dostawcę.
Opcjonalnie.

conferenceData.conferenceSolution nested object Rozwiązanie do obsługi konferencji, na przykład Google Meet.

Nieskonfigurowane 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 konferencyjnego.

Jeśli klient napotka nieznany lub pusty typ, nadal powinien być w stanie wyświetlić punkty wejścia. Powinien on jednak zabronić wprowadzania 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" w przypadku klasycznej wersji Hangouts dla użytkowników Google Workspace (funkcja wycofana; w dotychczasowych wydarzeniach ten typ może być widoczny, ale nie będzie można tworzyć nowych rozmów wideo)
  • "hangoutsMeet" w Google Meet (http://meet.google.com)
  • "addOn" dla zewnętrznych dostawców usług konferencyjnych

conferenceData.conferenceSolution.name string Nazwa tego rozwiązania widoczna dla użytkownika. 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 konferencyjnego.

Jeśli klient napotka nieznany lub pusty typ, nadal powinien być w stanie wyświetlić punkty wejścia. Powinien on jednak zabronić wprowadzania 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" w przypadku klasycznej wersji Hangouts dla użytkowników Google Workspace (funkcja wycofana; w dotychczasowych wydarzeniach ten typ może być widoczny, ale nie będzie można tworzyć nowych rozmów wideo)
  • "hangoutsMeet" w Google Meet (http://meet.google.com)
  • "addOn" dla zewnętrznych dostawców usług konferencyjnych

conferenceData.createRequest.requestId string Wygenerowany przez klienta unikalny identyfikator dla 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 żądania utworzenia rozmowy wideo.
conferenceData.createRequest.status.statusCode string Bieżący stan żądania utworzenia rozmowy wideo. Tylko do odczytu.

Możliwe wartości to:

  • "pending": prośba o utworzenie rozmowy wideo jest nadal przetwarzana.
  • "success": żądanie utworzenia konferencji zostało zrealizowane, punkty wejścia zostały uzupeł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 one 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 umożliwiający dostęp do konferencji. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych rozmowy wideo wypełnij tylko podzbiór tych pól: {meetingCode, accessCode, passcode, password, pin}, które odpowiadają terminologii używanej przez organizatora konferencji. Powinny wyświetlać się tylko wypełnione pola.

Opcjonalnie.

conferenceData.entryPoints[].entryPointType string Typ punktu wejścia na konferencję.

Możliwe wartości to:

  • "video" – dołączanie do rozmowy wideo przez HTTP. Rozmowa wideo 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. Rozmowa wideo może mieć 0 lub 1 punkt wejścia sip.
  • "more" – dalsze instrukcje dołączania do konferencji, np. dodatkowe numery telefonów. Rozmowa wideo może mieć 0 lub 1 punkt wejścia more. Rozmowa wideo, do której przypisano 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 wypełnij tylko podzbiór tych pól: {meetingCode, accessCode, passcode, password, pin}, które odpowiadają terminologii używanej przez organizatora konferencji. Powinny wyświetlać się tylko wypełnione pola.

Opcjonalnie.

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

Podczas tworzenia nowych danych rozmowy wideo wypełnij tylko podzbiór tych pól: {meetingCode, accessCode, passcode, password, pin}, które odpowiadają terminologii używanej przez organizatora konferencji. Powinny wyświetlać się 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 wypełnij tylko podzbiór tych pól: {meetingCode, accessCode, passcode, password, pin}, które odpowiadają terminologii używanej przez organizatora konferencji. Powinny wyświetlać się 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 wypełnij tylko podzbiór tych pól: {meetingCode, accessCode, passcode, password, pin}, które odpowiadają terminologii używanej przez organizatora konferencji. Powinny wyświetlać się 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.
  • phone: wymagany jest schemat tel:. Identyfikator URI powinien zawierać całą sekwencję wybierania numerów (np. tel:+12345678900,,123456789;1234).
  • dla sip wymagany jest schemat sip:, np. sip:12345678@mojdostawca.com.
  • dla schematu more, http: lub https: jest wymagany.

conferenceData.notes string Dodatkowe uwagi (takie jak instrukcje od administratora domeny czy informacje prawne) do wyświetlenia użytkownikowi. Może zawierać kod HTML. Maksymalna długość to 2048 znaków. Opcjonalnie.
conferenceData.signature string Podpis danych konferencji.

Wygenerowane po stronie serwera.

Nieskonfigurowane 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 pojawia się dana kopia wydarzenia. Tylko do odczytu. Wartością domyślną jest False (Fałsz).
description string Opis wydarzenia. Może zawierać kod HTML. Opcjonalnie. z możliwością zapisu
end nested object Czas zakończenia wydarzenia (wyłącznie). W przypadku wydarzenia cyklicznego jest to czas zakończenia pierwszego wystąpienia.
end.date date Data w formacie „rrrr-mm-dd”, jeśli jest to wydarzenie całodniowe. z możliwością zapisu
end.dateTime datetime Czas jako łączna wartość daty i godziny (sformatowana zgodnie z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że wyraźnie określisz strefę czasową w 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ą, do 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 Określa, czy godzina zakończenia nie jest podana. W celu zapewnienia zgodności nadal podany jest czas zakończenia, nawet jeśli ten atrybut ma wartość True. Wartością domyślną jest False (Fałsz).
etag etag ETag zasobu.
eventType string Konkretny typ wydarzenia. Po utworzeniu wydarzenia nie można zmienić tego ustawienia. Możliwe wartości:
  • default” – zwykłe wydarzenie lub nieokreślone dalej.
  • outOfOffice” – wydarzenie poza biurem.
  • focusTime” – wydarzenie typu czas skupienia.
  • workingLocation” – wydarzenie w lokalizacji miejsca pracy.
Obecnie za pomocą interfejsu API można tworzyć tylko zdarzenia „default” i „workingLocation”. Rozszerzona obsługa innych typów zdarzeń zostanie udostępniona w późniejszych wersjach.
z możliwością zapisu
extendedProperties object Rozszerzone właściwości zdarzenia.
extendedProperties.private object Właściwości, które są prywatne dla kopii wydarzenia widocznego w tym kalendarzu. z możliwością zapisu
extendedProperties.private.(key) string Nazwa właściwości prywatnej i odpowiadająca jej wartość.
extendedProperties.shared object Właściwości współdzielone między kopiami wydarzenia w kalendarzach innych uczestników. z możliwością zapisu
extendedProperties.shared.(key) string Nazwa współdzielonej 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 spotkania nie są odrzucane; declineAllConflictingInvitations oznacza, że wszystkie kolidujące zaproszenia na spotkania będące w konflikcie z wydarzeniem są odrzucane. Prawidłowe wartości to declineOnlyNewConflictingInvitations, czyli tylko nowe zaproszenia na spotkania będące w konflikcie, które nadejdą podczas wydarzenia w czasie skupienia, będą odrzucane.
focusTimeProperties.chatStatus string Stan oznaczający użytkownika w Google Chat i usługach powiązanych. Możliwe wartości to available lub doNotDisturb.
focusTimeProperties.declineMessage string Wiadomość z odpowiedzią, którą należy ustawić, jeśli istniejące wydarzenie lub nowe zaproszenie mają być automatycznie odrzucane przez Kalendarz.
gadget object Gadżet, który rozszerza to wydarzenie. Gadżety nie są już używane. Ta struktura jest używana tylko do zwracania metadanych z 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 wyświetla się po kliknięciu wydarzenia.
z możliwością zapisu
gadget.height integer Wysokość gadżetów 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 innych. 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 False (Fałsz). z możliwością zapisu
guestsCanSeeOtherGuests boolean Określa, czy uczestnicy inni niż organizator mogą zobaczyć, kim są uczestnicy wydarzenia. Opcjonalnie. Wartość domyślna to True. z możliwością zapisu
iCalUID string Unikalny identyfikator zdarzenia, zgodnie z definicją w dokumencie RFC5545. Służy on do jednoznacznej identyfikacji wydarzeń w systemach kalendarzy i musi być podawany podczas importowania wydarzeń za pomocą metody import.

Zwróć uwagę, że podczas tworzenia wydarzenia właściwości iCalUID i id nie są identyczne. Należy podać tylko jeden z nich. Jedna z różnic w ich semantyce polega na tym, że w przypadku wydarzeń cyklicznych wszystkie wystąpienia jednego zdarzenia mają różne zdarzenia id, ale wszystkie mają te same parametry iCalUID. Aby pobrać zdarzenie za pomocą parametru iCalUID, wywołaj metodę events.list, używając parametru iCalUID. Aby pobrać zdarzenie za pomocą jego 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:
  • Identyfikator jest dozwolony w przypadku kodowania base32hex, tj.małych liter a–v i cyfr 0–9; patrz sekcja 3. 1.2 w RFC2938.
  • identyfikator musi mieć od 5 do 1024 znaków
  • identyfikator musi być unikalny dla każdego kalendarza
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 określisz identyfikatora, zostanie on wygenerowany automatycznie przez serwer.

Zwróć uwagę, że podczas tworzenia wydarzenia właściwości icalUID i id nie są identyczne. Należy podać tylko jeden z nich. Jedna z różnic w ich semantyce polega na tym, że w przypadku wydarzeń cyklicznych wszystkie wystąpienia jednego zdarzenia mają różne zdarzenia id, ale wszystkie mają te same parametry icalUID.

z możliwością zapisu
kind string Typ zasobu („calendar#event”).
location string Położenie geograficzne wydarzenia w formie 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 głównych polach zdarzenia: „summary”, „description”, „location”, „start”, „end” i „recurrence”. Wartością domyślną jest False (Fałsz). Tylko do odczytu.
organizer object Organizator wydarzenia. Jeśli organizator jest też uczestnikiem, jest to wskazane z oddzielnym wpisem w attendees z polem organizer ustawionym na wartość Prawda. Aby zmienić organizatora, użyj operacji move. 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 Wskazuje, czy organizator odpowiada kalendarzowi, w którym pojawia się ta kopia wydarzenia. Tylko do odczytu. Wartością domyślną jest False (Fałsz).
originalStartTime nested object W przypadku wydarzenia cyklicznego jest to czas rozpoczęcia danego zdarzenia, zgodnie z danymi powtarzania w zdarzeniu cyklicznego wskazywanym przez parametr fragment wydarzenia cyklicznego. Identyfikuje on instancję w ramach serii wydarzeń cyklicznych, nawet jeśli została przeniesiona do innego czasu. Niezmienne.
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 z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że wyraźnie określisz strefę czasową w 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ą, do 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 zdarzeniach Poza biurem. Używana, jeśli eventType ma wartość outOfOffice. z możliwością zapisu
outOfOfficeProperties.autoDeclineMode string Określa, 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 spotkania nie są odrzucane; declineAllConflictingInvitations oznacza, że wszystkie kolidujące zaproszenia na spotkania będące w konflikcie z wydarzeniem są odrzucane. Z kolei declineOnlyNewConflictingInvitations oznacza, że odrzucone będą tylko nowe zaproszenia na spotkania będące w konflikcie, które zostały wysłane w czasie trwania wydarzenia Poza biurem.
outOfOfficeProperties.declineMessage string Wiadomość z odpowiedzią, którą należy ustawić, jeśli istniejące wydarzenie lub nowe zaproszenie mają być automatycznie odrzucane przez Kalendarz.
privateCopy boolean Jeśli ma wartość Prawda, propagacja zdarzeń jest wyłączona. Pamiętaj, że to nie to samo co Właściwości wydarzenia prywatnego. Opcjonalnie. Niezmienne. Wartością domyślną jest False (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ą podane w polach start i end. To pole jest pomijane w przypadku pojedynczych wydarzeń lub wystąpień wydarzeń cyklicznych. z możliwością zapisu
recurringEventId string W przypadku wydarzenia cyklicznego jest to wartość id wydarzenia cyklicznego, do którego należy to wystąpienie. Niezmienne.
reminders object Informacje o przypomnieniach o wydarzeniu dla uwierzytelnionego użytkownika.
reminders.overrides[] list Jeśli wydarzenie nie korzysta z przypomnień domyślnych, wyświetla się lista przypomnień związanych z tym wydarzeniem lub, jeśli nie jest skonfigurowana, oznacza, że dla tego wydarzenia nie ustawiono przypomnień. Maksymalna liczba przypomnień o zastąpieniu wynosi 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 w interfejsie.

Wymagane podczas dodawania przypomnienia.

z możliwością zapisu
reminders.overrides[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, na którą powinno zostać aktywowane przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40320 (4 tygodnie w minutach).

Wymagane podczas dodawania 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 iCalendar. z możliwością zapisu
source object Źródło, z którego utworzono zdarzenie. Przykładem może być strona internetowa, e-mail lub dowolny dokument możliwy do zidentyfikowania na podstawie adresu URL w schemacie HTTP lub HTTPS. Może je wyświetlać lub modyfikować tylko twórca wydarzenia.
source.title string Tytuł źródła, na przykład tytuł strony internetowej lub temat e-maila. z możliwością zapisu
source.url string Adres URL źródła wskazującego zasób. Schematem adresu URL musi być HTTP lub HTTPS. z możliwością zapisu
start nested object Godzina rozpoczęcia (włącznie z tym dniem) 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 z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że wyraźnie określisz strefę czasową w 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ą, do 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 określono syncToken lub updatedMin) lub jeśli flaga showDeleted jest ustawiona na true. Metoda get zawsze je zwraca.

    W zależności od typu wydarzenia stan „Anulowano” ma 2 stany:

    1. Anulowane wyjątki dotyczące nieanulowanego wydarzenia cyklicznego oznaczają, ż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 muszą mieć wypełnione wartości w polach id, recurringEventId i originalStartTime. Inne pola mogą być puste.

    2. Wszystkie pozostałe anulowane wydarzenia odnoszą się do usuniętych wydarzeń. Klient powinien usunąć swoje kopie synchronizowane lokalnie. Takie anulowane wydarzenia po pewnym czasie znikną, więc nie czekaj, aż będą dostępne przez cały czas.

      Tylko usunięte wydarzenia będą mieć wypełnione pole id.

    W kalendarzu organizatora anulowane wydarzenia nadal udostępniają szczegóły wydarzenia (podsumowanie, lokalizację itp.), aby można je było przywrócić (cofnąć usunięcie). Szczegóły są też dostępne w przypadku wydarzeń, na które użytkownik został zaproszony i który został usunięty ręcznie. Przyrostowe żądania synchronizacji z ustawieniem showDeleted jako false (fałsz) nie zwrócą jednak tych informacji.

    Jeśli wydarzenie zmieni organizatora (na przykład przez operację przenoszenia), a oryginalnego organizatora nie będzie na liście uczestników, pozostanie anulowane wydarzenie, w którym zagwarantowane 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ż mój stan 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” – używa domyślnej widoczności wydarzeń w kalendarzu. jest to wartość domyślna
  • public” – wydarzenie jest publiczne, a szczegóły wydarzenia 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 w lokalizacji miejsca pracy. z możliwością zapisu
workingLocationProperties.customLocation object Jeśli ten parametr występuje, wskazuje, że użytkownik pracuje w lokalizacji niestandardowej. z możliwością zapisu
workingLocationProperties.customLocation.label string Opcjonalna dodatkowa etykieta informująca o dodatkowych informacjach. z możliwością zapisu
workingLocationProperties.homeOffice any value Jeśli ten parametr jest obecny, określa, że użytkownik pracuje w domu. z możliwością zapisu
workingLocationProperties.officeLocation object Jeśli ten atrybut jest obecny, 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 na urządzeniach 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 o określonej nazwie znajdują się wszystkie szczegóły, ale tego pola może brakować, jeśli jest puste. 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 Kalendarza Google. Aby pobrać zdarzenie przy użyciu jego identyfikatora iCalendar, wywołaj metodę events.list przy użyciu parametru iCalUID.
import
Importuje wydarzenie. Ta operacja pozwala dodać prywatną kopię istniejącego wydarzenia do kalendarza.
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 typu default. Nie można przenosić wydarzeń outOfOffice, focusTime i workingLocation.
poprawka
Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. Lepiej użyć obiektu get, po którym następuje update. Określone przez Ciebie wartości pól zastępują obecne wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy (jeśli są 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 przeprowadzić częściową aktualizację, wykonaj get, a następnie update, używając tagów w celu zapewnienia niepokoju.
zegarek
Obserwuj zmiany w zasobach dotyczących wydarzeń.