close()

Close httplib2 connections.

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

Creates a Key Event.

Args:
parent: string, Required. The resource name of the parent property where this Key Event will be created. Format: properties/123 (required)
body: object, The request body.
The object takes the form of:

{ # A key event in a Google Analytics property.
"countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
"createTime": "A String", # Output only. Time when this key event was created in the property.
"custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
"defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
"currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
"numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
},
"deletable": True or False, # Output only. If set to true, this event can be deleted.
"eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
"name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
}

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

Returns:
An object of the form:

{ # A key event in a Google Analytics property.
"countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
"createTime": "A String", # Output only. Time when this key event was created in the property.
"custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
"defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
"currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
"numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
},
"deletable": True or False, # Output only. If set to true, this event can be deleted.
"eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
"name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
}

delete(name, x__xgafv=None)

Deletes a Key Event.

Args:
  name: string, Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (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)

Retrieve a single Key Event.

Args:
  name: string, Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456" (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A key event in a Google Analytics property.
  "countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
  "createTime": "A String", # Output only. Time when this key event was created in the property.
  "custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
  "defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
    "currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
    "numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
  },
  "deletable": True or False, # Output only. If set to true, this event can be deleted.
  "eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
  "name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
}

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

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.

Args:
parent: string, Required. The resource name of the parent property. Example: 'properties/123' (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 `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` 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 ListKeyEvents RPC.
"keyEvents": [ # The requested Key Events
{ # A key event in a Google Analytics property.
"countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
"createTime": "A String", # Output only. Time when this key event was created in the property.
"custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
"defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
"currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
"numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
},
"deletable": True or False, # Output only. If set to true, this event can be deleted.
"eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
"name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
},
],
"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 Key Event.

Args:
name: string, Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event} (required)
body: object, The request body.
The object takes the form of:

{ # A key event in a Google Analytics property.
"countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
"createTime": "A String", # Output only. Time when this key event was created in the property.
"custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
"defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
"currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
"numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
},
"deletable": True or False, # Output only. If set to true, this event can be deleted.
"eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
"name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
}

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 key event in a Google Analytics property.
"countingMethod": "A String", # Required. The method by which Key Events will be counted across multiple events within a session.
"createTime": "A String", # Output only. Time when this key event was created in the property.
"custom": True or False, # Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
"defaultValue": { # Defines a default value/currency for a key event. # Optional. Defines a default value/currency for a key event.
"currencyCode": "A String", # Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information.
"numericValue": 3.14, # Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset.
},
"deletable": True or False, # Output only. If set to true, this event can be deleted.
"eventName": "A String", # Immutable. The event name for this key event. Examples: 'click', 'purchase'
"name": "A String", # Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
}

Google Analytics Admin API . properties . keyEvents

Instance Methods

Method Details