Geliştirici Kılavuzu

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

Giriş

Gerçek Zamanlı Raporlama API'si, şu anda mülkünüzde gerçekleşmekte olan etkinlikleri raporlamanızı sağlar. Gerçek zamanlı verilere erişmek için, bir görünümü (profili) ve en az bir metriği belirten bir sorgu oluşturursunuz. 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ı Raporlama API'sına gönderilir.

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

Ön koşul

Google Analytics verilerini almak için Gerçek Zamanlı Raporlama API'sını kullanmadan önce:

  • API ile çalışan programlama diline özgü 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 hizmeti 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ı biliyorsunuz.

Gerçek Zamanlı Raporlama API'sını Kullanma

Gerçek Zamanlı Raporlama API'sını kullanmak için bir uygulama:

  1. Gerçek Zamanlı Raporlama API'sini sorgular.
  2. API Yanıtını işler.

Gerçek Zamanlı Raporlama API'sini Sorgulama

Analiz hizmet nesnesi, Real Time Reporting API sorgusu oluşturmak için bir yöntem sağlar. Sorgu parametreleri ve API'nin kullanabileceği veriler hakkında ayrıntılar 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ı Raporlama API'sına 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ı Raporlama API referansı sayfasına 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ı yakalamalı ve 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ü, Real Time Reporting API'yi sorgulamak ve API yanıtını ele almak 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 filtrelerine sahip 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 işlevini kullanmayın. Yani rt:activeUsers değeri, rt:minutesAgo değerinin 0 olduğu anlamına gelir.

  • Metrik filtreleri desteklenmemektedir.
  • fields parametresi desteklenmemektedir.

Kota Yönetimi

Sınırlar ve Kota bölümünde açıklandığı gibi, diğer Google Analytics API'leriyle paylaşılan günlük Real Time Reporting API 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, kota yenilenene kadar diğer Google Analytics API'lerinden gelen istekler de çalışmayı durdurur.

Kotayı çok hızlı tüketebilecek bazı örnek uygulamalar:

  • Tek bir Google Analytics görünümü (profili) 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 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 Real Time Reporting API'yi doğrudan 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 önbelleği makul bir yenileme aralığında düzenli olarak en son 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ığı Hesaplama

Gerçek zamanlı veriler için düzenli istek göndermeyi 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ünde, 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 isteklik 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ı Raporlama API'sını kullanmaya karar verdiğinizi varsayalım. Her kontrol paneli günde yaklaşık 1.333 sorgu oluşturabilir (4.000 sorgu / 3 kontrol paneli). Bir günün 86.400 saniyesi vardır. Görünüme (profile) ilişkin günlük istek sayısının toplam 4.000 günlük sınırın altında olması için, her bir gösterge tablosunun yenileme aralığı 65 saniyeden (86.400 / 1.333) uzun olmalıdır.