Events

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

Listę metod dla tego zasobu znajdziesz na końcu tej strony.

Reprezentacje zasobów

{
  "kind": "calendar#event",
  "etag": etag,
  "id": string,
  "status": string,
  "htmlLink": string,
  "created": datetime,
  "updated": datetime,
  "summary": string,
  "description": string,
  "location": string,
  "colorId": string,
  "creator": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "organizer": {
    "id": string,
    "email": string,
    "displayName": string,
    "self": boolean
  },
  "start": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "end": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "endTimeUnspecified": boolean,
  "recurrence": [
    string
  ],
  "recurringEventId": string,
  "originalStartTime": {
    "date": date,
    "dateTime": datetime,
    "timeZone": string
  },
  "transparency": string,
  "visibility": string,
  "iCalUID": string,
  "sequence": integer,
  "attendees": [
    {
      "id": string,
      "email": string,
      "displayName": string,
      "organizer": boolean,
      "self": boolean,
      "resource": boolean,
      "optional": boolean,
      "responseStatus": string,
      "comment": string,
      "additionalGuests": integer
    }
  ],
  "attendeesOmitted": boolean,
  "extendedProperties": {
    "private": {
      (key): string
    },
    "shared": {
      (key): string
    }
  },
  "hangoutLink": string,
  "conferenceData": {
    "createRequest": {
      "requestId": string,
      "conferenceSolutionKey": {
        "type": string
      },
      "status": {
        "statusCode": string
      }
    },
    "entryPoints": [
      {
        "entryPointType": string,
        "uri": string,
        "label": string,
        "pin": string,
        "accessCode": string,
        "meetingCode": string,
        "passcode": string,
        "password": string
      }
    ],
    "conferenceSolution": {
      "key": {
        "type": string
      },
      "name": string,
      "iconUri": string
    },
    "conferenceId": string,
    "signature": string,
    "notes": string,
  },
  "gadget": {
    "type": string,
    "title": string,
    "link": string,
    "iconLink": string,
    "width": integer,
    "height": integer,
    "display": string,
    "preferences": {
      (key): string
    }
  },
  "anyoneCanAddSelf": boolean,
  "guestsCanInviteOthers": boolean,
  "guestsCanModify": boolean,
  "guestsCanSeeOtherGuests": boolean,
  "privateCopy": boolean,
  "locked": boolean,
  "reminders": {
    "useDefault": boolean,
    "overrides": [
      {
        "method": string,
        "minutes": integer
      }
    ]
  },
  "source": {
    "url": string,
    "title": string
  },
  "workingLocationProperties": {
    "type": string,
    "homeOffice": (value),
    "customLocation": {
      "label": string
    },
    "officeLocation": {
      "buildingId": string,
      "floorId": string,
      "floorSectionId": string,
      "deskId": string,
      "label": string
    }
  },
  "outOfOfficeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string
  },
  "focusTimeProperties": {
    "autoDeclineMode": string,
    "declineMessage": string,
    "chatStatus": string
  },
  "attachments": [
    {
      "fileUrl": string,
      "title": string,
      "mimeType": string,
      "iconLink": string,
      "fileId": string
    }
  ],
  "birthdayProperties": {
    "contact": string,
    "type": string,
    "customTypeName": string
  },
  "eventType": string
}
Nazwa usługi Wartość Opis Uwagi
anyoneCanAddSelf boolean Określa, czy każdy może zaprosić się na wydarzenie (wartość wycofana). Opcjonalnie. Wartość domyślna to False (fałsz). z możliwością zapisu,
attachments[] list Załączniki do wydarzenia.

Aby zmodyfikować załączniki, parametr żądania supportsAttachments musi mieć wartość true.

Do każdego wydarzenia można dodać 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 Link URL do załącznika.

Do dodawania 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 Typ MIME załącznika.
attachments[].title string Tytuł załącznika.
attendeesOmitted boolean Określa, czy uczestnicy mogli zostać pominięci w reprezentacji wydarzenia. Podczas pobierania zdarzenia może to być spowodowane ograniczeniem określonym przez parametr zapytania maxAttendee. Podczas aktualizowania wydarzenia można użyć tego parametru, aby zaktualizować tylko odpowiedź uczestnika. Opcjonalnie. Wartość domyślna to 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 dostępu w całej domenie. z możliwością zapisu,
attendees[].additionalGuests integer Liczba dodatkowych gości. Opcjonalnie. Wartość domyślna to 0. z możliwością zapisu,
attendees[].comment string Komentarz uczestnika do odpowiedzi. Opcjonalnie. z możliwością zapisu,
attendees[].displayName string Imię i nazwisko uczestnika (jeśli są dostępne). Opcjonalnie. z możliwością zapisu,
attendees[].email string Adres e-mail uczestnika, jeśli jest dostępny. To pole musi być obecne podczas dodawania uczestnika. Musi to być prawidłowy adres e-mail zgodnie z RFC5322.

Wymagane podczas dodawania uczestnika.

z możliwością zapisu,
attendees[].id string Identyfikator profilu uczestnika (jeśli jest dostępny).
attendees[].optional boolean Określ, czy uczestnik jest opcjonalny. Opcjonalnie. Wartość domyślna to False (fałsz). z możliwością zapisu,
attendees[].organizer boolean Określa, czy uczestnik jest organizatorem wydarzenia. Tylko do odczytu. Wartość domyślna to False (fałsz).
attendees[].resource boolean Określa, czy uczestnik jest zasobem. Można ustawić tylko wtedy, gdy uczestnik jest dodawany do wydarzenia po raz pierwszy. Kolejne modyfikacje są ignorowane. Opcjonalnie. Wartość domyślna to 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 Określa, czy ten wpis reprezentuje kalendarz, w którym pojawia się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to False (fałsz).
birthdayProperties nested object dane dotyczące urodzin lub specjalnych wydarzeń; Używane, jeśli wartość parametru eventType to "birthday". Niezmienne. z możliwością zapisu,
birthdayProperties.contact string Nazwa zasobu kontaktu, z którym powiązane jest to wydarzenie związane z urodzinami. Można go używać do pobierania szczegółów kontaktu z People API. Format: "people/c12345". Tylko do odczytu.
birthdayProperties.customTypeName string Dla tego zdarzenia określono etykietę typu niestandardowego. To pole jest wypełniane, jeśli pole birthdayProperties.type ma wartość "custom". Tylko do odczytu.
birthdayProperties.type string Rodzaj urodzin lub specjalnego wydarzenia. Możliwe wartości:
  • "anniversary" – rocznica inna niż urodziny. Zawsze ma contact.
  • "birthday" – wydarzenie związane z urodzinami. Jest to wartość domyślna.
  • "custom" – specjalna data, której etykieta jest określona w polu customTypeName. Zawsze ma contact.
  • "other" – specjalna data, która nie pasuje do innych kategorii i nie ma niestandardowej etykiety. Zawsze ma contact.
  • "self" – urodziny właściciela kalendarza. Nie może zawierać contact.
Interfejs Calendar API obsługuje tylko tworzenie wydarzeń typu "birthday". Po utworzeniu wydarzenia nie można zmienić jego typu.
z możliwością zapisu,
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 konferencji, użyj pola createRequest. Aby zachować zmiany, pamiętaj, aby w przypadku wszystkich żądań modyfikacji zdarzeń ustawić parametr żądania conferenceDataVersion na 1. z możliwością zapisu,
conferenceData.conferenceId string Identyfikator konferencji.

Może być używany przez deweloperów do śledzenia konferencji, nie powinien być wyświetlany użytkownikom.

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

  • eventHangout: identyfikator nie jest ustawiony. (Ten typ konferencji został wycofany).
  • eventNamedHangout: ID to nazwa Hangouta. (Ten typ konferencji został wycofany).
  • hangoutsMeet: ID to 10-znakowy kod spotkania, np. aaa-bbbb-ccc.
  • addOn: identyfikator jest określany przez dostawcę zewnętrznego.
 Opcjonalnie.

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

Nieustawione w przypadku konferencji, w przypadku której żądanie utworzenia nie powiodło się.

Wymagane są właściwości conferenceSolution i co najmniej jedna właściwość entryPoint lub właściwość createRequest.

conferenceData.conferenceSolution.iconUri string Ikona tego rozwiązania 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, powinien nadal móc wyświetlać punkty wejścia. Powinien jednak uniemożliwiać modyfikacje.

Możliwe wartości to:

  • "eventHangout" w przypadku Hangouts dla użytkowników indywidualnych (wycofane; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania do rozmów wideo, ale nie można tworzyć nowych konferencji);
  • "eventNamedHangout" w przypadku klasycznej wersji Hangouts dla użytkowników Google Workspace (wycofana; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania konferencyjnego, ale nie można tworzyć nowych konferencji);
  • "hangoutsMeet" Google Meet (http://meet.google.com)
  • "addOn" dla dostawców usług konferencyjnych innych firm

conferenceData.conferenceSolution.name string Nazwa tego rozwiązania widoczna dla użytkowników. Nie jest zlokalizowana.
conferenceData.createRequest nested object Prośba o wygenerowanie nowej rozmowy wideo i dołączenie jej do wydarzenia. Dane są generowane asynchronicznie. Aby sprawdzić, czy dane są obecne, sprawdź pole status.

Wymagane są właściwości conferenceSolution i co najmniej jedna właściwość entryPoint lub właściwość createRequest.

conferenceData.createRequest.conferenceSolutionKey nested object Rozwiązanie do obsługi konferencji, np. Hangouts lub Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Typ rozwiązania do obsługi konferencji.

Jeśli klient napotka nieznany lub pusty typ, powinien nadal móc wyświetlać punkty wejścia. Powinien jednak uniemożliwiać modyfikacje.

Możliwe wartości to:

  • "eventHangout" w przypadku Hangouts dla użytkowników indywidualnych (wycofane; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania do rozmów wideo, ale nie można tworzyć nowych konferencji);
  • "eventNamedHangout" w przypadku klasycznej wersji Hangouts dla użytkowników Google Workspace (wycofana; istniejące wydarzenia mogą wyświetlać ten typ rozwiązania konferencyjnego, ale nie można tworzyć nowych konferencji);
  • "hangoutsMeet" Google Meet (http://meet.google.com)
  • "addOn" dla dostawców usług konferencyjnych innych firm

conferenceData.createRequest.requestId string Unikalny identyfikator wygenerowany przez klienta dla tego żądania.

Klienci powinni generować ten identyfikator w przypadku każdej nowej prośby. Jeśli podany identyfikator jest taki sam jak w przypadku poprzedniego żądania, żądanie jest ignorowane.

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

Możliwe wartości to:

  • "pending": prośba o utworzenie konferencji jest nadal przetwarzana.
  • "success": żądanie utworzenia konferencji zostało zrealizowane, punkty wejścia zostały wypełnione.
  • "failure": nie udało się utworzyć rozmowy wideo, nie ma 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.

Wymagane są właściwości conferenceSolution i co najmniej jedna właściwość entryPoint lub właściwość createRequest.

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

Podczas tworzenia nowych danych konferencji wypełniaj tylko podzbiór pól {meetingCode, accessCode, passcode, password, pin}, które pasują do terminologii używanej przez dostawcę konferencji. Wyświetlane powinny być tylko wypełnione pola.

Opcjonalnie.

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

Możliwe wartości to:

  • "video" – dołączanie do konferencji przez HTTP. Rozmowa wideo może mieć 0 lub 1 punkt wejścia video.
  • "phone" – dołączanie do konferencji przez wybranie numeru telefonu. Konferencja może mieć zero lub więcej phone punktów wejścia.
  • "sip" – dołączanie do konferencji 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 z tylko jednym punktem wejścia more nie jest prawidłową rozmową.

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

Przykłady:

  • dla video: meet.google.com/aaa-bbbb-ccc
  • dla phone: +1 123 268 2601
  • dla sip: 12345678@altostrat.com
  • W przypadku 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 konferencji wypełniaj tylko podzbiór pól {meetingCode, accessCode, passcode, password, pin}, które pasują do terminologii używanej przez dostawcę konferencji. Wyświetlane powinny być 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 konferencji wypełniaj tylko podzbiór pól {meetingCode, accessCode, passcode, password, pin}, które pasują do terminologii używanej przez dostawcę konferencji. Wyświetlane powinny być tylko wypełnione pola.

conferenceData.entryPoints[].password string Hasło dostępu do konferencji. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych konferencji wypełniaj tylko podzbiór pól {meetingCode, accessCode, passcode, password, pin}, które pasują do terminologii używanej przez dostawcę konferencji. Wyświetlane powinny być 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 konferencji wypełniaj tylko podzbiór pól {meetingCode, accessCode, passcode, password, pin}, które pasują do terminologii używanej przez dostawcę konferencji. Wyświetlane powinny być 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: wymagany jest schemat.
  • W przypadku phone wymagany jest schemat tel:. URI powinien zawierać całą sekwencję wybierania (np. tel:+12345678900,,,123456789;1234).
  • W przypadku sipsip: wymagany jest schemat, np. sip:12345678@myprovider.com.
  • W przypadku schematu more, http: lub https: wymagany jest schemat.

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

Wygenerowany po stronie serwera.

Nieustawione w przypadku konferencji, w przypadku której żądanie utworzenia nie powiodło się.

Opcjonalne w przypadku konferencji z oczekującą prośbą o utworzenie.

created datetime Czas utworzenia wydarzenia (sygnatura czasowa w formacie 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 Czy twórca odpowiada kalendarzowi, w którym pojawia się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to False (fałsz).
description string Opis wydarzenia. Może zawierać kod HTML. Opcjonalnie. z możliwością zapisu,
end nested object Godzina zakończenia wydarzenia (wyłą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 połączona wartość daty i godziny (sformatowana zgodnie ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w timeZone. z możliwością zapisu,
end.timeZone string Strefa czasowa, w której podano czas. (W formacie nazwy z bazy danych stref czasowych IANA, np. „Europe/Zurich”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozwijane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia lub zakończenia wydarzenia. z możliwością zapisu,
endTimeUnspecified boolean Określa, czy czas zakończenia jest rzeczywiście nieokreślony. Czas zakończenia jest nadal podawany ze względu na zgodność, nawet jeśli ten atrybut ma wartość „True”. Wartość domyślna to False (fałsz).
etag etag ETag zasobu.
eventType string Konkretny typ zdarzenia. Po utworzeniu wydarzenia nie można zmienić tego ustawienia. Możliwe wartości:
  • birthday” – specjalne wydarzenie całodniowe, które powtarza się co roku.
  • default” – zwykłe wydarzenie lub nieokreślone.
  • focusTime” – wydarzenie czasu skupienia.
  • fromGmail” – wydarzenie z Gmaila. Nie można utworzyć tego typu wydarzenia.
  • outOfOffice” – wydarzenie poza biurem.
  • 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 kopii wydarzenia wyświetlanej w tym kalendarzu. z możliwością zapisu,
extendedProperties.private.(key) string Nazwa właściwości prywatnej i odpowiednia wartość.
extendedProperties.shared object Właściwości, które są udostępniane między kopiami wydarzenia w kalendarzach innych uczestników. z możliwością zapisu,
extendedProperties.shared.(key) string Nazwa udostępnionej właściwości i odpowiednia wartość.
focusTimeProperties nested object dane wydarzenia typu czas skupienia; Używane, jeśli wartość parametru eventType to focusTime. z możliwością zapisu,
focusTimeProperties.autoDeclineMode string Czy odrzucać zaproszenia na spotkania, które pokrywają się z wydarzeniami typu czas skupienia. Prawidłowe wartości to declineNone, co oznacza, że żadne zaproszenia na spotkania nie są odrzucane; declineAllConflictingInvitations, co oznacza, że wszystkie zaproszenia na spotkania, które powodują konflikt z wydarzeniem, są odrzucane; oraz declineOnlyNewConflictingInvitations, co oznacza, że odrzucane są tylko nowe zaproszenia na spotkania, które powodują konflikt z wydarzeniem Czas skupienia i które przychodzą w trakcie tego wydarzenia.
focusTimeProperties.chatStatus string Stan, który ma być przypisany użytkownikowi w Google Chat i powiązanych usługach. Może to być available lub doNotDisturb.
focusTimeProperties.declineMessage string Wiadomość z odpowiedzią, która zostanie ustawiona, jeśli Kalendarz automatycznie odrzuci istniejące wydarzenie lub nowe zaproszenie.
gadget object Gadżet, który rozszerza to zdarzenie. Gadżety zostały wycofane. Ta struktura jest używana tylko do zwracania metadanych kalendarza urodzin.
gadget.display string Tryb wyświetlania gadżetu. Rola wycofana. Możliwe wartości:
  • icon” – gadżet wyświetla się obok tytułu wydarzenia w widoku kalendarza.
  • chip” – gadżet wyświetla się po kliknięciu zdarzenia.
z możliwością zapisu,
gadget.height integer Wysokość gadżetu w pikselach. Wysokość musi być liczbą całkowitą większą od 0. Opcjonalnie. Rola wycofana. z możliwością zapisu,
gadget.preferences object Ustawienia. z możliwością zapisu,
gadget.preferences.(key) string Nazwa ustawienia i odpowiadająca mu wartość.
gadget.title string Tytuł gadżetu. Rola wycofana. z możliwością zapisu,
gadget.type string Typ gadżetu. Rola wycofana. z możliwością zapisu,
gadget.width integer Szerokość gadżetu w pikselach. Szerokość musi być liczbą całkowitą większą od 0. Opcjonalnie. Rola wycofana. z możliwością zapisu,
guestsCanInviteOthers boolean Określa, czy uczestnicy inni niż organizator mogą zapraszać inne osoby na wydarzenie. Opcjonalnie. Wartość domyślna to True. z możliwością zapisu,
guestsCanModify boolean Czy uczestnicy inni niż organizator mogą modyfikować wydarzenie. Opcjonalnie. Wartość domyślna to False (fałsz). z możliwością zapisu,
guestsCanSeeOtherGuests boolean Określa, czy uczestnicy inni niż organizator mogą zobaczyć, kto bierze udział w wydarzeniu. Opcjonalnie. Wartość domyślna to True. z możliwością zapisu,
iCalUID string Unikalny identyfikator zdarzenia zdefiniowany w dokumencie RFC5545. Służy do jednoznacznego identyfikowania wydarzeń w systemach kalendarza i musi być podany podczas importowania wydarzeń za pomocą metody import.

Pamiętaj, że tagi iCalUIDid nie są identyczne i podczas tworzenia zdarzenia należy podać tylko jeden z nich. Jedną z różnic w ich semantyce jest to, że w przypadku wydarzeń 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, używając parametru iCalUID. Aby pobrać wydarzenie za pomocą jego id, wywołaj metodę events.get.

id string Nieprzezroczysty identyfikator zdarzenia. Podczas tworzenia nowych wydarzeń jednorazowych lub cyklicznych możesz określić ich identyfikatory. Podane identyfikatory muszą być zgodne z tymi regułami:
  • Dozwolone znaki w identyfikatorze to znaki używane w kodowaniu base32hex, 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 w przypadku każdego kalendarza;
Ze względu na globalny charakter systemu nie możemy zagwarantować, że kolizje identyfikatorów zostaną wykryte w momencie tworzenia zdarzenia. Aby zminimalizować ryzyko kolizji, zalecamy używanie sprawdzonego algorytmu UUID, takiego jak opisany w dokumencie RFC4122.

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

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

z możliwością zapisu,
kind string Typ zasobu („calendar#event”).
location string Geograficzna lokalizacja wydarzenia w formie dowolnego tekstu. Opcjonalnie. z możliwością zapisu,
locked boolean Określa, czy jest to zablokowana kopia wydarzenia, w której nie można wprowadzać zmian w głównych polach wydarzenia: „podsumowanie”, „opis”, „lokalizacja”, „początek”, „koniec” i „powtarzanie”. Wartość domyślna to False (fałsz). Tylko do odczytu.
organizer object Organizator wydarzenia. Jeśli organizator jest też uczestnikiem, jest to oznaczone osobnym wpisem w attendees z polem organizer ustawionym na wartość True. Aby zmienić organizatora, użyj operacji move. Tylko do odczytu, z wyjątkiem importowania zdarzenia. z możliwością zapisu,
organizer.displayName string Imię i nazwisko organizatora (jeśli jest dostępne). 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 zgodnie z RFC5322. z możliwością zapisu,
organizer.id string Identyfikator profilu organizatora (jeśli jest dostępny).
organizer.self boolean Czy organizator odpowiada kalendarzowi, w którym pojawia się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to False (fałsz).
originalStartTime nested object W przypadku wystąpienia wydarzenia cyklicznego jest to czas, w którym to wydarzenie powinno się rozpocząć zgodnie z danymi o powtarzaniu w wydarzeniu cyklicznym zidentyfikowanym przez recurringEventId. Unikalnie identyfikuje wystąpienie w serii wydarzeń cyklicznych, nawet jeśli zostało ono przeniesione na inny czas. 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 połączona wartość daty i godziny (sformatowana zgodnie ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w timeZone. z możliwością zapisu,
originalStartTime.timeZone string Strefa czasowa, w której podano czas. (W formacie nazwy z bazy danych stref czasowych IANA, np. „Europe/Zurich”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozwijane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia lub zakończenia wydarzenia. z możliwością zapisu,
outOfOfficeProperties nested object Dane o wydarzeniach poza biurem. Używane, jeśli wartość parametru eventType to outOfOffice. z możliwością zapisu,
outOfOfficeProperties.autoDeclineMode string Określa, czy odrzucać zaproszenia na spotkania, które pokrywają się z wydarzeniami poza biurem. Prawidłowe wartości to declineNone, co oznacza, że żadne zaproszenia na spotkania nie są odrzucane; declineAllConflictingInvitations, co oznacza, że wszystkie zaproszenia na spotkania, które powodują konflikt z wydarzeniem, są odrzucane; oraz declineOnlyNewConflictingInvitations, co oznacza, że odrzucane są tylko nowe zaproszenia na spotkania, które powodują konflikt z wydarzeniem „Poza biurem”.
outOfOfficeProperties.declineMessage string Wiadomość z odpowiedzią, która zostanie ustawiona, jeśli Kalendarz automatycznie odrzuci istniejące wydarzenie lub nowe zaproszenie.
privateCopy boolean Jeśli ma wartość Prawda, propagacja zdarzeń jest wyłączona. Pamiętaj, że nie jest to to samo co właściwości wydarzenia prywatnego. Opcjonalnie. Niezmienne. Wartość domyślna to False (fałsz).
recurrence[] list Lista wierszy RRULE, EXRULE, RDATE i EXDATE dla wydarzenia cyklicznego zgodnie ze specyfikacją RFC5545. Pamiętaj, że w tym polu nie są dozwolone wiersze DTSTART i DTEND. Godziny rozpoczęcia i zakończenia wydarzenia są podane w polach start i end. To pole jest pomijane w przypadku pojedynczych wydarzeń lub wystąpień wydarzeń cyklicznych. z możliwością zapisu,
recurringEventId string W przypadku wystąpienia wydarzenia cyklicznego jest to id wydarzenia cyklicznego, do którego należy to wystąpienie. Niezmienne.
reminders object Informacje o przypomnieniach o wydarzeniu dla uwierzytelnionego użytkownika. Pamiętaj, że zmiana przypomnień nie powoduje zmiany właściwości updated wydarzenia, w którym się znajdują.
reminders.overrides[] list Jeśli wydarzenie nie korzysta z domyślnych przypomnień, ta sekcja zawiera listę przypomnień dotyczących konkretnego wydarzenia lub informację, że dla tego wydarzenia nie ustawiono żadnych przypomnień. Maksymalna liczba przypomnień o zastąpieniu to 5. z możliwością zapisu,
reminders.overrides[].method string Metoda użyta 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.

z możliwością zapisu,
reminders.overrides[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, po upływie których ma się pojawić przypomnienie. Prawidłowe wartości to od 0 do 40 320 (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 z kalendarza. z możliwością zapisu,
sequence integer Numer sekwencyjny zgodny z formatem iCalendar. z możliwością zapisu,
source object Źródło, z którego utworzono zdarzenie. Może to być na przykład strona internetowa, e-mail lub dowolny dokument, który można zidentyfikować za pomocą adresu URL ze schematem HTTP lub HTTPS. Może być wyświetlana i modyfikowana tylko przez twórcę wydarzenia.
source.title string Tytuł źródła, np. tytuł strony internetowej lub temat e-maila. z możliwością zapisu,
source.url string Adres URL źródła wskazujący zasób. Schemat adresu URL musi być HTTP lub HTTPS. z możliwością zapisu,
start nested object Czas rozpoczęcia wydarzenia (włącznie z wartościami granicznymi). W przypadku wydarzenia cyklicznego jest to czas rozpoczęcia pierwszego wystąpienia.
start.date date Data w formacie „rrrr-mm-dd”, jeśli jest to wydarzenie całodniowe. z możliwością zapisu,
start.dateTime datetime Czas jako połączona wartość daty i godziny (sformatowana zgodnie ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w timeZone. z możliwością zapisu,
start.timeZone string Strefa czasowa, w której podano czas. (W formacie nazwy z bazy danych stref czasowych IANA, np. „Europe/Zurich”). W przypadku wydarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której powtarzanie jest rozwijane. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia lub zakończenia wydarzenia. z możliwością zapisu,
status string Stan zdarzenia. Opcjonalnie. Możliwe wartości:
  • confirmed” – wydarzenie zostało potwierdzone. Jest to stan domyślny.
  • tentative” – wydarzenie jest wstępnie potwierdzone.
  • cancelled” – wydarzenie zostało anulowane (usunięte). Metoda list zwraca anulowane wydarzenia tylko w przypadku synchronizacji przyrostowej (gdy określono syncToken lub updatedMin) lub jeśli flaga showDeleted ma wartość true. Metoda get zawsze je zwraca.

    Stan anulowania reprezentuje 2 różne stany w zależności od typu zdarzenia:

    1. Anulowane wyjątki nieanulowanego wydarzenia cyklicznego wskazują, że ta instancja nie powinna być już prezentowana użytkownikowi. Klienci powinni przechowywać te wydarzenia przez cały okres istnienia nadrzędnego wydarzenia cyklicznego.

      W przypadku anulowanych wyjątków gwarantujemy tylko wypełnienie pól id, recurringEventIdoriginalStartTime. Pozostałe pola mogą być puste.

    2. Wszystkie inne anulowane wydarzenia to usunięte wydarzenia. Klienci powinni usunąć lokalnie zsynchronizowane kopie. Takie odwołane wydarzenia znikną z czasem, więc nie możesz zakładać, że będą dostępne bezterminowo.

      W przypadku usuniętych zdarzeń gwarantujemy tylko wypełnienie pola id.

    W kalendarzu organizatora anulowane wydarzenia nadal zawierają szczegóły (podsumowanie, lokalizacja itp.), dzięki czemu można je przywrócić (cofnąć usunięcie). Podobnie wydarzenia, na które użytkownik został zaproszony i które ręcznie usunął, nadal dostarczają szczegółowych informacji. Żądania synchronizacji przyrostowej z parametrem showDeleted ustawionym na wartość false nie zwrócą jednak tych szczegółów.

    Jeśli organizator wydarzenia zmieni się (np. w wyniku operacji move), a pierwotny organizator nie znajduje się na liście uczestników, pozostanie po nim anulowane wydarzenie, w którym tylko pole id będzie na pewno wypełnione.

z możliwością zapisu,
summary string Nazwa wydarzenia, z możliwością zapisu,
transparency string Czy wydarzenie blokuje czas w kalendarzu. Opcjonalnie. Możliwe wartości:
  • opaque” – wartość domyślna. Wydarzenie blokuje czas w kalendarzu. Odpowiada to ustawieniu w interfejsie Kalendarza opcji Wyświetlaj mnie jako na Zajęty.
  • transparent” – wydarzenie nie blokuje czasu w kalendarzu. Odpowiada to ustawieniu opcji Wyświetlaj mnie jako na Dostępny w interfejsie Kalendarza.
z możliwością zapisu,
updated datetime Czas ostatniej modyfikacji głównych danych zdarzenia (sygnatura czasowa w formacie RFC3339). Aktualizowanie przypomnień o wydarzeniach nie spowoduje zmiany tego ustawienia. 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 osób, które mają dostęp do 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 o miejscu pracy. z możliwością zapisu,
workingLocationProperties.customLocation object Jeśli jest obecny, oznacza, że użytkownik pracuje z niestandardowej lokalizacji. z możliwością zapisu,
workingLocationProperties.customLocation.label string Opcjonalna dodatkowa etykieta z dodatkowymi informacjami. z możliwością zapisu,
workingLocationProperties.homeOffice any value Jeśli jest obecny, określa, że użytkownik pracuje w domu. z możliwością zapisu,
workingLocationProperties.officeLocation object Jeśli ta opcja jest dostępna, oznacza, że użytkownik pracuje w biurze. z możliwością zapisu,
workingLocationProperties.officeLocation.buildingId string Opcjonalny identyfikator budynku. Powinien on odwoływać się do identyfikatora budynku w bazie danych zasobów organizacji. z możliwością zapisu,
workingLocationProperties.officeLocation.deskId string Opcjonalny identyfikator biurka. z możliwością zapisu,
workingLocationProperties.officeLocation.floorId string Opcjonalny identyfikator piętra. z możliwością zapisu,
workingLocationProperties.officeLocation.floorSectionId string Opcjonalny identyfikator obszaru piętra. z możliwością zapisu,
workingLocationProperties.officeLocation.label string Nazwa biura wyświetlana w Kalendarzu w przeglądarce i na urządzeniach mobilnych. Zalecamy odwoływanie się do 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 z niestandardowej lokalizacji.
 Wszelkie szczegóły są podane w polu podrzędnym określonej nazwy, ale to pole może być puste. Pozostałe pola są ignorowane.

Wymagane podczas dodawania właściwości lokalizacji miejsca pracy.

z możliwością zapisu,

Metody

usuń
Usuwa wydarzenie.
get
Zwraca wydarzenie na podstawie jego identyfikatora w Kalendarzu Google. Aby pobrać wydarzenie za pomocą identyfikatora iCalendar, wywołaj metodę events.list, używając parametru iCalUID.
import
Importuje wydarzenie. Ta operacja służy do dodawania prywatnej kopii istniejącego wydarzenia do kalendarza. Można importować tylko zdarzenia z wartością eventType równą default.

Wycofane działanie: jeśli zaimportowane zostanie zdarzenie inne niż default, jego typ zostanie zmieniony na default, a wszystkie właściwości specyficzne dla typu zdarzenia zostaną usunięte.

wstaw
Tworzy wydarzenie.
instancje
Zwraca wystąpienia określonego wydarzenia cyklicznego.
list
Zwraca wydarzenia w określonym kalendarzu.
przenieść
Przenosi wydarzenie do innego kalendarza, czyli zmienia organizatora wydarzenia. Pamiętaj, że można przenosić tylko zdarzenia default. Nie można przenosić zdarzeń birthday, focusTime, fromGmail, outOfOffice ani workingLocation.
patch
Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie PATCH zużywa 3 jednostki limitu. Zalecamy używanie żądania get, a potem żądania update. Podane wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz w żądaniu, pozostaną niezmienione. Pola tablicy, jeśli są określone, zastępują istniejące tablice, co powoduje odrzucenie wszystkich poprzednich elementów tablicy.
quickAdd
Tworzy zdarzenie na podstawie prostego ciągu tekstowego.
aktualizować
Aktualizuje wydarzenie. Ta metoda nie obsługuje semantyki poprawki i zawsze aktualizuje całe zasoby wydarzenia. Aby wykonać częściową aktualizację, wykonaj operację get, a potem operację update, używając tagów ETag, aby zapewnić niepodzielność.
zegarek
Obserwuj zmiany w zasobach Events.