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 của 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 do API trả về nhất quán với dữ liệu hiển thị trong giao diện người dùng Google Analytics và hoàn toàn tuân thủ 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 được hoặc Theo thiết bị) được định 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:

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

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 một dữ liệu báo cáo như giao diện Google Analytics. Dữ liệu do API trả về hoàn toàn tuân thủ 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ố người dùng, việc loại bỏ trùng lặp và mô hình hoá 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, Đã ghi nhận hoặc Theo thiết bị) trong chế độ cài đặt tài sản của bạ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 bằng Java, Python, Node.js, PHP, C#, Go hoặc Ruby, hãy xem phần hướng dẫn 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 tra 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 của 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 có nội dung JSON RunReportRequest chỉ định dateRanges, dimensions và metrics của bạn:

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 cách sử dụ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ề một 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 hiện có

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

  • runReport Phương thức này trả về một 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 theo lô 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 duy nhất.
  • runPivotReport Phương thức này trả về báo cáo tổng hợp tuỳ chỉnh của dữ liệu sự kiện Google Analytics. Báo cáo tổng hợp 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 bảng tổng hợp mô tả các cột và hàng phương diện hiển thị 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 duy nhất.
  • 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ó sẵn cho tài sản Google Analytics được chỉ định.
  • checkCompatibility Phương thức này liệt kê các phương diện và chỉ số có thể được thêm vào một 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ề một 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. Sự kiện sẽ 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 biết các sự kiện và dữ liệu 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 tệp Xuất đối tượng, trong đó có thông tin tổng quan 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ý các hoạt động Xuất đối tượng định kỳ. Một yêu cầu xuất đối tượng định kỳ sẽ 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 của 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 có lập trình vào tính năng trò chuyện của 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à 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ả phương diện và chỉ số mà Data API hỗ trợ, hãy xem tài liệu về lược đồ API.