Method: properties.runAccessReport

Muestra un informe personalizado de los registros de acceso a los datos. El informe proporciona registros de cada vez que un usuario lee datos de informes de Google Analytics. Los registros de acceso se conservan hasta por 2 años.

Se pueden solicitar informes de acceso a los datos para una propiedad. La propiedad debe estar en Google Analytics 360. Este método solo está disponible para los administradores.

Estos registros de acceso a los datos incluyen los informes de la IU de GA4, las Exploraciones de IU de GA4, la API de datos de GA4 y otros productos, como Firebase y AdMob, que pueden recuperar datos de Google Analytics mediante una vinculación. Estos registros no incluyen cambios en la configuración de la propiedad, como agregar un flujo o cambiar la zona horaria de una propiedad. Para ver el historial de cambios en la configuración, consulta searchChangeHistoryEvents.

Solicitud HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
entity

string

El informe de acceso a los datos admite solicitudes a nivel de la propiedad o de la cuenta. Si se solicitan a nivel de la cuenta, los informes de acceso a los datos incluyen todo el acceso a todas las propiedades en esa cuenta.

Para solicitar la propiedad, la entidad debe ser, por ejemplo, "propiedades/123", si "123" es tu ID de propiedad GA4. Para solicitarla, la entidad debe ser, por ejemplo, "accounts/1234", si "1234" es tu ID de cuenta de GA4.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean
}
Campos
dimensions[]

object (AccessDimension)

Son las dimensiones solicitadas y se muestran en la respuesta. Se permiten hasta 9 dimensiones.

metrics[]

object (AccessMetric)

Son las métricas solicitadas y se muestran en la respuesta. Las solicitudes permiten hasta 10 métricas.

dateRanges[]

object (AccessDateRange)

Períodos de los registros de acceso para leer. Si se solicitan varios períodos, cada fila de respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, se incluyen los registros de acceso de los días superpuestos en las filas de respuesta de ambos. Se permiten hasta 2 períodos.

dimensionFilter

object (AccessFilterExpression)

Los filtros de dimensiones le permiten restringir la respuesta del informe a valores de dimensión específicos que coincidan con el filtro. Por ejemplo, filtrando los registros de acceso de un solo usuario. Para obtener más información, consulta los Fundamentos de los filtros de dimensión. No se pueden usar las métricas en este filtro.

metricFilter

object (AccessFilterExpression)

Los filtros de métricas te permiten restringir la respuesta del informe a valores de métricas específicos que coincidan con el filtro. Los filtros de métricas se aplican después de agregar las filas del informe, similar a la cláusula cláusula SQL. No se pueden usar las dimensiones en este filtro.

offset

string (int64 format)

Es el recuento de filas de la fila inicial. La primera fila se cuenta como la fila 0. Si no se especifica un desplazamiento, se trata como 0. Si el desplazamiento es cero, este método mostrará la primera página de resultados con entradas limit.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.

limit

string (int64 format)

La cantidad de filas que se mostrarán. Si no se especifica, se muestran 10,000 filas. La API muestra un máximo de 100,000 filas por solicitud, independientemente de cuántas solicites. limit debe ser un número positivo.

Es posible que la API muestre menos filas que las limit solicitadas, si no hay tantas filas como el limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando se generan informes solo de country, no se pueden obtener más de 300 filas, incluso si se establece limit en un valor más alto.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.

timeZone

string

La zona horaria de esta solicitud, si se especifica. Si no se especifica, se usa la zona horaria de la propiedad. La zona horaria de la solicitud se usa para interpretar las fechas de inicio y finalización del informe.

Tiene el formato de strings de la base de datos de la zona horaria de IANA (https://www.iana.org/time-zones); por ejemplo, "America/New_York" o "Asia/Tokyo".

orderBys[]

object (AccessOrderBy)

Especifica cómo se ordenan las filas en la respuesta.

returnEntityQuota

boolean

Alterna si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en AccessQuota. Para las solicitudes a nivel de la cuenta, este campo debe ser falso.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de RunAccessReportResponse.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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