Phản hồi lỗi

Khi yêu cầu API thành công, API sẽ trả về mã trạng thái 200 OK cùng với dữ liệu được yêu cầu trong nội dung phản hồi. Nếu xảy ra lỗi, API sẽ trả về một trong các mã lỗi chuẩn do Google API xác định, được ánh xạ đến mã trạng thái HTTP và một nội dung phản hồi chứa thông tin lỗi. Khi gặp lỗi, hãy kiểm tra các trường message và status trong nội dung phản hồi JSON để biết thông tin chi tiết cụ thể nhằm giúp gỡ lỗi.

Định dạng lỗi

Nếu một yêu cầu dẫn đến lỗi, API sẽ trả về mã trạng thái HTTP thích hợp và một nội dung phản hồi JSON. Phản hồi lỗi chứa một đối tượng error có cấu trúc sau:

{
  "error": {
    "code": 403,
    "message": "User does not have sufficient permissions for this property.",
    "status": "PERMISSION_DENIED"
  }
}

Đối tượng error chứa các trường sau:

Trường Mô tả
code Mã trạng thái HTTP, chẳng hạn như 400, 401, 403, 429 hoặc 500.
message Nội dung mô tả ngắn về lỗi.
status Mã lỗi chuẩn, chẳng hạn như INVALID_ARGUMENT, UNAUTHENTICATED, PERMISSION_DENIED, RESOURCE_EXHAUSTED hoặc INTERNAL.

Lỗi thường gặp

Bảng sau đây liệt kê các lỗi thường gặp do API trả về.

Mã trạng thái HTTP Mã chuẩn Lý do Mô tả
400 INVALID_ARGUMENT Yêu cầu lỗi Yêu cầu có định dạng không chính xác. Nguyên nhân có thể là do thiếu hoặc có tham số không hợp lệ, chẳng hạn như phạm vi ngày không chính xác hoặc bộ lọc có định dạng không chính xác.
401 UNAUTHENTICATED Thông tin đăng nhập không hợp lệ Yêu cầu không có thông tin xác thực hợp lệ cho tài nguyên mục tiêu. Tình trạng này có thể xảy ra nếu mã truy cập OAuth 2.0 bị thiếu, không hợp lệ hoặc đã hết hạn. Hãy làm theo hướng dẫn trong bài viết Xác thực bằng OAuth 2.0 để lấy mã thông báo hợp lệ.
403 PERMISSION_DENIED Không đủ quyền Người dùng được xác thực không có quyền truy cập vào tài sản Google Analytics được yêu cầu.
429 RESOURCE_EXHAUSTED Vượt quá hạn mức Yêu cầu bị từ chối do đã đạt đến hạn mức API. Hãy xem bài viết Hạn mức và hạn ngạch của Data API để biết thêm thông tin. Bạn có thể đang vượt quá hạn mức trên mỗi dự án hoặc trên mỗi tài sản.
500 INTERNAL Lỗi máy chủ nội bộ Đã xảy ra lỗi máy chủ không mong muốn. Đây thường là sự cố tạm thời. Bạn nên thử lại yêu cầu với thời gian đợi luỹ thừa. Để tránh vượt quá hạn ngạch lỗi máy chủ, bạn cần triển khai thời gian đợi luỹ thừa với giới hạn thử lại.
503 UNAVAILABLE Dịch vụ không khả dụng Dịch vụ này tạm thời không hoạt động. Đây thường là sự cố tạm thời. Bạn nên thử lại yêu cầu với thời gian đợi luỹ thừa. Để tránh vượt quá hạn ngạch lỗi máy chủ, bạn cần triển khai thời gian đợi luỹ thừa với giới hạn thử lại.