Reports API: Varlık Kullanımı Raporu

Varlık kullanım raporu, hesabınızın kullanıcıları tarafından kullanılan varlıklarla ilgili Google Workspace hizmet etkinliklerini döndürür. Bu raporlar, belirli kullanım bilgileri için özelleştirilebilir ve filtrelenebilir. Veriler son 30 gün için kullanılabilir.

Öğeler kullanım raporu yalnızca Müşteri Sözleşmeniz uyarınca yasal amaçlarla kullanılabilir. Bu raporlar, Google Workspace ve Education için de geçerlidir.

Tüm varlıkların kullanım etkinliklerini alma

Bu API tarafından desteklenen tek öğe türü Google+ topluluklarıdır. Hesabınızdaki uygulama öğeleriyle ilgili tüm etkinliklerin raporunu almak için aşağıdaki GET HTTP isteğini kullanın ve yetkilendirme belgelerinde açıklanan yetkilendirme jetonunu ekleyin. Okunabilirliği artırmak açısından aşağıdaki örnekte satır sonları kullanılmıştır:

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çiminde (yyyy-aa-gg) olur. Bu işlem için hesabınızın saat dilimini kullanmanızı öneririz. Sorgu dizesi parametreleri ve yanıt özellikleri hakkında daha fazla bilgi için API Referansı'na bakın. Varlık kullanım raporu parametreleri hakkında bilgi edinmek için Varlık Kullanım Parametreleri referansına bakın.

applicationParameters, almak istediğiniz parametrelerin virgülle ayrılmış listesidir. Her parametre application:parameter_name biçiminde olur. Örneğin: gplus:community_name. Kullanılabilir parametreler, Entities Usage Parameters referansında belgelenmiştir. Parametre belirtilmezse tümü döndürülür.

parameterFilters, sonuçlara uygulanacak filtrelerin virgülle ayrılmış listesidir. Her filtre application:parameter_name[relational_operator]parameter_value olarak biçimlendirilir. Örneğin, gplus:num_total_members>100 filtresi, sonuçları yalnızca gplus:num_total_members parametresinin değeri 100'den büyük olan sonuçları içerecek şekilde filtreler.

maxResults, tek bir getirme işleminde döndürülecek maksimum sonuç sayısıdır. Toplam sonuç sayısı bundan büyükse yanıt kesilir ve nextPageToken eklenir (aşağıdaki JSON yanıtı örneğine bakın).

Örnekler

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

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

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

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

Aşağıdaki örnekte, 100'den fazla üyesi olan topluluklara göre filtrelenmiş her gplus_communities öğesi için community_name ve num_total_members raporu alınır. API yanıtı örneği için JSON yanıtı örneği bölümüne bakın.

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 varlık için rapor alma

Belirli bir tüzel kişiye ait raporu almak için aşağıdaki GET HTTP isteğini kullanın ve yetkilendirme belgelerinde açıklanan yetkilendirme jetonunu ekleyin. Okunabilirliği artırmak için aşağıdaki örnekte satır sonları kullanılmıştır.

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

entityKey, varlığın bulunduğu uygulamaya özgü bir varlık tanımlayıcısıdır. İlgilendiğiniz belirli öğe için entityKey değerini nasıl alacağınızla ilgili ayrıntılar için API Referansı'na bakın. Diğer parametreler, Tüm varlıkların kullanım etkinliklerini alma bölümünde daha önce açıklanmıştır.

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

Örnekler

Aşağıdaki örnekte, entityKey "1234" kimliğine sahip bir gplus_community varlığı için varlık raporu alınmaktadır.

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. Yanıt, durum koduyla birlikte bir rapor döndürür. Yanıtın okunabilirliği için yanıttaki bazı parametreler çıkarıldı.

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ılı öğeler raporu için örnek JSON yanıtı

İstek karşılanamıyorsa yanıtta bir veya daha fazla uyarı döndürülebilir. Bu örnekte, istek yapıldığında rapor kullanılamamaktadır.

{
 "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: İnsan tarafından okunabilir uyarı mesajı
• data: Ayrıntılı uyarı bilgileri veren anahtar/değer çiftlerinin listesi