Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion

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

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchLinkPromotion.



7869
7870
7871
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7869

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#descriptionString

Optional. The Promotion description. Maximum length: 200 characters. Corresponds to the JSON property description

Returns:

  • (String)


7844
7845
7846
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7844

def description
  @description
end

#enabledBoolean 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)


7851
7852
7853
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7851

def enabled
  @enabled
end

#image_uriString

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

Returns:

  • (String)


7857
7858
7859
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7857

def image_uri
  @image_uri
end

#titleString

Required. The title of the promotion. Maximum length: 160 characters. Corresponds to the JSON property title

Returns:

  • (String)


7862
7863
7864
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7862

def title
  @title
end

#uriString

Required. The URL for the page the user wants to promote. Corresponds to the JSON property uri

Returns:

  • (String)


7867
7868
7869
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7867

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7874
7875
7876
7877
7878
7879
7880
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 7874

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