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 los datos de informes de Google Analytics. Los registros de acceso se conservan por un máximo de 2 años.

Se pueden solicitar informes de acceso a los datos para una propiedad. Se pueden solicitar informes para cualquier propiedad, pero las dimensiones que no están relacionadas con la cuota solo se pueden solicitar en las propiedades de 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 Google Analytics, las Exploraciones de la IU de Google Analytics, la API de datos de Google Analytics y otros productos, como Firebase AdMob puede recuperar datos de Google Analytics a través de una vinculación. Estos registros no incluyen cambios en la configuración de la propiedad, como agregar una transmisión o cambiar la zona horaria de una propiedad. Para ver el historial de cambios de configuración, consulta searchChangeHistoryEvents.

Para enviar tus comentarios sobre esta API, completa el formulario de comentarios a los informes de acceso de Google Analytics.

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 de esa cuenta.

Para solicitar a nivel de la propiedad, la entidad debe ser, por ejemplo, "properties/123". if "123" es tu ID de propiedad de Google Analytics. Para realizar una solicitud a nivel de la cuenta, la entidad debe ser, por ejemplo, "accounts/1234". if "1234" es el ID de tu cuenta de Google Analytics.

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,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
Campos
dimensions[]

object (AccessDimension)

Son las dimensiones solicitadas y que se muestran en la respuesta. Las solicitudes pueden tener hasta 9 dimensiones.

metrics[]

object (AccessMetric)

Las métricas solicitadas y que se muestran en la respuesta. Las solicitudes pueden tener hasta 10 métricas.

dateRanges[]

object (AccessDateRange)

Períodos de 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, los registros de acceso de esos días se incluirán en las filas de respuesta de ambos períodos. Las solicitudes pueden tener hasta 2 períodos.

dimensionFilter

object (AccessFilterExpression)

Los filtros de dimensión te permiten restringir la respuesta del informe a valores de dimensión específicos que coinciden con el filtro. Por ejemplo, si filtras los registros de acceso de un solo usuario. Para obtener más información, consulta Fundamentos de los filtros de dimensión para ver ejemplos. No se pueden usar 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, de manera similar a la cláusula que tiene SQL. No se pueden utilizar dimensiones en este filtro.

offset

string (int64 format)

El recuento de filas de la fila inicial. La primera fila se cuenta como fila 0. Si no se especifica el 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)

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

Es posible que la API muestre menos filas que la limit solicitada si no hay tantas filas restantes como la limit. Por ejemplo, hay menos de 300 valores posibles para la dimensión country, por lo que, cuando se informa solo sobre country, no puedes obtener más de 300 filas, incluso si estableces limit con un valor más alto.

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

timeZone

string

Es 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 horas de inicio y las fechas de finalización del informe.

Están formadas como cadenas de la base de datos de zonas horarias de IANA (https://www.iana.org/time-zones). por ejemplo, "América/Nueva_York" o “Asia/Tokio”.

orderBys[]

object (AccessOrderBy)

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

returnEntityQuota

boolean

Activa o desactiva la opción para que se muestre 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.

includeAllUsers

boolean

Opcional. Determina si se incluyen usuarios que nunca realizaron una llamada a la API en la respuesta. Si es verdadero, todos los usuarios con acceso a la propiedad o cuenta especificada se incluirán en la respuesta, independientemente de si realizaron o no una llamada a la API. Si es falso, solo se incluirán los usuarios que hayan realizado una llamada a la API.

expandGroups

boolean

Opcional. Decide si se devolverán los usuarios dentro de los grupos de usuarios. Este campo funciona solo cuando includeAllUsers se establece como verdadero. Si es verdadero, se mostrarán todos los usuarios con acceso a la propiedad o cuenta especificada. Si es falso, solo se mostrarán los usuarios con acceso directo.

Cuerpo de la respuesta

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

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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