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 bilgilerine göre özelleştirilebilir ve filtrelenebilir. Son 30 günün verileri kullanılabilir.
Varlık kullanım raporu, Müşteri Sözleşmeniz uyarınca yalnızca yasal amaçlarla kullanılabilir. Bu raporlar Google Workspace ve Education için de geçerlidir.
Tüm varlık kullanım etkinliklerini al
Şu anda bu API tarafından desteklenen tek varlık türü Google+ topluluklarıdır. Hesabınızdaki uygulama varlıklarıyla ilgili tüm etkinliklerin raporunu almak için aşağıdaki GET HTTP isteğini kullanın ve yetkilendirme belgelerinde açıklanan yetkilendirme jetonunu dahil edin. Okunabilirlik açısından aşağıdaki örnek satır sonları ile 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çiminde (yyyy-aa-gg). Bunun 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 için Varlık Kullanım Parametreleri referansı bölümüne bakın.
applicationParameters, almak istediğiniz parametrelerin virgülle ayrılmış listesidir.
Her parametre application:parameter_name olarak biçimlendirilir (örneğin, gplus:community_name). Kullanılabilir parametreler, Varlık Kullanım Parametreleri referansında açıklanmıştır. Hiçbir parametre belirtilmezse tümü döndürülür.
parameterFilters, sonuçlara uygulanacak filtrelerin virgülle ayrılmış bir listesidir. Her bir 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 100'den büyük değere sahip olduğu sonuçları içerecek şekilde filtreler.
maxResults, tek bir getirmede döndürülecek maksimum sonuç sayısıdır. Toplam sonuç sayısı bundan büyükse yanıt kısaltılır ve bir nextPageToken eklenir (aşağıdaki JSON yanıt örneğine bakın).
Örnekler
Aşağıdaki örnekte, tüm gplus_communities varlıklarının tüm parametrelerini içeren bir rapor alınmıştı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ınmıştı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 her gplus_communities varlığı için 100'den fazla üyesi olan topluluklara göre filtrelenmiş community_name ve num_total_members raporu alınmıştır. API yanıtı örneği için JSON yanıtı örneğini inceleyin.
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 varlıkla ilgili rapor almak için aşağıdaki GET HTTP isteğini kullanın ve yetkilendirme belgelerinde açıklanan yetkilendirme jetonunu ekleyin. Okunabilirlik açısından aşağıdaki örnek satır sonları ile biçimlendirilmiştir.
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 özel bir varlık tanımlayıcısıdır. İlgilendiğiniz varlık için entityKey'yi nasıl edineceğinizle ilgili ayrıntılar için API Referansı'na bakın. Diğer parametreler yukarıda Tüm varlık kullanım etkinliklerini alma bölümünde açıklanmıştır.
Sorgu dizesi parametreleri ve yanıt özellikleri hakkında daha fazla bilgi edinmek için API Referansı'na bakın. Varlık kullanım raporu parametreleri hakkında bilgi için Varlık Kullanım Parametreleri referansına bakın.
Örnekler
Aşağıdaki örnekte entityKey "1234" değerine sahip bir gplus_community varlığı için varlık raporu alınmıştı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, bir HTTP 200 durum kodu döndürür. Yanıt, durum koduyla birlikte bir rapor döndürür. Yanıttaki bazı parametreler okunabilirlik 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 varlıklar raporu için örnek JSON yanıtı
İstek yerine getirilemezse yanıtta bir veya daha fazla uyarı döndürülebilir. Bu örnekte, istek yapıldığı sırada 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ı kodumessage: Kullanıcılar tarafından okunabilir uyarı mesajıdata: Ayrıntılı uyarı bilgileri veren anahtar/değer çiftlerinin listesi