Method: analytics.agentPerformances.list

Zawiera listę danych o skuteczności agenta dostępnych dla dzwoniącego.

Każdy wynik zawiera dane o skuteczności konkretnego agenta w danym kraju. Jeśli agent ma niewystarczającą ilość danych dla danego 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ą być zwracane przez serwer. Serwer może dodatkowo ograniczyć maksymalną liczbę wyników zwracanych na jednej stronie. Jeśli parametr pageSize ma wartość 0, serwer zdecyduje, ile wyników ma zostać zwróconych. Maksymalna wartość parametru pageSize to 1000.
pageToken

string

Opcjonalnie. Wartość nextPageToken zwrócona z poprzedniego żądania List (jeśli występuje).

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Zwraca listę wyników agentów.

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

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

object (AgentPerformance)

Lista wyników agentów.
nextPageToken

string

Opcjonalnie. Token stronicowania do pobrania następnej strony wyników. Jeśli wartość to „”, oznacza to, że nie ma więcej wyników dla żądania.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w sekcji 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.

Określone przez platformę.
displayName

string

Wymagane. Nazwa, którą agent wyświetla użytkownikom. Maksymalnie 40 znaków.

Po weryfikacji agenta nie można go zmienić.
countryCode

string

Wymiar Kraj w przypadku podanych danych o skuteczności. Podany jako kod kraju w formacie 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 agenta (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 informacji 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-dniowym.
spamTrendDays28

enum (TrendDirection)

Trend dotyczący spamu w okresie 28 dni.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

Dane o przyczynach anulowania subskrypcji agenta za okres 7 dni.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

Dane dotyczące przyczyn rezygnacji z subskrypcji agenta za okres 28 dni.

Reputacja

Reputacja agenta w danym kraju.

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

TrendDirection

Pokazuje, jak dana wartość zmieniła się w określonym czasie.

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

AgentUnsubscribeReasonMetrics

Dane o przyczynach anulowania subskrypcji przez agentów 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 „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 już”.
spamPercentage

integer

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

integer

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