Visão geral

Com a API Admin do Google Analytics v1, você pode acessar relatórios usando runAccessReport . O relatório fornece registros de cada vez que um usuário lê o Google Analytics dados de relatório. Os registros de acesso são mantidos por até dois anos. Acesso aos dados relatórios estão disponíveis apenas para usuários com a função de Administrador.

Como criar um relatório de acesso aos dados

Os relatórios de acesso aos dados são fornecidos pelo método runAccessReport.

Recursos compartilhados com os relatórios principais

As solicitações de relatório de acesso aos dados têm a mesma semântica do Relatório principal comuns, para vários recursos compartilhados. Por exemplo: As especificações de Paginação, Filtros de dimensão e Períodos se comportam da mesma forma em relatórios de acesso a dados como Relatórios principais.

Familiarize-se com a visão geral da funcionalidade dos principais relatórios do a API Data v1. documento se concentrará nos recursos específicos das solicitações de relatório de acesso a dados.

Selecionar uma entidade denunciante

Semelhante aos Relatórios principais funcionalidade do API Data v1, runAccessReport da API Google Analytics Admin v1 exige o processo identificador de propriedade seja especificado um caminho de solicitação de URL no formato properties/GA_PROPERTY_ID, como:

  POST  https://analyticsadmin.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runAccessReport

O relatório de acesso aos dados resultante será gerado com base nas informações registros de acesso a dados para a propriedade especificada do Google Analytics.

Se você estiver usando uma das bibliotecas de cliente da API Admin, não é necessário manipular manualmente o caminho do URL da solicitação. A maioria dos clientes de API fornece um parâmetro property que deve ser preenchido com uma string no formato properties/GA_PROPERTY_ID. Veja o snippet de código na ao final deste guia para ver um exemplo de como usar as bibliotecas de cliente.

Dimensões e métricas

Dimensões descrevem e agrupam os dados de acesso da sua propriedade. Por exemplo, a dimensão userEmail indica o e-mail do usuário que acessou os dados de relatórios. Os valores de dimensão nas respostas de relatório são strings.

Métricas representam as medidas quantitativas de um relatório. A métrica accessCount retorna o número total de registros de acesso a dados.

Consulte o Esquema de acesso aos dados para ver uma lista completa das dimensões nomes de métricas disponíveis nas solicitações de relatórios de acesso aos dados.

Solicitação de relatório de acesso a dados

Para solicitar relatórios de acesso a dados, construa um objeto RunAccessReportRequest. Qa recomendamos começar com estes parâmetros de solicitação:

• Pelo menos uma entrada válida no campo date intervalos .
• Pelo menos uma entrada válida no dimensões .
• Se você não usar a dimensão epochTimeMicros, pelo menos uma entrada válida em as métricas para receber dados quantitativos de cada combinação de valores de dimensão na um relatório.

Veja um exemplo de solicitação com os campos recomendados. Essa consulta gera Lista de e-mails dos usuários, a hora mais recente em que eles acessaram a propriedade especificada durante os últimos sete dias e a contagem de acessos correspondentes.

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runAccessReport
{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "mostRecentAccessEpochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    }
  ],
  "metrics": [
    {
      "metricName": "accessCount"
    }
  ]
}

Denunciar resposta

Conceitualmente semelhante aos Relatórios principais funcionalidade da API Data v1, o Relatório de acesso a dados Resposta do solicitação de acesso de relatório é principalmente um cabeçalho e linhas. O cabeçalho consiste em AccessDimensionHeaders e AccessMetricHeaders que lista as colunas no relatório.

Cada relatório de acesso linha consiste em AccessDimensionValues e AccessMetricValues para as colunas do relatório. A ordem das colunas é consistente no o cabeçalho e todas as linhas.

Veja um exemplo de resposta para o exemplo de solicitação anterior:

{
  "dimensionHeaders": [
    {
      "dimensionName": "mostRecentAccessEpochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    }
  ],
  "metricHeaders": [
    {
      "metricName": "accessCount"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "1667591408427733"
        },
        {
          "value": "Bola@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "1238"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1667710959827161"
        },
        {
          "value": "Alex@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "475"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1667868650762743"
        },
        {
          "value": "Mahan@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "96"
        }
      ]
    }
  ],
  "rowCount": 3
}

Como filtrar registros de acesso

Use o dimensionFilter da tag RunAccessReportRequest para restringir a resposta do relatório a valores de dimensão específicos que correspondem ao filtro.

O exemplo a seguir gera um relatório com base no acesso a dados individuais filtrando os registros de acesso de um único usuário com e-mail Alex@example.net: O relatório contém a hora de cada registro de acesso, o horário e o endereço IP.

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runAccessReport
{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "epochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    },
    {
      "dimensionName": "userIP"
    }
  ],
  "dimensionFilter": {
    "accessFilter": {
      "fieldName": "userEmail",
      "stringFilter": {
        "matchType": "EXACT",
        "value": "Alex@example.net"
      }
    }
  }
}

Da mesma forma, metricFilter da tag RunAccessReportRequest pode ser usado para restringir a resposta de relatório a valores de métrica específicos que correspondem ao filtro.

O exemplo a seguir gera um relatório que contém e-mails e contagens de acesso de Todos os usuários que acessaram a propriedade especificada mais de 100 vezes.

{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "userEmail"
    }
  ],
  "metricFilter": {
    "accessFilter": {
      "numericFilter": {
        "operation": "GREATER_THAN",
        "value": {
          "int64Value": 100
        }
      },
      "fieldName": "accessCount"
    }
  },
  "metrics": [
    {
      "metricName": "accessCount"
    }
  ]
}

Relatórios de exemplo

Veja a seguir alguns exemplos de relatórios.

Relatório de acesso mais recente por usuário

O exemplo de relatório de acesso a seguir, que pode ser criado usando runAccessReport:

Esse relatório pode ser gerado consultando dimensões mostRecentAccessEpochTimeMicros; userEmail e a métrica accessCount. A contém uma linha para cada usuário: mostRecentAccessEpochTimeMicros agrega registros de acesso a dados para cada usuário que acessa a propriedade e retorna a hora do último acesso (em microssegundos Unix desde que o época) para cada linha.

Relatório de detalhamento do acesso do usuário

Outro exemplo de relatório útil é um detalhamento dos acessos dos usuários por acesso. Mecanismo (por exemplo, interface do usuário do Google Analytics, API etc.).

Esse relatório pode ser gerado consultando dimensões mostRecentAccessEpochTimeMicros; userEmail, accessMechanism e a accessCount métrica.

O relatório contém uma linha para cada combinação de usuário/mecanismo de acesso. A A dimensão mostRecentAccessEpochTimeMicros contém a última vez que um usuário acessou a propriedade usando o mecanismo de acesso especificado.

Relatório de visão geral do acesso à propriedade

É possível gerar um relatório para uma propriedade sem detalhar para usuários individuais. Por exemplo, o relatório a seguir mostra com que frequência uma propriedade são acessados usando diferentes Mecanismos de acesso:

Esse relatório pode ser gerado consultando dimensões accessedPropertyId; accessedPropertyName, accessMechanism e a accessCount métrica.

O relatório contém uma linha para cada combinação de ID da propriedade/mecanismo de acesso.

Relatório de acessos a dados individuais

Para gerar um relatório em que cada linha é baseada em um acesso a dados individual registro, omita a dimensão mostRecentAccessEpochTimeMicros de uma consulta e use a dimensão epochTimeMicros. Não é necessário consultar o accessCount, já que todas as linhas do relatório contêm informações sobre uma ocorrência única de acesso a dados.

O relatório a seguir contém informações detalhadas sobre cada vez que um usuário acessou a propriedade especificada.

Esse relatório pode ser gerado consultando dimensões epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned, revenueDataReturned.

Bibliotecas de cliente

Consulte o Guia de início rápido para ver uma explicação sobre como instalar e configurar bibliotecas de cliente.

Este é um exemplo que usa a biblioteca de cliente Python para executar uma consulta de acesso a dados e imprime a resposta.

from datetime import datetime

from google.analytics.admin import AnalyticsAdminServiceClient
from google.analytics.admin_v1alpha.types import (
    AccessDateRange,
    AccessDimension,
    AccessMetric,
    RunAccessReportRequest,
)


def run_sample():
    """Runs the sample."""
    # TODO(developer): Replace this variable with your Google Analytics 4
    #  property ID (e.g. "123456") before running the sample.
    property_id = "YOUR-GA4-PROPERTY-ID"
    run_access_report(property_id)


def run_access_report(property_id: str, transport: str = None):
    """
    Runs an access report for a Google Analytics property. The report will
    aggregate over dimensions `userEmail`, `accessedPropertyId`,
    `reportType`, `revenueDataReturned`, `costDataReturned`,
    `userIP`, and return the access count, as well as the most recent access
    time for each combination.
    See https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema
    for the description of each field used in a data access report query.
    Args:
        property_id(str): The Google Analytics Property ID.
        transport(str): The transport to use. For example, "grpc"
            or "rest". If set to None, a transport is chosen automatically.
    """
    client = AnalyticsAdminServiceClient(transport=transport)
    request = RunAccessReportRequest(
        entity=f"properties/{property_id}",
        dimensions=[
            AccessDimension(dimension_name="userEmail"),
            AccessDimension(dimension_name="accessedPropertyId"),
            AccessDimension(dimension_name="reportType"),
            AccessDimension(dimension_name="revenueDataReturned"),
            AccessDimension(dimension_name="costDataReturned"),
            AccessDimension(dimension_name="userIP"),
            AccessDimension(dimension_name="mostRecentAccessEpochTimeMicros"),
        ],
        metrics=[AccessMetric(metric_name="accessCount")],
        date_ranges=[AccessDateRange(start_date="yesterday", end_date="today")],
    )

    access_report = client.run_access_report(request)

    print("Result:")
    print_access_report(access_report)


def print_access_report(response):
    """Prints the access report."""
    print(f"{response.row_count} rows received")
    for dimensionHeader in response.dimension_headers:
        print(f"Dimension header name: {dimensionHeader.dimension_name}")
    for metricHeader in response.metric_headers:
        print(f"Metric header name: {metricHeader.metric_name})")

    for rowIdx, row in enumerate(response.rows):
        print(f"\nRow {rowIdx}")
        for i, dimension_value in enumerate(row.dimension_values):
            dimension_name = response.dimension_headers[i].dimension_name
            if dimension_name.endswith("Micros"):
                # Convert microseconds since Unix Epoch to datetime object.
                dimension_value_formatted = datetime.utcfromtimestamp(
                    int(dimension_value.value) / 1000000
                )
            else:
                dimension_value_formatted = dimension_value.value
            print(f"{dimension_name}: {dimension_value_formatted}")

        for i, metric_value in enumerate(row.metric_values):
            metric_name = response.metric_headers[i].metric_name
            print(f"{metric_name}: {metric_value.value}")

properties_run_access_report.py