Эксперименты

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

Список методов для этого ресурса приведен в конце страницы.

Представления ресурса

Шаблон для ресурса эксперимента Google Analytics в формате JSON.

{
  "id": string,
  "kind": "analytics#experiment",
  "selfLink": string,
  "accountId": string,
  "webPropertyId": string,
  "internalWebPropertyId": string,
  "profileId": string,
  "name": string,
  "description": string,
  "created": datetime,
  "updated": datetime,
  "objectiveMetric": string,
  "optimizationType": string,
  "status": string,
  "winnerFound": boolean,
  "startTime": datetime,
  "endTime": datetime,
  "reasonExperimentEnded": string,
  "rewriteVariationUrlsAsOriginal": boolean,
  "winnerConfidenceLevel": double,
  "minimumExperimentLengthInDays": integer,
  "trafficCoverage": double,
  "equalWeighting": boolean,
  "snippet": string,
  "variations": [
    {
      "name": string,
      "url": string,
      "status": string,
      "weight": double,
      "won": boolean
    }
  ],
  "servingFramework": string,
  "editableInGaUi": boolean,
  "parentLink": {
    "type": "analytics#profile",
    "href": string
  }
}
Название свойства Значение Описание Заметки
accountId string Идентификатор аккаунта, которому принадлежит эксперимент. Это поле доступно только для чтения.
created datetime Время создания эксперимента. Это поле доступно только для чтения.
description string Описание эксперимента. Можно редактировать
editableInGaUi boolean Указывает, может ли конечный пользователь редактировать эксперимент через интерфейс Google Analytics (значение true). Можно редактировать
endTime datetime Время окончания эксперимента, когда его статус был изменен с RUNNING на ENDED. Это поле присутствует только у завершенных экспериментов. Это поле доступно только для чтения.
equalWeighting boolean Логическое значение, задающее равномерное распределение трафика между всеми вариантами. Если задано значение false, эксперименты со страницами будут происходить в соответствии с заданным по умолчанию поведением с динамической корректировкой трафика на основе эффективности вариантов. Необязательный параметр, по умолчанию равный false. Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Можно редактировать
id string Идентификатор эксперимента. Обязательное поле для методов patch и update. Не используется в методе create.
internalWebPropertyId string Внутренний идентификатор веб-ресурса, которому принадлежит эксперимент. Это поле доступно только для чтения.
kind string Тип ресурса для эксперимента Google Analytics. Это поле доступно только для чтения.
minimumExperimentLengthInDays integer Целое число в диапазоне [3, 90], которое определяет минимальную продолжительность эксперимента и может изменяться во время его проведения. Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Можно редактировать
name string Название эксперимента. Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Обязательно при создании эксперимента. Можно редактировать
objectiveMetric string Показатель, который оптимизируется в рамках эксперимента. Допустимые значения: ga:goal(n)Completions, ga:adsenseAdsClicks, ga:adsenseAdsViewed, ga:adsenseRevenue, ga:bounces, ga:pageviews, ga:sessionDuration, ga:transactions, ga:transactionRevenue. Если эксперимент имеет статус RUNNING, а параметр servingFramework имеет значение REDIRECT или API, это поле является обязательным. Можно редактировать
optimizationType string Указывает, требуется ли добиться минимального или максимального значения параметра objectiveMetric. Допустимые значения: MAXIMUM, MINIMUM. Необязательный параметр, по умолчанию равный MAXIMUM. Задается только вместе с параметром objectiveMetric и не может изменяться для экспериментов со статусом RUNNING или ENDED. Можно редактировать
parentLink.href string Ссылка на представление (профиль), которому принадлежит эксперимент. Это поле доступно только для чтения.
parentLink.type string Значение: "analytics#profile". Это поле доступно только для чтения.
profileId string Идентификатор представления (профиля), которому принадлежит эксперимент. Это поле доступно только для чтения.
reasonExperimentEnded string Причина завершения эксперимента. Допустимые значения: STOPPED_BY_USER (Остановлено пользователем), WINNER_FOUND (Найден победитель), EXPERIMENT_EXPIRED (Закончился срок действия эксперимента), ENDED_WITH_NO_WINNER (Закончено без победителя), GOAL_OBJECTIVE_CHANGED (Цель изменена), ENDED_WITH_NO_WINNER – срок действия эксперимента не истек, однако не удалось определить победивший вариант. Если API изменяет статус эксперимента на ENDED, этому полю присваивается значение STOPPED_BY_USER. Это поле доступно только для чтения.
rewriteVariationUrlsAsOriginal boolean Логическое значение, позволяющее перезаписывать URL вариантов в соответствии с URL исходной страницы. Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Можно редактировать
servingFramework string Платформа для показа и анализа вариантов эксперимента. Допустимые значения:
  • REDIRECT – Google Analytics переадресует трафик на различные варианты страниц, формирует отчеты по вариантам и анализирует полученные результаты.
  • API – Google Analytics выбирает вариант для показа, создает отчеты на его основе и анализирует результаты. Показ варианта осуществляет вызывающая сторона.
  • EXTERNAL – обработку вариантов осуществляет внешняя платформа, передающая сведения о них в Google Analytics. Показ выбранного варианта и анализ результатов осуществляет вызывающая сторона.
Можно редактировать
snippet string Фрагмент кода, который требуется включить на управляющие страницы. Это поле доступно только для чтения.
startTime datetime Время начала эксперимента, когда его статус был изменен с READY_TO_RUN на RUNNING. Это поле присутствует только у стартовавших экспериментов. Это поле доступно только для чтения.
status string Статус эксперимента. Допустимые значения: DRAFT, READY_TO_RUN, RUNNING, ENDED. Создаваемому эксперименту можно присваивать первые три статуса. При создании эксперимента это поле является обязательным. Можно редактировать
trafficCoverage double Число с плавающей запятой в диапазоне от 0 до 1. Определяет долю трафика, включаемую в эксперимент, и может изменяться во время его проведения. Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Можно редактировать
updated datetime Время последнего изменения эксперимента. Это поле доступно только для чтения.
variations[] list Массив вариантов. Первым элементом является исходная страница. После того, как эксперименту присвоен статус RUNNING, количество вариантов нельзя изменить. Статус RUNNING может получить только эксперимент с как минимум двумя вариантами. Можно редактировать
variations[].name string Название варианта. При создании эксперимента это поле является обязательным. Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Можно редактировать
variations[].status string Статус варианта. Допустимые значения: ACTIVE (активный) и INACTIVE (не показывается). Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Можно редактировать
variations[].url string URL варианта. Для выполняющихся (статус RUNNING) и завершенных (статус ENDED) экспериментов это поле доступно только для чтения. Можно редактировать
variations[].weight double Коэффициент варианта. Присутствует только у стартовавших экспериментов. Это поле доступно только для чтения.
variations[].won boolean Имеет значение true, если по завершении эксперимента этот вариант имеет статистически более высокую эффективность, чем оригинал. Это поле доступно только для чтения.
webPropertyId string Идентификатор веб-ресурса, которому принадлежит эксперимент. Задается в форме UA-XXXXX-YY. Это поле доступно только для чтения.
winnerConfidenceLevel double Число с плавающей запятой в диапазоне от 0 до 1. Задает уровень доверительной вероятности для определения победившего варианта. Для завершенных экспериментов (статус ENDED) это поле доступно только для чтения. Можно редактировать
winnerFound boolean Указывает, был ли в ходе эксперимента определен победивший вариант. Это поле доступно только для чтения.

Методы

delete
Удаляет эксперимент.
get
Возвращает доступный пользователю эксперимент.
insert
Создает эксперимент.
list
Выводит список доступных пользователю экспериментов.
patch
Обновляет существующий эксперимент. Этот метод поддерживает семантику PATCH.
update
Обновляет существующий эксперимент.