Method: userActivity.search

ユーザー アクティビティ データを返します。

HTTP リクエスト

POST https://analyticsreporting.googleapis.com/v4/userActivity:search

この URL は gRPC Transcoding 構文を使用します。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "dateRange": {
    object(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
フィールド
dateRange

object(DateRange)

ユーザー アクティビティを取得する期間。期間を指定しない場合、デフォルトの期間は（startDate: 現在の日付 - 7 日間、endDate: 現在の日付 - 1 日）になります。

viewId

string

必須。データを取得するアナリティクスのビュー ID。すべての SearchUserActivityRequest に viewId が含まれている必要があります。
user

object(User)

必須。クエリ対象の一意のユーザー ID。すべての SearchUserActivityRequest にこのフィールドが含まれている必要があります。
activityTypes[]

enum(ActivityType)

リクエストされているすべてのアクティビティ タイプのセットです。これらのタイプに一致する設備のみがレスポンスで返されます。空の場合、すべてのアクティビティが返されます。
pageSize

number

ページサイズは、ページングを設定するためのもので、返される最大行数を指定します。ページサイズは 0 より大きくする必要があります。値が 0 の場合、またはフィールドが指定されていない場合、リクエストはデフォルトの 1 ページあたり 1, 000 行を返します。
pageToken

string

結果の次のページを取得するための連続トークン。これをリクエストに追加すると、pageToken の後の行が返されます。pageToken は、SearchUserActivityRequest リクエストに対するレスポンスの nextPageToken パラメータで返される値です。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

userActivity:get 呼び出しからのレスポンス。

JSON 表現 
{
  "sessions": [
    {
      object(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
フィールド
sessions[]

object(UserActivitySession)

各レコードはセッションを表します（デバイスの詳細、継続時間など）。
totalRows

number

このクエリによって返された合計行数（複数ページにわたる）。

nextPageToken

string

次のページを取得するには、このトークンを SearchUserActivityRequest に渡す必要があります。
sampleRate

number

このフィールドは、指定されたリクエストのサンプリング レートを表し、0.0 ～ 1.0 の数字で示されます。詳しくは、デベロッパー ガイドをご覧ください。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

ユーザー

特定のユーザーを一意に識別するための情報が含まれています。

JSON 表現 
{
  "type": enum(UserIdType),
  "userId": string
}
フィールド
type

enum(UserIdType)

リクエストに含まれるユーザーのタイプ。フィールド userId は、このタイプに関連付けられています。
userId

string

データがリクエストされているユーザーの一意の ID。

UserIdType

利用可能なさまざまなタイプのユーザー ID を表します。

列挙型
USER_ID_TYPE_UNSPECIFIED ユーザー ID の種類を指定しないと、デフォルトで CLIENT_ID が使用されます。
USER_ID 1 つ以上のデバイスやブラウザのインスタンスからコンテンツを利用する可能性がある 1 人のユーザーです（アカウントにログインしているユーザーなど）。
CLIENT_ID アナリティクスによって割り当てられた clientId。

ActivityType

列挙型
ACTIVITY_TYPE_UNSPECIFIED ActivityType には、レスポンスにこの値が含まれることはありません。リクエストでこのタイプを使用すると、エラーが発生します。
PAGEVIEW ユーザーがページを閲覧した結果としてアクティビティが発生した場合に使用されます。
SCREENVIEW 訪問者がモバイル デバイスでアプリケーションを使用した結果としてアクティビティが発生した場合に使用されます。
GOAL 目標タイプのアクティビティを示すために使用します。
ECOMMERCE ページの訪問者によって e コマース トランザクションが実行されました。
EVENT アクティビティがイベントの場合に使用されます。

UserActivitySession

これは、一定期間に特定の時間に特定のデバイスで実行されたユーザー セッションを表します。

JSON 表現 
{
  "sessionId": string,
  "deviceCategory": string,
  "platform": string,
  "dataSource": string,
  "activities": [
    {
      object(Activity)
    }
  ],
  "sessionDate": string
}
フィールド
sessionId

string

セッションの一意の ID。

deviceCategory

string

使用するデバイスの種類: 「モバイル」、「タブレット」など。

platform

string

アクティビティが発生したプラットフォーム（「android」、「ios」など）。

dataSource

string

ヒットのデータソース。デフォルトでは、analytics.js から送信されたヒットは「web」としてレポートされ、モバイル SDK から送信されたヒットは「app」としてレポートされます。これらの値は Measurement Protocol でオーバーライドできます。

activities[]

object(Activity)

このセッションの各アクティビティの詳細ビューを表します。

sessionDate

string

このセッションの日付（ISO-8601 形式）。

アクティビティ

Activity は、ユーザーのアクティビティのデータを表します。アクティビティはヒットとは異なります。1 回のヒットで複数の Activity が生じる場合があります。たとえば、ヒットにトランザクションと目標の完了が含まれている場合、このヒットには 2 つの Activity プロトコル（ECOMMERCE と GOAL の 1 つ）が存在します。逆に、複数のヒットから 1 つの Activity を作成することもできます。従来の e コマースでは、1 回の取引のデータが複数のヒットを介して送信されることがあります。これらのヒットは 1 つの ECOMMERCE アクティビティに統合されます。

JSON 表現 
{
  "activityTime": string,
  "source": string,
  "medium": string,
  "channelGrouping": string,
  "campaign": string,
  "keyword": string,
  "hostname": string,
  "landingPagePath": string,
  "activityType": enum(ActivityType),
  "customDimension": [
    {
      object(CustomDimension)
    }
  ],

  // Union field activity_details can be only one of the following:
  "pageview": {
    object(PageviewData)
  },
  "appview": {
    object(ScreenviewData)
  },
  "ecommerce": {
    object(EcommerceData)
  },
  "goals": {
    object(GoalSetData)
  },
  "event": {
    object(EventData)
  }
  // End of list of possible types for union field activity_details.
}
フィールド
activityTime

string (Timestamp format)

アクティビティのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒例: "2014-10-02T15:01:23.045123456Z"。
source

string

参照元サイトの参照元。手動でのキャンペーン トラッキングの場合は、utm_source キャンペーン トラッキング パラメータの値です。AdWords の自動タグ設定の場合は「google」となります。どちらも使用しない場合は、ユーザーを参照するソースのドメイン（例: document.referrer）になります。ポートアドレスが含まれる場合もあります。ユーザーが参照 URL なしで訪問した場合、その値は (direct) になります。

medium

string

参照元サイトの種類。手動でのキャンペーン トラッキングの場合は、utm_medium キャンペーン トラッキング パラメータの値です。AdWords の自動タグ設定の場合、クリック単価です。Google アナリティクスが検出した検索エンジンからのユーザーの場合はオーガニック検索結果です。参照元が検索エンジンでない場合は、参照です。ユーザーがプロパティに直接アクセスして、document.referrer が空の場合、値は (none) になります。

channelGrouping

string

このビューでエンドユーザーのセッションに関連付けられたチャネル グループ（ビューのチャネル グループで定義）。

campaign

string

手動でのキャンペーン トラッキングの場合は、utm_campaign キャンペーン トラッキング パラメータの値です。AdWords の自動タグ設定の場合、これはプロパティで使用するオンライン広告キャンペーンの名前です。どちらも使用しない場合、値は (not set) になります。
keyword

string

手動でのキャンペーン トラッキングの場合は、utm_term キャンペーン トラッキング パラメータの値になります。AdWords トラフィックの場合は、最も一致するターゲティング条件が含まれます。ディスプレイ ネットワークでは、複数のターゲティング条件が原因で広告が表示された場合に、Google 広告で選択された、最も一致するターゲティング条件が返されます。display_keyword、site プレースメント、boomuserlist、user_interest、age、gender などがこれに該当します。それ以外の場合、値は (not set) になります。
hostname

string

トラッキング リクエストが行われたホスト名。

landingPagePath

string

ユーザー セッションの最初のページ、またはランディング ページ。

activityType

enum(ActivityType)

このアクティビティのタイプ。

customDimension[]

object(CustomDimension)

このアクティビティに関連付けられているすべてのカスタム ディメンションのリスト。

共用体フィールド activity_details。activity_type に応じて、次のいずれかのフィールドが設定されます。activity_details は次のいずれかになります。
pageview

object(PageviewData)

これは、activityType が PAGEVIEW と等しい場合に設定されます。このフィールドには、ユーザーおよび訪問したページに関するすべての詳細情報が含まれます。
appview

object(ScreenviewData)

これは、activityType が SCREEN_VIEW と等しい場合に設定されます。
ecommerce

object(EcommerceData)

これは、activityType が ECOMMERCE と等しい場合に設定されます。
goals

object(GoalSetData)

このフィールドには、activityType が GOAL と等しい場合に、このアクティビティで達成されたすべての目標のリストが含まれます。
event

object(EventData)

このフィールドにはイベントに関するすべての詳細情報が含まれ、activityType が EVENT と等しい場合に設定されます。

CustomDimension

カスタム ディメンション。

JSON 表現 
{
  "index": number,
  "value": string
}
フィールド
index

number

カスタム ディメンションのスロット番号。

value

string

カスタム ディメンションの値。デフォルト値（空の文字列）は、セッション/訪問者スコープのカスタム ディメンション値をクリアします。

PageviewData

ユーザーがページを表示したときに収集された詳細を表します。

JSON 表現 
{
  "pagePath": string,
  "pageTitle": string
}
フィールド
pagePath

string

ユーザーが閲覧したページの URL。

pageTitle

string

訪問者が閲覧したページのタイトル。

ScreenviewData

JSON 表現 
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
フィールド
screenName

string

スクリーンの名前。
mobileDeviceBranding

string

モバイル メーカーまたはブランド名。例: 「Google」、「Apple」など。

mobileDeviceModel

string

モバイル デバイスのモデル。例: 「Pixel」、「iPhone」など。

appName

string

アプリケーション名。

EcommerceData

ユーザー アクションに関連付けられた e コマースの詳細情報。

JSON 表現 
{
  "actionType": enum(ECommerceAction),
  "transaction": {
    object(TransactionData)
  },
  "products": [
    {
      object(ProductData)
    }
  ],
  "ecommerceType": enum(EcommerceType)
}
フィールド
actionType

enum(ECommerceAction)

この e コマース アクションに関連付けられているアクション。

transaction

object(TransactionData)

この e コマース アクションのトランザクションの詳細。

products[]

object(ProductData)

このトランザクションの商品の詳細。
ecommerceType

enum(EcommerceType)

この e コマース アクティビティのタイプ。

ECommerceAction

e コマース アクションに関連付けられているすべてのアクションのセット。

列挙型
UNKNOWN アクション タイプが不明です。
CLICK 商品リストのクリックスルー。
DETAILS_VIEW 商品の詳細ビュー。
ADD_TO_CART カートに商品を追加します。
REMOVE_FROM_CART カートから商品を削除します。
CHECKOUT チェックアウトします。
PAYMENT 購入が完了しました。
REFUND 購入の払い戻し。
CHECKOUT_OPTION 決済オプション。

TransactionData

訪問者がページでトランザクションを実行したときに収集された詳細を表します。

JSON 表現 
{
  "transactionId": string,
  "transactionRevenue": number,
  "transactionTax": number,
  "transactionShipping": number
}
フィールド
transactionId

string

e コマース トラッキング メソッドによって提供される、ショッピング カートでの購入の取引 ID。

transactionRevenue

number

トランザクションの合計販売収益（送料と税金を除く）。

transactionTax

number

トランザクションの合計税額。

transactionShipping

number

送料の合計。

ProductData

e コマース トランザクションの商品の詳細。

JSON 表現 
{
  "productSku": string,
  "productName": string,
  "itemRevenue": number,
  "productQuantity": string
}
フィールド
productSku

string

商品を表す一意のコード。

productName

string

e コマース トラッキング アプリケーションによって提供される、購入された商品アイテムの商品名。
itemRevenue

number

購入された商品アイテムからの合計収益。

productQuantity

string (int64 format)

トランザクションにおけるこの商品ユニットの合計数。

EcommerceType

返される e コマースデータの種類を表します。

列挙型
ECOMMERCE_TYPE_UNSPECIFIED e コマース アクティビティ タイプが指定されていない場合に使用されます。
CLASSIC アクティビティに従来の（拡張されていない）e コマース情報がある場合に使用します。
ENHANCED アクティビティに拡張 e コマース情報がある場合に使用されます。

GoalSetData

アクティビティで達成された一連の目標を表します。

JSON 表現 
{
  "goals": [
    {
      object(GoalData)
    }
  ]
}
フィールド
goals[]

object(GoalData)

現在のアクティビティで達成されたすべての目標。

GoalData

目標に関するすべての詳細を表します。

JSON 表現 
{
  "goalIndex": number,
  "goalCompletions": string,
  "goalValue": number,
  "goalCompletionLocation": string,
  "goalPreviousStep1": string,
  "goalPreviousStep2": string,
  "goalPreviousStep3": string,
  "goalName": string
}
フィールド
goalIndex

number

プロファイルに設定された目標を示します。

goalCompletions

string (int64 format)

このアクティビティでの目標完了の合計数。

goalValue

number

この目標の値。

goalCompletionLocation

string

この目標を達成したページの URL。

goalPreviousStep1

string

目標完了の 1 ステップ前のページの URL。

goalPreviousStep2

string

目標完了の 2 ステップ前のページの URL。

goalPreviousStep3

string

目標完了の 3 ステップ前のページの URL。

goalName

string

目標の名前。

EventData

イベントに関するすべての詳細を表します。

JSON 表現 
{
  "eventCategory": string,
  "eventAction": string,
  "eventLabel": string,
  "eventValue": string,
  "eventCount": string
}
フィールド
eventCategory

string

操作されたページ上のオブジェクト。例: 「動画」。
eventAction

string

オブジェクトの操作のタイプ。例: 「play」。
eventLabel

string

イベントに添付されるラベル。

eventValue

string (int64 format)

イベントに関連付けられた数値。
eventCount

string (int64 format)

このアクティビティにおけるこのようなイベントの数。

試してみよう: