W wielu sytuacjach mogą wystąpić błędy podczas korzystania z interfejsu Display & Video 360 API. Może to być związane z błędem w kodzie, nieprawidłowymi danymi wpisywanymi przez użytkownika, a nawet problemem z interfejsem API. Niezależnie od przyczyny wiedza o rozwiązywaniu problemów jest ważnym elementem procesu programowania. Znajdziesz w nim kilka sprawdzonych metod, które pomogą Ci zacząć.
Podstawowe informacje
- Zapoznaj się z przewodnikiem po wymaganiach wstępnych. Sprawdź, czy masz dostęp do Display & Video 360 i prawidłowo skonfigurowany projekt interfejsu API.
- Jeśli Twoja odpowiedź zawiera błędy HTTP, przejrzyj je dokładnie i upewnij się, że żądanie jest wysyłane do właściwego interfejsu API i odpowiedniej usługi.
- Zapoznaj się z przewodnikiem po autoryzacji. Sprawdź, czy żądanie zawiera niezbędne dane uwierzytelniające OAuth 2.0.
Sprawdź, czy używasz prawidłowych danych logowania. Szczegółowe informacje o generowaniu danych uwierzytelniających znajdziesz w przewodniku po konfigurowaniu aplikacji. Możesz też przekazać token dostępu do punktu końcowego tokeninfo interfejsu Google OAuth2 API, aby sprawdzić, czy został on wydany dla odpowiedniego projektu API i autoryzowany do korzystania z odpowiednich zakresów:
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": ... }
Interpretowanie błędów
Gdy interfejs API napotyka błąd, zwykle zwraca odpowiedź JSON zawierającą obiekt error. Ten obiekt dostarcza dodatkowy kontekst dotyczący konkretnego błędu, który wystąpił.
{
"error": {
"code": 404,
"message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
"status": "NOT_FOUND"
}
}
Zwykle zawartość obiektu error zawiera wystarczającą ilość informacji, aby pomóc Ci zidentyfikować problem. Jeśli nie, poszukaj dodatkowych informacji,
aby ustalić, co oznacza błąd.
Sprawdzanie błędów
Zapoznaj się z sekcją poświęconą częstym błędom, która zawiera szczegółowe informacje o niektórych z nich najczęściej występujących błędów.
Jeśli błąd nie jest opisany w sekcji dotyczącej typowych błędów, w dokumentacji referencyjnej poszukaj kodu błędu, stanu i komunikatu.
Jeśli zauważysz błędy, które nie zostały udokumentowane, daj nam znać.
Określenie głównej przyczyny
Już wiesz, na czym polega błąd i co on oznacza. W przeciwnym razie wróć do sekcji wyjaśnianie błędów lub przejdź do pomocy, jeśli uważasz, że w interfejsie API napotkasz błąd, którego nie potrafisz naprawić.
Zanim go naprawić, musisz określić, co jest jego przyczyną. Często jest to błąd w kodzie lub nieprawidłowa wartość wejściowa.
Aby ustalić, czy problem jest związany z błędem w kodzie, sprawdź najpierw, czy kod działa prawidłowo. Najpierw przejrzyj sekcję kodu odpowiedzialną za wysyłanie nieudanego żądania w celu sprawdzenia, czy nie występują problemy oczywiste. W niektórych przypadkach, aby sprawdzić, czy kod działa prawidłowo, trzeba w niektórych przypadkach przejrzeć kolejne wiersze kodu za pomocą narzędzia do debugowania.
Analizowanie żądań HTTP to kolejny przydatny sposób na identyfikowanie potencjalnych błędów, a także w przypadku nieprawidłowych danych wejściowych. Wiele oficjalnych bibliotek klienta można skonfigurować pod kątem rejestrowania żądań i odpowiedzi HTTP. Więcej informacji znajdziesz w dokumentacji wybranej biblioteki. Do przechwytywania logów żądań i odpowiedzi można też używać serwera proxy HTTP, takiego jak Charles, Squid lub Fiddler. Po otrzymaniu tych dzienników sprawdź, czy wartości parametrów żądania podawane przez aplikację są prawidłowe i zgodne z oczekiwanymi.
Gdy zidentyfikujesz błąd lub nieprawidłowe dane wejściowe, które powodują błąd, poprawka będzie oczywista. Jeśli jednak nie wiesz, jak rozwiązać problem, możesz wykorzystać zebrane dotąd informacje, by uzyskać pomoc.
Uzyskiwanie pomocy
Jeśli nie jesteś w stanie samodzielnie naprawić błędu, skontaktuj się z naszym zespołem pomocy, korzystając z tego formularza w Centrum pomocy Display & Video 360.
Wypełniając ten formularz, podaj jak najwięcej informacji o napotkanym problemie i podjętych czynnościach w celu jego rozwiązania. Informacje, które warto podać:
- Dzienniki żądań i odpowiedzi HTTP. Pamiętaj, aby usunąć informacje poufne, takie jak tokeny dostępu OAuth 2.0, adresy e-mail itp.
- Fragment kodu. Jeśli jesteś w stanie zidentyfikować problem z konkretną sekcją kodu lub podejrzewasz, że dotyczy on określonego języka, dodaj krótki fragment, aby zilustrować to, co robisz.
- Dodatkowe informacje, takie jak wersja środowiska wykonawczego/interpretatora i platforma, które mogą być przydatne dla innych osób próbujących odtworzyć problem.
Jak rozwiązać problem
Po zidentyfikowaniu przyczyny problemu i opracowaniu rozwiązania nadszedł czas na wdrożenie poprawki. W miarę możliwości przed wdrożeniem poprawki w środowisku produkcyjnym należy w miarę możliwości przetestować ją w kontrolowanym środowisku (np. u partnera lub reklamodawcy skonfigurowanego specjalnie do testów) z porównaniem zarówno dobrych, jak i złych danych wejściowych.