- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- Usuario
- UserIdType
- ActivityType
- UserActivitySession
- Actividad
- CustomDimension
- PageviewData
- ScreenviewData
- EcommerceData
- ECommerceAction
- TransactionData
- ProductData
- EcommerceType
- GoalSetData
- GoalData
- EventData
- Pruébala
Muestra datos de la actividad del usuario.
Solicitud HTTP
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
La URL usa la sintaxis de la transcodificación gRPC.
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON | |
---|---|
{ "dateRange": { object( |
Campos | |
---|---|
dateRange |
Período para recuperar la actividad del usuario. Si no se proporciona un período, el predeterminado es (startDate: current date - 7 days, endDate: current date - 1 day). |
viewId |
Obligatorio. Es el ID de vista de Analytics desde el que se recuperan los datos. Cada SearchUserActivityRequest debe contener el |
user |
Obligatorio. ID de usuario único que se debe consultar. Cada SearchUserActivityRequest debe contener este campo. |
activityTypes[] |
Es un conjunto de todos los tipos de actividades que se solicitan. En la respuesta, solo se mostrarán las actividades que coincidan con estos tipos. Si está vacío, se mostrarán todas las actividades. |
pageSize |
El tamaño de la página es para la paginación y especifica la cantidad máxima de filas que se muestran. El tamaño de la página debe ser mayor que 0. Si el valor es 0 o si no se especifica el campo, la solicitud muestra el valor predeterminado de 1,000 filas por página. |
pageToken |
Un token de continuación para obtener la siguiente página de los resultados. Si agregas esto a la solicitud, se mostrarán las filas después del pageToken. El pageToken debe ser el valor que se muestra en el parámetro nextPageToken en la respuesta a la solicitud SearchUserActivityRequest. |
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Es la respuesta de la llamada a userActivity:get
.
Representación JSON | |
---|---|
{
"sessions": [
{
object( |
Campos | |
---|---|
sessions[] |
Cada registro representa una sesión (detalles del dispositivo, duración, etcétera). |
totalRows |
Es el total de filas que muestra esta consulta (en diferentes páginas). |
nextPageToken |
Este token se debe pasar a SearchUserActivityRequest para recuperar la página siguiente. |
sampleRate |
Este campo representa la tasa de muestreo de la solicitud dada y es un número entre 0.0 y 1.0. Si deseas obtener más información, consulta la guía para desarrolladores. |
Alcances de la autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
Usuario
Contiene información que identifica a un usuario en particular de manera inequívoca.
Representación JSON | |
---|---|
{
"type": enum( |
Campos | |
---|---|
type |
El tipo de usuario de la solicitud. El campo |
userId |
Es el ID único del usuario para el que se solicitan datos. |
UserIdType
Representa varios tipos de identificación de usuario disponibles.
Enumeradores | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
Si no se especifica el tipo de ID de usuario, el tipo predeterminado será CLIENT_ID. |
USER_ID |
Un solo usuario, como una cuenta de usuario que accedió, que puede interactuar con el contenido en uno o más dispositivos o instancias de navegador. |
CLIENT_ID |
El ID de cliente asignado a Analytics. |
ActivityType
Enumeradores | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
ActivityType nunca tendrá este valor en la respuesta. El uso de este tipo en la solicitud generará un error. |
PAGEVIEW |
Se usa cuando la actividad resultó de que un visitante viera una página. |
SCREENVIEW |
Se utiliza cuando la actividad resultó del uso de una aplicación en un dispositivo móvil por parte de un visitante. |
GOAL |
Se utiliza para indicar que es una actividad de tipo objetivo. |
ECOMMERCE |
El visitante realizó una transacción de comercio electrónico en la página. |
EVENT |
Se usa cuando la actividad es un evento. |
UserActivitySession
Representa la sesión de un usuario realizada en un dispositivo específico en un momento determinado durante un período.
Representación JSON | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
Campos | |
---|---|
sessionId |
Es el ID único de la sesión. |
deviceCategory |
Tipo de dispositivo usado: "dispositivo móvil", "tablet", etc. |
platform |
Plataforma en la que ocurrió la actividad: "Android", "iOS", etcétera. |
dataSource |
Indica la fuente de datos de un hit. De forma predeterminada, los hits enviados desde analytics.js se registran como "web" y los que se envían desde los SDK para dispositivos móviles se registran como "app". Estos valores se pueden anular en el Protocolo de medición. |
activities[] |
Representa una vista detallada de cada una de las actividades de esta sesión. |
sessionDate |
Es la fecha de esta sesión en formato ISO-8601. |
Actividad
Una actividad representa los datos de la actividad de un usuario. Ten en cuenta que una actividad es diferente de un hit. Un hit puede generar varias actividades. Por ejemplo, si un hit incluye una transacción y la consecución de un objetivo, habrá dos prototipos de actividad para este hit, uno para COMERCIO ELECTRÓNICO y otro para OBJETIVO. Por el contrario, varios hits también pueden crear una actividad. En el comercio electrónico clásico, los datos de una transacción pueden enviarse a través de varios hits. Estos hits se combinarán en una actividad de COMERCIO ELECTRÓNICO.
Representación JSON | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
Campos | ||
---|---|---|
activityTime |
Marca de tiempo de la actividad. Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: |
|
source |
Es la fuente de las referencias. Para el seguimiento manual de la campaña, es el valor del parámetro de seguimiento utm_source de la campaña. Para el etiquetado automático de AdWords, es google. Si no utilizas ninguno, el dominio de la fuente (p.ej., document.referrer) hace referencia a los usuarios. También puede contener una dirección de puerto. Si los usuarios llegaron sin una URL de referencia, su valor es (directo). |
|
medium |
Es el tipo de referencias. Para el seguimiento manual de la campaña, es el valor del parámetro de seguimiento utm_medium de la campaña. Para el etiquetado automático de AdWords, es cpc. Si los usuarios provienen de un motor de búsqueda detectado por Google Analytics, este es orgánico. Si la URL de referencia no es un motor de búsqueda, es una referencia. Si los usuarios llegaron directamente a la propiedad y document.referrer está vacío, su valor es (ninguno). |
|
channelGrouping |
Es el grupo de canales asociado con la sesión de un usuario final para esta vista (definido por las agrupaciones de canales de la vista). |
|
campaign |
Para el seguimiento manual de la campaña, es el valor del parámetro de seguimiento de la campaña utm_campaign. En el caso del etiquetado automático de AdWords, corresponde a los nombres de las campañas publicitarias en línea que usas para la propiedad. Si no usas ninguno, su valor es (not set). |
|
keyword |
Para el seguimiento manual de la campaña, es el valor del parámetro de seguimiento de la campaña utm_term. Para el tráfico de AdWords, contiene los mejores criterios de segmentación que coinciden. Para la Red de Display, donde varios criterios de segmentación podrían haber provocado la aparición del anuncio, devuelve los mejores criterios de segmentación coincidentes según la selección de Google Ads. Podría ser display_keyword, site location, boomuserlist, user_interest, edad o género. De lo contrario, su valor es (not set). |
|
hostname |
El nombre de host desde el que se realizó la solicitud de seguimiento |
|
landingPagePath |
Es la primera página de las sesiones de los usuarios o la página de destino. |
|
activityType |
Tipo de esta actividad. |
|
customDimension[] |
Una lista de todas las dimensiones personalizadas asociadas con esta actividad. |
|
Campo de unión activity_details . Según el activity_type , se establecerá exactamente uno de los siguientes campos. activity_details puede ser solo uno de los siguientes: |
||
pageview |
Se establecerá si |
|
appview |
Se establecerá si |
|
ecommerce |
Se establecerá si |
|
goals |
Este campo contiene una lista de todos los objetivos que se alcanzaron en esta actividad cuando |
|
event |
Este campo contiene todos los detalles relacionados con un evento y se establecerá si |
CustomDimension
Dimensión personalizada
Representación JSON | |
---|---|
{ "index": number, "value": string } |
Campos | |
---|---|
index |
Cantidad de ranuras de la dimensión personalizada. |
value |
Es el valor de la dimensión personalizada. El valor predeterminado (es decir, una cadena vacía) indica la eliminación del valor de la dimensión personalizada del alcance de la sesión o el visitante. |
PageviewData
Representa los detalles recopilados cuando el visitante ve una página.
Representación JSON | |
---|---|
{ "pagePath": string, "pageTitle": string } |
Campos | |
---|---|
pagePath |
Es la URL de la página que vio el visitante. |
pageTitle |
Es el título de la página que vio el visitante. |
ScreenviewData
Representación JSON | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
Campos | |
---|---|
screenName |
Es el nombre de la pantalla. |
mobileDeviceBranding |
Fabricante del dispositivo móvil o nombre de la marca P. ej.: “Google”, “Apple”, etcétera. |
mobileDeviceModel |
Modelo del dispositivo móvil. P. ej., "Pixel", "iPhone", etcétera. |
appName |
Es el nombre de la aplicación. |
EcommerceData
Son los detalles de comercio electrónico asociados con la actividad del usuario.
Representación JSON | |
---|---|
{ "actionType": enum( |
Campos | |
---|---|
actionType |
Es la acción asociada a esta acción de comercio electrónico. |
transaction |
Detalles de la transacción de esta acción de comercio electrónico. |
products[] |
Son los detalles de los productos en esta transacción. |
ecommerceType |
Indica el tipo de esta actividad de comercio electrónico. |
ECommerceAction
Es el conjunto de todas las acciones asociadas con una acción de comercio electrónico.
Enumeradores | |
---|---|
UNKNOWN |
Se desconoce el tipo de acción. |
CLICK |
Hacer clic en las listas de productos |
DETAILS_VIEW |
Vistas de detalles del producto. |
ADD_TO_CART |
Agrega productos al carrito. |
REMOVE_FROM_CART |
Quita productos del carrito. |
CHECKOUT |
Confirme la compra. |
PAYMENT |
Se completó la compra. |
REFUND |
Reembolso de compra. |
CHECKOUT_OPTION |
Opciones de confirmación de la compra. |
TransactionData
Representa los detalles recopilados cuando el visitante realiza una transacción en la página.
Representación JSON | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
Campos | |
---|---|
transactionId |
Es el ID de transacción, proporcionado por el método de seguimiento de comercio electrónico, para la compra realizada en el carrito de compras. |
transactionRevenue |
Indica los ingresos totales por ventas (sin impuestos ni gastos de envío) de la transacción. |
transactionTax |
Es el impuesto total de la transacción. |
transactionShipping |
Costo total del envío. |
ProductData
Son los detalles de los productos en una transacción de comercio electrónico.
Representación JSON | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
Campos | |
---|---|
productSku |
Es un código único que representa el producto. |
productName |
Es el nombre del producto, proporcionado por la aplicación de seguimiento de comercio electrónico, para los artículos comprados. |
itemRevenue |
Indica los ingresos totales por artículos de productos comprados. |
productQuantity |
Es la cantidad total de unidades de este producto incluidas en la transacción. |
EcommerceType
Representa el tipo de datos de comercio electrónico que se muestran.
Enumeradores | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED |
Se utiliza cuando no se especifica el tipo de actividad de comercio electrónico. |
CLASSIC |
Se usa cuando la actividad tiene información de comercio electrónico clásica (no mejorada). |
ENHANCED |
Se usa cuando la actividad mejoró la información de comercio electrónico. |
GoalSetData
Representa un conjunto de objetivos que se alcanzaron en una actividad.
Representación JSON | |
---|---|
{
"goals": [
{
object( |
Campos | |
---|---|
goals[] |
Todos los objetivos que se alcanzaron en la actividad actual. |
GoalData
Representa todos los detalles relacionados con un objetivo.
Representación JSON | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
Campos | |
---|---|
goalIndex |
Esto identifica el objetivo como se configuró para el perfil. |
goalCompletions |
Cantidad total de consecuciones de objetivos en esta actividad. |
goalValue |
Valor de este objetivo. |
goalCompletionLocation |
URL de la página donde se completó este objetivo. |
goalPreviousStep1 |
URL de la página un paso antes de la consecución de objetivos. |
goalPreviousStep2 |
URL de la página dos pasos antes de la consecución del objetivo. |
goalPreviousStep3 |
URL de la página tres pasos antes de la consecución del objetivo. |
goalName |
Es el nombre del objetivo. |
EventData
Representa todos los detalles relacionados con un evento.
Representación JSON | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
Campos | |
---|---|
eventCategory |
Es el objeto de la página con la que se interactuó. P. ej.: "Video". |
eventAction |
Tipo de interacción con el objeto. P. ej.: "reproducir". |
eventLabel |
Etiqueta adjunta al evento. |
eventValue |
Es el valor numérico asociado con el evento. |
eventCount |
Cantidad de eventos de este tipo en esta actividad. |