Method: alerts.list

Liste les alertes.

Requête HTTP

GET https://alertcenter.googleapis.com/v1beta1/alerts

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
customerId

string

Facultatif. Identifiant unique du compte Google Workspace du client auquel les alertes sont associées. La lettre "C" initiale doit être supprimée de customerId (par exemple, 046psxkn). Inféré de l'identité de l'appelant si non fourni. Trouvez votre numéro client.
pageSize

integer

Facultatif. La taille de page demandée. Le serveur peut renvoyer moins d'éléments que demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
pageToken

string

Facultatif. Jeton identifiant une page de résultats que le serveur doit renvoyer. Si elle est vide, une nouvelle itération est lancée. Pour poursuivre une itération, transmettez la valeur du champ nextPageToken de la réponse ListAlertsResponse précédente.
filter

string

Facultatif. Chaîne de requête permettant de filtrer les résultats des alertes. Pour en savoir plus, consultez les pages Filtres de requête et Champs de filtre de requête compatibles.
orderBy

string

Facultatif. Ordre de tri des résultats de la liste. Si aucun ordre n'est spécifié, les résultats peuvent être renvoyés dans un ordre arbitraire. Vous pouvez trier les résultats par ordre décroissant en fonction de l'horodatage de création à l'aide de orderBy="createTime desc". Actuellement, les trieurs acceptés sont createTime asc, createTime desc et updateTime desc.

Corps de la requête

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

Corps de la réponse

Message de réponse à une requête de liste d'alertes.

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

Représentation JSON 
{
  "alerts": [
    {
      object (Alert)
    }
  ],
  "nextPageToken": string
}
Champs
alerts[]

object (Alert)

Liste des alertes.
nextPageToken

string

Jeton de la page suivante. Si ce champ n'est pas vide, cela signifie qu'il peut y avoir d'autres alertes correspondant à la requête de fiche. Cette valeur peut être utilisée dans une ListAlertsRequest ultérieure pour obtenir des alertes à partir du dernier résultat de l'appel de liste en cours.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/apps.alerts

Pour en savoir plus, consultez le guide d'autorisation.