REST Resource: properties.dataStreams.eventCreateRules

資源:EventCreateRule

「事件建立規則」用來定義條件,可根據來源事件的相符條件觸發全新事件的建立作業。可以定義來源事件中的其他參數異動事件。

與「事件編輯」規則不同的是,事件建立規則未定義順序。這些 API 會各自獨立執行。

「事件編輯」和「事件建立」規則無法用來修改透過「事件建立」規則建立的事件。

JSON 表示法
{
  "name": string,
  "destinationEvent": string,
  "eventConditions": [
    {
      object (MatchingCondition)
    }
  ],
  "sourceCopyParameters": boolean,
  "parameterMutations": [
    {
      object (ParameterMutation)
    }
  ]
}
欄位
name

string

僅供輸出。這項 EventCreateRule 資源的資源名稱。格式:properties/{property}/dataStreams/{dataStream}/eventCreateRules/{eventCreateRule}

destinationEvent

string

必要欄位。要建立的新事件名稱,

這個值必須:* 小於 40 個半形字元 * 只能包含英文字母、數字或 _ (底線) * 開頭須為英文字母

eventConditions[]

object (MatchingCondition)

必要欄位。至少須設定一個條件,且最多不得超過 10 個。來源事件的條件必須相符,系統才會套用這項規則。

sourceCopyParameters

boolean

若為 true,來源參數就會複製到新事件。如果設為 False 或未設定,系統就不會從來源事件複製所有非內部參數。系統會在複製參數後套用參數異動。

parameterMutations[]

object (ParameterMutation)

參數異動會定義新事件的參數行為,並依序套用。最多可以套用 20 個異動。

MatchingCondition

定義「事件編輯」或「事件建立」規則套用至事件的條件。

JSON 表示法
{
  "field": string,
  "comparisonType": enum (ComparisonType),
  "value": string,
  "negated": boolean
}
欄位
field

string

必要欄位。要與條件比較的欄位名稱。如果指定「eventName」,此條件會套用至事件名稱。否則,系統會將條件套用至具有指定名稱的參數。

此值不能包含空格。

comparisonType

enum (ComparisonType)

必要欄位。要套用至值的比較類型。

value

string

必要欄位。要與這項條件比較的值。執行階段實作可能會執行這個值的類型強制轉換,根據參數值類型評估這個條件。

negated

boolean

是否應否定比較結果。舉例來說,如果 negated 為 true,「等於」的比較就會做為「不等於」。

ComparisonType

比對條件的比較類型

列舉
COMPARISON_TYPE_UNSPECIFIED 不明
EQUALS 等於 (區分大小寫)
EQUALS_CASE_INSENSITIVE 等於 (不區分大小寫)
CONTAINS 包含 (區分大小寫)
CONTAINS_CASE_INSENSITIVE 包含 (不區分大小寫)
STARTS_WITH 開頭有大小寫之分
STARTS_WITH_CASE_INSENSITIVE 開頭為 (不區分大小寫)
ENDS_WITH 結尾為區分大小寫
ENDS_WITH_CASE_INSENSITIVE 結尾為不區分大小寫
GREATER_THAN 大於
GREATER_THAN_OR_EQUAL 大於或等於
LESS_THAN 小於
LESS_THAN_OR_EQUAL 小於或等於
REGULAR_EXPRESSION 規則運算式。這項功能僅適用於網站串流。
REGULAR_EXPRESSION_CASE_INSENSITIVE 規則運算式,不區分大小寫。這項功能僅適用於網站串流。

ParameterMutation

定義要變動的事件參數。

JSON 表示法
{
  "parameter": string,
  "parameterValue": string
}
欄位
parameter

string

必要欄位。要變動的參數名稱。這個值必須:* 不得超過 40 個字元。* 規則內所有異動項目的名稱不得重複 * 只能包含字母、數字或 _ (底線)。如果是事件編輯規則,也可以將名稱設為「eventName」,以修改現有的 eventName。

parameterValue

string

必要欄位。要執行的值異動。* 必須少於 100 個字元。* 若要為參數指定常數值,請使用該值的字串。* 如要複製其他參數的值,請使用「[[other_parameter]]」等語法。詳情請參閱這篇說明中心文章

方法

create

建立 EventCreateRule。

delete

刪除 EventCreateRule。

get

查詢單一 EventCreateRule。

list

可列出網站資料串流的 EventCreateRules。

patch

更新 EventCreateRule。