Odniesienie do wbudowanych komponentów

W tym dokumencie opisano opcje, metody, właściwości i zdarzenia dotyczące wszystkich wbudowanych komponentów interfejsu Embed API.

uwierzytelnienie

gapi.analytics.auth

Komponent uwierzytelniania to pojedynczy tag, którego można użyć do autoryzacji użytkownika.

Metody
authorize(options:Object)	Zwroty:  gapi.analytics.auth Renderuje przycisk logowania Google Analytics w określonym kontenerze, który umożliwia użytkownikowi zalogowanie się na konto Google.
isAuthorized()	Zwroty:  boolean Zwraca wartość true, jeśli użytkownik przeprowadził autoryzację. W przeciwnym razie zwraca wartość false.
signOut()	Zwroty:  gapi.analytics.auth Wylogowuje bieżącego użytkownika. Wywołuje też zdarzenie signOut.
getAuthResponse()	Zwroty:  Object Pobiera dane uwierzytelniania zwrócone przez pierwotne żądanie autoryzacji. Zwrócony obiekt zawiera token dostępu, za pomocą którego zwykle można ręcznie wysyłać uwierzytelnione żądania.
getUserProfile()	Zwroty:  Object Pobiera podstawowe informacje z profilu aktualnie zalogowanego użytkownika. Obejmuje to nazwę użytkownika, adres e-mail i publiczne zdjęcie profilowe (jeśli jest ustawione).

Metody dziedziczone
on
once
off

Opcje
clientId	Typ:  string Identyfikator klienta projektu w Konsoli Play.
container	Typ:  string|HTMLElement Identyfikator elementu HTML w modelu DOM, który będzie hostować przycisk logowania. Możesz też przekazać odwołanie do samego elementu.
userInfoLabel	Typ:  string Tekst wyświetlany przed adresem e-mail zalogowanego użytkownika. Domyślna wartość to 'You are logged in as: '.
scopes	Typ:  Array Lista zakresów uwierzytelniania interfejsu API Google, do których żąda Twoja aplikacja. Aby wyświetlić wszystkie dostępne zakresy, otwórz narzędzie OAuth 2.0 Playground. Informacje o zakresach uwierzytelniania interfejsu API Google Analytics znajdziesz w przewodnikach dla programistów dotyczących zasobów konfiguracji i raportowania.
overwriteDefaultScopes	Typ:  boolean Wskazuje, czy opcja scopes zastępuje domyślne zakresy interfejsu Embed API czy dodaje do nich nowe. Określenie zakresu domyślnego (false) spowoduje dodanie do zakresów domyślnych, a określenie zakresu true spowoduje zastąpienie ich zakresami określonymi przez opcję scopes. Domyślne wartości zakresów to:['https://www.googleapis.com/auth/analytics.readonly']. Uwaga: uwierzytelnianie za pomocą interfejsu Embed API wymaga dostępu do podstawowego profilu użytkownika. Tych zakresów nie można zastąpić.
serverAuth.access_token	Typ:  string Jeśli masz już prawidłowy token dostępu, możesz go przekazać bezpośrednio metody autoryzacji, a użytkownik nie zostanie poproszony o autoryzację. Szczegółowe informacje o pobieraniu tokena dostępu znajdziesz w dokumentacji protokołu OAuth 2.0.

Wydarzenia
signIn	Argumenty: brak Uruchamiane, gdy użytkownik zaloguje się poprawnie.
signOut	Argumenty: brak Uruchamiane, gdy użytkownik się wyloguje.
needsAuthorization	Argumenty: brak Podczas wywoływania metody gapi.analytics.auth.authorize odbywa się wstępne sprawdzanie, czy użytkownik jest obecnie zalogowany. Jeśli użytkownik nie jest zalogowany, zdarzenie to jest wywoływane i sygnalizuje, że wymagana jest dodatkowa autoryzacja.
error	Argumenty:  response Uruchamiane, gdy podczas procesu uwierzytelniania wystąpi błąd. Jeśli chcesz otrzymać komunikat o błędzie z obiektu odpowiedzi, jego lokalizacja to response.error.message.

Wycofane zdarzenia
success	Argumenty:  response To zdarzenie zapewnia zgodność wsteczną i może zostać usunięte w przyszłej wersji. Zamiast tego użyj zdarzenia signIn.

Przykład

// 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'
  }
});

Uwaga: autoryzacja odbywa się natychmiast, gdy używasz serverAuth.access_token, więc nie musisz rejestrować modułu obsługi zdarzeń.

Ważne: jeśli używasz serverAuth.access_token, to Ty musisz się upewnić, że token jest prawidłowy i nie utracił ważności. Szczegółowe informacje o odświeżaniu wygasłego tokena dostępu znajdziesz w dokumentacji protokołu OAuth 2.0.

Dane

gapi.analytics.report.Data

Zespół
Data(options:Object)	Komponent Dane umożliwia wysyłanie zapytań do interfejsu API podstawowego raportowania Google Analytics i uzyskiwanie wyników.

Opcje
query	Typ:  Object Obiekt zawierający parametry zapytania z interfejsu API podstawowego raportowania. Oprócz standardowych wartości domyślnych dostarczanych przez interfejs API używane są te wartości domyślne: { 'start-date': '7daysAgo', 'end-date': 'yesterday }

Metody dziedziczone
get
set
execute
on
once
off
emit

Wydarzenia
success	Argumenty:  response Uruchamiane po ukończeniu zapytania.
error	Argumenty:  response Uruchamiane, gdy podczas przetwarzania zapytania wystąpi błąd. Jeśli chcesz otrzymać komunikat o błędzie z obiektu odpowiedzi, jego lokalizacja to response.error.message.

Przykład

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

Zespół
DataChart(options:Object)	DataChart obejmuje standardowy wykres Google i komponent Dane, dzięki czemu możesz łatwo utworzyć wizualizację na podstawie zapytania bez konieczności łączenia go ze sobą.

Opcje
query	Typ:  Object Zobacz opcję wysyłania zapytań do komponentu danych.
chart	Typ:  Object Szczegółowe informacje dotyczące poszczególnych opcji wykresów znajdziesz poniżej.
chart.container	Typ:  string|HTMLElement Identyfikator elementu HTML elementu DOM, który będzie hostować wykres danych. Możesz też przekazać odwołanie do samego elementu.
chart.type	Typ:  string Typ wykresu. Dostępne opcje to LINE, COLUMN, BAR, TABLE i GEO.
chart.options	Typ:  Object Wszystkie opcje, które można przekazać do odpowiedniego obiektu Chart Google.

Metody dziedziczone
get
set
execute
on
once
off
emit

Wydarzenia
success	Argumenty:  result Uruchamiane, gdy zapytanie zakończy się powodzeniem, a wykres zostanie w pełni wyrenderowany. result.chart – wystąpienie Wykresu Google. result.data – odpowiedź na raport w formacie parametru danych. result.dataTable – instancja DataTable utworzona z obiektu result.data. result.response – nieprzetworzony obiekt odpowiedzi API.
error	Argumenty:  response Uruchamiane, gdy podczas zapytania lub procesu renderowania wystąpi błąd. Jeśli chcesz otrzymać komunikat o błędzie z obiektu odpowiedzi, jego lokalizacja to response.error.message.

Przykład

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

Zespół
ViewSelector(options:Object)	Komponent ViewSelector umożliwia wybór konta, usługi i widoku za pomocą menu.

Opcje
container	Typ:  string|HTMLElement Identyfikator elementu HTML w modelu DOM, który będzie hostować obiekt ViewSelector. Możesz też przekazać odwołanie do samego elementu.

Metody dziedziczone
get
set
execute
on
once
off
emit

Właściwości instancji
ids	Typ:  string Niepowtarzalny identyfikator tabeli w formacie ga:XXXX, gdzie XXXX to identyfikator widoku danych (profilu) w Analytics.

Wydarzenia
change	Argumenty:  ids Uruchamiane za każdym razem, gdy użytkownik wybierze z menu nowy widok. Jest on też uruchamiany przy pierwszym renderowaniu wystąpienia elementu ViewSelector i wyświetla się widok domyślny.

Przykład

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

Metody współdzielonych komponentów

Metody
set(options)	zwroty: this Ustawia lub aktualizuje opcje konfiguracji komponentu (można to zrobić również na etapie tworzenia w konstruktorze).
get()	zwroty: Object Zwraca bieżące opcje konfiguracji komponentu.
execute()	zwroty: this Wywołuje główne działanie komponentu. Zwykle polega to na wyrenderowaniu czegoś na stronie lub wygenerowaniu raportu (albo i jednym).
on(event, handler)	zwroty: this Rejestruje funkcję, która ma zostać wywołana, gdy komponent wywoła określone zdarzenie.
once(event, handler)	zwroty: this Rejestruje funkcję do wywołania dopiero po następnym wystąpieniu określonego zdarzenia. Po uruchomieniu modułu obsługi po automatycznym wyrejestrowaniu się.
off(opt_event, opt_handler)	zwroty: undefined Usuwa moduł obsługi zdarzeń z komponentu. Jeśli żaden moduł obsługi nie zostanie przekazany, zostaną usunięte wszystkie moduły obsługi przekazanego zdarzenia. Jeśli żadne zdarzenie nie zostanie przekazane, zostaną usunięte wszystkie moduły obsługi każdego zdarzenia.
emit(event, ...opt_args)	zwroty: undefined Emituje zdarzenie. Możesz opcjonalnie określić argumenty, które mają być przekazywane do zarejestrowanych modułów obsługi.

set

Ustawia lub aktualizuje opcje konfiguracji komponentu (można to zrobić również na etapie tworzenia w konstruktorze).

Wykorzystanie

component.set(options);

Parametry

Nazwa	Typ	Opis
options	Object	Opcje konfiguracji tego komponentu. Zaliczone opcje zostaną scalone z istniejącymi opcjami.

Zwroty

this – instancja komponentu.

---

get

Zwraca bieżące opcje konfiguracji komponentu.

Zwroty

Object – bieżące opcje konfiguracji komponentu.

---

execute()

Wywołuje główne działanie komponentu. Zwykle polega to na wyrenderowaniu czegoś na stronie lub wygenerowaniu raportu (albo i jednym).

Zwroty

this – instancja komponentu.

---

on(event, handler)

Rejestruje funkcję, która ma zostać wywołana, gdy komponent wywoła określone zdarzenie.

Parametry

Nazwa	Typ	Opis
event	string	Nazwa zdarzenia.
handler	Function	Funkcja, która zostanie wywołana po wystąpieniu zdarzenia. (Szczegółowe informacje o parametrach znajdziesz w odwołaniach do poszczególnych zdarzeń).

Zwroty

this – instancja komponentu.

---

once(event, handler)

Rejestruje funkcję do wywołania dopiero po następnym wystąpieniu określonego zdarzenia. Po uruchomieniu modułu obsługi po automatycznym wyrejestrowaniu się.

Parametry

Nazwa	Typ	Opis
event	string	Nazwa zdarzenia.
handler	Function	Funkcja, która zostanie wywołana po wystąpieniu zdarzenia. (Szczegółowe informacje o parametrach znajdziesz w odwołaniach do poszczególnych zdarzeń).

Zwroty

this – instancja komponentu.

---

off(opt_event, opt_handler)

Usuwa moduł obsługi zdarzeń z komponentu. Jeśli żaden moduł obsługi nie zostanie przekazany, zostaną usunięte wszystkie moduły obsługi przekazanego zdarzenia. Jeśli żadne zdarzenie nie zostanie przekazane, zostaną usunięte wszystkie moduły obsługi każdego zdarzenia.

Parametry

Nazwa	Typ	Opis
opt_event	string	Nazwa zdarzenia. Jeśli nie określisz żadnego zdarzenia, zostaną usunięte wszystkie moduły obsługi wszystkich zdarzeń. Opcjonalne.
opt_handler	Function	Odwołanie do modułu obsługi funkcji, które ma zostać usunięte. Jeśli nie zostanie przekazana żadna funkcja, wszystkie moduły obsługi zostaną usunięte. Opcjonalne.

Zwroty

undefined

---

emit(event, ...opt_args)

Emituje zdarzenie. Możesz opcjonalnie określić argumenty, które mają być przekazywane do zarejestrowanych modułów obsługi.

Parametry

Nazwa	Typ	Opis
event	string	Nazwa zdarzenia.
...opt_args	*	Opcjonalne argumenty przekazywane do wszystkich zarejestrowanych modułów obsługi zdarzeń.

Zwroty

undefined