Method: analytics.agentPerformances.list

Arayan kişinin erişebileceği temsilci performans verilerini listeler.

Her sonuç, belirli bir ülkedeki belirli bir temsilcinin performans metriklerini gösterir. Bir aracının belirli bir ülke için yeterli verisi yoksa söz konusu aracı-ülke çifti için performans kaydı döndürülmez.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
pageSize

integer

İsteğe bağlı. Sunucu tarafından döndürülecek maksimum sonuç sayısını belirtin. Sunucu, tek bir sayfada döndürülen maksimum sonuç sayısını daha da kısıtlayabilir. pageSize 0 ise sunucu, döndürülecek sonuç sayısına karar verir. Maksimum pageSize değeri 1.000'dir.
pageToken

string

İsteğe bağlı. Önceki bir List isteğinden döndürülen nextPageToken değeri (varsa).

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Temsilci performanslarının listesini döndürür.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "agentPerformances": [
    {
      object (AgentPerformance)
    }
  ],
  "nextPageToken": string
}
Alanlar
agentPerformances[]

object (AgentPerformance)

Temsilci performanslarının listesi.
nextPageToken

string

İsteğe bağlı. Sonraki sonuç sayfasını almak için kullanılan sayfalama jetonu. Değer "" ise istek için başka sonuç olmadığı anlamına gelir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.

AgentPerformance

Bir ülkedeki temsilcinin performans metrikleri.

JSON gösterimi 
{
  "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)
  }
}
Alanlar
name

string

Aracının benzersiz tanımlayıcısı.

Platform tarafından tanımlanır.
displayName

string

Zorunlu. Temsilcinin kullanıcılara gösterdiği ad. Maksimum 40 karakter.

Temsilci doğrulaması yapıldıktan sonra değiştirilemez.
countryCode

string

Belirli performans metrikleri için ülke boyutu. ISO 3166 Alpha-2 ülke kodu olarak verilir. Örneğin, Amerika Birleşik Devletleri için "US".
agentUseCase

enum (AgentUseCase)

Temsilcinin kullanım alanı
reputation

enum (Reputation)

Aracının ilgili ülkedeki itibarı.
trafficLimit

integer

Belirli bir ülkedeki temsilcinin trafik sınırı (kullanıcı başına aylık mesaj sayısı). Aracı trafik sınırlarına tabi değilse değer ayarlanmaz.
metricsPeriodEndTime

string (Timestamp format)

Metriklerin hesaplandığı dönemin sonunu gösteren zaman damgası. İtibar da dahil olmak üzere metrikler, bu zaman damgasına kadar olan verilere göre hesaplanır. Bu zaman damgası, en son Pasifik Saati (PT) gece yarısıdır.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".
spamTrendDays7

enum (TrendDirection)

7 günlük dönem için spam trendi.
spamTrendDays28

enum (TrendDirection)

28 günlük dönem için spam trendi.
agentUnsubscribeReasonMetricsDays7

object (AgentUnsubscribeReasonMetrics)

7 günlük dönem için aracı abonelikten çıkma nedeni metrikleri.
agentUnsubscribeReasonMetricsDays28

object (AgentUnsubscribeReasonMetrics)

28 günlük dönem için aracı abonelikten çıkma nedeni metrikleri.

İtibar

Aracının söz konusu ülkedeki itibarı.

Sıralamalar
REPUTATION_UNSPECIFIED Belirtilmemiş itibar.
LOW İtibar düşük.
MEDIUM Orta düzeyde itibar. Bu, varsayılan itibardır.
HIGH Yüksek itibar

TrendDirection

Bir metriğin belirli bir dönemde nasıl değiştiğini gösterir.

Sıralamalar
TREND_DIRECTION_UNSPECIFIED Belirtilmemiş trend yönü.
DOWN Trend düşüşte.
NEUTRAL Trend değişmedi.
UP Trend yükselişte.

AgentUnsubscribeReasonMetrics

Belirli bir dönem için aracı abonelikten çıkma nedeni metrikleri.

JSON gösterimi 
{
  "notSignedUpPercentage": integer,
  "tooManyMessagesPercentage": integer,
  "noLongerInterestedPercentage": integer,
  "spamPercentage": integer,
  "otherPercentage": integer
}
Alanlar
notSignedUpPercentage

integer

Abonelikten çıkma nedeni olarak "Kaydolmadım"ı seçen kullanıcıların yüzdesi.
tooManyMessagesPercentage

integer

Abonelikten çıkma nedeni olarak "Çok fazla ileti"yi seçen kullanıcıların yüzdesi.
noLongerInterestedPercentage

integer

Abonelikten çıkma nedeni olarak "Artık ilgilenmiyorum"u seçen kullanıcıların yüzdesi.
spamPercentage

integer

E-posta listesinden çıkma nedeni olarak "Spam"i seçen kullanıcıların yüzdesi.
otherPercentage

integer

Abonelikten çıkma nedeni olarak "Diğer"i seçen kullanıcıların yüzdesi.