Существует множество сценариев, в которых вы можете столкнуться с ошибками при работе с API Display & Video 360. Это может быть связано с ошибкой в вашем коде, неверным пользовательским вводом или даже с проблемой самого API. Какой бы ни была причина, знание того, как устранять ошибки, является важной частью процесса разработки. В этом руководстве представлены некоторые практические советы, которые помогут вам начать работу.
Обзор основ
- Ознакомьтесь с руководством по предварительным требованиям . Убедитесь, что у вас есть доступ к Display & Video 360 и правильно настроенному проекту API.
- Если ваш ответ содержит ошибки HTTP, обязательно просмотрите их внимательно и убедитесь, что запрос направляется к правильному API и сервису.
- Ознакомьтесь с руководством по авторизации . Убедитесь, что ваш запрос содержит необходимые учетные данные OAuth 2.0.
Убедитесь, что вы используете правильные учетные данные. Подробную информацию о создании учетных данных для аутентификации см. в руководстве по настройке приложения . Вы также можете передать свой токен доступа в конечную точку tokeninfo API Google OAuth2, чтобы убедиться, что он выдан правильному проекту API и авторизован для правильной области(й):
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": ... }
Понимание ошибок
Когда API обнаруживает ошибку, он обычно возвращает ответ JSON, содержащий объект error . Этот объект предоставляет дополнительный контекст о конкретной возникшей ошибке.
{
"error": {
"code": 404,
"message": "Resource type LINE_ITEM does not exist: advertisers/1/lineItems/1",
"status": "NOT_FOUND"
}
}
Обычно содержимое объекта error содержит достаточно информации, которая поможет вам определить, что пошло не так. Если нет, возможно, вам придется провести дополнительное исследование, чтобы выяснить, что означает ошибка.
Исследование ошибок
Обратитесь к разделу « Распространенные ошибки» , в котором приведены сведения о некоторых наиболее часто встречающихся ошибках.
Если ошибка не описана в разделе «Распространенные ошибки», обратитесь к справочной документации и попробуйте найти код ошибки, статус и сообщение.
Если вы обнаружите какие-либо ошибки, которые не задокументированы, сообщите нам об этом.
Выявление основной причины
К этому моменту вы определили ошибку и понимаете, что она означает. Если нет, вернитесь к пониманию ошибок или сразу обратитесь за помощью, если вы считаете, что столкнулись с ошибкой в API, которую не можете исправить самостоятельно.
Прежде чем вы сможете исправить ошибку, вам необходимо определить, что ее вызывает. Часто это ошибка в вашем коде или неверное входное значение.
Чтобы определить, связана ли проблема с ошибкой в вашем коде, вам следует сначала убедиться, что ваш код работает должным образом. В качестве первого шага рассмотрите возможность проверки раздела кода, ответственного за выполнение ошибочного запроса, на наличие очевидных проблем. В некоторых случаях может потребоваться использовать инструмент отладки для пошагового выполнения кода, чтобы убедиться, что он работает правильно.
Проверка HTTP-запросов — еще один полезный способ выявления потенциальных ошибок, а также случаев неправильного ввода. Многие официальные клиентские библиотеки можно настроить для регистрации HTTP-запросов и ответов; просмотрите документацию по выбранной вами библиотеке для получения более подробной информации. HTTP-прокси, такой как Charles , Squid или Fiddler, также можно использовать для сбора журналов запросов и ответов. Получив эти журналы, просмотрите их, чтобы убедиться, что значения параметров запроса, предоставляемые вашим приложением, верны и соответствуют вашим ожиданиям.
Как только вы определите ошибку или неверный ввод, вызвавший ошибку, исправление, надеюсь, станет очевидным. Однако, если вы застряли или не знаете, как лучше всего решить проблему, вы можете использовать информацию, которую вы собрали на данный момент, при получении помощи.
Получение помощи
Если вы не можете устранить ошибку самостоятельно, вы можете связаться с нашей службой поддержки через эту форму , расположенную в справочном центре Display & Video 360.
Заполняя эту форму, вы должны указать как можно больше информации о проблеме, с которой вы столкнулись, и о шагах по устранению неполадок, которые вы уже предприняли. Полезная информация, включающая:
- Журналы HTTP-запросов и ответов. Обязательно удалите конфиденциальную информацию, такую как токены доступа OAuth 2.0, адреса электронной почты и т. д.
- Фрагмент кода. Если вы можете изолировать проблему в определенном разделе кода или подозреваете, что проблема связана с языком, включите небольшой фрагмент, чтобы проиллюстрировать, что вы делаете.
- Дополнительная информация, такая как версия среды выполнения/интерпретатора и платформа, которая может быть полезна другим, пытающимся воспроизвести проблему.
Исправление проблемы
После того, как вы определили причину проблемы и нашли решение, пришло время внедрить исправление. По возможности проверяйте исправление в контролируемой среде (например, у партнера или рекламодателя, настроенного специально для тестирования) на основе ряда как хороших, так и плохих входных данных, прежде чем развертывать его в рабочей среде.