Reports API: Varlık Kullanımı Raporu

Varlık kullanım raporu, öğelerle ilgili Google Workspace hizmet etkinliklerini döndürür. dahil edilir. Bu raporlar belirli bir kullanıma göre özelleştirilebilir ve filtrelenebilir ekleyebilirsiniz. Son 30 günün verileri kullanılabilir.

Varlıklar kullanım raporu şu ülkelerde yalnızca yasal amaçlarla kullanılabilir: . Bu raporlar ayrıca, Google Workspace ve Education.

Tüm varlık kullanım etkinliklerini alın

Şu anda bu API tarafından desteklenen tek varlık türü Google+ topluluklarıdır. Bir hesabınızdaki uygulama varlıklarıyla ilgili tüm etkinliklerin raporunu görmek için GET HTTP isteği gönderin ve yetkilendirme belgelerini inceleyin. Örneğin, aşağıdaki örnek, satır sonları olacak şekilde biçimlendirilmiştir:

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

date değeri, kullanımın gerçekleştiği tarihtir ve zaman damgası ISO 8601 biçimi, yyyy-aa-gg. Önerilerimiz: bunun için hesabınızın saat dilimini kullanın. Sorgu dizesi parametreleri ve daha fazla bilgi için API Referans. Varlık kullanım raporu parametreleri hakkında bilgi için Varlık Kullanım Parametreleri referans.

applicationParameters, almak istediğiniz parametrelerin virgülle ayrılmış bir listesidir. Her parametre application:parameter_name olarak biçimlendirilir. Örneğin, gplus:community_name. Kullanılabilir parametreler, Varlık Kullanım Parametreleri referans. Hiçbir parametre belirtilmezse tümü döndürülür.

parameterFilters, sonuçlara uygulanacak filtrelerin virgülle ayrılmış bir listesidir. Her biri filtre biçimi şu şekildedir: application:parameter_name[relational_operator]parameter_value Örneğin, gplus:num_total_members>100 filtresi, sonuçları yalnızca sonuçları içerecek şekilde filtreler (gplus:num_total_members parametresi 100'den büyük bir değere sahiptir)

maxResults, tek bir getirmede döndürülecek maksimum sonuç sayısıdır. Toplam sonuç sayısı bundan büyük olursa yanıt kısaltılır ve nextPageToken dahil edilecektir (bkz. Aşağıdaki JSON yanıtı örneği).

Örnekler

Aşağıdaki örnek, tüm parametreleri içeren bir rapor alır gplus_communities varlık için

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11

Aşağıdaki örnekte, community_name parametresini içeren bir rapor alınır gplus_communities varlığın tümü için.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all
/dates/2017-12-11?parameters=gplus:community_name

Aşağıdaki örnekte community_name ve Her gplus_communities varlığı için num_total_members (filtreleme ölçütü) topluluk ve e-posta desteği alabilirsiniz. API yanıtı örneği için bkz. JSON yanıtı örneği.

GET https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/all/dates/2017-12-11
?parameters=gplus:community_name,gplus:num_total_members&filters=gplus:num_total_members>100

Belirli bir öğeyle ilgili rapor alma

Belirli bir öğeyle ilgili rapor almak için aşağıdaki GET HTTP isteğini kullanın ve yetkilendirme belgelerini inceleyin. Örneğin, aşağıdaki örnek, satır sonları şeklinde biçimlendirilmiştir.

GET https://admin.googleapis.com/admin/reports/v1/gplus_communities/entityKey/dates/date
?parameters=applicationParameters
&filters=parameterFilters
&maxResults=maxResults

entityKey, çok önemlidir. Bkz. API Referans:entityKey ilgi alanları arasındadır. Diğer parametreler yukarıda, Tüm varlık kullanım etkinliklerini alın.

Sorgu dizesi parametreleri ve yanıt özellikleri hakkında daha fazla bilgi için API Referansı'na bakın. Daha fazla bilgi için hakkında daha fazla bilgi edinmek için Varlık Kullanım Parametreleri referans.

Örnekler

Aşağıdaki örnekte,gplus_community entityKey "1234".

https://admin.googleapis.com/admin/reports/v1/usage/gplus_communities/1234/dates/2017-12-11

Kullanım raporu örneği JSON yanıtı

Başarılı bir yanıt, HTTP 200 durum kodu döndürür. Şununla birlikte: yanıt bir rapor döndürür. Yanıttaki parametrelerden bazıları okunaklılık için atlandı.

Varlıklar raporu için örnek JSON yanıtı

{
 "kind": "reports#usageReports",
 "nextPageToken": "NjQ1OTgwODk0MzkxNDAwNjQ0OA",
 "usageReports": [
 {
   "kind": "admin#reports#usageReport",
   "date": "2017-12-11",
   "entity": {
    "type": "OBJECT",
    "customerId": "C03az79cb",
    "objectType": "GPLUS_COMMUNITY",
    "objectId": "1234",
   },
   "parameters": [
    {
      "name": "gplus:community_name",
      "stringValue": "My Community"
    },
    {
     "name": "gplus:num_total_members",
     "intValue": 37
    },
    {
     "name": "gplus:num_7day_active_members",
     "intValue": 12
    },
    {
     "name": "gplus:num_30day_active_members",
     "intValue": 17
    },
   ]
  }
 ]
}

Uyarı içeren öğeler raporu için örnek JSON yanıtı

İstek yerine getirilemezse yanıtta bir veya daha fazla uyarı döndürülebilir. Burada Örneğin, istek yapıldığı anda rapor mevcut değildir. 
{
 "kind": "reports#usageReports",
 "warnings": [
    {
      "code": "PARTIAL_DATA_AVAILABLE"
      "message": "Data for date 2017-12-11 for application gplus is not available right now, please try again after a few hours."
      "data": [
        {
          "key": "date"
          "value": "2017-12-11"
        }
      ]
    }
  ],
 "usageReports": [],
}
 warnings dizisindeki her giriş aşağıdaki parametrelere sahiptir:
  • code: makine tarafından okunabilir uyarı kodu
  • message: Okunabilir uyarı mesajı
  • data: Ayrıntılı uyarı bilgileri veren anahtar/değer çiftlerinin listesi