Filters コレクションは、Filter リソースのセットです。各 Filter リソースに、ビュー(旧プロファイル)に適用できるフィルタが記述されています。
このリソースのメソッドの一覧については、このページの最後をご覧ください。
リソース表現
アナリティクス アカウント フィルタの JSON テンプレート。
{ "id": string, "kind": "analytics#filter", "selfLink": string, "accountId": string, "name": string, "type": string, "created": datetime, "updated": datetime, "parentLink": { "type": "analytics#account", "href": string }, "includeDetails": { "kind": "analytics#filterExpression", "field": string, "matchType": string, "expressionValue": string, "caseSensitive": boolean, "fieldIndex": integer }, "excludeDetails": { "kind": "analytics#filterExpression", "field": string, "matchType": string, "expressionValue": string, "caseSensitive": boolean, "fieldIndex": integer }, "lowercaseDetails": { "field": string, "fieldIndex": integer }, "uppercaseDetails": { "field": string, "fieldIndex": integer }, "searchAndReplaceDetails": { "field": string, "fieldIndex": integer, "searchString": string, "replaceString": string, "caseSensitive": boolean }, "advancedDetails": { "fieldA": string, "fieldAIndex": integer, "extractA": string, "fieldB": string, "fieldBIndex": integer, "extractB": string, "outputToField": string, "outputToFieldIndex": integer, "outputConstructor": string, "fieldARequired": boolean, "fieldBRequired": boolean, "overrideOutputField": boolean, "caseSensitive": boolean } }
プロパティ名 | 値 | 説明 | メモ |
---|---|---|---|
accountId |
string |
このフィルタが属するアカウントの ID。 | |
advancedDetails |
object |
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 |
出力フィールドの既存の値がある場合に、出力式によって上書きするかどうかを示します。 | 書き込み可能 |
created |
datetime |
フィルタの作成日時。 | |
excludeDetails |
nested object |
EXCLUDE タイプのフィルタの詳細。 | |
excludeDetails.caseSensitive |
boolean |
フィルタで大文字と小文字を区別するかどうかを指定します。 | 書き込み可能 |
excludeDetails.expressionValue |
string |
フィルタ式の値。 | 書き込み可能 |
excludeDetails.field |
string |
フィルタにより除外するフィールド。有効な値:
|
書き込み可能 |
excludeDetails.fieldIndex |
integer |
カスタム ディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合にのみ設定します。 | 書き込み可能 |
excludeDetails.kind |
string |
フィルタ式の種類の値。 | |
excludeDetails.matchType |
string |
このフィルタのマッチタイプ。有効な値は BEGINS_WITH 、EQUAL 、ENDS_WITH 、CONTAINS 、MATCHES です。GEO_DOMAIN 、GEO_IP_ADDRESS 、PAGE_REQUEST_URI 、PAGE_HOSTNAME のフィルタではすべてのマッチタイプを使用できます。他のすべてのフィルタでは MATCHES を使用する必要があります。 |
書き込み可能 |
id |
string |
フィルタ ID。 | |
includeDetails |
nested object |
INCLUDE タイプのフィルタの詳細。 | |
includeDetails.caseSensitive |
boolean |
フィルタで大文字と小文字を区別するかどうかを指定します。 | 書き込み可能 |
includeDetails.expressionValue |
string |
フィルタ式の値。 | 書き込み可能 |
includeDetails.field |
string |
フィルタにより除外するフィールド。有効な値:
|
書き込み可能 |
includeDetails.fieldIndex |
integer |
カスタム ディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合にのみ設定します。 | 書き込み可能 |
includeDetails.kind |
string |
フィルタ式の種類の値。 | |
includeDetails.matchType |
string |
このフィルタのマッチタイプ。有効な値は BEGINS_WITH 、EQUAL 、ENDS_WITH 、CONTAINS 、MATCHES です。GEO_DOMAIN 、GEO_IP_ADDRESS 、PAGE_REQUEST_URI 、PAGE_HOSTNAME のフィルタではすべてのマッチタイプを使用できます。他のすべてのフィルタでは MATCHES を使用する必要があります。 |
書き込み可能 |
kind |
string |
アナリティクス フィルタのリソースタイプ。 | |
lowercaseDetails |
object |
LOWER タイプのフィルタの詳細。 | |
lowercaseDetails.field |
string |
フィルタで使用するフィールド。 | 書き込み可能 |
lowercaseDetails.fieldIndex |
integer |
カスタム ディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。 | 書き込み可能 |
name |
string |
このフィルタの名前。 | 書き込み可能 |
parentLink |
object |
このフィルタの親リンク。このフィルタが属するアカウントを参照します。 | |
parentLink.href |
string |
このフィルタが属するアカウントへのリンク。 | |
parentLink.type |
string |
値は「analytics#account」です。 | |
searchAndReplaceDetails |
object |
SEARCH_AND_REPLACE タイプのフィルタの詳細。 | |
searchAndReplaceDetails.caseSensitive |
boolean |
フィルタで大文字と小文字を区別するかどうかを指定します。 | 書き込み可能 |
searchAndReplaceDetails.field |
string |
フィルタで使用するフィールド。 | 書き込み可能 |
searchAndReplaceDetails.fieldIndex |
integer |
カスタム ディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。 | 書き込み可能 |
searchAndReplaceDetails.replaceString |
string |
検索語句を置換する語句。 | 書き込み可能 |
searchAndReplaceDetails.searchString |
string |
検索語句。 | 書き込み可能 |
selfLink |
string |
このフィルタのリンク。 | |
type |
string |
このフィルタのタイプ有効な値は INCLUDE、EXCLUDE、LOWERCASE、UPPERCASE、SEARCH_AND_REPLACE、ADVANCED です。 | 書き込み可能 |
updated |
datetime |
このフィルタの最終更新日時。 | |
uppercaseDetails |
object |
UPPER タイプのフィルタの詳細。 | |
uppercaseDetails.field |
string |
フィルタで使用するフィールド。 | 書き込み可能 |
uppercaseDetails.fieldIndex |
integer |
カスタム ディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。 | 書き込み可能 |