Bu belgede, tüm yerleşik Embed API bileşenleri için seçenekler, yöntemler, özellikler ve etkinlikler açıklanmaktadır.
auth
gapi.analytics.auth
Kimlik doğrulama bileşeni, bir kullanıcıyı yetkilendirmek için kullanılabilecek bir tekiltondur.
Yöntemler |
|
---|---|
authorize(options:Object) |
İade edilen: Belirtilen kapsayıcı içinde, kullanıcının Google hesabıyla oturum açmasına olanak tanıyan bir Google Analytics oturum açma düğmesi oluşturur. |
isAuthorized() |
İade edilen: Kullanıcı başarıyla yetkilendirildiyse |
signOut() |
İade edilen: Geçerli kullanıcının oturumu kapatılır. Ayrıca |
getAuthResponse() |
İade edilen: Orijinal yetkilendirme isteği tarafından döndürülen kimlik doğrulama verilerini alır. Döndürülen nesne, genellikle kimliği doğrulanmış istekleri manuel olarak yapmak için olabilen erişim jetonunu içerir. |
getUserProfile() |
İade edilen: Şu anda oturum açmış kullanıcıyla ilgili temel profil bilgilerini alır. Kullanıcının adı, e-posta adresi ve herkese açık profil resmi (ayarlanmışsa) bu bilgilere dahildir. |
Seçenekler |
|
---|---|
clientId |
Tür: Projenizin geliştirici konsolundaki istemci kimliği. |
container |
Tür: DOM'da, oturum açma düğmesini barındıracak bir HTML öğesinin kimliği. Öğenin kendisine bir referans da aktarabilirsiniz. |
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ğrulama kapsamları için Yapılandırma ve Raporlama kaynaklarına yönelik geliştirici kılavuzlarına bakın. |
overwriteDefaultScopes |
Tür:
Varsayılan kapsamlar değeri şöyledir: Not: Embed API aracılığıyla kimlik doğrulama için kullanıcının temel profiline erişim gerekir. Bu kapsamların üzerine yazılamaz. |
serverAuth.access_token |
Tür: Geçerli bir erişim jetonunuz varsa doğrudan yetkilendirme yöntemine iletebilirsiniz. Bu durumda kullanıcıdan yetkilendirmesi istenmez. Erişim jetonunun nasıl alınacağıyla ilgili ayrıntılar için OAuth 2.0 dokümanlarına bakı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 işlemi sırasında hata oluştuğunda tetiklenir. Hata mesajını yanıt nesnesinden almak istiyorsanız yanıt nesnesi |
Kullanımdan kaldırılan etkinlikler | |
---|---|
success |
Bağımsız değişkenler: Bu etkinlik, geriye dönük uyumluluk için mevcuttur ve gelecekteki 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'sını sorgulamanızı ve sonuçları geri almanızı sağlar. |
Seçenekler |
|
---|---|
query
|
Tür: Core Reporting API'den sorgu parametreleri içeren bir nesne. API tarafından sağlanan normal varsayılan değerlere ek olarak aşağıdaki varsayılan değerler 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 istiyorsanız yanıt nesnesi |
Ö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();
DataChart
gapi.analytics.googleCharts.DataChart
Marka | |
---|---|
DataChart(options:Object)
|
DataChart , standart bir Google grafiğini ve bir Data bileşenini sarmalar. Böylece, sorguyu birbirine bağlamaya gerek kalmadan sorgudan kolayca görselleştirme oluşturabilirsiniz. |
Seçenekler |
|
---|---|
query |
Tür: |
chart |
Tür: Bağımsız grafik seçeneği ayrıntıları için aşağıya bakın. |
chart.container |
Tür: DataChart'ı barındıracak, DOM'daki bir HTML öğesinin kimliği. Öğenin kendisine bir referans da aktarabilirsiniz. |
chart.type |
Tür: Grafik türü. Olası seçenekler şunlardır: |
chart.options |
Tür: İlgili Google Grafiği 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şturulduktan sonra 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 istiyorsanız yanıt nesnesi |
Ö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();
ViewSelector
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: ViewSelector'ı barındıracak, DOM'daki bir HTML öğesinin kimliği. Öğenin kendisine bir referans da aktarabilirsiniz. |
Örnek özellikleri |
|
---|---|
ids |
Tür: ga:XXXX formunun benzersiz tablo kimliği. Burada 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. Ayrıca, ViewSelector örneği ilk oluşturulduğunda ve varsayılan görünüm gösterildiğ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) |
iade sayısı: Bileşenin yapılandırma seçeneklerini ayarlar veya günceller (bu işlem, oluşturucuda oluşturma sırasında da yapılabilir). |
get() |
iade sayısı: Bir bileşenin mevcut yapılandırma seçeneklerini döndürür. |
execute() |
iade sayısı: Bileşenin birincil işlemini çağırır. Bu genellikle sayfada bir öğenin oluşturulması veya bir rapor (ya da her ikisi) çalıştırılmasıdır. |
on(event, handler) |
iade sayısı: Bileşen belirtilen etkinliği yayınladığında çağrılacak bir işlevi kaydeder. |
once(event, handler) |
iade sayısı: Yalnızca belirtilen etkinliğin bir sonraki oluşumunda çağrılacak bir işlevi kaydeder. İşleyici, çalıştırıldıktan sonra kaydını otomatik olarak iptal eder. |
off(opt_event, opt_handler) |
iade sayısı: Bir bileşenden etkinlik işleyiciyi kaldırır. İşleyici iletilmezse geçirilen etkinliğin tüm işleyicileri kaldırılır. Herhangi bir etkinlik iletilmezse tüm etkinliklerin tüm işleyicileri kaldırılır. |
emit(event, ...opt_args) |
iade sayısı: Bir etkinlik yayınladığında. İsteğe bağlı olarak, kayıtlı işleyicilere iletilecek bağımsız değişkenleri belirtebilirsiniz. |
set
Bileşenin yapılandırma seçeneklerini ayarlar veya günceller (bu işlem, 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şen için yapılandırma seçenekleri. Başarılı seçenekler mevcut seçeneklerle birleştirilir. |
İlerlemeler
this
: Bileşen örneği.
get
Bir bileşenin mevcut yapılandırma seçeneklerini döndürür.
İlerlemeler
Object
: Bileşenin mevcut yapılandırma seçenekleri.
execute()
Bileşenin birincil işlemini çağırır. Bu genellikle sayfada bir öğenin oluşturulması veya bir rapor (ya da her ikisi) çalıştırılmasıdır.
İlerlemeler
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 referanslarına bakın.) |
İlerlemeler
this
: Bileşen örneği.
once(event, handler)
Yalnızca belirtilen etkinliğin bir sonraki oluşumunda çağrılacak bir işlevi kaydeder. İşleyici, çalıştırıldıktan sonra kaydını otomatik olarak iptal eder.
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 referanslarına bakın.) |
İlerlemeler
this
: Bileşen örneği.
off(opt_event, opt_handler)
Bir bileşenden etkinlik işleyiciyi kaldırır. İşleyici iletilmezse geçirilen etkinliğin tüm işleyicileri kaldırılır. Herhangi bir etkinlik iletilmezse tüm etkinliklerin tüm işleyicileri kaldırılır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
opt_event |
string |
Etkinliğin adı. Etkinlik belirtilmezse tüm etkinliklerin tüm işleyicileri kaldırılır. İsteğe bağlı. |
opt_handler |
Function |
Kaldırılacak işlev işleyici başvurusu. Hiçbir işlev iletilmezse tüm işleyiciler kaldırılır. İsteğe bağlı. |
İlerlemeler
undefined
emit(event, ...opt_args)
Bir etkinlik yayınladığında. İsteğe bağlı olarak, kayıtlı işleyicilere iletilecek bağımsız değişkenleri belirtebilirsiniz.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
event |
string |
Etkinliğin adı. |
...opt_args |
* |
Kayıtlı etkinlik işleyicilere iletilecek isteğe bağlı bağımsız değişkenler. |
İlerlemeler
undefined