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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

#audience ⇒ ::String

Returns Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs.

Format: properties/{property}/audiences/{audience}.

Returns:

  • (::String) —

    Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs.

    Format: properties/{property}/audiences/{audience}



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. The descriptive display name for this audience. For example, "Purchasers".

Returns:

  • (::String) —

    Output only. The descriptive display name for this audience. For example, "Purchasers".



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. The time when CreateAudienceExport was called and the AudienceExport began the CREATING state.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The time when CreateAudienceExport was called and the AudienceExport began the CREATING state.



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceExport enters the ACTIVE or FAILED states.

Returns:

  • (::Integer) —

    Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the CREATING state, this tokens charged will be fixed once an AudienceExport enters the ACTIVE or FAILED states.



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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>

Returns Required. The dimensions requested and displayed in the query response.

Returns:



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.

Returns:

  • (::String) —

    Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion.



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport.

Format: properties/{property}/audienceExports/{audience_export}.

Returns:

  • (::String) —

    Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport.

    Format: properties/{property}/audienceExports/{audience_export}



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. The percentage completed for this audience export ranging between 0 to 100.

Returns:

  • (::Float) —

    Output only. The percentage completed for this audience export ranging between 0 to 100.



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. The total number of rows in the AudienceExport result.

Returns:

  • (::Integer) —

    Output only. The total number of rows in the AudienceExport result.



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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)

Returns Output only. The current state for this AudienceExport.

Returns:



687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# 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