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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCity

Defined in:

lib/post_for_me/models/platform_post.rb,
sig/post_for_me/models/platform_post.rbs

Instance Attribute Summary

• #city_name ⇒ String

  City name.

• #percentage ⇒ Float

  Percentage of audience from this city.

Instance Method Summary

• #initialize(address_clicks:, app_download_clicks:, audience_cities:, audience_countries:, audience_genders:, audience_types:, average_time_watched:, comments:, email_clicks:, engagement_likes:, favorites:, full_video_watched_rate:, impression_sources:, lead_submissions:, likes:, new_followers:, phone_number_clicks:, profile_views:, reach:, shares:, total_time_watched:, video_view_retention:, video_views:, website_clicks:) ⇒ AudienceCity constructor

  A new instance of AudienceCity.

• #to_hash ⇒ { city_name: String, percentage: Float }

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(address_clicks:, app_download_clicks:, audience_cities:, audience_countries:, audience_genders:, audience_types:, average_time_watched:, comments:, email_clicks:, engagement_likes:, favorites:, full_video_watched_rate:, impression_sources:, lead_submissions:, likes:, new_followers:, phone_number_clicks:, profile_views:, reach:, shares:, total_time_watched:, video_view_retention:, video_views:, website_clicks:) ⇒ AudienceCity

Returns a new instance of AudienceCity.

Parameters:

• address_clicks (Float) —

  Number of address clicks

• app_download_clicks (Float) —

  Number of app download clicks

• audience_cities (Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCity>) —

  Audience cities breakdown

• audience_countries (Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceCountry>) —

  Audience countries breakdown

• audience_genders (Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceGender>) —

  Audience genders breakdown

• audience_types (Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::AudienceType>) —

  Audience types breakdown

• average_time_watched (Float) —

  Average time watched in seconds

• comments (Float) —

  Number of comments on the post

• email_clicks (Float) —

  Number of email clicks

• engagement_likes (Array<PostForMe::Models::TiktokBusinessVideoMetricPercentage>) —

  Engagement likes data by percentage and time

• favorites (Float) —

  Number of favorites on the post

• full_video_watched_rate (Float) —

  Rate of full video watches as a percentage

• impression_sources (Array<PostForMe::Models::PlatformPost::Metrics::TikTokBusinessMetricsDto::ImpressionSource>) —

  Impression sources breakdown

• lead_submissions (Float) —

  Number of lead submissions

• likes (Float) —

  Number of likes on the post

• new_followers (Float) —

  Number of new followers gained from the post

• phone_number_clicks (Float) —

  Number of phone number clicks

• profile_views (Float) —

  Number of profile views generated

• reach (Float) —

  Total reach of the post

• shares (Float) —

  Number of shares on the post

• total_time_watched (Float) —

  Total time watched in seconds

• video_view_retention (Array<PostForMe::Models::TiktokBusinessVideoMetricPercentage>) —

  Video view retention data by percentage and time

• video_views (Float) —

  Total number of video views

• website_clicks (Float) —

  Number of website clicks

• city_name: (String)
• percentage: (Float)

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

class AudienceCity < PostForMe::Internal::Type::BaseModel
  # @!attribute city_name
  #   City name
  #
  #   @return [String]
  required :city_name, String

  # @!attribute percentage
  #   Percentage of audience from this city
  #
  #   @return [Float]
  required :percentage, Float

  # @!method initialize(city_name:, percentage:)
  #   @param city_name [String] City name
  #
  #   @param percentage [Float] Percentage of audience from this city
end

Instance Attribute Details

#city_name ⇒ String

City name

Parameters:

• value (String)

Returns:

• (String)

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

required :city_name, String

#percentage ⇒ Float

Percentage of audience from this city

Parameters:

• value (Float)

Returns:

• (Float)

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

required :percentage, Float

Instance Method Details

#to_hash ⇒ { city_name: String, percentage: Float }

Returns:

• ({ city_name: String, percentage: Float })

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

def to_hash: -> { city_name: String, percentage: Float }