Method: userActivity.search

Gibt Daten zur Nutzeraktivität zurück.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung
{
  "dateRange": {
    object(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
Felder
dateRange

object(DateRange)

Zeitraum, für den die Nutzeraktivität abgerufen werden soll. Wenn kein Zeitraum angegeben ist, wird der Standardzeitraum wie folgt verwendet (startDate: aktuelles Datum – 7 Tage, endDate: aktuelles Datum – 1 Tag).

viewId

string

Erforderlich. Die ID der Analytics-Datenansicht, für die Daten abgerufen werden sollen Jede SearchUserActivityRequest muss die viewId enthalten.

user

object(User)

Erforderlich. Eindeutige Nutzer-ID, die abgefragt werden soll. Jede SearchUserActivityRequest muss dieses Feld enthalten.

activityTypes[]

enum(ActivityType)

Satz aller angeforderten Aktivitätstypen. In der Antwort werden nur Aktivitäten zurückgegeben, die diesen Typen entsprechen. Wenn das Feld leer ist, werden alle Aktivitäten zurückgegeben.

pageSize

number

Die Seitengröße gilt für das Paging und gibt die maximale Anzahl der zurückgegebenen Zeilen an. Die Seitengröße muss größer als 0 sein. Wenn der Wert 0 ist oder das Feld nicht angegeben ist, gibt die Anfrage den Standardwert von 1.000 Zeilen pro Seite zurück.

pageToken

string

Fortsetzungs-Token für den Abruf der nächsten Ergebnisseite. Wenn Sie dies zur Anfrage hinzufügen, werden die Zeilen nach dem pageToken zurückgegeben. Das pageToken sollte der Wert sein, der im Parameter „nextPageToken“ in der Antwort auf die Anfrage SearchUserActivityRequest zurückgegeben wird.

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Die Antwort des userActivity:get-Aufrufs.

JSON-Darstellung
{
  "sessions": [
    {
      object(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
Felder
sessions[]

object(UserActivitySession)

Jeder Eintrag stellt eine Sitzung dar (Gerätedetails, Dauer usw.).

totalRows

number

Gesamtzahl der von dieser Abfrage zurückgegebenen Zeilen (auf verschiedenen Seiten).

nextPageToken

string

Dieses Token sollte an SearchUserActivityRequest übergeben werden, um die nächste Seite abzurufen.

sampleRate

number

Dieses Feld stellt die Stichprobenrate für die gegebene Anfrage dar und enthält eine Zahl zwischen 0,0 und 1,0. Weitere Informationen finden Sie im Entwicklerleitfaden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Nutzer

Enthält Informationen zur eindeutigen Identifizierung eines bestimmten Nutzers.

JSON-Darstellung
{
  "type": enum(UserIdType),
  "userId": string
}
Felder
type

enum(UserIdType)

Typ des Nutzers in der Anfrage. Das Feld „userId“ ist mit diesem Typ verknüpft.

userId

string

Eindeutige ID des Nutzers, für den die Daten angefordert werden.

UserIdType

Stellt die verschiedenen verfügbaren Arten der Nutzeridentifikation dar.

Enums
USER_ID_TYPE_UNSPECIFIED Wenn der Nutzer-ID-Typ nicht angegeben ist, wird als Standardtyp CLIENT_ID verwendet.
USER_ID Ein einzelner Nutzer, der beispielsweise in seinem Konto angemeldet ist und mit Content auf einem oder mehreren Geräten bzw. unterschiedlichen Browserinstanzen interagiert
CLIENT_ID Analytics hat clientId zugewiesen.

ActivityType

Enums
ACTIVITY_TYPE_UNSPECIFIED Dieser Wert wird für „ActivityType“ nie in der Antwort verwendet. Die Verwendung dieses Typs in der Anfrage führt zu einem Fehler.
PAGEVIEW Wird verwendet, wenn die Aktivität dazu führte, dass ein Besucher eine Seite aufgerufen hat.
SCREENVIEW Wird verwendet, wenn die Aktivität darauf zurückzuführen ist, dass ein Besucher eine App auf einem Mobilgerät verwendet.
GOAL Wird verwendet, um anzuzeigen, dass es sich um eine Aktivität vom Typ „Ziel“ handelt.
ECOMMERCE Der Besucher der Seite hat eine E-Commerce-Transaktion durchgeführt.
EVENT Wird verwendet, wenn die Aktivität ein Ereignis ist.

UserActivitySession

Dieser Wert bezieht sich auf eine Nutzersitzung, die auf einem bestimmten Gerät zu einem bestimmten Zeitpunkt über einen bestimmten Zeitraum ausgeführt wurde.

JSON-Darstellung
{
  "sessionId": string,
  "deviceCategory": string,
  "platform": string,
  "dataSource": string,
  "activities": [
    {
      object(Activity)
    }
  ],
  "sessionDate": string
}
Felder
sessionId

string

Eindeutige ID der Sitzung.

deviceCategory

string

Verwendeter Gerätetyp: „Mobilgerät“, „Tablet“ usw.

platform

string

Plattform, auf der die Aktivität stattgefunden hat: „android“, „ios“ usw.

dataSource

string

Die Datenquelle eines Treffers. Standardmäßig werden die Treffer von analytics.js als „web“ und die von den mobilen SDKs gesendeten Treffer als „app“ angezeigt. Diese Werte können im Measurement Protocol überschrieben werden.

activities[]

object(Activity)

Eine detaillierte Ansicht jeder Aktivität in dieser Sitzung.

sessionDate

string

Das Datum dieser Sitzung im ISO-8601-Format.

Aktivitäten

Eine Aktivität stellt Daten für die Aktivität eines Nutzers dar. Beachten Sie, dass sich eine Aktivität von einem Treffer unterscheidet. Ein Treffer kann zu mehreren Aktivitäten führen. Wenn ein Treffer beispielsweise eine Transaktion und einen Zielabschluss umfasst, werden zwei Aktivitätsprotokollen für diesen Treffer erstellt, einer für ECOMMERCE und einer für GOAL. Umgekehrt kann auch mehrere Treffer zu einer Aktivität führen. Im klassischen E-Commerce werden Daten für eine Transaktion möglicherweise über mehrere Treffer gesendet. Diese Treffer werden in einer ECOMMERCE-Aktivität zusammengeführt.

JSON-Darstellung
{
  "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.
}
Felder
activityTime

string (Timestamp format)

Zeitstempel der Aktivität.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".

source

string

Die Quelle von Verweisen. Für das manuelle Kampagnen-Tracking ist dies der Wert des Kampagnen-Tracking-Parameters „utm_source“. Für die automatische Tag-Kennzeichnung von AdWords ist der Code „google“. Wenn Sie weder das eine noch das andere Feld verwenden, handelt es sich um die Domain der Quelle (z.B. „document.referrer“), über die die Nutzer weitergeleitet werden. Er kann auch eine Portadresse enthalten. Wenn Nutzer ohne Referrer-URL auf Ihre Website gelangt sind, lautet der Wert (direct).

medium

string

Die Art der Verweise. Für das manuelle Kampagnen-Tracking ist dies der Wert des Kampagnen-Tracking-Parameters „utm_medium“. Für die automatische Tag-Kennzeichnung in AdWords wird CPC verwendet. Wenn Nutzer von einer Suchmaschine kommen, die von Google Analytics erkannt wird, ist diese organische Suche. Wenn es sich bei der Referrer-URL nicht um eine Suchmaschine handelt, ist es ein Verweis. Wenn Nutzer direkt zur Property gelangt sind und „document.referrer“ leer ist, lautet der Wert „(none)“.

channelGrouping

string

Die Channelgruppe, die der Sitzung eines Endnutzers für diese Datenansicht zugeordnet ist (definiert durch die Channelgruppierungen der Datenansicht).

campaign

string

Für das manuelle Kampagnen-Tracking ist dies der Wert des Kampagnen-Tracking-Parameters „utm_campaign“. Für das automatische Tagging in AdWords werden die Namen der Onlinewerbekampagnen verwendet, die Sie für die Property verwenden. Wenn Sie weder das eine noch das andere verwenden, ist der Wert „(nicht festgelegt)“.

keyword

string

Für das manuelle Kampagnen-Tracking ist dies der Wert des Kampagnen-Tracking-Parameters „utm_term“. Für AdWords-Traffic enthält er die am besten passenden Ausrichtungskriterien. Wenn für das Displaynetzwerk mehrere Targeting-Kriterien zur Schaltung der Anzeige hätten führen können, werden die am besten passenden Targeting-Kriterien zurückgegeben, die in den Anzeigen ausgewählt wurden. Dabei kann es sich um „display_keyword“, „Website-Placement“, „boomuserlist“, „user_interest“, „age“ oder „gender“ handeln. Andernfalls ist der Wert „(nicht festgelegt)“.

hostname

string

Der Hostname, von dem aus die Tracking-Anfrage gesendet wurde.

landingPagePath

string

Die erste Seite in den Sitzungen der Nutzer oder die Landingpage.

activityType

enum(ActivityType)

Art dieser Aktivität.

customDimension[]

object(CustomDimension)

Eine Liste aller benutzerdefinierten Dimensionen, die mit dieser Aktivität verknüpft sind.

Union-Feld activity_details. Abhängig von der activity_type wird genau eines der folgenden Felder festgelegt. Für activity_details ist nur einer der folgenden Werte zulässig:
pageview

object(PageviewData)

Dieser Wert wird festgelegt, wenn activityType gleich PAGEVIEW ist. Dieses Feld enthält alle Details über den Besucher und die besuchte Seite.

appview

object(ScreenviewData)

Dieser Wert wird festgelegt, wenn activityType gleich SCREEN_VIEW ist.

ecommerce

object(EcommerceData)

Dieser Wert wird festgelegt, wenn activityType gleich ECOMMERCE ist.

goals

object(GoalSetData)

Dieses Feld enthält eine Liste aller Ziele, die in dieser Aktivität erreicht wurden, wenn activityType gleich GOAL ist.

event

object(EventData)

Dieses Feld enthält alle Details zu einem Ereignis. Es wird festgelegt, wenn activityType gleich EVENT ist.

CustomDimension

Benutzerdefinierte Dimension.

JSON-Darstellung
{
  "index": number,
  "value": string
}
Felder
index

number

Slotnummer der benutzerdefinierten Dimension.

value

string

Wert der benutzerdefinierten Dimension. Der Standardwert (leerer String) gibt an, dass der Wert der benutzerdefinierten Dimension auf Sitzung/Besucherbereich gelöscht wird.

PageviewData

Stellt Details dar, die beim Aufrufen einer Seite durch den Besucher erfasst werden.

JSON-Darstellung
{
  "pagePath": string,
  "pageTitle": string
}
Felder
pagePath

string

Die URL der Seite, die der Besucher aufgerufen hat.

pageTitle

string

Der Titel der Seite, die der Besucher aufgerufen hat.

ScreenviewData

JSON-Darstellung
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
Felder
screenName

string

Der Name des Bildschirms.

mobileDeviceBranding

string

Hersteller oder Markenname des Mobilgeräts. Z. B. „Google“, „Apfel“ usw.

mobileDeviceModel

string

Modell des Mobilgeräts. Z. B.: "Pixel", "iPhone" usw.

appName

string

Der Name der Anwendung

EcommerceData

E-Commerce-Details in Verbindung mit der Nutzeraktivität.

JSON-Darstellung
{
  "actionType": enum(ECommerceAction),
  "transaction": {
    object(TransactionData)
  },
  "products": [
    {
      object(ProductData)
    }
  ],
  "ecommerceType": enum(EcommerceType)
}
Felder
actionType

enum(ECommerceAction)

Aktion, die mit dieser E-Commerce-Aktion verknüpft ist.

transaction

object(TransactionData)

Transaktionsdetails dieser E-Commerce-Aktion

products[]

object(ProductData)

Details zu den Produkten in dieser Transaktion.

ecommerceType

enum(EcommerceType)

Der Typ dieser E-Commerce-Aktivität.

ECommerceAction

Satz aller Aktionen, die mit einer E-Commerce-Aktion verknüpft sind.

Enums
UNKNOWN Der Aktionstyp ist unbekannt.
CLICK Klicks durch Produktlisten.
DETAILS_VIEW Produktdetailansichten.
ADD_TO_CART Legen Sie die Produkte in den Einkaufswagen.
REMOVE_FROM_CART Entfernen Sie die Produkte aus dem Einkaufswagen.
CHECKOUT Gehen Sie zur Kasse.
PAYMENT Kauf abgeschlossen.
REFUND Erstattung des Kaufs.
CHECKOUT_OPTION Zahlungs- und Versandoptionen.

TransactionData

Details, die erfasst werden, wenn der Besucher eine Transaktion auf der Seite durchführt

JSON-Darstellung
{
  "transactionId": string,
  "transactionRevenue": number,
  "transactionTax": number,
  "transactionShipping": number
}
Felder
transactionId

string

Die Transaktions-ID für den Kauf im Einkaufswagen, die über die E-Commerce-Tracking-Methode bereitgestellt wird.

transactionRevenue

number

Der Gesamtumsatz der Transaktion ohne Versandkosten und Steuern.

transactionTax

number

Die Steuern für die Transaktion insgesamt.

transactionShipping

number

Gesamtkosten der Versandkosten.

ProductData

Details zu den Produkten in einer E-Commerce-Transaktion

JSON-Darstellung
{
  "productSku": string,
  "productName": string,
  "itemRevenue": number,
  "productQuantity": string
}
Felder
productSku

string

Eindeutiger Code, der das Produkt repräsentiert.

productName

string

Der von der E-Commerce-Tracking-Anwendung bereitgestellte Produktname für die gekauften Artikel.

itemRevenue

number

Der Gesamtumsatz aus gekauften Produktartikeln.

productQuantity

string (int64 format)

Gesamtzahl der Produkteinheiten in der Transaktion.

EcommerceType

Der Typ der E-Commerce-Daten, die zurückgegeben werden.

Enums
ECOMMERCE_TYPE_UNSPECIFIED Wird verwendet, wenn der E-Commerce-Aktivitätstyp nicht angegeben ist.
CLASSIC Wird verwendet, wenn die Aktivität klassische (nicht erweiterte) E-Commerce-Informationen enthält.
ENHANCED Wird verwendet, wenn durch die Aktivität erweiterte E-Commerce-Informationen erfasst wurden.

GoalSetData

Eine Reihe von Zielen, die mit einer Aktivität erreicht wurden.

JSON-Darstellung
{
  "goals": [
    {
      object(GoalData)
    }
  ]
}
Felder
goals[]

object(GoalData)

Alle Ziele, die in der aktuellen Aktivität erreicht wurden.

GoalData

Alle Details, die zu einem Ziel gehören

JSON-Darstellung
{
  "goalIndex": number,
  "goalCompletions": string,
  "goalValue": number,
  "goalCompletionLocation": string,
  "goalPreviousStep1": string,
  "goalPreviousStep2": string,
  "goalPreviousStep3": string,
  "goalName": string
}
Felder
goalIndex

number

Hiermit wird das für das Profil konfigurierte Ziel identifiziert.

goalCompletions

string (int64 format)

Gesamtzahl der Zielabschlüsse in dieser Aktivität.

goalValue

number

Wert in diesem Zielvorhaben.

goalCompletionLocation

string

URL der Seite, auf der dieses Zielvorhaben abgeschlossen wurde.

goalPreviousStep1

string

URL der Seite einen Schritt vor dem Abschluss des Zielvorhabens.

goalPreviousStep2

string

URL der Seite zwei Schritte vor dem Abschluss für das Zielvorhaben.

goalPreviousStep3

string

URL der Seite drei Schritte vor dem Abschluss für das Zielvorhaben.

goalName

string

Name des Ziels.

EventData

Stellt alle Details zu einem Ereignis dar.

JSON-Darstellung
{
  "eventCategory": string,
  "eventAction": string,
  "eventLabel": string,
  "eventValue": string,
  "eventCount": string
}
Felder
eventCategory

string

Das Objekt auf der Seite, mit dem interagiert wurde. Beispiel: „Video“.

eventAction

string

Art der Interaktion mit dem Objekt. Beispiel: „play“.

eventLabel

string

Mit dem Ereignis verknüpftes Label.

eventValue

string (int64 format)

Numerischer Wert, der dem Ereignis zugeordnet ist.

eventCount

string (int64 format)

Anzahl der Ereignisse in dieser Aktivität.

Jetzt testen