Method: userUsageReport.get

Hesaba sahip bir kullanıcı grubuna ait mülkler ve istatistiklerden oluşan bir rapor getirir. Daha fazla bilgi için Kullanıcı Kullanım Raporu kılavuzuna bakın. Kullanıcı raporu parametreleri hakkında daha fazla bilgi için Kullanıcı Kullanım parametreleri referans kılavuzlarına bakın.

HTTP isteği

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

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

Yol parametreleri

Parametreler
userKey or all

string

Verilerinin filtrelenmesi gereken profil kimliğini veya kullanıcı e-postasını temsil eder. Tüm bilgiler için all veya kullanıcının benzersiz Google Workspace profil kimliği ya da birincil e-posta adresi için userKey olabilir. Silinmiş bir kullanıcı olmamalıdır. Silinmiş bir kullanıcı için Directory API'de showDeleted=true ile users.list çağrısı yapın, ardından döndürülen ID öğesini userKey olarak kullanın.
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. Kullanıcı Kullanım Raporu'ndaki 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/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z

İ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=).
maxResults

integer (uint32 format)

Her yanıt sayfasında kaç etkinlik kaydının gösterileceğini belirler. Örneğin, istek maxResults=1 değerini ayarlarsa ve raporda iki etkinlik varsa raporda iki sayfa olur. Yanıtın nextPageToken özelliği, ikinci sayfanın jetonuna sahiptir.
maxResults sorgu dizesi isteğe bağlıdır.
orgUnitID

string

Rapor oluşturulacak kuruluş biriminin kimliği. Kullanıcı etkinliği yalnızca belirtilen kuruluş birimine ait olan kullanıcılara gösterilir.

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ş. Müşteri Kullanımı raporundaki uygulama değerleri arasında accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet ve sites yer alır.
parameters sorgu dizesi, app_name1:param_name1, app_name2:param_name2 CSV biçimindedir.

groupIdFilter

string

Kullanıcı etkinliklerinin filtrelendiği virgülle ayrılmış grup kimlikleri (karartılmış). Diğer bir deyişle yanıt, yalnızca burada belirtilen grup kimliklerinden en az birinin parçası olan kullanıcılara ilişkin etkinlikleri içerir. Biçim: "id:abc123,id:xyz456"

İ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.