Перейти на новую версию

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

Если используемая вами версия устарела, необходимо как можно скорее обновить её, чтобы избежать перебоев в работе сервиса.

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

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

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

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

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

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

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

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

C#

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

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

Java

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

  1. Указывается в Maven artifactId. 
    <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;

Python

Клиентская библиотека Google API для Python (версии 1/2) не имеет версий. Версия 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: Определите статус вашей версии.

Проверьте график прекращения поддержки , чтобы определить статус вашей версии. Если вашей версии нет в списке, значит, она снята с поддержки и больше не поддерживается.

Если ваша версия указана в списке, проверьте столбцы « Дата прекращения поддержки» и «Дата прекращения поддержки» :

  • Если даты отсутствуют, значит, ваша версия полностью поддерживается.
  • Если указаны даты, ваша версия устарела и будет снята с поддержки в указанную дату.

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

Шаг 3: Обновление версий

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

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

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

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

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

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

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

C#

Библиотека клиента Google API для .NET предоставляет отдельные сборки для каждой версии API Campaign Manager 360, распространяемые через NuGet. Обновите библиотеку клиента до версии, соответствующей версии API, которую вы хотите использовать.

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

Java

Клиентская библиотека Google API для Java предоставляет отдельные сборки для каждой версии API Campaign Manager 360, распространяемые через Maven. Обновите клиентскую библиотеку до версии, соответствующей версии API, которую вы хотите использовать.

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

PHP

Библиотека Google API Client Library for PHP предоставляет отдельные сборки для каждой версии API Campaign Manager 360, распространяемые через Packagist. Обновите библиотеку до версии, соответствующей версии API, которую вы хотите использовать.

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

Python

Все сборки клиентской библиотеки Google API для Python (v1/v2) поддерживают все версии API Campaign Manager 360. Для перехода на новую версию API Campaign Manager 360 обновите строку версии, передаваемую в качестве аргумента в построитель обнаружения:

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

Руби

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

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

ОТДЫХ

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

Например, при миграции с v4 на v5 вам нужно будет изменить базовый URL-адрес следующим образом:

https://dfareporting.googleapis.com/dfareporting/v4/...
 к: 
https://dfareporting.googleapis.com/dfareporting/v5/...

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

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

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

  • Новые возможности : Добавлена ​​новая функциональность. Для миграции не требуется вносить изменения в код.
  • Завершение поддержки : Функциональность удалена из API. При наличии альтернативной функциональности будет указано соответствующее уведомление.
  • Известные проблемы : Изменения существующего функционала, такие как переименование полей или методов, или изменение логики валидации.

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

Будьте в курсе событий

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