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 بالسمات التالية:

اسم الموقع القيمة الوصف Notes
الخصائص المطلوبة
name string اسم هذا الفلتر قابل للكتابة
type string أدخِل هذا الفلتر. القيم المحتملة هي INCLUDE وEXCLUDE وLOWERCASE وتعلُّم أحرف SEARCH_AND_REPLACE وADVANCED. قابل للكتابة
السمات الاختيارية
advancedDetails.caseSensitive boolean يشير إلى ما إذا كانت تعبيرات الفلاتر حساسة لحالة الأحرف. قابل للكتابة
advancedDetails.extractA string التعبير المطلوب استخراجه من الحقل "أ". قابل للكتابة
advancedDetails.extractB string التعبير المطلوب استخراجه من الحقل "ب". قابل للكتابة
advancedDetails.fieldA string الحقل "أ". قابل للكتابة
advancedDetails.fieldAIndex integer فهرس السمة المخصّصة. يجب ملء هذا الحقل إذا كان الحقل CUSTOM_ بما في ذلك. قابل للكتابة
advancedDetails.fieldARequired boolean يشير إلى ما إذا كان الحقل A مطلوبًا للمطابقة. قابل للكتابة
advancedDetails.fieldB string الحقل "ب". قابل للكتابة
advancedDetails.fieldBIndex integer فهرس السمة المخصّصة. يجب ملء هذا الحقل إذا كان الحقل CUSTOM_ بما في ذلك. قابل للكتابة
advancedDetails.fieldBRequired boolean يشير إلى ما إذا كان الحقل "ب" مطلوبًا للمطابقة. قابل للكتابة
advancedDetails.outputConstructor string التعبير المستخدم لإنشاء قيمة المخرجات. قابل للكتابة
advancedDetails.outputToField string حقل الإخراج. قابل للكتابة
advancedDetails.outputToFieldIndex integer فهرس السمة المخصّصة. يجب ملء هذا الحقل إذا كان الحقل CUSTOM_ بما في ذلك. قابل للكتابة
advancedDetails.overrideOutputField boolean يشير إلى ما إذا كان يجب تجاوز القيمة الحالية لحقل الإخراج، إن وجدت، باستخدام تعبير الإخراج. قابل للكتابة
excludeDetails.caseSensitive boolean تحدِّد هذه السياسة ما إذا كان الفلتر حسّاسًا لحالة الأحرف. قابل للكتابة
excludeDetails.expressionValue string قيمة تعبير الفلتر قابل للكتابة
excludeDetails.field string حقل للفلترة. القيم المتاحة:
  • المحتوى والزيارات
    • PAGE_REQUEST_URI،
    • PAGE_HOSTNAME،
    • PAGE_TITLE،
    • REFERRAL،
    • cost_DATA_URI (عنوان URL لاستهداف الحملة)،
    • HIT_TYPE،
    • INTERNAL_SEARCH_TERM،
    • INTERNAL_SEARCH_TYPE،
    • SOURCE_PROPERTY_TRACKING_ID,
  • الحملة أو المجموعة الإعلانية
    • CAMPAIGN_SOURCE،
    • CAMPAIGN_MEDIUM،
    • CAMPAIGN_NAME،
    • CAMPAIGN_AD_GROUP،
    • CAMPAIGN_TERM،
    • 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_Enable (الحقل المنطقي)،
    • FLASH_VERSION،
    • geo_SPEED (سرعة الاتصال)،
    • VISITOR_TYPE،
    • geo_Organization (مؤسسة مزوّد خدمة الإنترنت)
    • Geo_DOMAIN،
    • KPI_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_ يفعل (الحقل المنطقي)،
    • 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_dimension. قابل للكتابة
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،
    • REFERRAL،
    • cost_DATA_URI (عنوان URL لاستهداف الحملة)،
    • HIT_TYPE،
    • INTERNAL_SEARCH_TERM،
    • INTERNAL_SEARCH_TYPE،
    • SOURCE_PROPERTY_TRACKING_ID,
  • الحملة أو المجموعة الإعلانية
    • CAMPAIGN_SOURCE،
    • CAMPAIGN_MEDIUM،
    • CAMPAIGN_NAME،
    • CAMPAIGN_AD_GROUP،
    • CAMPAIGN_TERM،
    • 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_Enable (الحقل المنطقي)،
    • FLASH_VERSION،
    • geo_SPEED (سرعة الاتصال)،
    • VISITOR_TYPE،
    • geo_Organization (مؤسسة مزوّد خدمة الإنترنت)
    • Geo_DOMAIN،
    • KPI_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_ يفعل (الحقل المنطقي)،
    • 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_dimension. قابل للكتابة
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_ بما في ذلك. قابل للكتابة
searchAndReplaceDetails.caseSensitive boolean تحدِّد هذه السياسة ما إذا كان الفلتر حسّاسًا لحالة الأحرف. قابل للكتابة
searchAndReplaceDetails.field string الحقل المطلوب استخدامه في الفلتر قابل للكتابة
searchAndReplaceDetails.fieldIndex integer فهرس السمة المخصّصة. يجب ملء هذا الحقل إذا كان الحقل CUSTOM_ بما في ذلك. قابل للكتابة
searchAndReplaceDetails.replaceString string العبارة المطلوب استبدال عبارة البحث بها. قابل للكتابة
searchAndReplaceDetails.searchString string عبارة البحث. قابل للكتابة
uppercaseDetails.field string الحقل المطلوب استخدامه في الفلتر قابل للكتابة
uppercaseDetails.fieldIndex integer فهرس السمة المخصّصة. يجب ملء هذا الحقل إذا كان الحقل CUSTOM_ بما في ذلك. قابل للكتابة

الإجابة

في حال نجاحها، تعرض هذه الطريقة مورد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. });
}

تجربة

استخدِم مستكشف واجهات برمجة التطبيقات أدناه لطلب هذه الطريقة على البيانات المباشرة والاطّلاع على الردّ. ويمكنك بدلاً من ذلك تجربة المستكشف المستقل.