Правила прекращения поддержки столбцов для Google Analytics API

В этой статье описываются правила прекращения поддержки, которые действуют в отношении столбцов Core Reporting API и Metadata API.

Обзор

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

Информация об изменениях столбцов будет представлена в журналах. Все необходимые обновления Metadata API проведет автоматически.

Область действия правил

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

Новые столбцы

Если в API добавляются новые столбцы:

  • В соответствующем журнале изменений публикуется информация о новых столбцах.
  • Metadata API автоматически предоставляет доступ к новым столбцам.

Удаление столбцов

Если из API удаляются столбцы:

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

Переименование столбцов

Если изменяются названия столбцов:

  • В соответствующем журнале изменений публикуется информация об исходных и замещающих их столбцах.
  • В Metadata API атрибуту status исходного столбца присваивается значение DEPRECATED, а атрибуту replacedBy – идентификатор замещающего столбца.
  • Исходные столбцы можно использовать в запросах для отчетов на протяжении 6 месяцев.
  • По истечении этого срока исходные столбцы удаляются из Metadata API, и при попытке выполнить запрос к ним возвращается ошибка 400 Неверный запрос.

Удаление атрибутов

Если из Metadata API удаляются атрибуты:

  • В соответствующем журнале изменений публикуется информация об удаляемых атрибутах.
  • Указанные атрибуты будут доступны в Metadata API на протяжении 6 месяцев.
  • По истечении этого срока атрибуты удаляются из Metadata API.

Группы

Иногда необходимо изменить название группы или порядок столбцов. При этом:

  • информация об изменениях публикуется в журнале.