Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion

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

Returns a new instance of GoogleCloudDiscoveryengineV1betaSearchLinkPromotion.



20918
20919
20920
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 20918

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) 


20893
20894
20895
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 20893

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) 


20900
20901
20902
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 20900

def enabled
  @enabled
end

#image_uri ⇒ String

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

Returns:

  • (String) 


20906
20907
20908
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 20906

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) 


20911
20912
20913
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 20911

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) 


20916
20917
20918
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 20916

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20923
20924
20925
20926
20927
20928
20929
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 20923

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