このドキュメントでは、すべての組み込み Embed API コンポーネントのオプション、メソッド、プロパティ、イベントについて説明します。
認証
gapi.analytics.auth
auth コンポーネントは、ユーザーの認証に使用できるシングルトンです。
Methods |
|
---|---|
authorize(options:Object) |
戻り値: 指定されたコンテナ内に Google アナリティクスのログインボタンをレンダリングします。ユーザーはこのボタンから Google アカウントにログインできます。 |
isAuthorized() |
戻り値: ユーザーが認証に成功した場合は |
signOut() |
戻り値: 現在のユーザーをログアウトします。また、 |
getAuthResponse() |
戻り値: 元の認可リクエストによって返された認証データを取得します。返されるオブジェクトにはアクセス トークンが含まれます。通常、このトークンを使用すると、手動で認証されたリクエストを行うことができます。 |
getUserProfile() |
戻り値: 現在ログインしているユーザーの基本的なプロフィール情報を取得します。この情報には、ユーザーの名前、メールアドレス、(設定されていれば)公開プロフィール画像が含まれます。 |
オプション |
|
---|---|
clientId |
タイプ: Developers Console にあるプロジェクトのクライアント ID。 |
container |
タイプ: ログインボタンをホストする、DOM 内の HTML 要素の ID。要素自体に参照を渡すこともできます。 |
userInfoLabel |
タイプ: ログイン ユーザーのメールアドレスの前に表示するテキスト。デフォルトは |
scopes |
タイプ: アプリケーションでリクエストしている Google API auth スコープのリスト。使用可能なすべてのスコープを確認するには、OAuth 2.0 Playground を参照してください。Google アナリティクス API の認証スコープについては、Configuration と Reporting リソースのデベロッパー ガイドをご覧ください。 |
overwriteDefaultScopes |
タイプ:
デフォルトのスコープ値は 注意: Embed API を介した認証では、ユーザーの基本的なプロフィール情報へのアクセスが必要です。これらのスコープは上書きできません。 |
serverAuth.access_token |
タイプ: 既に有効なアクセス トークンがある場合は、authorize メソッドに直接渡すことができます。それ以降、ユーザーが認証を求められることはありません。アクセス トークンの取得方法の詳細については、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)
|
Data コンポーネントを使用して、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 グラフと Data コンポーネントをラップするため、クエリをつなぎ合わせることなく、クエリから簡単に可視化を行うことができます。 |
オプション |
|
---|---|
query |
タイプ: Data コンポーネントのクエリ オプションをご覧ください。 |
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(プロファイル ID)です。 |
イベント |
|
---|---|
change |
引数: ユーザーがプルダウン メニューから新しいビューを選択するたびに呼び出されます。また、ViewSelector インスタンスが初めてレンダリングされ、デフォルトのビューが表示されるときにも呼び出されます。 |
例
var viewSelector = new gapi.analytics.ViewSelector({ container: 'view-selector' }); viewSelector.on('change', function(ids) { console.log(ids); }); viewSelector.execute();
共有コンポーネント メソッド
Methods | |
---|---|
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