Class: HubSpotSDK::Models::Crm::PublicAdsSearchFilter

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/hubspot_sdk/models/crm/public_ads_search_filter.rb

Defined Under Namespace

Modules: FilterType

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(ad_network:, entity_type:, filter_type:, operator:, search_terms:, search_term_type:) ⇒ Object

Some parameter documentations has been truncated, see HubSpotSDK::Models::Crm::PublicAdsSearchFilter for more details.

Parameters:

  • ad_network (String) —

    Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL)

  • entity_type (String) —

    Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN)

  • filter_type (Symbol, HubSpotSDK::Models::Crm::PublicAdsSearchFilter::FilterType) —

    Type of the filter (ADS_SEARCH)

  • operator (String) —

    Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN)

  • search_terms (Array<String>)
  • search_term_type (String) —

    Search term to match an ad




# File 'lib/hubspot_sdk/models/crm/public_ads_search_filter.rb', line 44

Instance Attribute Details

#ad_network ⇒ String

Ad network (ADWORDS, FACEBOOK, LINKEDIN, ALL)

Returns:

  • (String) 


11
 
# File 'lib/hubspot_sdk/models/crm/public_ads_search_filter.rb', line 11

required :ad_network, String, api_name: :adNetwork

#entity_type ⇒ String

Type of ad entity (KEYWORD, ADGROUP, AD, CAMPAIGN)

Returns:

  • (String) 


17
 
# File 'lib/hubspot_sdk/models/crm/public_ads_search_filter.rb', line 17

required :entity_type, String, api_name: :entityType

#filter_type ⇒ Symbol, HubSpotSDK::Models::Crm::PublicAdsSearchFilter::FilterType

Type of the filter (ADS_SEARCH)

Returns:



23
24
25
 
# File 'lib/hubspot_sdk/models/crm/public_ads_search_filter.rb', line 23

required :filter_type,
enum: -> { HubSpotSDK::Crm::PublicAdsSearchFilter::FilterType },
api_name: :filterType

#operator ⇒ String

Operator to be applied (CONTAINS, IS_EQUAL_TO, ENDS_WITH, STARTS_WITH, IS_KNOWN)

Returns:

  • (String) 


31
 
# File 'lib/hubspot_sdk/models/crm/public_ads_search_filter.rb', line 31

required :operator, String

#search_term_type ⇒ String

Search term to match an ad

Returns:

  • (String) 


42
 
# File 'lib/hubspot_sdk/models/crm/public_ads_search_filter.rb', line 42

required :search_term_type, String, api_name: :searchTermType

#search_terms ⇒ Array<String>

Returns:

  • (Array<String>) 


36
 
# File 'lib/hubspot_sdk/models/crm/public_ads_search_filter.rb', line 36

required :search_terms, HubSpotSDK::Internal::Type::ArrayOf[String], api_name: :searchTerms