Class: Google::Shopping::Merchant::Products::V1::Product

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

Overview

The processed product, built from multiple [product inputs][google.shopping.merchant.products.v1main.ProductInput] after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

All fields in the processed product and its sub-messages match the name of their corresponding attribute in the Product data specification with some exceptions.

Instance Attribute Summary collapse

Instance Attribute Details

#automated_discounts ⇒ ::Google::Shopping::Merchant::Products::V1::AutomatedDiscounts (readonly)

Returns Output only. The automated discounts information for the product.

Returns:



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#content_language ⇒ ::String (readonly)

Returns Output only. The two-letter ISO 639-1 language code for the product.

Returns:

  • (::String) —

    Output only. The two-letter ISO 639-1 language code for the product.



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#custom_attributes ⇒ ::Array<::Google::Shopping::Type::CustomAttribute> (readonly)

Returns Output only. A list of custom (merchant-provided) attributes. It can also be used to submit 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, such as additional attributes used for Buy on Google.

Returns:

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

    Output only. A list of custom (merchant-provided) attributes. It can also be used to submit 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, such as additional attributes used for Buy on Google.



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#data_source ⇒ ::String (readonly)

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

Returns:

  • (::String) —

    Output only. The primary data source of the product.



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#feed_label ⇒ ::String (readonly)

Returns Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters areA-Z, 0-9, hyphen and underscore. The feed label must not include any spaces. For more information, see Using feed labels.

Returns:

  • (::String) —

    Output only. The feed label lets you categorize and identify your products. The maximum allowed characters is 20 and the supported characters areA-Z, 0-9, hyphen and underscore. The feed label must not include any spaces. For more information, see Using feed labels



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#legacy_local ⇒ ::Boolean (readonly)

Returns Output only. Determines whether the product is only targeting local destinations and whether the product name should be distinguished with a local~ prefix. For example, accounts/123/products/local~en~US~sku123.

Returns:

  • (::Boolean) —

    Output only. Determines whether the product is only targeting local destinations and whether the product name should be distinguished with a local~ prefix. For example, accounts/123/products/local~en~US~sku123.



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#name ⇒ ::String

Returns The name of the product. Format: accounts/{account}/products/{product} where the last section product consists of: content_language~feed_label~offer_id example for product name is accounts/123/products/en~US~sku123. A legacy local product name would be accounts/123/products/local~en~US~sku123. Note: For calls to the v1beta version, the product section consists of: channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.

Returns:

  • (::String) —

    The name of the product. Format: accounts/{account}/products/{product} where the last section product consists of: content_language~feed_label~offer_id example for product name is accounts/123/products/en~US~sku123. A legacy local product name would be accounts/123/products/local~en~US~sku123. Note: For calls to the v1beta version, the product section consists of: channel~content_language~feed_label~offer_id, for example: accounts/123/products/online~en~US~sku123.



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#offer_id ⇒ ::String (readonly)

Returns Output only. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the product data specification for details.

Returns:

  • (::String) —

    Output only. Your unique identifier for the product. This is the same for the product input and processed product. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. See the product data specification for details.



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#product_attributes ⇒ ::Google::Shopping::Merchant::Products::V1::ProductAttributes (readonly)

Returns Output only. A list of strongly-typed product attributes.

Returns:



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#product_status ⇒ ::Google::Shopping::Merchant::Products::V1::ProductStatus (readonly)

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

Returns:



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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

#version_number ⇒ ::Integer (readonly)

Returns Output only. Represents the existing version (freshness) of the product, 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 product. Re-insertion (for example, product refresh after 30 days) can be performed with the current version_number.

Only supported for insertions into primary data sources.

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

Returns:

  • (::Integer) —

    Output only. Represents the existing version (freshness) of the product, 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 product. Re-insertion (for example, product refresh after 30 days) can be performed with the current version_number.

    Only supported for insertions into primary data sources.

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



112
113
114
115
 
# File 'proto_docs/google/shopping/merchant/products/v1/products.rb', line 112

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