Filtros: insert

Requiere autorización

Crear un filtro nuevo. Pruébalo ahora o consulta un ejemplo.

Solicitud

Solicitud HTTP

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

Parámetros

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

Autorización

Esta solicitud requiere autorización con el siguiente ámbito. Obtén más información sobre la autenticación y la autorización.

Ámbito
https://www.googleapis.com/auth/analytics.edit

Cuerpo de la solicitud

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

Nombre de propiedad Valor Descripción Notas
Propiedades obligatorias
name string Nombre de este filtro. editable
type string Tipo de este filtro. Los valores posibles son INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE y ADVANCED. editable
Propiedades opcionales
advancedDetails.caseSensitive boolean Indica si en las expresiones de filtro se distingue entre mayúsculas y minúsculas. editable
advancedDetails.extractA string Expresión que se extraerá del campo A. editable
advancedDetails.extractB string Expresión que se extraerá del campo B. editable
advancedDetails.fieldA string Campo A. editable
advancedDetails.fieldAIndex integer Índice de la dimensión personalizada. Es obligatoria si el campo es CUSTOM_DIMENSION. editable
advancedDetails.fieldARequired boolean Indica si es obligatorio que coincida el campo A. editable
advancedDetails.fieldB string Campo B. editable
advancedDetails.fieldBIndex integer Índice de la dimensión personalizada. Es obligatoria si el campo es CUSTOM_DIMENSION. editable
advancedDetails.fieldBRequired boolean Indica si es obligatorio que coincida el campo B. editable
advancedDetails.outputConstructor string Expresión usada para construir el valor de salida. editable
advancedDetails.outputToField string Campo de salida. editable
advancedDetails.outputToFieldIndex integer Índice de la dimensión personalizada. Es obligatoria si el campo es CUSTOM_DIMENSION. editable
advancedDetails.overrideOutputField boolean Indica si la expresión de salida debe anular el valor del campo de salida, si hay alguno. editable
excludeDetails.caseSensitive boolean Determina si en el filtro se distingue entre mayúsculas y minúsculas. editable
excludeDetails.expressionValue string Valor de expresión de filtro. editable
excludeDetails.field string Campo que se filtrará. Valores posibles:
  • Contenido y tráfico
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • PAGE_TITLE,
    • REFERRAL,
    • COST_DATA_URI (URL de destino 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,
  • Audiencia/usuarios
    • BROWSER,
    • BROWSER_VERSION,
    • BROWSER_SIZE,
    • PLATFORM,
    • PLATFORM_VERSION,
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_COLORS,
    • JAVA_ENABLED (campo booleano),
    • FLASH_VERSION,
    • GEO_SPEED (velocidad de conexión),
    • VISITOR_TYPE,
    • GEO_ORGANIZATION (organización del ISP),
    • GEO_DOMAIN,
    • GEO_IP_ADDRESS,
    • GEO_IP_VERSION,
  • Ubicación
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CITY,
  • Evento
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL,
  • Otros
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • Aplicación
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (campo booleano),
    • IS_FATAL_EXCEPTION (campo booleano),
    • EXCEPTION_DESCRIPTION,
  • Dispositivo móvil
    • IS_MOBILE (campo booleano, obsoleto; utiliza DEVICE_CATEGORY=mobile),
    • IS_TABLET (campo booleano, obsoleto; utiliza 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,
  • Redes sociales
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • SOCIAL_ACTION_TARGET,
 editable
excludeDetails.fieldIndex integer Índice de la dimensión personalizada. Configúrala solo si el campo es CUSTOM_DIMENSION. editable
excludeDetails.matchType string Tipo de concordancia de 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; los demás filtros deben usar MATCHES. editable
includeDetails.caseSensitive boolean Determina si en el filtro se distingue entre mayúsculas y minúsculas. editable
includeDetails.expressionValue string Valor de expresión de filtro. editable
includeDetails.field string Campo que se filtrará. Valores posibles:
  • Contenido y tráfico
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • PAGE_TITLE,
    • REFERRAL,
    • COST_DATA_URI (URL de destino 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,
  • Audiencia/usuarios
    • BROWSER,
    • BROWSER_VERSION,
    • BROWSER_SIZE,
    • PLATFORM,
    • PLATFORM_VERSION,
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_COLORS,
    • JAVA_ENABLED (campo booleano),
    • FLASH_VERSION,
    • GEO_SPEED (velocidad de conexión),
    • VISITOR_TYPE,
    • GEO_ORGANIZATION (organización del ISP),
    • GEO_DOMAIN,
    • GEO_IP_ADDRESS,
    • GEO_IP_VERSION,
  • Ubicación
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CITY,
  • Evento
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL,
  • Otros
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • Aplicación
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (campo booleano),
    • IS_FATAL_EXCEPTION (campo booleano),
    • EXCEPTION_DESCRIPTION,
  • Dispositivo móvil
    • IS_MOBILE (campo booleano, obsoleto; utiliza DEVICE_CATEGORY=mobile),
    • IS_TABLET (campo booleano, obsoleto; utiliza 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,
  • Redes sociales
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • SOCIAL_ACTION_TARGET,
 editable
includeDetails.fieldIndex integer Índice de la dimensión personalizada. Configúrala solo si el campo es CUSTOM_DIMENSION. editable
includeDetails.matchType string Tipo de concordancia de 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; los demás filtros deben usar MATCHES. editable
lowercaseDetails.field string Campo que se utilizará en el filtro. editable
lowercaseDetails.fieldIndex integer Índice de la dimensión personalizada. Es obligatoria si el campo es CUSTOM_DIMENSION. editable
searchAndReplaceDetails.caseSensitive boolean Determina si en el filtro se distingue entre mayúsculas y minúsculas. editable
searchAndReplaceDetails.field string Campo que se utilizará en el filtro. editable
searchAndReplaceDetails.fieldIndex integer Índice de la dimensión personalizada. Es obligatoria si el campo es CUSTOM_DIMENSION. editable
searchAndReplaceDetails.replaceString string Término con el que se reemplazará el término de búsqueda. editable
searchAndReplaceDetails.searchString string Término que se buscará. editable
uppercaseDetails.field string Campo que se utilizará en el filtro. editable
uppercaseDetails.fieldIndex integer Índice de la dimensión personalizada. Es obligatoria si el campo es CUSTOM_DIMENSION. editable

Respuesta

Si se realiza correctamente, este método devuelve 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 de cliente para obtener una lista de los lenguajes admitidos).

Java

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

Utiliza la biblioteca de 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

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

Utiliza la biblioteca de cliente 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ébalo

Utiliza el siguiente explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta. También puedes probar el explorador independiente.