Package com.google.analytics.admin.v1alpha

Interface KeyEventOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
KeyEvent, KeyEvent.Builder
@Generated public interface KeyEventOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Resource name of this key event.
 Format: properties/{property}/keyEvents/{key_event}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of this key event.
 Format: properties/{property}/keyEvents/{key_event}
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getEventName

      String getEventName()
       Immutable. The event name for this key event.
 Examples: 'click', 'purchase'
      string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The eventName.

    • getEventNameBytes

      com.google.protobuf.ByteString getEventNameBytes()
       Immutable. The event name for this key event.
 Examples: 'click', 'purchase'
      string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for eventName.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Time when this key event was created in the property.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Time when this key event was created in the property.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time when this key event was created in the property.
      .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDeletable

      boolean getDeletable()
       Output only. If set to true, this event can be deleted.
      bool deletable = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deletable.

    • getCustom

      boolean getCustom()
       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.
      bool custom = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The custom.

    • getCountingMethodValue

      int getCountingMethodValue()
       Required. The method by which Key Events will be counted across multiple
 events within a session.
      .google.analytics.admin.v1alpha.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for countingMethod.

    • getCountingMethod

      KeyEvent.CountingMethod getCountingMethod()
       Required. The method by which Key Events will be counted across multiple
 events within a session.
      .google.analytics.admin.v1alpha.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The countingMethod.

    • hasDefaultValue

      boolean hasDefaultValue()
       Optional. Defines a default value/currency for a key event.
      .google.analytics.admin.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the defaultValue field is set.

    • getDefaultValue

      KeyEvent.DefaultValue getDefaultValue()
       Optional. Defines a default value/currency for a key event.
      .google.analytics.admin.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The defaultValue.

    • getDefaultValueOrBuilder

      KeyEvent.DefaultValueOrBuilder getDefaultValueOrBuilder()
       Optional. Defines a default value/currency for a key event.
      .google.analytics.admin.v1alpha.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];