Method: userUsageReport.get

Hesaptaki bir kullanıcı grubuna ait mülkler ve istatistiklerden oluşan bir rapor alır. Daha fazla bilgi için Kullanıcı Kullanım Raporu rehberine göz atın. Kullanıcı raporunun 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

Verilerin filtrelenmesi gereken profil kimliğini veya kullanıcı e-postasını temsil eder. Tüm bilgiler için all, kullanıcının benzersiz Google Workspace profil kimliği veya birincil e-posta adresi için userKey olabilir. Silinmiş bir kullanıcı olmamalıdır. Silinen 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'a (Pasifik Standart Saati) göre kullanımın gerçekleştiği tarihi gösterir. 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, 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, kullanımı raporda döndürülen uygulamanın adını içerir. Kullanıcı Kullanım Raporu için uygulama değerleri accounts, docs ve gmail değerlerini içerir.

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

Bu örnekte, <> 'not equal to' operatörü, isteğin sorgu dizesinde URL olarak kodlanmış (%3C%3E): 

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 şunları içerir:

  • == - 'eşittir'.
  • <> - "eşit değil". URL olarak kodlanmış (%3C%3E).
  • < - "küçüktür". URL olarak kodlanmış (%3C).
  • <= - "küçüktür veya eşittir". URL olarak kodlanmış (%3C=).
  • > - "büyüktür". URL olarak kodlanmış (%3E).
  • >= - "büyüktür veya eşittir". URL olarak kodlanmış (%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 raporun iki sayfası vardır. 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ş biriminde yer alan kullanıcılar için 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ı alma konusundaki takip isteğinizde, pageToken sorgu dizesine nextPageToken değerini girin.
parameters

string

parameters sorgu dizesi, raporun sonuçlarını hassaslaştıran etkinlik parametrelerinin virgülle ayrılmış listesidir. Parametre, belirli bir uygulamayla ilişkilendirilmiştir. Müşteri Kullanımı raporuna ilişkin uygulama değerleri arasında accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet ve sites bulunmaktadı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ış). Yani yanıt, yalnızca burada bahsedilen grup kimliklerinden en az birinin parçası olan kullanıcılara yönelik 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ılavuzunu inceleyin.