API de informes centrales: segmentos

En este documento se describen la sintaxis y los aspectos que se deben tener en cuenta para usar segmentos en la API de informes centrales.

Introducción

Al usar la función de segmentación de la API de informes centrales puede solicitar un segmento en dicha API de dos formas:

  1. Segmentos por ID: la consulta se realiza utilizando el ID numérico de un segmento integrado o personalizado.
  2. Segmentos dinámicos: el segmento se especifica dinámicamente en el momento de la solicitud.

Segmentos por ID

Puedes solicitar un segmento en la API de informes centrales usando el ID de un segmento integrado o personalizado. Todos los segmentos disponibles para un usuario se pueden recuperar con el método list de la colección Segmentos en la API de administración de Google Analytics. Para cada segmento el ID está disponible en la propiedad id del recurso Segmento.

Para obtener más información sobre el uso de los ID de segmento en las solicitudes de la API, consulta Referencia de la API de informes centrales.

Segmentos dinámicos

También puedes crear dinámicamente un segmento y usarlo al realizar una solicitud de API. Normalmente, al crear un segmento dinámico se debe tener en cuenta lo siguiente:

  1. Seleccionar usuarios y sesiones
  2. Usar condiciones y secuencias
  3. Usar ámbitos de las métricas

Cada aspecto para crear un segmento que se debe tener en cuenta se describe a continuación con más detalle. En Referencia de la sintaxis de los segmentos dinámicos puedes consultar la sintaxis completa de los segmentos dinámicos.

Dimensiones y métricas permitidas en los segmentos.
En los segmentos no se pueden usar todas las dimensiones y métricas. En Explorador de dimensiones y métricas puedes consultar las dimensiones y las métricas que se permiten en los segmentos.

1. Seleccionar usuarios y sesiones

Especifica si deseas intentar seleccionar usuarios o sesiones (o ambos).

  • Usa users:: para seleccionar usuarios.
  • Usa sessions:: para seleccionar sesiones.
  • Si se especifican las condiciones de users:: y sessions::, significa que:
    1. las condiciones de usuario se aplican en primer lugar para enviar las sesiones de los usuarios coincidentes.
    2. las condiciones de sesión solo se aplican a las sesiones a partir de la primera.

Por ejemplo:

  • Seleccionar los usuarios que han usado el navegador Chrome en una de las sesiones como mínimo.
    • users::condition::ga:browser==Chrome
  • Seleccionar las sesiones donde se ha usado el navegador Chrome.
    • sessions::condition::ga:browser==Chrome
  • Seleccionar las sesiones de la ciudad de Londres que han tenido una sesión como mínimo en la que se ha usado el navegador Chrome.
    • users::condition::ga:browser==Chrome;sessions::condition::ga:city==London

Consulta la sección conditionScope de la referencia de la sintaxis para obtener información sobre la selección de usuarios y sesiones.

2. Usar condiciones y secuencias

Una vez que hayas determinado si quieres segmentar por usuarios o sesiones, debes especificar una o varias condiciones o secuencias.

Condiciones

En las condiciones se utiliza el prefijo condition::. Por ejemplo:

  • Seleccionar los usuarios de Londres que han realizado una visita con el navegador Chrome.
    • users::condition::ga:city==London;ga:browser==Chrome

Secuencias

Las condiciones de secuencia constan de uno o varios pasos, donde cada paso se define mediante una o varias condiciones de dimensión o métrica.

Las condiciones basadas en secuencia se especifican con el prefijo sequence:: y los operadores seguido de (;–>>) o seguido inmediatamente de (;–>). Por ejemplo:

  • Seleccionar los usuarios que primero han usado un equipo y, después, un dispositivo móvil. Como vamos a segmentar a los usuarios, se buscan todas las sesiones de un usuario y se comprueba si un usuario ha utilizado un equipo en una sesión y, después, un dispositivo móvil en una de las sesiones posteriores.
    • users::sequence::ga:deviceCategory==desktop;->>ga:deviceCategory==mobile
  • También puedes usar varias condiciones en cada paso.
    • users::sequence::ga:deviceCategory==desktop;ga:operatingSystem==Windows->>ga:deviceCategory==mobile;ga:operatingSystem==Android
  • También puedes combinar condiciones y secuencias en un segmento con un operador AND (es decir, ";").
    • users::condition::ga:totalEvents>10;sequence::ga:deviceCategory==desktop->>ga:deviceCategory==mobile

Consulta la sección conditionType de la referencia de la sintaxis para obtener información sobre las condiciones simples y basadas en secuencias. En las secciones Secuencias y Condiciones de Referencia de la función de segmentos puedes consultar más ejemplos.

3. Usar ámbitos de las métricas

El ámbito de una métrica define el nivel en el que se define: HIT, SESIÓN o USUARIO. Por ejemplo, ga:pageviews y ga:transactions son métricas de HIT ya que se producen en un hit, mientras que ga:sessionDuration y ga:bounces son métricas de SESIÓN ya que hay un solo valor para ellas por sesión. Conceptualmente, USUARIO es el ámbito de máximo nivel y HIT es el de menor nivel.

Los valores de métrica también se pueden registrar en ámbitos superiores a su ámbito principal. Por ejemplo, ga:pageviews y ga:transactions se pueden registrar en los niveles SESIÓN y USUARIO con solo agregarlos para cada hit que se produce en esas sesiones o para dichos usuarios.

Puedes especificar el ámbito de cada condición de métrica, que determinará el nivel al que se aplica esa condición. Los ámbitos de métrica se especifican mediante el prefijo perUser::, perSession:: o perHit::.

Por ejemplo:

  • Seleccionar los usuarios que han gastado 10 € como mínimo en un sitio web (es decir, el valor del ciclo de vida de un usuario es de al menos 10 €).
    users::condition::perUser::ga:transactionRevenue>=10
    
  • Seleccionar los usuarios que han gastado 10 € como mínimo en una sesión.
    users::condition::perSession::ga:transactionRevenue>=10
    

Restricciones de ámbito

La API de informes centrales realiza la validación de los ámbitos de métricas para garantizar que la consulta indicada es válida. Las reglas de la validación de ámbito son:

  1. El ámbito de métrica especificado siempre debe ser igual o menor que su ámbito de condición principal (tal como se indica mediante el prefijo users:: o sessions::).
  2. El ámbito de métrica especificado debe ser igual o mayor que su ámbito definido en el modelo de datos. Consulta Métricas: referencia de ámbito principal para obtener una lista completa de métricas y sus ámbitos principales.

Por ejemplo, los ámbitos de métrica siguientes son válidos:

  • Ambos ámbitos de condición y de métrica son iguales (por ejemplo, nivel USUARIO).
    • users::condition::perUser::ga:transactionRevenue>10
  • El ámbito de condición es mayor que el de métrica (por ejemplo, USUARIO > SESIÓN).
    • users::condition::perSession::ga:transactionRevenue>10
  • ga:totalEvents es una métrica de nivel HIT y, por lo tanto, sus posibles ámbitos en una condición son perHit::, perSession:: o perUser:: (ya que todos son mayores o igual que el ámbito de HIT).
    • users::condition::perHit::ga:totalEvents>5
    • users::condition::perSession::ga:totalEvents>5

A continuación se indican ámbitos de métrica no válidos:

  • El siguiente segmento no es válido porque el ámbito de condición principal es menor que el de métrica (por ejemplo, SESIÓN < USUARIO).
    • sessions::condition::perUser::ga:transactionRevenue>10
  • Usar un ámbito de HIT para una métrica de SESIÓN y nivel de HIT < nivel de SESIÓN.
    • users::condition::perHit::ga:sessionDuration>60

Ámbito predeterminado

Cuando el ámbito de una condición de métrica no se especifica explícitamente, se utiliza el ámbito de condición predeterminado. Por ejemplo, el segmento siguiente usará un ámbito de USUARIO en todas sus condiciones de métrica: users::condition::ga:transactionRevenue>=10;ga:sessionDuration>60

Referencia de la sintaxis de los segmentos dinámicos

Sintaxis básica

La sintaxis para definir un segmento tiene el formato: segment=<segmentCondition>+. Es decir, un segmento se compone de una o varias instrucciones segmentCondition.

Una <segmentCondition> se define como: <conditionScope><conditionType><dimensionOrMetricConditions>

donde:
conditionScope especifica el ámbito de nivel superior de las condiciones.
conditionTypetipoCondición especifica el tipo de las condiciones.
dimensionOrMetricConditions especifican las condiciones de dimensión o de métrica, o los pasos de la secuencia.

conditionScope

Especifica el ámbito de nivel superior de las condiciones. Los valores posibles son:

  • users:: para seleccionar usuarios.
  • sessions:: para seleccionar sesiones.

Restricciones y consideraciones que se deben tener en cuenta para conditionScope:

  • Si se especifican varios "usuarios" y "sesiones" en un solo segmento, se deben combinar con un operador AND.
  • Las condiciones que seleccionan usuarios y sesiones también se deben combinar con un operador AND. Cuando se especifican las condiciones para usuarios y sesiones, todas las condiciones de usuario se aplican en primer lugar para encontrar a los usuarios coincidentes, seguidas de todas las condiciones de sesión en las sesiones que pertenecen a estos usuarios coincidentes.
  • Si utilizas condiciones de usuario, el periodo no debe ser mayor que 90 días.
  • El ámbito de condición también determina el nivel de ámbito predeterminado de todas las condiciones de métrica por debajo de él. Consulta Métricas: referencia de ámbito principal para obtener más información sobre los niveles de ámbito.

conditionType

Especifica el tipo de las condiciones. Los valores posibles son:

  • condition:: para especificar condiciones simples (por ejemplo, no basadas en secuencias)
  • sequence:: para especificar las condiciones basadas en secuencias.

Restricciones y consideraciones que se deben tener en cuenta para conditionType:

  • Si se especifican varias "condiciones simples" y "secuencias", siempre deben estar combinadas con un operador AND.
  • Se permite un máximo de diez pasos en las condiciones basadas en secuencia por segmento.

Condiciones simples

Las condiciones simples constan de una o varias condiciones de dimensión o métrica que se pueden combinar.

Los operadores de condición válidos para las condiciones simples son:

La sintaxis de las condiciones simples es:

condition::<dimensionOrMetricConditions>

Ejemplos de condiciones simples:

  • users::condition::ga:transactionRevenue>10;ga:sessionDuration>60
  • Se puede especificar un operador de negación de nivel superior para encontrar el complemento de una determinada condición simple que pueda incluir varias condiciones de dimensiones o métricas. Por ejemplo, users::condition::!ga:transactionRevenue>10;ga:sessionDuration>60

Condiciones de exclusión

Una condición de exclusión se utiliza para crear un segmento que no cumple la condición definida.

La sintaxis utiliza el operador NOT (carácter ! ) para negar una condición y excluir las sesiones que coinciden con dicha condición.

Excluir las sesiones en las que la página de salida coincide exactamente con la ruta de la página raíz:
sessions::condition::!ga:exitPagePath==/

Varias condiciones

Puedes agrupar las condiciones de usuario con un solo prefijo users::, o puedes usar prefijos users:: independientes para cada condición. Lo mismo se aplica a las condiciones de sesión.

Por ejemplo, los segmentos siguientes son equivalentes. En ambos casos, las condiciones condition1 y condition2 están combinadas con el operador AND para seleccionar los usuarios:
users::<condition1>;<condition2>
users::<condition1>users::<condition2>

Condiciones de secuencia

Las condiciones de secuencia constan de uno o varios pasos, donde cada paso se define mediante una o varias condiciones de dimensión o métrica. Se pueden combinar varios pasos con operadores de secuencia especiales.

Los operadores de secuencia válidos para las condiciones de secuencia:

  • El operador –>> indica que el paso anterior precede al paso siguiente.
  • El operador –> indica que el paso anterior precede inmediatamente al paso siguiente.

La sintaxis de las condiciones de secuencia es:

sequence:: NOT? FIRST_HIT_MATCHES_FIRST_STEP? (AND (PRECEDES|IMMEDIATELY_PRECEDES) <step>)*

donde:

NOT se representa mediante: !
FIRST_HIT_MATCHES_FIRST_STEP se representa mediante: ^
PRECEDES se representa mediante: ;–>>
IMMEDIATELY_PRECEDES se representa mediante: ;–>
step se representa mediante: <dimensionOrMetricConditions>

Ejemplos de condiciones de secuencia:

  • users::sequence::ga:deviceCategory==desktop;->ga:deviceCategory==tablet
  • También se puede especificar un operador de negación de nivel superior para encontrar el complemento de una determinada secuencia que pueda incluir varias condiciones de dimensiones o métricas. Por ejemplo, users::sequence::!ga:deviceCategory==desktop;->ga:deviceCategory==tablet
  • El operador ^ se puede usar para especificar que el primer paso coincide con el primer hit de la primera sesión en el periodo indicado. Por ejemplo: users::sequence::^ga:deviceCategory==desktop;->ga:deviceCategory==tablet.

Condiciones de fecha de sesión

Los segmentos admiten un tipo de análisis que utiliza la sintaxis dateOfSession. En combinación con el operador <>, puedes restringir un segmento a un grupo de usuarios que han iniciado una sesión en un determinado periodo. El periodo máximo de dateOfSession es de 31 días. Consulta el ejemplo de fecha de sesión más adelante para obtener información sobre su uso.

Condiciones de dimensiones y de métricas

Combinar condiciones

Puedes combinar una o varias condiciones de dimensión con los operadores AND (es decir, ";') y OR (es decir, ","). El operador OR tiene una prioridad más alta.

La sintaxis es la misma que la que se usa para combinar filtros. Consulta Combinar filtros en la referencia de la API de informes centrales para obtener más información.

Operadores

En la tabla siguiente se describen todos los operadores disponibles que se pueden usar en los segmentos y si se admiten para dimensiones o métricas.

Operador Descripción ¿Se admite en las condiciones de dimensión? ¿Se admite en las condiciones de métrica?
== Igual a o concordancia exacta.
Por ejemplo: ga:city==London

Por ejemplo: ga:adCost==10
.= No es igual o no es una concordancia exacta.
Por ejemplo: ga:city!=London

Por ejemplo: ga:adCost!=10
< Menor que. Sí (solo para valores numéricos).
Por ejemplo: ga:hour<12

Por ejemplo:ga:adCost<10
<= Menor o igual que. Sí (solo para valores numéricos).
Por ejemplo: ga:hour<=12

Por ejemplo: ga:adCost<=10
> Mayor que. Sí (solo para valores numéricos).
Por ejemplo: ga:hour>12

Por ejemplo: ga:adCost>10
>= Mayor o igual que. Sí (solo para valores numéricos).
Por ejemplo: ga:hour>=12

Por ejemplo: ga:adCost>=10
<> Entre (el valor está entre el intervalo indicado).1 Sí (solo para valores numéricos).
Por ejemplo: ga:hour<>1_12

Por ejemplo: ga:adCost<>10_20
[] En la lista (el valor es uno de los incluidos en la lista).2
Por ejemplo:ga:browser[]Chrome|Firefox|Opera
No
=@ Contiene cadena secundaria.
Por ejemplo: ga:keyword=@shoes
No
.@ No contiene cadena secundaria.
Por ejemplo: ga:keyword!@shoes
No
=~ Contiene una concordancia para la expresión regular.
Por ejemplo: ga:keyword=~shoes
No
.~ No contiene una concordancia para la expresión regular.
Por ejemplo: ga:keyword!~shoes
No

1Operador Entre <>
Permite consultar los valores de un determinado intervalo. Los valores del intervalo son inclusivos y el operador se puede usar en métricas y dimensiones que tengan valores numéricos (por ejemplo, ga:hour). Los valores máximo y mínimo del intervalo deben estar separados por un guion bajo.

Sintaxis:
{dimensionOrMetricName}<>{minValue}_{maxValue}

Ejemplo:
Seleccionar las sesiones que se han producido desde las 12 a las 23 horas.
sessions::condition::ga:hour<>12_23

2Operador En la lista []
Permite consultar los valores de una determinada lista. Solo se puede usar con dimensiones. La lista de valores se debe separar por un carácter "|". Si hay un carácter "|" en el valor, se debe usar un carácter de escape.

Sintaxis:
{dimensionName}[]{value1}|{value2}|...

Restricciones:
Se permite un máximo de diez valores por condición de dimensión en la lista (por ejemplo, ga:city[]city1|city2|...|city10).

Ejemplo:
Seleccionar las sesiones procedentes de los navegadores Chrome, Firefox u Opera.
sessions::condition::ga:browser[]Chrome|Firefox|Opera

Agregar secuencias de escape a caracteres especiales

Los caracteres especiales "," y ";" deben tener una secuencia de escape si se encuentran en las expresiones de valor. Por ejemplo, ga:keyword==nike\,shoes.

Para obtener más información sobre las condiciones de dimensiones y de métricas, consulta Referencia de la API de informes centrales.

Restricciones

Las restricciones relacionadas con las condiciones de dimensiones y de métricas son:

  • Un máximo de diez condiciones de dimensiones o de métricas por segmento.
  • La longitud máxima de la expresión en las condiciones de dimensiones es de 1024 caracteres.

Migrar segmentos dinámicos antiguos

Los segmentos dinámicos antiguos que usan el prefijo dynamic:: son equivalentes a los segmentos de sesión con condiciones de dimensiones y de métricas en la sintaxis actual. Si utilizas segmentos dinámicos antiguos, debes migrar a la nueva sintaxis reemplazando el prefijo dynamic:: por el prefijo sessions::condition::. Por ejemplo, los dos segmentos siguientes son equivalentes:

dynamic::ga:browser==Chrome
es igual a:
sessions::condition::ga:browser==Chrome

Segmentos de ejemplo

1. Datos demográficos: hombres de América cuyo idioma es EN-US y que están interesados en los juegos.

Los segmentos basados en usuario se aplican los primeros. Por lo tanto, la condición basada en usuario devuelve usuarios que son hombres y que están interesados en los juegos. Las sesiones que pertenecen a estos usuarios están sujetas a las condiciones basadas en sesiones para obtener las sesiones procedentes de América y cuyo idioma es EN-US.

users::condition::ga:userGender==Male;users::condition::ga:interestAffinityCategory==Games ; sessions::condition::ga:region==Americas;sessions::condition::ga:language==en-u

2. Comportamiento: usuarios que han tenido más de 100 sesiones, no han hecho una visita en los últimos siete días, han efectuado más de dos transacciones por sesión y han estado más de 100 segundos en el sitio web por sesión.

users::condition::ga:sessions>100;ga:daysSinceLastSession>=7; perSession::ga:transactions>2;perSession::ga:sessionDuration>100

3. Sesiones: seleccionar las sesiones cuyo navegador es Chrome, el país es EE. UU. y tienen más de una excepción por hit Y seleccionar a los usuarios cuyo número de salidas por sesión es menor que dos.

sessions::condition::ga:browser==Chrome;ga:country==US;perHit::ga:exceptions>1; users::condition::perSession::ga:exits<2

4. Sesión con una secuencia: seleccionar las sesiones con Paso: Chrome y número total de eventos por hit superior a 5 Y seleccionar usuarios con Paso: En equipo seguido de Paso: En dispositivo móvil.

sessions::sequence::ga:browser==Chrome;condition::perHit::ga:totalEvents>5;users::sequence::ga:deviceCategory==desktop->>ga:deviceCategory=mobile

5. Fecha de sesión: seleccionar usuarios que han tenido su primera sesión entre el 20 de mayo de 2014 y el 30 de mayo de 2014 y han estado más de 600 segundos en el sitio web.

users::sequence::^ga:sessionCount==1;dateOfSession<>2014-05-20_2014-05-30;->>ga:sessionDurationBucket>600

Métricas: referencia de ámbito principal

Métrica Alcance principal
ga:adClicksHIT
ga:adCostHIT
ga:adsenseAdsClicksHIT
ga:adsenseAdsViewedHIT
ga:adsenseAdUnitsViewedHIT
ga:adsenseCTRHIT
ga:adsenseECPMHIT
ga:adsensePageImpressionsHIT
ga:adsenseRevenueHIT
ga:avgDomainLookupTimeHIT
ga:avgDomContentLoadedTimeHIT
ga:avgDomInteractiveTimeHIT
ga:avgEventValueHIT
ga:avgPageDownloadTimeHIT
ga:avgPageLoadTimeHIT
ga:avgRedirectionTimeHIT
ga:avgScreenviewDurationHIT
ga:avgSearchDepthHIT
ga:avgSearchDurationHIT
ga:avgSearchResultViewsHIT
ga:avgServerConnectionTimeHIT
ga:avgServerResponseTimeHIT
ga:avgUserTimingValueHIT
ga:costPerConversionHIT
ga:costPerGoalConversionHIT
ga:costPerTransactionHIT
ga:CPCHIT
ga:CPMHIT
ga:CTRHIT
ga:domainLookupTimeHIT
ga:domContentLoadedTimeHIT
ga:domInteractiveTimeHIT
ga:domLatencyMetricsSampleHIT
ga:eventValueHIT
ga:exceptionsHIT
ga:exceptionsPerScreenviewHIT
ga:fatalExceptionsHIT
ga:fatalExceptionsPerScreenviewHIT
ga:goalAbandonRateAllHIT
ga:goalAbandonsAllHIT
ga:goalCompletionsAllHIT
ga:goalStartsAllHIT
ga:goalValueAllHIT
ga:goalValueAllPerSearchHIT
ga:goalXXAbandonRateHIT
ga:goalXXAbandonsHIT
ga:goalXXCompletionsHIT
ga:goalXXStartsHIT
ga:goalXXValueHIT
ga:impressionsHIT
ga:itemQuantityHIT
ga:itemRevenueHIT
ga:itemsPerPurchaseHIT
ga:localItemRevenueHIT
ga:localTransactionRevenueHIT
ga:localTransactionShippingHIT
ga:localTransactionTaxHIT
ga:marginHIT
ga:metricXXHIT
ga:pageDownloadTimeHIT
ga:pageLoadSampleHIT
ga:pageLoadTimeHIT
ga:pageValueHIT
ga:pageviewsHIT
ga:percentSearchRefinementsHIT
ga:redirectionTimeHIT
ga:revenuePerItemHIT
ga:revenuePerTransactionHIT
ga:ROIHIT
ga:RPCHIT
ga:screenviewsHIT
ga:searchDepthHIT
ga:searchDurationHIT
ga:searchGoalConversionRateAllHIT
ga:searchGoalXXConversionRateHIT
ga:searchRefinementsHIT
ga:searchResultViewsHIT
ga:searchUniquesHIT
ga:serverConnectionTimeHIT
ga:serverResponseTimeHIT
ga:socialActivitiesHIT
ga:socialInteractionsHIT
ga:socialInteractionsPerSessionHIT
ga:speedMetricsSampleHIT
ga:timeOnScreenHIT
ga:totalEventsHIT
ga:totalValueHIT
ga:transactionRevenueHIT
ga:transactionsHIT
ga:transactionShippingHIT
ga:transactionTaxHIT
ga:uniqueAppviewsHIT
ga:uniqueEventsHIT
ga:uniquePageviewsHIT
ga:uniquePurchasesHIT
ga:uniqueScreenviewsHIT
ga:uniqueSocialInteractionsHIT
ga:userTimingSampleHIT
ga:userTimingValueHIT
ga:adsenseExitsSESIÓN
ga:avgTimeOnPageSESIÓN
ga:avgSessionDurationSESIÓN
ga:bouncesSESIÓN
ga:entranceBounceRateSESIÓN
ga:entranceRateSESIÓN
ga:entrancesSESIÓN
ga:eventsPerSessionWithEventSESIÓN
ga:exitRateSESIÓN
ga:exitsSESIÓN
ga:goalConversionRateAllSESIÓN
ga:goalValuePerSessionSESIÓN
ga:goalXXConversionRateSESIÓN
ga:organicSearchesSESIÓN
ga:pageviewsPerSessionSESIÓN
ga:percentSessionsWithSearchSESIÓN
ga:screenviewsPerSessionSESIÓN
ga:searchExitRateSESIÓN
ga:searchExitsSESIÓN
ga:searchSessionsSESIÓN
ga:sessionDurationSESIÓN
ga:transactionRevenuePerSessionSESIÓN
ga:transactionsPerSessionSESIÓN
ga:bounceRateSESIÓN
ga:sessionsSESIÓN
ga:sessionsWithEventSESIÓN
ga:newSessionsUSUARIO
ga:percentNewSessionsUSUARIO
ga:usersUSUARIO