Tổng quan về Google Analytics Data API

Bạn có thể sử dụng Data API để truy cập vào dữ liệu báo cáo trong Google Analytics theo phương thức lập trình.

Tìm hiểu thêm về tài sản Google Analytics.

Dữ liệu mà API trả về nhất quán với dữ liệu xuất hiện trong giao diện người dùng Google Analytics và hoàn toàn tuân thủ các chế độ cài đặt Thông tin nhận dạng trong báo cáo (chẳng hạn như Kết hợp, Quan sát hoặc Dựa trên thiết bị) được cấu hình cho tài sản Google Analytics của bạn.

Dưới đây là một số ví dụ mà bạn có thể báo cáo bằng Google Analytics Data API phiên bản 1:

  • Số người dùng hoạt động hằng ngày trong tuần qua của ứng dụng Android.
  • Số lượt xem trang của 10 trang hàng đầu trên trang web trong 28 ngày qua.
  • Số người dùng đang hoạt động ở mỗi quốc gia trong 30 phút qua của ứng dụng iOS.

Bạn cũng có thể sử dụng Google Analytics Data API phiên bản 1 để làm những việc sau:

  • Tạo các trang tổng quan tuỳ chỉnh để trình bày dữ liệu trong Google Analytics.
  • Tự động hoá các nhiệm vụ báo cáo phức tạp để tiết kiệm thời gian.
  • Tích hợp dữ liệu Google Analytics với các ứng dụng kinh doanh khác.

Tính nhất quán của dữ liệu và thông tin nhận dạng trong báo cáo

Google Analytics Data API phiên bản 1 truy cập vào cùng dữ liệu báo cáo như giao diện Google Analytics. Dữ liệu mà API trả về hoàn toàn tuân thủ các chế độ cài đặt Thông tin nhận dạng trong báo cáo được định cấu hình cho Tài sản Google Analytics của bạn, nhờ đó, số lượng người dùng, việc loại bỏ trùng lặp và mô hình dữ liệu sẽ phù hợp với không gian nhận dạng đã chọn (chẳng hạn như Kết hợp, Quan sát hoặc Dựa trên thiết bị) trong phần cài đặt tài sản.

Để tìm hiểu thêm về cách các không gian nhận dạng khác nhau có thể ảnh hưởng đến báo cáo của bạn, hãy xem bài viết Thông tin nhận dạng trong báo cáo.

Bắt đầu

Để bắt đầu sử dụng thư viện ứng dụng trong Java, Python, Node.js, PHP, C#, Go hoặc Ruby, hãy xem bài viết Bắt đầu nhanh về thư viện ứng dụng. Để tìm hiểu cách tạo truy vấn, lọc phương diện và đọc phản hồi, hãy xem bài viết Tạo báo cáo hoặc kiểm thử truy vấn một cách tương tác trong Trình khám phá truy vấn.

Yêu cầu và phản hồi mẫu runReport

Để truy vấn dữ liệu sự kiện qua REST, hãy gửi yêu cầu POST đến điểm cuối runReport bằng nội dung JSON RunReportRequest chỉ định dateRanges, dimensions, và metrics:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

Hoặc chạy lệnh curl tương đương bằng Thông tin xác thực mặc định của ứng dụng:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

API trả về RunReportResponse chứa tiêu đề cột và hàng dữ liệu:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

Các phương thức có thể sử dụng

Dưới đây là danh sách các phương thức Data API. Để biết thêm chi tiết, hãy xem tài liệu tham khảo.

  • runReport Phương thức này trả về báo cáo tùy chỉnh về dữ liệu sự kiện Google Analytics và là phương thức ưu tiên cho các truy vấn báo cáo đơn giản.
  • batchRunReports Đây là phiên bản hàng loạt của phương thức runReport, cho phép bạn tạo nhiều báo cáo bằng một lệnh gọi API.
  • runPivotReport Phương thức này trả về báo cáo сводный tuỳ chỉnh về dữ liệu sự kiện Google Analytics. Báo cáo сводный là định dạng nâng cao và biểu cảm hơn so với báo cáo thông thường. Mỗi сводный mô tả các cột và hàng phương diện có thể nhìn thấy trong phản hồi báo cáo.
  • batchRunPivotReports Đây là phiên bản hàng loạt của phương thức runPivotReport, cho phép bạn tạo nhiều báo cáo bằng một lệnh gọi API.
  • getMetadata Phương thức này trả về siêu dữ liệu cho các phương diện và chỉ số có trong các phương thức báo cáo. Dùng để khám phá các phương diện và chỉ số. Phản hồi của phương thức này cũng bao gồm các Phương diện và chỉ số tuỳ chỉnh có cho tài sản Google Analytics đã chỉ định.
  • checkCompatibility Phương thức này liệt kê các phương diện và chỉ số có thể thêm vào yêu cầu báo cáo và duy trì khả năng tương thích.
  • runRealtimeReport Phương thức này trả về báo cáo tuỳ chỉnh về dữ liệu sự kiện theo thời gian thực cho tài sản của bạn. Các sự kiện xuất hiện trong báo cáo theo thời gian thực vài giây sau khi được gửi đến Google Analytics. Báo cáo theo thời gian thực cho thấy dữ liệu về sự kiện và mức sử dụng trong phạm vi thời gian từ thời điểm hiện tại đến 30 phút trước (tối đa 60 phút đối với tài sản Google Analytics 360).
  • properties.audienceExports Một nhóm phương thức cho phép bạn tạo Báo cáo xuất đối tượng, bao gồm ảnh chụp nhanh về người dùng trong một đối tượng.
  • properties.recurringAudienceLists (Bản xem trước) Một nhóm phương thức cho phép bạn quản lý Báo cáo xuất đối tượng định kỳ. Báo cáo xuất đối tượng định kỳ tạo ra danh sách đối tượng mới mỗi ngày.
  • runFunnelReport (Bản xem trước) Phương thức này trả về báo cáo phễu tuỳ chỉnh về dữ liệu sự kiện Google Analytics. Kỹ thuật khám phá phễu cho phép bạn thể hiện các bước mà người dùng cần thực hiện để hoàn tất một hành động bằng hình ảnh, và xem nhanh mức độ mà họ hoàn tất hoặc không hoàn tất ở mỗi bước.
  • properties.chat (Bản xem trước) Phương thức này cung cấp quyền truy cập theo phương thức lập trình vào tính năng Ask Advisor trong Google Analytics. Bạn có thể đặt câu hỏi bằng ngôn ngữ tự nhiên về dữ liệu sự kiện, chẩn đoán các thay đổi về hiệu suất và nhận thông tin chi tiết dạng bảng và dạng tường thuật có cấu trúc.

Các phương diện và chỉ số được hỗ trợ

Để xem danh sách tất cả các phương diện và chỉ số mà Data API hỗ trợ, hãy xem tài liệu về lược đồ API.