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 با ویژگی های زیر ارائه کنید:

نام ملک ارزش شرح یادداشت
خواص مورد نیاز
name string نام این فیلتر قابل نوشتن
type string نوع این فیلتر مقادیر ممکن عبارتند از: INCLUDE، EXCLUDE، LOWERCASE، UPPERCASE، SEARCH_AND_REPLACE و ADVANCED. قابل نوشتن
ویژگی های اختیاری
advancedDetails. caseSensitive boolean نشان می دهد که آیا عبارات فیلتر به حروف بزرگ و کوچک حساس هستند یا خیر. قابل نوشتن
advancedDetails. extractA string عبارت برای استخراج از فیلد A. قابل نوشتن
advancedDetails. extractB string عبارت برای استخراج از فیلد B. قابل نوشتن
advancedDetails. fieldA string فیلد A. قابل نوشتن
advancedDetails. fieldAIndex integer شاخص بعد سفارشی. اگر فیلد CUSTOM_DIMENSION باشد، الزامی است. قابل نوشتن
advancedDetails. fieldARequired boolean نشان می دهد که آیا فیلد A باید مطابقت داشته باشد یا خیر. قابل نوشتن
advancedDetails. fieldB string فیلد B. قابل نوشتن
advancedDetails. fieldBIndex integer شاخص بعد سفارشی. اگر فیلد CUSTOM_DIMENSION باشد، الزامی است. قابل نوشتن
advancedDetails. fieldBRequired boolean نشان می دهد که آیا فیلد B باید مطابقت داشته باشد یا خیر. قابل نوشتن
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،
    • عنوان صفحه،
    • معرف،
    • COST_DATA_URI (URL هدف کمپین)،
    • HIT_TYPE،
    • INTERNAL_SEARCH_TERM،
    • INTERNAL_SEARCH_TYPE،
    • SOURCE_PROPERTY_TRACKING_ID،
  • کمپین یا AdGroup
    • CAMPAIGN_SOURCE،
    • CAMPAIGN_MEDIUM،
    • CAMPAIGN_NAME،
    • CAMPAIGN_AD_GROUP،
    • CAMPAIGN_TERM،
    • CAMPAIGN_CONTENT،
    • کد کمپین،
    • CAMPAIGN_REFERRAL_PATH،
  • تجارت الکترونیک
    • TRANSACTION_COUNTRY،
    • TRANSACTION_REGION،
    • TRANSACTION_CITY،
    • TRANSACTION_AFFILIATION (محل فروشگاه یا سفارش)،
    • نام آیتم،
    • کد مورد،
    • ITEM_VARIATION،
    • شناسه تراکنش،
    • TRANSACTION_CURRENCY_CODE،
    • PRODUCT_ACTION_TYPE،
  • مخاطب/کاربران
    • مرورگر،
    • BROWSER_VERSION،
    • BROWSER_SIZE،
    • سکو،
    • PLATFORM_VERSION،
    • زبان،
    • وضوح صفحه،
    • SCREEN_COLORS،
    • JAVA_ENABLED (فیلد بولی)،
    • FLASH_VERSION،
    • GEO_SPEED (سرعت اتصال)،
    • VISITOR_TYPE،
    • GEO_ORGANIZATION (سازمان ISP)،
    • 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_VERSION،
    • صفحه نمایش،
    • IS_APP (فیلد بولی)،
    • IS_FATAL_EXCEPTION (فیلد بولی)،
    • EXCEPTION_DESCRIPTION،
  • دستگاه موبایل
    • IS_MOBILE (فیلد بولی، منسوخ شده. از DEVICE_CATEGORY=موبایل استفاده کنید)،
    • IS_TABLET (فیلد بولی، منسوخ شده. از DEVICE_CATEGORY=تبلت استفاده کنید)،
    • 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_ACTION_TARGET،
 قابل نوشتن
excludeDetails. fieldIndex integer شاخص بعد سفارشی. فقط در صورتی تنظیم کنید که فیلد a است 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،
    • عنوان صفحه،
    • معرف،
    • COST_DATA_URI (URL هدف کمپین)،
    • HIT_TYPE،
    • INTERNAL_SEARCH_TERM،
    • INTERNAL_SEARCH_TYPE،
    • SOURCE_PROPERTY_TRACKING_ID،
  • کمپین یا AdGroup
    • CAMPAIGN_SOURCE،
    • CAMPAIGN_MEDIUM،
    • CAMPAIGN_NAME،
    • CAMPAIGN_AD_GROUP،
    • CAMPAIGN_TERM،
    • CAMPAIGN_CONTENT،
    • کد کمپین،
    • CAMPAIGN_REFERRAL_PATH،
  • تجارت الکترونیک
    • TRANSACTION_COUNTRY،
    • TRANSACTION_REGION،
    • TRANSACTION_CITY،
    • TRANSACTION_AFFILIATION (محل فروشگاه یا سفارش)،
    • نام آیتم،
    • کد مورد،
    • ITEM_VARIATION،
    • شناسه تراکنش،
    • TRANSACTION_CURRENCY_CODE،
    • PRODUCT_ACTION_TYPE،
  • مخاطب/کاربران
    • مرورگر،
    • BROWSER_VERSION،
    • BROWSER_SIZE،
    • سکو،
    • PLATFORM_VERSION،
    • زبان،
    • وضوح صفحه،
    • SCREEN_COLORS،
    • JAVA_ENABLED (فیلد بولی)،
    • FLASH_VERSION،
    • GEO_SPEED (سرعت اتصال)،
    • VISITOR_TYPE،
    • GEO_ORGANIZATION (سازمان ISP)،
    • 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_VERSION،
    • صفحه نمایش،
    • IS_APP (فیلد بولی)،
    • IS_FATAL_EXCEPTION (فیلد بولی)،
    • EXCEPTION_DESCRIPTION،
  • دستگاه موبایل
    • IS_MOBILE (فیلد بولی، منسوخ شده. از DEVICE_CATEGORY=موبایل استفاده کنید)،
    • IS_TABLET (فیلد بولی، منسوخ شده. از DEVICE_CATEGORY=تبلت استفاده کنید)،
    • 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_ACTION_TARGET،
 قابل نوشتن
includeDetails. fieldIndex integer شاخص بعد سفارشی. فقط در صورتی تنظیم کنید که فیلد a است 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_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 را در بدنه پاسخ باز می گرداند.

مثال ها

توجه: نمونه‌های کد موجود برای این روش همه زبان‌های برنامه‌نویسی پشتیبانی‌شده را نشان نمی‌دهند (برای فهرست زبان‌های پشتیبانی‌شده به صفحه کتابخانه‌های سرویس گیرنده مراجعه کنید).

جاوا

از کتابخانه سرویس گیرنده جاوا استفاده می کند.

/*
 * 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();
}

پایتون

از کتابخانه کلاینت پایتون استفاده می کند.

# 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))

جاوا اسکریپت

از کتابخانه سرویس گیرنده جاوا اسکریپت استفاده می کند.

/*
 * 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. });
}

آن را امتحان کنید!

از APIs Explorer زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید. از طرف دیگر، اکسپلورر مستقل را امتحان کنید.