Yerleşik Bileşen Referansı

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: gapi.analytics.auth

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: boolean

Kullanıcı başarıyla yetkilendirdiyse true değerini, aksi takdirde false değerini döndürür.

signOut()

İadeler: gapi.analytics.auth

Mevcut kullanıcının oturumunu kapatır. Ayrıca, signOut etkinliğini tetikler.

getAuthResponse()

İadeler: Object

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: Object

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.

Devralınan yöntemler

on
once
off

Seçenekler

clientId

Tür: string

Geliştirici konsolundaki projenizin istemci kimliği.

container

Tür: string|HTMLElement

DOM'da, oturum açma düğmesini içerecek HTML öğesinin kimliği. Öğenin kendisine bir referans da iletebilirsiniz.

userInfoLabel

Tür: string

Giriş yapmış kullanıcının e-posta adresinden önce gösterilecek metin. Varsayılan olarak 'You are logged in as: ' değerine ayarlanır.

scopes

Tür: Array

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: boolean

scopes seçeneğinin, varsayılan Yerleştirme API kapsamlarının yerini alıp almayacağını veya bunlara eklenip eklenmeyeceğini belirtir. false (varsayılan) belirtildiğinde, varsayılan kapsamlar eklenir ve true politikası belirtildiğinde, bunları scopes seçeneği tarafından belirtilen kapsamlarla değiştirir.

Varsayılan kapsam değeri:['https://www.googleapis.com/auth/analytics.readonly'].

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: string

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

gapi.analytics.auth.authorize yöntemi çağrılırken kullanıcının oturum açmış olup olmadığını görmek için bir ilk kontrol gerçekleştirilir. Kullanıcı oturum açmamışsa daha fazla yetkilendirme gerektiğini belirtmek için bu etkinlik tetiklenir.

error

Bağımsız değişkenler: response

Kimlik doğrulama sürecinde hata oluştuğunda tetiklenir. Hata mesajını yanıt nesnesinden almak isterseniz, response.error.message olacaktır.

Kullanımdan kaldırılan etkinlikler
success

Bağımsız değişkenler: response

Bu etkinlik geriye dönük uyumluluk için mevcuttur ve sonraki bir sürümde kaldırılabilir. Bunun yerine signIn etkinliğini kullanın.

Ö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: Object

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
}

Devralınan yöntemler

get
set
execute
on
once
off
emit

Etkinlikler

success

Bağımsız değişkenler: response

Sorgu başarıyla tamamlandığında tetiklenir.

error

Bağımsız değişkenler: response

Sorgu işlemi sırasında bir hata oluştuğunda tetiklenir. Hata mesajını yanıt nesnesinden almak isterseniz, response.error.message olacaktır.

Ö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: Object

Veri bileşeni sorgu seçeneğine bakın.

chart

Tür: Object

Farklı grafik seçeneği ayrıntıları için aşağıya bakın.

chart.container

Tür: string|HTMLElement

DOM'da, DataChart'ı barındıran HTML öğesinin kimliği. Öğenin kendisine bir referans da iletebilirsiniz.

chart.type

Tür: string

Grafik türü. Olası seçenekler şunlardır: LINE, COLUMN, BAR, TABLE ve GEO.

chart.options

Tür: Object

İlgili Google Chart nesnesine geçirilebilecek tüm seçenekler.

Devralınan yöntemler

get
set
execute
on
once
off
emit

Etkinlikler

success

Bağımsız değişkenler: result

Sorgu başarıyla tamamlandığında ve grafik tamamen oluşturulduğunda tetiklenir.

  • result.chart – Google Grafik örneği.
  • result.dataveri parametresi biçiminde rapor yanıtı.
  • result.dataTableresult.data nesnesinden oluşturulan DataTable örneği.
  • result.response – Ham API yanıtı nesnesi.
error

Bağımsız değişkenler: response

Sorgu veya oluşturma işlemi sırasında bir hata oluştuğunda tetiklenir. Hata mesajını yanıt nesnesinden almak isterseniz, response.error.message olacaktır.

Ö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: string|HTMLElement

DOM'da, ViewSelector'ı barındıracak HTML öğesinin kimliği. Öğenin kendisine bir referans da iletebilirsiniz.

Devralınan yöntemler

get
set
execute
on
once
off
emit

Örnek özellikleri

ids

Tür: string

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: ids

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: this

Bileşenin yapılandırma seçeneklerini ayarlar veya günceller (bu, oluşturucuda oluşturma sırasında da yapılabilir).

get()

İadeler: Object

Bir bileşenin mevcut yapılandırma seçeneklerini döndürür.

execute()

İadeler: this

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: this

Bileşen belirtilen etkinliği yayınladığında çağrılacak bir işlevi kaydeder.

once(event, handler)

İadeler: this

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: undefined

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: undefined

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