Filtros: insert

Requer autorização

Cria um novo filtro. Faça um teste agora ou veja um exemplo.

Solicitação

Solicitação HTTP

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

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
accountId string ID da conta para a qual criar o filtro.

Autorização

Essa solicitação requer uma autorização com o escopo a seguir (mais informações sobre autenticação e autorização).

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

Corpo da solicitação

No corpo da solicitação, forneça um recurso "management.filter" com estas propriedades:

Nome da propriedade Valor Descrição Observações
Propriedades obrigatórias
name string Nome do filtro. gravável
type string Tipo de filtro. Os valores possíveis são INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE e ADVANCED. gravável
Propriedades opcionais
advancedDetails.caseSensitive boolean Indica se as expressões do filtro diferenciam letras maiúsculas de minúsculas. gravável
advancedDetails.extractA string Expressão a ser extraída do campo A. gravável
advancedDetails.extractB string Expressão a ser extraída do campo B. gravável
advancedDetails.fieldA string Campo A. gravável
advancedDetails.fieldAIndex integer O índice da dimensão personalizada. Obrigatório se o campo for CUSTOM_DIMENSION. gravável
advancedDetails.fieldARequired boolean Indica se é obrigatório haver correspondência com o campo A. gravável
advancedDetails.fieldB string Campo B. gravável
advancedDetails.fieldBIndex integer O índice da dimensão personalizada. Obrigatório se o campo for CUSTOM_DIMENSION. gravável
advancedDetails.fieldBRequired boolean Indica se é obrigatório haver correspondência com o campo B. gravável
advancedDetails.outputConstructor string Expressão usada para gerar o valor de saída. gravável
advancedDetails.outputToField string Campo de saída. gravável
advancedDetails.outputToFieldIndex integer O índice da dimensão personalizada. Obrigatório se o campo for CUSTOM_DIMENSION. gravável
advancedDetails.overrideOutputField boolean Indica se o valor existente do campo de saída, se aplicável, deve ser substituído pela expressão de saída. gravável
excludeDetails.caseSensitive boolean Determina se o filtro diferencia letras maiúsculas e minúsculas. gravável
excludeDetails.expressionValue string Valor da expressão do filtro gravável
excludeDetails.field string Campo a ser filtrado. Valores possíveis:
  • Conteúdo e tráfego
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • PAGE_TITLE,
    • REFERRAL,
    • COST_DATA_URI (URL de destino da campanha),
    • HIT_TYPE,
    • INTERNAL_SEARCH_TERM,
    • INTERNAL_SEARCH_TYPE,
    • SOURCE_PROPERTY_TRACKING_ID,
  • Campanha ou grupo de anúncios
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM,
    • CAMPAIGN_NAME,
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_TERM,
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE,
    • CAMPAIGN_REFERRAL_PATH,
  • Comércio eletrônico
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (loja ou local do pedido),
    • ITEM_NAME,
    • ITEM_CODE,
    • ITEM_VARIATION,
    • TRANSACTION_ID,
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE,
  • Público/usuários
    • BROWSER,
    • BROWSER_VERSION,
    • BROWSER_SIZE,
    • PLATFORM,
    • PLATFORM_VERSION,
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_COLORS,
    • JAVA_ENABLED (campo Boolean),
    • FLASH_VERSION,
    • GEO_SPEED (velocidade de conexão),
    • VISITOR_TYPE,
    • GEO_ORGANIZATION (organização de ISP),
    • GEO_DOMAIN,
    • GEO_IP_ADDRESS,
    • GEO_IP_VERSION,
  • Local
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CITY,
  • Evento
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL,
  • Outros
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • Aplicativo
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (campo Boolean),
    • IS_FATAL_EXCEPTION (campo Boolean),
    • EXCEPTION_DESCRIPTION,
  • Dispositivo móvel
    • IS_MOBILE (campo Boolean, desativado. Use DEVICE_CATEGORY=mobile),
    • IS_TABLET (campo Boolean, desativado. Use DEVICE_CATEGORY=tablet),
    • DEVICE_CATEGORY,
    • MOBILE_HAS_QWERTY_KEYBOARD (campo Boolean),
    • MOBILE_HAS_NFC_SUPPORT (campo Boolean),
    • MOBILE_HAS_CELLULAR_RADIO (campo Boolean),
    • MOBILE_HAS_WIFI_SUPPORT (campo Boolean),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_METHOD,
  • Rede social
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • SOCIAL_ACTION_TARGET,
 gravável
excludeDetails.fieldIndex integer O índice da dimensão personalizada. Defina somente se o campo for CUSTOM_DIMENSION. gravável
excludeDetails.matchType string Tipo de correspondência para o filtro. Os possíveis valores são BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS ou MATCHES. Os filtros GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI ou PAGE_HOSTNAME podem usar qualquer tipo de correspondência. Todos os outros filtros precisam usar MATCHES. gravável
includeDetails.caseSensitive boolean Determina se o filtro diferencia letras maiúsculas e minúsculas. gravável
includeDetails.expressionValue string Valor da expressão do filtro gravável
includeDetails.field string Campo a ser filtrado. Valores possíveis:
  • Conteúdo e tráfego
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • PAGE_TITLE,
    • REFERRAL,
    • COST_DATA_URI (URL de destino da campanha),
    • HIT_TYPE,
    • INTERNAL_SEARCH_TERM,
    • INTERNAL_SEARCH_TYPE,
    • SOURCE_PROPERTY_TRACKING_ID,
  • Campanha ou grupo de anúncios
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM,
    • CAMPAIGN_NAME,
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_TERM,
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE,
    • CAMPAIGN_REFERRAL_PATH,
  • Comércio eletrônico
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (loja ou local do pedido),
    • ITEM_NAME,
    • ITEM_CODE,
    • ITEM_VARIATION,
    • TRANSACTION_ID,
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE,
  • Público/usuários
    • BROWSER,
    • BROWSER_VERSION,
    • BROWSER_SIZE,
    • PLATFORM,
    • PLATFORM_VERSION,
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_COLORS,
    • JAVA_ENABLED (campo Boolean),
    • FLASH_VERSION,
    • GEO_SPEED (velocidade de conexão),
    • VISITOR_TYPE,
    • GEO_ORGANIZATION (organização de ISP),
    • GEO_DOMAIN,
    • GEO_IP_ADDRESS,
    • GEO_IP_VERSION,
  • Local
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CITY,
  • Evento
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL,
  • Outros
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • Aplicativo
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (campo Boolean),
    • IS_FATAL_EXCEPTION (campo Boolean),
    • EXCEPTION_DESCRIPTION,
  • Dispositivo móvel
    • IS_MOBILE (campo Boolean, desativado. Use DEVICE_CATEGORY=mobile),
    • IS_TABLET (campo Boolean, desativado. Use DEVICE_CATEGORY=tablet),
    • DEVICE_CATEGORY,
    • MOBILE_HAS_QWERTY_KEYBOARD (campo Boolean),
    • MOBILE_HAS_NFC_SUPPORT (campo Boolean),
    • MOBILE_HAS_CELLULAR_RADIO (campo Boolean),
    • MOBILE_HAS_WIFI_SUPPORT (campo Boolean),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_METHOD,
  • Rede social
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • SOCIAL_ACTION_TARGET,
 gravável
includeDetails.fieldIndex integer O índice da dimensão personalizada. Defina somente se o campo for CUSTOM_DIMENSION. gravável
includeDetails.matchType string Tipo de correspondência para o filtro. Os possíveis valores são BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS ou MATCHES. Os filtros GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI ou PAGE_HOSTNAME podem usar qualquer tipo de correspondência. Todos os outros filtros precisam usar MATCHES. gravável
lowercaseDetails.field string O campo a ser usado no filtro. gravável
lowercaseDetails.fieldIndex integer O índice da dimensão personalizada. Obrigatório se o campo for CUSTOM_DIMENSION. gravável
searchAndReplaceDetails.caseSensitive boolean Determina se o filtro diferencia letras maiúsculas e minúsculas. gravável
searchAndReplaceDetails.field string O campo a ser usado no filtro. gravável
searchAndReplaceDetails.fieldIndex integer O índice da dimensão personalizada. Obrigatório se o campo for CUSTOM_DIMENSION. gravável
searchAndReplaceDetails.replaceString string Termo que substituirá o termo de pesquisa. gravável
searchAndReplaceDetails.searchString string Termo a ser pesquisado. gravável
uppercaseDetails.field string O campo a ser usado no filtro. gravável
uppercaseDetails.fieldIndex integer O índice da dimensão personalizada. Obrigatório se o campo for CUSTOM_DIMENSION. gravável

Resposta

Se for bem-sucedido, esse método retornará um recurso "management.filter" no corpo da resposta.

Exemplos

Observação: os exemplos de código disponíveis para esse método não representam todas as linguagens de programação compatíveis. Consulte a página de bibliotecas cliente para ver uma lista de linguagens compatíveis.

Java

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

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta. Se você preferir, teste o Explorador independente.