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

نص الطلب

في نص الطلب، أضِف موردًا منmanagement.filter بالسمات التالية:

اسم الموقع القيمة الوصف Notes
الخصائص المطلوبة
name string اسم هذا الفلتر قابل للكتابة
type string نوع هذا الفلتر القيم المحتملة هي include وEXCLUDE وLOWERCASE وCASE و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،
    • إحالة
    • 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_VERSION
    • LANGUAGE،
    • SCREEN_RESOLUTION،
    • SCREEN_COLORS،
    • JAVA_optional (الحقل المنطقي)،
    • FLASH_VERSION،
    • GEO_SPEED (سرعة الاتصال)،
    • VISITOR_TYPE،
    • GEO_Organization (مؤسسة مزوّد خدمة الإنترنت)
    • GEO_DOMAIN،
    • GEO_IP_ADDRESS،
    • GEO_IP_VERSION,
  • الموقع
    • GEO_COUNTRY،
    • GEO_AREA،
    • 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_السمات. قابل للكتابة
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_CITY،
    • TRANSACTION_AFFILIATION (المتجر أو الموقع الجغرافي للطلب)،
    • ITEM_NAME،
    • ITEM_CODE،
    • ITEM_VARIATION،
    • TRANSACTION_ID،
    • TRANSACTION_CURRENCY_CODE،
    • PRODUCT_ACTION_TYPE،
  • الجمهور/المستخدمون
    • BROWSER،
    • BROWSER_VERSION,
    • BROWSER_SIZE،
    • المنصة
    • PLATFORM_VERSION
    • LANGUAGE،
    • SCREEN_RESOLUTION،
    • SCREEN_COLORS،
    • JAVA_optional (الحقل المنطقي)،
    • FLASH_VERSION،
    • GEO_SPEED (سرعة الاتصال)،
    • VISITOR_TYPE،
    • GEO_Organization (مؤسسة مزوّد خدمة الإنترنت)
    • GEO_DOMAIN،
    • GEO_IP_ADDRESS،
    • GEO_IP_VERSION,
  • الموقع
    • GEO_COUNTRY،
    • GEO_AREA،
    • 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_السمات. قابل للكتابة
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 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. });
}

تجربة

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