create(parent, body=None, x__xgafv=None)

Creates a ChannelGroup.

Args:
  parent: string, Required. The property for which to create a ChannelGroup. Example format: properties/1234 (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a Channel Group.
  "description": "A String", # The description of the Channel Group. Max length of 256 characters.
  "displayName": "A String", # Required. The display name of the Channel Group. Max length of 80 characters.
  "groupingRule": [ # Required. The grouping rules of channels. Maximum number of rules is 50.
    { # The rules that govern how traffic is grouped into one channel.
      "displayName": "A String", # Required. Customer defined display name for the channel.
      "expression": { # A logical expression of Channel Group dimension filters. # Required. The Filter Expression that defines the Grouping Rule.
        "andGroup": { # A list of Channel Group filter expressions. # A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
        "filter": { # A specific filter for a single dimension. # A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.
          "fieldName": "A String", # Required. Immutable. The dimension name to filter.
          "inListFilter": { # A filter for a string dimension that matches a particular list of options. The match is case insensitive. # A filter for a string dimension that matches a particular list of options.
            "values": [ # Required. The list of possible string values to match against. Must be non-empty.
              "A String",
            ],
          },
          "stringFilter": { # Filter where the field value is a String. The match is case insensitive. # A filter for a string-type dimension that matches a particular pattern.
            "matchType": "A String", # Required. The match type for the string filter.
            "value": "A String", # Required. The string value to be matched against.
          },
        },
        "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression # A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
        "orGroup": { # A list of Channel Group filter expressions. # A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
      },
    },
  ],
  "name": "A String", # Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
  "primary": True or False, # Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.
  "systemDefined": True or False, # Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a Channel Group.
  "description": "A String", # The description of the Channel Group. Max length of 256 characters.
  "displayName": "A String", # Required. The display name of the Channel Group. Max length of 80 characters.
  "groupingRule": [ # Required. The grouping rules of channels. Maximum number of rules is 50.
    { # The rules that govern how traffic is grouped into one channel.
      "displayName": "A String", # Required. Customer defined display name for the channel.
      "expression": { # A logical expression of Channel Group dimension filters. # Required. The Filter Expression that defines the Grouping Rule.
        "andGroup": { # A list of Channel Group filter expressions. # A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
        "filter": { # A specific filter for a single dimension. # A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.
          "fieldName": "A String", # Required. Immutable. The dimension name to filter.
          "inListFilter": { # A filter for a string dimension that matches a particular list of options. The match is case insensitive. # A filter for a string dimension that matches a particular list of options.
            "values": [ # Required. The list of possible string values to match against. Must be non-empty.
              "A String",
            ],
          },
          "stringFilter": { # Filter where the field value is a String. The match is case insensitive. # A filter for a string-type dimension that matches a particular pattern.
            "matchType": "A String", # Required. The match type for the string filter.
            "value": "A String", # Required. The string value to be matched against.
          },
        },
        "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression # A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
        "orGroup": { # A list of Channel Group filter expressions. # A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
      },
    },
  ],
  "name": "A String", # Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
  "primary": True or False, # Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.
  "systemDefined": True or False, # Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.
}

delete(name, x__xgafv=None)

Deletes a ChannelGroup on a property.

Args:
  name: string, Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Lookup for a single ChannelGroup.

Args:
  name: string, Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678 (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a Channel Group.
  "description": "A String", # The description of the Channel Group. Max length of 256 characters.
  "displayName": "A String", # Required. The display name of the Channel Group. Max length of 80 characters.
  "groupingRule": [ # Required. The grouping rules of channels. Maximum number of rules is 50.
    { # The rules that govern how traffic is grouped into one channel.
      "displayName": "A String", # Required. Customer defined display name for the channel.
      "expression": { # A logical expression of Channel Group dimension filters. # Required. The Filter Expression that defines the Grouping Rule.
        "andGroup": { # A list of Channel Group filter expressions. # A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
        "filter": { # A specific filter for a single dimension. # A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.
          "fieldName": "A String", # Required. Immutable. The dimension name to filter.
          "inListFilter": { # A filter for a string dimension that matches a particular list of options. The match is case insensitive. # A filter for a string dimension that matches a particular list of options.
            "values": [ # Required. The list of possible string values to match against. Must be non-empty.
              "A String",
            ],
          },
          "stringFilter": { # Filter where the field value is a String. The match is case insensitive. # A filter for a string-type dimension that matches a particular pattern.
            "matchType": "A String", # Required. The match type for the string filter.
            "value": "A String", # Required. The string value to be matched against.
          },
        },
        "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression # A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
        "orGroup": { # A list of Channel Group filter expressions. # A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
      },
    },
  ],
  "name": "A String", # Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
  "primary": True or False, # Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.
  "systemDefined": True or False, # Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists ChannelGroups on a property.

Args:
  parent: string, Required. The property for which to list ChannelGroups. Example format: properties/1234 (required)
  pageSize: integer, The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
  pageToken: string, A page token, received from a previous `ListChannelGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChannelGroups` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListChannelGroups RPC.
  "channelGroups": [ # List of ChannelGroup. These will be ordered stably, but in an arbitrary order.
    { # A resource message representing a Channel Group.
      "description": "A String", # The description of the Channel Group. Max length of 256 characters.
      "displayName": "A String", # Required. The display name of the Channel Group. Max length of 80 characters.
      "groupingRule": [ # Required. The grouping rules of channels. Maximum number of rules is 50.
        { # The rules that govern how traffic is grouped into one channel.
          "displayName": "A String", # Required. Customer defined display name for the channel.
          "expression": { # A logical expression of Channel Group dimension filters. # Required. The Filter Expression that defines the Grouping Rule.
            "andGroup": { # A list of Channel Group filter expressions. # A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
              "filterExpressions": [ # A list of Channel Group filter expressions.
                # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
              ],
            },
            "filter": { # A specific filter for a single dimension. # A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.
              "fieldName": "A String", # Required. Immutable. The dimension name to filter.
              "inListFilter": { # A filter for a string dimension that matches a particular list of options. The match is case insensitive. # A filter for a string dimension that matches a particular list of options.
                "values": [ # Required. The list of possible string values to match against. Must be non-empty.
                  "A String",
                ],
              },
              "stringFilter": { # Filter where the field value is a String. The match is case insensitive. # A filter for a string-type dimension that matches a particular pattern.
                "matchType": "A String", # Required. The match type for the string filter.
                "value": "A String", # Required. The string value to be matched against.
              },
            },
            "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression # A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
            "orGroup": { # A list of Channel Group filter expressions. # A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
              "filterExpressions": [ # A list of Channel Group filter expressions.
                # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
              ],
            },
          },
        },
      ],
      "name": "A String", # Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
      "primary": True or False, # Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.
      "systemDefined": True or False, # Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a ChannelGroup.

Args:
  name: string, Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group} (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource message representing a Channel Group.
  "description": "A String", # The description of the Channel Group. Max length of 256 characters.
  "displayName": "A String", # Required. The display name of the Channel Group. Max length of 80 characters.
  "groupingRule": [ # Required. The grouping rules of channels. Maximum number of rules is 50.
    { # The rules that govern how traffic is grouped into one channel.
      "displayName": "A String", # Required. Customer defined display name for the channel.
      "expression": { # A logical expression of Channel Group dimension filters. # Required. The Filter Expression that defines the Grouping Rule.
        "andGroup": { # A list of Channel Group filter expressions. # A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
        "filter": { # A specific filter for a single dimension. # A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.
          "fieldName": "A String", # Required. Immutable. The dimension name to filter.
          "inListFilter": { # A filter for a string dimension that matches a particular list of options. The match is case insensitive. # A filter for a string dimension that matches a particular list of options.
            "values": [ # Required. The list of possible string values to match against. Must be non-empty.
              "A String",
            ],
          },
          "stringFilter": { # Filter where the field value is a String. The match is case insensitive. # A filter for a string-type dimension that matches a particular pattern.
            "matchType": "A String", # Required. The match type for the string filter.
            "value": "A String", # Required. The string value to be matched against.
          },
        },
        "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression # A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
        "orGroup": { # A list of Channel Group filter expressions. # A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
      },
    },
  ],
  "name": "A String", # Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
  "primary": True or False, # Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.
  "systemDefined": True or False, # Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.
}

  updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource message representing a Channel Group.
  "description": "A String", # The description of the Channel Group. Max length of 256 characters.
  "displayName": "A String", # Required. The display name of the Channel Group. Max length of 80 characters.
  "groupingRule": [ # Required. The grouping rules of channels. Maximum number of rules is 50.
    { # The rules that govern how traffic is grouped into one channel.
      "displayName": "A String", # Required. Customer defined display name for the channel.
      "expression": { # A logical expression of Channel Group dimension filters. # Required. The Filter Expression that defines the Grouping Rule.
        "andGroup": { # A list of Channel Group filter expressions. # A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
        "filter": { # A specific filter for a single dimension. # A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression.
          "fieldName": "A String", # Required. Immutable. The dimension name to filter.
          "inListFilter": { # A filter for a string dimension that matches a particular list of options. The match is case insensitive. # A filter for a string dimension that matches a particular list of options.
            "values": [ # Required. The list of possible string values to match against. Must be non-empty.
              "A String",
            ],
          },
          "stringFilter": { # Filter where the field value is a String. The match is case insensitive. # A filter for a string-type dimension that matches a particular pattern.
            "matchType": "A String", # Required. The match type for the string filter.
            "value": "A String", # Required. The string value to be matched against.
          },
        },
        "notExpression": # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression # A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression.
        "orGroup": { # A list of Channel Group filter expressions. # A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group.
          "filterExpressions": [ # A list of Channel Group filter expressions.
            # Object with schema name: GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression
          ],
        },
      },
    },
  ],
  "name": "A String", # Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}
  "primary": True or False, # Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default.
  "systemDefined": True or False, # Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group.
}

Google Analytics Admin API . properties . channelGroups

Instance Methods

Method Details