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 lỗi này có thể liên quan đến lỗi trong mã, dữ liệu đầu vào không hợp lệ của người dùng hoặc thậm chí là vấn đề với chính API. Dù 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 hay nhất để bạn bắt đầu.
Xem lại kiến thức cơ bản
- 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.
- 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 đang được gửi đến đúng API và dịch vụ.
- Xem hướng dẫn 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.
Xác minh rằng bạn đang sử dụng đúng thông tin xác thực. Hãy 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ể truyề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ã truy cập đó được cấp cho đúng dự án API và được uỷ quyền cho(các) phạm vi chính xác:
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ề một 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 vấn đề. Nếu không, bạn có thể cần phải nghiên cứu thêm để tìm hiểu ý nghĩa của lỗi.
Nghiên cứu lỗi
Hãy tham khảo phần các lỗi thường gặp để biết thông tin chi tiết về một số lỗi thường gặp nhất.
Nếu lỗi không được đề cập trong phần lỗi phổ biến, 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 lỗi.
Nếu bạn gặp phải lỗi nào chưa được ghi nhận, vui lòng cho chúng tôi biết.
Xác định nguyên nhân gốc rễ
Đế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 về lỗi hoặc chuyển đến phần yêu cầu trợ giúp nếu bạn cho rằng mình gặp phải 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ị đầu vào 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 mình đang hoạt động như dự kiến. Bước đầu tiên, hãy cân nhắc việc xem lại phần mã chịu trách nhiệm tạo 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 sử dụng công cụ gỡ lỗi để từng bước kiểm tra mã để đảm bảo mã đó hoạt động chính xác.
Kiểm tra các 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ư các trường hợp nhập không hợp lệ. Bạn có thể định cấu hình nhiều thư viện ứng dụng chính thức để 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 mà bạn chọ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 Fiddler để ghi lại nhật ký yêu cầu và phản hồi. Sau khi bạn nhận được các nhật ký này, hãy xem lại để đảm bảo rằng các giá trị tham số yêu cầu do ứng dụng cung cấp là chính xác và khớp với những gì bạn mong đợi.
Sau khi bạn xác định được lỗi hoặc dữ liệu đầu vào không hợp lệ gây ra lỗi, lỗi sẽ được khắc phục một cách rõ ràng. Tuy nhiên, nếu gặp khó khăn hoặc không chắc cách khắc phục vấn đề hiệu quả nhất, bạn có thể sử dụng thông tin đã thu thập được cho đến thời điểm này 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 của Display & Video 360.
Khi điền vào biểu mẫu này, bạn nên cung cấp càng nhiều thông tin càng tốt về vấn đề bạn đang gặp phải và các bước khắc phục sự cố mà bạn đã thực hiện. Thông tin hữu ích cần có:
- Nhật ký yêu cầu và phản hồi 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ể tách riêng vấn đề cho một phần mã cụ thể hoặc nghi ngờ vấn đề là do 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 thời gian chạy/trình thông dịch và nền tảng, có thể hữu ích cho những người khác đ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 gây ra vấn đề và đưa ra giải pháp, bạn đã sẵn sàng triển khai bản sửa lỗi. Bất cứ khi nào có thể, hãy kiểm thử bản sửa lỗi trong một 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 cho việc kiểm thử) dựa trên một loạt dữ liệu đầu vào cả tốt và xấu trước khi triển khai vào môi trường phát hành chính thức.