Method: userActivity.search

Restituisce i dati sull'attività utente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

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

object(DateRange)

Intervallo di date per il quale recuperare l'attività utente. Se non viene specificato un intervallo di date, l'intervallo di date predefinito è (startDate: data corrente - 7 giorni, data di fine: data corrente - 1 giorno).

viewId

string

Obbligatoria. L'ID vista di Analytics da cui recuperare i dati. Ogni elemento SearchUserActivityRequest deve contenere il parametro viewId.

user

object(User)

Obbligatoria. ID utente univoco per il quale eseguire la query. Ogni elemento SearchUserActivityRequest deve contenere questo campo.

activityTypes[]

enum(ActivityType)

Insieme di tutti i tipi di attività richiesti. Nella risposta verranno restituite solo le attività che corrispondono a questi tipi. Se il campo è vuoto, verranno restituite tutte le attività.

pageSize

number

La dimensione della pagina serve al paging e specifica il numero massimo di righe restituite. La dimensione della pagina deve essere maggiore di 0. Se il valore è 0 o se il campo non è specificato, la richiesta restituisce 1000 righe per pagina, per impostazione predefinita.

pageToken

string

Un token di continuazione per visualizzare la pagina successiva dei risultati. Se lo aggiungi alla richiesta, verranno restituite le righe che seguono il token pageToken. pageToken deve essere il valore restituito nel parametro nextPageToken nella risposta alla richiesta SearchUserActivityRequest.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

La risposta dalla chiamata userActivity:get.

Rappresentazione JSON
{
  "sessions": [
    {
      object(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
Campi
sessions[]

object(UserActivitySession)

Ogni record rappresenta una sessione (dettagli del dispositivo, durata e così via).

totalRows

number

Righe totali restituite da questa query (in pagine diverse).

nextPageToken

string

Questo token deve essere trasmesso a SearchUserActivityRequest per recuperare la pagina successiva.

sampleRate

number

Questo campo rappresenta la frequenza di campionamento per la richiesta specificata ed è un numero compreso tra 0,0 e 1,0. Per maggiori dettagli, consulta la guida per gli sviluppatori.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Utente

Contiene informazioni che consentono di identificare in modo univoco un particolare utente.

Rappresentazione JSON
{
  "type": enum(UserIdType),
  "userId": string
}
Campi
type

enum(UserIdType)

Tipo di utente nella richiesta. Il campo userId è associato a questo tipo.

userId

string

ID univoco dell'utente per il quale vengono richiesti i dati.

UserIdType

Rappresenta i vari tipi di identificazione degli utenti disponibili.

Enum
USER_ID_TYPE_UNSPECIFIED Quando non viene specificato il tipo di ID utente, il tipo predefinito utilizzato sarà CLIENT_ID.
USER_ID Un utente singolo, come un account utente a cui è stato eseguito l'accesso, che può interagire con contenuti su uno o più dispositivi e/o una o più istanze di browser.
CLIENT_ID ClientId assegnato ad Analytics.

ActivityType

Enum
ACTIVITY_TYPE_UNSPECIFIED ActivityType non avrà mai questo valore nella risposta. L'uso di questo tipo nella richiesta comporterà un errore.
PAGEVIEW Utilizzata quando l'attività è risultata dalla visualizzazione di una pagina da parte di un visitatore.
SCREENVIEW Utilizzato quando l'attività è risultata da un visitatore che utilizza un'applicazione su un dispositivo mobile.
GOAL Utilizzato per indicare che un'attività di tipo obiettivo.
ECOMMERCE Il visitatore della pagina ha eseguito una transazione di e-commerce.
EVENT Utilizzata quando l'attività è un evento.

UserActivitySession

Rappresenta una sessione utente eseguita su un dispositivo specifico in un determinato momento in un determinato periodo di tempo.

Rappresentazione JSON
{
  "sessionId": string,
  "deviceCategory": string,
  "platform": string,
  "dataSource": string,
  "activities": [
    {
      object(Activity)
    }
  ],
  "sessionDate": string
}
Campi
sessionId

string

ID univoco della sessione.

deviceCategory

string

Il tipo di dispositivo utilizzato: "mobile", "tablet" e così via.

platform

string

Piattaforma su cui si è verificata l'attività: "android", "ios" e così via.

dataSource

string

La sorgente di dati di un hit. Per impostazione predefinita, gli hit inviati da analytics.js vengono registrati come "web" e gli hit inviati da SDK mobile vengono registrati come "app". L'override di questi valori può essere eseguito in Measurement Protocol.

activities[]

object(Activity)

Rappresenta una vista dettagliata di ogni attività di questa sessione.

sessionDate

string

Data di questa sessione in formato ISO-8601.

Attività

Un'attività rappresenta i dati relativi a un'attività di un utente. Tieni presente che un'attività è diversa da un hit. Un hit può comportare più attività. Ad esempio, se un hit include una transazione e un completamento obiettivo, per questo hit saranno presenti due protocolli attività, uno per ECOMMERCE e uno per OBIETTIVO. Al contrario, più hit possono creare un'unica attività. Nell'e-commerce classico, i dati di una transazione potrebbero essere inviati attraverso più hit. Questi hit verranno uniti in un'unica attività ECOMMERCE.

Rappresentazione 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.
}
Campi
activityTime

string (Timestamp format)

Timestamp dell'attività.

Un timestamp in formato "Zulu" UTC RFC3339, preciso al nanosecondo. Esempio: "2014-10-02T15:01:23.045123456Z".

source

string

La sorgente dei referral. Per il monitoraggio manuale delle campagne, è il valore del parametro di monitoraggio della campagna utm_source. Per la codifica automatica di AdWords, è Google. Se non utilizzi nessuno dei due, si tratta del dominio della sorgente (ad es. document.referrer) che fa riferimento agli utenti. Potrebbe anche contenere un indirizzo di porta. Se gli utenti sono arrivati senza un referrer, il suo valore è (direct).

medium

string

Il tipo di referral. Per il monitoraggio manuale delle campagne, è il valore del parametro di monitoraggio della campagna utm_medium. Per la codifica automatica di AdWords, si tratta di cpc. Se gli utenti provengono da un motore di ricerca rilevato da Google Analytics, si tratta di risultati organici. Se il referrer non è un motore di ricerca, si tratta di referral. Se gli utenti hanno raggiunto direttamente la proprietà e document.referrer è vuoto, il valore è (nessuno).

channelGrouping

string

Il gruppo di canali associato alla sessione di un utente finale per questa vista (definito dai raggruppamenti dei canali della vista).

campaign

string

Per il monitoraggio manuale delle campagne, è il valore del parametro di monitoraggio della campagna utm_campaign. Per la codifica automatica di AdWords, si tratta dei nomi delle campagne pubblicitarie online che utilizzi per la proprietà. Se non utilizzi nessuno dei due valori, il valore è (not set).

keyword

string

Per il monitoraggio manuale delle campagne, è il valore del parametro di monitoraggio della campagna utm_term. Per il traffico AdWords, contiene i migliori criteri di targeting corrispondenti. Per la Rete Display, dove più criteri di targeting avrebbero potuto determinare la visualizzazione dell'annuncio, restituisce i migliori criteri di targeting corrispondenti selezionati da Google Ads. Può essere display_keyword, site posizionamento, boomuserlist, user_interest, età o genere. In caso contrario, il valore è (not set).

hostname

string

Il nome host da cui è stata effettuata la richiesta di monitoraggio.

landingPagePath

string

La prima pagina della pagina delle sessioni degli utenti o la pagina di destinazione.

activityType

enum(ActivityType)

Tipo di attività.

customDimension[]

object(CustomDimension)

Un elenco di tutte le dimensioni personalizzate associate a questa attività.

Campo di unione activity_details. A seconda dell'activity_type, verrà impostato esattamente uno dei seguenti campi. activity_details può essere solo uno dei seguenti:
pageview

object(PageviewData)

Verrà impostato se activityType è uguale a PAGEVIEW. Questo campo contiene tutti i dettagli sul visitatore e sulla pagina visitata.

appview

object(ScreenviewData)

Verrà impostato se activityType è uguale a SCREEN_VIEW.

ecommerce

object(EcommerceData)

Verrà impostato se activityType è uguale a ECOMMERCE.

goals

object(GoalSetData)

Questo campo contiene un elenco di tutti gli obiettivi raggiunti in questa attività quando activityType è uguale a GOAL.

event

object(EventData)

Questo campo contiene tutti i dettagli relativi a un evento e verrà impostato se activityType è uguale a EVENT.

CustomDimension

Dimensione personalizzata.

Rappresentazione JSON
{
  "index": number,
  "value": string
}
Campi
index

number

Numero area annuncio della dimensione personalizzata.

value

string

Valore della dimensione personalizzata. Il valore predefinito (ovvero una stringa vuota) indica la cancellazione del valore della dimensione personalizzata a livello di sessione/visitatore.

PageviewData

Rappresenta i dettagli raccolti quando il visitatore visualizza una pagina.

Rappresentazione JSON
{
  "pagePath": string,
  "pageTitle": string
}
Campi
pagePath

string

L'URL della pagina che il visitatore ha visualizzato.

pageTitle

string

Il titolo della pagina che il visitatore ha visualizzato.

ScreenviewData

Rappresentazione JSON
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
Campi
screenName

string

Il nome dello schermo.

mobileDeviceBranding

string

Produttore di dispositivi mobili o nome del brand. Esempio: "Google", "Mela" ecc.

mobileDeviceModel

string

Modello del dispositivo mobile. Ad esempio: "Pixel", "iPhone" ecc.

appName

string

Nome dell'applicazione.

EcommerceData

Dettagli di e-commerce associati all'attività dell'utente.

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

enum(ECommerceAction)

Azione associata a questa azione di e-commerce.

transaction

object(TransactionData)

Dettagli transazione di questa azione di e-commerce.

products[]

object(ProductData)

Dettagli dei prodotti inclusi in questa transazione.

ecommerceType

enum(EcommerceType)

Il tipo di attività di e-commerce.

ECommerceAction

Insieme di tutte le azioni associate a un'azione di e-commerce.

Enum
UNKNOWN Tipo di azione sconosciuto.
CLICK Clic sugli elenchi di prodotti.
DETAILS_VIEW Viste dei dettagli dei prodotti
ADD_TO_CART Aggiungi prodotto/i al carrello.
REMOVE_FROM_CART Rimuovi i prodotti dal carrello.
CHECKOUT Paga.
PAYMENT Acquisto completato.
REFUND Rimborso dell'acquisto.
CHECKOUT_OPTION Opzioni di pagamento.

TransactionData

Rappresenta i dettagli raccolti quando il visitatore esegue una transazione sulla pagina.

Rappresentazione JSON
{
  "transactionId": string,
  "transactionRevenue": number,
  "transactionTax": number,
  "transactionShipping": number
}
Campi
transactionId

string

L'ID transazione, fornito dal metodo di monitoraggio e-commerce, per l'acquisto nel carrello degli acquisti.

transactionRevenue

number

Le entrate totali delle vendite (escluse spese di spedizione e tasse) della transazione.

transactionTax

number

Imposte totali per la transazione.

transactionShipping

number

Costo totale della spedizione.

ProductData

Dettagli dei prodotti in una transazione e-commerce.

Rappresentazione JSON
{
  "productSku": string,
  "productName": string,
  "itemRevenue": number,
  "productQuantity": string
}
Campi
productSku

string

Codice univoco che rappresenta il prodotto.

productName

string

Il nome del prodotto, fornito dall'applicazione di monitoraggio e-commerce, per gli articoli acquistati.

itemRevenue

number

Le entrate totali generate dagli articoli acquistati.

productQuantity

string (int64 format)

Numero totale di queste unità di prodotto nella transazione.

EcommerceType

Rappresenta il tipo di dati e-commerce che viene restituito.

Enum
ECOMMERCE_TYPE_UNSPECIFIED Utilizzato quando il tipo di attività e-commerce non è specificato.
CLASSIC Utilizzata quando l'attività contiene informazioni di e-commerce classiche (non ottimizzate).
ENHANCED Utilizzata quando l'attività ha migliorato le informazioni di e-commerce.

GoalSetData

Rappresenta un insieme di obiettivi che sono stati raggiunti in un'attività.

Rappresentazione JSON
{
  "goals": [
    {
      object(GoalData)
    }
  ]
}
Campi
goals[]

object(GoalData)

Tutti gli obiettivi che sono stati raggiunti nell'attività corrente.

GoalData

Rappresenta tutti i dettagli relativi a un obiettivo.

Rappresentazione JSON
{
  "goalIndex": number,
  "goalCompletions": string,
  "goalValue": number,
  "goalCompletionLocation": string,
  "goalPreviousStep1": string,
  "goalPreviousStep2": string,
  "goalPreviousStep3": string,
  "goalName": string
}
Campi
goalIndex

number

Questo identifica l'obiettivo come configurato per il profilo.

goalCompletions

string (int64 format)

Numero totale di completamenti obiettivo in questa attività.

goalValue

number

Valore in questo obiettivo.

goalCompletionLocation

string

URL della pagina in cui è stato completato l'obiettivo.

goalPreviousStep1

string

URL della pagina un passaggio prima del completamento dell'obiettivo.

goalPreviousStep2

string

URL della pagina due passaggi prima del completamento dell'obiettivo.

goalPreviousStep3

string

URL della pagina tre passaggi prima del completamento dell'obiettivo.

goalName

string

Nome dell'obiettivo.

EventData

Rappresenta tutti i dettagli relativi a un evento.

Rappresentazione JSON
{
  "eventCategory": string,
  "eventAction": string,
  "eventLabel": string,
  "eventValue": string,
  "eventCount": string
}
Campi
eventCategory

string

L'oggetto sulla pagina con cui è stata eseguita l'interazione. Esempio: "Video".

eventAction

string

Tipo di interazione con l'oggetto. Esempio: "riproduci".

eventLabel

string

Etichetta allegata all'evento.

eventValue

string (int64 format)

Valore numerico associato all'evento.

eventCount

string (int64 format)

Numero di eventi di questo tipo in questa attività.

Prova.