標準のユニバーサルアナリティクス（UA）プロパティでは、2023 年 7 月 1 日をもってデータの処理が停止されました。UA 360 プロパティでは、2024 年 7 月 1 日をもってデータの処理が停止されます。また、Google アナリティクス 4 への移行に伴い、一部の UA 360 の機能はその前にサポート終了となります。Data API を使用して、GA4 プロパティのレポート機能にアクセスします。

このページは Cloud Translation API によって翻訳されました。

組み込みコンポーネントリファレンス

このドキュメントでは、すべての組み込み Embed API コンポーネントのオプション、メソッド、プロパティ、イベントについて説明します。

認証

gapi.analytics.auth

auth コンポーネントは、ユーザーの認証に使用できるシングルトンです。

Methods
`authorize(options:Object)`	戻り値: `gapi.analytics.auth` 指定されたコンテナ内に Google アナリティクスのログインボタンをレンダリングします。ユーザーはこのボタンから Google アカウントにログインできます。
`isAuthorized()`	戻り値: `boolean` ユーザーが認証に成功した場合は `true`、そうでない場合は `false` を返します。
`signOut()`	戻り値: `gapi.analytics.auth` 現在のユーザーをログアウトします。また、`signOut` イベントをトリガーします。
`getAuthResponse()`	戻り値: `Object` 元の認可リクエストによって返された認証データを取得します。返されるオブジェクトにはアクセストークンが含まれます。通常、このトークンを使用すると、手動で認証されたリクエストを行うことができます。
`getUserProfile()`	戻り値: `Object` 現在ログインしているユーザーの基本的なプロフィール情報を取得します。この情報には、ユーザーの名前、メールアドレス、（設定されていれば）公開プロフィール画像が含まれます。

継承されるメソッド
`on`
`once`
`off`

オプション
`clientId`	タイプ: `string` Developers Console にあるプロジェクトのクライアント ID。
`container`	タイプ: `string\|HTMLElement` ログインボタンをホストする、DOM 内の HTML 要素の ID。要素自体に参照を渡すこともできます。
`userInfoLabel`	タイプ: `string` ログインユーザーのメールアドレスの前に表示するテキスト。デフォルトは `'You are logged in as: '` です。
`scopes`	タイプ: `Array` アプリケーションでリクエストしている Google API auth スコープのリスト。使用可能なすべてのスコープを確認するには、OAuth 2.0 Playground を参照してください。Google アナリティクス API の認証スコープについては、Configuration と Reporting リソースのデベロッパーガイドをご覧ください。
`overwriteDefaultScopes`	タイプ: `boolean` `scopes` オプションがデフォルトの Embed API スコープを置き換えるか、またはスコープに追加されるかを示します。`false`（デフォルト）を指定すると、デフォルトのスコープに追加されます。`true` を指定すると、`scopes` オプションで指定されたスコープに置き換えられます。デフォルトのスコープ値は `['https://www.googleapis.com/auth/analytics.readonly']` です。注意: Embed API を介した認証では、ユーザーの基本的なプロフィール情報へのアクセスが必要です。これらのスコープは上書きできません。
`serverAuth.access_token`	タイプ: `string` 既に有効なアクセストークンがある場合は、authorize メソッドに直接渡すことができます。それ以降、ユーザーが認証を求められることはありません。アクセストークンの取得方法の詳細については、OAuth 2.0 のドキュメントを参照してください。

イベント
`signIn`	引数: なしユーザーが正常にログインしたときに発生します。
`signOut`	引数: なしユーザーが正常にログアウトしたときに発生します。
`needsAuthorization`	引数: なし `gapi.analytics.auth.authorize` メソッドを呼び出すと、ユーザーが現在ログインしているかどうかの初期チェックが行われます。ユーザーがログインしていない場合、追加の認証が必要であることを示すためにこのイベントが発生します。
`error`	引数: `response` 認証プロセス中にエラーが発生したときに呼び出されます。レスポンスオブジェクトからエラーメッセージを取得する場合は、`response.error.message` にあります。

廃止されたイベント

廃止されたイベント
`success`	引数: `response` このイベントは、下位互換性のために存在していますが、将来のバージョンでは削除される可能性があります。代わりに `signIn` イベントを使用してください。

success

引数: response

このイベントは、下位互換性のために存在していますが、将来のバージョンでは削除される可能性があります。代わりに signIn イベントを使用してください。

例

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

注: serverAuth.access_token を使用するとすぐに承認が行われるため、イベントハンドラを登録する必要はありません。

重要: serverAuth.access_token を使用する場合、トークンが有効で、期限切れになっていないことを確認する必要があります。期限切れのアクセストークンを更新する方法については、OAuth 2.0 のドキュメントをご覧ください。

データ

gapi.analytics.report.Data

構成
`Data(options:Object)`	Data コンポーネントを使用して、Google アナリティクスの Core Reporting API に対してクエリを実行し、結果を受け取ることができます。

オプション
`query`	タイプ: `Object` Core Reporting API のクエリパラメータを含むオブジェクト。API によって提供される通常のデフォルト値に加えて、次のデフォルト値が使用されます。 { 'start-date': '7daysAgo', 'end-date': 'yesterday }

オプション

query

タイプ: Object

Core Reporting API のクエリパラメータを含むオブジェクト。API によって提供される通常のデフォルト値に加えて、次のデフォルト値が使用されます。

{
  'start-date': '7daysAgo',
  'end-date': 'yesterday
}

継承されるメソッド
`get`
`set`
`execute`
`on`
`once`
`off`
`emit`

イベント
`success`	引数: `response` クエリが正常に完了したときに呼び出されます。
`error`	引数: `response` クエリの処理中にエラーが発生したときに呼び出されます。レスポンスオブジェクトからエラーメッセージを取得する場合は、`response.error.message` にあります。

イベント

success

引数: response

クエリが正常に完了したときに呼び出されます。

error

引数: response

クエリの処理中にエラーが発生したときに呼び出されます。レスポンスオブジェクトからエラーメッセージを取得する場合は、response.error.message にあります。

例

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`	タイプ: `Object` Data コンポーネントのクエリオプションをご覧ください。
`chart`	タイプ: `Object` 個々のグラフオプションの詳細については下記をご覧ください。
`chart.container`	タイプ: `string\|HTMLElement` DataChart をホストする、DOM 内の HTML 要素の ID。要素自体に参照を渡すこともできます。
`chart.type`	タイプ: `string` グラフのタイプ。使用可能なオプションは、`LINE`、`COLUMN`、`BAR`、`TABLE`、`GEO` です。
`chart.options`	タイプ: `Object` 対応する Google Chart オブジェクトに渡すことができるすべてのオプション。

継承されるメソッド
`get`
`set`
`execute`
`on`
`once`
`off`
`emit`

イベント
`success`	引数: `result` クエリが正常に完了し、グラフが完全にレンダリングされたときに呼び出されます。 `result.chart` - Google Chart インスタンス。 `result.data` - データパラメータ形式のレポートレスポンス。 `result.dataTable` - `result.data` オブジェクトから作成された DataTable インスタンス。 `result.response` - 未加工の API レスポンスオブジェクト。
`error`	引数: `response` クエリまたはレンダリングの処理中にエラーが発生したときに呼び出されます。レスポンスオブジェクトからエラーメッセージを取得する場合は、`response.error.message` にあります。

イベント

success

引数: result

クエリが正常に完了し、グラフが完全にレンダリングされたときに呼び出されます。

result.chart - Google Chart インスタンス。
result.data - データパラメータ形式のレポートレスポンス。
result.dataTable - result.data オブジェクトから作成された DataTable インスタンス。
result.response - 未加工の API レスポンスオブジェクト。

error

引数: response

クエリまたはレンダリングの処理中にエラーが発生したときに呼び出されます。レスポンスオブジェクトからエラーメッセージを取得する場合は、response.error.message にあります。

例

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`	タイプ: `string\|HTMLElement` ViewSelector をホストする、DOM 内の HTML 要素の ID。要素自体に参照を渡すこともできます。

オプション

container

タイプ: string|HTMLElement

ViewSelector をホストする、DOM 内の HTML 要素の ID。要素自体に参照を渡すこともできます。

継承されるメソッド
`get`
`set`
`execute`
`on`
`once`
`off`
`emit`

インスタンスプロパティ
`ids`	タイプ: `string` ga:XXXX 形式の固有の表 ID。XXXX は、アナリティクスのビュー ID（プロファイル ID）です。

インスタンスプロパティ

ids

タイプ: string

ga:XXXX 形式の固有の表 ID。XXXX は、アナリティクスのビュー ID（プロファイル ID）です。

イベント
`change`	引数: `ids` ユーザーがプルダウンメニューから新しいビューを選択するたびに呼び出されます。また、ViewSelector インスタンスが初めてレンダリングされ、デフォルトのビューが表示されるときにも呼び出されます。

イベント

change

引数: ids

ユーザーがプルダウンメニューから新しいビューを選択するたびに呼び出されます。また、ViewSelector インスタンスが初めてレンダリングされ、デフォルトのビューが表示されるときにも呼び出されます。

例

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

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

viewSelector.execute();

共有コンポーネントメソッド

Methods
`set(options)`	戻り値: `this` コンポーネントの構成オプションを設定または更新します（これは、コンストラクタの作成時にも行うことができます）。
`get()`	戻り値: `Object` コンポーネントの現在の構成オプションを返します。
`execute()`	戻り値: `this` コンポーネントのプライマリアクションを呼び出します。通常は、ページ上でのレンダリングやレポートの実行、またはその両方を行います。
`on(event, handler)`	戻り値: `this` コンポーネントが指定されたイベントを発行したときに呼び出す関数を登録します。
`once(event, handler)`	戻り値: `this` 指定されたイベントが次回発生した場合のみ呼び出す関数を登録します。ハンドラは、一度実行されると、自動的に登録解除されます。
`off(opt_event, opt_handler)`	戻り値: `undefined` コンポーネントからイベントハンドラを削除します。ハンドラが渡されない場合、渡されたイベントのハンドラがすべて削除されます。イベントが渡されない場合は、すべてのイベントのハンドラがすべて削除されます。
`emit(event, ...opt_args)`	戻り値: `undefined` イベントを発生させます。登録済みハンドラに渡す引数を指定することもできます。

`set`

コンポーネントの構成オプションを設定または更新します（これは、コンストラクタの作成時にも行うことができます）。

使用量

component.set(options);

パラメータ

名前	型	説明
`options`	`Object`	このコンポーネントの設定オプション。渡されたオプションが既存のオプションと統合されます。

パラメータ

名前	型	説明
`event`	`string`	イベントの名前。
`...opt_args`	`*`	登録済みのイベントハンドラに渡すオプション引数。

戻り値

undefined

組み込みコンポーネント リファレンス

認証

Methods

継承されるメソッド

オプション

イベント

例

データ

オプション

継承されるメソッド

イベント

例

DataChart

オプション

継承されるメソッド

イベント

例

ViewSelector

オプション

継承されるメソッド

インスタンス プロパティ

イベント

例

共有コンポーネント メソッド

set

使用量

パラメータ

戻り値

get

戻り値

execute()

戻り値

on(event, handler)

パラメータ

戻り値

once(event, handler)

パラメータ

戻り値

off(opt_event, opt_handler)

パラメータ

戻り値

emit(event, ...opt_args)

パラメータ

戻り値

組み込みコンポーネントリファレンス

インスタンスプロパティ

共有コンポーネントメソッド

`set`

`get`

`execute()`

`on(event, handler)`

`once(event, handler)`

`off(opt_event, opt_handler)`

`emit(event, ...opt_args)`