Class: Google::Analytics::Data::V1beta::AudienceExport

Inherits:

Object

• Object
• Google::Analytics::Data::V1beta::AudienceExport

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/analytics/data/v1beta/analytics_data_api.rb

Overview

An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days.

Defined Under Namespace

Modules: State

Instance Attribute Summary

• #audience ⇒ ::String

  Required.

• #audience_display_name ⇒ ::String readonly

  Output only.

• #begin_creating_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #creation_quota_tokens_charged ⇒ ::Integer readonly

  Output only.

• #dimensions ⇒ ::Array<::Google::Analytics::Data::V1beta::AudienceDimension>

  Required.

• #error_message ⇒ ::String readonly

  Output only.

• #name ⇒ ::String readonly

  Output only.

• #percentage_completed ⇒ ::Float readonly

  Output only.

• #row_count ⇒ ::Integer readonly

  Output only.

• #state ⇒ ::Google::Analytics::Data::V1beta::AudienceExport::State readonly

  Output only.

Instance Attribute Details

#audience ⇒ ::String

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#audience_display_name ⇒ ::String (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#begin_creating_time ⇒ ::Google::Protobuf::Timestamp (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#creation_quota_tokens_charged ⇒ ::Integer (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#dimensions ⇒ ::Array<::Google::Analytics::Data::V1beta::AudienceDimension>

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#error_message ⇒ ::String (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#name ⇒ ::String (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#percentage_completed ⇒ ::Float (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#row_count ⇒ ::Integer (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end

#state ⇒ ::Google::Analytics::Data::V1beta::AudienceExport::State (readonly)

# File 'proto_docs/google/analytics/data/v1beta/analytics_data_api.rb', line 687

class AudienceExport
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The AudienceExport currently exists in this state.
  module State
    # Unspecified state will never be used.
    STATE_UNSPECIFIED = 0

    # The AudienceExport is currently creating and will be available in the
    # future. Creating occurs immediately after the CreateAudienceExport call.
    CREATING = 1

    # The AudienceExport is fully created and ready for querying. An
    # AudienceExport is updated to active asynchronously from a request; this
    # occurs some time (for example 15 minutes) after the initial create call.
    ACTIVE = 2

    # The AudienceExport failed to be created. It is possible that
    # re-requesting this audience export will succeed.
    FAILED = 3
  end
end