รายงานการเข้าถึงข้อมูล

คุณสร้างรายงานการเข้าถึงข้อมูลได้โดยใช้เมธอด Admin API v1 runAccessReport รายงานนี้จะแสดงทุกครั้งที่ผู้ใช้อ่านข้อมูล Google Analytics ระบบจะเก็บบันทึกการเข้าถึงข้อมูลไว้ไม่เกิน 2 ปี รายงานการเข้าถึงข้อมูลพร้อมใช้งานสําหรับผู้ใช้ที่มีบทบาทผู้ดูแลระบบเท่านั้น

ขอรายงานการเข้าถึงข้อมูลโดยใช้ไลบรารีไคลเอ็นต์

วิธีที่รวดเร็วที่สุดในการเริ่มต้นใช้งานรายงานการเข้าถึงข้อมูลคือการใช้ไลบรารีไคลเอ็นต์

ดูคําอธิบายเกี่ยวกับวิธีติดตั้งและกําหนดค่าไลบรารีไคลเอ็นต์ Google Analytics ได้ในคู่มือเริ่มใช้งานฉบับย่อ

ต่อไปนี้คือตัวอย่างการใช้ไลบรารีไคลเอ็นต์ Python ที่เรียกใช้การค้นหาการเข้าถึงข้อมูลและพิมพ์คำตอบ

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

ฟีเจอร์ที่แชร์กับรายงานหลัก

คำขอรายงานการเข้าถึงข้อมูลมีความหมายเหมือนกับคำขอรายงานหลักสำหรับฟีเจอร์ทั่วไปหลายรายการ ตัวอย่างเช่น การแบ่งหน้า ตัวกรองมิติข้อมูล และช่วงวันที่จะทํางานเหมือนกันในรายงานทั้ง 2 ประเภท

ทําความคุ้นเคยกับภาพรวมของรายงานหลักใน Data API v1 จากนั้นกลับมาที่หน้านี้เพื่อดูข้อมูลเพิ่มเติมเกี่ยวกับรายงานการเข้าถึงข้อมูล

สร้างรายงานการเข้าถึงข้อมูล

ใช้เมธอด runAccessReport เพื่อขอรายงานการเข้าถึงข้อมูล

เลือกเอนทิตีการรายงาน

เช่นเดียวกับฟังก์ชันการรายงานหลักของ Data API v1 เมธอด runAccessReport ของ Google Analytics Admin API v1 กำหนดให้ต้องระบุตัวระบุพร็อพเพอร์ตี้ Google Analytics ในเส้นทางคำขอ URL ในรูปแบบ properties/GA_PROPERTY_ID เช่น

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

รายงานการเข้าถึงข้อมูลที่แสดงจะสร้างขึ้นจากระเบียนการเข้าถึงข้อมูล Google Analytics สําหรับพร็อพเพอร์ตี้ Google Analytics ที่ระบุ

หากคุณใช้ไลบรารีไคลเอ็นต์ Admin API รายการใดรายการหนึ่ง ก็ไม่จำเป็นต้องจัดการเส้นทาง URL คำขอด้วยตนเอง ไคลเอ็นต์ API ส่วนใหญ่จะให้พารามิเตอร์ property ที่คาดหวังสตริงในรูปแบบของ properties/GA_PROPERTY_ID ดูตัวอย่างการใช้ไลบรารีของไคลเอ็นต์ได้ที่ข้อมูลโค้ดตอนต้นของหน้านี้

เลือกมิติข้อมูลและเมตริก

มิติข้อมูลอธิบายและจัดกลุ่มข้อมูลการเข้าถึงสําหรับพร็อพเพอร์ตี้ เช่น มิติข้อมูล userEmail ระบุอีเมลของผู้ใช้ที่เข้าถึงข้อมูลการรายงาน ค่ามิติข้อมูลในการตอบกลับรายงานคือสตริง

เมตริกแสดงการวัดเชิงปริมาณของรายงาน เมตริก accessCount จะแสดงจํานวนระเบียนการเข้าถึงข้อมูลทั้งหมด

ดูรายการมิติข้อมูลและชื่อเมตริกทั้งหมดที่ใช้ได้ในคําขอรายงานการเข้าถึงข้อมูลได้ที่สคีมาการเข้าถึงข้อมูล

ขอรายงาน

หากต้องการขอรายงานการเข้าถึงข้อมูล ให้สร้างออบเจ็กต์ RunAccessReportRequest เราขอแนะนำให้เริ่มต้นด้วยพารามิเตอร์คำขอต่อไปนี้

• รายการที่ถูกต้องอย่างน้อย 1 รายการในฟิลด์ช่วงวันที่
• รายการที่ถูกต้องอย่างน้อย 1 รายการในฟิลด์มิติข้อมูล
• หากไม่ได้ใช้มิติข้อมูล epochTimeMicros ให้ป้อนรายการที่ถูกต้องอย่างน้อย 1 รายการในช่องเมตริกเพื่อรับข้อมูลเชิงปริมาณสําหรับชุดค่าผสมของค่ามิติข้อมูลแต่ละชุดในรายงาน

ต่อไปนี้คือตัวอย่างคำขอที่มีช่องที่แนะนำ การค้นหานี้จะสร้างรายการอีเมลของผู้ใช้ เวลาล่าสุดที่ผู้ใช้เข้าถึงพร็อพเพอร์ตี้ที่ระบุในช่วง 7 วันที่ผ่านมา และจํานวนการเข้าถึงที่เกี่ยวข้อง

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

อ่านคำตอบ

การตอบกลับรายงานการเข้าถึงข้อมูลประกอบด้วยส่วนหัวและแถวเป็นหลัก ส่วนหัวประกอบด้วย 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
}

กรองตามระเบียนการเข้าถึง

ใช้ช่อง dimensionFilter ของออบเจ็กต์ RunAccessReportRequest เพื่อจํากัดการตอบสนองของรายงานให้แสดงเฉพาะค่ามิติข้อมูลที่ตรงกับตัวกรอง

ตัวอย่างต่อไปนี้สร้างรายงานตามระเบียนการเข้าถึงข้อมูลแต่ละรายการ โดยกรองระเบียนการเข้าถึงของผู้ใช้รายเดียวที่มีอีเมลAlex@example.net รายงานมีเวลาของระเบียนการเข้าถึงแต่ละรายการ อีเมล และที่อยู่ 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"
      }
    }
  }
}

ในทํานองเดียวกัน คุณสามารถใช้ช่อง metricFilter ของออบเจ็กต์ RunAccessReportRequest เพื่อจํากัดการตอบสนองของรายงานให้แสดงเฉพาะค่าเมตริกที่ตรงกับตัวกรอง

ตัวอย่างต่อไปนี้จะสร้างรายงานที่มีอีเมลและจํานวนการเข้าถึงของผู้ใช้ทั้งหมดที่เข้าถึงพร็อพเพอร์ตี้ที่ระบุมากกว่า 100 ครั้ง

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

รายงานตัวอย่าง

ต่อไปนี้คือรายงานตัวอย่างที่คุณลองใช้ได้

การเข้าถึงล่าสุด

ตัวอย่างรายงานการเข้าถึงต่อไปนี้ที่สร้างได้โดยใช้ runAccessReport

รายงานนี้สร้างขึ้นได้โดยการค้นหามิติข้อมูล mostRecentAccessEpochTimeMicros, userEmail และเมตริก accessCount รายงานมี 1 แถวต่อผู้ใช้แต่ละราย โดยมิติข้อมูล mostRecentAccessEpochTimeMicros จะรวบรวมระเบียนการเข้าถึงข้อมูลของผู้ใช้แต่ละรายที่เข้าถึงพร็อพเพอร์ตี้ และแสดงผลเวลาเข้าถึงล่าสุด (เป็นไมโครวินาที Unix นับจากจุดเริ่มต้น) สําหรับแต่ละแถว

รายละเอียดการเข้าถึงของผู้ใช้

อีกตัวอย่างของรายงานที่มีประโยชน์คือรายละเอียดการเข้าถึงของผู้ใช้ตามกลไกการเข้าถึง (เช่น อินเทอร์เฟซผู้ใช้ Google Analytics, API ฯลฯ)

รายงานนี้สร้างขึ้นได้โดยการค้นหามิติข้อมูล mostRecentAccessEpochTimeMicros, userEmail, accessMechanism และaccessCount เมตริก

รายงานจะมี 1 แถวต่อชุดค่าผสมผู้ใช้/กลไกการเข้าถึงแต่ละชุด มิติข้อมูล mostRecentAccessEpochTimeMicros มีเวลาที่ผู้ใช้เข้าถึงพร็อพเพอร์ตี้ครั้งล่าสุดโดยใช้กลไกการเข้าถึงที่ระบุ

ภาพรวมการเข้าถึงพร็อพเพอร์ตี้

คุณสามารถสร้างรายงานสําหรับพร็อพเพอร์ตี้โดยไม่มีการแจกแจงรายละเอียดผู้ใช้แต่ละรายได้ ตัวอย่างเช่น รายงานต่อไปนี้จะระบุความถี่ที่มีการเข้าถึงพร็อพเพอร์ตี้โดยใช้กลไกการเข้าถึงที่แตกต่างกัน

รายงานนี้สร้างขึ้นได้โดยการค้นหามิติข้อมูล accessedPropertyId, accessedPropertyName, accessMechanism และaccessCount เมตริก

รายงานจะมี 1 แถวต่อรหัสพร็อพเพอร์ตี้/ชุดค่าผสมของกลไกการเข้าถึงแต่ละรายการ

การเข้าถึงข้อมูลส่วนบุคคล

หากต้องการสร้างรายงานที่แต่ละแถวอิงตามระเบียนการเข้าถึงข้อมูลแต่ละรายการ ให้ละเว้นมิติข้อมูล mostRecentAccessEpochTimeMicros ออกจากการค้นหา และใช้มิติข้อมูล epochTimeMicros แทน คุณไม่จําเป็นต้องค้นหาเมตริก accessCount เนื่องจากทุกแถวของรายงานมีข้อมูลเกี่ยวกับการเข้าถึงข้อมูลที่เกิดขึ้นครั้งเดียว

รายงานต่อไปนี้มีรายละเอียดเกี่ยวกับแต่ละครั้งที่ผู้ใช้เข้าถึงพร็อพเพอร์ตี้ที่ระบุ

รายงานนี้สร้างขึ้นได้โดยการค้นหามิติข้อมูล epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned, revenueDataReturned