Experiments: patch

Требуется авторизация

Обновите существующий эксперимент. Этот метод поддерживает семантику исправлений. См. пример .

Помимо стандартных параметров , этот метод поддерживает параметры, перечисленные в таблице параметров.

Запрос

HTTP-запрос

PATCH https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId

Параметры

Имя параметра Ценить Описание
Параметры пути
accountId string Идентификатор аккаунта эксперимента, который необходимо обновить.
experimentId string Идентификатор эксперимента, который необходимо обновить.
profileId string Идентификатор представления (профиля) эксперимента, который необходимо обновить.
webPropertyId string Идентификатор веб-ресурса эксперимента, который необходимо обновить.

Авторизация

Этот запрос требует авторизации хотя бы в одной из следующих областей ( подробнее об аутентификации и авторизации читайте здесь ).

Объем
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit

Тело запроса

В теле запроса предоставьте соответствующие части ресурса Management.experiment в соответствии с правилами семантики исправлений со следующими свойствами:

Имя свойства Ценить Описание Примечания
Обязательные свойства
id string Идентификатор эксперимента. Требуется для патчей и обновлений. Запрещено создавать.
Дополнительные свойства
description string Заметки об этом эксперименте. записываемый
editableInGaUi boolean Если это правда, конечный пользователь сможет редактировать эксперимент через пользовательский интерфейс Google Analytics. записываемый
equalWeighting boolean Логическое значение, указывающее, следует ли распределять трафик равномерно по всем вариантам. Если значение равно False, эксперименты с контентом следуют стандартному поведению, заключающемуся в динамической корректировке трафика на основе вариаций эффективности. Необязательно – по умолчанию установлено значение False. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
minimumExperimentLengthInDays integer Целое число в [3, 90]. Указывает минимальную продолжительность эксперимента. Можно изменить для текущего эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
name string Название эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. Это поле обязательно для заполнения при создании эксперимента. записываемый
objectiveMetric string Метрика, которую оптимизирует эксперимент. Допустимые значения: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", " ga:transactions", "ga:transactionRevenue". Это поле является обязательным, если статус «РАБОТАЕТ», а для «Серверфреймворк» — «ПЕРЕДИРЕКТ» или «API». записываемый
optimizationType string Следует ли минимизировать или максимизировать ObjectMetric. Возможные значения: «МАКСИМАЛЬНЫЙ», «МИНИМУМ». Необязательно — по умолчанию «МАКСИМАЛЬНЫЙ». Невозможно указать без ObjectMetric. Невозможно изменить, если статус «РАБОТАЕТ» или «ЗАВЕРШЕН». записываемый
rewriteVariationUrlsAsOriginal boolean Логическое значение, указывающее, перезаписываются ли URL-адреса вариантов в соответствии с оригиналом. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
servingFramework string Структура, используемая для обслуживания вариантов эксперимента и оценки результатов. Один из:
  • ПЕРЕНАПРАВЛЕНИЕ: Google Analytics перенаправляет трафик на разные страницы вариантов, сообщает о выбранном варианте и оценивает результаты.
  • API: Google Analytics выбирает вариант для обслуживания и сообщает о нем, а также оценивает результаты; вызывающий абонент несет ответственность за обслуживание выбранного варианта.
  • ВНЕШНИЙ: варианты будут обслуживаться извне, а выбранный вариант будет передан в Google Analytics. Вызывающая сторона несет ответственность за обслуживание выбранного варианта и оценку результатов.
записываемый
status string Статус эксперимента. Возможные значения: «ЧЕРНОВИК», «READY_TO_RUN», «RUNNING», «ENDED». Эксперименты можно создавать в состоянии «ЧЕРНОВИК», «READY_TO_RUN» или «RUNNING». Это поле обязательно для заполнения при создании эксперимента. записываемый
trafficCoverage double Число с плавающей запятой от 0 до 1. Указывает долю трафика, участвующую в эксперименте. Можно изменить для текущего эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
variations[] list Массив вариаций. Первая вариация массива является исходной. Количество вариантов не может меняться, когда эксперимент находится в состоянии ВЫПОЛНЯЕТСЯ. Прежде чем статус можно будет установить на «РАБОТАЕТ», требуются как минимум два изменения. записываемый
variations[]. name string Название вариации. Это поле обязательно для заполнения при создании эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
variations[]. status string Статус вариации. Возможные значения: «АКТИВНО», «НЕАКТИВНО». НЕАКТИВНЫЕ варианты не обслуживаются. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
variations[]. url string URL-адрес варианта. Это поле нельзя изменить для эксперимента со статусом ВЫПОЛНЯЕТСЯ или ЗАВЕРШЕНО. записываемый
winnerConfidenceLevel double Число с плавающей запятой от 0 до 1. Определяет необходимый уровень уверенности для выбора победителя. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый

Ответ

В случае успеха этот метод возвращает ресурс Management.experiment в теле ответа.

Примеры

Примечание. Примеры кода, доступные для этого метода, не представляют все поддерживаемые языки программирования (список поддерживаемых языков см. на странице клиентских библиотек ).

Джава

Использует клиентскую библиотеку Java .

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

// This example patches an existing experiment with new variations.
Variations variationA = new Variations();
variationA.setName("Home A");
variationA.setUrl("homeA.html");
Variations variationB = new Variations();
variationB.setName("Home B");
variationB.setUrl("homeB.html");
List<Variations> variations = Arrays.asList(variationA, variationB);

try {
  // First get an existing Experiment.
  Experiment body = analytics.management().experiments().get("123456",
      "UA-123456-1", "7654321", "122333444455555").execute();

  // Set the new variations.
  body.setVariations(variations);

  // Call Patch with the updated experiment.
  analytics.management().experiments().patch("123456", "UA-123456-1",
      "7654321", "12233344455555", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

Использует клиентскую библиотеку PHP .

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

/**
 * This request patches an existing experiment.
 */

// Construct the first variation.
$variationA = new Google_Service_Analytics_ExperimentVariations();
$variationA->setName('VariationA');
$variationA->setUrl('index.html');

// Construct the second variation.
$variationB = new Google_Service_Analytics_ExperimentVariations();
$variationB->setName('VariationB');
$variationB->setUrl('indexB.html');

try {
  // Get an existing Experiment.
  $experiment = $analytics->management_experiments->get('123456',
      'UA-123456-1', '7654321', '122333444455555');

  // Set the new variations.
  $experiment->setVariations(array($variationA, $variationB));

  // Call the patch method with the updated experiment.
  $analytics->management_experiments->patch('123456', 'UA-123456-1',
      '7654321', '122333444455555', $experiment);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


Питон

Использует клиентскую библиотеку Python .

# Note: This code assumes you have an authorized Analytics service object.
# See the Experiments Developer Guide for details.

# This request patches an existing experiment with a new name,
# and new variations.
try:
  analytics.management().experiments().patch(
      accountId='123456',
      webPropertyId='UA-123456-1',
      profileId='7654321',
      experimentId='ABCDEFG123456abcdefg',
      body={
          'name': 'Landing Page Test April',
          'variations': [
              {
                  'name': 'First Variation',
                  'url': 'index.html'
              },
              {
                  'name': 'Proposed Change',
                  'url': 'indexB.html'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Использует клиентскую библиотеку JavaScript .

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Experiments Developer Guide for details.
 */

/*
 * This request patches an existing experiment.
 */
function patchExperiment() {
  var request = gapi.client.analytics.management.experiments.patch(
    {
      'accountId': '123456',
      'webPropertyId': 'UA-123456-1',
      'profileId': '7654321',
      'experimentId': '122333444455555',
      'resource': {
        'name': 'Landing Page Test',
        'status': 'DRAFT',
        'variations': [
          {
            'name': 'VariationA',
            'url': 'index.html'
          },
          {
            'name': 'VariationB',
            'url': 'indexB.html'
          }
        ]
      }
    });
  request.execute(function (response) { // Handle the response. });
}
,

Требуется авторизация

Обновите существующий эксперимент. Этот метод поддерживает семантику исправлений. См. пример .

Помимо стандартных параметров , этот метод поддерживает параметры, перечисленные в таблице параметров.

Запрос

HTTP-запрос

PATCH https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/experiments/experimentId

Параметры

Имя параметра Ценить Описание
Параметры пути
accountId string Идентификатор аккаунта эксперимента, который необходимо обновить.
experimentId string Идентификатор эксперимента, который необходимо обновить.
profileId string Идентификатор представления (профиля) эксперимента, который необходимо обновить.
webPropertyId string Идентификатор веб-ресурса эксперимента, который необходимо обновить.

Авторизация

Этот запрос требует авторизации хотя бы в одной из следующих областей ( подробнее об аутентификации и авторизации читайте здесь ).

Объем
https://www.googleapis.com/auth/analytics
https://www.googleapis.com/auth/analytics.edit

Тело запроса

В теле запроса предоставьте соответствующие части ресурса Management.experiment в соответствии с правилами семантики исправлений со следующими свойствами:

Имя свойства Ценить Описание Примечания
Обязательные свойства
id string Идентификатор эксперимента. Требуется для патчей и обновлений. Запрещено создавать.
Дополнительные свойства
description string Заметки об этом эксперименте. записываемый
editableInGaUi boolean Если это правда, конечный пользователь сможет редактировать эксперимент через пользовательский интерфейс Google Analytics. записываемый
equalWeighting boolean Логическое значение, указывающее, следует ли распределять трафик равномерно по всем вариантам. Если значение равно False, эксперименты с контентом следуют стандартному поведению, заключающемуся в динамической корректировке трафика на основе вариаций эффективности. Необязательно – по умолчанию установлено значение False. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
minimumExperimentLengthInDays integer Целое число в [3, 90]. Указывает минимальную продолжительность эксперимента. Можно изменить для текущего эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
name string Название эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. Это поле обязательно для заполнения при создании эксперимента. записываемый
objectiveMetric string Метрика, которую оптимизирует эксперимент. Допустимые значения: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", " ga:transactions", "ga:transactionRevenue". Это поле является обязательным, если статус «РАБОТАЕТ», а для «Серверфреймворк» — «ПЕРЕДИРЕКТ» или «API». записываемый
optimizationType string Следует ли минимизировать или максимизировать ObjectMetric. Возможные значения: «МАКСИМАЛЬНЫЙ», «МИНИМУМ». Необязательно — по умолчанию «МАКСИМАЛЬНЫЙ». Невозможно указать без ObjectMetric. Невозможно изменить, если статус «РАБОТАЕТ» или «ЗАВЕРШЕН». записываемый
rewriteVariationUrlsAsOriginal boolean Логическое значение, указывающее, перезаписываются ли URL-адреса вариантов в соответствии с оригиналом. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
servingFramework string Структура, используемая для обслуживания вариантов эксперимента и оценки результатов. Один из:
  • ПЕРЕНАПРАВЛЕНИЕ: Google Analytics перенаправляет трафик на разные варианты страниц, сообщает о выбранном варианте и оценивает результаты.
  • API: Google Analytics выбирает вариант для обслуживания и сообщает о нем, а также оценивает результаты; вызывающий абонент несет ответственность за обслуживание выбранного варианта.
  • ВНЕШНИЙ: варианты будут обслуживаться извне, а выбранный вариант будет передан в Google Analytics. Вызывающая сторона несет ответственность за обслуживание выбранного варианта и оценку результатов.
записываемый
status string Статус эксперимента. Возможные значения: «ЧЕРНОВИК», «READY_TO_RUN», «RUNNING», «ENDED». Эксперименты можно создавать в состоянии «ЧЕРНОВИК», «READY_TO_RUN» или «RUNNING». Это поле обязательно для заполнения при создании эксперимента. записываемый
trafficCoverage double Число с плавающей запятой от 0 до 1. Указывает долю трафика, участвующую в эксперименте. Можно изменить для текущего эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
variations[] list Массив вариаций. Первая вариация массива является исходной. Количество вариантов не может меняться, когда эксперимент находится в состоянии ВЫПОЛНЯЕТСЯ. Прежде чем статус можно будет установить на «РАБОТАЕТ», требуются как минимум два изменения. записываемый
variations[]. name string Название вариации. Это поле обязательно для заполнения при создании эксперимента. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
variations[]. status string Статус вариации. Возможные значения: «АКТИВНО», «НЕАКТИВНО». НЕАКТИВНЫЕ варианты не обслуживаются. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый
variations[]. url string URL-адрес варианта. Это поле нельзя изменить для эксперимента со статусом ВЫПОЛНЯЕТСЯ или ЗАВЕРШЕНО. записываемый
winnerConfidenceLevel double Число с плавающей запятой от 0 до 1. Определяет необходимый уровень уверенности для выбора победителя. Это поле нельзя изменить для эксперимента со статусом ЗАВЕРШЕНО. записываемый

Ответ

В случае успеха этот метод возвращает ресурс Management.experiment в теле ответа.

Примеры

Примечание. Примеры кода, доступные для этого метода, не представляют все поддерживаемые языки программирования (список поддерживаемых языков см. на странице клиентских библиотек ).

Джава

Использует клиентскую библиотеку Java .

/*
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

// This example patches an existing experiment with new variations.
Variations variationA = new Variations();
variationA.setName("Home A");
variationA.setUrl("homeA.html");
Variations variationB = new Variations();
variationB.setName("Home B");
variationB.setUrl("homeB.html");
List<Variations> variations = Arrays.asList(variationA, variationB);

try {
  // First get an existing Experiment.
  Experiment body = analytics.management().experiments().get("123456",
      "UA-123456-1", "7654321", "122333444455555").execute();

  // Set the new variations.
  body.setVariations(variations);

  // Call Patch with the updated experiment.
  analytics.management().experiments().patch("123456", "UA-123456-1",
      "7654321", "12233344455555", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

Использует клиентскую библиотеку PHP .

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Experiments Developer Guide for details.
 */

/**
 * This request patches an existing experiment.
 */

// Construct the first variation.
$variationA = new Google_Service_Analytics_ExperimentVariations();
$variationA->setName('VariationA');
$variationA->setUrl('index.html');

// Construct the second variation.
$variationB = new Google_Service_Analytics_ExperimentVariations();
$variationB->setName('VariationB');
$variationB->setUrl('indexB.html');

try {
  // Get an existing Experiment.
  $experiment = $analytics->management_experiments->get('123456',
      'UA-123456-1', '7654321', '122333444455555');

  // Set the new variations.
  $experiment->setVariations(array($variationA, $variationB));

  // Call the patch method with the updated experiment.
  $analytics->management_experiments->patch('123456', 'UA-123456-1',
      '7654321', '122333444455555', $experiment);
} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}


Питон

Использует клиентскую библиотеку Python .

# Note: This code assumes you have an authorized Analytics service object.
# See the Experiments Developer Guide for details.

# This request patches an existing experiment with a new name,
# and new variations.
try:
  analytics.management().experiments().patch(
      accountId='123456',
      webPropertyId='UA-123456-1',
      profileId='7654321',
      experimentId='ABCDEFG123456abcdefg',
      body={
          'name': 'Landing Page Test April',
          'variations': [
              {
                  'name': 'First Variation',
                  'url': 'index.html'
              },
              {
                  'name': 'Proposed Change',
                  'url': 'indexB.html'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Использует клиентскую библиотеку JavaScript .

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Experiments Developer Guide for details.
 */

/*
 * This request patches an existing experiment.
 */
function patchExperiment() {
  var request = gapi.client.analytics.management.experiments.patch(
    {
      'accountId': '123456',
      'webPropertyId': 'UA-123456-1',
      'profileId': '7654321',
      'experimentId': '122333444455555',
      'resource': {
        'name': 'Landing Page Test',
        'status': 'DRAFT',
        'variations': [
          {
            'name': 'VariationA',
            'url': 'index.html'
          },
          {
            'name': 'VariationB',
            'url': 'indexB.html'
          }
        ]
      }
    });
  request.execute(function (response) { // Handle the response. });
}