Có nhiều tình huống mà bạn có thể gặp lỗi khi làm việc với Hiển thị và API Video 360. Các vấn đề này có thể liên quan đến lỗi trong mã của bạn, hoạt động đầ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. Bất kể lý do là gì, bạn luôn 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 cho bạn một số mẹo về các phương pháp hay nhất để giúp bạn bắt đầu.
Xem xét thông tin 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 Hiển thị và 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 đảm bảo bạn xem xét cẩn thận những lỗi này và đảm bảo rằng yêu cầu đượ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 đăng nhập OAuth 2.0 cần thiết.
Xác minh rằng bạn đang sử dụng đúng thông tin đăng nhập. Xem Hướng dẫn thiết lập ứng dụng để biết chi tiết về cách tạo giấy uỷ nhiệm xác thực. Bạn cũng có thể chuyển mã truy cập của mình cho Điểm cuối tokeninfo của API Google OAuth2 để xác minh rằng đó là đượ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": ... }
Hiểu lỗi
Khi gặp lỗi, API thường trả về phản hồi JSON có chứa
đối tượng error
. Đối tượng này cung cấp thêm ngữ cảnh về việc
đã 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 thực hiện thêm một số
nghiên cứu để tìm ra ý 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, trong đó cung cấp 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ó trong phần lỗi thường gặp, hãy tham khảo tài liệu tham khảo rồi thử tìm mã lỗi. trạng thái và thông báo.
Nếu bạn gặp bất kỳ lỗi nào không đượ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, quay lại phần hiểu lỗi hoặc chuyển đến phần yêu cầu trợ giúp nếu bạn tin 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 xuyên thì đâ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, 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ã chịu trách nhiệm về nguyên nhân gây ra lỗi để kiểm tra những vấn đề rõ ràng. Trong một số trường hợp, có thể cần phải sử dụng công cụ gỡ lỗi để duyệt qua từng dòng mã nhằm đảm bảo mã hoạt động chính xác.
Việ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, vì cũng như các trường hợp nhập 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 nhật ký các yêu cầu và phản hồi HTTP; hãy xem lại tài liệu dành cho để biết thêm chi tiết. Proxy HTTP như Charles, Squid hoặc Fiddler cũng có thể được sử dụng để thu thập nhật ký yêu cầu và phản hồi. Sau khi bạn có được nhật ký, hãy xem lại chúng để đảm bảo rằng giá trị thông số yêu cầu đang được cung cấp bởi đơn đăng ký của bạn là chính xác và phù hợ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 cách khắc phục sẽ rõ ràng. Nếu bạn gặp khó khăn hoặc không chắc chắn cách tốt nhất để khắc phục tuy nhiên, bạn có thể sử dụng thông tin đã thu thập được cho đến thời điểm này khi đang 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 mục Hiển thị và Trung tâm trợ giúp 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ề sự cố bạn đang gặp phải và các bước khắc phục sự cố bạn đã thực hiện đã thực hiện. Thông tin hữu ích cần bao gồm:
- Nhật ký phản hồi và yêu cầu HTTP. Hãy nhớ che khuất thông tin nhạy cảm chẳng hạn 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 đề thành một phần cụ thể mã hoặc nghi ngờ vấn đề là theo ngôn ngữ cụ thể, 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/phiên dịch và nền tảng, Điều này 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 bạn xác định được nguyên nhân của vấn đề và tìm ra giải pháp, thời gian 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ôi trường (chẳng hạn như đối tác hoặc nhà quảng cáo được định cấu hình cụ thể cho thử nghiệm) dựa trên một loạt cả đầu vào tốt và xấu trước khi triển khai sản xuất.