Filters: update

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

Обновляет существующий фильтр. Попробуйте сейчас или посмотрите пример .

Запрос

HTTP-запрос

PUT https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters/filterId

Параметры

Имя параметра Ценить Описание
Параметры пути
accountId string Идентификатор учетной записи, которой принадлежит фильтр.
filterId string Идентификатор фильтра, который необходимо обновить.

Авторизация

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

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

Тело запроса

В теле запроса укажите ресурс Management.filter со следующими свойствами:

Имя свойства Ценить Описание Примечания
Обязательные свойства
name string Имя этого фильтра. записываемый
type string Тип этого фильтра. Возможные значения: INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE и ADVANCED. записываемый
Дополнительные свойства
advancedDetails. caseSensitive boolean Указывает, чувствительны ли выражения фильтра к регистру. записываемый
advancedDetails. extractA string Выражение для извлечения из поля A. записываемый
advancedDetails. extractB string Выражение для извлечения из поля B. записываемый
advancedDetails. fieldA string Поле А. записываемый
advancedDetails. fieldAIndex integer Индекс специального параметра. Обязательно, если поле имеет значение CUSTOM_DIMENSION. записываемый
advancedDetails. fieldARequired boolean Указывает, требуется ли соответствие поля A. записываемый
advancedDetails. fieldB string Поле Б. записываемый
advancedDetails. fieldBIndex integer Индекс специального параметра. Обязательно, если поле имеет значение CUSTOM_DIMENSION. записываемый
advancedDetails. fieldBRequired boolean Указывает, требуется ли соответствие поля B. записываемый
advancedDetails. outputConstructor string Выражение, используемое для создания выходного значения. записываемый
advancedDetails. outputToField string Поле вывода. записываемый
advancedDetails. outputToFieldIndex integer Индекс специального параметра. Обязательно, если поле имеет значение CUSTOM_DIMENSION. записываемый
advancedDetails. overrideOutputField boolean Указывает, должно ли существующее значение выходного поля (если таковое имеется) быть переопределено выходным выражением. записываемый
excludeDetails. caseSensitive boolean Определяет, чувствителен ли фильтр к регистру. записываемый
excludeDetails. expressionValue string Значение выражения фильтра записываемый
excludeDetails. field string Поле для фильтрации. Возможные значения:
  • Контент и трафик
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • ЗАГОЛОВОК СТРАНИЦЫ,
    • НАПРАВЛЕНИЯ,
    • COST_DATA_URI (целевой URL-адрес кампании),
    • HIT_TYPE,
    • INTERNAL_SEARCH_TERM,
    • ВНУТРЕННИЙ_ПОИСК_ТИП,
    • SOURCE_PROPERTY_TRACKING_ID,
  • Кампания или группа объявлений
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM,
    • НАЗВАНИЕ КАМПАНИИ,
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_TERM,
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE,
    • CAMPAIGN_REFERRAL_PATH,
  • Электронная коммерция
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (Местоположение магазина или заказа),
    • ИМЯ ЭЛЕМЕНТА,
    • КОД ИЗДЕЛИЯ,
    • ITEM_VARIATION,
    • ID ТРАНЗАКЦИИ,
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE,
  • Аудитория/Пользователи
    • БРАУЗЕР,
    • БРАУЗЕР_ВЕРСИЯ,
    • БРАУЗЕР_SIZE,
    • ПЛАТФОРМА,
    • ПЛАТФОРМА_ВЕРСИЯ,
    • ЯЗЫК,
    • РАЗРЕШЕНИЕ ЭКРАНА,
    • ЭКРАН_ЦВЕТА,
    • JAVA_ENABLED (логическое поле),
    • FLASH_VERSION,
    • GEO_SPEED (Скорость соединения),
    • ПОСЕТИТЕЛЬ_ТИП,
    • GEO_ORGANIZATION (организация интернет-провайдера),
    • ГЕО_ДОМЕН,
    • ГЕО_IP_АДРЕС,
    • ГЕО_IP_ВЕРСИЯ,
  • Расположение
    • ГЕО_СТРАНА,
    • ГЕО_РЕГИОН,
    • ГЕО_СИТИ,
  • Событие
    • EVENT_CATEGORY,
    • СОБЫТИЕ_АКЦИЯ,
    • EVENT_LABEL,
  • Другой
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • ПОЛЬЗОВАТЕЛЬ_ОПРЕДЕЛЕН_ЗНАЧЕНИЕ,
  • Приложение
    • ПРИЛОЖЕНИЕ_ИД,
    • APP_INSTALLER_ID,
    • ИМЯ ПРИЛОЖЕНИЯ,
    • ПРИЛОЖЕНИЕ_ВЕРСИЯ,
    • ЭКРАН,
    • IS_APP (логическое поле),
    • IS_FATAL_EXCEPTION (логическое поле),
    • ИСКЛЮЧЕНИЕ_ОПИСАНИЕ,
  • Мобильное устройство
    • IS_MOBILE (логическое поле, устарело. Используйте DEVICE_CATEGORY=mobile),
    • IS_TABLET (логическое поле, устарело. Используйте DEVICE_CATEGORY=таблетка),
    • УСТРОЙСТВО_КАТЕГОРИЯ,
    • MOBILE_HAS_QWERTY_KEYBOARD (логическое поле),
    • MOBILE_HAS_NFC_SUPPORT (логическое поле),
    • MOBILE_HAS_CELLULAR_RADIO (логическое поле),
    • MOBILE_HAS_WIFI_SUPPORT (логическое поле),
    • MOBILE_BRAND_NAME,
    • МОБИЛЬНАЯ_МОДЕЛЬ_ИМЯ,
    • МОБИЛЬНЫЙ_МАРКЕТИНГ_ИМЯ,
    • МОБИЛЬ_POINTING_METHOD,
  • Социальное
    • СОЦИАЛЬНАЯ СЕТЬ,
    • СОЦИАЛЬНОЕ_ДЕЙСТВИЕ,
    • SOCIAL_ACTION_TARGET,
записываемый
excludeDetails. fieldIndex integer Индекс специального параметра. Устанавливается только в том случае, если поле имеет значение CUSTOM_DIMENSION. записываемый
excludeDetails. matchType string Тип соответствия для этого фильтра. Возможные значения: BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS или MATCHES . Фильтры GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI или PAGE_HOSTNAME могут использовать любой тип соответствия; все остальные фильтры должны использовать MATCHES . записываемый
includeDetails. caseSensitive boolean Определяет, чувствителен ли фильтр к регистру. записываемый
includeDetails. expressionValue string Значение выражения фильтра записываемый
includeDetails. field string Поле для фильтрации. Возможные значения:
  • Контент и трафик
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • ЗАГОЛОВОК СТРАНИЦЫ,
    • НАПРАВЛЕНИЯ,
    • COST_DATA_URI (целевой URL-адрес кампании),
    • HIT_TYPE,
    • ВНУТРЕННИЙ_ПОИСК_ТЕРМИН,
    • ВНУТРЕННИЙ_ПОИСК_ТИП,
    • SOURCE_PROPERTY_TRACKING_ID,
  • Кампания или группа объявлений
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM,
    • НАЗВАНИЕ КАМПАНИИ,
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_TERM,
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE,
    • CAMPAIGN_REFERRAL_PATH,
  • Электронная коммерция
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (Местоположение магазина или заказа),
    • ИМЯ ЭЛЕМЕНТА,
    • КОД ИЗДЕЛИЯ,
    • ITEM_VARIATION,
    • ID ТРАНЗАКЦИИ,
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE,
  • Аудитория/Пользователи
    • БРАУЗЕР,
    • БРАУЗЕР_ВЕРСИЯ,
    • БРАУЗЕР_SIZE,
    • ПЛАТФОРМА,
    • ПЛАТФОРМА_ВЕРСИЯ,
    • ЯЗЫК,
    • РАЗРЕШЕНИЕ ЭКРАНА,
    • ЭКРАН_ЦВЕТА,
    • JAVA_ENABLED (логическое поле),
    • FLASH_VERSION,
    • GEO_SPEED (Скорость соединения),
    • ПОСЕТИТЕЛЬ_ТИП,
    • GEO_ORGANIZATION (организация интернет-провайдера),
    • ГЕО_ДОМЕН,
    • ГЕО_IP_АДРЕС,
    • ГЕО_IP_ВЕРСИЯ,
  • Расположение
    • ГЕО_СТРАНА,
    • ГЕО_РЕГИОН,
    • ГЕО_СИТИ,
  • Событие
    • EVENT_CATEGORY,
    • СОБЫТИЕ_АКЦИЯ,
    • EVENT_LABEL,
  • Другой
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • ПОЛЬЗОВАТЕЛЬ_DEFINED_VALUE,
  • Приложение
    • ПРИЛОЖЕНИЕ_ИД,
    • APP_INSTALLER_ID,
    • ИМЯ ПРИЛОЖЕНИЯ,
    • ПРИЛОЖЕНИЕ_ВЕРСИЯ,
    • ЭКРАН,
    • IS_APP (логическое поле),
    • IS_FATAL_EXCEPTION (логическое поле),
    • ИСКЛЮЧЕНИЕ_ОПИСАНИЕ,
  • Мобильное устройство
    • IS_MOBILE (логическое поле, устарело. Используйте DEVICE_CATEGORY=mobile),
    • IS_TABLET (логическое поле, устарело. Используйте DEVICE_CATEGORY=таблетка),
    • УСТРОЙСТВО_КАТЕГОРИЯ,
    • MOBILE_HAS_QWERTY_KEYBOARD (логическое поле),
    • MOBILE_HAS_NFC_SUPPORT (логическое поле),
    • MOBILE_HAS_CELLULAR_RADIO (логическое поле),
    • MOBILE_HAS_WIFI_SUPPORT (логическое поле),
    • MOBILE_BRAND_NAME,
    • МОБИЛЬНАЯ_МОДЕЛЬ_ИМЯ,
    • МОБИЛЬНЫЙ_МАРКЕТИНГ_ИМЯ,
    • МОБИЛЬ_POINTING_METHOD,
  • Социальное
    • СОЦИАЛЬНАЯ СЕТЬ,
    • СОЦИАЛЬНОЕ_ДЕЙСТВИЕ,
    • SOCIAL_ACTION_TARGET,
записываемый
includeDetails. fieldIndex integer Индекс специального параметра. Устанавливается только в том случае, если поле имеет значение CUSTOM_DIMENSION. записываемый
includeDetails. matchType string Тип соответствия для этого фильтра. Возможные значения: BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS или MATCHES . Фильтры GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI или PAGE_HOSTNAME могут использовать любой тип соответствия; все остальные фильтры должны использовать MATCHES . записываемый
lowercaseDetails. field string Поле для использования в фильтре. записываемый
lowercaseDetails. fieldIndex integer Индекс специального параметра. Обязательно, если поле имеет значение CUSTOM_DIMENSION. записываемый
searchAndReplaceDetails. caseSensitive boolean Определяет, чувствителен ли фильтр к регистру. записываемый
searchAndReplaceDetails. field string Поле для использования в фильтре. записываемый
searchAndReplaceDetails. fieldIndex integer Индекс специального параметра. Обязательно, если поле имеет значение CUSTOM_DIMENSION. записываемый
searchAndReplaceDetails. replaceString string Термин, которым можно заменить поисковый запрос. записываемый
searchAndReplaceDetails. searchString string Термин для поиска. записываемый
uppercaseDetails. field string Поле для использования в фильтре. записываемый
uppercaseDetails. fieldIndex integer Индекс специального параметра. Обязательно, если поле имеет значение CUSTOM_DIMENSION. записываемый

Ответ

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

Примеры

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

Джава

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

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

/*
 * This example updates an existing filter.
 */

// Construct the filter Expression object.
AnalyticsManagementFiltersFilterExpression details = new
    AnalyticsManagementFiltersFilterExpression();
details.setField("GEO_DOMAIN");
details.setMatchType("EQUAL");
details.setExpressionValue("example.com");
details.setCaseSensitive(false);

// Construct the body of the request.
Filter body = new Filter();
body.setName("My Domain Filter");
body.setType("EXCLUDE");
body.setExcludeDetails(details);

try {
  analytics.management().filters().update("123456", "1223334444", 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 Filters Developer Guide for details.
 */

/**
 * This request updates an existing filter.
 */
try {

  // Construct the filter expression object.
  $details = new Google_Service_Analytics_FilterExpression();
  $details->setField('GEO_DOMAIN');
  $details->setMatchType('EQUAL');
  $details->setExpressionValue('example.com');
  $details->setCaseSensitive(false);

  // Construct the filter and set the details.
  $filter = new Google_Service_Analytics_Filter();
  $filter->setName('My Domain Filter');
  $filter->setType('EXCLUDE');
  $filter->setId('7654321');
  $filter->setExcludeDetails($details);
  $analytics->management_filters->update('123456', '7654321', $filter);
} 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 Filters Developer Guide for details.

# This request updates an existing filter.
try:
  analytics.management().filters().update(
      accountId='123456',
      filterId='1223334444',
      body={
          'name': 'My Domain Filter',
          'type': 'EXCLUDE',
          'excludeDetails': {
              'field': 'GEO_DOMAIN',
              'matchType': 'EQUAL',
              'expressionValue': 'example.com',
              'caseSensitive': False
              }
      }
  ).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 Filters Developer Guide for details.
 */

/*
 * This request updates an existing filter.
 */
function updateFilter() {
  var request = gapi.client.analytics.management.filters.update(
    {
      'accountId': '123456',
      'filterId': '1223334444',
      'resource': {
        'id': '1223334444',
        'name': 'My Domain Filter',
        'type': 'EXCLUDE',
        'excludeDetails': {
          'field': 'GEO_DOMAIN',
          'matchType': 'EQUAL',
          'expressionValue': 'example.com',
          'caseSensitive': false
        }
      }
    });
  request.execute(function (response) { // Handle the response. });
}

Попробуй это!

Используйте API-интерфейс ниже, чтобы вызвать этот метод для реальных данных и просмотреть ответ. Альтернативно попробуйте автономный Проводник .