Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/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) ⇒ GoogleCloudDiscoveryengineV1betaSearchLinkPromotion

Returns a new instance of GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.



18624
18625
18626
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18624

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) 


18599
18600
18601
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18599

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) 


18606
18607
18608
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18606

def enabled
  @enabled
end

#image_uri ⇒ String

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

Returns:

  • (String) 


18612
18613
18614
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18612

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) 


18617
18618
18619
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18617

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) 


18622
18623
18624
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18622

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18629
18630
18631
18632
18633
18634
18635
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 18629

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