Filters: insert

נדרשת הרשאה

יצירת מסנן חדש. אפשר לנסות עכשיו או לראות דוגמה.

בקשה

בקשת HTTP

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

פרמטרים

שם הפרמטר תמורה לכסף תיאור
פרמטרים של נתיב
accountId string מספר החשבון שעבורו רוצים ליצור מסנן.

אישור

הבקשה הזו מחייבת הרשאה עם ההיקף הבא (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/analytics.edit

גוף הבקשה

בגוף הבקשה, מציינים משאבmanagement.filter עם המאפיינים הבאים:

שם הנכס תמורה לכסף תיאור הערות
המאפיינים הנדרשים
name string שם המסנן הזה. ניתן לכתיבה
type string סוג המסנן הזה. הערכים האפשריים הם: INCLUDE, Exclude, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE ו-ADVANCED. ניתן לכתיבה
מאפיינים אופציונליים
advancedDetails.caseSensitive boolean מציין אם ביטויי הסינון תלויי אותיות רישיות. ניתן לכתיבה
advancedDetails.extractA string ביטוי לחילוץ משדה א'. ניתן לכתיבה
advancedDetails.extractB string ביטוי לחילוץ משדה ב'. ניתן לכתיבה
advancedDetails.fieldA string Field A (שדה א'). ניתן לכתיבה
advancedDetails.fieldAIndex integer האינדקס של המאפיין המותאם אישית. חובה אם השדה הוא CUSTOM_dimension. ניתן לכתיבה
advancedDetails.fieldARequired boolean שדה זה מציין אם שדה א' חייב להיות תואם. ניתן לכתיבה
advancedDetails.fieldB string שדה ב'. ניתן לכתיבה
advancedDetails.fieldBIndex integer האינדקס של המאפיין המותאם אישית. חובה אם השדה הוא CUSTOM_dimension. ניתן לכתיבה
advancedDetails.fieldBRequired boolean התנאי מציין אם שדה ב' חייב להיות תואם. ניתן לכתיבה
advancedDetails.outputConstructor string ביטוי משמש ליצירת ערך הפלט. ניתן לכתיבה
advancedDetails.outputToField string שדה פלט. ניתן לכתיבה
advancedDetails.outputToFieldIndex integer האינדקס של המאפיין המותאם אישית. חובה אם השדה הוא CUSTOM_dimension. ניתן לכתיבה
advancedDetails.overrideOutputField boolean השדה הזה מציין אם ביטוי הפלט צריך לשנות את הערך הקיים של שדה הפלט, אם יש כזה. ניתן לכתיבה
excludeDetails.caseSensitive boolean המדיניות הזו קובעת אם המסנן הוא תלוי אותיות רישיות. ניתן לכתיבה
excludeDetails.expressionValue string ערך של ביטוי סינון ניתן לכתיבה
excludeDetails.field string שדה לסינון. ערכים אפשריים:
  • תוכן ותנועה
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • PAGE_TITLE,
    • הפניה,
    • cost_DATA_URI (כתובת אתר של יעד הקמפיין),
    • HIT_TYPE,
    • INTERNAL_SEARCH_QUERY,
    • INTERNAL_SEARCH_TYPE,
    • SOURCE_PROPERTY_TRACKING_ID,
  • מסע פרסום או קבוצת מודעות
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM,
    • CAMPAIGN_NAME,
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_PERIOD,
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE,
    • CAMPAIGN_REFERRAL_PATH,
  • מסחר אלקטרוני
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (מיקום החנות או ההזמנה),
    • ITEM_NAME,
    • ITEM_CODE,
    • ITEM_VARIATION,
    • TRANSACTION_ID,
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE,
  • קהל/משתמשים
    • BROWSER,
    • BROWSER_VERSION,
    • BROWSER_SIZE,
    • PLATFORM,
    • PLATFORM_VERSION,
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_colorS,
    • JAVA_Enabled (שדה בוליאני),
    • FLASH_VERSION,
    • geo_SPEED (מהירות חיבור),
    • VISITOR_TYPE,
    • geo_Organization (ארגון ספק האינטרנט),
    • geo_DOMAIN,
    • geo_IP_ADDRESS,
    • GEO_IP_VERSION,
  • מיקום
    • geo_COUNTRY,
    • geo_REGION,
    • geo_CITY,
  • אירוע
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL,
    • אחר
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • יישום
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (שדה בוליאני),
    • IS_FATAL_EXCEPTION (שדה בוליאני),
    • EXCEPTION_DESCRIPTION,
  • נייד
    • IS_MOBILE (שדה בוליאני, הוצא משימוש. השתמש ב-DEVICE_CATEGORY=mobile),
    • IS_TABLET (שדה בוליאני, הוצא משימוש. צריך להשתמש ב-DEVICE_CATEGORY=tablet),
    • DEVICE_CATEGORY,
    • MOBILE_HAS_QWERTY_KEYboard (שדה בוליאני),
    • MOBILE_HAS_NFC_Support (שדה בוליאני),
    • MOBILE_HAS_CELLULAR_Radio (שדה בוליאני),
    • MOBILE_HAS_WIFI_Support (שדה בוליאני),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_METHOD,
  • חברתי
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • SOCIAL_ACTION_TARGET,
 ניתן לכתיבה
excludeDetails.fieldIndex integer האינדקס של המאפיין המותאם אישית. יש להגדיר רק אם השדה הוא CUSTOM_attribute. ניתן לכתיבה
excludeDetails.matchType string סוג התאמה למסנן הזה. ערכים אפשריים הם BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS או MATCHES. המסננים GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI או PAGE_HOSTNAME יכולים להשתמש בכל סוג התאמה. כל שאר המסננים חייבים להשתמש ב-MATCHES. ניתן לכתיבה
includeDetails.caseSensitive boolean המדיניות הזו קובעת אם המסנן הוא תלוי אותיות רישיות. ניתן לכתיבה
includeDetails.expressionValue string ערך של ביטוי סינון ניתן לכתיבה
includeDetails.field string שדה לסינון. ערכים אפשריים:
  • תוכן ותנועה
    • PAGE_REQUEST_URI,
    • PAGE_HOSTNAME,
    • PAGE_TITLE,
    • הפניה,
    • cost_DATA_URI (כתובת אתר של יעד הקמפיין),
    • HIT_TYPE,
    • INTERNAL_SEARCH_QUERY,
    • INTERNAL_SEARCH_TYPE,
    • SOURCE_PROPERTY_TRACKING_ID,
  • מסע פרסום או קבוצת מודעות
    • CAMPAIGN_SOURCE,
    • CAMPAIGN_MEDIUM,
    • CAMPAIGN_NAME,
    • CAMPAIGN_AD_GROUP,
    • CAMPAIGN_PERIOD,
    • CAMPAIGN_CONTENT,
    • CAMPAIGN_CODE,
    • CAMPAIGN_REFERRAL_PATH,
  • מסחר אלקטרוני
    • TRANSACTION_COUNTRY,
    • TRANSACTION_REGION,
    • TRANSACTION_CITY,
    • TRANSACTION_AFFILIATION (מיקום החנות או ההזמנה),
    • ITEM_NAME,
    • ITEM_CODE,
    • ITEM_VARIATION,
    • TRANSACTION_ID,
    • TRANSACTION_CURRENCY_CODE,
    • PRODUCT_ACTION_TYPE,
  • קהל/משתמשים
    • BROWSER,
    • BROWSER_VERSION,
    • BROWSER_SIZE,
    • PLATFORM,
    • PLATFORM_VERSION,
    • LANGUAGE,
    • SCREEN_RESOLUTION,
    • SCREEN_colorS,
    • JAVA_Enabled (שדה בוליאני),
    • FLASH_VERSION,
    • geo_SPEED (מהירות חיבור),
    • VISITOR_TYPE,
    • geo_Organization (ארגון ספק האינטרנט),
    • geo_DOMAIN,
    • geo_IP_ADDRESS,
    • GEO_IP_VERSION,
  • מיקום
    • geo_COUNTRY,
    • geo_REGION,
    • geo_CITY,
  • אירוע
    • EVENT_CATEGORY,
    • EVENT_ACTION,
    • EVENT_LABEL,
    • אחר
    • CUSTOM_FIELD_1,
    • CUSTOM_FIELD_2,
    • USER_DEFINED_VALUE,
  • יישום
    • APP_ID,
    • APP_INSTALLER_ID,
    • APP_NAME,
    • APP_VERSION,
    • SCREEN,
    • IS_APP (שדה בוליאני),
    • IS_FATAL_EXCEPTION (שדה בוליאני),
    • EXCEPTION_DESCRIPTION,
  • נייד
    • IS_MOBILE (שדה בוליאני, הוצא משימוש. השתמש ב-DEVICE_CATEGORY=mobile),
    • IS_TABLET (שדה בוליאני, הוצא משימוש. צריך להשתמש ב-DEVICE_CATEGORY=tablet),
    • DEVICE_CATEGORY,
    • MOBILE_HAS_QWERTY_KEYboard (שדה בוליאני),
    • MOBILE_HAS_NFC_Support (שדה בוליאני),
    • MOBILE_HAS_CELLULAR_Radio (שדה בוליאני),
    • MOBILE_HAS_WIFI_Support (שדה בוליאני),
    • MOBILE_BRAND_NAME,
    • MOBILE_MODEL_NAME,
    • MOBILE_MARKETING_NAME,
    • MOBILE_POINTING_METHOD,
  • חברתי
    • SOCIAL_NETWORK,
    • SOCIAL_ACTION,
    • SOCIAL_ACTION_TARGET,
 ניתן לכתיבה
includeDetails.fieldIndex integer האינדקס של המאפיין המותאם אישית. יש להגדיר רק אם השדה הוא CUSTOM_attribute. ניתן לכתיבה
includeDetails.matchType string סוג התאמה למסנן הזה. ערכים אפשריים הם BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS או MATCHES. המסננים GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI או PAGE_HOSTNAME יכולים להשתמש בכל סוג התאמה. כל שאר המסננים חייבים להשתמש ב-MATCHES. ניתן לכתיבה
lowercaseDetails.field string שדה לשימוש במסנן. ניתן לכתיבה
lowercaseDetails.fieldIndex integer האינדקס של המאפיין המותאם אישית. חובה אם השדה הוא CUSTOM_dimension. ניתן לכתיבה
searchAndReplaceDetails.caseSensitive boolean המדיניות הזו קובעת אם המסנן הוא תלוי אותיות רישיות. ניתן לכתיבה
searchAndReplaceDetails.field string שדה לשימוש במסנן. ניתן לכתיבה
searchAndReplaceDetails.fieldIndex integer האינדקס של המאפיין המותאם אישית. חובה אם השדה הוא CUSTOM_dimension. ניתן לכתיבה
searchAndReplaceDetails.replaceString string מונח להחלפת מונח החיפוש. ניתן לכתיבה
searchAndReplaceDetails.searchString string מונח לחיפוש. ניתן לכתיבה
uppercaseDetails.field string שדה לשימוש במסנן. ניתן לכתיבה
uppercaseDetails.fieldIndex integer האינדקס של המאפיין המותאם אישית. חובה אם השדה הוא CUSTOM_dimension. ניתן לכתיבה

תשובה

אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה משאבmanagement.filter בגוף התגובה.

דוגמאות

הערה: דוגמאות הקוד הזמינות לשיטה זו לא מייצגות את כל שפות התכנות הנתמכות (רשימת השפות הנתמכות זמינה בדף של ספריות המשתמשים).

Java

משתמש בספריית הלקוח של 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

משתמש בספריית הלקוח של 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

משתמש בספריית הלקוח של 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

נעשה שימוש בספריית הלקוח של 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. });
}

רוצה לנסות?

צריך להשתמש ב-APIs Explorer שבהמשך כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה. לחלופין, אפשר לנסות את ה-Explorer העצמאי.