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

Đối tượng trong Google Analytics giúp bạn phân đoạn người dùng theo những cách có ý nghĩa đối với công việc kinh doanh của bạn. Thông qua đối tượng, bạn có thể nhóm người dùng trang web hoặc ứng dụng của mình dựa trên các thuộc tính chung.

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

Hãy tham khảo hướng dẫn 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ệp xuất đối tượng.

Tổng quan

Hãy tạo các yêu cầu API Dữ liệu sau đây để tạo và truy vấn tệp xuất đối tượng:

  1. Gọi phương thức audienceExports.create để tạo tệp xuất đối tượng.
  2. Gọi phương thức audienceExports.query để 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 để 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 để liệt kê tất 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 API Dữ liệu đều yêu cầu bạn phải chỉ định mã nhận dạng tài sản Google Analytics bên trong đường dẫn yêu cầu URL, ở dạng 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 được thu thập trong tài sản Google Analytics đã chỉ định.

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

Tạo tệp xuất đối tượng

Để tạo tệp xuất đối tượng, hãy gọi phương thức audienceExports.create bằng cách sử dụng đối tượ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 trường audience, được định dạng là properties/{propertyId}/audiences/{audienceId}. Bạn có thể sử dụng phương thức audiences.list của API Quản trị Google Analytics phiên bản 1 để lấy giá trị này. Trường Audience.name của phản hồi audiences.list chứa tên đối tượng.
  • Danh sách phương diện hợp lệ trong trường dimensions. Bạn có thể xem danh sách các phương diện mà phương thức này hỗ trợ 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 mới được đưa vào tệp xuất đối tượng.

Sau đây là yêu cầu mẫu để tạo tệp 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 tên của tệp xuất đối tượng trong trường name, ví dụ: properties/1234567/audienceExports/123. Dưới đây là một 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ệp xuất đối tượng.

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

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

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

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

Sau đây là một 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 để 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 của tệp đó sẽ thay đổi từ CREATING thành ACTIVE.

Dưới đây là một 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ể lấy trạng thái của tất cả các lượt xuất đối tượng bằng cách gọi phương thức audienceExports.list.

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

Sau khi tạo tệp xuất đối tượng, hãy gọi phương thức audienceExports.query và chỉ định name của tệp xuất đối tượng trong yêu cầu.

Sau đây là một yêu cầu mẫu:

Yêu cầu HTTP

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

Nếu quá trình 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à một 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
}