Görevlerle İlgili Temel Bilgiler

Rapor görevlerini kullanarak, Google Analytics etkinlik verilerinizin özelleştirilmiş bir raporunu oluşturmak için uzun süren bir eşzamansız istek başlatabilirsiniz.

Bu istekten oluşturulan Rapor Görevi kaynağı, Google Analytics mülkünüze okuma erişimi olan tüm kullanıcılar tarafından özelleştirilmiş raporlara erişmek için kullanılabilir.

Özelleştirilmiş bir rapor, hazır olduktan sonra 72 saat boyunca kullanılabilir. Bu sürenin ardından, 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şturmak için eşzamansız bir yaklaşım kullanır. Rapor görevi oluşturmak için öncelikle reportTasks.create yöntemine bir istek gönderilmesi gerekir. Ardından, oluşturulan özelleştirilmiş raporu almak için reportTasks.query yöntemi kullanılır.

Ayrıca, belirli bir rapor göreviyle ilgili yapılandırma meta verilerini almak için reportTasks.get ve bir mülkle ilgili tüm rapor görevlerini listelemek için reportTasks.list kullanabilirsiniz.

Raporlama birimi seçme

Data API v1'in tüm yöntemleri, Google Analytics mülk tanımlayıcısının bir URL istek yolunda properties/GA_PROPERTY_ID biçiminde belirtilmesini gerektirir. Örneğin:

  POST  https://analyticsdata.googleapis.com/v1alpha/properties/GA_PROPERTY_ID/reportTasks

Rapor, belirtilen Google Analytics mülkünde toplanan Google Analytics etkinlik verilerine göre oluşturulur.

Data API istemci kitaplıklarından birini kullanıyorsanız istek URL'si yolunu manuel olarak değiştirmeniz gerekmez. Çoğu API istemcisi, properties/GA_PROPERTY_ID biçiminde bir dize bekleyebilecek bir property parametresi sağlar. İstemci kitaplıklarını kullanma örnekleri için Hızlı başlangıç kılavuzuna bakın.

Rapor Görevi oluşturma isteğinde bulunma

Rapor görevi oluşturmak için bir istekteki ReportTask nesnesini kullanarak reportTasks.create yöntemini çağırın. Aşağıdaki parametreler gereklidir:

Ö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ı, name alanında Rapor Görevi adını içerir (properties/1234567/reportTasks/123 gibi). Bu ad, bir Rapor Görevi'nin durumunu almak ve ortaya çıkan raporu almak için sonraki sorgularda kullanılabilir.

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örevi hazırlık durumunu alma

reportTasks.create aramasından sonra raporun oluşturulması birkaç dakika sürebilir. reportTasks.get yöntemini çağırarak bir rapor görevinin hazırlık durumunu edinebilirsiniz.

Rapor Görevi'ni belirtmek için bir reportTasks.create yanıtından aldığınız Rapor Görevi adını (ör. properties/1234567/reportTasks/123) kullanın.

Örnek:

HTTP İsteği

GET https://analyticsdata.googleapis.com/v1alpha/properties/1234567/reportTasks/123

Rapor Görevi'nin hazırlık durumu, yanıtın state alanında döndürülür. Rapor oluşturma işlemi tamamlandıktan sonra rapor görevinin durumu CREATING yerine ACTIVE olarak değişir.

reportMetadata alanı, oluşturulan raporla ilgili üst düzey bilgileri (ör. satır sayısı ve kullanılan kota jetonu miktarı) içerir.

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
  }
}

reportTasks.list yöntemini çağırarak tüm rapor görevlerinin durumunu öğrenebilirsiniz.

Oluşturulan raporu alma

reportTasks.create yöntemi kullanılarak oluşturulan rapor görevi oluşturulduktan sonra reportTasks.query yöntemini çağırın ve rapor görevi adını (ör. properties/1234567/reportTasks/123) belirtin.

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"
  }
}