Filters: insert

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.

L'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:
  • Contenu et trafic
    • PAGE_REQUEST_URI,
    • "PAGE_HOSTNAME",
    • "PAGE_TITLE",
    • PARRAINAGE,
    • COST_DATA_URI (URL de la cible de la campagne),
    • HIT_TYPE
    • INTERNAL_SEARCH_TERM,
    • INTERNAL_SEARCH_TYPE
    • SOURCE_PROPERTY_TRACKING_ID,
  • Campagne ou groupe d'annonces
    • CAMPAIGN_SOURCE,
    • CAMPAGNE_MOYENNE,
    • "CAMPAIGN_NAME",
    • "CAMPAIGN_AD_GROUP",
    • CAMPAIGN_TERM,
    • "CAMPAIGN_CONTENT",
    • "CAMPAIGN_CODE",
    • "CAMPAIGN_REFERRAL_PATH",
  • E-commerce
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (magasin ou adresse de commande),
    • "ITEM_NAME",
    • ITEM_CODE
    • "ITEM_VARIATION",
    • TRANSACTION_ID
    • TRANSACTION_CURRENCY_CODE,
    • "PRODUCT_ACTION_TYPE",
  • Audience/Utilisateurs
    • NAVIGATEUR,
    • BROWSER_VERSION,
    • BROWSER_SIZE
    • PLATFORM
    • PLATFORM_VERSION
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_COLORS,
    • JAVA_ENABLED (champ booléen),
    • FLASH_VERSION,
    • GEO_SPEED (vitesse de connexion),
    • "VISITOR_TYPE"
    • GEO_ORGANIZATION (FAI),
    • "GEO_DOMAIN",
    • GEO_IP_ADDRESS,
    • GEO_IP_VERSION,
  • Lieu
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CITY,
  • Événement
    • EVENT_CATEGORY
    • EVENT_ACTION
    • EVENT_LABEL,
  • Autre
    • PERSONNALISÉ_FIELD_1,
    • PERSONNALISÉ_FIELD_2,
    • USER_DEFINED_VALUE,
  • Application
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (champ booléen),
    • IS_FATAL_EXCEPTION (champ booléen),
    • EXCEPTION_DESCRIPTION,
  • Appareil mobile <ph type="x-smartling-placeholder">
      </ph>
    • IS_MOBILE (Champ booléen, obsolète. Utiliser DEVICE_CATEGORY=mobile),
    • IS_TABLET (Champ booléen, obsolète. utiliser DEVICE_CATEGORY=tablette),
    • DEVICE_CATEGORY
    • MOBILE_HAS_QWERTY_KEYBOARD (champ booléen),
    • MOBILE_HAS_NFC_SUPPORT (champ booléen),
    • MOBILE_HAS_CELLULAR_RADIO (champ booléen),
    • MOBILE_HAS_WIFI_SUPPORT (champ booléen),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_method,
  • Réseaux sociaux :
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • "SOCIAL_ACTION_TARGET",
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:
  • Contenu et trafic
    • PAGE_REQUEST_URI,
    • "PAGE_HOSTNAME",
    • "PAGE_TITLE",
    • PARRAINAGE,
    • COST_DATA_URI (URL de la cible de la campagne),
    • HIT_TYPE
    • INTERNAL_SEARCH_TERM,
    • INTERNAL_SEARCH_TYPE
    • SOURCE_PROPERTY_TRACKING_ID,
  • Campagne ou groupe d'annonces
    • CAMPAIGN_SOURCE,
    • CAMPAGNE_MOYENNE,
    • "CAMPAIGN_NAME",
    • "CAMPAIGN_AD_GROUP",
    • CAMPAIGN_TERM,
    • "CAMPAIGN_CONTENT",
    • "CAMPAIGN_CODE",
    • "CAMPAIGN_REFERRAL_PATH",
  • E-commerce
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (magasin ou adresse de commande),
    • "ITEM_NAME",
    • ITEM_CODE
    • "ITEM_VARIATION",
    • TRANSACTION_ID
    • TRANSACTION_CURRENCY_CODE,
    • "PRODUCT_ACTION_TYPE",
  • Audience/Utilisateurs
    • NAVIGATEUR,
    • BROWSER_VERSION,
    • BROWSER_SIZE
    • PLATFORM
    • PLATFORM_VERSION
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_COLORS,
    • JAVA_ENABLED (champ booléen),
    • FLASH_VERSION,
    • GEO_SPEED (vitesse de connexion),
    • "VISITOR_TYPE"
    • GEO_ORGANIZATION (FAI),
    • "GEO_DOMAIN",
    • GEO_IP_ADDRESS,
    • GEO_IP_VERSION,
  • Lieu
    • GEO_COUNTRY,
    • GEO_REGION,
    • GEO_CITY,
  • Événement
    • EVENT_CATEGORY
    • EVENT_ACTION
    • EVENT_LABEL,
  • Autre
    • PERSONNALISÉ_FIELD_1,
    • PERSONNALISÉ_FIELD_2,
    • USER_DEFINED_VALUE,
  • Application
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (champ booléen),
    • IS_FATAL_EXCEPTION (champ booléen),
    • EXCEPTION_DESCRIPTION,
  • Appareil mobile <ph type="x-smartling-placeholder">
      </ph>
    • IS_MOBILE (Champ booléen, obsolète. Utiliser DEVICE_CATEGORY=mobile),
    • IS_TABLET (Champ booléen, obsolète. utiliser DEVICE_CATEGORY=tablette),
    • DEVICE_CATEGORY
    • MOBILE_HAS_QWERTY_KEYBOARD (champ booléen),
    • MOBILE_HAS_NFC_SUPPORT (champ booléen),
    • MOBILE_HAS_CELLULAR_RADIO (champ booléen),
    • MOBILE_HAS_WIFI_SUPPORT (champ booléen),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_method,
  • Réseaux sociaux :
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • "SOCIAL_ACTION_TARGET",
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.