Görevlerle İlgili Temel Bilgiler

Rapor görevlerini kullanarak Google Analytics etkinlik verilerinizin özelleştirilmiş bir raporunu oluşturmak için uzun süreli eşzamansız bir 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ın özelleştirilmiş raporlarına erişmek için kullanılabilir.

Özelleştirilmiş rapor hazır olduktan sonra 72 saat boyunca kullanılabilir. Bu süreden 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şturmak için eşzamansız bir yaklaşım kullanır. Öncelikle, bir Rapor Görevi oluşturmak için reportTasks.create yöntemine istek göndermeniz 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ülkteki tüm Rapor Görevlerini listelemek için reportTasks.list kullanabilirsiniz.

Raporlama varlığı seçin

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

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

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

Data API istemci kitaplıklarından birini kullanıyorsanız istek URL yolunu manuel olarak değiştirmenize gerek yoktur. Çoğu API istemcisi, properties/GA4_PROPERTY_ID biçiminde bir dize bekleyen property parametresi sağlar. İstemci kitaplıklarını kullanmaya ilişkin örnekler 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ında, name alanında Rapor Görevi adı (properties/1234567/reportTasks/123 gibi) yer alır. Bu ad, bir Rapor Görevinin durumunu elde etmek ve elde edilen 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örevinin hazırlık durumunu alma

reportTasks.create çağrısından sonra raporun oluşturulması birkaç dakika sürebilir. Bir Rapor Görevinin hazırlık durumunu reportTasks.get yöntemini çağırarak alabilirsiniz.

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

Örnek:

HTTP İsteği

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

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

reportMetadata alanı, oluşturulan raporla ilgili satır sayısı ve ücretlendirilen kota jetonlarının miktarı gibi üst düzey bilgileri 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
  }
}

Tüm Rapor Görevleri'nin durumunu reportTasks.list yöntemini çağırarak alabilirsiniz.

Oluşturulan raporu alma

reportTasks.create yöntemi kullanılarak Rapor Görevi oluşturulduktan sonra, reportTasks.query yöntemini çağırın ve Rapor Görevi adını (properties/1234567/reportTasks/123 gibi) 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"
  }
}