Events

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

Listę metod dotyczących tego zasobu znajdziesz na końcu tej strony.

Prezentacje 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 Czy każdy może zaprosić siebie na wydarzenie (ta opcja została wycofana). Opcjonalnie: Wartość domyślna to False (fałsz). zapisywalny
attachments[] list Załączniki do wydarzenia.

Aby zmodyfikować załączniki, parametr żądania supportsAttachments powinien być ustawiony na 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 odpowiadającego wpisu zasobu Files w interfejsie Drive API.
attachments[].fileUrl string Link do załącznika.

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

Wymagane przy dodawaniu załącznika.

 zapisywalny
attachments[].mimeType string Typ multimediów internetowych (typ MIME) załącznika.
attachments[].title string Tytuł załącznika.
attendeesOmitted boolean Czy uczestnicy mogą być pomijani 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 False (fałsz). zapisywalny
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. zapisywalny
attendees[].additionalGuests integer Liczba dodatkowych gości. Opcjonalnie: Wartość domyślna to 0. zapisywalny
attendees[].comment string Odpowiedź uczestnika. Opcjonalnie: z możliwością zapisu
attendees[].displayName string Imię i nazwisko uczestnika (jeśli jest dostępny). Opcjonalnie: zapisywalny
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.

 zapisywalny
attendees[].id string Identyfikator profilu uczestnika (jeśli jest dostępny).
attendees[].optional boolean Określa, czy jest to uczestnik opcjonalny. Opcjonalnie: Wartość domyślna to False (fałsz). zapisywalny
attendees[].organizer boolean Czy uczestnik jest organizatorem wydarzenia. Tylko do odczytu. Wartość domyślna to False (fałsz).
attendees[].resource boolean 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 False (fałsz). zapisywalny
attendees[].responseStatus string Stan odpowiedzi uczestnika. Możliwe wartości:
  • „needsAction” – uczestnik nie odpowiedział na zaproszenie (zalecane w przypadku nowych wydarzeń).
  • „declined” – uczestnik odrzucił zaproszenie.
  • „tentative” – uczestnik zaakceptował wstępnie 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 wydarzeń specjalnych. Używany, jeśli eventType to "birthday". Niezmienna. z możliwością zapisu
birthdayProperties.contact string Nazwa zasobu danych kontaktu, z którym jest powiązane to zdarzenie urodzinowe. Możesz go użyć do pobrania danych kontaktowych z interfejsu People API. Format: "people/c12345". Tylko do odczytu.
birthdayProperties.customTypeName string Etykieta typu niestandardowego określona dla tego zdarzenia. To pole jest wypełniane, jeśli birthdayProperties.type ma wartość "custom". Tylko do odczytu.
birthdayProperties.type string Typ urodzin lub wydarzenia specjalnego. Możliwe wartości:
  • "anniversary" – rocznica inna niż urodziny. Zawsze ma contact.
  • "birthday" – zdarzenie urodzinowe. jest to wartość domyślna
  • "custom" – data specjalna, której etykieta jest dokładniej określona w polu customTypeName. Zawsze ma wartość contact.
  • "other" – data specjalna, która nie pasuje do żadnej z powyższych kategorii i nie ma etykiety niestandardowej. Zawsze ma wartość contact.
  • "self" – urodziny właściciela kalendarza. Nie może zawierać ciągu znaków contact.
Interfejs Calendar API obsługuje tylko tworzenie wydarzeń typu "birthday". Po utworzeniu zdarzenia nie można zmienić jego typu.		 zapisywalny
colorId string Kolor zdarzenia. To identyfikator odnoszący się do wpisu w sekcji event definicji kolorów (patrz punkt końcowy kolorów). Opcjonalnie: zapisywalny
conferenceData nested object informacje związane z konferencją, takie jak szczegóły konferencji w Google Meet; Aby utworzyć nowe szczegóły konferencji, użyj pola createRequest. Aby zmiany były trwałe, pamiętaj, aby w przypadku wszystkich próśb o modyfikację zdarzenia ustawić parametr conferenceDataVersion na 1. z możliwością zapisu
conferenceData.conferenceId string Identyfikator konferencji.

Może być używany przez deweloperów do śledzenia konferencji, ale nie powinien być widoczny dla użytkowników.

Wartość identyfikatora jest formatowana inaczej w zależności od typu rozwiązania do obsługi konferencji:

  • eventHangout: identyfikator nie jest ustawiony. (Ten typ konferencji został wycofany).
  • eventNamedHangout: ID to nazwa spotkania. (Ten typ konferencji został wycofany).
  • hangoutsMeet: identyfikator to 10-literowy kod spotkania, na przykład aaa-bbbb-ccc.
  • addOn: identyfikator jest definiowany przez zewnętrznego dostawcę.
 Opcjonalnie.
conferenceData.conferenceSolution nested object Narzędzie do konferencji, np. Google Meet.

Nie ustawione w przypadku konferencji z nieudanym żądaniem utworzenia.

Wymagana jest właściwość conferenceSolution i co najmniej 1 element z właściwości 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 konferencyjnego dla tego zdarzenia.
conferenceData.conferenceSolution.key.type string Typ rozwiązania do obsługi rozmów wideo.

Jeśli klient napotka nieznany lub pusty typ, powinien nadal mieć możliwość wyświetlenia punktów wejścia. Nie powinna jednak zezwalać na wprowadzanie 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" w klasycznej wersji Hangouts dla użytkowników Google Workspace (ta opcja jest wycofana. Istniejące wydarzenia mogą wyświetlać ten typ rozwiązania konferencyjnego, ale nie można tworzyć nowych konferencji);
  • "hangoutsMeet" w 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żytkownika. Nie zlokalizowany.
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.

Wymagana jest właściwość conferenceSolution i co najmniej 1 element z właściwości entryPoint lub createRequest.
conferenceData.createRequest.conferenceSolutionKey nested object Narzędzie do konferencji, takie jak Hangouts lub Google Meet.
conferenceData.createRequest.conferenceSolutionKey.type string Typ rozwiązania do obsługi rozmów wideo.

Jeśli klient napotka nieznany lub pusty typ, powinien nadal mieć możliwość wyświetlenia punktów wejścia. Nie powinna jednak zezwalać na wprowadzanie 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" w klasycznej wersji Hangouts dla użytkowników Google Workspace (ta opcja jest wycofana. Istniejące wydarzenia mogą wyświetlać ten typ rozwiązania konferencyjnego, ale nie można tworzyć nowych konferencji);
  • "hangoutsMeet" w Google Meet (http://meet.google.com)
  • "addOn" dla dostawców usług konferencyjnych innych firm;

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

Klienci powinni wygenerować ten identyfikator na potrzeby każdej nowej prośby. Jeśli podany identyfikator jest taki sam jak w poprzednim żądaniu, zostanie zignorowane.
conferenceData.createRequest.status nested object Stan prośby o utworzenie konferencji.
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 konferencji jest nadal przetwarzana.
  • "success": żądanie utworzenia konferencji zostało wykonane pomyślnie, punkty wejścia zostały wypełnione.
  • "failure": nie udało się utworzyć konferencji, nie ma punktów wejścia.

conferenceData.entryPoints[] list informacje o poszczególnych punktach dostępu do konferencji, takie jak adresy URL lub numery telefonów;

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

Wymagana jest właściwość conferenceSolution i co najmniej 1 element z właściwości entryPoint lub createRequest.
conferenceData.entryPoints[].accessCode string Kod dostępu do konferencji. Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych konferencji wypełnij 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 videopunkt wejścia.
  • "phone" – dołączanie do konferencji przez wybranie numeru telefonu. Konferencja może mieć zero lub więcej punktów wejścia phone.
  • "sip" – dołączanie do konferencji przez SIP. W rozmowie wideo może występować zero lub jeden punkt wejścia sip.
  • "more" – dalsze instrukcje dotyczące dołączania do konferencji, na przykład dodatkowe numery telefonów. Rozmowa wideo może mieć 0 lub 1 morepunkt wejścia. Rozmowa wideo z jednym punktem wejścia more nie jest prawidłową rozmową wideo.

conferenceData.entryPoints[].label string Etykieta identyfikatora URI. widoczne dla użytkowników. Nie zlokalizowany. 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
  • for more: should not be filled

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łnij 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 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 dostępu do konferencji; Maksymalna długość to 128 znaków.

Podczas tworzenia nowych danych konferencji wypełnij 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łnij 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:

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

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

Wygenerowano po stronie serwera.

Nie ustawione w przypadku konferencji z nieudanym żądaniem utworzenia.

Opcjonalnie w przypadku konferencji z oczekującym żądaniem utworzenia.
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: zapisywalny
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. zapisywalny
end.dateTime datetime Czas jako połączona wartość daty i czasu (sformatowana zgodnie ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w elementach timeZone. zapisywalny
end.timeZone string Strefa czasowa, w której jest podany czas. (w formacie nazwy strefy czasowej z bazy danych IANA, np. „Europe/Warsaw”). W przypadku zdarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której rozszerzona jest powtarzalność. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/zakończenia wydarzenia. zapisywalny
endTimeUnspecified boolean Określa, czy godzina zakończenia jest 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 ETag zasobu.
eventType string Konkretny typ zdarzenia. Po utworzeniu wydarzenia nie można zmienić tego ustawienia. Możliwe wartości:
  • „birthday” – specjalne całodniowe wydarzenie cykliczne powtarzane co roku.
  • „default” – zwykłe zdarzenie lub nieokreślone.
  • „focusTime” – zdarzenie czasu skupienia.
  • „fromGmail” – wydarzenie z Gmaila. Nie można utworzyć tego typu zdarzenia.
  • „outOfOffice” – wydarzenie poza biurem.
  • „workingLocation” – zdarzenie dotyczące lokalizacji miejsca pracy.
 zapisywalny
extendedProperties object Rozszerzone właściwości zdarzenia.
extendedProperties.private object Właściwości, które są prywatne dla kopii wydarzenia widocznej 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. zapisywalny
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 ma 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 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, w którym użytkownik jest oznaczony w Google Chat i powiązanych usługach. Może to być available lub doNotDisturb.
focusTimeProperties.declineMessage string wiadomość z odpowiedzią do ustawienia, jeśli istniejące wydarzenie lub nowa zaproszenie zostanie automatycznie odrzucone przez Kalendarz.
gadget object Gadżet, który rozszerza to zdarzenie. Gadżety zostały wycofane. Ta struktura jest teraz używana tylko do zwracania metadanych kalendarza urodzinowego.
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 wydarzenia.
 zapisywalny
gadget.height integer Wysokość gadżetu w pikselach. Wysokość musi być liczbą całkowitą większą od 0. Opcjonalnie: Rola wycofana. zapisywalny
gadget.preferences object Ustawienia. zapisywalny
gadget.preferences.(key) string Nazwa preferencji i odpowiadająca jej wartość.
gadget.title string Tytuł gadżetu. Rola wycofana. zapisywalny
gadget.type string Typ gadżetu. Rola wycofana. zapisywalny
gadget.width integer Szerokość gadżetu w pikselach. Szerokość musi być liczbą całkowitą większą od 0. Opcjonalnie: Rola wycofana. z możliwością zapisu
guestsCanInviteOthers boolean Czy uczestnicy inni niż organizator mogą zapraszać inne osoby na wydarzenie. Opcjonalnie: Wartość domyślna to Prawda. zapisywalny
guestsCanModify boolean Określa, 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 Prawda. zapisywalny
iCalUID string Unikalny identyfikator zdarzenia zdefiniowany w dokumencie RFC5545. Służy do jednoznacznego identyfikowania wydarzeń w różnych systemach kalendarza i musi być podany podczas importowania wydarzeń za pomocą metody import.

Pamiętaj, że iCalUID i id nie są identyczne i podczas tworzenia zdarzenia należy podać tylko jeden z nich. Jednym z różnic w semantyce jest to, że w przypadku cyklicznych zdarzeń wszystkie wystąpienia jednego zdarzenia mają różne wartości id, ale wszystkie mają te same wartości iCalUID. Aby pobrać zdarzenie za pomocą jego iCalUID, wywołaj metodę events.list, podając parametr iCalUID. Aby pobrać zdarzenie za pomocą jego id, wywołaj metodę events.get.
id string Nieprzejrzysty identyfikator zdarzenia. Podczas tworzenia nowych pojedynczych lub powtarzających się zdarzeń możesz określić ich identyfikatory. Podane identyfikatory muszą spełniać te reguły:
  • 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
  • długość identyfikatora musi wynosić od 5 do 1024 znaków.
  • identyfikator musi być unikalny dla każdego kalendarza.
Ze względu na globalnie rozproszony charakter systemu nie możemy zagwarantować, że kolizje identyfikatorów zostaną wykryte podczas tworzenia wydarzeń. Aby zminimalizować ryzyko kolizji, zalecamy użycie sprawdzonego algorytmu UUID, takiego jak opisany w RFC4122.

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

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

 zapisywalny
kind string Typ zasobu („calendar#event”).
location string Geograficzna lokalizacja wydarzenia w postaci dowolnego tekstu. 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 False (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. zapisywalny
organizer.displayName string Nazwa organizatora (jeśli jest dostępna). zapisywalny
organizer.email string Adres e-mail organizatora (jeśli jest dostępny). Musi to być prawidłowy adres e-mail zgodny ze standardem RFC5322. zapisywalny
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 wydarzenia cyklicznego jest to godzina rozpoczęcia wydarzenia zgodnie z danymi cyklicznymi wydarzenia cyklicznego identyfikowanymi przez identyfikator zdarzenia cyklicznego. Unikalnie identyfikuje wystąpienie w serii powtarzających się zdarzeń, nawet jeśli zostało przeniesione na inny czas. Niezmienna.
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 czasu (sformatowana zgodnie ze standardem RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w elementach timeZone. zapisywalny
originalStartTime.timeZone string Strefa czasowa, w której jest podany czas. (w formacie nazwy strefy czasowej z bazy danych IANA, np. „Europe/Warsaw”). W przypadku zdarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której rozszerzona jest powtarzalność. W przypadku pojedynczych wydarzeń to pole jest opcjonalne i wskazuje niestandardową strefę czasową rozpoczęcia/zakończenia wydarzenia. zapisywalny
outOfOfficeProperties nested object dane o wydarzeniu poza biurem; Używana, jeśli eventType ma wartość outOfOffice. zapisywalny
outOfOfficeProperties.autoDeclineMode string 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 zostały odrzucone; declineAllConflictingInvitations oznacza, że wszystkie zaproszenia na spotkania będące w konflikcie i sprzeczne z wydarzeniem, które są w konflikcie, są odrzucane; oraz declineOnlyNewConflictingInvitations, co oznacza, że tylko nowe zaproszenia na spotkania będące w konflikcie, które dotarły w czasie trwania wydarzenia „Poza biurem”, będą odrzucane.
outOfOfficeProperties.declineMessage string wiadomość z odpowiedzią do ustawienia, jeśli istniejące wydarzenie lub nowa zaproszenie zostanie automatycznie odrzucone 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: Niezmienna. Wartość domyślna to False (fałsz).
recurrence[] list Lista wierszy RRULE, EXRULE, RDATE i EXDATE dla powtarzającego się zdarzenia, zgodnie z RFC5545. Pamiętaj, że w tym polu nie można używać linii DTSTART i DTEND. Czas rozpoczęcia i zakończenia wydarzenia 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 id wydarzenia cyklicznego, do którego należy to wystąpienie. Niezmienna.
reminders object Informacje o przypominaniach o wydarzeniu dla uwierzytelnionego użytkownika. Pamiętaj, że zmiana przypomnień nie powoduje też zmiany właściwości updated w otaczającym zdarzeniu.
reminders.overrides[] list Jeśli zdarzenie nie korzysta z domyślnych przypomnień, wyświetla się lista przypomnień dotyczących tego zdarzenia. Jeśli nie ma przypomnień, wyświetla się informacja, że nie ma żadnych przypomnień dotyczących tego zdarzenia. Maksymalna liczba przypomnień do zastąpienia to 5. zapisywalny
reminders.overrides[].method string Metoda używana przez to przypomnienie. Możliwe wartości:
  • „email” – przypomnienia są wysyłane e-mailem.
  • „popup” – przypomnienia są wysyłane przez wyskakujące okienko w interfejsie.

Wymagany podczas dodawania przypomnienia.

 zapisywalny
reminders.overrides[].minutes integer Liczba minut przed rozpoczęciem wydarzenia, w których przypomnienie powinno się aktywować. Dozwolone wartości to 0–40 320 (4 tygodnie w minutach).

Wymagany podczas dodawania przypomnienia.

 zapisywalny
reminders.useDefault boolean Określa, czy do wydarzenia mają zastosowanie domyślne przypomnienia w kalendarzu. zapisywalny
sequence integer Numer sekwencyjny zgodnie z iKalendarzem. zapisywalny
source object Źródło, z którego pochodzi zdarzenie. Może to być na przykład strona internetowa, wiadomość e-mail lub dowolny dokument, który można zidentyfikować za pomocą adresu URL z schematem HTTP lub HTTPS. Może być widoczne i modyfikowane tylko przez twórcę wydarzenia.
source.title string Tytuł źródła, np. tytuł strony internetowej lub temat e-maila. zapisywalny
source.url string Adres URL źródła wskazującego zasób. Schemat adresu URL musi być HTTP lub HTTPS. zapisywalny
start nested object Godzina rozpoczęcia wydarzenia (włącznie). 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. zapisywalny
start.dateTime datetime Czas jako połączona wartość daty i godziny (sformatowana zgodnie z RFC3339). Wymagane jest przesunięcie strefy czasowej, chyba że strefa czasowa jest wyraźnie określona w elementach timeZone. zapisywalny
start.timeZone string Strefa czasowa, w której jest podany czas. (w formacie nazwy strefy czasowej z bazy danych IANA, np. „Europe/Warsaw”). W przypadku zdarzeń cyklicznych to pole jest wymagane i określa strefę czasową, w której rozszerzona jest powtarzalność. 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” – zdarzenie jest wstępnie potwierdzone.
  • „cancelled” – zdarzenie zostało anulowane (usunięte). Metoda list zwraca anulowane zdarzenia tylko w przypadku synchronizacji przyrostowej (gdy są określone parametry syncToken lub updatedMin) albo jeśli flaga showDeleted ma wartość true. Metoda get zawsze zwraca te wartości.

    Stan „Anulowano” może oznaczać 2 różne stany w zależności od typu zdarzenia:

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

      Wyjątki anulowanych reklam mają wypełnione tylko pola id, recurringEventId i originalStartTime. Pozostałe pola mogą być puste.

    2. Wszystkie inne anulowane wydarzenia odnoszą się do usuniętych wydarzeń. Klienci powinni usunąć skopiowane lokalnie pliki. 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ć). Podobnie informacje o wydarzeniu, na które użytkownik został zaproszony i które usunął ręcznie, nadal są dostępne. Jednak żądania stopniowej synchronizacji z wartością showDeleted równą „false” nie zwracają tych szczegółów.

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

zapisywalny
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 blokuje czas w kalendarzu. Jest to równoznaczne z ustawieniem Pokaż mnie jako na Zajęty w interfejsie Kalendarza.
  • „transparent” – wydarzenie nie blokuje czasu w kalendarzu. Jest to równoznaczne z ustawieniem Pokaż mnie jako na Dostępny w interfejsie Kalendarza.
 z możliwością zapisu
updated datetime Czas ostatniej modyfikacji głównych danych zdarzenia (jako sygnatura czasowa RFC3339). Zmiana przypomnień o wydarzeniu nie spowoduje zmiany tego ustawienia. Tylko do odczytu.
visibility string Widoczność zdarzenia. Opcjonalnie: Możliwe wartości:
  • „default” – domyślna widoczność wydarzeń w kalendarzu. jest to wartość domyślna
  • „public” – wydarzenie jest publiczne, a jego szczegóły są widoczne dla wszystkich czytelników kalendarza.
  • „private” – wydarzenie jest prywatne i tylko uczestnicy mogą wyświetlać jego szczegóły.
  • „confidential” – zdarzenie jest prywatne. Ta wartość jest podawana ze względu na zgodność.
 z możliwością zapisu
workingLocationProperties nested object Dane zdarzenia dotyczące miejsca pracy. zapisywalny
workingLocationProperties.customLocation object Jeśli jest obecny, określa, że użytkownik pracuje w niestandardowej lokalizacji. zapisywalny
workingLocationProperties.customLocation.label string Opcjonalna dodatkowa etykieta zawierająca dodatkowe informacje. zapisywalny
workingLocationProperties.homeOffice any value Wskazuje, że użytkownik pracuje w domu. zapisywalny
workingLocationProperties.officeLocation object Jeśli jest obecny, określa, że użytkownik pracuje w biurze. zapisywalny
workingLocationProperties.officeLocation.buildingId string Opcjonalny identyfikator budynku. Powinien on wskazywać identyfikator budynku w bazie danych zasobów organizacji. zapisywalny
workingLocationProperties.officeLocation.deskId string Opcjonalny identyfikator działu zapisywalny
workingLocationProperties.officeLocation.floorId string Opcjonalny identyfikator piętra. z możliwością zapisu
workingLocationProperties.officeLocation.floorSectionId string Opcjonalny identyfikator obszaru piętra. zapisywalny
workingLocationProperties.officeLocation.label string Nazwa biura wyświetlana w klientach Kalendarza w przeglądarce i na urządzeniach mobilnych. Zalecamy odniesienie się do nazwy budynku w bazie danych zasobów organizacji. zapisywalny
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ń
Usuwanie wydarzenia.
get
Zwraca wydarzenie na podstawie jego identyfikatora w Kalendarzu Google. Aby pobrać wydarzenie za pomocą identyfikatora iCalendar, wywołaj metodę events.list za pomocą parametru iCalUID.
import
Importuje wydarzenie. Ta operacja służy do dodawania do kalendarza prywatnej kopii istniejącego wydarzenia. Można importować tylko zdarzenia o eventType default.

Wycofane działanie: jeśli importujesz 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 zdarzenie.
instancjach
Zwraca wystąpienia określonego wydarzenia cyklicznego.
list
Zwraca wydarzenia w wybranym kalendarzu.
move
Przenosi wydarzenie do innego kalendarza, czyli zmienia jego organizatora. Pamiętaj, że można przenosić tylko zdarzenia default. Zdarzenia birthday, focusTime, fromGmail, outOfOffice i workingLocation nie można przenosić.
poprawka
Aktualizuje zdarzenie. Ta metoda obsługuje semantykę poprawki. Pamiętaj, że każde żądanie zmiany zużywa 3 jednostki limitu; preferuj użycie get, a następnie update. Podane przez Ciebie wartości pól zastąpią dotychczasowe wartości. Pola, których nie określisz 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.
update
Aktualizuje zdarzenie. 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
Sprawdzaj zmiany w zasobach Zdarzenia.