GoogleApi.DFAReporting.V34.Model.CustomEvent (google_api_dfa_reporting v0.31.0)

View Source

Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click.

Attributes

  • annotateClickEvent (type: GoogleApi.DFAReporting.V34.Model.CustomEventClickAnnotation.t, default: nil) - Annotate a click event. This field is mutually exclusive with insertEvent and annotateImpressionEvent. This or insertEvent and annotateImpressionEvent is a required field.
  • annotateImpressionEvent (type: GoogleApi.DFAReporting.V34.Model.CustomEventImpressionAnnotation.t, default: nil) - Annotate an impression. This field is mutually exclusive with insertEvent and annotateClickEvent. This or insertEvent and annotateClickEvent is a required field.
  • customVariables (type: list(GoogleApi.DFAReporting.V34.Model.CustomVariable.t), default: nil) - Custom variables associated with the event.
  • eventType (type: String.t, default: nil) - The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE, the fields in either annotateClickEvent or annotateImpressionEvent need to be populated.
  • floodlightConfigurationId (type: String.t, default: nil) - Floodlight configuration ID of the advertiser the event is linked to. This is a required field.
  • insertEvent (type: GoogleApi.DFAReporting.V34.Model.CustomEventInsert.t, default: nil) - Insert custom event. This field is mutually exclusive with annotateClickEvent and annotateImpressionEvent. This or annotateClickEvent and annotateImpressionEvent is a required field.
  • kind (type: String.t, default: nil) - Identifies what kind of resource this is. Value: the fixed string "dfareporting#customEvent".
  • ordinal (type: String.t, default: nil) - The ordinal of this custom event. This is a required field.
  • timestampMicros (type: String.t, default: nil) - The timestamp of this custom event, in Unix epoch micros. This is a required field.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.DFAReporting.V34.Model.CustomEvent{
  annotateClickEvent:
    GoogleApi.DFAReporting.V34.Model.CustomEventClickAnnotation.t() | nil,
  annotateImpressionEvent:
    GoogleApi.DFAReporting.V34.Model.CustomEventImpressionAnnotation.t() | nil,
  customVariables: [GoogleApi.DFAReporting.V34.Model.CustomVariable.t()] | nil,
  eventType: String.t() | nil,
  floodlightConfigurationId: String.t() | nil,
  insertEvent: GoogleApi.DFAReporting.V34.Model.CustomEventInsert.t() | nil,
  kind: String.t() | nil,
  ordinal: String.t() | nil,
  timestampMicros: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.