Geliştirici Kılavuzu

Bu belgede, Google Analytics verilerini almak için Gerçek Zamanlı Reporting API'nin nasıl kullanılacağı açıklanmaktadır.

Giriş

Gerçek Zamanlı Reporting API, şu anda mülkünüzde gerçekleşen etkinlikleri raporlamanıza olanak tanır. Gerçek zamanlı verilere erişmek için bir görüntüleme (profil) ve en az bir metrik belirten bir sorgu oluşturursunuz. Ayrıca, sorgunuzu hassaslaştırmak için boyutlar ve filtreler gibi ek sorgu parametreleri de sağlayabilirsiniz. Bu sorgu, verileri tablo biçiminde döndüren Gerçek Zamanlı Reporting API'ye gönderilir.

API'yi kullanmaya yeni başladıysanız Gerçek Zamanlı Reporting API'ye ve sağladığı verilere giriş yapmak için Gerçek Zamanlı Reporting API'ye Genel Bakış'ı okuyun.

Ön koşul

Google Analytics verilerini almak için Gerçek Zamanlı Reporting API'yi kullanmadan önce:

  • API ile çalışan programlama diline özel istemci kitaplıklarının tam listesi için istemci kitaplıkları sayfasını okuyun.
  • Google Analytics verilerini almak amacıyla API'yi tek başına (istemci kitaplığı kullanmadan) nasıl kullanacağınızı öğrenmek için Referans Kılavuzu'nu okuyun.

Her istemci kitaplığı, tüm Real Time Reporting API verilerine erişmek için tek bir analiz hizmet nesnesi sağlar. Hizmet nesnesi oluşturmak için:

  1. Uygulamanızı Google API Konsolu'na kaydedin.
  2. Google Analytics verilerine erişim yetkisi verin.
  3. Bir Analytics hizmet nesnesi oluşturun.

Bu adımları tamamlamadıysanız lütfen durup bir Google Analytics API uygulaması oluşturmanın ilk adımlarında size yol gösterecek Merhaba Google Analytics API Eğiticisi'ni okuyun. Sonrasında, Google Analytics verilerini almak için API'yi nasıl kullanacağınızı öğrenebilirsiniz.

Gerçek Zamanlı Reporting API'yi kullanma

Gerçek Zamanlı Reporting API'yi kullanmak için bir uygulama:

  1. Gerçek Zamanlı Reporting API'yi sorgular.
  2. API yanıtını işliyor.

Gerçek Zamanlı Raporlama API'sini Sorgulama

Analiz hizmet nesnesi, Gerçek Zamanlı Reporting API sorgusu oluşturmak için bir yöntem sağlar. Sorgu parametreleri ve API'nin kullanabildiği veriler hakkında ayrıntılı bilgi için aşağıdakileri okuyun:

Bir sorguyu tanımladıktan sonra sorguyu Google Analytics sunucularına göndermek için execute yöntemini çağırın.

API Yanıtını İşleme

Gerçek Zamanlı Reporting API'ye yapılan bir sorgu başarılı olursa API, istenen verileri gerçek zamanlı bir veri kaynağının parçası olarak döndürür. API yanıt yapısı ve biçimiyle ilgili ayrıntılar için Gerçek Zamanlı Reporting API referansı bölümüne bakın.

Herhangi bir hata oluşursa API, belirli bir durum kodu ve hatayı açıklayan bir mesaj döndürür. Tüm uygulamalar hataları yakalayıp işlemelidir. Hataların ayrıntılı listesi ve yeniden deneme önerileri için Hata Yanıtları bölümüne bakın.

Kod Örnekleri

Gerçek Zamanlı Veri: get sayfasındaki Örnekler bölümü, Gerçek Zamanlı Reporting API'yi sorgulamak ve API yanıtını işlemek için çeşitli programlama dillerinde örnek kod sağlar.

Sorgu Kısıtlamaları

Real Time API sorgularıyla ilgili kısıtlamalar şunlardır:

  • rt:activeUsers metriği aşağıdaki boyut filtreleriyle birlikte bir sorguya dahil edilirse yalnızca AND operatörü ve eşitlik eşleme türü (==) desteklenir.
    • rt:goalId
    • rt:eventAction
    • rt:eventCategory
    • rt:eventLabel

    rt:activeUsers metriği yalnızca şu anda sitede etkin olan kullanıcıların sayısını aldığından, rt:activeUsers ile rt:minutesAgo kullanmayın. Diğer bir deyişle rt:activeUsers, rt:minutesAgo değerinin 0 olduğu anlamına gelir.

  • Metrik filtreleri desteklenmez.
  • fields parametresi desteklenmez.

Kota Yönetimi

Sınırlar ve Kota bölümünde açıklandığı gibi, diğer Google Analytics API'leriyle paylaşılan Real Time Reporting API için günlük kotalar vardır. Real Time Reporting API'yi kısa aralıklarla sorguluyorsanız günlük kota sınırlarına çok kısa sürede ulaşırsınız. Bu durumda diğer Google Analytics API'lerinden gelen istekler de kota yenilenene kadar çalışmayı durdurur.

Kotayı çok hızlı bir şekilde tüketebilecek bazı örnek uygulamalar şunlardır:

  • Tek bir Google Analytics görünümü (profil) için verileri günlük olarak çok kısa aralıklarla sorgulayan birden fazla gerçek zamanlı kontrol paneliniz var.
  • Çok sayıda kullanıcısı olan bir mülkünüz var ve gerçek zamanlı bir widget uyguluyorsunuz. Widget bir kullanıcıya her gösterildiğinde, bir önbellek kullanmak yerine doğrudan Google Analytics'i sorgulamış olursunuz.

Kota kullanımını en aza indirmek ve verimli bir şekilde yönetmek için:

  • Sunucu tarafı önbelleğe alma yöntemini uygulayın. Birden fazla kullanıcı aynı gerçek zamanlı veriler için istekte bulunduğunda, her kullanıcının isteği için doğrudan Real Time Reporting API'yi sorgulamak yerine önbelleğe alınmış bir yanıt döndürmeniz gerekir. Ardından günlük kota sınırlarını aşmamak için makul bir yenileme aralığında önbelleği düzenli aralıklarla en yeni gerçek zamanlı verilerle yenileyin.
  • Ek boyutlar belirterek birden fazla sorguyu birleştirin ve yanıtı sunucu veya istemci tarafında ayrıştırın.
  • Gerçek zamanlı verileri istediğiniz zaman aralığını artırın.

Örnek: Yenileme Aralığını Hesaplama

Gerçek zamanlı veriler için düzenli istekler yapmayı düşünüyorsanız beklenen kullanımınıza göre makul bir yenileme aralığı seçmeniz gerekir.

Örneğin, tek bir Google Analytics görünümünün (profilinin) günlük kota sınırı 10.000 istektir. Tek bir gün içinde Core Reporting API'de tek bir görünüm (profil) için 6.000 sorgu yapmayı bekliyorsanız bu görünüm (profil) için 4.000 istek kotanız olur.

Aynı görünümden (profilden) gerçek zamanlı veriler için tüm gün sorgulama yapan 3 gerçek zamanlı kontrol paneli uygulamak üzere Gerçek Zamanlı Reporting API'yi kullanmaya karar verdiğinizi varsayalım. Her kontrol paneli günde yaklaşık 1.333 sorgu yapabilir (4.000 sorgu / 3 kontrol paneli). Bir günde 86.400 saniye vardır. Dolayısıyla, her bir kontrol paneli için yenileme aralığı 65 saniyeden uzun (86.400 / 1.333) olmalıdır. Böylece, görünüm (profil) için günlük istek sayısının toplam sayısı 4.000 olan günlük sınırın altında olur.