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.



19044
19045
19046
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19044

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)


19019
19020
19021
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19019

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)


19026
19027
19028
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19026

def enabled
  @enabled
end

#image_uriString

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

Returns:

  • (String)


19032
19033
19034
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19032

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)


19037
19038
19039
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19037

def title
  @title
end

#uriString

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

Returns:

  • (String)


19042
19043
19044
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19042

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19049
19050
19051
19052
19053
19054
19055
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 19049

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