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.



17313
17314
17315
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17313

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) 


17288
17289
17290
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17288

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) 


17295
17296
17297
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17295

def enabled
  @enabled
end

#image_uri ⇒ String

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

Returns:

  • (String) 


17301
17302
17303
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17301

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) 


17306
17307
17308
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17306

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) 


17311
17312
17313
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17311

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17318
17319
17320
17321
17322
17323
17324
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 17318

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