Ссылки на фильтр профиля: метод insert

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

Создает новую ссылку на фильтр профиля. Испытайте его в действии или изучите готовый пример.

Запрос

HTTP-запрос

POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/profiles/profileId/profileFilterLinks

Параметры

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

Авторизация

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

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

Тело запроса

В теле запроса требуется предоставить ресурс ProfileFilterLinks со следующими свойствами:

Название свойства Значение Описание Примечания
Обязательные свойства
filterRef.id string Идентификатор фильтра. Можно редактировать
Необязательные свойства
rank integer Ранг этой ссылки на фильтр профиля относительно других фильтров, привязанных к тому же профилю.

Операции, осуществляющие только чтение (например list и get), всегда получают ранг, начиная с 1.

Для операций записи (например create, update или delete) можно указать значение от 0 до 255 включительно. Чтобы добавить ссылку в конец списка, не указывайте ее ранг или укажите значение больше любого ранее заданного. Чтобы вставить ссылку в начало списка, присвойте ей ранг не более 1. При добавлении новой ссылки все существующие фильтры с таким же или более низким рангом опускаются на одну позицию вниз по списку. После вставки, обновления или удаления ссылки изменяется нумерация всех ссылок на фильтры профиля, начиная с 1.

Можно редактировать

Ответ

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

Примеры

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

Java

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

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

/*
 * This request creates a new profile filter link.
 */

// Construct the filter reference.
FilterRef filterRef = new FilterRef();
filterRef.setId("1223334444");

// Construct the body of the request.
ProfileFilterLink body = new ProfileFilterLink();
body.setFilterRef(filterRef);

try {
analytics.management().profileFilterLinks().insert("123456",
    "UA-123456-1", "7654321", 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.
# See the Filters Developer Guide for details.

# This request creates a new profile filter link.
try:
  analytics.management().profileFilterLinks().insert(
      accountId='123456',
      webPropertyId='UA-123456-1',
      profileId='7654321',
      body={
          'filterRef': {
              'id': '1223334444'
          }
      }
  ).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 ниже, чтобы применить этот метод к реальным данным и посмотреть, как он работает. Также можно перейти на эту страницу.