Filters: update

需要授權

更新現有的篩選器。立即試用或參閱範例。

要求

HTTP 要求

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

參數

參數名稱 值 說明
路徑參數
accountId string 篩選器所屬的帳戶 ID。
filterId string 要更新的篩選器 ID。

授權

這項要求需要下列範圍的授權 (進一步瞭解驗證和授權)。

範圍
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、
    • PAGE_TITLE、
    • 轉問：
    • COST_DATA_URI (廣告活動指定網址)，
    • 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_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_NAME、
    • 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_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 (廣告活動指定網址)，
    • 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_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_NAME、
    • 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_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_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 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. });
}

試試看！

使用下方的 APIs Explorer，針對有效資料呼叫這個方法，然後查看回應。 或者，您也可以試試獨立的 Explorer。