Class: PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/post_for_me/models/platform_post.rb,
sig/post_for_me/models/platform_post.rbs

Defined Under Namespace

Classes: AudienceCity, AudienceCountry, AudienceGender, AudienceType, ImpressionSource

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(percentage:, type:) ⇒ Object

Parameters:

  • percentage (Float) —

    Percentage of audience of this type

  • type (String) —

    Type of audience




# File 'lib/post_for_me/models/platform_post.rb', line 360

Instance Attribute Details

#address_clicks ⇒ Float

Number of address clicks

Parameters:

  • value (Float)

Returns:

  • (Float) 


151
 
# File 'lib/post_for_me/models/platform_post.rb', line 151

required :address_clicks, Float

#app_download_clicks ⇒ Float

Number of app download clicks

Parameters:

  • value (Float)

Returns:

  • (Float) 


157
 
# File 'lib/post_for_me/models/platform_post.rb', line 157

required :app_download_clicks, Float

#audience_cities ⇒ Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCity>

Audience cities breakdown

Parameters:

  • value (::Array[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCity])

Returns:



163
164
 
# File 'lib/post_for_me/models/platform_post.rb', line 163

required :audience_cities,
-> { PostForMe::Internal::Type::ArrayOf[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCity] }

#audience_countries ⇒ Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCountry>

Audience countries breakdown

Parameters:

  • value (::Array[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCountry])

Returns:



170
171
 
# File 'lib/post_for_me/models/platform_post.rb', line 170

required :audience_countries,
-> { PostForMe::Internal::Type::ArrayOf[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCountry] }

#audience_genders ⇒ Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceGender>

Audience genders breakdown

Parameters:

  • value (::Array[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceGender])

Returns:



177
178
 
# File 'lib/post_for_me/models/platform_post.rb', line 177

required :audience_genders,
-> { PostForMe::Internal::Type::ArrayOf[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceGender] }

#audience_types ⇒ Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceType>

Audience types breakdown

Parameters:

  • value (::Array[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceType])

Returns:



184
185
 
# File 'lib/post_for_me/models/platform_post.rb', line 184

required :audience_types,
-> { PostForMe::Internal::Type::ArrayOf[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceType] }

#average_time_watched ⇒ Float

Average time watched in seconds

Parameters:

  • value (Float)

Returns:

  • (Float) 


191
 
# File 'lib/post_for_me/models/platform_post.rb', line 191

required :average_time_watched, Float

#comments ⇒ Float

Number of comments on the post

Parameters:

  • value (Float)

Returns:

  • (Float) 


197
 
# File 'lib/post_for_me/models/platform_post.rb', line 197

required :comments, Float

#email_clicks ⇒ Float

Number of email clicks

Parameters:

  • value (Float)

Returns:

  • (Float) 


203
 
# File 'lib/post_for_me/models/platform_post.rb', line 203

required :email_clicks, Float

#engagement_likes ⇒ Array<PostForMe::Models::TiktokBusinessVideoMetricPercentage>

Engagement likes data by percentage and time

Parameters:

Returns:



209
210
 
# File 'lib/post_for_me/models/platform_post.rb', line 209

required :engagement_likes,
-> { PostForMe::Internal::Type::ArrayOf[PostForMe::TiktokBusinessVideoMetricPercentage] }

#favorites ⇒ Float

Number of favorites on the post

Parameters:

  • value (Float)

Returns:

  • (Float) 


216
 
# File 'lib/post_for_me/models/platform_post.rb', line 216

required :favorites, Float

#full_video_watched_rate ⇒ Float

Rate of full video watches as a percentage

Parameters:

  • value (Float)

Returns:

  • (Float) 


222
 
# File 'lib/post_for_me/models/platform_post.rb', line 222

required :full_video_watched_rate, Float

#impression_sources ⇒ Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::ImpressionSource>

Impression sources breakdown

Parameters:

  • value (::Array[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::ImpressionSource])

Returns:



228
229
 
# File 'lib/post_for_me/models/platform_post.rb', line 228

required :impression_sources,
-> { PostForMe::Internal::Type::ArrayOf[PostForMe::PlatformPost::Metrics::TikTokBusinessMetricsDto::ImpressionSource] }

#lead_submissions ⇒ Float

Number of lead submissions

Parameters:

  • value (Float)

Returns:

  • (Float) 


235
 
# File 'lib/post_for_me/models/platform_post.rb', line 235

required :lead_submissions, Float

#likes ⇒ Float

Number of likes on the post

Parameters:

  • value (Float)

Returns:

  • (Float) 


241
 
# File 'lib/post_for_me/models/platform_post.rb', line 241

required :likes, Float

#new_followers ⇒ Float

Number of new followers gained from the post

Parameters:

  • value (Float)

Returns:

  • (Float) 


247
 
# File 'lib/post_for_me/models/platform_post.rb', line 247

required :new_followers, Float

#phone_number_clicks ⇒ Float

Number of phone number clicks

Parameters:

  • value (Float)

Returns:

  • (Float) 


253
 
# File 'lib/post_for_me/models/platform_post.rb', line 253

required :phone_number_clicks, Float

#profile_views ⇒ Float

Number of profile views generated

Parameters:

  • value (Float)

Returns:

  • (Float) 


259
 
# File 'lib/post_for_me/models/platform_post.rb', line 259

required :profile_views, Float

#reach ⇒ Float

Total reach of the post

Parameters:

  • value (Float)

Returns:

  • (Float) 


265
 
# File 'lib/post_for_me/models/platform_post.rb', line 265

required :reach, Float

#shares ⇒ Float

Number of shares on the post

Parameters:

  • value (Float)

Returns:

  • (Float) 


271
 
# File 'lib/post_for_me/models/platform_post.rb', line 271

required :shares, Float

#total_time_watched ⇒ Float

Total time watched in seconds

Parameters:

  • value (Float)

Returns:

  • (Float) 


277
 
# File 'lib/post_for_me/models/platform_post.rb', line 277

required :total_time_watched, Float

#video_view_retention ⇒ Array<PostForMe::Models::TiktokBusinessVideoMetricPercentage>

Video view retention data by percentage and time

Parameters:

Returns:



283
284
 
# File 'lib/post_for_me/models/platform_post.rb', line 283

required :video_view_retention,
-> { PostForMe::Internal::Type::ArrayOf[PostForMe::TiktokBusinessVideoMetricPercentage] }

#video_views ⇒ Float

Total number of video views

Parameters:

  • value (Float)

Returns:

  • (Float) 


290
 
# File 'lib/post_for_me/models/platform_post.rb', line 290

required :video_views, Float

#website_clicks ⇒ Float

Number of website clicks

Parameters:

  • value (Float)

Returns:

  • (Float) 


296
 
# File 'lib/post_for_me/models/platform_post.rb', line 296

required :website_clicks, Float

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


213
 
# File 'sig/post_for_me/models/platform_post.rbs', line 213

def to_hash: -> {