Events

Interfejs Calendar API udostępnia różne rodzaje zasobów dotyczących 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
    }
  ],
  "eventType": string
}
nazwa usługi, Wartość Opis Notatki
anyoneCanAddSelf boolean Określa, czy każdy może zaprosić na wydarzenie samodzielnie (funkcja wycofana). Opcjonalnie. Wartość domyślna to Fałsz. z możliwością zapisu
attachments[] list Pliki załączników dla wydarzenia.

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

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.

Aby dodać załączniki z plikami z Dysku Google, użyj tego samego formatu co we właściwości alternateLink zasobu Files w interfejsie Drive API.

Wymagane przy dodawaniu załącznika.

 z możliwością zapisu
attachments[].mimeType string Internetowy typ nośnika (typ MIME) załącznika.
attachments[].title string Tytuł załącznika.
attendeesOmitted boolean Określa, czy uczestnicy mogli zostać pominięci w reprezentacji wydarzenia. Podczas pobierania zdarzenia może to być spowodowane ograniczeniem określonym przez parametr zapytania maxAttendee. Podczas aktualizowania wydarzenia można użyć tych danych tylko do zmiany odpowiedzi uczestnika. Opcjonalnie. Wartość domyślna to 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 zapełnić listę uczestników, konta usługi muszą korzystać z przekazywania uprawnień w całej domenie. z możliwością zapisu
attendees[].additionalGuests integer Liczba dodatkowych gości. Opcjonalnie. Wartość domyślna to 0. z możliwością zapisu
attendees[].comment string Komentarz uczestnika do odpowiedzi. Opcjonalnie. z możliwością zapisu
attendees[].displayName string Imię i nazwisko uczestnika (jeśli 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. To musi być prawidłowy adres e-mail zgodnie z dokumentem 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ść domyślna to Fałsz. z możliwością zapisu
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 to ustawić tylko wtedy, gdy uczestnik jest dodawany do wydarzenia po raz pierwszy. Kolejne modyfikacje są ignorowane. Opcjonalnie. Wartość domyślna to 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 dotyczy kalendarza, w którym znajduje się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to Fałsz.
colorId string Kolor wydarzenia. To identyfikator odnoszący się do wpisu w sekcji event definicji kolorów (patrz punkt końcowy kolorów). Opcjonalnie. z możliwością zapisu
conferenceData nested object informacje związane z konferencją, na przykład szczegóły rozmowy 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 zdarzenia. 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 formatowana inaczej w zależności od typu rozwiązania do obsługi konferencji:

  • eventHangout: identyfikator nie jest ustawiony. (Ten typ rozmowy wideo został wycofany).
  • eventNamedHangout: ID to nazwa spotkania. (Ten typ rozmowy wideo został wycofany).
  • hangoutsMeet: identyfikator to 10-literowy kod spotkania, na przykład aaa-bbbb-ccc.
  • addOn: identyfikator jest definiowany przez zewnętrznego dostawcę.
Opcjonalna.
conferenceData.conferenceSolution nested object rozwiązanie do obsługi konferencji, takie jak Google Meet;

Anuluj ustawienie dla rozmowy wideo z nieudanym żądaniem utworzenia.

Wymagany jest element conferenceSolution i co najmniej 1 element entryPoint lub createRequest.
conferenceData.conferenceSolution.iconUri string Ikona tego rozwiązania widoczna dla użytkownika.
conferenceData.conferenceSolution.key nested object Klucz, który umożliwia jednoznaczne zidentyfikowanie rozwiązania do obsługi konferencji 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. Nie powinno to jednak uniemożliwić wprowadzania zmian.

Możliwe wartości to:

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

conferenceData.conferenceSolution.name string Nazwa tego rozwiązania widoczna dla użytkowników. Brak lokalizacji.
conferenceData.createRequest nested object prośbę o wygenerowanie nowej rozmowy wideo i dołączenie jej do wydarzenia. Dane są generowane asynchronicznie. Aby sprawdzić, czy dane są dostępne, sprawdź pole status.

Wymagany jest element 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. Nie powinno to jednak uniemożliwić wprowadzania zmian.

Możliwe wartości to:

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

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

Klienci powinni ponownie wygenerować ten identyfikator dla każdego nowego żądania. Jeśli podany identyfikator jest taki sam jak w poprzednim żądaniu, zostanie zignorowane.
conferenceData.createRequest.status nested object Stan prośby o utworzenie rozmowy wideo.
conferenceData.createRequest.status.statusCode string Bieżący stan prośby o utworzenie rozmowy wideo. Tylko do odczytu.

Możliwe wartości to:

  • "pending": prośba o utworzenie rozmowy wideo jest nadal przetwarzana.
  • "success": żądanie utworzenia rozmowy wideo zakończone powodzeniem, punkty wejścia zostały wypełnione.
  • "failure": nie udało się utworzyć rozmowy wideo, brak punktów wejścia.

conferenceData.entryPoints[] list Informacje o punktach wejścia na poszczególne konferencje, takie jak adresy URL lub numery telefonów.

Wszystkie muszą należeć do tej samej konferencji.

Wymagany jest element conferenceSolution i co najmniej 1 element entryPoint lub createRequest.
conferenceData.entryPoints[].accessCode string Kod dostępu do rozmowy wideo. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór {meetingCode, accessCode, passcode, password, pin} zgodnie z terminologią użytą przez dostawcę konferencji. Powinny się wyświetlać tylko wypełnione pola.

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

Możliwe wartości to:

  • "video" – dołączanie do konferencji przez HTTP. W rozmowie wideo może występować zero lub jeden punkt wejścia video.
  • "phone" – dołączanie do konferencji przez wybranie numeru telefonu. W konferencji może być nie więcej niż phone punktów wejścia.
  • "sip" – dołączanie do konferencji przez SIP. W rozmowie wideo może występować zero lub jeden punkt wejścia sip.
  • "more" – dalsze instrukcje dołączania do konferencji, na przykład dodatkowe numery telefonów. W rozmowie wideo może występować zero lub jeden punkt wejścia more. Rozmowa, w której znajduje się tylko punkt wejścia more, nie jest prawidłową konferencją.

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

Przykłady:

  • dla video: meet.google.com/aaa-bbbb-ccc
  • dla firmy phone: +1 123 268 2601
  • dla sip: 12345678@altostrat.com
  • dla more: pole nie powinno być wypełnione

Opcjonalnie.
conferenceData.entryPoints[].meetingCode string Kod spotkania umożliwiający dostęp do rozmowy wideo. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór {meetingCode, accessCode, passcode, password, pin} zgodnie z terminologią użytą przez dostawcę konferencji. Powinny się wyświetlać tylko wypełnione pola.

Opcjonalnie.
conferenceData.entryPoints[].passcode string Hasło umożliwiające dostęp do konferencji. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór {meetingCode, accessCode, passcode, password, pin} zgodnie z terminologią użytą przez dostawcę konferencji. Powinny się wyświetlać tylko wypełnione pola.
conferenceData.entryPoints[].password string Hasło umożliwiające dostęp do konferencji. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór {meetingCode, accessCode, passcode, password, pin} zgodnie z terminologią użytą przez dostawcę konferencji. Powinny się wyświetlać tylko wypełnione pola.

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

Podczas tworzenia nowych danych rozmów wideo wypełnij tylko podzbiór {meetingCode, accessCode, passcode, password, pin} zgodnie z terminologią użytą przez dostawcę konferencji. Powinny się wyświetlać tylko wypełnione pola.

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

Format:

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

conferenceData.notes string Dodatkowe uwagi (na przykład 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 rozmowy wideo.

Wygenerowano po stronie serwera.

Anuluj ustawienie dla rozmowy wideo z nieudanym żądaniem utworzenia.

Opcjonalne w przypadku rozmowy wideo z oczekującą prośbą o utworzenie.
created datetime Czas utworzenia zdarzenia (w postaci sygnatury czasowej RFC3339). Tylko do odczytu.
creator object Twórca wydarzenia. Tylko do odczytu.
creator.displayName string Nazwa twórcy (jeśli jest dostępna).
creator.email string Adres e-mail twórcy (jeśli jest dostępny).
creator.id string Identyfikator profilu twórcy (jeśli jest dostępny).
creator.self boolean Określa, czy twórca odpowiada kalendarzowi, w którym znajduje się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to 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łączna). W przypadku wydarzenia cyklicznego jest to godzina zakończenia pierwszego wystąpienia.
end.date date Data w formacie „rrrr-mm-dd”, jeśli jest to wydarzenie całodniowe. z możliwością zapisu
end.dateTime datetime Czas jako połączona wartość daty i godziny (sformatowana zgodnie z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że w polu timeZone wyraźnie określisz strefę czasową. z możliwością zapisu
end.timeZone string Strefa czasowa, w której określono godzinę. (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 powtarza się. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia i zakończenia wydarzenia. z możliwością zapisu
endTimeUnspecified boolean Określa, czy godzina zakończenia jest faktycznie nieokreślona. Ze względu na zgodność z zasadami godzina zakończenia jest nadal podawana, nawet jeśli ten atrybut ma wartość Prawda. Wartość domyślna to Fałsz.
etag etag Tag ETag zasobu.
eventType string Konkretny typ zdarzenia. Po utworzeniu wydarzenia nie można zmienić tej wartości. Możliwe wartości:
  • „default” – jest to zwykłe wydarzenie lub nie zostało określone bardziej szczegółowo.
  • „outOfOffice” – wydarzenie poza biurem.
  • „focusTime” – wydarzenie typu czas skupienia.
  • „workingLocation” – zdarzenie dotyczące lokalizacji miejsca pracy.
  • „fromGmail” – wydarzenie z Gmaila. Nie można utworzyć tego typu wydarzenia.
 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 przez kopie wydarzenia w kalendarzach innych uczestników. z możliwością zapisu
extendedProperties.shared.(key) string Nazwa współdzielonej właściwości i odpowiadająca jej wartość.
focusTimeProperties nested object Dane zdarzenia 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 zostały odrzucone; declineAllConflictingInvitations oznacza, że wszystkie zaproszenia na spotkania będące w konflikcie i kolidujące z wydarzeniem są odrzucane, a declineOnlyNewConflictingInvitations – tylko nowe zaproszenia na spotkania będące w konflikcie, które zostały odebrane w czasie trwania wydarzenia Czas skupienia, są odrzucane.
focusTimeProperties.chatStatus string Stan oznaczający użytkownika w Google Chat i powiązanych usługach. Może to być available lub doNotDisturb.
focusTimeProperties.declineMessage string Komunikat z opcją określenia, czy istniejące lub nowe zaproszenie mają być automatycznie odrzucane przez Kalendarz.
gadget object Gadżet rozszerzający to wydarzenie. 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 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ż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 inne niż organizator mogą zapraszać na wydarzenie inne osoby. Opcjonalnie. Wartość domyślna to Prawda. z możliwością zapisu
guestsCanModify boolean Określa, czy uczestnicy inni niż organizator mogą modyfikować wydarzenie. Opcjonalnie. Wartość domyślna to 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 Prawda. z możliwością zapisu
iCalUID string Unikalny identyfikator zdarzenia określony w RFC5545. Służy do jednoznacznego identyfikowania wydarzeń w systemach kalendarzowych i należy go podawać podczas importowania wydarzeń za pomocą metody import.

Pamiętaj, że właściwości iCalUID i id nie są identyczne i tylko jeden z nich należy podać podczas tworzenia zdarzenia. Jedyna różnica w ich semantyce polega na tym, że w przypadku wydarzeń cyklicznych wszystkie wystąpienia określonego wydarzenia mają różne właściwości id, ale wszystkie mają takie same elementy iCalUID. Aby pobrać zdarzenie za pomocą parametru iCalUID, wywołaj metodę events.list za pomocą parametru iCalUID. Aby pobrać zdarzenie za pomocą parametru 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:
  • znaki dozwolone w identyfikatorze to te używane w kodowaniu base32hex, tj. małe litery a-v i cyfry 0–9, patrz sekcja 3.1.2 w dokumencie RFC2938
  • identyfikator musi mieć 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 kolizje identyfikatorów zostaną wykryte podczas tworzenia wydarzeń. Aby zminimalizować ryzyko kolizji, zalecamy użycie uznanego algorytmu UUID, takiego jak ten opisany w RFC4122.

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

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

 z możliwością zapisu
kind string Typ zasobu („calendar#event”).
location string Lokalizacja geograficzna wydarzenia jako dowolny tekst. Opcjonalnie. z możliwością zapisu
locked boolean Czy jest to zablokowana kopia zdarzenia, w przypadku której nie można wprowadzać żadnych zmian w głównych polach zdarzenia „podsumowanie”, „opis”, „lokalizacja”, „początek”, „koniec” ani „powtarzanie”. Wartość domyślna to Fałsz. Tylko do odczytu.
organizer object Organizator wydarzenia. Jeśli organizator jest też uczestnikiem, jest to oznaczone osobną pozycją w usłudze attendees z polem organizer ustawionym na wartość True. Aby zmienić organizatora, użyj operacji przenoszenia. Tylko do odczytu, chyba że importujesz wydarzenie. 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). To musi być prawidłowy adres e-mail zgodnie z dokumentem RFC5322. z możliwością zapisu
organizer.id string Identyfikator profilu organizatora (jeśli jest dostępny).
organizer.self boolean Określa, czy organizator odpowiada kalendarzowi, w którym znajduje się ta kopia wydarzenia. Tylko do odczytu. Wartość domyślna to Fałsz.
originalStartTime nested object W przypadku wydarzenia cyklicznego jest to godzina rozpoczęcia wydarzenia zgodnie z danymi cyklicznymi wydarzenia cyklicznego identyfikowanymi przez identyfikator zdarzenia cyklicznego. Jednoznacznie identyfikuje wystąpienie w serii zdarzeń cyklicznych, nawet jeśli wystąpienie zostało przeniesione do innego momentu. Stała.
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 z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że w polu timeZone wyraźnie określisz strefę czasową. z możliwością zapisu
originalStartTime.timeZone string Strefa czasowa, w której określono godzinę. (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 powtarza się. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia i zakończenia wydarzenia. z możliwością zapisu
outOfOfficeProperties nested object Dane dotyczące wydarzeń poza biurem. Używana, jeśli eventType ma wartość outOfOffice. z możliwością zapisu
outOfOfficeProperties.autoDeclineMode string Określa, czy chcesz 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 zostały odrzucone; declineAllConflictingInvitations oznacza, że wszystkie zaproszenia na spotkania będące w konflikcie i kolidujące z wydarzeniem są odrzucane, a declineOnlyNewConflictingInvitations – tylko nowe zaproszenia na spotkania będące w konflikcie, które otrzymasz w czasie trwania wydarzenia „Poza biurem”, będą odrzucane.
outOfOfficeProperties.declineMessage string Komunikat z opcją określenia, czy istniejące lub nowe zaproszenie mają być automatycznie odrzucane przez Kalendarz.
privateCopy boolean Jeśli zasada ma wartość Prawda, rozpowszechnianie zdarzeń jest wyłączone. Pamiętaj, że to nie to samo co właściwości wydarzenia prywatnego. Opcjonalnie. Stała. Wartość domyślna to Fałsz.
recurrence[] list Lista wierszy RRULE, EXRULE, RDATE i EXDATE dla wydarzenia cyklicznego, zgodnie z opisem w RFC5545. Zwróć uwagę, że wiersze DTSTART i DTEND są niedozwolone w tym polu. Czas rozpoczęcia i zakończenia zdarzenia jest określony 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 pole id wydarzenia cyklicznego, do którego należy ta instancja. Stała.
reminders object Informacje o przypomnieniach o wydarzeniu dla uwierzytelnionego użytkownika. Pamiętaj, że zmiana przypomnień nie powoduje zmiany właściwości updated powiązanego wydarzenia.
reminders.overrides[] list Jeśli dla wydarzenia nie są używane przypomnienia domyślne, zobaczysz listę przypomnień związanych z tym wydarzeniem lub, jeśli nie zostanie skonfigurowana, wskazuje, że dla tego wydarzenia nie są ustawione żadne przypomnienia. Maksymalna liczba przypomnień o zastąpieniu to 5. z możliwością zapisu
reminders.overrides[].method string Metoda użyta w tym przypomnieniu. Możliwe wartości:
  • „email” – przypomnienia są wysyłane e-mailem.
  • „popup” – przypomnienia są wysyłane w wyskakującym okienku interfejsu.

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
reminders.overrides[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, kiedy powinno wyświetlić się przypomnienie. Prawidłowe wartości mieszczą się w zakresie od 0 do 40 320 (4 tygodnie w minutach).

Wymagane przy dodawaniu przypomnienia.

 z możliwością zapisu
reminders.useDefault boolean Określa, czy domyślne przypomnienia kalendarza mają zastosowanie do wydarzenia. z możliwością zapisu
sequence integer Numer sekwencyjny zgodnie z iKalendarzem. z możliwością zapisu
source object Źródło, z którego utworzono zdarzenie. Może to być na przykład strona internetowa, wiadomość e-mail lub dowolny dokument, który można rozpoznać za pomocą adresu URL zgodnego ze schematem HTTP lub HTTPS. Tylko twórca wydarzenia może je zobaczyć lub zmodyfikować.
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 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. z możliwością zapisu
start.dateTime datetime Czas jako połączona wartość daty i godziny (sformatowana zgodnie z RFC3339). Przesunięcie strefy czasowej jest wymagane, chyba że w polu timeZone wyraźnie określisz strefę czasową. z możliwością zapisu
start.timeZone string Strefa czasowa, w której określono godzinę. (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 powtarza się. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia i 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 przy synchronizacji przyrostowej (gdy określono syncToken lub updatedMin) lub jeśli flaga showDeleted jest ustawiona na true. Metoda get zawsze je zwraca.

    Stan anulowanego zdarzenia to 2 różne stany w zależności od jego typu:

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

      Gwarantowane, że anulowane wyjątki będą miały wypełnione tylko wartości w polach id, recurringEventId i originalStartTime. Pozostałe pola mogą być puste.

    2. Wszystkie inne anulowane wydarzenia odnoszą się do usuniętych wydarzeń. Klienci powinni usunąć swoje zsynchronizowane lokalnie kopie. Takie anulowane wydarzenia wkrótce znikną, więc nie czekaj, aż będą dostępne bezterminowo.

      Gwarantujemy, że w przypadku usuniętych wydarzeń tylko pole id będzie wypełnione.

    Anulowane wydarzenia w kalendarzu organizatora nadal zawierają szczegóły wydarzenia (podsumowanie, lokalizację itp.), aby można je było przywrócić (przywrócić). Szczegółowe informacje są też dostępne w przypadku wydarzeń, na które użytkownik został zaproszony i który został usunięty ręcznie. Jednak przyrostowe żądania synchronizacji z wartością fałsz (showDeleted) nie zwracają tych informacji.

    Jeśli organizator zmieni organizatora (na przykład w wyniku operacji move) i pierwotnego organizatora nie ma na liście uczestników, wydarzenie pozostawi anulowane wydarzenie, w którym tylko pole id zostanie wypełnione.

z możliwością zapisu
summary string Nazwa wydarzenia, z możliwością zapisu
transparency string Określa, czy wydarzenie ma blokować czas w kalendarzu. Opcjonalnie. Możliwe wartości:
  • „opaque” – wartość domyślna. Wydarzenie nie zablokuje czasu w kalendarzu. Odpowiada to ustawieniu 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 Ostatnia modyfikacja danych głównego zdarzenia (w postaci sygnatury czasowej RFC3339). Zaktualizowanie przypomnień o wydarzeniach nie spowoduje żadnych zmian. 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 jego szczegóły są widoczne dla wszystkich czytelników kalendarza.
  • „private” – wydarzenie jest prywatne i tylko jego 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 ta opcja jest dostępna, oznacza, że użytkownik pracuje w lokalizacji niestandardowej. 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 ten parametr jest dostępny, oznacza, że użytkownik pracuje w domu. z możliwością zapisu
workingLocationProperties.officeLocation object Jeśli ten parametr jest dostępny, oznacza, że użytkownik pracuje w biurze. z możliwością zapisu
workingLocationProperties.officeLocation.buildingId string Opcjonalny identyfikator budynku. Powinien 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 klientach internetowych i mobilnych. Zalecamy odwołanie 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 w lokalizacji niestandardowej.
Wszystkie szczegóły są określone w polu podrzędnym o podanej nazwie, ale to pole może nie być puste, 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 iKalendarz, wywołaj metodęevents.list przy użyciu parametru iCalUID.
import
Importuje zdarzenie. Ta operacja pozwala dodać prywatną kopię istniejącego wydarzenia do kalendarza. Można importować tylko zdarzenia z eventType o wartości default.

Wycofane działanie: jeśli zaimportujesz zdarzenie inne niż default, jego typ zostanie zmieniony na default, a wszystkie właściwości związane z typem zdarzenia zostaną usunięte.

wstaw
Tworzy wydarzenie.
instancje
Zwraca wystąpienia określonego wydarzenia cyklicznego.
list
Zwraca wydarzenia z określonego kalendarza.
przenieś
Przenosi wydarzenie do innego kalendarza, czyli zmienia jego organizatora. Pamiętaj, że można przenieść tylko wydarzenia default. Nie można przenieść wydarzeń outOfOffice, focusTime, workingLocation i fromGmail.
poprawka
Aktualizuje wydarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie poprawki zużywa 3 jednostki limitu. Zalecamy użycie ciągu get, a następnie update. Określone przez Ciebie wartości pól zastępują istniejące wartości. Pola, które nie zostaną określone w żądaniu, pozostaną niezmienione. Pola tablicowe (jeśli są określone) zastępują istniejące tablice. Spowoduje to odrzucenie wszystkich elementów, które zostały wcześniej podane.
quickAdd
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 polecenie get, a następnie polecenie update, używając étagów, aby zapewnić swobodę.
zegarek
Wypatruj zmian w zasobach dotyczących wydarzeń.