Method: analytics.agentPerformances.list

Enumera los datos de rendimiento del agente a los que puede acceder el llamador.

Cada resultado representa las métricas de rendimiento de un agente específico en un país específico. Si un agente no tiene suficientes datos para un país determinado, no se devuelve ningún registro de rendimiento para ese par agente-país.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Especifica la cantidad máxima de resultados que devolverá el servidor. El servidor puede limitar aún más la cantidad máxima de resultados que se muestran en una sola página. Si pageSize es 0, el servidor decidirá la cantidad de resultados que se mostrarán. El valor máximo de pageSize es 1,000.
pageToken

string

Opcional. El valor nextPageToken que se muestra de una solicitud de lista previa, si existe.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Devuelve una lista de rendimientos del agente.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
Campos
agentPerformances[]

object (AgentPerformance)

Es la lista de rendimientos de los agentes.
nextPageToken

string

Opcional. Es el token de paginación para recuperar la siguiente página de resultados. Si el valor es "", significa que no hay más resultados para la solicitud.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

AgentPerformance

Son las métricas de rendimiento de un agente en un país.

Representación 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)
  }
}
Campos
name

string

El identificador único del agente.

Es definido por la plataforma.
displayName

string

Obligatorio. Es el nombre que el agente muestra a los usuarios. Máximo de 40 caracteres.

No se puede modificar después de la verificación del agente.
countryCode

string

Es la dimensión del país para las métricas de rendimiento proporcionadas. Se proporciona como un código de país ISO 3166 Alpha-2. Por ejemplo, “US” para Estados Unidos de América.
agentUseCase

enum (AgentUseCase)

Caso de uso del agente
reputation

enum (Reputation)

Reputación del agente en el país determinado.
trafficLimit

integer

Límite de tráfico del agente (mensajes por usuario y por mes) en el país determinado. Si el agente no está sujeto a límites de tráfico, no se establecerá el valor.
metricsPeriodEndTime

string (Timestamp format)

Es la marca de tiempo que representa el final del período para el que se calcularon las métricas. Las métricas, incluida la reputación, se calculan en función de los datos hasta esta marca de tiempo. Esta marca de tiempo corresponde a la medianoche más reciente (hora del Pacífico, PT).

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
spamTrendDays7

enum (TrendDirection)

Tendencia de spam durante un período de 7 días.
spamTrendDays28

enum (TrendDirection)

Tendencia de spam para un período de 28 días.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

Son las métricas de los motivos por los que los agentes se dieron de baja durante un período de 7 días.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

Son las métricas de los motivos por los que los agentes se dan de baja durante un período de 28 días.

Reputación

Reputación del agente en el país determinado.

Enums
REPUTATION_UNSPECIFIED Reputación sin especificar.
LOW Reputación baja
MEDIUM Reputación media Esta es la reputación predeterminada.
HIGH Reputación alta

TrendDirection

Muestra cómo cambió una métrica durante un período determinado.

Enums
TREND_DIRECTION_UNSPECIFIED No se especificó la dirección de la tendencia.
DOWN La tendencia es a la baja.
NEUTRAL La tendencia no cambió.
UP La tendencia es ascendente.

AgentUnsubscribeReasonMetrics

Son las métricas de motivos de anulación de la suscripción del agente para un período determinado.

Representación JSON 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Campos
notSignedUpPercentage

integer

Es el porcentaje de usuarios que eligieron "No me suscribí" como motivo para cancelar la suscripción.
tooManyMessagesPercentage

integer

Es el porcentaje de usuarios que eligieron "Demasiados mensajes" como motivo para anular la suscripción.
noLongerInterestedPercentage

integer

Es el porcentaje de usuarios que eligieron “Ya no me interesa” como motivo para cancelar la suscripción.
spamPercentage

integer

Es el porcentaje de usuarios que eligieron "Spam" como motivo para anular la suscripción.
otherPercentage

integer

Es el porcentaje de usuarios que eligieron "Otro" como motivo para cancelar la suscripción.