개요

Google 애널리틱스 Admin API v1을 사용하면 runAccessReport 메서드를 사용하여 데이터 액세스 보고서를 생성할 수 있습니다. 이 보고서는 사용자가 Google 애널리틱스 보고 데이터를 읽을 때마다 기록을 제공합니다. 액세스 기록은 최대 2년 동안 보관됩니다. 데이터 액세스 보고서는 관리자 역할이 있는 사용자만 사용할 수 있습니다.

데이터 액세스 보고서 만들기

데이터 액세스 보고는 runAccessReport 메서드에서 제공됩니다.

핵심 보고서와 함께 제공되는 기능

데이터 액세스 보고서 요청은 여러 공유 기능에 대해 핵심 보고서 요청과 동일한 의미 체계를 갖습니다. 예를 들어 페이지로 나누기, 측정기준 필터, 기간 사양은 데이터 액세스 보고서에서 핵심 보고서와 동일하게 작동합니다.

이 문서의 나머지 부분에서는 데이터 액세스 보고서 요청과 관련된 기능을 중점적으로 다루므로 Data API v1의 핵심 보고 기능 개요를 숙지하세요.

보고 항목 선택

Data API v1의 핵심 보고 기능과 마찬가지로 Google 애널리틱스 Admin API v1의 runAccessReport 메서드를 사용하려면 다음과 같이 properties/GA4_PROPERTY_ID 형식의 URL 요청 경로 내에 Google 애널리틱스 4 속성 식별자를 지정해야 합니다.

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

결과 데이터 액세스 보고서는 지정된 Google 애널리틱스 4 속성의 Google 애널리틱스 데이터 액세스 레코드를 기반으로 생성됩니다.

Admin API 클라이언트 라이브러리 중 하나를 사용하는 경우 요청 URL 경로를 수동으로 조작할 필요가 없습니다. 대부분의 API 클라이언트는 properties/GA4_PROPERTY_ID 형식의 문자열을 예상하는 property 매개변수를 제공합니다. 클라이언트 라이브러리 사용 예는 이 가이드의 코드 스니펫을 참고하세요.

측정기준 및 측정항목

측정기준은 속성의 액세스 데이터를 설명하고 그룹화합니다. 예를 들어 userEmail 측정기준은 보고 데이터에 액세스한 사용자의 이메일을 나타냅니다. 보고서 응답의 측정기준 값은 문자열입니다.

측정항목은 보고서의 정량적 측정값을 나타냅니다. accessCount 측정항목은 데이터 액세스 레코드의 총 수를 반환합니다.

데이터 액세스 보고서 요청에 사용할 수 있는 측정기준 및 측정항목 이름의 전체 목록은 데이터 액세스 스키마를 참조하세요.

데이터 액세스 보고서 요청

데이터 액세스 보고서를 요청하려면 RunAccessReportRequest 객체를 구성합니다. 먼저 다음 요청 매개변수로 시작하는 것이 좋습니다.

  • 기간 입력란에 유효한 항목이 하나 이상 있어야 합니다.
  • 측정기준 필드에 유효한 항목이 1개 이상 있어야 합니다.
  • epochTimeMicros 측정기준을 사용하지 않는 경우 metrics 필드에 유효한 항목을 하나 이상 입력하여 보고서의 각 측정기준 값 조합에 대한 정량적 데이터를 수신합니다.

다음은 권장 필드가 포함된 샘플 요청입니다. 이 쿼리는 사용자 이메일 목록, 지난 7일 동안 지정된 속성에 사용자가 가장 최근에 액세스한 시간, 해당하는 액세스 수를 생성합니다.

HTTP

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

응답 신고

액세스 보고서 요청의 데이터 액세스 보고서 응답은 Data API v1의 핵심 보고 기능과 개념적으로 유사하게 주로 헤더와 행입니다. 헤더는 보고서의 열을 나열하는 AccessDimensionHeaders 및 AccessMetricHeaders로 구성됩니다.

각 액세스 보고서 행은 보고서 열의 AccessDimensionValues 및 AccessMetricValues로 구성됩니다. 열의 순서는 요청, 헤더, 모든 행에서 일관됩니다.

다음은 이전 샘플 요청에 대한 샘플 응답입니다.

{
  "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
}

액세스 레코드 필터링

보고서 응답을 필터와 일치하는 특정 측정기준 값으로 제한하려면 RunAccessReportRequest 객체의 dimensionFilter 필드를 사용합니다.

다음 예시에서는 이메일 Alex@example.net를 사용하는 단일 사용자의 액세스 레코드를 필터링하여 개별 데이터 액세스 레코드를 기반으로 보고서를 생성합니다. 보고서에는 각 액세스 기록 시간, 사용자 이메일, IP 주소가 포함됩니다.

HTTP

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA4_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"
      }
    }
  }
}

마찬가지로 RunAccessReportRequest 객체의 metricFilter 필드를 사용하여 보고서 응답을 필터와 일치하는 특정 측정항목 값으로 제한할 수 있습니다.

다음 예에서는 지정된 속성에 100회 넘게 액세스한 모든 사용자의 이메일과 액세스 수가 포함된 보고서를 생성합니다.

HTTP

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

예시 보고서

다음과 같은 샘플러 보고서를 사용해 볼 수 있습니다.

사용자당 최근 액세스 보고서

다음은 runAccessReport를 사용하여 만들 수 있는 샘플 액세스 보고서입니다.

최근 액세스 에포크 시간 마이크로 사용자 이메일 액세스 수
1525220215025371 Bola@example.net 5
1525220215028361 Alex@example.net 36
1525220215027671 Charlie@example.net 1153
1525220215027341 Mahan@example.net 1

이 보고서는 측정기준 mostRecentAccessEpochTimeMicros, userEmail, accessCount 측정항목을 쿼리하여 생성할 수 있습니다. 보고서에는 사용자별로 하나의 행이 포함됩니다. mostRecentAccessEpochTimeMicros 측정기준은 속성에 액세스하는 각 사용자의 데이터 액세스 레코드를 집계하고 각 행의 마지막 액세스 시간 (에포크 이후 유닉스 마이크로초)을 반환합니다.

사용자 액세스 분석 보고서

유용한 보고서의 또 다른 예는 액세스 메커니즘 (예: Google 애널리틱스 사용자 인터페이스, API 등)별 사용자 액세스 분석입니다.

최근 액세스 에포크 시간 마이크로 사용자 이메일 액세스 메커니즘 액세스 수
1525220215028367 Alex@example.net Firebase 31
1525220215555778 Alex@example.net Google 애널리틱스 사용자 인터페이스 1
1525220215022378 Bola@example.net Google 애널리틱스 사용자 인터페이스 65
1525220215026389 Bola@example.net Google 애널리틱스 API 894
1525220215025631 Charlie@example.net Google 애널리틱스 API 67
1525220215068325 Mahan@example.net Google Ads 3

이 보고서는 측정기준 mostRecentAccessEpochTimeMicros, userEmail, accessMechanism, accessCount 측정항목을 쿼리하여 생성할 수 있습니다.

보고서에는 사용자/액세스 메커니즘 조합별로 행이 하나씩 포함되어 있습니다. mostRecentAccessEpochTimeMicros 측정기준에는 사용자가 지정된 액세스 메커니즘을 사용하여 속성에 마지막으로 액세스한 시간이 포함됩니다.

속성 액세스 개요 보고서

개별 사용자를 분류하지 않고 속성 보고서를 생성할 수 있습니다. 예를 들어 다음 보고서는 다양한 액세스 메커니즘을 사용하여 속성에 액세스하는 빈도를 나타냅니다.

액세스한 속성 ID 액세스한 속성 이름 액세스 메커니즘 액세스 수
12345678 DemoApp Firebase 31
12345678 DemoApp Google 애널리틱스 사용자 인터페이스 624
12345678 DemoApp Google Ads 83
12345678 DemoApp Google 애널리틱스 API 1744

이 보고서는 측정기준 accessedPropertyId, accessedPropertyName, accessMechanism, accessCount 측정항목을 쿼리하여 생성할 수 있습니다.

보고서에는 각 속성 ID/액세스 메커니즘 조합당 하나의 행이 포함됩니다.

개별 데이터 액세스 보고서

각 행이 개별 데이터 액세스 레코드를 기반으로 하는 보고서를 생성하려면 쿼리에서 mostRecentAccessEpochTimeMicros 측정기준을 생략하고 대신 epochTimeMicros 측정기준을 사용합니다. 보고서의 모든 행에 단일 데이터 액세스 어커런스에 대한 정보가 포함되어 있으므로 accessCount 측정항목을 쿼리할 필요가 없습니다.

다음 보고서에는 사용자가 지정된 속성에 액세스할 때마다 세부정보가 포함되어 있습니다.

에포크 시간 마이크로 사용자 이메일 액세스한 속성 ID 액세스한 속성 이름 사용자 IP 액세스 메커니즘 비용 데이터 반환 반환된 수익 데이터
1525220215025371 Bola@example.net 12345678 DemoApp 1.2.3.1 Google 애널리틱스 사용자 인터페이스 true true
1525220645645645 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google 애널리틱스 사용자 인터페이스 false false
1525220211312322 Bola@example.net 12345678 DemoApp 11.22.33.11 Google Ads true false
1525220210234221 Alex@example.net 12345678 DemoApp 11.22.33.22 Firebase false false
1525220215028368 Alex@example.net 12345678 DemoApp 1.2.3.2 Google Ads false false
1525220214234231 Mahan@example.net 12345678 DemoApp 11.22.33.55 Google Ads true true
1525220423423452 Charlie@example.net 12345678 DemoApp 1.2.3.3 Google 애널리틱스 API true false
1525220132312333 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Ads true true

이 보고서는 측정기준 epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned, revenueDataReturned를 쿼리하여 생성할 수 있습니다.

클라이언트 라이브러리

클라이언트 라이브러리를 설치하고 구성하는 방법에 대한 설명은 빠른 시작 가이드를 참고하세요.

다음은 데이터 액세스 쿼리를 실행하고 응답을 출력하는 Python 클라이언트 라이브러리 사용 예시입니다.

Python

google-analytics-admin/properties_run_access_report.py
Cloud Shell에서 열기 GitHub에서 보기 
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