Filters: insert

Requiere autorización.

Cree un filtro nuevo. Pruébalo ahora y ve un ejemplo.

Solicitud

Solicitud HTTP

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

Parámetros

Nombre del parámetro Valor Descripción
Parámetros de ruta de acceso
accountId string ID de la cuenta para el que se creará el filtro.

Autorización

Esta solicitud requiere autorización con el siguiente alcance (más información sobre la autenticación y la autorización).

Alcance
https://www.googleapis.com/auth/analytics.edit

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporciona un recurso management.filter con las siguientes propiedades:

Nombre de la propiedad Valor Descripción Notas
Propiedades obligatorias
name string Nombre de este filtro. admite escritura
type string Tipo de este filtro. Los valores posibles son INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE y ADVANCED. admite escritura
Propiedades opcionales
advancedDetails.caseSensitive boolean Indica si las expresiones de filtro distinguen mayúsculas de minúsculas. admite escritura
advancedDetails.extractA string Expresión para extraer del campo A. admite escritura
advancedDetails.extractB string Expresión para extraer del campo B. admite escritura
advancedDetails.fieldA string Campo A. admite escritura
advancedDetails.fieldAIndex integer Es el índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. admite escritura
advancedDetails.fieldARequired boolean Indica si el campo A es obligatorio para coincidir. admite escritura
advancedDetails.fieldB string Campo B. admite escritura
advancedDetails.fieldBIndex integer Es el índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. admite escritura
advancedDetails.fieldBRequired boolean Indica si el campo B es obligatorio para coincidir. admite escritura
advancedDetails.outputConstructor string Expresión que se usa para construir el valor de salida. admite escritura
advancedDetails.outputToField string Campo de salida. admite escritura
advancedDetails.outputToFieldIndex integer Es el índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. admite escritura
advancedDetails.overrideOutputField boolean Indica si la expresión de salida debe anular el valor existente del campo de resultado, si existe alguno. admite escritura
excludeDetails.caseSensitive boolean Determina si el filtro distingue mayúsculas de minúsculas. admite escritura
excludeDetails.expressionValue string Valor de expresión de filtro admite escritura
excludeDetails.field string Campo para filtrar. Valores posibles:
  • Contenido y tráfico
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME
    • PAGE_TITLE
    • REFERENCIA
    • COST_DATA_URI (URL de orientación de la campaña)
    • HIT_TYPE
    • INTERNAL_SEARCH_TERM,
    • INTERNAL_SEARCH_TYPE:
    • SOURCE_PROPERTY_TRACKING_ID,
  • Campaña o grupo de anuncios
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM;
    • CAMPAIGN_NAME
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_TERM
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE;
    • CAMPAIGN_REFERRAL_PATH,
  • Comercio electrónico
    • TRANSACTION_COUNTRY
    • TRANSACTION_REGION
    • TRANSACTION_CITY
    • TRANSACTION_AFFILIATION (ubicación de la tienda o del pedido),
    • ITEM_NAME
    • ITEM_CODE,
    • ITEM_VARIATION
    • TRANSACTION_ID
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE
  • Público/Usuarios
    • NAVEGADOR,
    • BROWSER_VERSION
    • BROWSER_SIZE
    • PLATAFORMA,
    • PLATFORM_VERSION;
    • IDIOMA
    • SCREEN_RESOLUTION
    • SCREEN_COLORS
    • JAVA_ENABLED (campo booleano),
    • FLASH_VERSION
    • GEO_SPEED (Velocidad de conexión),
    • VISITOR_TYPE,
    • GEO_ORGANIZATION (organización de ISP),
    • GEO_DOMAIN
    • GEO_IP_ADDRESS
    • GEO_IP_VERSION,
  • Ubicación
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CIUDAD,
  • Evento
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL
  • Otro
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • Aplicación
    • APP_ID
    • APP_INSTALLER_ID,
    • APP_NAME
    • APP_VERSION
    • PANTALLA
    • IS_APP (campo booleano),
    • IS_FATAL_EXCEPTION (campo booleano),
    • EXCEPTION_DESCRIPTION,
  • Dispositivo móvil
    • IS_MOBILE (Campo booleano, obsoleto. Usar DEVICE_CATEGORY=mobile),
    • IS_TABLET (campo booleano, obsoleto. Usar DEVICE_CATEGORY=tablet),
    • DEVICE_CATEGORY,
    • MOBILE_HAS_QWERTY_KEYBOARD (campo booleano),
    • MOBILE_HAS_NFC_SUPPORT (Campo booleano),
    • MOBILE_HAS_CELLULAR_RADIO (campo booleano),
    • MOBILE_HAS_WIFI_SUPPORT (Campo booleano),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_METHOD,
  • Social
    • SOCIAL_NETWORK
    • SOCIAL_ACTION
    • SOCIAL_ACTION_TARGET
admite escritura
excludeDetails.fieldIndex integer Es el índice de la dimensión personalizada. Solo se establece si el campo es CUSTOM_DIMENSION. admite escritura
excludeDetails.matchType string Tipo de concordancia para este filtro. Los valores posibles son BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS o MATCHES. Los filtros GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI o PAGE_HOSTNAME pueden usar cualquier tipo de concordancia. Todos los demás filtros deben usar MATCHES. admite escritura
includeDetails.caseSensitive boolean Determina si el filtro distingue mayúsculas de minúsculas. admite escritura
includeDetails.expressionValue string Valor de expresión de filtro admite escritura
includeDetails.field string Campo para filtrar. Valores posibles:
  • Contenido y tráfico
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME
    • PAGE_TITLE
    • REFERENCIA
    • COST_DATA_URI (URL de orientación de la campaña)
    • HIT_TYPE
    • INTERNAL_SEARCH_TERM,
    • INTERNAL_SEARCH_TYPE:
    • SOURCE_PROPERTY_TRACKING_ID,
  • Campaña o grupo de anuncios
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM;
    • CAMPAIGN_NAME
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_TERM
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE;
    • CAMPAIGN_REFERRAL_PATH,
  • Comercio electrónico
    • TRANSACTION_COUNTRY
    • TRANSACTION_REGION
    • TRANSACTION_CITY
    • TRANSACTION_AFFILIATION (ubicación de la tienda o del pedido),
    • ITEM_NAME
    • ITEM_CODE,
    • ITEM_VARIATION
    • TRANSACTION_ID
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE
  • Público/Usuarios
    • NAVEGADOR,
    • BROWSER_VERSION
    • BROWSER_SIZE
    • PLATAFORMA,
    • PLATFORM_VERSION;
    • IDIOMA
    • SCREEN_RESOLUTION
    • SCREEN_COLORS
    • JAVA_ENABLED (campo booleano),
    • FLASH_VERSION
    • GEO_SPEED (Velocidad de conexión),
    • VISITOR_TYPE,
    • GEO_ORGANIZATION (organización de ISP),
    • GEO_DOMAIN
    • GEO_IP_ADDRESS
    • GEO_IP_VERSION,
  • Ubicación
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CIUDAD,
  • Evento
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL
  • Otro
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • Aplicación
    • APP_ID
    • APP_INSTALLER_ID,
    • APP_NAME
    • APP_VERSION
    • PANTALLA
    • IS_APP (campo booleano),
    • IS_FATAL_EXCEPTION (campo booleano),
    • EXCEPTION_DESCRIPTION,
  • Dispositivo móvil
    • IS_MOBILE (Campo booleano, obsoleto. Usar DEVICE_CATEGORY=mobile),
    • IS_TABLET (campo booleano, obsoleto. Usar DEVICE_CATEGORY=tablet),
    • DEVICE_CATEGORY,
    • MOBILE_HAS_QWERTY_KEYBOARD (campo booleano),
    • MOBILE_HAS_NFC_SUPPORT (Campo booleano),
    • MOBILE_HAS_CELLULAR_RADIO (campo booleano),
    • MOBILE_HAS_WIFI_SUPPORT (Campo booleano),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_METHOD,
  • Social
    • SOCIAL_NETWORK
    • SOCIAL_ACTION
    • SOCIAL_ACTION_TARGET
admite escritura
includeDetails.fieldIndex integer Es el índice de la dimensión personalizada. Solo se establece si el campo es CUSTOM_DIMENSION. admite escritura
includeDetails.matchType string Tipo de concordancia para este filtro. Los valores posibles son BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS o MATCHES. Los filtros GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI o PAGE_HOSTNAME pueden usar cualquier tipo de concordancia. Todos los demás filtros deben usar MATCHES. admite escritura
lowercaseDetails.field string Campo que se usará en el filtro. admite escritura
lowercaseDetails.fieldIndex integer Es el índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. admite escritura
searchAndReplaceDetails.caseSensitive boolean Determina si el filtro distingue mayúsculas de minúsculas. admite escritura
searchAndReplaceDetails.field string Campo que se usará en el filtro. admite escritura
searchAndReplaceDetails.fieldIndex integer Es el índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. admite escritura
searchAndReplaceDetails.replaceString string Término para reemplazar el término de búsqueda. admite escritura
searchAndReplaceDetails.searchString string Término para buscar. admite escritura
uppercaseDetails.field string Campo que se usará en el filtro. admite escritura
uppercaseDetails.fieldIndex integer Es el índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. admite escritura

Respuesta

Si se aplica correctamente, este método muestra un recurso management.filter en el cuerpo de la respuesta.

Ejemplos

Nota: Los ejemplos de código disponibles para este método no representan todos los lenguajes de programación admitidos (consulta la página de bibliotecas cliente para consultar una lista de lenguajes admitidos).

Java

Usa la biblioteca cliente de 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

Usa la biblioteca cliente 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

Usa la biblioteca cliente de 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

Usa la biblioteca cliente de 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. });
}

Pruébela.

Usa el Explorador de API que aparece a continuación para llamar a este método en datos activos y ver la respuesta. También puedes probar el Explorador independiente.