Method: analytics.agentPerformances.list

Listet die Daten zur Agent-Leistung auf, auf die der Aufrufer Zugriff hat.

Jedes Ergebnis stellt die Leistungsmesswerte für einen bestimmten Agent in einem bestimmten Land dar. Wenn für einen Agent nicht genügend Daten für ein bestimmtes Land vorhanden sind, wird kein Leistungsdatensatz für dieses Agent-Land-Paar zurückgegeben.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Abfrageparameter

Parameter
pageSize

integer

Optional. Geben Sie die maximale Anzahl der Ergebnisse an, die vom Server zurückgegeben werden sollen. Die Anzahl der maximal auf einer Seite zurückgegebenen Ergebnisse kann auf dem Server weiter begrenzt werden. Wenn für „pageSize“ der Wert 0 angegeben ist, wird die Anzahl der zurückzugebenden Ergebnisse auf dem Server festgelegt. Die maximale Seitengröße beträgt 1.000.
pageToken

string

Optional. Der Wert „nextPageToken“ wurde gegebenenfalls von einer vorherigen Listenanfrage zurückgegeben.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Gibt eine Liste der Agent-Leistungen zurück.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
Felder
agentPerformances[]

object (AgentPerformance)

Liste der Agent-Leistungen.
nextPageToken

string

Optional. Das Seitentoken zum Abrufen der nächsten Ergebnisseite. Wenn der Wert "" ist, sind keine weiteren Ergebnisse für die Anfrage vorhanden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

AgentPerformance

Leistungsmesswerte für einen Agent in einem Land.

JSON-Darstellung 
{
  "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)
  }
}
Felder
name

string

Die eindeutige ID des Agents.

Wird von der Plattform definiert.
displayName

string

Erforderlich. Der Name, der Nutzern für den Agent angezeigt wird. Maximal 40 Zeichen.

Nach der Agent-Bestätigung nicht mehr änderbar.
countryCode

string

Die Dimension „Land“ für die angegebenen Leistungsmesswerte. Wird als Ländercode gemäß ISO 3166 Alpha-2 angegeben. Beispiel: „US“ für die Vereinigten Staaten von Amerika.
agentUseCase

enum (AgentUseCase)

Der Anwendungsfall des Agents.
reputation

enum (Reputation)

Die Reputation des Agents im angegebenen Land.
trafficLimit

integer

Das Traffic-Limit für den Agent (Nachrichten pro Nutzer und Monat) im angegebenen Land. Wenn für den Agent keine Traffic-Limits gelten, wird der Wert nicht festgelegt.
metricsPeriodEndTime

string (Timestamp format)

Der Zeitstempel, der das Ende des Zeitraums darstellt, für den die Messwerte berechnet wurden. Messwerte, einschließlich der Reputation, werden anhand von Daten bis zu diesem Zeitstempel berechnet. Dieser Zeitstempel ist der letzte Mitternacht in der Pacific Time (PT).

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
spamTrendDays7

enum (TrendDirection)

Spamtrend für einen Zeitraum von 7 Tagen.
spamTrendDays28

enum (TrendDirection)

Spamtrend für einen Zeitraum von 28 Tagen.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

Messwerte zu den Gründen für die Abmeldung vom Agent für einen Zeitraum von 7 Tagen.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

Messwerte zu den Gründen für die Abmeldung vom Agent für einen Zeitraum von 28 Tagen.

Reputation

Die Reputation des Agents im angegebenen Land.

Enums
REPUTATION_UNSPECIFIED Nicht angegebene Reputation.
LOW Geringe Reputation. Das ist die Standardreputation.
MEDIUM Mittlere Reputation.
HIGH Hohe Reputation.

TrendDirection

Zeigt, wie sich ein Messwert in einem bestimmten Zeitraum verändert hat.

Enums
TREND_DIRECTION_UNSPECIFIED Nicht angegebene Trendrichtung.
DOWN Der Trend ist rückläufig.
NEUTRAL Der Trend hat sich nicht verändert.
UP Der Trend ist steigend.

AgentUnsubscribeReasonMetrics

Messwerte zu den Gründen für die Abmeldung vom Agent für einen bestimmten Zeitraum.

JSON-Darstellung 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Felder
notSignedUpPercentage

integer

Prozentsatz der Nutzer, die „Nicht angemeldet“ als Grund für die Abmeldung angegeben haben.
tooManyMessagesPercentage

integer

Prozentsatz der Nutzer, die „Zu viele Nachrichten“ als Grund für die Abmeldung angegeben haben.
noLongerInterestedPercentage

integer

Prozentsatz der Nutzer, die „Kein Interesse mehr“ als Grund für die Abmeldung angegeben haben.
spamPercentage

integer

Prozentsatz der Nutzer, die „Spam“ als Grund für die Abmeldung angegeben haben.
otherPercentage

integer

Prozentsatz der Nutzer, die „Sonstiges“ als Grund für die Abmeldung angegeben haben.