Khắc phục sự cố

Có nhiều trường hợp bạn có thể gặp lỗi khi làm việc với API Display & Video 360. Những vấn đề này có thể liên quan đến lỗi trong mã, hoạt động đầu vào của người dùng không hợp lệ hoặc thậm chí là vấn đề với chính API. Bất kể lý do là gì, việc biết cách khắc phục lỗi là một phần quan trọng trong quá trình phát triển. Hướng dẫn này sẽ cung cấp một số mẹo về các phương pháp hay nhất để giúp bạn bắt đầu.

Xem lại các khái niệm cơ bản

  1. Xem hướng dẫn về điều kiện tiên quyết. Đảm bảo bạn có quyền truy cập vào Display & Video 360 và một dự án API được định cấu hình đúng cách.
  2. Nếu phản hồi của bạn chứa lỗi HTTP, hãy nhớ xem xét kỹ các lỗi này và đảm bảo rằng yêu cầu được gửi tới đúng API và dịch vụ.
  3. Xem lại hướng dẫn về việc uỷ quyền. Đảm bảo yêu cầu của bạn chứa thông tin xác thực OAuth 2.0 cần thiết.
  4. Xác minh rằng bạn đang sử dụng đúng thông tin xác thực. Xem Hướng dẫn thiết lập ứng dụng để biết thông tin chi tiết về cách tạo thông tin xác thực. Bạn cũng có thể chuyển mã truy cập của mình đến điểm cuối tokeninfo của API Google OAuth2 để xác minh rằng mã đó được cấp cho đúng dự án API và được uỷ quyền cho đúng(các) phạm vi:

    POST https://www.googleapis.com/oauth2/v2/tokeninfo?access_token={YOUR_ACCESS_TOKEN}
    
    200 OK
    
    {
     "issued_to": "{API_PROJECT_CLIENT_ID}",
     "audience": "...",
     "scope": "{API_SCOPES}",
     "expires_in": ...
    }
    

Tìm hiểu về lỗi

Khi gặp lỗi, API thường trả về phản hồi JSON chứa đối tượng error. Đối tượng này cung cấp thêm ngữ cảnh về lỗi cụ thể đã gặp phải.

{
 "error": {
  "code": 404,
  "message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
  "status": "NOT_FOUND"
 }
}

Thông thường, nội dung của đối tượng error sẽ chứa đủ thông tin để giúp bạn xác định sự cố. Nếu không, bạn có thể cần tiến hành nghiên cứu thêm để tìm hiểu ý nghĩa của lỗi.

Đang nghiên cứu lỗi

  1. Hãy tham khảo phần về các lỗi phổ biến. Mục này sẽ cung cấp thông tin chi tiết về một số lỗi thường gặp nhất.

  2. Nếu lỗi không được đề cập trong phần các lỗi thường gặp, hãy tham khảo tài liệu tham khảo và thử tìm mã lỗi, trạng thái và thông báo.

  3. Nếu bạn gặp bất kỳ lỗi nào không được ghi lại, vui lòng cho chúng tôi biết.

Xác định nguyên nhân gốc rễ

Đến thời điểm này, bạn đã xác định được lỗi và hiểu ý nghĩa của lỗi. Nếu không, hãy quay lại phần tìm hiểu lỗi hoặc chuyển sang phần yêu cầu trợ giúp nếu bạn cho rằng mình gặp lỗi trong API mà bạn không thể tự khắc phục.

Trước khi có thể khắc phục lỗi, bạn cần xác định nguyên nhân gây ra lỗi. Thông thường, đây sẽ là lỗi trong mã của bạn hoặc giá trị nhập không hợp lệ.

Để xác định xem vấn đề có liên quan đến lỗi trong mã hay không, trước tiên, bạn nên xác minh rằng mã của bạn đang hoạt động như dự kiến. Bước đầu tiên, hãy cân nhắc xem lại phần mã dẫn đến việc đưa ra yêu cầu không thành công để kiểm tra các vấn đề rõ ràng. Trong một số trường hợp, bạn có thể cần phải sử dụng công cụ gỡ lỗi để duyệt từng dòng mã nhằm đảm bảo công cụ đó hoạt động đúng cách.

Việc kiểm tra yêu cầu HTTP là một cách hữu ích khác để xác định các lỗi tiềm ẩn, cũng như trường hợp nhập dữ liệu không hợp lệ. Nhiều thư viện ứng dụng chính thức có thể được định cấu hình để ghi lại các yêu cầu và phản hồi HTTP; hãy xem tài liệu về thư viện lựa chọn của bạn để biết thêm thông tin chi tiết. Bạn cũng có thể sử dụng một proxy HTTP như Charles, Squid hoặc topic để ghi lại yêu cầu và nhật ký phản hồi. Sau khi bạn lấy được các nhật ký này, hãy xem lại để đảm bảo rằng giá trị tham số yêu cầu do ứng dụng của bạn cung cấp là chính xác và khớp với những gì bạn mong đợi.

Sau khi xác định được lỗi hoặc dữ liệu đầu vào không hợp lệ gây ra lỗi, hy vọng rằng việc khắc phục sẽ hiển thị rõ ràng. Tuy nhiên, nếu không biết chắc cách khắc phục vấn đề hoặc cách tốt nhất để khắc phục vấn đề, thì bạn có thể sử dụng thông tin đã thu thập được từ trước đến nay khi yêu cầu trợ giúp.

Nhận trợ giúp

Nếu không thể tự khắc phục lỗi, bạn có thể liên hệ với nhóm hỗ trợ của chúng tôi thông qua biểu mẫu này trong trung tâm trợ giúp Display & Video 360.

Khi điền vào biểu mẫu này, bạn nên cung cấp nhiều thông tin nhất có thể về vấn đề mình đang gặp phải và các bước khắc phục sự cố bạn đã thực hiện. Thông tin hữu ích bao gồm:

  • Nhật ký phản hồi và yêu cầu HTTP. Hãy nhớ loại bỏ thông tin nhạy cảm như mã truy cập OAuth 2.0, địa chỉ email, v.v.
  • Đoạn mã. Nếu bạn có thể xác định vấn đề với một phần mã cụ thể hoặc nghi ngờ vấn đề cụ thể theo ngôn ngữ, hãy thêm một đoạn mã nhỏ để minh hoạ những gì bạn đang làm.
  • Thông tin bổ sung, chẳng hạn như phiên bản và nền tảng thời gian chạy/trình thông dịch, có thể hữu ích cho những người đang cố gắng tái hiện vấn đề.

Khắc phục vấn đề

Sau khi đã xác định được nguyên nhân của vấn đề và tìm ra giải pháp, đã đến lúc triển khai giải pháp khắc phục. Bất cứ khi nào có thể, hãy kiểm thử bản sửa lỗi của bạn trong môi trường được kiểm soát (chẳng hạn như một đối tác hoặc nhà quảng cáo được định cấu hình riêng để kiểm thử) dựa trên một loạt dữ liệu đầu vào cả tốt và không hợp lệ trước khi triển khai chính thức.