フィルタ

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 フィルタにより除外するフィールド。有効な値は次のとおりです。
  • コンテンツとトラフィック
    • PAGE_REQUEST_URI
    • PAGE_HOSTNAME
    • PAGE_TITLE
    • REFERRAL
    • COST_DATA_URI(キャンペーンのターゲット URL)
    • 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
  • e コマース
    • 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
    • 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
    • SCREEN
    • IS_APP(ブール値フィールド)
    • IS_FATAL_EXCEPTION(ブール値フィールド)
    • EXCEPTION_DESCRIPTION
  • 携帯端末
    • IS_MOBILE(ブール値フィールド、サポート終了。DEVICE_CATEGORY=mobile を使用)
    • IS_TABLET(ブール値フィールド、サポート終了。DEVICE_CATEGORY=tablet を使用)
    • 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.kind string フィルタ式の種類の値。
excludeDetails.matchType string このフィルタのマッチタイプ。有効な値は BEGINS_WITHEQUALENDS_WITHCONTAINSMATCHES です。GEO_DOMAINGEO_IP_ADDRESSPAGE_REQUEST_URIPAGE_HOSTNAME フィルタでは、どのマッチタイプでも使用できます。他のフィルタでは、MATCHES を使用してください。 書き込み可能
id string フィルタ ID。
includeDetails nested object INCLUDE タイプのフィルタの詳細。
includeDetails.caseSensitive boolean フィルタで大文字と小文字を区別するかどうかを指定します。 書き込み可能
includeDetails.expressionValue string フィルタ式の値。 書き込み可能
includeDetails.field string フィルタにより除外するフィールド。有効な値は次のとおりです。
  • コンテンツとトラフィック
    • PAGE_REQUEST_URI
    • PAGE_HOSTNAME
    • PAGE_TITLE
    • REFERRAL
    • COST_DATA_URI(キャンペーンのターゲット URL)
    • 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
  • e コマース
    • 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
    • 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
    • SCREEN
    • IS_APP(ブール値フィールド)
    • IS_FATAL_EXCEPTION(ブール値フィールド)
    • EXCEPTION_DESCRIPTION
  • 携帯端末
    • IS_MOBILE(ブール値フィールド、サポート終了。DEVICE_CATEGORY=mobile を使用)
    • IS_TABLET(ブール値フィールド、サポート終了。DEVICE_CATEGORY=tablet を使用)
    • 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.kind string フィルタ式の種類の値。
includeDetails.matchType string このフィルタのマッチタイプ。有効な値は BEGINS_WITHEQUALENDS_WITHCONTAINSMATCHES です。GEO_DOMAINGEO_IP_ADDRESSPAGE_REQUEST_URIPAGE_HOSTNAME フィルタでは、どのマッチタイプでも使用できます。他のフィルタでは、MATCHES を使用してください。 書き込み可能
kind string アナリティクス フィルタのリソースタイプ。
lowercaseDetails object LOWER タイプのフィルタの詳細。
lowercaseDetails.field string フィルタで使用するフィールド。 書き込み可能
lowercaseDetails.fieldIndex integer カスタム ディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。 書き込み可能
name string このフィルタの名前。 書き込み可能
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 検索語句。 書き込み可能
type string このフィルタのタイプ有効な値は INCLUDE、EXCLUDE、LOWERCASE、UPPERCASE、SEARCH_AND_REPLACE、ADVANCED です。 書き込み可能
updated datetime このフィルタの最終更新日時。
uppercaseDetails object UPPER タイプのフィルタの詳細。
uppercaseDetails.field string フィルタで使用するフィールド。 書き込み可能
uppercaseDetails.fieldIndex integer カスタム ディメンションのインデックス。フィールドが CUSTOM_DIMENSION の場合は必須です。 書き込み可能

メソッド

delete
フィルタを削除します。
get
ユーザーがアクセスできるフィルタを返します。
insert
新しいフィルタを作成します。
list
アカウントのすべてのフィルタを一覧表示します。
patch
既存のフィルタを更新します。このメソッドはパッチの動作をサポートしています。
update
既存のフィルタを更新します。