Method: analytics.agentPerformances.list

Liste les données sur les performances de l'agent accessibles à l'appelant.

Chaque résultat représente les métriques de performances d'un agent spécifique dans un pays donné. Si un agent ne dispose pas de suffisamment de données pour un pays donné, aucun enregistrement de performances n'est renvoyé pour cette paire agent-pays.

Requête HTTP

GET https://businesscommunications.googleapis.com/v1/analytics/agentPerformances

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Spécifiez le nombre maximal de résultats à renvoyer par le serveur. Le serveur peut en outre limiter le nombre maximal de résultats renvoyés sur une seule page. Si l'attribut pageSize est défini sur 0, le serveur décide du nombre de résultats à renvoyer. La valeur maximale de pageSize est 1 000.
pageToken

string

Facultatif. La valeur nextPageToken affichée par une requête "List" antérieure, le cas échéant.

Corps de la requête

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

Corps de la réponse

Renvoie une liste des performances de l'agent.

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

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

object (AgentPerformance)

Liste des performances de l'agent.
nextPageToken

string

Facultatif. Jeton de pagination permettant de récupérer la page de résultats suivante. Si la valeur est "", cela signifie qu'il n'y a plus de résultats pour la requête.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/businesscommunications

Pour plus d'informations, consultez la OAuth 2.0 Overview.

AgentPerformance

Métriques de performances d'un agent dans un pays.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "countryCode": string,
  "agentUseCase": enum (AgentUseCase),
  "reputation": enum (Reputation),
  "trafficLimit": integer,
  "metricsPeriodEndTime": string,
  "spamTrendDays7": enum (TrendDirection),
  "spamTrendDays28": enum (TrendDirection),
  "agentUnsubscribeReasonMetricsDays7": {
    object (AgentUnsubscribeReasonMetrics)
  },
  "agentUnsubscribeReasonMetricsDays28": {
    object (AgentUnsubscribeReasonMetrics)
  }
}
Champs
name

string

Identifiant unique de l'agent.

Défini par la plate-forme.
displayName

string

Obligatoire. Nom que l'agent affiche pour les utilisateurs. 40 caractères maximum.

Non modifiable après la validation de l'agent.
countryCode

string

Dimension "Pays" pour les métriques de performances données. Indiqué sous la forme d'un code pays ISO 3166 Alpha-2. Par exemple, "US" pour les États-Unis d'Amérique.
agentUseCase

enum (AgentUseCase)

Cas d'utilisation de l'agent
reputation

enum (Reputation)

Réputation de l'agent dans le pays donné.
trafficLimit

integer

Limite de trafic pour l'agent (messages par utilisateur et par mois) dans le pays donné. Si l'agent n'est pas soumis à des limites de trafic, la valeur n'est pas définie.
metricsPeriodEndTime

string (Timestamp format)

Code temporel représentant la fin de la période pour laquelle les métriques ont été calculées. Les métriques, y compris la réputation, sont calculées en fonction des données jusqu'à ce code temporel. Ce code temporel correspond au dernier minuit (heure du Pacifique).

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
spamTrendDays7

enum (TrendDirection)

Tendance du spam sur une période de sept jours.
spamTrendDays28

enum (TrendDirection)

Tendance du spam sur une période de 28 jours.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

Métriques sur les motifs de désabonnement de l'agent sur une période de sept jours.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

Métriques sur les motifs de désabonnement de l'agent sur une période de 28 jours.

Réputation

Réputation de l'agent dans le pays donné.

Enums
REPUTATION_UNSPECIFIED Réputation non spécifiée.
LOW Réputation faible. Il s'agit de la réputation par défaut.
MEDIUM Réputation moyenne.
HIGH Réputation élevée.

TrendDirection

Indique l'évolution d'une métrique sur une période donnée.

Enums
TREND_DIRECTION_UNSPECIFIED Direction de la tendance non spécifiée.
DOWN La tendance est à la baisse.
NEUTRAL La tendance n'a pas changé.
UP La tendance est à la hausse.

AgentUnsubscribeReasonMetrics

Métriques sur les motifs de désabonnement de l'agent sur une période donnée.

Représentation JSON 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Champs
notSignedUpPercentage

integer

Pourcentage d'utilisateurs ayant choisi "Non inscrit" comme motif de désabonnement.
tooManyMessagesPercentage

integer

Pourcentage d'utilisateurs ayant choisi "Trop de messages" comme motif de désabonnement.
noLongerInterestedPercentage

integer

Pourcentage d'utilisateurs ayant choisi "Plus intéressé" comme motif de désabonnement.
spamPercentage

integer

Pourcentage d'utilisateurs ayant choisi "Spam" comme motif de désabonnement.
otherPercentage

integer

Pourcentage d'utilisateurs ayant choisi "Autre" comme motif de désabonnement.