Лучшие практики

Видео: ознакомьтесь с докладом о передовом опыте семинара 2019 года.

В этом руководстве описаны некоторые рекомендации, которые вы можете применить для оптимизации эффективности и производительности ваших приложений.

Текущее обслуживание

Чтобы обеспечить бесперебойную работу вашего приложения:

  • Постоянно обновляйте контактный адрес электронной почты разработчика в центре API. Это псевдоним, который мы используем, чтобы связаться с вами. Если мы не сможем связаться с вами по поводу соблюдения Положений и условий API, ваш доступ к API может быть отозван без вашего предварительного уведомления. Избегайте использования личного адреса электронной почты, привязанного к индивидуальной или неконтролируемой учетной записи. Для просмотра API-центра вам необходимо войти в свой управляющий аккаунт.

  • Чтобы получать информацию о таких проблемах, как изменения продукта, простои из-за обслуживания, даты прекращения поддержки и т. д., подпишитесь на нашу рассылку.

Форум регулярно контролируется командой Google Ads API, что делает его идеальным местом для размещения вопросов по API.

  • Следите за тем, чтобы ваше приложение соответствовало Условиям использования Google Ads API. При необходимости группа проверки токенов и обеспечения соответствия свяжется с вами по контактному адресу электронной почты. Если у вас есть вопросы или сомнения по поводу Условий и условий, вы можете обратиться к группе проверки, ответив на электронное письмо, которое они отправили вам при проверке вашего заявления на токен разработчика.

Оптимизация

Вы можете оптимизировать свое приложение, выполняя пакетные операции и, при необходимости, отправляя разреженные объекты.

Пакетные операции

Выполнение запроса к API влечет за собой ряд фиксированных затрат, таких как двусторонняя сетевая задержка, обработка сериализации и десериализации, а также вызовы серверных систем. Чтобы уменьшить влияние этих фиксированных затрат и повысить общую производительность, большинство методов mutate в API предназначены для приема массива операций. Объединяя несколько операций в каждый запрос, вы можете сократить количество отправляемых запросов и связанные с ними фиксированные затраты. Если можете, избегайте запросов, содержащих только одну операцию.

Например, предположим, что вы добавляете 50 000 ключевых слов в кампанию в нескольких группах объявлений. Вместо того, чтобы делать 50 000 запросов по 1 ключевому слову каждый, сделайте 100 запросов по 500 ключевых слов каждый или даже 10 запросов по 5000 ключевых слов каждый. Существуют ограничения на количество операций, разрешенных в запросе, поэтому вам может потребоваться скорректировать размер пакета для достижения оптимальной производительности.

Отправляйте редкие объекты

Когда объекты отправляются в API, поля необходимо десериализовать, проверить и сохранить в базе данных. Передача полных объектов, когда вы хотите обновить только несколько полей, может привести к увеличению времени обработки и снижению производительности. Чтобы избежать этого, API Google Рекламы поддерживает редкие обновления, позволяя вам заполнять только те поля в объекте, которые вам нужно изменить или которые являются обязательными. Редкие обновления обрабатываются быстрее и с меньшей вероятностью приводят к ошибкам. Поля, которых нет в update_mask (также известной как FieldMask ), остаются неизменными.

Например, приложение, которое обновляет ставки на уровне ключевых слов, может выиграть от использования редких обновлений, поскольку необходимо будет заполнить только поля идентификатора группы объявлений, идентификатора критерия и ставок.

Обработка и управление ошибками

Во время разработки вы, вероятно, столкнетесь с ошибками. В этом разделе описаны соображения и стратегии по внедрению управления ошибками в ваше приложение. В дополнение к этому разделу посетите Руководство по устранению неполадок для получения дополнительной информации об управлении ошибками.

Различать источники запросов

Некоторые приложения в основном являются интерактивными, вызывая вызовы API непосредственно в ответ на действия пользователя в пользовательском интерфейсе. Другие работают в основном в автономном режиме, выполняя вызовы API как часть периодического внутреннего процесса. Многие приложения сочетают в себе эти два параметра. Размышляя об управлении ошибками, может быть полезно различать эти разные типы запросов.

Для запросов, инициируемых пользователями, вашей главной задачей должно быть обеспечение удобства для пользователей. Используйте конкретную произошедшую ошибку, чтобы предоставить пользователю как можно больше контекста в пользовательском интерфейсе. Предложите простые шаги, которые они могут предпринять, чтобы устранить ошибку (см. предложения ниже).

Для запросов, инициированных на серверной стороне, реализуйте обработчики различных типов ошибок, с которыми может столкнуться ваше приложение. Всегда включайте обработчик по умолчанию для устранения редких или ранее не встречавшихся ошибок. Хороший подход для обработчика по умолчанию — добавить неудачную операцию и ошибку в очередь, чтобы человек-оператор мог просмотреть и определить подходящее решение.

Различать типы ошибок

Знание различий между типами ошибок в API Google Рекламы имеет решающее значение при создании надежной обработки ошибок. Некоторые из наиболее распространенных типов ошибок:

  1. Ошибки аутентификации
  2. Повторные ошибки
  3. Ошибки валидации
  4. Ошибки, связанные с синхронизацией

Дополнительные сведения см. в разделах «Типы ошибок и распространенные ошибки» .

Синхронизировать серверные части

Если у пользователей вашего приложения есть ручной доступ к аккаунтам Google Рекламы, они могут вносить изменения, о которых ваше приложение не знает, что приведет к рассинхронизации локальной базы данных вашего приложения. Как отмечено в нашем руководстве по типам ошибок , вы можете устранять ошибки, связанные с синхронизацией, в случае их возникновения, но вы также можете попытаться предотвратить их заранее. Одна из превентивных стратегий — запускать ночную синхронизацию всех ваших учетных записей, получать объекты Google Ads в ваших учетных записях и сравнивать их с вашей локальной базой данных.

Журнал ошибок

Все ошибки должны регистрироваться, чтобы облегчить отладку и мониторинг. Как минимум запишите идентификатор запроса, операции, вызвавшие ошибку, и саму ошибку. Другая информация для регистрации включает идентификатор клиента, службу API, задержку двустороннего запроса, количество повторных попыток, а также необработанный запрос и ответ.

Обязательно отслеживайте тенденции ошибок API, чтобы вы могли обнаружить и устранить проблемы с вашим приложением. Рассмотрите возможность создания собственного решения или использования одного из многих доступных коммерческих инструментов, которые могут использовать ваши журналы для создания интерактивных информационных панелей и отправки автоматических оповещений.

Разработка

Используйте тестовые учетные записи во время разработки.

Используйте тестовые аккаунты

Тестовые аккаунты – это аккаунты Google Рекламы, которые фактически не показывают рекламу. Вы можете использовать тестовый аккаунт, чтобы поэкспериментировать с API Google Рекламы и проверить, что подключение вашего приложения, логика управления кампанией или другие процессы работают должным образом. Ваш токен разработчика не требует одобрения для использования в тестовом аккаунте, поэтому вы можете начать разработку с помощью Google Ads API сразу после запроса токена разработчика, даже до того, как ваше приложение будет проверено.