Method: entityUsageReports.get

Hesaptaki kullanıcılar tarafından kullanılan varlıklar için mülk ve istatistik koleksiyonu olan bir rapor getirir. Daha fazla bilgi için Varlık Kullanım Raporu rehberine bakın. Varlıklar raporunun parametreleri hakkında daha fazla bilgi için Varlık Kullanımı parametreleri referans kılavuzlarına bakın.

HTTP isteği

GET https://admin.googleapis.com/admin/reports/v1/usage/{entityType}/{entityKey or all}/dates/{date}

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

Yol parametreleri

Parametreler
entityType

enum (EntityType)

Rapordaki varlığın türünü temsil eder.
entityKey or all

string

Verilerin filtreleneceği nesnenin anahtarını temsil eder. Bu dize, tüm kullanıcılar için etkinlik etkinliklerini veya uygulamaya özel bir varlık için diğer herhangi bir değeri almak amacıyla all değerini alabilen bir dizedir. Belirli bir entityType için entityKey edinmeyle ilgili ayrıntılar için Varlık Kullanımı parametreleri referans kılavuzlarını inceleyin.
date

string

UTC-8:00 (Pasifik Standart Saati) saat dilimine göre kullanımın gerçekleştiği tarihi temsil eder. Zaman damgası ISO 8601 biçiminde, yyyy-mm-dd olmalıdır.

Sorgu parametreleri

Parametreler
customerId

string

Verileri alınacak müşterinin benzersiz kimliği.
filters

string

filters sorgu dizesi, bir uygulamanın etkinlik parametrelerinin virgülle ayrılmış listesidir. Bu parametrede parametre değeri, ilişkisel bir operatör tarafından değiştirilir. filters sorgu dizesi, raporda kullanımı döndürülen uygulamanın adını içerir. Varlık kullanım raporundaki uygulama değerleri arasında accounts, docs ve gmail yer alır.

Filtreler [application name]:[parameter name][relational operator][parameter value],... biçimindedir.

Bu örnekte <> "eşit değildir" operatörü, isteğin sorgu dizesinde (%3C%3E) URL olarak kodlanmıştır: 

GET
https://www.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-01
?parameters=gplus:community_name,gplus:num_total_members
&filters=gplus:num_total_members%3C%3E0

İlişkisel operatörler şunlardır:

  • == - "eşittir".
  • <> - "eşit değildir". URL olarak kodlanmıştır (%3C%3E).
  • < - "küçüktür". URL olarak kodlanmıştır (%3C).
  • <= - "küçüktür veya eşittir". URL kodlamalıdır (%3C=).
  • > - "büyüktür". URL olarak kodlanmıştır (%3E).
  • >= - "büyüktür veya eşittir". URL kodlamalıdır (%3E=).
Filtreler yalnızca sayısal parametrelere uygulanabilir.
maxResults

integer (uint32 format)

Her yanıt sayfasında kaç etkinlik kaydının gösterileceğini belirler. Örneğin, istek <span>maxResults=1</span> değerini ayarlarsa ve raporda iki etkinlik varsa raporda iki sayfa olur. Yanıtın <span>nextPageToken</span> özelliği, ikinci sayfanın jetonuna sahiptir.
pageToken

string

Sonraki sayfayı belirtmek için kullanılan jeton. Birden fazla sayfa içeren bir raporun yanıtta nextPageToken özelliği bulunur. Raporun sonraki sayfasını alırken gönderdiğiniz takip isteğinizde pageToken sorgu dizesine nextPageToken değerini girin.
parameters

string

parameters sorgu dizesi, bir raporun sonuçlarını ayrıntılandıran etkinlik parametrelerinin virgülle ayrılmış bir listesidir. Parametre, belirli bir uygulamayla ilişkilendirilmiş. Varlık kullanım raporu için uygulama değerleri yalnızca gplus şeklindedir.
parameter sorgu dizesi, [app_name1:param_name1], [app_name2:param_name2]... CSV biçimindedir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, UsageReports öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

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

  • https://www.googleapis.com/auth/admin.reports.usage.readonly

Daha fazla bilgi için Yetkilendirme kılavuzuna göz atın.

EntityType

Sıralamalar
gplus_communities Google+ toplulukları hakkında bir rapor döndürür.