Requiere autorización
Actualiza un filtro existente. Pruébalo ahora y ve un ejemplo.
Solicitud
Solicitud HTTP
PUT https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters/filterId
Parámetros
Nombre del parámetro | Valor | Descripción |
---|---|---|
Parámetros de ruta de acceso | ||
accountId |
string |
ID de la cuenta a la que pertenece el filtro |
filterId |
string |
ID del filtro que se actualizará. |
Autorización
Esta solicitud requiere autorización con el siguiente alcance (obtén 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 |
Es el nombre de este filtro. | admite escritura |
type |
string |
Es el 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 |
El índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. | admite escritura |
advancedDetails.fieldARequired |
boolean |
Indica si debe coincidir el campo A. | admite escritura |
advancedDetails.fieldB |
string |
Campo B. | admite escritura |
advancedDetails.fieldBIndex |
integer |
El índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. | admite escritura |
advancedDetails.fieldBRequired |
boolean |
Indica si se requiere que el campo B coincida. | 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 |
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 salida, si existe. | admite escritura |
excludeDetails.caseSensitive |
boolean |
Determina si el filtro distingue mayúsculas de minúsculas. | admite escritura |
excludeDetails.expressionValue |
string |
Valor de la expresión de filtro | admite escritura |
excludeDetails.field |
string |
Campo que se filtrará. Valores posibles:
|
admite escritura |
excludeDetails.fieldIndex |
integer |
El índice de la dimensión personalizada. Se establece solo si el campo es CUSTOM_DIMENSION. | admite escritura |
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; 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 la expresión de filtro | admite escritura |
includeDetails.field |
string |
Campo que se filtrará. Valores posibles:
|
admite escritura |
includeDetails.fieldIndex |
integer |
El índice de la dimensión personalizada. Se establece solo si el campo es CUSTOM_DIMENSION. | admite escritura |
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; todos los demás filtros deben usar MATCHES . |
admite escritura |
lowercaseDetails.field |
string |
Es el campo que se usará en el filtro. | admite escritura |
lowercaseDetails.fieldIndex |
integer |
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 |
Es el campo que se usará en el filtro. | admite escritura |
searchAndReplaceDetails.fieldIndex |
integer |
El índice de la dimensión personalizada. Obligatorio si el campo es CUSTOM_DIMENSION. | admite escritura |
searchAndReplaceDetails.replaceString |
string |
Término con el que se reemplazará el término de búsqueda. | admite escritura |
searchAndReplaceDetails.searchString |
string |
Término para buscar. | admite escritura |
uppercaseDetails.field |
string |
Es el campo que se usará en el filtro. | admite escritura |
uppercaseDetails.fieldIndex |
integer |
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 updates an existing 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().update("123456", "1223334444", body).execute(); } catch (GoogleJsonResponseException e) { System.err.println("There was a service error: " + e.getDetails().getCode() + " : " + e.getDetails().getMessage()); }
PHP
Utiliza la biblioteca cliente PHP.
/** * Note: This code assumes you have an authorized Analytics service object. * See the Filters Developer Guide for details. */ /** * This request updates an existing 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->setId('7654321'); $filter->setExcludeDetails($details); $analytics->management_filters->update('123456', '7654321', $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 updates an existing filter. try: analytics.management().filters().update( accountId='123456', filterId='1223334444', 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 updates an existing filter. */ function updateFilter() { var request = gapi.client.analytics.management.filters.update( { 'accountId': '123456', 'filterId': '1223334444', 'resource': { 'id': '1223334444', '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
Usa el Explorador de APIs que aparece a continuación para llamar a este método con los datos en tiempo real y ver la respuesta. También puedes probar el Explorador independiente.