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.



17397
17398
17399
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17397

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) 


17372
17373
17374
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17372

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) 


17379
17380
17381
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17379

def enabled
  @enabled
end

#image_uri ⇒ String

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

Returns:

  • (String) 


17385
17386
17387
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17385

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) 


17390
17391
17392
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17390

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) 


17395
17396
17397
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17395

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17402
17403
17404
17405
17406
17407
17408
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17402

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