이 문서에서는 모든 내장 Embed API 구성요소의 옵션, 메서드, 속성, 이벤트를 설명합니다.
auth
gapi.analytics.auth
인증 구성요소는 사용자를 승인하는 데 사용할 수 있는 싱글톤입니다.
방법 |
|
---|---|
authorize(options:Object) |
반환: 사용자가 Google 계정으로 로그인할 수 있도록 지정된 컨테이너 내에 Google 애널리틱스 로그인 버튼을 렌더링합니다. |
isAuthorized() |
반환: 사용자가 성공적으로 승인하면 |
signOut() |
반환: 현재 사용자를 로그아웃시킵니다. |
getAuthResponse() |
반환: 원래 승인 요청에서 반환한 인증 데이터를 가져옵니다. 반환된 객체에는 액세스 토큰이 포함되며, 액세스 토큰이 일반적으로 수동으로 인증된 요청을 수행하는 데 사용될 수 있습니다. |
getUserProfile() |
반환: 현재 로그인한 사용자의 기본 프로필 정보를 가져옵니다. 여기에는 사용자 이름, 이메일 주소, 공개 프로필 이미지 (설정된 경우)가 포함됩니다. |
옵션 |
|
---|---|
clientId |
유형: 개발자 콘솔에서 프로젝트의 클라이언트 ID입니다. |
container |
유형: 로그인 버튼을 호스팅할 DOM의 HTML 요소 ID입니다. 요소 자체에 대한 참조를 전달할 수도 있습니다. |
userInfoLabel |
유형: 로그인한 사용자의 이메일 주소 앞에 표시할 텍스트입니다. 기본값은 |
scopes |
유형: 애플리케이션에서 요청하는 Google API 인증 범위 목록입니다. 사용 가능한 모든 범위를 보려면 OAuth 2.0 Playground를 방문하세요. Google 애널리틱스 API 인증 범위는 개발자 가이드에서 구성 및 보고 리소스를 참고하세요. |
overwriteDefaultScopes |
유형:
기본 범위 값은 참고: Embed API를 통해 인증하려면 사용자의 기본 프로필에 대한 액세스 권한이 필요합니다. 이러한 범위는 덮어쓸 수 없습니다. |
serverAuth.access_token |
유형: 유효한 액세스 토큰이 이미 있는 경우 인증 방법에 직접 전달할 수 있습니다. 그러면 사용자에게 인증하라는 메시지가 표시되지 않습니다. 액세스 토큰을 가져오는 방법에 대한 자세한 내용은 OAuth 2.0 문서를 참고하세요. |
이벤트 |
|
---|---|
signIn |
인수: 없음 사용자가 로그인에 성공하면 시작됩니다. |
signOut |
인수: 없음 사용자가 성공적으로 로그아웃하면 시작됩니다. |
needsAuthorization |
인수: 없음
|
error |
인수: 인증 프로세스 중에 오류가 발생하면 시작됩니다. 응답 객체에서 오류 메시지를 가져오려면 |
지원 중단된 이벤트 | |
---|---|
success |
인수: 이 이벤트는 이전 버전과의 호환성을 위해 존재하며 향후 버전에서 삭제될 수 있습니다. 대신 |
예
// 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' } });
데이터
gapi.analytics.report.Data
생성자 | |
---|---|
Data(options:Object)
|
데이터 구성요소를 사용하면 Google 애널리틱스 Core Reporting API를 쿼리하고 결과를 반환할 수 있습니다. |
옵션 |
|
---|---|
query
|
유형: Core Reporting API의 쿼리 매개변수가 포함된 객체입니다. API에서 제공하는 일반 기본값 외에 다음 기본값이 사용됩니다. { 'start-date': '7daysAgo', 'end-date': 'yesterday } |
이벤트 |
|
---|---|
success |
인수: 쿼리가 성공적으로 완료되면 시작됩니다. |
error |
인수: 쿼리 프로세스 중에 오류가 발생하면 실행됩니다. 응답 객체에서 오류 메시지를 가져오려면 |
예
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
생성자 | |
---|---|
DataChart(options:Object)
|
DataChart 는 표준 Google 차트와 데이터 구성요소를 래핑하므로 직접 연결하지 않고도 쿼리에서 시각화를 쉽게 만들 수 있습니다. |
옵션 |
|
---|---|
query |
유형: 데이터 구성요소 쿼리 옵션을 참고하세요. |
chart |
유형: 개별 차트 옵션 세부정보는 아래를 참고하세요. |
chart.container |
유형: DataChart를 호스팅할 DOM의 HTML 요소 ID입니다. 요소 자체에 대한 참조를 전달할 수도 있습니다. |
chart.type |
유형: 차트 유형입니다. 가능한 옵션은 |
chart.options |
유형: 해당 Google Chart 객체에 전달할 수 있는 모든 옵션입니다. |
이벤트 |
|
---|---|
success |
인수: 쿼리가 성공적으로 완료되고 차트가 완전히 렌더링되면 시작됩니다. |
error |
인수: 쿼리 또는 렌더링 프로세스 중에 오류가 발생하면 실행됩니다. 응답 객체에서 오류 메시지를 가져오려면 |
예
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
생성자 | |
---|---|
ViewSelector(options:Object)
|
ViewSelector 구성요소를 사용하면 드롭다운 메뉴를 통해 계정, 속성, 보기를 선택할 수 있습니다. |
옵션 |
|
---|---|
container |
유형: ViewSelector를 호스팅할 DOM의 HTML 요소 ID입니다. 요소 자체에 대한 참조를 전달할 수도 있습니다. |
인스턴스 속성 |
|
---|---|
ids |
유형: ga:XXXX 형식의 고유한 표 ID로, 여기에서 XXXX는 애널리틱스 보기 (프로필) ID입니다. |
이벤트 |
|
---|---|
change |
인수: 사용자가 드롭다운 메뉴에서 새 뷰를 선택할 때마다 실행됩니다. 또한 ViewSelector 인스턴스가 처음 렌더링되고 기본 뷰가 표시될 때도 실행됩니다. |
예
var viewSelector = new gapi.analytics.ViewSelector({ container: 'view-selector' }); viewSelector.on('change', function(ids) { console.log(ids); }); viewSelector.execute();
공유 구성요소 메서드
방법 | |
---|---|
set(options) |
반환: 구성요소의 구성 옵션을 설정하거나 업데이트합니다. 이 작업은 생성자에서 생성할 때 수행할 수도 있습니다. |
get() |
반환: 구성요소의 현재 구성 옵션을 반환합니다. |
execute() |
반환: 구성요소의 기본 작업을 호출합니다. 일반적으로 이는 페이지에서 무언가를 렌더링하거나 보고서를 실행 (또는 둘 다)하는 것입니다. |
on(event, handler) |
반환: 구성요소가 지정된 이벤트를 내보낼 때 호출될 함수를 등록합니다. |
once(event, handler) |
반환: 지정된 이벤트가 다음에 발생할 때만 호출될 함수를 등록합니다. 핸들러는 실행된 후 자동으로 등록 취소됩니다. |
off(opt_event, opt_handler) |
반환: 구성요소에서 이벤트 핸들러를 제거합니다. 핸들러가 전달되지 않으면 전달된 이벤트의 모든 핸들러가 삭제됩니다. 이벤트가 전달되지 않으면 모든 이벤트의 핸들러가 모두 삭제됩니다. |
emit(event, ...opt_args) |
반환: 이벤트를 생성합니다. 원하는 경우 등록된 핸들러에 전달할 인수를 지정할 수 있습니다. |
set
구성요소의 구성 옵션을 설정하거나 업데이트합니다. 이 작업은 생성자에서 생성할 때 수행할 수도 있습니다.
사용량
component.set(options);
매개변수
이름 | 유형 | 설명 |
---|---|---|
options |
Object |
이 구성요소의 구성 옵션입니다. 전달된 옵션이 기존 옵션과 병합됩니다. |
반환 값
this
: 구성요소 인스턴스입니다.
get
구성요소의 현재 구성 옵션을 반환합니다.
반환 값
Object
- 구성요소의 현재 구성 옵션입니다.
execute()
구성요소의 기본 작업을 호출합니다. 일반적으로 이는 페이지에서 무언가를 렌더링하거나 보고서를 실행 (또는 둘 다)하는 것입니다.
반환 값
this
: 구성요소 인스턴스입니다.
on(event, handler)
구성요소가 지정된 이벤트를 내보낼 때 호출될 함수를 등록합니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
event |
string |
이벤트 이름 |
handler |
Function |
이벤트가 발생할 때 호출될 함수입니다. 매개변수 세부정보는 개별 이벤트 참조를 확인하세요. |
반환 값
this
: 구성요소 인스턴스입니다.
once(event, handler)
지정된 이벤트가 다음에 발생할 때만 호출될 함수를 등록합니다. 핸들러는 실행된 후 자동으로 등록 취소됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
event |
string |
이벤트 이름 |
handler |
Function |
이벤트가 발생할 때 호출될 함수입니다. 매개변수 세부정보는 개별 이벤트 참조를 확인하세요. |
반환 값
this
: 구성요소 인스턴스입니다.
off(opt_event, opt_handler)
구성요소에서 이벤트 핸들러를 제거합니다. 핸들러가 전달되지 않으면 전달된 이벤트의 모든 핸들러가 삭제됩니다. 이벤트가 전달되지 않으면 모든 이벤트의 핸들러가 모두 삭제됩니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
opt_event |
string |
이벤트 이름 이벤트를 지정하지 않으면 모든 이벤트의 핸들러가 모두 삭제됩니다. 선택사항. |
opt_handler |
Function |
삭제할 함수 핸들러에 대한 참조입니다. 함수가 전달되지 않으면 모든 핸들러가 삭제됩니다. 선택사항. |
반환 값
undefined
emit(event, ...opt_args)
이벤트를 생성합니다. 원하는 경우 등록된 핸들러에 전달할 인수를 지정할 수 있습니다.
매개변수
이름 | 유형 | 설명 |
---|---|---|
event |
string |
이벤트 이름 |
...opt_args |
* |
등록된 이벤트 핸들러에 전달할 선택적 인수입니다. |
반환 값
undefined