Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1SearchLinkPromotion

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

Returns a new instance of GoogleCloudDiscoveryengineV1SearchLinkPromotion.



2686
2687
2688
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2686

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) 


2661
2662
2663
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2661

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) 


2668
2669
2670
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2668

def enabled
  @enabled
end

#image_uri ⇒ String

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

Returns:

  • (String) 


2674
2675
2676
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2674

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) 


2679
2680
2681
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2679

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) 


2684
2685
2686
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2684

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2691
2692
2693
2694
2695
2696
2697
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2691

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