Rapor görevlerini kullanarak uzun süreli eşzamansız bir istek oluşturarak Google Analytics etkinlik verilerinizin özelleştirilmiş bir raporu.
Bu istekten oluşturulan Rapor Görevi kaynağı, erişim için kullanılabilir. Google Analytics verilerinize okuma erişimi olan tüm kullanıcılar tarafından özelleştirilmiş raporlar
Özelleştirilmiş rapor, hazır olduktan sonra 72 saat boyunca kullanılabilir. Bundan sonra ilgili rapor görevi kaynağı ve içeriği otomatik olarak silinir.
Rapor Görevi Oluşturma
Google Analytics Data API v1,
Rapor görevleri oluşturabilirsiniz. İlk olarak,
reportTasks.create
yöntemi gereklidir. Ardından,
reportTasks.query
yöntemi, oluşturulan özelleştirilmiş raporu almak için kullanılır.
Ayrıca,
reportTasks.get
belirli bir Rapor Görevi ile ilgili yapılandırma meta verilerini almak
reportTasks.list
bir mülkle ilgili tüm Rapor Görevleri'ni listelemek için kullanılır.
Rapor eden varlık seçin
Data API v1'in tüm yöntemleri için
Google Analytics mülk tanımlayıcısı
properties/GA_PROPERTY_ID
, örneğin:
POST https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks
Rapor, Google Analytics etkinliğini temel alarak oluşturulur belirtilen Google Analytics mülkünde toplanan veriler.
Data API istemci kitaplıklarından birini kullanıyorsanız
İstek URL'si yolunu manuel olarak değiştirmeye gerek yoktur.
Çoğu API istemcisi bir property
parametresi sağlar
dizesi properties/GA_PROPERTY_ID
biçimindedir.
Örnekler için Hızlı başlangıç kılavuzuna bakın
birkaç temel adımı vardır.
Rapor görevi oluşturma isteğinde bulunma
Rapor Görevi oluşturmak için
reportTasks.create
yöntemini kullanarak
ReportTask
nesnesini ifade eder. Aşağıdaki parametreler gereklidir:
reportDefinition
Bu alan, özelleştirilmiş raporun tanımını açıklar. Bu parametre yapısı, Temel Raporlama yöntemleri tarafından kullanılan rapor tanımına benzer.
Örnek rapor görevi oluşturma isteği:
HTTP İsteği
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks
{
"reportDefinition": {
"dateRanges": [{ "startDate": "2024-05-01"", "endDate": "2024-05-15" }],
"dimensions": [{ "name": "country" }],
"metrics": [{ "name": "activeUsers" }]
}
}
reportTasks.create
yönteminin yanıtı Rapor'u içerir
name
alanındaki görev adı (ör.
properties/1234567/reportTasks/123
) ile uyumludur ve
durumunu öğrenmek ve verileri yeniden toplamak için
en iyi uygulamaları
paylaşacağız.
HTTP Yanıtı
{
"response": {
"@type": "type.googleapis.com/google.analytics.data.v1alpha.ReportTask",
"name": "properties/1234567/reportTasks/123",
"reportDefinition": {
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"dateRanges": [
{
"startDate": "2024-05-01",
"endDate": "2024-05-15"
}
]
},
"reportMetadata": {
"state": "CREATING",
"beginCreatingTime": "2024-05-16T00:00:01.133612336Z"
}
}
}
Rapor görevine hazırlık durumunu alma
Rapor oluşturulduktan sonra raporun oluşturulması birkaç dakika
reportTasks.create
çağrısına bir tıklama URL'si eklemeniz gerekir. Bir Rapor Görevinin hazırlık durumunu öğrenmek için
reportTasks.get
yöntemidir.
Rapor görevi adını kullanın (ör. properties/1234567/reportTasks/123
)
bir reportTasks.create
yanıtından aldığınız
Görevi Bildir'i tıklayın.
Örnek:
HTTP İsteği
GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123
Bir Rapor Görevinin hazırlık durumu
state
girin. Rapor oluşturma işlemi tamamlandıktan sonra
Rapor Görevinin CREATING
olan durumu ACTIVE
olarak değişir.
reportMetadata
alanı, oluşturulan raporla ilgili üst düzey bilgileri içerir. Örneğin,
satır sayısı ve ücret alınan kota jetonlarının miktarı.
HTTP Yanıtı
{
"reportDefinition": {
"dimensions": [
{
"name": "country"
}
],
"metrics": [
{
"name": "activeUsers"
}
],
"dateRanges": [
{
"startDate": "2024-05-01",
"endDate": "2024-05-15"
}
]
},
"reportMetadata": {
"state": "ACTIVE",
"beginCreatingTime": "2024-05-16T00:00:01.133612336Z",
"creationQuotaTokensCharged": 6,
"taskRowCount": 167,
"errorMessage": "",
"totalRowCount": 167
}
}
Tüm Rapor Görevleri'nin durumunu görmek için
reportTasks.list
yöntemidir.
Oluşturulan raporu alma
Rapor Görevi
reportTasks.create
yöntemini çağırın,
reportTasks.query
yöntemini kullanın ve Rapor Görevi adını
(ör. properties/1234567/reportTasks/123
).
HTTP İsteği
POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123:query
Rapor Görevi hazırsa oluşturulan raporu içeren bir yanıt döndürülür:
HTTP Yanıtı
{
"dimensionHeaders": [
{
"name": "country"
}
],
"metricHeaders": [
{
"name": "activeUsers",
"type": "TYPE_INTEGER"
}
],
"rows": [
...
],
"rowCount": 167,
"metadata": {
"currencyCode": "USD",
"timeZone": "America/Los_Angeles"
}
}