Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSearchLinkPromotion

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



19692
19693
19694
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19692

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) 


19667
19668
19669
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19667

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) 


19674
19675
19676
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19674

def enabled
  @enabled
end

#image_uri ⇒ String

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

Returns:

  • (String) 


19680
19681
19682
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19680

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) 


19685
19686
19687
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19685

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) 


19690
19691
19692
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19690

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19697
19698
19699
19700
19701
19702
19703
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 19697

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