Method: analytics.agentPerformances.list

Elenca i dati sul rendimento dell'agente accessibili al chiamante.

Ogni risultato rappresenta le metriche di rendimento per un agente specifico in un paese specifico. Se un agente non dispone di dati sufficienti per un determinato paese, non viene restituito alcun record di rendimento per la coppia agente-paese.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

Parametri
pageSize

integer

Facoltativo. Specifica il numero massimo di risultati da restituire dal server. Il server potrebbe limitare ulteriormente il numero massimo di risultati restituiti in una singola pagina. Se pageSize è 0, il server deciderà il numero di risultati da restituire. Il valore massimo di pageSize è 1000.
pageToken

string

Facoltativo. Il valore nextPageToken restituito da una precedente richiesta List, se presente.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Restituisce un elenco delle prestazioni degli agenti.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
Campi
agentPerformances[]

object (AgentPerformance)

Elenco delle prestazioni degli agenti.
nextPageToken

string

Facoltativo. Il token di paginazione per recuperare la pagina successiva dei risultati. Se il valore è "", significa che non ci sono altri risultati per la richiesta.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

AgentPerformance

Metriche sul rendimento per un agente in un paese.

Rappresentazione 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)
  }
}
Campi
name

string

L'identificatore univoco dell'agente.

Definito dalla piattaforma.
displayName

string

Obbligatorio. Il nome che l'agente mostra agli utenti. Massimo 40 caratteri.

Non modificabile dopo la verifica dell'agente.
countryCode

string

La dimensione Paese per le metriche sul rendimento specificate. Indicato come codice paese ISO 3166 Alpha-2. Ad esempio, "US" per gli Stati Uniti d'America.
agentUseCase

enum (AgentUseCase)

Il caso d'uso dell'agente
reputation

enum (Reputation)

Reputazione dell'agente nel paese specificato.
trafficLimit

integer

Limite di traffico per l'agente (messaggi per utente al mese) nel paese specificato. Se l'agente non è soggetto a limiti di traffico, il valore non verrà impostato.
metricsPeriodEndTime

string (Timestamp format)

Il timestamp che rappresenta la fine del periodo per il quale sono state calcolate le metriche. Le metriche, inclusa la reputazione, vengono calcolate in base ai dati fino a questo timestamp. Questo timestamp indica la mezzanotte più recente del fuso orario del Pacifico (PT).

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
spamTrendDays7

enum (TrendDirection)

Tendenza dello spam per un periodo di 7 giorni.
spamTrendDays28

enum (TrendDirection)

Tendenza dello spam per un periodo di 28 giorni.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

Metriche sui motivi dell'annullamento dell'iscrizione degli agenti per un periodo di 7 giorni.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

Metriche sui motivi di annullamento dell'iscrizione degli agenti per un periodo di 28 giorni.

Reputazione

La reputazione dell'agente nel paese specificato.

Enum
REPUTATION_UNSPECIFIED Reputazione non specificata.
LOW Reputazione bassa. Questa è la reputazione predefinita.
MEDIUM Reputazione media.
HIGH Buona reputazione.

TrendDirection

Mostra la variazione di una metrica in un determinato periodo.

Enum
TREND_DIRECTION_UNSPECIFIED Direzione del trend non specificata.
DOWN La tendenza è in calo.
NEUTRAL La tendenza non è cambiata.
UP La tendenza è in aumento.

AgentUnsubscribeReasonMetrics

Metriche sui motivi di annullamento dell'iscrizione degli agenti per un determinato periodo.

Rappresentazione JSON 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Campi
notSignedUpPercentage

integer

Percentuale di utenti che hanno scelto "Non registrato" come motivo dell'annullamento dell'iscrizione.
tooManyMessagesPercentage

integer

Percentuale di utenti che hanno scelto "Troppi messaggi" come motivo dell'annullamento dell'iscrizione.
noLongerInterestedPercentage

integer

Percentuale di utenti che hanno scelto "Non mi interessa più" come motivo dell'annullamento dell'iscrizione.
spamPercentage

integer

Percentuale di utenti che hanno scelto "Spam" come motivo dell'annullamento dell'iscrizione.
otherPercentage

integer

Percentuale di utenti che hanno scelto "Altro" come motivo dell'annullamento dell'iscrizione.