Method: analytics.agentPerformances.list

Wyświetla dane o skuteczności agenta dostępne dla dzwoniącego.

Każdy wynik przedstawia dane o skuteczności konkretnego agenta w danym kraju. Jeśli agent ma niewystarczającą ilość danych w danym kraju, nie jest zwracany żaden rekord skuteczności dla tej pary agent-kraj.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Określ maksymalną liczbę wyników, które mają zostać zwrócone przez serwer. Serwer może dodatkowo ograniczyć maksymalną liczbę wyników zwracanych na jednej stronie. Jeśli wartość parametru pageSize wynosi 0, serwer sam określi liczbę wyników do zwrócenia. Maksymalna wartość parametru pageSize to 1000.
pageToken

string

Opcjonalnie. Wartość nextPageToken zwrócona przez poprzednie żądanie List, jeśli taka wartość istnieje.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Zwraca listę danych o skuteczności agenta.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
Pola
agentPerformances[]

object (AgentPerformance)

Lista danych o skuteczności agenta.
nextPageToken

string

Opcjonalnie. Token stronicowania umożliwiający pobranie następnej strony wyników. Jeśli wartość to "", oznacza to, że nie ma więcej wyników dla tego żądania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji: OAuth 2.0 Overview.

AgentPerformance

Dane o skuteczności agenta w danym kraju.

Zapis 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)
  }
}
Pola
name

string

Unikalny identyfikator agenta.

Zdefiniowany przez platformę.
displayName

string

Wymagane. Nazwa, która jest wyświetlana użytkownikom. Maksymalnie 40 znaków

Po zweryfikowaniu agenta nie można jej zmienić.
countryCode

string

Wymiar kraju dla podanych danych o skuteczności. Podany jako kod kraju ISO 3166 Alpha-2. Na przykład „PL” w przypadku Polski.
agentUseCase

enum (AgentUseCase)

Przypadek użycia agenta
reputation

enum (Reputation)

Reputacja agenta w danym kraju.
trafficLimit

integer

Limit ruchu dla agenta (liczba wiadomości na użytkownika miesięcznie) w danym kraju. Jeśli agent nie podlega limitom ruchu, wartość nie zostanie ustawiona.
metricsPeriodEndTime

string (Timestamp format)

Sygnatura czasowa oznaczająca koniec okresu, za który obliczono dane. Dane, w tym reputacja, są obliczane na podstawie danych do tej sygnatury czasowej. Ta sygnatura czasowa to ostatnia północ czasu pacyficznego (PT).

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
spamTrendDays7

enum (TrendDirection)

Trend dotyczący spamu w okresie 7 dni.
spamTrendDays28

enum (TrendDirection)

Trend dotyczący spamu w okresie 28 dni.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

Dane o przyczynach rezygnacji z subskrypcji agenta w okresie 7 dni.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

Dane o przyczynach rezygnacji z subskrypcji agenta w okresie 28 dni.

Reputation

Reputacja agenta w danym kraju.

Wartości w polu enum
REPUTATION_UNSPECIFIED Nieokreślona reputacja.
LOW Niska reputacja. Jest to domyślna reputacja.
MEDIUM Średnia reputacja.
HIGH Dobra reputacja.

TrendDirection

Pokazuje, jak zmieniły się dane w danym okresie.

Wartości w polu enum
TREND_DIRECTION_UNSPECIFIED Nieokreślony kierunek trendu.
DOWN Trend spadkowy.
NEUTRAL Trend się nie zmienił.
UP Trend wzrostowy.

AgentUnsubscribeReasonMetrics

Dane o przyczynach rezygnacji z subskrypcji agenta w danym okresie.

Zapis JSON 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Pola
notSignedUpPercentage

integer

Odsetek użytkowników, którzy jako powód rezygnacji z subskrypcji wybrali opcję „Nie zarejestrowano”.
tooManyMessagesPercentage

integer

Odsetek użytkowników, którzy jako powód rezygnacji z subskrypcji wybrali opcję „Zbyt wiele wiadomości”.
noLongerInterestedPercentage

integer

Odsetek użytkowników, którzy jako powód rezygnacji z subskrypcji wybrali opcję „Nie interesuje mnie to”.
spamPercentage

integer

Odsetek użytkowników, którzy jako powód rezygnacji z subskrypcji wybrali opcję „Spam”.
otherPercentage

integer

Odsetek użytkowników, którzy jako powód rezygnacji z subskrypcji wybrali opcję „Inne”.