Переход на новую версию

Регулярно выпускаются новые версии API Менеджера кампаний 360. По мере выпуска новых версий старые версии устаревают и в конечном итоге закрываются. Когда версия закрывается, все запросы к этой версии начинают возвращать ошибки.

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

Шаг 1. Определите, какую версию вы используете

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

Новый редактор скриптов приложений

Информация о версии для Apps Script отображается в диалоговом окне дополнительных служб:

  1. В редакторе сценариев приложений щелкните Добавить службу .
  2. Найдите API Менеджера кампаний 360 в списке доступных сервисов.
  3. Значение, выбранное в раскрывающемся списке версий, — это используемая в данный момент версия API Менеджера кампаний 360.

Устаревший редактор скриптов приложений

Информация о версии для Apps Script отображается в диалоговом окне дополнительных служб:

  1. В редакторе скриптов приложений перейдите в раздел Ресурсы > Расширенные сервисы Google .
  2. Найдите API Менеджера кампаний 360 в списке доступных сервисов.
  3. Значение, выбранное в раскрывающемся списке версий, — это используемая в данный момент версия API Менеджера кампаний 360.

С#

Информация о версии клиентской библиотеки API Google для .NET представлена ​​в следующих местах:

  1. Включено в имя пакета nuget и пространство имен службы.
    Google.Apis.Dfareporting.v3_4
  2. Предоставляется через общедоступное свойство DfareportingService .
    Console.WriteLine(DfareportingService.Version);

Джава

Информация о версии клиентской библиотеки Google API для Java представлена ​​в следующих местах:

  1. Указан в идентификаторе артефакта maven.
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-dfareporting</artifactId>
      <version>v3.4-rev1-1.21.0</version>
    </dependency>
  2. Включено в имя файла JAR.
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. Предоставляется через общедоступную собственность Dfareporting .
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Информация о версии клиентской библиотеки API Google для PHP предоставляется через общедоступное свойство Google_Service_Dfareporting :

$service = new Google_Service_Dfareporting($client)
print $service->version;

питон

Клиентская библиотека Google API для Python не имеет версий. Используемая версия API указывается в качестве аргумента для построителя обнаружения:

discovery.build('dfareporting', 'v3.4', http=http)

Рубин

Клиентская библиотека API Google для версий Ruby < 0.9 не имеет версий. Используемая версия API указывается в качестве аргумента конструктора службы:

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)

Для клиентской библиотеки API Google для версий Ruby >= 0.9 версия предоставляется в пространстве имен службы:

Google.Apis.DfareportingV3_4

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

Шаг 2. Определите статус вашей версии

В расписании устаревания указано состояние каждой поддерживаемой в настоящее время версии. Найдите свою версию в этом списке и определите ее статус следующим образом:

  1. Если в столбцах «Дата устаревания» и «Дата закрытия» даты не указаны, вы используете полностью поддерживаемую версию.
  2. Если указаны даты, используемая вами версия в настоящее время устарела и будет прекращена в указанную дату.
  3. Если вашей версии нет в списке, она уже устарела и больше не поддерживается.

Если вы попали в #2 или #3 выше, вам нужно будет перейти на более новую версию, чтобы избежать перерыва в обслуживании. Рекомендуется перейти на самую последнюю версию, которая указана в верхней части таблицы расписания устаревания (за исключением бета-версий). Это даст вам максимальное количество времени между обновлениями.

Шаг 3. Обновите версии

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

Новый редактор скриптов приложений

Сценарий Google Apps поддерживает все версии API Менеджера кампаний 360 и позволяет выбирать версию для каждого сценария отдельно. Чтобы изменить версию, используемую конкретным скриптом:

  1. В редакторе сценариев приложений щелкните Добавить службу .
  2. Найдите API Менеджера кампаний 360 в списке доступных сервисов.
  3. Измените используемую версию API Менеджера кампаний 360 в раскрывающемся списке версий.
  4. Нажмите «Добавить» , чтобы сохранить изменения.

Устаревший редактор скриптов приложений

Сценарий Google Apps поддерживает все версии API Менеджера кампаний 360 и позволяет выбирать версию для каждого сценария отдельно. Чтобы изменить версию, используемую конкретным скриптом:

  1. В редакторе скриптов приложений перейдите в раздел Ресурсы > Расширенные сервисы Google .
  2. Найдите API Менеджера кампаний 360 в списке доступных сервисов.
  3. Измените используемую версию API Менеджера кампаний 360 в раскрывающемся списке версий.
  4. Нажмите OK , чтобы сохранить изменения.

С#

Клиентская библиотека API Google для .NET предоставляет отдельные сборки для каждой версии API Менеджера кампаний 360, распространяемой через Nuget.

Подробные инструкции по установке или альтернативные варианты загрузки см. в документации клиентской библиотеки .

Джава

Клиентская библиотека API Google для Java предоставляет отдельные сборки для каждой версии API Менеджера кампаний 360, распространяемой через Maven.

Подробные инструкции по установке или альтернативные варианты загрузки см. в документации клиентской библиотеки .

PHP

Клиентская библиотека API Google для PHP предоставляет отдельные сборки для каждой версии API Менеджера кампаний 360, распространяемой через Packagist.

Подробные инструкции по установке или альтернативные варианты загрузки см. в документации клиентской библиотеки .

Питон

Каждая сборка клиентской библиотеки API Google для Python поддерживает все версии API Менеджера кампаний 360. Просто обновите строку версии, передаваемую в качестве аргумента построителю обнаружения:

discovery.build('dfareporting', 'v3.4', http=http)
Подробные инструкции по установке или альтернативные варианты загрузки см. в документации по клиентской библиотеке .

Рубин

Клиентская библиотека API Google для Ruby версии 0.8 и более ранних поддерживает все версии API Менеджера кампаний 360. Просто обновите строку версии, передаваемую конструктору службы в качестве аргумента:

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
Клиентская библиотека API Google для Ruby v0.9+ предоставляет отдельные сборки для каждой версии API Менеджера кампаний 360, распространяемой через RubyGems. Подробные инструкции по установке или альтернативные варианты загрузки см. в документации клиентской библиотеки .

Шаг 4. Устранение различий в версиях

Мы стремимся сделать наши новые выпуски обратно совместимыми, а это означает, что миграция между версиями API не потребует внесения изменений в ваш код. Если это невозможно, мы сообщаем об изменениях, требующих действий со стороны разработчиков (также называемых критическими изменениями ), в наших примечаниях к выпуску .

На этом этапе вам следует ознакомиться с нашими примечаниями к выпуску, начиная с версии, следующей за той, с которой вы начали (которую вы отметили в предыдущем разделе), и продолжая до версии, до которой вы обновляетесь, включительно. Разделы примечаний к выпуску следует интерпретировать следующим образом:

  • Новые функции - Недавно добавленная функциональность.
  • Закаты — функциональность, которая была удалена из API. Функции замены, если они доступны, будут описаны в этом разделе.
  • Известные проблемы — изменения, не являющиеся добавлениями или удалениями. Например, этот раздел может охватывать поля или методы, которые были переименованы, или измененную логику проверки.

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

С другой стороны, если вы обнаружите изменения в разделах «Закаты» или «Известные проблемы» , вам может потребоваться принять меры. Вы должны просмотреть свой код, чтобы определить, используются ли какие-либо удаленные или измененные функции вашим приложением. Если это так, вам нужно будет внести обновления в свой код, чтобы учесть эти изменения.

В курсе

Как упоминалось ранее, выпуски API Менеджера кампаний 360 происходят регулярно. Обновления о новых выпусках, устаревании и закрытии публикуются на следующих каналах:

Рекомендуется подписаться на один или несколько из этих каналов, чтобы быть в курсе последних новостей API.