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

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

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

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

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

Новый редактор Apps Script

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

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

Устаревший редактор Apps Script

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

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

С#

Информация о версии клиентской библиотеки Google API для .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

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

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

Питон

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

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

Руби

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

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

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

Google.Apis.DfareportingV3_4

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

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

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

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

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

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

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

Новый редактор Apps Script

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

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

Устаревший редактор Apps Script

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

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

С#

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

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

Ява

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

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

PHP

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

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

Питон

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

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

Руби

Клиентская библиотека Google API для 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.