Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

Promotion proto includes uri and other helping information to display the promotion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.



14621
14622
14623
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14621

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

Instance Attribute Details

#description ⇒ String

Optional. The Promotion description. Maximum length: 200 characters. Corresponds to the JSON property description

Returns:

  • (String) 


14596
14597
14598
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14596

def description
  @description
end

#enabled ⇒ Boolean Also known as: enabled?

Optional. The enabled promotion will be returned for any serving configs associated with the parent of the control this promotion is attached to. This flag is used for basic site search only. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


14603
14604
14605
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14603

def enabled
  @enabled
end

#image_uri ⇒ String

Optional. The promotion thumbnail image url. Corresponds to the JSON property imageUri

Returns:

  • (String) 


14609
14610
14611
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14609

def image_uri
  @image_uri
end

#title ⇒ String

Required. The title of the promotion. Maximum length: 160 characters. Corresponds to the JSON property title

Returns:

  • (String) 


14614
14615
14616
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14614

def title
  @title
end

#uri ⇒ String

Required. The URL for the page the user wants to promote. Corresponds to the JSON property uri

Returns:

  • (String) 


14619
14620
14621
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14619

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14626
14627
14628
14629
14630
14631
14632
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 14626

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @enabled = args[:enabled] if args.key?(:enabled)
  @image_uri = args[:image_uri] if args.key?(:image_uri)
  @title = args[:title] if args.key?(:title)
  @uri = args[:uri] if args.key?(:uri)
end