Bu dokümanda, tüm yerleşik Yerleştirme API'si bileşenleri için seçenekler, yöntemler, özellikler ve etkinlikler açıklanmaktadır.
auth
gapi.analytics.auth
Yetkilendirme bileşeni, bir kullanıcıyı yetkilendirmek için kullanılabilecek tekli kısımdır.
Yöntemler |
|
---|---|
authorize(options:Object) |
İadeler: Kullanıcının belirli bir kapsayıcıda Google hesabıyla oturum açmasını sağlayan bir Google Analytics oturum açma düğmesi oluşturur. |
isAuthorized() |
İadeler: Kullanıcı başarıyla yetkilendirdiyse |
signOut() |
İadeler: Mevcut kullanıcının oturumunu kapatır. Ayrıca, |
getAuthResponse() |
İadeler: Orijinal yetkilendirme isteği tarafından döndürülen kimlik doğrulama verilerini alır. Döndürülen nesne, genellikle kimlik doğrulaması yapılmış istekleri manuel olarak yapmak için kullanılabilecek erişim jetonunu içerir. |
getUserProfile() |
İadeler: Oturumu açık olan kullanıcıyla ilgili temel profil bilgilerini alır. Buna kullanıcının adı, e-posta adresi ve herkese açık profil resmi (ayarlandıysa) dahildir. |
Seçenekler |
|
---|---|
clientId |
Tür: Geliştirici konsolundaki projenizin istemci kimliği. |
container |
Tür: DOM'da, oturum açma düğmesini içerecek HTML öğesinin kimliği. Öğenin kendisine bir referans da iletebilirsiniz. |
userInfoLabel |
Tür: Giriş yapmış kullanıcının e-posta adresinden önce gösterilecek metin. Varsayılan olarak |
scopes |
Tür: Uygulamanızın istediği Google API kimlik doğrulama kapsamlarının listesi. Kullanılabilir tüm kapsamları görmek için OAuth 2.0 Playground'u ziyaret edin. Google Analytics API kimlik doğrulaması kapsamları için Yapılandırma ve Raporlama kaynakları için geliştirici kılavuzlarına göz atın. |
overwriteDefaultScopes |
Tür:
Varsayılan kapsam değeri: Not: Yerleştirme API'si üzerinden kimlik doğrulama, kullanıcının temel profiline erişim gerektirir. Bu kapsamların üzerine yazılamaz. |
serverAuth.access_token |
Tür: Geçerli bir erişim jetonunuz varsa bunu doğrudan yetkilendirme yöntemine iletebilirsiniz ve kullanıcıdan yetkilendirmesi istenmez. Erişim jetonu almayla ilgili ayrıntılar için OAuth 2.0 dokümanlarına göz atın. |
Etkinlikler |
|
---|---|
signIn |
Bağımsız değişkenler: Yok Kullanıcı başarıyla oturum açtığında tetiklenir. |
signOut |
Bağımsız değişkenler: Yok Kullanıcı oturumu başarıyla kapattığında tetiklenir. |
needsAuthorization |
Bağımsız değişkenler: Yok
|
error |
Bağımsız değişkenler: Kimlik doğrulama sürecinde hata oluştuğunda tetiklenir. Hata mesajını yanıt nesnesinden almak isterseniz, |
Kullanımdan kaldırılan etkinlikler | |
---|---|
success |
Bağımsız değişkenler: Bu etkinlik geriye dönük uyumluluk için mevcuttur ve sonraki bir sürümde kaldırılabilir. Bunun yerine |
Örnek
// Standard client-side authorization. gapi.analytics.auth.authorize({ clientId: 'XXXXXX', container: 'auth-button' }); gapi.analytics.auth.on('signIn', function() { console.log(gapi.analytics.auth.getUserProfile()); });
// Authorization using an access token obtained server-side. // You do not need to register an event handler because // authorization happens immediately. gapi.analytics.auth.authorize({ serverAuth: { access_token: 'XXXXXX' } });
Veriler
gapi.analytics.report.Data
Marka | |
---|---|
Data(options:Object)
|
Veri bileşeni, Google Analytics Temel Raporlama API'sini sorgulamanıza ve sonuçları geri almanıza olanak tanır. |
Seçenekler |
|
---|---|
query
|
Tür: Core Reporting API'deki sorgu parametrelerini içeren bir nesne. API tarafından sağlanan normal varsayılan değerlerin yanı sıra aşağıdaki varsayılan değerler de kullanılır: { 'start-date': '7daysAgo', 'end-date': 'yesterday } |
Etkinlikler |
|
---|---|
success |
Bağımsız değişkenler: Sorgu başarıyla tamamlandığında tetiklenir. |
error |
Bağımsız değişkenler: Sorgu işlemi sırasında bir hata oluştuğunda tetiklenir. Hata mesajını yanıt nesnesinden almak isterseniz, |
Örnek
var report = new gapi.analytics.report.Data({ query: { ids: 'ga:XXXX', metrics: 'ga:sessions', dimensions: 'ga:city' } }); report.on('success', function(response) { console.log(response); }); report.execute();
Veri Grafiği
gapi.analytics.googleCharts.DataChart
Marka | |
---|---|
DataChart(options:Object)
|
DataChart , standart bir Google grafiğini ve bir Veri bileşenini sarmalar. Böylece, kendiniz bağlamak zorunda kalmadan bir sorgudan kolayca görselleştirme oluşturabilirsiniz. |
Seçenekler |
|
---|---|
query |
Tür: |
chart |
Tür: Farklı grafik seçeneği ayrıntıları için aşağıya bakın. |
chart.container |
Tür: DOM'da, DataChart'ı barındıran HTML öğesinin kimliği. Öğenin kendisine bir referans da iletebilirsiniz. |
chart.type |
Tür: Grafik türü. Olası seçenekler şunlardır: |
chart.options |
Tür: İlgili Google Chart nesnesine geçirilebilecek tüm seçenekler. |
Etkinlikler |
|
---|---|
success |
Bağımsız değişkenler: Sorgu başarıyla tamamlandığında ve grafik tamamen oluşturulduğunda tetiklenir.
|
error |
Bağımsız değişkenler: Sorgu veya oluşturma işlemi sırasında bir hata oluştuğunda tetiklenir. Hata mesajını yanıt nesnesinden almak isterseniz, |
Örnek
var chart = new gapi.analytics.googleCharts.DataChart({ query: { ids: 'ga:XXXX', metrics: 'ga:sessions', dimensions: 'ga:date' }, chart: { type: 'LINE', container: 'line-chart', options: { title: 'Sessions over the past week.', fontSize: 12 } } }); chart.on('success', function(response) { // response.chart : the Google Chart instance. // response.data : the Google Chart data object. }); chart.execute();
Görünüm Seçici
gapi.analytics.ViewSelector
Marka | |
---|---|
ViewSelector(options:Object)
|
ViewSelector bileşeni, açılır menüler aracılığıyla hesabınızı, mülkünüzü ve görünümünüzü seçmenize olanak tanır. |
Seçenekler |
|
---|---|
container |
Tür: DOM'da, ViewSelector'ı barındıracak HTML öğesinin kimliği. Öğenin kendisine bir referans da iletebilirsiniz. |
Örnek özellikleri |
|
---|---|
ids |
Tür: ga:XXXX biçimindeki benzersiz tablo kimliği. XXXX, Analytics görünüm (profil) kimliğidir. |
Etkinlikler |
|
---|---|
change |
Bağımsız değişkenler: Kullanıcı açılır menülerden yeni bir görünüm seçtiğinde tetiklenir. Görünüm Seçici örneği ilk oluşturulduğunda ve varsayılan görünüm görüntülendiğinde de tetiklenir. |
Örnek
var viewSelector = new gapi.analytics.ViewSelector({ container: 'view-selector' }); viewSelector.on('change', function(ids) { console.log(ids); }); viewSelector.execute();
Paylaşılan Bileşen Yöntemleri
Yöntemler | |
---|---|
set(options) |
İadeler: Bileşenin yapılandırma seçeneklerini ayarlar veya günceller (bu, oluşturucuda oluşturma sırasında da yapılabilir). |
get() |
İadeler: Bir bileşenin mevcut yapılandırma seçeneklerini döndürür. |
execute() |
İadeler: Bileşenin birincil işlemini çağırır. Bu genellikle sayfada bir şeyler oluşturur veya bir raporu çalıştırır (ya da her ikisini birden yapar). |
on(event, handler) |
İadeler: Bileşen belirtilen etkinliği yayınladığında çağrılacak bir işlevi kaydeder. |
once(event, handler) |
İadeler: Belirtilen etkinliğin yalnızca bir sonraki oluşumunda çağrılacak bir işlevi kaydeder. İşleyen, otomatik olarak kaydını iptal ettikten sonra çalıştırıldıktan sonra. |
off(opt_event, opt_handler) |
İadeler: Bir bileşenden etkinlik işleyiciyi kaldırır. Hiçbir işleyici aktarılmazsa, iletilen etkinlik için tüm işleyiciler kaldırılır. Hiçbir etkinlik iletilmezse tüm etkinlikler için tüm işleyiciler kaldırılır. |
emit(event, ...opt_args) |
İadeler: Bir etkinlik aktarır. İsteğe bağlı olarak, kayıtlı işleyicilere aktarılacak bağımsız değişkenleri belirtebilirsiniz. |
set
Bileşenin yapılandırma seçeneklerini ayarlar veya günceller (bu, oluşturucuda oluşturma sırasında da yapılabilir).
Kullanım
component.set(options);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
options |
Object |
Bu bileşenin yapılandırma seçenekleri. Geçilen seçenekler mevcut seçeneklerle birleştirilecek. |
İadeler
this
: Bileşen örneği.
get
Bir bileşenin mevcut yapılandırma seçeneklerini döndürür.
İadeler
Object
– Bileşenin mevcut yapılandırma seçenekleri.
execute()
Bileşenin birincil işlemini çağırır. Bu genellikle sayfada bir şeyler oluşturur veya bir raporu çalıştırır (ya da her ikisini birden yapar).
İadeler
this
: Bileşen örneği.
on(event, handler)
Bileşen belirtilen etkinliği yayınladığında çağrılacak bir işlevi kaydeder.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
event |
string |
Etkinliğin adı. |
handler |
Function |
Etkinlik gerçekleştiğinde çağrılacak işlev. (Parametre ayrıntıları için bağımsız etkinlik başvurularına bakın.) |
İadeler
this
: Bileşen örneği.
once(event, handler)
Belirtilen etkinliğin yalnızca bir sonraki oluşumunda çağrılacak bir işlevi kaydeder. İşleyen, otomatik olarak kaydını iptal ettikten sonra çalıştırıldıktan sonra.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
event |
string |
Etkinliğin adı. |
handler |
Function |
Etkinlik gerçekleştiğinde çağrılacak işlev. (Parametre ayrıntıları için bağımsız etkinlik başvurularına bakın.) |
İadeler
this
: Bileşen örneği.
off(opt_event, opt_handler)
Bir bileşenden etkinlik işleyiciyi kaldırır. Hiçbir işleyici aktarılmazsa, iletilen etkinlik için tüm işleyiciler kaldırılır. Hiçbir etkinlik iletilmezse tüm etkinlikler için tüm işleyiciler kaldırılır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
opt_event |
string |
Etkinliğin adı. Herhangi bir etkinlik belirtilmemişse tüm etkinlikler için tüm işleyiciler kaldırılır. İsteğe bağlıdır. |
opt_handler |
Function |
Kaldırılacak işlev işleyiciye yapılan referans. Herhangi bir işlev aktarılmazsa tüm işleyiciler kaldırılır. İsteğe bağlıdır. |
İadeler
undefined
emit(event, ...opt_args)
Bir etkinlik aktarır. İsteğe bağlı olarak, kayıtlı işleyicilere aktarılacak bağımsız değişkenleri belirtebilirsiniz.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
event |
string |
Etkinliğin adı. |
...opt_args |
* |
Kayıtlı etkinlik işleyicilerine aktarılacak isteğe bağlı bağımsız değişkenler. |
İadeler
undefined