需要授權
要求
HTTP 要求
POST https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters
參數
參數名稱 | 值 | 說明 |
---|---|---|
路徑參數 | ||
accountId |
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 |
要篩選的欄位。可能的值:
|
可寫入 |
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 |
要篩選的欄位。可能的值:
|
可寫入 |
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 creates a new 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().insert("123456", 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 creates a new 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->setExcludeDetails($details); $analytics->management_filters->insert('123456', $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 creates a new filter. try: analytics.management().filters().insert( accountId='123456', 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
/* * Note: This code assumes you have an authorized Analytics client object. * See the Filters Developer Guide for details. */ /* * This request creates a new filter. */ function insertFilter() { var request = gapi.client.analytics.management.filters.insert( { 'accountId': '123456', 'resource': { '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。