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) permettant de trier les résultats par ordre croissant ou décroissant. Les champs acceptés incluent resourceId, resourceName, capacity, buildingId et floorName. Si aucun ordre n'est spécifié, la valeur par défaut est croissante. Doit se présenter sous la forme "champ [asc|desc], champ [asc|desc], ...". Par exemple, buildingId, capacity desc renvoie les résultats triés en premier 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 se présenter sous la forme "valeur de l'opérateur de champ", où le champ peut correspondre à n'importe quel champ compatible et les opérateurs peuvent correspondre à n'importe quelle opération prise en charge. Les opérateurs incluent "=" pour une correspondance exacte, "!=" pour non-concordance et ":" pour une correspondance de préfixe ou "HAS" le cas échéant. Pour la correspondance de préfixe, la valeur doit toujours être suivie d'un *. Les opérateurs logiques NOT et AND sont acceptés (dans cet ordre de priorité). Les champs compatibles sont 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 en tant que collection de CalendarResources. Il s'agit toujours de admin#directory#resources#calendars#calendarResourcesList.
etag

string

ETag de la ressource.
items[]

object (CalendarResource)

CalendarResources de cette page de résultats.
nextPageToken

string

Jeton de continuité permettant de 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.