REST Resource: properties.channelGroups

リソース: ChannelGroup

チャネル グループを表すリソース メッセージ。

JSON 表現
{
  "name": string,
  "displayName": string,
  "description": string,
  "groupingRule": [
    {
      object (GroupingRule)
    }
  ],
  "systemDefined": boolean,
  "primary": boolean
}
フィールド
name

string

出力専用。このチャネル グループ リソースのリソース名です。形式: properties/{property}/channelGroups/{channelGroup}

displayName

string

必須。チャネル グループの表示名。最大文字数は 80 文字です。

description

string

チャネル グループの説明。最大長は 256 文字です。

groupingRule[]

object (GroupingRule)

必須。チャネルのグループ化ルール。ルールの最大数は 50 です。

systemDefined

boolean

出力専用。true の場合、このチャネル グループは、Google アナリティクスで事前定義されているデフォルト チャネル グループです。このチャネル グループの表示名とグループ化ルールは更新できません。

primary

boolean

省略可。true の場合、このチャネル グループがレポートのデフォルト チャネル グループとして使用されます。primary に設定できるチャネル グループは一度に 1 つのみです。チャネル グループで primary フィールドが設定されている場合、以前のメインのチャネル グループでの設定が解除されます。

デフォルトでは、Google アナリティクスの既定のチャネル グループがメインのチャネル グループになります。

GroupingRule

トラフィックを 1 つのチャネルにグループ化する方法を規定するルール。

JSON 表現
{
  "displayName": string,
  "expression": {
    object (ChannelGroupFilterExpression)
  }
}
フィールド
displayName

string

必須。顧客が定義したチャネルの表示名。

expression

object (ChannelGroupFilterExpression)

必須。グループ化ルールを定義するフィルタ式。

ChannelGroupFilterExpression

チャネル グループのディメンション フィルタの論理式。

JSON 表現
{

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

object (ChannelGroupFilterExpressionList)

AND 結合される式のリスト。orGroup で ChannelGroupFilterExpressions のみを含めることができます。トップレベルの ChannelGroupFilterExpression に対して設定する必要があります。

orGroup

object (ChannelGroupFilterExpressionList)

OR で結合する式のリスト。andGroup または orGroup を含む ChannelGroupFilterExpressions を含めることはできません。

notExpression

object (ChannelGroupFilterExpression)

NOT 対象のフィルタ式(反転、補完)。また、dimensionOrMetricFilter のみを含めることができます。最上位の ChannelGroupFilterExpression では設定できません。

filter

object (ChannelGroupFilter)

単一のディメンションに対するフィルタ。最上位の ChannelGroupFilterExpression では設定できません。

ChannelGroupFilterExpressionList

チャネル グループのフィルタ式のリスト。

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

object (ChannelGroupFilterExpression)

チャネル グループのフィルタ式のリスト。

ChannelGroupFilter

単一のディメンションに対する特定のフィルタ。

JSON 表現
{
  "fieldName": string,

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

string

必須。変更不可。フィルタするディメンション名。

共用体フィールド value_filter。このフィルタの動作を定義する StringFilter または InListFilter。value_filter は次のいずれかになります。
stringFilter

object (StringFilter)

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

inListFilter

object (InListFilter)

特定のオプション リストに一致する文字列ディメンションのフィルタ。

StringFilter

フィールド値が文字列のフィルタ。大文字と小文字が区別されません。

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

enum (MatchType)

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

value

string

必須。照合する文字列値。

MatchType

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

列挙型
MATCH_TYPE_UNSPECIFIED デフォルトのマッチタイプ。
EXACT 文字列値の完全一致。
BEGINS_WITH 文字列値で始まります。
ENDS_WITH 文字列値で終わります。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 正規表現と文字列値とに完全に一致します。
PARTIAL_REGEXP 文字列値と部分一致する正規表現。

InListFilter

特定のオプション リストに一致する文字列ディメンションのフィルタ。大文字と小文字が区別されません。

JSON 表現
{
  "values": [
    string
  ]
}
フィールド
values[]

string

必須。照合対象となる文字列値のリスト。空でない必要があります。

メソッド

create

ChannelGroup を作成します。

delete

プロパティの ChannelGroup を削除します。

get

単一の ChannelGroup のルックアップ。

list

プロパティの ChannelGroup を一覧表示します。

patch

ChannelGroup を更新します。