Class: Google::Apis::AnalyticsdataV1beta::AudienceExport

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsdata_v1beta/classes.rb,
lib/google/apis/analyticsdata_v1beta/representations.rb,
lib/google/apis/analyticsdata_v1beta/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AudienceExport

Returns a new instance of AudienceExport.



117
118
119
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 117

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#audience ⇒ 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` Corresponds to the JSON propertyaudience`

Returns:

  • (String) 


61
62
63
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 61

def audience
  @audience
end

#audience_display_name ⇒ String

Output only. The descriptive display name for this audience. For example, " Purchasers". Corresponds to the JSON property audienceDisplayName

Returns:

  • (String) 


67
68
69
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 67

def audience_display_name
  @audience_display_name
end

#begin_creating_time ⇒ String

Output only. The time when CreateAudienceExport was called and the AudienceExport began the CREATING state. Corresponds to the JSON property beginCreatingTime

Returns:

  • (String) 


73
74
75
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 73

def begin_creating_time
  @begin_creating_time
end

#creation_quota_tokens_charged ⇒ Fixnum

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. Corresponds to the JSON property creationQuotaTokensCharged

Returns:

  • (Fixnum) 


81
82
83
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 81

def creation_quota_tokens_charged
  @creation_quota_tokens_charged
end

#dimensions ⇒ Array<Google::Apis::AnalyticsdataV1beta::V1betaAudienceDimension>

Required. The dimensions requested and displayed in the query response. Corresponds to the JSON property dimensions

Returns:



86
87
88
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 86

def dimensions
  @dimensions
end

#error_message ⇒ String

Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


92
93
94
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 92

def error_message
  @error_message
end

#name ⇒ String

Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this AudienceExport. Format: properties/property/audienceExports/audience_export` Corresponds to the JSON propertyname`

Returns:

  • (String) 


99
100
101
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 99

def name
  @name
end

#percentage_completed ⇒ Float

Output only. The percentage completed for this audience export ranging between 0 to 100. Corresponds to the JSON property percentageCompleted

Returns:

  • (Float) 


105
106
107
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 105

def percentage_completed
  @percentage_completed
end

#row_count ⇒ Fixnum

Output only. The total number of rows in the AudienceExport result. Corresponds to the JSON property rowCount

Returns:

  • (Fixnum) 


110
111
112
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 110

def row_count
  @row_count
end

#state ⇒ String

Output only. The current state for this AudienceExport. Corresponds to the JSON property state

Returns:

  • (String) 


115
116
117
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 115

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 122

def update!(**args)
  @audience = args[:audience] if args.key?(:audience)
  @audience_display_name = args[:audience_display_name] if args.key?(:audience_display_name)
  @begin_creating_time = args[:begin_creating_time] if args.key?(:begin_creating_time)
  @creation_quota_tokens_charged = args[:creation_quota_tokens_charged] if args.key?(:creation_quota_tokens_charged)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @error_message = args[:error_message] if args.key?(:error_message)
  @name = args[:name] if args.key?(:name)
  @percentage_completed = args[:percentage_completed] if args.key?(:percentage_completed)
  @row_count = args[:row_count] if args.key?(:row_count)
  @state = args[:state] if args.key?(:state)
end