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, UPPERCASE, SEARCH_AND_REPLACE และ ADVANCED เขียนได้
พร็อพเพอร์ตี้ที่ไม่บังคับ
advancedDetails.caseSensitive boolean ระบุว่านิพจน์ตัวกรองเป็นแบบพิจารณาตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ เขียนได้
advancedDetails.extractA string นิพจน์ที่จะดึงจากช่อง A เขียนได้
advancedDetails.extractB string นิพจน์ที่จะดึงจากช่อง B เขียนได้
advancedDetails.fieldA string ช่อง ก. เขียนได้
advancedDetails.fieldAIndex integer ดัชนีของมิติข้อมูลที่กําหนดเอง ต้องระบุหากฟิลด์คือ CUSTOM_DIMENSION เขียนได้
advancedDetails.fieldARequired boolean ระบุว่าต้องจับคู่ช่อง A หรือไม่ เขียนได้
advancedDetails.fieldB string ช่อง ข. เขียนได้
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 (URL เป้าหมายแคมเปญ)
    • HIT_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_VERSION
    • BROWSER_SIZE
    • PLATFORM
    • PLATFORM_VERSION
    • ภาษา
    • 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
    • SCREEN
    • IS_APP (ฟิลด์บูลีน)
    • IS_FATAL_EXCEPTION (ฟิลด์บูลีน)
    • EXCEPTION_DESCRIPTION
  • โทรศัพท์มือถือ
    • IS_MOBILE (ฟิลด์บูลีน, เลิกใช้แล้ว ใช้ DEVICE_CATEGORY=mobile)
    • 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 (URL เป้าหมายแคมเปญ)
    • HIT_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_VERSION
    • BROWSER_SIZE
    • PLATFORM
    • PLATFORM_VERSION
    • ภาษา
    • 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
    • SCREEN
    • IS_APP (ฟิลด์บูลีน)
    • IS_FATAL_EXCEPTION (ฟิลด์บูลีน)
    • EXCEPTION_DESCRIPTION
  • โทรศัพท์มือถือ
    • IS_MOBILE (ฟิลด์บูลีน, เลิกใช้แล้ว ใช้ DEVICE_CATEGORY=mobile)
    • 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 resource ในเนื้อหาการตอบสนอง

ตัวอย่าง

หมายเหตุ: ตัวอย่างโค้ดที่มีสำหรับวิธีการนี้ไม่ได้แสดงถึงภาษาโปรแกรมที่รองรับทั้งหมด (ดูรายการภาษาที่รองรับได้ในหน้าไลบรารีของไคลเอ็นต์)

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

ลองใช้เลย

ใช้ API Explorer ด้านล่างเพื่อเรียกใช้เมธอดนี้ในข้อมูลสดและดูการตอบสนอง หรือลองใช้เครื่องมือสำรวจแบบสแตนด์อโลน