Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion

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) ⇒ GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.



7785
7786
7787
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7785

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) 


7760
7761
7762
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7760

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) 


7767
7768
7769
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7767

def enabled
  @enabled
end

#image_uri ⇒ String

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

Returns:

  • (String) 


7773
7774
7775
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7773

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) 


7778
7779
7780
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7778

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) 


7783
7784
7785
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7783

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7790
7791
7792
7793
7794
7795
7796
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7790

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