REST Resource: properties.subpropertyEventFilters

リソース: SubpropertyEventFilter

GA4 サブプロパティのイベント フィルタを表すリソース メッセージ。

JSON 表現 
{
  "name": string,
  "filterClauses": [
    {
      object (SubpropertyEventFilterClause)
    }
  ],
  "applyToProperty": string
}
フィールド
name

string

出力専用。形式: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} 例: properties/1234/subpropertyEventFilters/5678
filterClauses[]

object (SubpropertyEventFilterClause)

必須。順序なしリスト。SubpropertyEventFilter を定義するフィルタ句。サブプロパティに送信されるデータを決定するために、すべての句が AND 結合されます。
applyToProperty

string

変更不可。このフィルタを使用するサブプロパティのリソース名。

SubpropertyEventFilterClause

フィルタを定義する句。フィルタには、包含（フィルタ句を満たすイベントがサブプロパティのデータに含まれる）と除外（フィルタ句を満たすイベントをサブプロパティのデータから除外）のいずれかを指定できます。

JSON 表現 
{
  "filterClauseType": enum (FilterClauseType),
  "filterExpression": {
    object (SubpropertyEventFilterExpression)
  }
}
フィールド
filterClauseType

enum (FilterClauseType)

必須。フィルタ句のタイプ。
filterExpression

object (SubpropertyEventFilterExpression)

必須。サブプロパティに送信されるイベントの論理式。

FilterClauseType

一致フィルタ句と除外フィルタ句のどちらであるかを指定します。

列挙型
FILTER_CLAUSE_TYPE_UNSPECIFIED フィルタ句のタイプが不明か、指定されていません。
INCLUDE フィルタ句が満たされている場合、イベントはサブプロパティに含まれます。
EXCLUDE フィルタ句の条件が満たされると、イベントはサブプロパティから除外されます。

SubpropertyEventFilterExpression

サブプロパティのイベント フィルタの論理式。

JSON 表現 
{

  // Union field expr can be only one of the following:
  "orGroup": {
    object (SubpropertyEventFilterExpressionList)
  },
  "notExpression": {
    object (SubpropertyEventFilterExpression)
  },
  "filterCondition": {
    object (SubpropertyEventFilterCondition)
  }
  // End of list of possible types for union field expr.
}
フィールド
共用体フィールド expr。フィルタに適用される式。expr は次のいずれかになります。
orGroup

object (SubpropertyEventFilterExpressionList)

OR で結合する式のリスト。notExpression 式または filterCondition 式のみを含める必要があります。
notExpression

object (SubpropertyEventFilterExpression)

否定（反転、補完）するフィルタ式。フィルタのみを含めることができます。最上位の SubpropertyEventFilterExpression には設定できません。
filterCondition

object (SubpropertyEventFilterCondition)

特定のイベントに一致するフィルタを作成します。最上位の SubpropertyEventFilterExpression には設定できません。

SubpropertyEventFilterExpressionList

サブプロパティのイベント フィルタ式のリスト。

JSON 表現 
{
  "filterExpressions": [
    {
      object (SubpropertyEventFilterExpression)
    }
  ]
}
フィールド
filterExpressions[]

object (SubpropertyEventFilterExpression)

必須。順序なしリスト。サブプロパティのイベント フィルタ式のリスト

SubpropertyEventFilterCondition

特定のフィルタ式

JSON 表現 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "nullFilter": boolean,
  "stringFilter": {
    object (StringFilter)
  }
  // End of list of possible types for union field one_filter.
}
フィールド
fieldName

string

必須。フィルタするフィールド。

共用体フィールド one_filter。

one_filter は次のいずれかになります。
nullFilter

boolean

null 値のフィルタ。
stringFilter

object (StringFilter)

特定のパターンに一致する文字列型のディメンションのフィルタ。

StringFilter

特定のパターンに一致する文字列型のディメンションのフィルタ。

JSON 表現 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
フィールド
matchType

enum (MatchType)

必須。文字列フィルタのマッチタイプ。
value

string

必須。照合に使用される文字列値。
caseSensitive

boolean

省略可。true の場合、文字列値の大文字と小文字は区別されます。false の場合、大文字と小文字が区別されません。

MatchType

フィルタを使用して一致を判断する方法。

列挙型
MATCH_TYPE_UNSPECIFIED マッチタイプが不明か、指定されていません。
EXACT 文字列値との完全一致。
BEGINS_WITH 文字列値で始まります。
ENDS_WITH 文字列値で終わる。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 正規表現が文字列値と完全に一致します。
PARTIAL_REGEXP 正規表現が文字列値と部分一致する場合。

Methods

create

 サブプロパティ イベント フィルタを作成します。

delete

 サブプロパティのイベント フィルタを削除します。

get

 1 つのサブプロパティのイベント フィルタを検索します。

list

 プロパティのすべてのサブプロパティのイベント フィルタを一覧表示します。

patch

 サブプロパティ イベント フィルタを更新します。