Cấp phép tài khoản do đối tác kiểm soát – Hướng dẫn cho nhà phát triển API

Giới thiệu

createAccountTree là một phần của API cấp phép có thể được dùng để tạo tài khoản Google Analytics mới trên quy mô lớn. Không giống như createAccountTicket, createAccountTree không yêu cầu bất kỳ hoạt động tương tác nào của người dùng cuối để hoàn tất việc tạo tài khoản; quá trình này là hoàn toàn tự động. Điều này hữu ích khi bạn cần cung cấp tài khoản Analytics mà bạn kiểm soát thay mặt cho khách hàng và khi bạn cung cấp chế độ xem tùy chỉnh dữ liệu đó cho khách hàng của mình.

API này dành riêng cho những đối tác kiểm soát các tài sản web hoặc trang web của người dùng của họ. Nếu người dùng của bạn kiểm soát các trang web hoặc tài sản web của riêng họ, thì bạn nên tạo tài khoản Analytics do người dùng kiểm soát.

Trước khi bắt đầu

Tất cả API Google Analytics đều được truy cập theo cách tương tự. Trước khi bắt đầu sử dụng API cấp phép, bạn nên:

  • Hãy đọc trang thư viện ứng dụng để biết danh sách đầy đủ các thư viện ứng dụng cụ thể của ngôn ngữ lập trình hoạt động với API.
  • Đọc Hướng dẫn tham khảo để tìm hiểu về giao diện API và cách truy cập vào dữ liệu mà không cần thư viện ứng dụng.

Mỗi thư viện ứng dụng cung cấp một đối tượng dịch vụ phân tích duy nhất để truy cập API cấp phép. Để tạo đối tượng dịch vụ, thường thì bạn phải trải qua các bước sau:

  1. Đăng ký ứng dụng của bạn trong Google API Console.
  2. Uỷ quyền tạo tài khoản Google Analytics mới.
  3. Tạo một đối tượng dịch vụ Analytics.

Nếu bạn chưa hoàn tất các bước này, vui lòng dừng lại và đọc Xin chào hướng dẫn về API Google Analytics. Hướng dẫn này sẽ hướng dẫn bạn qua các bước tạo ứng dụng API Google Analytics đầu tiên. Sau khi hoàn tất, bạn sẽ hiểu cách truy cập vào các API Google Analytics để thực hiện các công việc thực tế.

Tài khoản mẫu

Để được phép sử dụng API này, bạn sẽ phải cung cấp một Tài khoản Google Analytics mới, đóng vai trò là tài khoản mẫu cho API này. Khi được tạo, tài khoản mới sẽ kế thừa các chế độ cài đặt khác nhau của tài khoản mẫu, bao gồm cả người chấp nhận Điều khoản dịch vụ, Tổ chức và các chế độ cài đặt chia sẻ dữ liệu khác. Hãy xem tài liệu tham khảo về createAccountTree để biết thêm thông tin chi tiết về tài khoản mẫu, bao gồm cả danh sách tất cả dữ liệu kế thừa.

Cấp phép tài khoản

Để cấp phép cho tài khoản Google Analytics mới, hãy gửi yêu cầu đến điểm cuối API createAccountTree. Bạn sẽ cần có các thông tin cấp phép sau đây:

  • Trường Tài khoản
    • Một accountName cho tài khoản.
  • Trường Thuộc tính web
    • webpropertyName cho thuộc tính.
    • websiteUrl. Đây phải là URL được liên kết với thuộc tính người dùng cho tài khoản Analytics này.
  • Trường Xem
    • profileName cho khung hiển thị.
    • timezone cho khung hiển thị.

Sau khi có thông tin chi tiết, hãy thực hiện lệnh gọi đã xác thực đến điểm cuối API:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

Nếu thành công, API sẽ phản hồi kèm theo thông tin chi tiết về tài khoản, thuộc tính web và chế độ xem mới tạo:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

Quyền sở hữu và quản lý tài khoản

Tài khoản Google Analytics đã tạo sẽ thuộc sở hữu của bất kỳ tài khoản người dùng nào đã cho phép phản hồi qua OAuth. Vì lý do này, tổ chức của bạn nên sử dụng tài khoản dịch vụ để quản lý Tài khoản Analytics, thay vì tài khoản người dùng cá nhân.

Sau khi tạo tài khoản, bạn có thể định cấu hình tài khoản đó bằng API Quản lý. Sau đây là một số tác vụ phổ biến cho một tài khoản mới tạo:

Làm rõ mối quan hệ tài khoản

Giống như với tất cả các API của Google, bạn cần phải có một dự án trên Google Cloud làm điểm bắt đầu để cấp phép yêu cầu. Như mô tả trong tài liệu về OAuth 2.0, tài khoản này là nơi bạn sẽ quản lý thông tin đăng nhập cho các yêu cầu API. Tuy nhiên, tài khoản Google Analytics đã tạo không được liên kết trực tiếp với dự án Cloud hoặc tài khoản quản lý của dự án dưới bất kỳ hình thức nào. Tài khoản này chỉ được liên kết với tài khoản người dùng hoặc tài khoản dịch vụ đã uỷ quyền yêu cầu. Bạn có thể sử dụng API Quản lý nếu cần thiết lập quyền truy cập vào tài khoản đối với tài khoản Analytics.