Create your own awesome maps

Even on the go

with our free apps for iPhone, iPad and Android

Get Started

Already have an account?
Log In

Google Analytics API リファレンス by Mind Map: Google Analytics API リファレンス
0.0 stars - reviews range from 0 to 5

Google Analytics API リファレンス

ディメンションと指標のリファレンス

Data Export API データ フィードで使用できるすべてのディメンションと指標について説明

全リスト

ユーザー, Dimensions, ga:visitorType, ga:visitCount, ga:daysSinceLastVisit, ga:userDefinedValue, Metrics, ga:visitors, ga:newVisits, ga:percentNewVisits

セッション, Dimensions, ga:visitLength, Metrics, ga:visits, ga:timeOnSite, ga:avgTimeOnSite

キャンペーン, Deminsions, ga:referralPath, ga:campaign, ga:soruce, ga:medium, ga:keyword, ga:adContent, Metrics, ga:organicSearches

AdWords

目標, Metrics, ga:goal(n)Starts, ga:goalStartsAll, ga:goal(n)Completions, ga:goalCompletionsAll, ga:goal(n)Value, ga:goalValueAll, ga:goalValuePerVisit, ga:goal(n)ConversionRate, ga:goalConversionRateAll, ga:goal(n)Abandons, ga:goalAbandonsAll, ga:goal(n)AbandonRate, ga:goalAbandonRateAll

システム, Dimensions, ga:browser, ga:browserVersion, ga:operatingSystem, ga:operatingSystemVersion, ga:flashVersion, ga:javaEnabled, ga:isMobile, ga:language, ga:screenColors, ga:screenResolution

地域とネットワーク, Dimensions, ga:coutinent, ga:subContinent, ga:country, ga:region, ga:city, ga:latitude, ga:longitude, ga:networkDomain, ga:networkLocation

ページトラッキング, Dimensions, ga:hostname, ga:pagePath, ga:pageTitle, ga:landingPagePath, ga:secondPagePath, ga:exitPagePath, ga:previousPagePath, ga:nextPagePath, ga:pageDepth, Metrics, ga:entrance, ga:entranceRate, ga:bounces, ga:entranceBounceRate, ga:visitBounceRate, ga:pageviews, ga:gapeviewsPerVisit, ga:uniquePageviews, ga:timeOnPage, ga:avgTimeOnPage, ga:exits, ga:exitRate, ga:pageLoadSample, ga:pageLoadTime, ga:avgPageLoadTime

サイト内検索

イベントトラッキング, Dimensions, ga:eventCategory, ga:eventAction, ga:eventLabel, Metrics, ga:totalEvents, ga:uniqueEvents, ga:eventValue, ga:avgEventValue, ga:visitsWithEvent, ga:eventsPerVisitWithEvent

eコマース, Dimensions, ga:transactionId, eコマーストラッキングメソッドで取得したショッピングカートのトランザクションID, ga:affiliation, 通常、供給元や実店舗の場所(商品アフィリエーション)の指定に使用される, ga:visitsToTransaction, ユーザーがキャンペーン経由でサイトを訪れてから購入に至るまでの訪問数, ga:daysToTransaction, ユーザーがサイトを訪れてから購入に至るまでの日数, ga:productCategory, eコマースアプリケーションで提供された購入アイテムの製品パターン(サイズ、色), ga:productName, eコマーストラッキングアプリケーションで取得した購入アイテムの商品名, ga:productSku, eコマーストラッキングアプリケーションで定義した購入アイテムの商品コード, Metrics, ga:transactions, トランザクションの合計数, ga:transactionsPerVisit, 1回のサイト訪問あたりの平均トランザクション数, ga:transactions / ga:visits, ga:transactionsRevenue, トランザクションの合計売上収益額(配送料と税金を除く), 詳細は、_addTrans()のトラッキングAPIリファレンス参照, ga:revenuePerTransaction, eコマーストランザクションの平均収益額, ga:transactionRevenue / ga:transactions, ga:transactionRevenuePerVisit, 1回のサイト訪問あたりの平均トランザクション収益額, ga:transactionRevenue / ga:visites, ga:transactionShipping, 配送料の合計, ga:transactionTax, 税額合計, ga:totalValue, サイトの合計値(合計収益額と合計目標値を含む), ga:transactionRevenue + ga:goalValueAll, ga:itemQuantity, 購入されたアイテムの合計数, ユーザーが2個のフリスビーと5個のテニスボールを購入した場合、7個のアイテムが購入されたことになる, ga:uniquePurchases, 購入された商品セットの数, サイトで2個のフリスビーと5個のテニスボールを購入された場合、2つの個別の商品が購入されたことになる, ga:revenuePerItem, アイテムあたりの平均収益額, ga:itemRevenue / ga:itemQuantity, ga:itemRevenue, ウェブサイトで購入された商品アイテムの合計収益額, 詳細は_addItem()のトラッキングAPIリファレンス, ga:itemsPerPurchase, 1回の購入あたりのアイテム(またはアイテムグループ)の平均販売数, ga:itemQuantity / ga:uniquePurchases

カスタム変数, Dimensions, ga:customVarName(n), ga:customVarValue(n)

時間, Dimensions, ga:date, ga:year, ga:month, ga:week, ga:day, ga:hour, ga:nthMonth, ga:nthWeek, ga:nthDay, ga:dayOfWeek

Demensions ディメンション

ユーザー, ga:visitorType, 新規ユーザーかリピートユーザーかを示すブール値, 有効な値はNew Visitor と Returning Visitor, ga:visitCount, ウェブサイトへの訪問インデックス, ユニークユーザーの訪問ごとに、初回訪問時の1からインデックスが追加される, 後続の訪問により以前の訪問インデックスが書き換えられることはない, ga:daysSinceLastVisit, ユーザーが最後にアクセスしてから経過した日数, リピート訪問数の計算に使用, ga:userDefinedValue, ウェブサイトのカスタムユーザーセグメントを定義するときに指定される値, 詳細

セッション, ga:visitLength, ウェブサイトへの訪問な長さ、秒単位で計測、記録, 返される値は文字列

キャンペーン, ga:referralPath, 参照URLのパス, 他のウェブサイトに自分のウェブサイトへのリンクがある場合、この要素にその参照リンクのあるページのパスが含められる, ga:campaign, キャンペーントラッキングを手動で行っている場合は、キャンペーントラッキングパラメータutm_campaignの値, AdWordsの自動タグ設定を使用している場合は、ウェブサイトで使用しているオンライン広告キャンペーンの名前, それ以外の場合は、値(not set)が使用される, ga:source, ウェブサイトの参照元, キャンペーントラッキングを手動で行っている場合は、キャンペーントラッキングパラメータutm_sourceの値, AdWordsの自動タグ設定を使用している場合、この値はgoogle, それ以外の場合は、ウェブサイトにアクセスしたユーザーの参照元ドメインになる, ポートアドレスが含まれる場合もある, ユーザーがサイトに直接アクセスした場合、この値は(direct), ga:medium, ウェブサイトへの参照の種類, キャンペーントラッキングを手動で行っている場合は、キャンペーントラッキングパラメータutm_mediumの値, AdWordsの自動タグ設定を使用している場合は、この値はpcc, ユーザーの参照元が検索エンジンであることが検出された場合、この値はorganic, 参照元が検索エンジンでない場合、この値はreferral, ユーザーがサイトに直接アクセスしてdocument.referrerが空の場合、この値は(none), ga:keyword, キャンペーントラッキングを手動で行っている場合は、キャンペーントラッキングパラメータutm_termの値, AdWordsの自動タグ設定を使用している場合や、ユーザーがオーガニック検索からウェブサイトに到達した場合は、検索に使用されたキーワード, それ以外の場合、この値は(not set), ga:adContent, キャンペーントラッキングを手動で行っている場合は、キャンペーントラッキングパラメータutm_contentの値, AdWordsの自動タグ設定を使用している場合は、オンライン広告キャンペーンのテキストの1行目, AdWords広告テキストでキーワード挿入を使用している場合は、キーワード挿入にマッチしたキーワードが表示される, それ以外の場合、この値は(not set)になる

AdWords

システム, ga:browser, ウェブサイトにアクセスしたユーザーが使用しているブラウザの名前, ga:browserVersion, ウェブサイトにアクセスしたユーザーが使用しているブラウザのバージョン, ga:operatingSystem, ユーザーが使用しているオペレーティングシステム, Windows、Linux、Macintosh、iPhone、iPodなど, ga:operatingSystemVersion, ユーザーが使用しているオペレーティングシステムのバージョン, Windowsではxp、vista、7など, ga:flashVersion, ユーザーのブラウザでサポートされているFlashのバージョン(マイナーバージョンを含む), ga:javaEnabled, ユーザーのブラウザのJavaサポートを示す, 有効な値はYesまたはNoで、最初の文字を大文字にする必要がある, ga:isMobile, モバイルユーザーを示す, 有効な値はYesまたはNoで、最初の文字を大文字にする必要がある, ga:language, ブラウザのHTTPリクエストによって提供される言語, 値はISO-639コード, ga:screenColors, ユーザーのブラウザのDOMから取得したユーザーのモニターの色深度, ga:screenResolution, ユーザーのブラウザのDOMから取得したユーザーのモニターの画面解像度, ※表示中のブラウザの実際のサイズではない

地域とネットワーク, ga:continent, IPアドレスから取得したウェブサイトユーザーの大陸, ga:subContinent, IPアドレスから取得したウェブサイトユーザーの亜大陸, ga:country, IPアドレスから取得したウェブサイトユーザーの国, ga:region, IPアドレスから取得したウェブサイトユーザーの地域, アメリカの場合New Yorkなどの州。日本の場合、都道府県, ga:city, IPアドレスから取得したウェブサイトユーザーの都市, ga:latitude, ユーザーの都市のおおよその緯度, IPアドレスから取得される, 赤道の北側の位置は正の値、赤道の南側の位置は負の値, ga:longitude, ユーザーの都市のおおよその経度, IPアドレスから取得される, 子午線の東側の位置は正の値、子午線の西側の位置は負の値, ga:networkDomain, ウェブサイトのアクセスしたユーザーが使用しているISPのドメイン名, IPアドレスに登録されたドメイン名が取得される, ga:networkLocation, ウェブサイトへのアクセスに使用されたサービスプロバイダの名前, ウェブサイトのユーザーの大半がケーブルインターネットの主要なサービスプロバイダを介してアクセスしている場合、 この要素にはそれらのケーブルサービスプロバイダの名前が表示される

ページトラッキング, ga:hostname, トラッキングリクエストを送信したホスト名, ga:pagePath, パスやクエリパラメータで指定されたウェブサイトのページ, ページの完全なURLを取得するにはga:hostnameと組み合わせて使用する, ga:pageTitle, ドキュメントオブジェクトモデルのdocument.titleプロパティで指定されたページのタイトル, 複数のURLで同じページタイトルを持つ場合があるので注意, ga:landingPagePath, ユーザーのセッションの最初のページ、またはlandingページ, ga:secondPagePath, ユーザーのセッションの2番目のページ, ga:exitPagePath, ユーザーのセッションの最後のページ、またはexitページ, ga:previousPagePath, ウェブサイトで前(before)にアクセスされたページ, 通常はga:nextPagepathディメンションと共に使用, ga:nextPagePath, ウェブサイトで後(after)にアクセスされたページ, 通常はga:previousPagePathディメンションと共に使用, ga:pageDepth, セッション(訪問)中にユーザーが閲覧したページ数, 値は有効な数値範囲でページビュー数をカウントするヒストグラム, この計算ですべての訪問には少なくとも1つのページビューがあり、訪問の一部にはさらに多くのページビューがある

サイト内検索, ga:searchUsed, ga:searchKeyword, ga:searchKeywordRefinement, ga:searchCategory, ga:searchStartPage, ga:searchDestinationPage

イベントトラッキング, ga:eventCategory, イベントのカテゴリ, ga:eventAction, イベントのアクション, ga:eventLabel, イベントのラベル

eコマース, ga:transactionId, eコマーストラッキングメソッドで取得したショッピングカートのトランザクションID, ga:affiliation, 通常、供給元や実店舗の場所(商品アフィリエーション)の指定に使用, ga:visitsToTransaction, ユーザーがキャンペーン経由でサイトを訪れてから購入に至るまでの訪問数, ga:daysToTransaction, ユーザーがサイトを訪れてから購入に至るまでの日数, ga:productCategory, eコマースアプリケーションで提供された購入アイテムの製品パターン(サイズ、色), ga:productName, eコマーストラッキングアプリケーションで取得した購入アイテムの商品名, ga:productSku, eコマーストラッキングアプリケーションで定義した購入アイテムの商品コード

カスタム変数

時間, ga:date, 訪問した日付, YYYYMMDD形式の整数, ga:year, 訪問した年, 2005年から今年までの4桁の年, ga:month, 訪問した月, 01~12の2桁の整数, ga:week, 訪問した週, 01~53の2桁の数値, 週は日曜日から始まる, ga:day, 日にち, 01~31の2桁の数値, ga:hour, アカウントに設定されたタイムゾーンにおける00~23の2桁の時刻, この値は夏時間に関するすべてのローカルルールに従い、夏時間を反映して修正される, タイムゾーンに夏時間が適用される場合、毎年その日のその時間が繰り返される切り替え時間中(1:00~2:00など)のアクセス数が急増する, 逆に切り替え時には対応する期間中のアクセス数がゼロになる(Googleアナリティクスでは時間単位以上の精度でユーザータイムをトラッキングしない), ga:nthMonth, 指定した期間内の月ごとのインデックス, 期間の最初の月のインデックスは0、2番目の月は1のように続く, このインデックスはエントリga:monthに対応, ga:nthWeek, 指定した期間内の週ごとのインデックス, 期間の最初の週のインデックスは0、2番目の週は1のように続く, このインデックスはエントリga:weekに対応, ga:nthDay, 指定した期間内の日ごとのインデックス, 期間の最初の日(開始日)のインデックスは0、2日目は1のように続く, ga:dayOfWeek, 曜日, 0~6(日曜日~土曜日)の1桁の数値

Metrics 指標

ユーザー, ga:visitors, リクエストした期間にウェブサイトにアクセスしたユーザーの合計数, ga:newVisits, ウェブサイトを初めて訪問したと検出されたユーザーの数, ga:percentVewVisits, 初めてサイトを訪問したユーザーの割合, (ga:newVisits / ga:visits) * 100

セッション, ga:visits, 選択したディメンションでの訪問の合計数, 訪問は単一ユーザーのセッションで構成, ga:timeOnSite, ユーザーセッションの合計時間(秒), XMLで返される値は1つの文字列で、この値はdouble、float、long、stringなど、クライアントライブラリによって異なる方で表される, ga:avgTimeOnSite, ユーザーセッションの平均時間(秒), ga:visitLength / ga:visits

キャンペーン, ga:organicSearches, セッション中に行われたオーガニック検索の回数, この指標は検索エンジンの種類を問わない

AdWords

目標, 注:, APIでは20個の目標を使用できる, 目標値は1~20の対応する番号を使用してリクエストできる, たとえば、目標3の目標開始数を取得する場合はga:goal3Startsを使用する, ga:goal(n)Starts, リクエストされた目標番号の合計開始数, ga:goalStartsAll, プロファイルで定義されたすべての目標の合計開始数, ga:goal(n)Completions, リクエストされた目標番号の合計完了数, ga:goalCompletionsAll, プロファイルで定義されたすべての目標の合計完了数, ga:goal(n)Value, リクエストされた目標番号の合計数値, ga:goalValueAll, プロファイルで定義されたすべての目標の合計数値, ga:goalValuePerVisit, 1回のサイト訪問の平均目標値, ga:goalValueAll / ga:visits, ga:goal(n)ConversionRate, リクエストされた目標番号のコンバージョンを達成した訪問数の割合, (ga:goal(n)Completions / ga:visits) * 100, ga:goalConversionRateAll, 少なくとも1つの目標のコンバージョンを達成した訪問数の割合, (ga:goalCompletionsAll / ga:visits) * 100, ga:goal(n)Abandons, リクエストした目標番号のコンバージョンプロセスを開始したユーザーが達成に至らなかった回数, ga:goal(n)Starts - ga:goal(n)Completions, ga:goalAbandonsAll, 目標のコンバージョンプロセスを開始したユーザーが達成に至らなかった全体の回数, ga:goalStartsAll - ga:goalCompletions, ga:goal(n)AbandonRate, リクエストした目標番号の目標到達プロセスが途中で放棄された割合, ((ga:goal(n)Starts - ga:goal(n)Completions) / ga:goal(n)Starts) * 100, ga:goalAbandonRateAll, 目標到達プロセスが途中で放棄された割合, ((ga:goalStartsAll - ga:goalCompletionsAll) / ga:goalStartsAll) * 100

ページトラッキング, ga:entrances, ウェブサイトの閲覧開始数, この値をウェブサイト全体で集計した場合は訪問数と同じになるが、通常はga:landingPagePathと共に使用される, ga:entranceRate, このページが閲覧開始ページだったページビューの割合, (ga:entrances / ga:pageviews) * 100, ga:bounces, ウェブサイトを1ページ(または1イベント)のみ閲覧したセッションの合計数, ga:entranceBounceRate, 1ページだけを閲覧した訪問(ランディングページでサイトを離脱した訪問)の割合, (ga:bounces / ga:entrances) * 100, ga:visitBounceRate, 1ページだけ閲覧した訪問(最初のページでサイトを離脱した訪問)の割合, (ga:bounces / ga:visits) * 100, ga:pageviews, ウェブサイトの合計ページビュー数, ga:pageviewsPerVisit, サイトの訪問中に閲覧された平均ページ数, 同じページが繰り返し表示された場合もカウントされる, ga:pageviews / ga:visits, ga:uniquePageviews, 1回の訪問中に閲覧された異なる(ユニーク)ページの数をすべての訪問で合計した数, ga:timeOnPage, ユーザーが特定のページを閲覧した時間, 時間は、そのページの閲覧を開始した時刻を次のページの閲覧開始時刻から差し引いて計算される, そのため、ウェブサイトの離脱ページには適用されない, この指標の値は文字列としてXMLで返され、値は秒数で表される, クライアントライブラリにより、double、float、long、stringなど、この値の表現方法が異なる, ga:avgTimeOnPage, ユーザーがこのページ(または特定の複数ページ)を閲覧した平均時間, ga:timeOnPage / (ga:pageviews - ga:exits), ga:exits, ウェブサイトからの離脱回数, 閲覧開始数と同様に、ウェブサイト全体で集計した場合は訪問数と同じになる, ga:exitRate, 全ページビューの中でサイトん離脱が発生した割合, (ga:exits / ga:pageviews) * 100, ga:pageLoadSample, 特定の期間にページの読み込み時間が計測された回数, ga:pageLoadTime, 特定の期間におけるページの合計読み込み時間(ミリ秒), ga:avgpageLoadTime, このページの平均読み込み時間(秒単位), ga:pageLoadTime / (ga:pageLoadSample * 1000)

サイト内検索

イベントトラッキング, ga:totalEvents, すべてのカテゴリにおけるプロファイルの合計イベント数, ga:uniqueEvents, すべてのカテゴリにおけるプロファイルのユニークイベントの合計数, ga:eventValue, プロファイルのイベント合計数, ga:avgEventValue, イベントの平均値, ga:eventValue / ga:totalEvents, ga:visitsWithEvent, イベントが発生した訪問数の合計, ga:eventsPerVisitWithEvent, イベントが発生した訪問あたりの平均イベント数, ga:totalEvents / ga:visitsWithEvent

eコマース, ga:transactions, トランザクションの合計数, ga:transactionsPerVisit, 1回のサイト訪問あたりの平均トランザクション数, ga:transactions / ga:visits, ga:transactionsRevenue, トランザクションの合計売上収益額(配送料と税金を除く), 詳細, ga:revenuePerTransaction, eコマーストランザクションの平均収益額, ga:transactionRevenue / ga:transactions, ga:transactionRevenueVisit, 1回のサイト訪問あたりの平均トランザクション収益額, ga:trasactionRevenue / ga:visits, ga:transactionShipping, 配送料の合計, ga:transactionTax, 税額合計, ga:totalValue, サイトの合計値(合計収益額と合計目標値を含む), ga:transactionRevenue + ga:goalValueAll, ga:itemQuantity, 購入したアイテムの合計数, たとえば、ユーザーが2個のフリスビーと5個のテニスボールを購入した場合、7個のアイテムが購入されたことになる, ga:uniquePurchases, 購入された商品セットの数, たとえば、サイトで2個のフリスビーと5個のテニスボールが購入された場合、2つの個別の商品が購入されたことになる, ga:revenuePerItem, アイテムあたりの平均収益額, ga:itemRevenue / ga:itemQuantity, ga:itemRevenue, ウェブサイトで購入された商品アイテムの合計収益額, 詳細, ga:itemPerPurchase, 1回の購入あたりのアイテム(またはアイテムグループ)の平均販売数, ga:itemQuantity / ga:uniquePurchases

Data Export API - 一般的なクエリ

一般的なクエリ

特定期間のユーザー数とページビュー数

モバイルトラフィック

収益創出キャンペーン

ユーザー

新規ユーザーとリピーター

国別のユーザー

ブラウザとオペレーティング・システム

サイト滞在時間

トラフィック

すべてのトラフィック-利用状況

すべてのトラフィック-目標

全てのトラフィック-eコマース

参照元サイト

検索エンジン

検索エンジン-オーガニック検索

検索エンジン-有料の検索

キーワード

コンテンツ

上位のコンテンツ

上位リンク先ページ

離脱ページ

サイト内検索-検索キーワード

トラッキング コード: e コマース

GATC eコマースメソッド

_addItem( orderId, sku, name, category, price, quantity )

_addTrans( orderId, affiliation, total, tax, shipping, city, state, country )

_trackTrans()

メソッドの詳細

_addItem(), eコマースサイトのユーザーが購入したアイテムをトラッキングする, このメソッドはSKUで個々のアイテムをトラッキングする, skuパラメータが必須。orderId引数を使用して親トランザクションオブジェクトにアイテムを関連付ける, このメソッドの引数は位置で照合されるので、値のないパラメータであっても、すべてのパラメータを指定する, このメソッドは、数量計算などの他の計算は実行しない, 以下のベストプラクティスを念頭に置く, お持ちのソフトウェアで数量を計算する, 同一セッションで、追加された重複アイテム(SKUが同じ)は数量計算に影響しない, 同一セッションで、同じSKUが付けられている2つのアイテムを追加した場合、1番目のアイテムの情報は2番目のアイテムの情報と置き換えられる, 広告枠の各アイテムに固有のSKUが付けられていることを確認, 広告枠内の異なるアイテムに同じSKUが付けられ、ユーザーが両方のアイテムを購入すると、 最後に追加されたアイテムのデータのみが返される, 必ず、追加するアイテムの親トランザクションオブジェクトを設定する, 追加されたアイテムの親トランザクションオブジェクトが存在しないと、そのアイテムは、代わりに空トランザクションオブジェクトに関連付けられる, 親トランザクションオブジェクトなしでアイテムを追加しても、その商品はSKU付きでレポートに表示されますが、 そのSKUはどのトランザクションにも関連付けられていない, 必ずnameパラメータの値を指定する, nameパラメータが必要でない場合、nameパラメータなしでトランザクションに追加されたアイテムはそのトランザクションの商品明細に表示されない, トランザクションの総収益を見ているかぎり、特定のアイテムがトランザクション合計額にどの程度貢献しているのかを知ることはできない, パラメータ, orderId, オプション, String, アイテムに関連付ける、トランザクションの注文ID, sku, 必須, String, アイテムのSKUコード, name, オプション, String, 商品名, 商品詳細レポート内のデータを見るときは必須, category, オプション, String, 商品カテゴリ, price, 必須, String, 商品価格, quantity, 必須, String, 購入数

_addTrans(), 指定した値でトランザクションオブジェクトを作成, このメソッドはトランザクショントラッキングのみ処理し、その他のeコマース機能は提供しない, トランザクションがそのセッションの既存のトランザクションの複製である場合、 古いトランザクションの値は新しいトランザクションの値で上書きされる, このメソッドの引数は位置で照合されるので、値のないパラメータであっても、すべてのパラメータを指定する, パラメータ, orderId, 必須, String, このトランザクション固有の内部注文ID番号, afiliation, オプション, String, 提供パートナーまたはアフィリエーションストア(指定しないと不定), total, 必須, String, トランザクションの合計額(米ドル), tax, オプション, String, トランザクションの税額, shipping, オプション, String, トランザクションの配送料, city, オプション, String, トランザクションと関連付ける市区町村, state, オプション, String, トランザクションと関連付ける都道府県, country, オプション, String, トランザクションと関連付ける国

_trackTrans(), Google Analyticsサーバーにトランザクションとアイテムデータの両方を送信する, このメソッドを_trackPageview()の後に呼び出して、_addItem()メソッドと_addTrans()メソッドと一緒に使用する, このメソッドは、アイテムとトランザクション要素を設定した後に呼び出す

Data API - データ フィード

概要

アナリティクスレポートのカテゴリ, ユーザー, トラフィック, コンテンツ, サイト内検索, 目標, eコマース

指標とディメンションの2つの主要フィールドから構成される

すべてのカテゴリのデータを1つのリクエストに組み合わせることはできない

許可されていないディメンションと指標の組み合わせをリクエストすると、 実際のフィールドの代わりにエラーが返される

データフィードリクエスト

データを取得するプロファイルのテーブルIDを指定し、 ディメンションと指標の組み合わせを選択し、 クエリ文字列にデータ範囲とその他のパラメータを指定

ベースURL, https://www.google.com/analytics/feeds/data, 必須, データフィードリクエストのベースURL

ids, ids=ga:123456, 必須, アナリティクスレポートデータの取得に使用する固有のテーブルID, アカウントフィードの各エントリに対して<ga:tableId>要素により提供される

dimensions, dimensions=ga:source,ga:medium, オプション, dimensionsパラメータにはアナリティクスレポートのメインデータキーを定義する, ウェブプロパティの指標を分割するには、ディメンションを使用する, フィードリクエストにディメンションを使用する場合の制限, クエリにはディメンションを7つまで指定できる, ディメンションのみで構成されるクエリを送信することはできない, リクエストするディメンションには、少なくとも1つの指標を組み合わせる必要がある, あらゆるディメンションは、他のディメンションまたは指標とともに使用できる, ディメンションとの有効な組み合わせである場合に限られる

metrics, metrics=ga:visits.ga:bounces, 必須, クリックやページビューなど、プロファイル内のユーザー行動について集計した統計情報, 指標を単独でクエリすると、全体ページビュー数や合計直帰数など、リクエストしたデータはニノ集計値が得られる, ディメンションと共にリクエストした場合は、値がディメンション別に分割される, 指標をリクエストする場合の注意点, ディメンションのみではリクエストを構成できないため、少なくとも1つの指標を指定する必要がある, クエリには指標を10コマで指定できる, ディメンションを指定していない限り、ほとんどのカテゴリの指標を組み合わせて指定することができる, Data Export APIでは計算された指標が得られないため、指標の値は常に集計値としてレポートされる

sort, sort=ga:visits, オプション, 返されたデータの並べ替え順と方向を示す, sort=ga:browser,ga:pageviews, クエリに並べ替え順を指定しないと、データはリストされている順序で左から右にディメンションによって並べ替えられる, dimensions=ga:country,ga:browser, 最初にga:countryで、次にga:browserで並べ替えられる, sortパラメータの使用の注意点, dimennsionsまたはmetricsパラメータで使用したディメンションまたは指標の値のみで並べ替える, dimensionsまたはmetricsパラメータに示されていないフィールドでの並べかえをリクエストすると、リクエストエラーが返される, en-USの言語/地域では、文字列が昇順のアルファベット順に並べ替えられる, 数字は昇順に並べ替えられる, 日付は昇順に並べ替えられる, 並べ替え方向は、リクエストしたフィールドの前にマイナス記号(-)をつけることによって昇順から降順に変更できる, sort=-ga:pageviews,ga:browser, 最初にga:pageviewsで降順に並べ替え、次にga:browserで昇順に並べ替えられる

filters, filters=ga:medium%3D%3Dreferral, オプション, filtersクエリ文字列パラメータは、リクエストからアナリティクスサーバーに返されるデータを制限する, filtersパラメータを使用する場合、フィルタするディメンションまたは指標に続けてフィルタ式を指定する, https://www.google.com/analytics/feeds/data ?ids=ga:12134 &dimensions=ga:browser&metrics=ga:pageviews &filters=ga:browser%3D~%5EFirefox &start-date=2007-01-01 &end-date=2007-12-31, フィルタされたクエリでは、結果に含める(または含めない)行が制限される, 結果の各行はフィルタに対してテストされる, フィルタが一致すると行が維持され、一致しないと行が削除される, URLエンコード, Javaクライアントライブラリによってフィルタ演算子が自動的にエンコードされる, JavaScriptクライアントライブラリを使用するか、プロトコルに対してリクエストを直接行う場合、フィルタ演算子を明示的にエンコードする必要がある, ディメンションのフィルタ, フィルタはディメンションの集計前に行われるため、返される指標には該当するディメンションのみの合計が示される, 指標のフィルタ, 指標のフィルタは指標の集計後に行われる, 有効な組み合わせ, リクエスト内のすべてのディメンション/指標とフィルタが有効な組み合わせである限り、 クエリに含まれないディメンションまたは指標をフィルタすることができる, 特定のブラウザでフィルタした日付付きのページビューリストをクエリすることができる, フィルタ構文, 1つのフィルタの形式, ga:name operator expression, name, フィルタするディメンションまたは指標の名前, operator, 使用するフィルタの一致タイプを定義する, 演算子はディメンションまたは指標に固有, expression, 結果に含める値か、結果から除外する値を指定する, 式には正規表現構文を使用する, フィルタ演算子, ディメンションと指標にはそれぞれ6種類のフィルタ演算子がある, 演算子をURLクエリ文字列に含めるには URLエンコードする必要がある, 指標のフィルタ, 演算子, 説明, URLエンコードした形式, 例, ==, 次と等しい, %3D%3D, ページ閲覧時間がちょうど10秒である結果を返す, filters=ga:timeOnPage%3D%3D10, !=, 等しくない, !%3D, ページ閲覧時間が10秒以外である結果を返す, filters=ga:timeOnPage!%3D, >, 次を上回る, %3E, ページ閲覧時間が10秒を超える結果を返す, filters=ga:timeOnPage%3E10, <, 次を下回る, %3C, ページ閲覧時間が10秒未満である結果を返す, filters=ga:timeOnPage%3C10, >=, 以上, %3E%3D, ページ閲覧時間が10秒以上である結果を返す, filters=ga:timeOnPage%3E%3D10, <=, 以下, %3C%3D, ページ閲覧時間が10秒以下である結果を返す, ディメンションのフィルタ, 演算子, 説明, URLエンコードした形式, 例, ==, 完全一致, %3D%3D, 都市がIrvineである指標を集計, filters=ga:city%3D%3DIrvine, !=, 一致しない, !%3D, 都市がIrvine以外である指標を集計する, filters=ga:city!%3DIrvine, =@, サブストリングを含む, %3D@, 都市にYorkが含まれる指標を集計する, filters=ga:city%3D@York, !@, サブストリングを含まない, !@, 都市にYorkが含まれない指標を集計する, filters=ga:city!@York, =~, 正規表現の一致を含む, %3D~, 都市がNewから始まる指標を集計する, filters=ga:city%3D~%5ENew.*, (%5Eは、パターンを文字列の先頭に固定する^文字をURLエンコードした形式), !~, 正規表現に一致しない, !~, 都市がNewで始まらない指標を集計する, filters=ga:city!~%5ENew.*, フィルタ式, URL予約文字, &などの文字は、通常どおり%でURLエンコードする必要がある, 予約文字, セミコロン、カンマ、バックスラッシュを式に含める場合は、 すべてバックスラッシュでエスケープ処理する必要がある, 正規表現, フィルタ式では=~や!~演算子を使用して正規表現も使用できる, 正規表現の構文はPerl正規表現と似ているが、次の規則が追加で適用される, 最大文字数128文字, 128文字を超える正規表現は、サーバーから400 Bad Request ステータスコードが返される, 大文字と小文字の区別, 正規表現一致では大文字と小文字は区別されない, フィルタの組み合わせ, フィルタはORとANDのブール論理を使用して結合できる, フィルタ式の128文字制限を事実上拡張できる, OR, OR演算子にはカンマ(,)を使用する, OR演算子はAND演算子より優先される, 同じ式でディメンションと指標の組み合わせにOR演算子を使用することはできない, AND, AND演算子にはセミコロン(;)を使用する, AND演算子よりOR演算子が優先される, 同じ式でディメンションと指標の組み合わせにAND演算子を使用する

segment, segment=gaid::10, segment=dynamic::ga:medium%3D%3Dreferral, オプション, (1)デフォルトまたはカスタムのアドバンスセグメントの数値ID, アカウントフィードにより、すべてのデフォルトアドバンスセグメント及びそのIDと、 アカウントに定義されているすべてのカスタムセグメントが返されます, (2)クエリのdynamicパラメータ, このメソッドを使用して、1つ以上のディメンションや指標でデータリクエストをセグメント化する, セグメントには、正規表現をfiltersパラメータと同様に使用することもできる, セグメントに使用できないディメンションと指標, 使用できないセグメントのディメンション, ga:adDistributionNetwork ga:adMatchType ga:adMatchedQuery ga:adPlacementDomain ga:adPlacementUrl ga:adFormat ga:adTargetingType ga:adTargetingOption ga:adDisplayUrl ga:adDestinationUrl ga:adwordsCustomerId ga:adwordsCampaignId ga:adwordsAdGroupId ga:adwordsCreativeId ga:adwordsCriteriaId ga:latitude ga:longitude ga:secondPagePath ga:previousPagePath ga:nextPagePath ga:searchStartPage ga:searchDestinationPage ga:transactionId ga:date ga:year ga:month ga:week ga:day ga:nthMonth ga:nthWeek ga:nthDay ga:dayOfWeek, 使用できないセグメントの指標, 計算に基づくすべての指標 ga:visitors ga:organicSearches ga:impressions ga:adClicks ga:adCost ga:searchResultViews ga:uniqueEvents

start-date, start-date=2011-08-30, 必須, すべてのアナリティクスフィードリクエストには、開始日と終了日の範囲を指定する必要がある, リクエストに開始日と終了日の値を指定しないと、サーバーからリクエストエラーが返される, 日付けの値にはYYYY-MM-DDの形式を使用, 有効な開始日は2005-01-01以降, 開始日に上限はないが、かなり先の開始日を設定すると、空の結果が返される可能性が高くなる

end-date, end-date=2011-08-30, 必須, すべてのアナリティクスフィードリクエストには、開始日と終了日の範囲を指定する必要がある, リクエストに開始日と終了日の値を指定しないと、サーバーからリクエストエラーが返される, 日付けの値にはYYYY-MM-DDの形式を使用, 有効な終了日は2005-01-01以降, 終了日に上限はないが、かなり先の終了日を設定すると、空の結果が返される可能性が高くなる

start-indexパラメータ, start-index=10, オプション, 開始インデックスを指定しないと1, totalResultsが10,000件を超え、インデックス10,001以上のエントリを取得したい場合には、 max-resultsパラメータと共にこのパラメータを改ページメカニズムとして使用する

max-resultsパラメータ, max-results=100, オプション, このフィードに含める最大エントリ数, 一部の要素を取得するには、これをstart-indexと組み合わせて使用する, 先頭から始まって返される要素の数を制限するには、単独で使用する, クエリにmax-resultsパラメータを使用しないと、デフォルトでフィードから最大1000個のエントリが返される, Analytics Data Export APIでは、リクエストした数に関係なく、リクエストにつき最大10,000個のエントリが返される, ディメンションのセグメントが予想より少ない場合は、リクエストしたよりも少ないエントリが返される場合がある

vパラメータ, v=2, オプション, このフィードのメジャーバージョンは1と2

prettyprintパラメータ, prettyprint=true, オプション, フィードのXMLに空白を追加して、読みやすくする, 個のパラメータはtrueまたはfalseに設定できる, デフォルトはfalse, フィードレスポンスを直接確認する場合、デバッグ用にこのパラメータを使用する

データフィードレスポンス

データフィード, title, Google Analytics Data for Profileという文字列と選択したプロファイルのID, id, フィードURL, totalResults, クエリに対する結果の合計数, レスポンス内の結果の数とは関係ない, startIndex, エントリの開始インデックス, デフォルトでは1で、それ以外の場合はstart-indexクエリパラメータに指定された数になる, itemsPerPage, 現在のリクエストのアイテム数, 最大値は10,000, dxp:startDate, start-dateクエリパラメータで指定されたクエリの最初の日, dxp:endDate, end-dateクエリパラメータで指定されたクエリの最後の日, この日付も含まれる, dxp:containsSampleData, このレスポンスのエントリにサンプルデータが含まれているかどうかを示すブール値, dxp:aggregates, クエリと一致する各指標の合計値が含まれる, 一部のクエリでは、Googleアナリティクスで1ページに表示できる数より多くの値がAPIによって返されることがある, この場合、結果を改ページする必要がある, 集計された指標の値には、改ページされていないデータの各指標の合計が含まれる, これは、1ページに返される指標の値の合計とは異なる, APIは合計値を返さない, dxp:metric, クエリと一致するすべての指標の合計値を示す指標, name, 指標の名前, value, この指標の改ページされていない値, type, 返される値のタイプ, currency、float、percent、time、us_currency、または未知のタイプに設定できる, 設定しないこともできる, dxp:dataSource, アナリティクスデータソースの概要情報, dxp:tableId, ソースの名前空間を含む固有のプロファイルID, 例) ga:0123456, dxp:tableName, アナリティクス管理UIに表示されるプロファイル名, dxp:property name=ga:profileId, ソースのプロファイルID, 例) 0123456, dxp:property name=ga:webPropertyId, ソースのウェブプロパティID, 例) UA-0123456-1, dxp:property name=ga:accountName, アナリティクスインターフェースに表示されるアカウント名, dxp:segment, dxp:definition, デフォルトおよびカスタムのアドバンスセグメントには、フィードによりセグメントと関連付けられた名前とIDが返される, 動的セグメントには、フィードによりリクエストに含まれる式が返される, 例外を含む、フィードで返されるアドバンスセグメントの詳細は、アカウントフィードのdxp:segmentとdxp:dfinitionを確認, entry, レスポンスの各エントリには次の要素が含まれる, title, &mdashクエリ内のディメンションのリストとそのエントリに一致する結果, dxp:dimension, クエリ内の各ディメンションの1つの要素, name, ディメンションの名前, value, ディメンションの値, dxp:metric, クエリ内の各指標の1つの要素, name, 指標の名前, value, その指標のクエリの集計値, type, 返される値のタイプ, currency、float、percent、time、us_currency、または未知のタイプに設定できる, 設定しないこともできる

データフィードエラーコード

Data Export APIは、リクエストが正常に処理されると200HTTPステータスコードを返す

リクエストにエラーや問題が発生すると、データフィードからエラーの種類に応じたHTTPステータスコードとエラーの原因が返される

注:APIから返される原因の文字列は予告なく変更される場合があるので、 アプリケーションでは原因の文字列に対する照合を行わず、エラーコードのみを参照するようにする

エラーコードと対応する原因, 400 Bad Request, リクエストに関する問題, ディメンションや指標が無効, 数:指標が1つもないか、ディメンションや指標の数が多すぎる, フィルタでORを使用して指標とディメンションを結合している, フィルタかセグメントの構文が無効, ディメンションと指標の組み合わせ、またはアドバンスセグメントが無効, 401 Unauthorized, 認証に関する問題, ユーザー名またはパスワードが無効, 認証トークンが無効, 403 Forbidden, 認証に関する問題, 権限:ユーザーにリクエストしたプロファイルへのアクセス権限がない, プロファイルIDではなくアカウントIDが使用されている, 500 Internal Server Error, リクエストを再発行しないでください, 503 Service Unavailable, サービスに関する問題, X-Google-Commandヘッダーをチェックして、再発行可能かどうか確認, タイムアウト, サーバーエラー, サービスが使用不可, 割り当て量が不十分

サンプリング

Google アナリティクスでは、ディメンションと指標の特定の組み合わせがリアルタイムで計算される

妥当な時間内にデータを返すために、データのサンプルのみが処理される

Data Export APIからのデータがウェブインターフェースと一致しない場合、トップレベルレスポンス要素のcontainsSampledDataを使用して データがサンプリングされたものであるかどうか確認する

大量のデータ結果の処理

クエリから大量の結果が返されることが予想される場合、 APIクエリを最適化し、誤差をさけ、割り当ての超過を最低限に抑えることができる

APIリクエストの最適化の基本レベルは、最大数のディメンション(7)と指標(10)で設定されている

一般的にリクエストする指標の数を制限してもクエリの性能が改善するわけではない

最適化の手法, 改ページ, 結果を改ページすることで、大量の結果を管理しやすいセグメントに分割することができる, データフィードには一致する行の数と、リクエストされた行の一部が表示される, 実際に返される行数に対して一致する合計行数の比率が高い場合、個々のクエリに必要以上の時間がかかっている可能性がある, 日付範囲によるクエリの分割, 1つの長い日付範囲の日付付きの結果を改ページする代わりに、 1週間または1日ごとにクエリを分けることを検討する, 1日のリクエストに、クエリの最大数を超える結果業が含まれる場合など、大量のデータには引き続き結果を改ページすることが必要になる場合がある, いずれの場合も、クエリに一致する行数が最大結果行数を超える場合、 日付範囲を分割することにより回答の合計取得時間を改善できる, クエリが単一スレッドで送られるか、並行して送られるかに関係なくいえること, フィルタの効果的な使用, フィルタを追加することで、引き続き必要な情報を得ながらデータを制限することを検討する, ディメンションのフィルタによって、目的のデータのサブセットを返すことができるか, 値のしきい値(訪問数5回未満の一致を無視するなど)によって、あまり関係ない結果をフィルタすることができるか, 各結果の実際の取得時間はあまり変わりませんが、結果として取得されるページが制限されるため、 全体の操作時間を短縮し、許可された割り当て量に対する影響を最低限に抑えることができる

Data API - アカウント フィード

概要

アカウントフィードリクエスト

アカウントフィードURL, https://www.google.com/analytics/feeds/accounts/default, 必須, アカウントフィードの保護されたURLプレフィックスの後にdefault文字列が付いたもの, この文字列は、認証済みのユーザーがアクセスできるアカウント情報をすべて取得する

start-indexパラメータ, start-index=1, オプション, フィードの開始エントリ, 指定しない場合は、開始エントリは1になる, このパラメータは、max-resultsパラメータと共に改ページメカニズムとして使用する

max-results, max-results=50, オプション, このフィードに含める最大エントリ数, 有効な値の範囲は1~10,000, 一部の要素を取得するには、これをstart-indexと組み合わせて使う, 先頭から始まって返される要素の数を制限するには、単独で使用する, クエリにmax-resultsパラメータを使用しないと、デフォルトでフィードから最大1000個のエントリが返される

vパラメータ, v=2, オプション, このフィードに対してリクエストされたバージョン, このフィードのメジャーバージョンは1と2, バージョンパラメータはトラブルシューティング以外には使用しないことをおすすめ, コードのバージョンを指定する際は、GData-VersionHTTPヘッダーを使用

prettyprint, prettyprint=true, オプション, フィードのXMLに空白を追加して、読みやすくする, パラメータはtrueまたはfalseに設定できる, デフォルトはfalse, フィードレスポンスを直接確認する場合、デバッグ用にこのパラメータを使用する

アカウントフィードレスポンス

アカウントフィード, id, title, totalResults, startIndex, itemsPerPage, dxp:segment id='gaid:XXX' name='XXX', entry, dxp:property name=ga:webPropertyId, dxp:property name=ga:accountName, dxp:property name=ga:accountId, dxp:property name=ga:profileId, dxp:property name=ga:timexone, title, id, dxp:tableId, ga:customVariable index='1' name='myVar' scope='visitor', index, カスタム変数のインデックス, name, カスタム変数の名前, scope, カスタム変数の範囲, ga:goal active='true' name='Completing Order' number='1' value='10.0', active, name, number, value, ga:destination caseSensitive='false' expression='/purchaseComplete.html' matchType='regex' step1Required='false', caseSensitive, expression, matchType, step1Required, ga:step name='View Product Categories' number='1' path='/Apps|Accessories', name, number, path, ga:engagement comparison='&gt;' thresholdValue='300' type='timeOnSite', comparison, thresholdValue, type

アカウントフィードのエラーコード

401 Unauthorized, 認証トークンが無効, 認証されたユーザーのアカウントが見つからない, ユーザーIDが未入力または無効である

500 Internal Server Error, リクエストを再発行しないでください

503 Service Unavailable, X-Google-Commandヘッダーをチェックして、再発行可能かどうか確認する, 割り当て量が不十分, タイムアウト, サーバーエラー, サービスが使用不可である

Data Export API - プロトコル

対象読者

認証

バージョンの指定

GAPI - Google Analytics API PHP Interface

Using the GAPI filter control

example, country == 'United States' && ( browser == 'Firefox' || browser == 'Chrome'), country == 'United States' && browser == 'Firefox' || browser == 'Chrome'

GAPI Operators, &&, And, ||, Or

Metric Filters, ==, Eqials, !=, Not equal, >, Greater than, <, Less than, >=, Greater than or equal to, <=, Less than or equal to

Dimension Filters, ==, 正確な一致, Exact match, !=, 一致していない, Does not match, =~, 正規表現にマッチ, Matches a regular expression, !~, 正規表現に一致しない, Does not match regular expression, =@, 部分文字列が含まれている, Contains substring, !@, 部分文字列が含まれていない, Does not contain substring

Examples, Simple examples, $filter = 'country == United States && browser == Firefox && browserVersion != 3.0.10';, $filter = 'country == United States && visits > 30';, Regular expression examples, $filter = 'country == United States && browser = Firefox && browserversion =~ ^3\.';

Class Documentation

Methods, Google Analytics Report Request, requestReportData( $report_id, $dimensions, $metrics, $sort_metric=null, $filter=null, $start_date=null, $end_date=null, $start_index=1, $max_results=30 ), Attribute 属性, Type(required/optional) タイプ(必須/省略可能), Description 説明, Example 例, $report_id, String, ID of the report you wish to query, 0123456, $dimensions, Array, Google Analytics dimensions, array("browser"), $metrics, Array, Google Analytics metrics, array("pageviews"), $sort_metric, Array(optional), Dimension(s) or metric(s) to sort by. Ascending order default, precede option with '-' for descending order. Use array for combination of parameters., $filter, $start_date, $end_date, $start_index, $max_results, Google Analytics Account Request

参考ページ

Google Analytics Data Export API で簡単に人気記事一覧を作成する方法

GAPI(Google Analytics APIのPHPライブラリ)

ディメンション(Dimensions)・指標(Metrics)・フィルタ(filter)の設定例

トラフィック

コンバージョン

eコマース

Data Feed Query Explorer

インタラクティブなサンプルを試せる