Method: entityUsageReports.get

Hesaptaki kullanıcılar tarafından kullanılan öğelerin özelliklerini ve istatistiklerini içeren bir rapor alır. Daha fazla bilgi için Öğe Kullanımı Raporu kılavuzuna bakın. Varlık raporu 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)

Raporun varlık türünü temsil eder.
entityKey

string

Verileri filtrelemek için kullanılacak nesnenin anahtarını temsil eder. Tüm kullanıcılara ait etkinlik etkinliklerini veya uygulamaya özel bir varlık için başka herhangi bir değeri almak üzere all değerini alabilen bir dizedir. Belirli bir entityType için entityKey değerinin nasıl alınacağıyla ilgili ayrıntılar için Öğe Kullanım parametreleri referans kılavuzlarına bakın.
date

string

UTC-8:00'a (Pasifik Standart Saati) göre kullanımın gerçekleştiği tarihi gösterir. Zaman damgası ISO 8601 biçimindedir, yyyy-mm-dd.

Sorgu parametreleri

Parametreler
customerId

string

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

string

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

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

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

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).
  • <: "Daha az". URL olarak kodlanmış (%3C).
  • <=: "Küçük veya eşittir". URL olarak kodlanmış olmalıdır (%3C=).
  • >: "Büyüktür". URL olarak kodlanmıştır (%3E).
  • >=: "Büyük veya eşittir". URL olarak kodlanmıştı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 vardır. Yanıtın <span>nextPageToken</span> mülkünde ikinci sayfanın jetonu bulunur.
pageToken

string

Sonraki sayfayı belirtmek için jeton. Birden fazla sayfa içeren bir raporda yanıtta nextPageToken mülkü bulunur. Raporun bir sonraki sayfasını almak için gönderdiğiniz takip isteğinde, pageToken sorgu dizesine nextPageToken değerini girin.
parameters

string

parameters sorgu dizesi, bir raporun sonuçlarını hassaslaştıran, virgülle ayrılmış bir etkinlik parametresi listesidir. Parametre, belirli bir uygulamayla ilişkilidir. 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ılavuzunu inceleyin.

EntityType

Sıralamalar
gplus_communities Google+ topluluklarıyla ilgili bir rapor döndürür.