Google Analytics Admin API . properties . conversionEvents

Instance Methods

close()

Close httplib2 connections.

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

Creates a conversion event with the specified attributes.

delete(name, x__xgafv=None)

Deletes a conversion event in a property.

get(name, x__xgafv=None)

Retrieve a single conversion event.

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

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

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a conversion event with the specified attributes.

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

{ # A conversion event in a Google Analytics property.
  "createTime": "A String", # Output only. Time when this conversion event was created in the property.
  "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
  "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
  "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
}

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

Returns:
  An object of the form:

    { # A conversion event in a Google Analytics property.
  "createTime": "A String", # Output only. Time when this conversion event was created in the property.
  "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
  "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
  "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
}
delete(name, x__xgafv=None)
Deletes a conversion event in a property.

Args:
  name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/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); } The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name, x__xgafv=None)
Retrieve a single conversion event.

Args:
  name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/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 conversion event in a Google Analytics property.
  "createTime": "A String", # Output only. Time when this conversion event was created in the property.
  "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
  "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
  "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion 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 `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` 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 ListConversionEvents RPC.
  "conversionEvents": [ # The requested conversion events
    { # A conversion event in a Google Analytics property.
      "createTime": "A String", # Output only. Time when this conversion event was created in the property.
      "eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'
      "isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.
      "name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_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(previous_request, previous_response)
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.