Method: resources.calendars.list

Récupère la liste des ressources d'agenda d'un compte.

Requête HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/resources/calendars

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customer

string

Identifiant unique du compte Google Workspace du client. En tant qu'administrateur de compte, vous pouvez également utiliser l'alias my_customer pour représenter le numéro client de votre compte.

Paramètres de requête

Paramètres
maxResults

integer

Nombre maximal de résultats sur une page.
orderBy

string

Champ(s) pour trier les résultats dans l'ordre croissant ou décroissant. Les champs compatibles incluent resourceId, resourceName, capacity, buildingId et floorName. Si aucun ordre n'est spécifié, la valeur par défaut est croissante. Doit être au format "champ [asc|desc], champ [asc|desc], ...". Par exemple, buildingId, capacity desc renvoie les résultats triés d'abord par buildingId dans l'ordre croissant, puis par capacity dans l'ordre décroissant.
pageToken

string

Jeton permettant de spécifier la page suivante dans la liste.
query

string

Requête de chaîne utilisée pour filtrer les résultats. Doit être au format "valeur de l'opérateur de champ" où le champ peut correspondre à n'importe quel champ compatible et l'opérateur peut correspondre à n'importe quelle opération compatible. Les opérateurs incluent "=" pour un mot clé exact : "!=" pour non-concordance et ":" pour la correspondance de préfixe ou de correspondance HAS, le cas échéant. Dans le cas d'une correspondance de préfixe, la valeur doit toujours être suivie d'un *. Les opérateurs logiques NOT et AND sont pris en charge (dans cet ordre de priorité). Les champs compatibles incluent generatedResourceName, name, buildingId, floorName, capacity, featureInstances.feature.name, resourceEmail et resourceCategory. Exemple : buildingId=US-NYC-9TH AND featureInstances.feature.name:Phone.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

API publique: Resources.calendars

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (CalendarResource)
    }
  ],
  "nextPageToken": string
}
Champs
kind

string

Identifie cet élément comme une collection de CalendarResources. Il s'agit toujours de admin#directory#resources#calendars#calendarResourcesList.
etag

string

ETag de la ressource.
items[]

object (CalendarResource)

CalendarResources figurant sur cette page de résultats.
nextPageToken

string

Jeton de continuité servant à parcourir les ensembles de résultats volumineux. Indiquez cette valeur dans une requête ultérieure pour renvoyer la page de résultats suivante.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://apps-apis.google.com/a/feeds/calendar/resource/
  • https://www.googleapis.com/auth/admin.directory.resource.calendar
  • https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly

Pour en savoir plus, consultez le Guide relatif aux autorisations.