Class: WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/ad_group_update_params.rb

Defined Under Namespace

Modules: ActionScene, VideoUserAction

Instance Attribute Summary collapse

Class Method 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(action_category_ids: nil, action_period: nil, action_scene: nil, video_user_actions: nil) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action for more details.

A single TikTok behavioral targeting entry. One category of past user behavior (what they did, over what window, on which kind of content). See docs/tiktok_api/ad_group.md § actions.

Parameters:



2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2726

class Action < WhopSDK::Internal::Type::BaseModel
  # @!attribute action_category_ids
  #   Behavioral category IDs. Use /tool/action_category/ to list them.
  #
  #   @return [Array<String>, nil]
  optional :action_category_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

  # @!attribute action_period
  #   Lookback window in days. TikTok accepts 7, 15, 30, 60, 90, or 180.
  #
  #   @return [Integer, nil]
  optional :action_period, Integer, nil?: true

  # @!attribute action_scene
  #   The category of TikTok content a behavioral targeting rule applies to. See
  #   docs/tiktok_api/ad_group.md § actions.
  #
  #   @return [Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::ActionScene, nil]
  optional :action_scene,
           enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::ActionScene },
           nil?: true

  # @!attribute video_user_actions
  #   Specific video interactions (WATCHED_TO_END, LIKED, COMMENTED, SHARED, FOLLOWED,
  #   PROFILE_VISITED).
  #
  #   @return [Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::VideoUserAction>, nil]
  optional :video_user_actions,
           -> {
             WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::VideoUserAction]
           },
           nil?: true

  # @!method initialize(action_category_ids: nil, action_period: nil, action_scene: nil, video_user_actions: nil)
  #   Some parameter documentations has been truncated, see
  #   {WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action} for more
  #   details.
  #
  #   A single TikTok behavioral targeting entry. One category of past user behavior
  #   (what they did, over what window, on which kind of content). See
  #   docs/tiktok_api/ad_group.md § actions.
  #
  #   @param action_category_ids [Array<String>, nil] Behavioral category IDs. Use /tool/action_category/ to list them.
  #
  #   @param action_period [Integer, nil] Lookback window in days. TikTok accepts 7, 15, 30, 60, 90, or 180.
  #
  #   @param action_scene [Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::ActionScene, nil] The category of TikTok content a behavioral targeting rule applies to. See docs/
  #
  #   @param video_user_actions [Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::VideoUserAction>, nil] Specific video interactions (WATCHED_TO_END, LIKED, COMMENTED, SHARED, FOLLOWED,

  # The category of TikTok content a behavioral targeting rule applies to. See
  # docs/tiktok_api/ad_group.md § actions.
  #
  # @see WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action#action_scene
  module ActionScene
    extend WhopSDK::Internal::Type::Enum

    VIDEO_RELATED = :VIDEO_RELATED
    CREATOR_RELATED = :CREATOR_RELATED
    HASHTAG_RELATED = :HASHTAG_RELATED
    LIVE_RELATED = :LIVE_RELATED

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Specific past video interactions used for behavioral targeting. See
  # docs/tiktok_api/ad_group.md § actions.video_user_actions.
  module VideoUserAction
    extend WhopSDK::Internal::Type::Enum

    WATCHED_TO_END = :WATCHED_TO_END
    LIKED = :LIKED
    COMMENTED = :COMMENTED
    SHARED = :SHARED
    FOLLOWED = :FOLLOWED
    PROFILE_VISITED = :PROFILE_VISITED

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#action_category_ids ⇒ Array<String>?

Behavioral category IDs. Use /tool/action_category/ to list them.

Returns:

  • (Array<String>, nil) 


2731
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2731

optional :action_category_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true

#action_period ⇒ Integer?

Lookback window in days. TikTok accepts 7, 15, 30, 60, 90, or 180.

Returns:

  • (Integer, nil) 


2737
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2737

optional :action_period, Integer, nil?: true

#action_scene ⇒ Symbol, ...

The category of TikTok content a behavioral targeting rule applies to. See docs/tiktok_api/ad_group.md § actions.

Returns:



2744
2745
2746
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2744

optional :action_scene,
enum: -> { WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::ActionScene },
nil?: true

#video_user_actions ⇒ Array<Symbol, WhopSDK::Models::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::VideoUserAction>?

Specific video interactions (WATCHED_TO_END, LIKED, COMMENTED, SHARED, FOLLOWED, PROFILE_VISITED).

Returns:



2753
2754
2755
2756
2757
 
# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2753

optional :video_user_actions,
-> {
  WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::AdGroupUpdateParams::PlatformConfig::Tiktok::Action::VideoUserAction]
},
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/ad_group_update_params.rb', line 2788