REST Resource: properties.channelGroups

Recurso: ChannelGroup

Uma mensagem de recurso que representa um grupo de canais.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "groupingRule": [
    {
      object (GroupingRule)
    }
  ],
  "systemDefined": boolean,
  "primary": boolean
}
Campos
name

string

Apenas saída. O nome do recurso do grupo de canais. Formato: properties/{property}/channelGroups/{channelGroup}
displayName

string

Obrigatório. O nome de exibição do grupo de canais. O comprimento máximo é de 80 caracteres.
description

string

A descrição do grupo de canais. Comprimento máximo de 256 caracteres.
groupingRule[]

object (GroupingRule)

Obrigatório. As regras de agrupamento de canais. O número máximo de regras é 50.
systemDefined

boolean

Apenas saída. Se for verdadeiro, esse grupo de canais é o grupo de canais padrão predefinido pelo Google Analytics. Não é possível atualizar o nome de exibição e as regras de agrupamento para esse grupo de canais.
primary

boolean

Opcional. Se verdadeiro, esse grupo de canais será usado como o grupo de canais padrão para relatórios. Apenas um grupo de canais pode ser definido como primary a qualquer momento. Se o campo primary for definido em um grupo de canais, ele será desativado no grupo de canais principal anterior.

O grupo de canais predefinido do Google Analytics é o principal por padrão.

GroupingRule

As regras que regem como o tráfego é agrupado em um canal.

Representação JSON 
{
  "displayName": string,
  "expression": {
    object (ChannelGroupFilterExpression)
  }
}
Campos
displayName

string

Obrigatório. Nome de exibição definido pelo cliente para o canal.
expression

object (ChannelGroupFilterExpression)

Obrigatório. A expressão de filtro que define a regra de agrupamento.

ChannelGroupFilterExpression

Uma expressão lógica de filtros de dimensão do grupo de canais.

Representação 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.
}
Campos
Campo de união expr. A expressão aplicada a um filtro. expr pode ser apenas de um dos tipos a seguir:
andGroup

object (ChannelGroupFilterExpressionList)

Uma lista de expressões a serem combinadas com AND. Ele só pode conter ChannelGroupFilterExpressions com orGroup. Isso precisa ser definido para a ChannelGroupFilterExpression de nível superior.
orGroup

object (ChannelGroupFilterExpressionList)

Uma lista de expressões para OR juntas. Não é possível incluir ChannelGroupFilterExpressions com andGroup ou orGroup.
notExpression

object (ChannelGroupFilterExpression)

Uma expressão de filtro a ser negada (ou seja, invertida, complementada). Ele só pode incluir um dimensionOrMetricFilter. Isso não pode ser definido no nível superior da ChannelGroupFilterExpression.
filter

object (ChannelGroupFilter)

Um filtro em uma única dimensão. Isso não pode ser definido no nível superior da ChannelGroupFilterExpression.

ChannelGroupFilterExpressionList

Uma lista de expressões de filtro do grupo de canais.

Representação JSON 
{
  "filterExpressions": [
    {
      object (ChannelGroupFilterExpression)
    }
  ]
}
Campos
filterExpressions[]

object (ChannelGroupFilterExpression)

Uma lista de expressões de filtro do grupo de canais.

ChannelGroupFilter

Um filtro específico para uma única dimensão.

Representação 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.
}
Campos
fieldName

string

Obrigatório. Imutável. O nome da dimensão a ser filtrada.
Campo de união value_filter. Um StringFilter ou InListFilter que define o comportamento dos filtros. value_filter pode ser apenas de um dos tipos a seguir:
stringFilter

object (StringFilter)

Um filtro para uma dimensão do tipo string que corresponde a um padrão específico.
inListFilter

object (InListFilter)

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções.

StringFilter

Filtre onde o valor do campo é uma string. A correspondência não diferencia maiúsculas de minúsculas.

Representação JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
Campos
matchType

enum (MatchType)

Obrigatório. O tipo de correspondência do filtro de string.
value

string

Obrigatório. O valor da string a ser correspondido.

MatchType

Como o filtro será usado para determinar uma correspondência.

Enums
MATCH_TYPE_UNSPECIFIED Tipo de correspondência padrão.
EXACT Correspondência exata do valor da string.
BEGINS_WITH Começa com o valor da string.
ENDS_WITH Termina com o valor da string.
CONTAINS Contém o valor da string.
FULL_REGEXP Correspondência completa da expressão regular com o valor da string.
PARTIAL_REGEXP Correspondência parcial da expressão regular com o valor da string.

InListFilter

Um filtro para uma dimensão de string que corresponde a uma lista específica de opções. A correspondência não diferencia maiúsculas de minúsculas.

Representação JSON 
{
  "values": [
    string
  ]
}
Campos
values[]

string

Obrigatório. A lista de valores de string possíveis para correspondência. Precisa estar preenchido.

Métodos

create

 Cria um ChannelGroup.

delete

 Exclui um ChannelGroup de uma propriedade.

get

 Consulta de um único ChannelGroup.

list

 Lista os ChannelGroups em uma propriedade.

patch

 Atualiza um ChannelGroup.