Filters: update

مطلوب تفويض

تعديل فلتر حالي جرِّب ذلك الآن أو اطّلِع على مثال.

طلب

طلب HTTP

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

المَعلمات

اسم المعلَمة القيمة الوصف
معلّمات المسار
accountId string رقم تعريف الحساب الذي ينتمي إليه الفلتر.
filterId string رقم تعريف الفلتر الذي سيتم تعديله

التفويض

ويتطلب هذا الطلب الحصول على تفويض من النطاق التالي (مزيد من المعلومات حول المصادقة والتفويض).

النطاق
https://www.googleapis.com/auth/analytics.edit

نص الطلب

في نص الطلب، قدِّم مورد فلتر الإدارة مع السمات التالية:

اسم الموقع القيمة الوصف ملاحظات
السمات المطلوبة
name string اسم هذا الفلتر. قابل للكتابة
type string نوع هذا الفلتر القيم الممكنة هي INCLUDE وEXCLUDE وLOWERCASE وfCASE وSEARCH_AND_REPLACE وADVANCED. قابل للكتابة
السمات الاختيارية
advancedDetails.caseSensitive boolean تشير هذه الخاصية إلى ما إذا كانت تعبيرات الفلاتر حساسة لحالة الأحرف. قابل للكتابة
advancedDetails.extractA string التعبير المطلوب استخراجه من الحقل "أ". قابل للكتابة
advancedDetails.extractB string التعبير المطلوب استخراجه من الحقل "ب". قابل للكتابة
advancedDetails.fieldA string الحقل (أ) قابل للكتابة
advancedDetails.fieldAIndex integer فهرس البُعد المخصّص. مطلوبة إذا كان الحقل "المكوّن المخصّص". قابل للكتابة
advancedDetails.fieldARequired boolean تشير إلى ما إذا كان الحقل "أ" مطلوبًا للمطابقة. قابل للكتابة
advancedDetails.fieldB string الحقل (ب). قابل للكتابة
advancedDetails.fieldBIndex integer فهرس البُعد المخصّص. مطلوبة إذا كان الحقل "المكوّن المخصّص". قابل للكتابة
advancedDetails.fieldBRequired boolean تشير إلى ما إذا كان الحقل "ب" مطلوبًا للمطابقة أم لا. قابل للكتابة
advancedDetails.outputConstructor string التعبير المستخدَم لإنشاء قيمة الناتج. قابل للكتابة
advancedDetails.outputToField string حقل الناتج قابل للكتابة
advancedDetails.outputToFieldIndex integer فهرس البُعد المخصّص. مطلوبة إذا كان الحقل "المكوّن المخصّص". قابل للكتابة
advancedDetails.overrideOutputField boolean تشير هذه السمة إلى ما إذا كان يجب إلغاء القيمة الحالية لحقل الناتج، إن توفّرت، من خلال التعبير الناتج. قابل للكتابة
excludeDetails.caseSensitive boolean يتم تحديد ما إذا كان الفلتر حسّاسًا لحالة الأحرف. قابل للكتابة
excludeDetails.expressionValue string فلترة قيمة التعبير قابل للكتابة
excludeDetails.field string حقل للفلترة. القيم المتاحة:
  • المحتوى وعدد الزيارات
    • PAGE_REQUEST_URI،
    • PAGE_HOSTNAME،
    • PAGE_TITLE،
    • إحالة
    • 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_ITY،
    • TRANSACTION_AFFILIATION (الموقع الجغرافي للمتجر أو الطلب)
    • ITEM_NAME،
    • ITEM_CODE،
    • ITEM_VARIATION،
    • TRANSACTION_ID،
    • TRANSACTION_CURRENCY_CODE،
    • PRODUCT_ACTION_TYPE،
  • الجمهور/المستخدمون
    • متصفّح
    • BROWSER_Version،
    • BROWSER_SIZE،
    • النظام الأساسي
    • PLATFORM_Version
    • اللغة،
    • SCREEN_RESOLUTION،
    • SCREEN_COLORS،
    • JAVA_ENABLED (حقل منطقي)،
    • FLASH_DESCRIPTION،
    • 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_DESCRIPTION،
    • الشاشة،
    • 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_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،
    • إحالة
    • 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_ITY،
    • TRANSACTION_AFFILIATION (الموقع الجغرافي للمتجر أو الطلب)
    • ITEM_NAME،
    • ITEM_CODE،
    • ITEM_VARIATION،
    • TRANSACTION_ID،
    • TRANSACTION_CURRENCY_CODE،
    • PRODUCT_ACTION_TYPE،
  • الجمهور/المستخدمون
    • متصفّح
    • BROWSER_Version،
    • BROWSER_SIZE،
    • النظام الأساسي
    • PLATFORM_Version
    • اللغة،
    • SCREEN_RESOLUTION،
    • SCREEN_COLORS،
    • JAVA_ENABLED (حقل منطقي)،
    • FLASH_DESCRIPTION،
    • 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_DESCRIPTION،
    • الشاشة،
    • 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_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 فهرس البُعد المخصّص. مطلوبة إذا كان الحقل "المكوّن المخصّص". قابل للكتابة
searchAndReplaceDetails.caseSensitive boolean يتم تحديد ما إذا كان الفلتر حسّاسًا لحالة الأحرف. قابل للكتابة
searchAndReplaceDetails.field string حقل لاستخدامه في الفلتر. قابل للكتابة
searchAndReplaceDetails.fieldIndex integer فهرس البُعد المخصّص. مطلوبة إذا كان الحقل "المكوّن المخصّص". قابل للكتابة
searchAndReplaceDetails.replaceString string العبارة المطلوب استخدامها بدلاً من عبارة البحث. قابل للكتابة
searchAndReplaceDetails.searchString string مصطلح البحث. قابل للكتابة
uppercaseDetails.field string حقل لاستخدامه في الفلتر. قابل للكتابة
uppercaseDetails.fieldIndex integer فهرس البُعد المخصّص. مطلوبة إذا كان الحقل "المكوّن المخصّص". قابل للكتابة

الإجابة

وإذا نجحت، ستعرض هذه الطريقة مورد فلتر الإدارة في نص الاستجابة.

أمثلة

ملاحظة: إنّ الأمثلة المرتبطة بالرموز والمتوفرة لهذه الطريقة لا تمثّل كل لغات البرمجة المتوافقة (يُرجى مراجعة صفحة مكتبات البرامج للاطّلاع على قائمة باللغات المتوافقة).

Java

يستخدم مكتبة برامج 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

استخدام مكتبة برامج 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

استخدام مكتبة برامج 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

استخدام مكتبة عميل 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. });
}

جرِّب هذه الميزة الآن.

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