Rozwiązywanie problemów

Podczas pracy z interfejsem Display & Video 360 API mogą wystąpić różne błędy. Mogą one być związane z błędem w kodzie, nieprawidłowymi danymi użytkownika lub nawet problemem z samym interfejsem API. Niezależnie od przyczyny, umiejętność rozwiązywania problemów jest ważną częścią procesu tworzenia. Ten przewodnik zawiera kilka sprawdzonych metod, które pomogą Ci zacząć.

Omówienie podstaw

  1. Zapoznaj się z przewodnikiem po wymaganiach wstępnych. Upewnij się, że masz dostęp do Display & Video 360 i prawidłowo skonfigurowany projekt interfejsu API.
  2. Jeśli odpowiedź zawiera błędy HTTP, dokładnie je sprawdź i upewnij się, że żądanie jest wysyłane do prawidłowego interfejsu API i usługi.
  3. Zapoznaj się z przewodnikiem po autoryzacji. Upewnij się, że żądanie zawiera niezbędne dane uwierzytelniające OAuth 2.0.
  4. Sprawdź, czy używasz prawidłowych danych logowania. Szczegółowe informacje o generowaniu danych logowania znajdziesz w przewodniku Konfigurowanie aplikacji. Możesz też przekazać token dostępu do punktu końcowego tokeninfo interfejsu Google OAuth2 API, aby sprawdzić, czy został on wydany do prawidłowego projektu interfejsu API i czy jest autoryzowany do 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": ...
    }
    

Informacje o błędach

Gdy interfejs API napotka błąd, zwraca zwykle odpowiedź JSON zawierającą obiekt error. Ten obiekt dostarcza dodatkowego kontekstu dotyczącego konkretnego błędu.

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

Zazwyczaj zawartość obiektu error zawiera wystarczającą ilość informacji, aby można było określić, co poszło nie tak. Jeśli nie, może być konieczne przeprowadzenie dodatkowych badań, aby dowiedzieć się, co oznacza błąd.

Badanie błędów

  1. Zapoznaj się z sekcją Typowe błędy, która zawiera szczegółowe informacje o najczęściej występujących błędach.

  2. Jeśli w sekcji typowych błędów nie ma informacji o Twoim błędzie, zajrzyj do dokumentacji i spróbuj wyszukać kod błędu, stan oraz komunikat.

  3. Jeśli natrafisz na błędy, które nie są opisane w dokumentacji, daj nam znać.

Identyfikowanie głównej przyczyny

W tym momencie powinieneś już zidentyfikować błąd i wiedzieć, co oznacza. Jeśli nie, wróć do sekcji Rozumienie błędów lub przejdź do sekcji Uzyskiwanie pomocy, jeśli uważasz, że napotkałeś błąd w interfejsie API, którego nie możesz rozwiązać samodzielnie.

Zanim naprawisz błąd, musisz ustalić 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, najpierw sprawdź, czy kod działa zgodnie z oczekiwaniami. Najpierw sprawdź sekcję kodu odpowiedzialną za wysyłanie żądania, które powoduje błąd, aby sprawdzić, czy nie ma w niej oczywistych problemów. W niektórych przypadkach konieczne może być użycie narzędzia do debugowania, aby przejrzeć kod wiersz po wierszu i sprawdzić, czy działa prawidłowo.

Badanie żądań HTTP to kolejny przydatny sposób na wykrywanie potencjalnych błędów, a także przypadków nieprawidłowego wejścia. Wiele oficjalnych bibliotek klienta można skonfigurować tak, aby rejestrowały żądania i odpowiedzi HTTP. Więcej informacji znajdziesz w dokumentacji wybranej biblioteki. Do rejestrowania żądań i odpowiedzi możesz też użyć serwera proxy HTTP, takiego jak Charles, Squid lub Fiddler. Po uzyskaniu tych logów sprawdź, czy wartości parametrów żądań podawane przez aplikację są prawidłowe i zgodne z oczekiwaniami.

Gdy znajdziesz błąd lub nieprawidłowe dane wejściowe, które powodują błąd, rozwiązanie problemu powinno być oczywiste. Jeśli jednak nie wiesz, jak rozwiązać problem, możesz skorzystać z dotychczas zebranych informacji.

Uzyskiwanie pomocy

Jeśli nie możesz samodzielnie rozwiązać problemu, skontaktuj się z naszym zespołem pomocy, korzystając z tego formularza w Centrum pomocy Display & Video 360.

Podczas wypełniania tego formularza podaj jak najwięcej informacji o problemie, z którym się borykasz, oraz o podjętych już przez Ciebie próbach jego rozwiązania. Przydatne informacje do uwzględnienia:

  • logi żądań i odpowiedzi HTTP. Usuń informacje poufne, takie jak tokeny dostępu OAuth 2.0, adresy e-mail itp.
  • Fragment kodu. Jeśli udało Ci się zlokalizować problem w konkretnej sekcji kodu lub podejrzewasz, że problem dotyczy konkretnego języka, dołącz krótki fragment kodu, aby zilustrować, co robisz.
  • dodatkowe informacje, takie jak wersja środowiska uruchomieniowego lub interpretera oraz platforma, które mogą być przydatne dla innych osób próbujących odtworzyć problem;

Rozwiązywanie problemu

Gdy już zidentyfikujesz przyczynę problemu i znajdziesz jego rozwiązanie, czas wdrożyć poprawkę. Przed wdrożeniem rozwiązania w wersji produkcyjnej przetestuj je w kontrolowanym środowisku (np. u partnera lub reklamodawcy skonfigurowanego specjalnie do testowania) z użyciem różnych danych wejściowych (zarówno prawidłowych, jak i nieprawidłowych).