Специальные параметры: метод patch

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

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

Запрос

HTTP-запрос

PATCH https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customDimensions/customDimensionId

Параметры

Название параметра Значение Описание
Параметры пути
accountId string Идентификатор аккаунта, для которого требуется обновить специальный параметр.
customDimensionId string Идентификатор специального параметра.
webPropertyId string Идентификатор веб-ресурса, для которого требуется обновить специальный параметр.
Необязательные параметры запроса

Авторизация

Этот запрос требует авторизации в следующей области доступа. Подробнее об аутентификации и авторизации...

Область доступа
https://www.googleapis.com/auth/analytics.edit

Тело запроса

В теле запроса необходимо предоставить части ресурса management.customDimension в соответствии с правилами семантики PATCH.

Ответ

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

Примеры

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

Java

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

/*
 * Note: This code assumes you have an authorized Analytics service object.
 */

/*
 * This request patches an existing custom dimension.
 */

// Construct the body of the request and set its properties.
CustomDimension body = new CustomDimension();
body.setName("Campaign Group");
body.setScope("SESSION");
body.setActive(true);

try {
  analytics.management().customDimensions()
      .patch("123456", "UA-123456-1", "ga:dimension2", body).execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

Python

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

# Note: This code assumes you have an authorized Analytics service object.

# This request patches an existing custom dimension.
try:
  analytics.management().customDimensions().patch(
      accountId='123456',
      webPropertyId='UA-123456-1',
      customDimensionId='ga:dimension2',
      body={
          'name': 'Campaign Group',
          'scope': 'SESSION',
          'active': True
      }
  ).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))

Практическое занятие

Воспользуйтесь инструментом API Explorer ниже, чтобы применить этот метод к реальным данным и посмотреть, как он работает. Также можно перейти на эту страницу.