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.



8426
8427
8428
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8426

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)


8401
8402
8403
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8401

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)


8408
8409
8410
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8408

def enabled
  @enabled
end

#image_uriString

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

Returns:

  • (String)


8414
8415
8416
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8414

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)


8419
8420
8421
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8419

def title
  @title
end

#uriString

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

Returns:

  • (String)


8424
8425
8426
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8424

def uri
  @uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8431
8432
8433
8434
8435
8436
8437
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 8431

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