Фильтры: метод insert

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

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

Запрос

HTTP-запрос

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

Параметры

Название параметра Значение Описание
Параметры пути
accountId 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 Поле A. Можно редактировать
advancedDetails.fieldAIndex integer Индекс специального параметра. Требуется для полей типа CUSTOM_DIMENSION. Можно редактировать
advancedDetails.fieldARequired boolean Указывает, что поле A обязательно для сопоставления. Можно редактировать
advancedDetails.fieldB string Поле B. Можно редактировать
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;
    • PAGE_TITLE;
    • REFERRAL;
    • COST_DATA_URI (целевой URL кампании);
    • HIT_TYPE;
    • INTERNAL_SEARCH_TERM;
    • INTERNAL_SEARCH_TYPE;
    • SOURCE_PROPERTY_TRACKING_ID.
  • Кампания или группа объявлений:
    • CAMPAIGN_SOURCE;
    • CAMPAIGN_MEDIUM;
    • CAMPAIGN_NAME;
    • CAMPAIGN_AD_GROUP;
    • CAMPAIGN_TERM;
    • CAMPAIGN_CONTENT;
    • CAMPAIGN_CODE;
    • CAMPAIGN_REFERRAL_PATH.
  • Электронная торговля:
    • TRANSACTION_COUNTRY;
    • TRANSACTION_REGION;
    • TRANSACTION_CITY;
    • TRANSACTION_AFFILIATION (местоположение магазина или заказа);
    • ITEM_NAME;
    • ITEM_CODE;
    • ITEM_VARIATION;
    • TRANSACTION_ID;
    • TRANSACTION_CURRENCY_CODE;
    • PRODUCT_ACTION_TYPE.
  • Аудитория и пользователи
    • BROWSER;
    • BROWSER_VERSION;
    • BROWSER_SIZE;
    • PLATFORM;
    • PLATFORM_VERSION;
    • LANGUAGE;
    • SCREEN_RESOLUTION;
    • SCREEN_COLORS;
    • JAVA_ENABLED (поле с логическим значением);
    • FLASH_VERSION;
    • GEO_SPEED (скорость соединения);
    • VISITOR_TYPE;
    • GEO_ORGANIZATION (интернет-провайдер);
    • GEO_DOMAIN;
    • GEO_IP_ADDRESS;
    • GEO_IP_VERSION.
  • Местоположение:
    • GEO_COUNTRY;
    • GEO_REGION;
    • GEO_CITY.
  • Событие
    • EVENT_CATEGORY;
    • EVENT_ACTION;
    • EVENT_LABEL.
  • Другое:
    • CUSTOM_FIELD_1;
    • CUSTOM_FIELD_2;
    • USER_DEFINED_VALUE.
  • Приложение:
    • APP_ID;
    • APP_INSTALLER_ID;
    • APP_NAME;
    • APP_VERSION;
    • SCREEN;
    • IS_APP (поле с логическим значением);
    • IS_FATAL_EXCEPTION (поле с логическим значением);
    • EXCEPTION_DESCRIPTION;
  • Мобильное устройство:
    • IS_MOBILE (поле с логическим значением, устарело, используйте DEVICE_CATEGORY=mobile);
    • IS_TABLET (поле с логическим значением, устарело, используйте DEVICE_CATEGORY=tablet);
    • DEVICE_CATEGORY;
    • MOBILE_HAS_QWERTY_KEYBOARD (поле с логическим значением);
    • MOBILE_HAS_NFC_SUPPORT (поле с логическим значением);
    • MOBILE_HAS_CELLULAR_RADIO (поле с логическим значением);
    • MOBILE_HAS_WIFI_SUPPORT (поле с логическим значением);
    • MOBILE_BRAND_NAME;
    • MOBILE_MODEL_NAME;
    • MOBILE_MARKETING_NAME;
    • MOBILE_POINTING_METHOD.
  • Социальные функции
    • SOCIAL_NETWORK;
    • SOCIAL_ACTION;
    • 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;
    • PAGE_TITLE;
    • REFERRAL;
    • COST_DATA_URI (целевой URL кампании);
    • HIT_TYPE;
    • INTERNAL_SEARCH_TERM;
    • INTERNAL_SEARCH_TYPE;
    • SOURCE_PROPERTY_TRACKING_ID.
  • Кампания или группа объявлений:
    • CAMPAIGN_SOURCE;
    • CAMPAIGN_MEDIUM;
    • CAMPAIGN_NAME;
    • CAMPAIGN_AD_GROUP;
    • CAMPAIGN_TERM;
    • CAMPAIGN_CONTENT;
    • CAMPAIGN_CODE;
    • CAMPAIGN_REFERRAL_PATH.
  • Электронная торговля:
    • TRANSACTION_COUNTRY;
    • TRANSACTION_REGION;
    • TRANSACTION_CITY;
    • TRANSACTION_AFFILIATION (местоположение магазина или заказа);
    • ITEM_NAME;
    • ITEM_CODE;
    • ITEM_VARIATION;
    • TRANSACTION_ID;
    • TRANSACTION_CURRENCY_CODE;
    • PRODUCT_ACTION_TYPE.
  • Аудитория и пользователи
    • BROWSER;
    • BROWSER_VERSION;
    • BROWSER_SIZE;
    • PLATFORM;
    • PLATFORM_VERSION;
    • LANGUAGE;
    • SCREEN_RESOLUTION;
    • SCREEN_COLORS;
    • JAVA_ENABLED (поле с логическим значением);
    • FLASH_VERSION;
    • GEO_SPEED (скорость соединения);
    • VISITOR_TYPE;
    • GEO_ORGANIZATION (интернет-провайдер);
    • GEO_DOMAIN;
    • GEO_IP_ADDRESS;
    • GEO_IP_VERSION.
  • Местоположение:
    • GEO_COUNTRY;
    • GEO_REGION;
    • GEO_CITY.
  • Событие
    • EVENT_CATEGORY;
    • EVENT_ACTION;
    • EVENT_LABEL.
  • Другое:
    • CUSTOM_FIELD_1;
    • CUSTOM_FIELD_2;
    • USER_DEFINED_VALUE.
  • Приложение:
    • APP_ID;
    • APP_INSTALLER_ID;
    • APP_NAME;
    • APP_VERSION;
    • SCREEN;
    • IS_APP (поле с логическим значением);
    • IS_FATAL_EXCEPTION (поле с логическим значением);
    • EXCEPTION_DESCRIPTION;
  • Мобильное устройство:
    • IS_MOBILE (поле с логическим значением, устарело, используйте DEVICE_CATEGORY=mobile);
    • IS_TABLET (поле с логическим значением, устарело, используйте DEVICE_CATEGORY=tablet);
    • DEVICE_CATEGORY;
    • MOBILE_HAS_QWERTY_KEYBOARD (поле с логическим значением);
    • MOBILE_HAS_NFC_SUPPORT (поле с логическим значением);
    • MOBILE_HAS_CELLULAR_RADIO (поле с логическим значением);
    • MOBILE_HAS_WIFI_SUPPORT (поле с логическим значением);
    • MOBILE_BRAND_NAME;
    • MOBILE_MODEL_NAME;
    • MOBILE_MARKETING_NAME;
    • MOBILE_POINTING_METHOD.
  • Социальные функции
    • SOCIAL_NETWORK;
    • SOCIAL_ACTION;
    • 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

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

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

/*
 * This example creates a new 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().insert("123456", 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 creates a new 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->setExcludeDetails($details);
  $analytics->management_filters->insert('123456', $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

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

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

# This request creates a new filter.
try:
  analytics.management().filters().insert(
      accountId='123456',
      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 creates a new filter.
 */
function insertFilter() {
  var request = gapi.client.analytics.management.filters.insert(
    {
      'accountId': '123456',
      'resource': {
        '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 Explorer ниже, чтобы применить этот метод к реальным данным и посмотреть, как он работает. Также можно перейти на эту страницу.