Autorisation requise
Créez un filtre. Essayez maintenant ou consultez un exemple.
Requête
Requête HTTP
POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters
Paramètres
Nom du paramètre | Valeur | Description |
---|---|---|
Paramètres de chemin d'accès | ||
accountId |
string |
ID du compte pour lequel créer le filtre. |
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure le champ d'application suivant (en savoir plus sur le processus d'authentification et d'autorisation).
Champ d'application |
---|
https://www.googleapis.com/auth/analytics.edit |
Corps de la requête
Dans le corps de la requête, indiquez une ressource "management.filter" avec les propriétés suivantes:
Nom de propriété | Valeur | Description | Notes |
---|---|---|---|
Propriétés obligatoires | |||
name |
string |
Nom de ce filtre. | accessible en écriture |
type |
string |
Type de ce filtre. Les valeurs possibles sont INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE et ADVANCED. | accessible en écriture |
Propriétés facultatives | |||
advancedDetails.caseSensitive |
boolean |
Indique si les expressions de filtre sont sensibles à la casse. | accessible en écriture |
advancedDetails.extractA |
string |
Expression à extraire du champ A. | accessible en écriture |
advancedDetails.extractB |
string |
Expression à extraire du champ B. | accessible en écriture |
advancedDetails.fieldA |
string |
Champ A. | accessible en écriture |
advancedDetails.fieldAIndex |
integer |
Index de la dimension personnalisée Obligatoire si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
advancedDetails.fieldARequired |
boolean |
Indique si le champ A doit correspondre. | accessible en écriture |
advancedDetails.fieldB |
string |
Champ B. | accessible en écriture |
advancedDetails.fieldBIndex |
integer |
Index de la dimension personnalisée Obligatoire si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
advancedDetails.fieldBRequired |
boolean |
Indique si le champ B doit correspondre. | accessible en écriture |
advancedDetails.outputConstructor |
string |
Expression utilisée pour construire la valeur de sortie. | accessible en écriture |
advancedDetails.outputToField |
string |
Champ de sortie. | accessible en écriture |
advancedDetails.outputToFieldIndex |
integer |
Index de la dimension personnalisée Obligatoire si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
advancedDetails.overrideOutputField |
boolean |
Indique si la valeur existante du champ de sortie, le cas échéant, doit être remplacée par l'expression de sortie. | accessible en écriture |
excludeDetails.caseSensitive |
boolean |
Détermine si le filtre est sensible à la casse. | accessible en écriture |
excludeDetails.expressionValue |
string |
Valeur de l'expression de filtre | accessible en écriture |
excludeDetails.field |
string |
Champ à filtrer. Valeurs possibles:
|
accessible en écriture |
excludeDetails.fieldIndex |
integer |
Index de la dimension personnalisée N'est défini que si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
excludeDetails.matchType |
string |
Type de correspondance pour ce filtre. Les valeurs possibles sont BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS ou MATCHES . Les filtres GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI ou PAGE_HOSTNAME peuvent utiliser n'importe quel type de correspondance. Tous les autres filtres doivent utiliser MATCHES . |
accessible en écriture |
includeDetails.caseSensitive |
boolean |
Détermine si le filtre est sensible à la casse. | accessible en écriture |
includeDetails.expressionValue |
string |
Valeur de l'expression de filtre | accessible en écriture |
includeDetails.field |
string |
Champ à filtrer. Valeurs possibles:
|
accessible en écriture |
includeDetails.fieldIndex |
integer |
Index de la dimension personnalisée N'est défini que si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
includeDetails.matchType |
string |
Type de correspondance pour ce filtre. Les valeurs possibles sont BEGINS_WITH , EQUAL , ENDS_WITH , CONTAINS ou MATCHES . Les filtres GEO_DOMAIN , GEO_IP_ADDRESS , PAGE_REQUEST_URI ou PAGE_HOSTNAME peuvent utiliser n'importe quel type de correspondance. Tous les autres filtres doivent utiliser MATCHES . |
accessible en écriture |
lowercaseDetails.field |
string |
Champ à utiliser dans le filtre. | accessible en écriture |
lowercaseDetails.fieldIndex |
integer |
Index de la dimension personnalisée Obligatoire si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
searchAndReplaceDetails.caseSensitive |
boolean |
Détermine si le filtre est sensible à la casse. | accessible en écriture |
searchAndReplaceDetails.field |
string |
Champ à utiliser dans le filtre. | accessible en écriture |
searchAndReplaceDetails.fieldIndex |
integer |
Index de la dimension personnalisée Obligatoire si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
searchAndReplaceDetails.replaceString |
string |
Terme par lequel remplacer le terme de recherche. | accessible en écriture |
searchAndReplaceDetails.searchString |
string |
Terme à rechercher. | accessible en écriture |
uppercaseDetails.field |
string |
Champ à utiliser dans le filtre. | accessible en écriture |
uppercaseDetails.fieldIndex |
integer |
Index de la dimension personnalisée Obligatoire si le champ est de type CUSTOM_DIMENSION. | accessible en écriture |
Réponse
Lorsque cette méthode fonctionne, elle renvoie une ressource management.filter dans le corps de la réponse.
Exemples
Remarque : Les langages de programmation compatibles ne figurent pas tous dans les exemples de code présentés pour cette méthode (consultez la page Bibliothèques clientes pour obtenir la liste des langages compatibles).
Java
Utilise la bibliothèque 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
Utilise la bibliothèque 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
Utilise la bibliothèque 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
Utilise la bibliothèque 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. }); }
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse. Vous pouvez également utiliser la version autonome de l'explorateur.