# Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::SearchLinkPromotion (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchLinkPromotion.

Promotion proto includes uri and other helping information to display the
promotion.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #description

    def description() -> ::String

**Returns**

- (::String) --- Optional. The Promotion description. Maximum length: 200 characters.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The Promotion description. Maximum length: 200 characters.
**Returns**

- (::String) --- Optional. The Promotion description. Maximum length: 200 characters.

### #document

    def document() -> ::String

**Returns**

- (::String) --- Optional. The [Document](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document "Google::Cloud::DiscoveryEngine::V1beta::Document (class)") the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.

### #document=

    def document=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The [Document](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document "Google::Cloud::DiscoveryEngine::V1beta::Document (class)") the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.
**Returns**

- (::String) --- Optional. The [Document](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1beta/latest/Google-Cloud-DiscoveryEngine-V1beta-Document "Google::Cloud::DiscoveryEngine::V1beta::Document (class)") the user wants to promote. For site search, leave unset and only populate uri. Can be set along with uri.

### #enabled

    def enabled() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #enabled=

    def enabled=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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.
**Returns**

- (::Boolean) --- 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.

### #image_uri

    def image_uri() -> ::String

**Returns**

- (::String) --- Optional. The promotion thumbnail image url.

### #image_uri=

    def image_uri=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The promotion thumbnail image url.
**Returns**

- (::String) --- Optional. The promotion thumbnail image url.

### #title

    def title() -> ::String

**Returns**

- (::String) --- Required. The title of the promotion. Maximum length: 160 characters.

### #title=

    def title=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The title of the promotion. Maximum length: 160 characters.
**Returns**

- (::String) --- Required. The title of the promotion. Maximum length: 160 characters.

### #uri

    def uri() -> ::String

**Returns**

- (::String) --- Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.

### #uri=

    def uri=(value) -> ::String

**Parameter**

- **value** (::String) --- Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.
**Returns**

- (::String) --- Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.