Freebusy: query

Gibt Informationen zur Verfügbarkeit für eine Reihe von Kalendern zurück. Jetzt testen

Anfrage

HTTP-Anfrage

POST https://www.googleapis.com/calendar/v3/freeBusy

Autorisierung

Diese Anfrage ermöglicht die Autorisierung mit mindestens einem der folgenden Bereiche:

Umfang
https://www.googleapis.com/auth/calendar.readonly
https://www.googleapis.com/auth/calendar

Weitere Informationen finden Sie auf der Seite Authentifizierung und Autorisierung.

Anfragetext

Geben Sie im Anfragetext Daten mit der folgenden Struktur ein:

{
  "timeMin": datetime,
  "timeMax": datetime,
  "timeZone": string,
  "groupExpansionMax": integer,
  "calendarExpansionMax": integer,
  "items": [
    {
      "id": string
    }
  ]
}
Property-Name Wert Beschreibung Hinweise
timeMin datetime Der Beginn des Intervalls für die Abfrage, der gemäß RFC3339 formatiert ist.
timeMax datetime Das Ende des Intervalls für die Abfrage, die gemäß RFC3339 formatiert ist.
timeZone string Die in der Antwort verwendete Zeitzone. Optional. Die Standardeinstellung ist UTC.
groupExpansionMax integer Maximale Anzahl von Kalenderkennzeichnungen, die für eine einzelne Gruppe angegeben werden können. Optional. Für eine Gruppe mit mehr Mitgliedern als dieser Wert wird ein Fehler zurückgegeben. Der Höchstwert ist 100.
calendarExpansionMax integer Maximale Anzahl von Kalendern, für die Informationen zu FreeBusy bereitgestellt werden sollen. Optional. Der Höchstwert ist 50.
items[] list Liste der abzufragenden Kalender und/oder Gruppen.
items[].id string Die ID eines Kalenders oder einer Gruppe.

Antwort

Bei Erfolg gibt diese Methode einen Antworttext mit der folgenden Struktur zurück:

{
  "kind": "calendar#freeBusy",
  "timeMin": datetime,
  "timeMax": datetime,
  "groups": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "calendars": [
        string
      ]
    }
  },
  "calendars": {
    (key): {
      "errors": [
        {
          "domain": string,
          "reason": string
        }
      ],
      "busy": [
        {
          "start": datetime,
          "end": datetime
        }
      ]
    }
  }
}
Name der Eigenschaft Wert Beschreibung Hinweise
kind string Typ der Ressource ("calendar#freeBusy")
timeMin datetime Beginn des Intervalls.
timeMax datetime Das Ende des Intervalls.
groups object Erweiterung der Gruppen.
groups.(key) nested object Liste der Kalender, die Mitglieder dieser Gruppe sind.
groups.(key).errors[] list Optionale Fehler (wenn die Berechnung für die Gruppe fehlgeschlagen ist).
groups.(key).errors[].domain string Domain oder allgemeine Kategorie des Fehlers.
groups.(key).errors[].reason string Spezifische Ursache des Fehlers. Folgende Werte sind möglich:
  • „groupTooBig“: Die angeforderte Gruppe von Nutzern ist zu groß für eine einzelne Abfrage.
  • „tooManyCalendarsRequested“ – Die Anzahl der angeforderten Kalender ist zu groß für eine einzelne Abfrage.
  • "notFound" – Die angeforderte Ressource wurde nicht gefunden.
  • "internalError": Beim API-Dienst ist ein interner Fehler aufgetreten.
In Zukunft werden möglicherweise weitere Fehlertypen hinzugefügt. Kunden sollten daher Fehlerstatus, die nicht in dieser Liste enthalten sind, ordnungsgemäß verarbeiten.
groups.(key).calendars[] list Liste der Kalenderkennungen innerhalb einer Gruppe.
calendars object Liste der Verfügbarkeitsinformationen für Kalender.
calendars.(key) nested object Erweiterungen des Verfügbar/Beschäftigt-Status für einen einzelnen Kalender
calendars.(key).errors[] list Optionale Fehler (wenn die Berechnung für den Kalender fehlgeschlagen ist)
calendars.(key).errors[].domain string Domain oder allgemeine Kategorie des Fehlers.
calendars.(key).errors[].reason string Spezifische Ursache des Fehlers. Folgende Werte sind möglich:
  • „groupTooBig“: Die angeforderte Gruppe von Nutzern ist zu groß für eine einzelne Abfrage.
  • „tooManyCalendarsRequested“ – Die Anzahl der angeforderten Kalender ist zu groß für eine einzelne Abfrage.
  • "notFound" – Die angeforderte Ressource wurde nicht gefunden.
  • "internalError": Beim API-Dienst ist ein interner Fehler aufgetreten.
In Zukunft werden möglicherweise weitere Fehlertypen hinzugefügt. Kunden sollten daher Fehlerstatus, die nicht in dieser Liste enthalten sind, ordnungsgemäß verarbeiten.
calendars.(key).busy[] list Liste der Zeiträume, in denen dieser Kalender als beschäftigt gelten soll.
calendars.(key).busy[].start datetime Der (inklusive) Beginn des Zeitraums.
calendars.(key).busy[].end datetime Das (ausschließliche) Ende des Zeitraums.

Jetzt testen

Verwenden Sie den unten angegebenen APIs Explorer, um diese Methode für Livedaten aufzurufen und die Antwort einzusehen.