Class: Google::Shopping::Merchant::Promotions::V1beta::Promotion

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb

Overview

Represents a promotion. See the following articles for more details.

Required promotion input attributes to pass data validation checks are primarily defined below:

After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::Attributes

Returns Optional. A list of promotion attributes.

Returns:



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#content_language ⇒ ::String

Returns Required. The two-letter ISO 639-1 language code for the promotion.

Promotions is only for selected languages.

Returns:



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#custom_attributes ⇒ ::Array<::Google::Shopping::Type::CustomAttribute>

Returns Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.

Returns:

  • (::Array<::Google::Shopping::Type::CustomAttribute>) —

    Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API.



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_source ⇒ ::String (readonly)

Returns Output only. The primary data source of the promotion.

Returns:

  • (::String) —

    Output only. The primary data source of the promotion.



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Identifier. The name of the promotion. Format: accounts/{account}/promotions/{promotion}.

Returns:

  • (::String) —

    Identifier. The name of the promotion. Format: accounts/{account}/promotions/{promotion}



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#promotion_id ⇒ ::String

Returns Required. The user provided promotion ID to uniquely identify the promotion. Follow minimum requirements to prevent promotion disapprovals.

Returns:

  • (::String) —

    Required. The user provided promotion ID to uniquely identify the promotion. Follow minimum requirements to prevent promotion disapprovals.



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#promotion_status ⇒ ::Google::Shopping::Merchant::Promotions::V1beta::PromotionStatus (readonly)

Returns Output only. The status of a promotion, data validation issues, that is, information about a promotion computed asynchronously.

Returns:



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#redemption_channel ⇒ ::Array<::Google::Shopping::Merchant::Promotions::V1beta::RedemptionChannel>

Returns Required. Redemption channel for the promotion. At least one channel is required.

Returns:



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#target_country ⇒ ::String

Returns Required. The target country used as part of the unique identifier. Represented as a CLDR territory code.

Promotions are only available in selected countries, Free Listings and Shopping ads Local Inventory ads.

Returns:



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#version_number ⇒ ::Integer

Returns Optional. Represents the existing version (freshness) of the promotion, which can be used to preserve the right order when multiple updates are done at the same time.

If set, the insertion is prevented when version number is lower than the current version number of the existing promotion. Re-insertion (for example, promotion refresh after 30 days) can be performed with the current version_number.

If the operation is prevented, the aborted exception will be thrown.

Returns:

  • (::Integer) —

    Optional. Represents the existing version (freshness) of the promotion, which can be used to preserve the right order when multiple updates are done at the same time.

    If set, the insertion is prevented when version number is lower than the current version number of the existing promotion. Re-insertion (for example, promotion refresh after 30 days) can be performed with the current version_number.

    If the operation is prevented, the aborted exception will be thrown.



103
104
105
106
 
# File 'proto_docs/google/shopping/merchant/promotions/v1beta/promotions.rb', line 103

class Promotion
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end