Filters

A coleção "Filtros" é um conjunto de recursos "Filtrar", cada um dos quais descreve um filtro que pode ser aplicado a uma vista (perfil).

Para ver uma lista de métodos desse recurso, vá até o final desta página.

Representações do recurso

Modelo JSON para um filtro de conta do Google Analytics.

{
  "id": string,
  "kind": "analytics#filter",
  "selfLink": string,
  "accountId": string,
  "name": string,
  "type": string,
  "created": datetime,
  "updated": datetime,
  "parentLink": {
    "type": "analytics#account",
    "href": string
  },
  "includeDetails": {
    "kind": "analytics#filterExpression",
    "field": string,
    "matchType": string,
    "expressionValue": string,
    "caseSensitive": boolean,
    "fieldIndex": integer
  },
  "excludeDetails": {
    "kind": "analytics#filterExpression",
    "field": string,
    "matchType": string,
    "expressionValue": string,
    "caseSensitive": boolean,
    "fieldIndex": integer
  },
  "lowercaseDetails": {
    "field": string,
    "fieldIndex": integer
  },
  "uppercaseDetails": {
    "field": string,
    "fieldIndex": integer
  },
  "searchAndReplaceDetails": {
    "field": string,
    "fieldIndex": integer,
    "searchString": string,
    "replaceString": string,
    "caseSensitive": boolean
  },
  "advancedDetails": {
    "fieldA": string,
    "fieldAIndex": integer,
    "extractA": string,
    "fieldB": string,
    "fieldBIndex": integer,
    "extractB": string,
    "outputToField": string,
    "outputToFieldIndex": integer,
    "outputConstructor": string,
    "fieldARequired": boolean,
    "fieldBRequired": boolean,
    "overrideOutputField": boolean,
    "caseSensitive": boolean
  }
}

Nome da propriedade	Valor	Descrição	Observações
`accountId`	`string`	ID da conta à qual esse filtro pertence.
`advancedDetails`	`object`	Detalhes do filtro do tipo ADVANCED.
`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
`created`	`datetime`	Horário de criação desse filtro.
`excludeDetails`	`nested object`	Detalhes do filtro do tipo EXCLUDE.
`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-alvo/usuários BROWSER, BROWSER_VERSION, BROWSER_SIZE, PLATFORM, PLATFORM_VERSION, LANGUAGE, SCREEN_RESOLUTION, SCREEN_COLORS, JAVA_enabled (campo booleano), 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, Outro CUSTOM_FIELD_1, CUSTOM_FIELD_2, USER_DEFINED_VALUE, Aplicativo APP_ID, APP_INSTALLER_ID, APP_NAME, APP_VERSION, SCREEN, IS_APP (campo booleano), IS_FATAL_EXCEPTION (campo booleano), EXCEPTION_DESCRIPTION, Dispositivo móvel IS_MOBILE (campo booleano, uso suspenso. Use DEVICE_CATEGORY=mobile), IS_TABLET (campo booleano, descontinuado. Use 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,	gravável
`excludeDetails.fieldIndex`	`integer`	O índice da dimensão personalizada. Defina apenas se o campo for CUSTOM_DIMENSION.	gravável
`excludeDetails.kind`	`string`	Valor de tipo de expressão de filtro
`excludeDetails.matchType`	`string`	Tipo de correspondência para o filtro. Os valores possíveis 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
`id`	`string`	ID do filtro.
`includeDetails`	`nested object`	Detalhes do filtro do tipo INCLUDE.
`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-alvo/usuários BROWSER, BROWSER_VERSION, BROWSER_SIZE, PLATFORM, PLATFORM_VERSION, LANGUAGE, SCREEN_RESOLUTION, SCREEN_COLORS, JAVA_enabled (campo booleano), 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, Outro CUSTOM_FIELD_1, CUSTOM_FIELD_2, USER_DEFINED_VALUE, Aplicativo APP_ID, APP_INSTALLER_ID, APP_NAME, APP_VERSION, SCREEN, IS_APP (campo booleano), IS_FATAL_EXCEPTION (campo booleano), EXCEPTION_DESCRIPTION, Dispositivo móvel IS_MOBILE (campo booleano, uso suspenso. Use DEVICE_CATEGORY=mobile), IS_TABLET (campo booleano, descontinuado. Use 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,	gravável
`includeDetails.fieldIndex`	`integer`	O índice da dimensão personalizada. Defina apenas se o campo for CUSTOM_DIMENSION.	gravável
`includeDetails.kind`	`string`	Valor de tipo de expressão de filtro
`includeDetails.matchType`	`string`	Tipo de correspondência para o filtro. Os valores possíveis 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
`kind`	`string`	Tipo de recurso para filtro do Google Analytics.
`lowercaseDetails`	`object`	Detalhes do filtro do tipo LOWER.
`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
`name`	`string`	Nome do filtro.	gravável
`parentLink`	`object`	Link pai para esse filtro. Aponta para a conta à qual pertence esse filtro.
`parentLink.href`	`string`	Link para a conta à qual pertence esse filtro.
`parentLink.type`	`string`	O valor é "analytics#account".
`searchAndReplaceDetails`	`object`	Detalhes do filtro do tipo SEARCH_AND_REPLACE.
`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
`selfLink`	`string`	Link para esse filtro.
`type`	`string`	Tipo de filtro. Os valores possíveis são INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE e ADVANCED.	gravável
`updated`	`datetime`	Horário da última modificação do filtro.
`uppercaseDetails`	`object`	Detalhes do filtro do tipo UPPER.
`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

Métodos

excluir: Excluir um filtro.
get: Retorna um filtro aos quais o usuário tem acesso.
inserir: Crie um novo filtro.
list: Lista todos os filtros de uma conta
patch: Atualiza um filtro existente. Esse método é compatível com a semântica de patch.
update: Atualiza um filtro existente.