Tạo dữ liệu xuất đối tượng

Đối tượng trong Google Analytics cho phép bạn phân khúc người dùng theo những cách quan trọng đối với doanh nghiệp của bạn. Bằng đối tượng, bạn có thể nhóm người dùng của trang web hoặc ứng dụng dựa trên .

Bạn có thể xuất đối tượng của mình (bao gồm cả thông tin tổng quan nhanh về người dùng) bằng cách sử dụng API dữ liệu.

Tham khảo bài viết Kỳ vọng về dữ liệu xuất đối tượng để biết thông tin quan trọng về dữ liệu mà bạn thấy trong tính năng xuất đối tượng.

Tổng quan

Thực hiện các yêu cầu sau đây về Data API để tạo và truy vấn một tệp xuất đối tượng:

  1. Gọi audienceExports.create để tạo dữ liệu xuất đối tượng.
  2. Gọi audienceExports.query được dùng để truy xuất người dùng trong đối tượng.

Để biết thêm thông tin, bạn có thể gọi audienceExports.get đến truy xuất siêu dữ liệu cấu hình về một tệp xuất đối tượng cụ thể và audienceExports.list đến liệt kê tất cả các tệp xuất đối tượng cho một tài sản cụ thể.

Chọn một pháp nhân báo cáo

Tất cả các phương thức Data API đều yêu cầu tài sản Google Analytics mã nhận dạng được chỉ định bên trong đường dẫn yêu cầu URL, trong của properties/GA_PROPERTY_ID. Ví dụ:

  POST  https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID/audienceExports

Báo cáo này được tạo dựa trên dữ liệu sự kiện Google Analytics đã thu thập trong tài sản Google Analytics được chỉ định.

Nếu đang sử dụng một trong các thư viện ứng dụng Data API, bạn không cần thay đổi đường dẫn URL yêu cầu. Hầu hết ứng dụng API đều cung cấp property tham số mong đợi chuỗi ở dạng properties/GA_PROPERTY_ID. Xem Hướng dẫn bắt đầu nhanh để xem các ví dụ về cách sử dụng thư viện ứng dụng.

Tạo dữ liệu xuất đối tượng

Để tạo tính năng xuất đối tượng, hãy gọi phương thức audienceExports.create bằng cách sử dụng AudienceExport trong yêu cầu của bạn. Các tham số sau đây là bắt buộc:

  • Tên đối tượng hợp lệ trong audience được định dạng là properties/{propertyId}/audiences/{audienceId}. Bạn có thể sử dụng audiences.list của API Quản trị Google Analytics phiên bản 1 để có được giá trị này. Chiến lược phát hành đĩa đơn Audience.name trường của phản hồi audiences.list có chứa tên đối tượng.
  • Danh sách phương diện hợp lệ trong dimensions . Bạn có thể tìm thấy danh sách phương diện được hỗ trợ bằng phương pháp này trong Tài liệu về giản đồ xuất đối tượng. Chỉ dữ liệu cho các phương diện được đề cập trong trường này được bao gồm trong đối tượng xuất.

Dưới đây là yêu cầu mẫu để tạo dữ liệu xuất đối tượng:

Yêu cầu HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports
{
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Phản hồi của phương thức audienceExports.create chứa dữ liệu xuất đối tượng tên vào trường name, ví dụ: properties/1234567/audienceExports/123. Dưới đây là phản hồi mẫu:

Phản hồi HTTP

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceExport",
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "CREATING",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  }
}

Bạn có thể sử dụng name để truy vấn người dùng trong tính năng xuất đối tượng.

Truy vấn trạng thái sẵn sàng của tính năng xuất đối tượng

Có thể mất vài phút để tạo tệp xuất đối tượng sau audienceExports.create .

Bạn có thể kiểm tra trạng thái sẵn sàng xuất đối tượng bằng cách gọi hàm Phương thức audienceExports.get.

Sử dụng tên xuất đối tượng từ phản hồi audienceExports.create cho hãy chỉ định tệp xuất đối tượng trong yêu cầu của bạn.

Dưới đây là yêu cầu mẫu:

Yêu cầu HTTP

GET https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123

Trạng thái sẵn sàng cho việc xuất đối tượng được trả về trong trường state của phản hồi. Sau khi quá trình tạo tệp xuất đối tượng hoàn tất, trạng thái thay đổi từ CREATING thành ACTIVE.

Dưới đây là phản hồi mẫu:

Phản hồi HTTP

{
  "name": "properties/1234567/audienceExports/123",
  "audience": "properties/1234567/audiences/12345",
  "audienceDisplayName": "Purchasers",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ],
  "state": "CREATING",
  "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
}

Bạn có thể biết trạng thái của tất cả các lượt xuất đối tượng bằng cách gọi hàm audienceExports.list .

Truy xuất người dùng từ tệp xuất đối tượng

Sau khi tạo dữ liệu xuất đối tượng, hãy gọi phương thức audienceExports.query rồi chỉ định name của tính năng xuất đối tượng trong yêu cầu.

Dưới đây là yêu cầu mẫu:

Yêu cầu HTTP

POST https://analyticsdata.googleapis.com/v1beta/properties/1234567/audienceExports/123:query

Nếu tính năng xuất đối tượng đã sẵn sàng, lệnh gọi này sẽ trả về danh sách người dùng trong đối tượng.

Dưới đây là phản hồi mẫu:

Phản hồi HTTP

{
  "audienceExport": {
    "name": "properties/1234567/audienceExports/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2023-06-22T23:35:28.787910949Z"
  },
  "audienceRows": [
    {
      "dimensionValues": [
        {
          "value": "1000276123.1681742376"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000374452.1668627377"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000391956.1652750758"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000410539.1682018694"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1000703969.1666725875"
        }
      ]
    }
  ],
  "rowCount": 5
}