Class: Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource

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

Overview

The primary data source for local and online products.

Defined Under Namespace

Modules: Channel Classes: DefaultRule, Destination

Instance Attribute Summary collapse

Instance Attribute Details

#channel ⇒ ::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Channel

Returns Optional. Immutable. Specifies the type of data source channel.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb', line 86

class PrimaryProductDataSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default rule management of the data source.
  # @!attribute [rw] take_from_data_sources
  #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSourceReference>]
  #     Required. The list of data sources linked in the [default
  #     rule](https://support.google.com/merchants/answer/7450276).
  #     This list is ordered by the default rule priority of joining the data.
  #     It might include none or multiple references to `self` and supplemental
  #     data sources.
  #
  #     The list must not be empty.
  #
  #     To link the data source to the default rule, you need to add a
  #     new reference to this list (in sequential order).
  #
  #     To unlink the data source from the default rule, you need to
  #     remove the given reference from this list.
  #
  #     Changing the order of this list will result in changing the priority of
  #     data sources in the default rule.
  #
  #     For example, providing the following list: [`1001`, `self`] will
  #     take attribute values from supplemental data source `1001`, and fallback
  #     to `self` if the attribute is not set in `1001`.
  class DefaultRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destinations also known as [Marketing
  # methods](https://support.google.com/merchants/answer/15130232) selections.
  # @!attribute [rw] destination
  #   @return [::Google::Shopping::Type::Destination::DestinationEnum]
  #     [Marketing methods](https://support.google.com/merchants/answer/15130232)
  #     (also known as destination) selections.
  # @!attribute [rw] state
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination::State]
  #     The state of the destination.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the destination.
    module State
      # Not specified.
      STATE_UNSPECIFIED = 0

      # Indicates that the destination is enabled.
      ENABLED = 1

      # Indicates that the destination is disabled.
      DISABLED = 2
    end
  end

  # Data Source Channel.
  #
  # Channel is used to distinguish between data sources for different product
  # verticals.
  module Channel
    # Not specified.
    CHANNEL_UNSPECIFIED = 0

    # Online product.
    ONLINE_PRODUCTS = 1

    # Local product.
    LOCAL_PRODUCTS = 2

    # Unified data source for both local and online products.
    # Note: Products management through the API is not possible for this
    # channel.
    PRODUCTS = 3
  end
end

#content_language ⇒ ::String

Returns Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source.

feedLabel and contentLanguage must be either both set or unset. The fields can only be unset for data sources without file input.

If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.

Returns:

  • (::String) —

    Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source.

    feedLabel and contentLanguage must be either both set or unset. The fields can only be unset for data sources without file input.

    If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb', line 86

class PrimaryProductDataSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default rule management of the data source.
  # @!attribute [rw] take_from_data_sources
  #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSourceReference>]
  #     Required. The list of data sources linked in the [default
  #     rule](https://support.google.com/merchants/answer/7450276).
  #     This list is ordered by the default rule priority of joining the data.
  #     It might include none or multiple references to `self` and supplemental
  #     data sources.
  #
  #     The list must not be empty.
  #
  #     To link the data source to the default rule, you need to add a
  #     new reference to this list (in sequential order).
  #
  #     To unlink the data source from the default rule, you need to
  #     remove the given reference from this list.
  #
  #     Changing the order of this list will result in changing the priority of
  #     data sources in the default rule.
  #
  #     For example, providing the following list: [`1001`, `self`] will
  #     take attribute values from supplemental data source `1001`, and fallback
  #     to `self` if the attribute is not set in `1001`.
  class DefaultRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destinations also known as [Marketing
  # methods](https://support.google.com/merchants/answer/15130232) selections.
  # @!attribute [rw] destination
  #   @return [::Google::Shopping::Type::Destination::DestinationEnum]
  #     [Marketing methods](https://support.google.com/merchants/answer/15130232)
  #     (also known as destination) selections.
  # @!attribute [rw] state
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination::State]
  #     The state of the destination.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the destination.
    module State
      # Not specified.
      STATE_UNSPECIFIED = 0

      # Indicates that the destination is enabled.
      ENABLED = 1

      # Indicates that the destination is disabled.
      DISABLED = 2
    end
  end

  # Data Source Channel.
  #
  # Channel is used to distinguish between data sources for different product
  # verticals.
  module Channel
    # Not specified.
    CHANNEL_UNSPECIFIED = 0

    # Online product.
    ONLINE_PRODUCTS = 1

    # Local product.
    LOCAL_PRODUCTS = 2

    # Unified data source for both local and online products.
    # Note: Products management through the API is not possible for this
    # channel.
    PRODUCTS = 3
  end
end

#countries ⇒ ::Array<::String>

Returns Optional. The countries where the items may be displayed. Represented as a CLDR territory code.

Returns:

  • (::Array<::String>) —

    Optional. The countries where the items may be displayed. Represented as a CLDR territory code.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb', line 86

class PrimaryProductDataSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default rule management of the data source.
  # @!attribute [rw] take_from_data_sources
  #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSourceReference>]
  #     Required. The list of data sources linked in the [default
  #     rule](https://support.google.com/merchants/answer/7450276).
  #     This list is ordered by the default rule priority of joining the data.
  #     It might include none or multiple references to `self` and supplemental
  #     data sources.
  #
  #     The list must not be empty.
  #
  #     To link the data source to the default rule, you need to add a
  #     new reference to this list (in sequential order).
  #
  #     To unlink the data source from the default rule, you need to
  #     remove the given reference from this list.
  #
  #     Changing the order of this list will result in changing the priority of
  #     data sources in the default rule.
  #
  #     For example, providing the following list: [`1001`, `self`] will
  #     take attribute values from supplemental data source `1001`, and fallback
  #     to `self` if the attribute is not set in `1001`.
  class DefaultRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destinations also known as [Marketing
  # methods](https://support.google.com/merchants/answer/15130232) selections.
  # @!attribute [rw] destination
  #   @return [::Google::Shopping::Type::Destination::DestinationEnum]
  #     [Marketing methods](https://support.google.com/merchants/answer/15130232)
  #     (also known as destination) selections.
  # @!attribute [rw] state
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination::State]
  #     The state of the destination.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the destination.
    module State
      # Not specified.
      STATE_UNSPECIFIED = 0

      # Indicates that the destination is enabled.
      ENABLED = 1

      # Indicates that the destination is disabled.
      DISABLED = 2
    end
  end

  # Data Source Channel.
  #
  # Channel is used to distinguish between data sources for different product
  # verticals.
  module Channel
    # Not specified.
    CHANNEL_UNSPECIFIED = 0

    # Online product.
    ONLINE_PRODUCTS = 1

    # Local product.
    LOCAL_PRODUCTS = 2

    # Unified data source for both local and online products.
    # Note: Products management through the API is not possible for this
    # channel.
    PRODUCTS = 3
  end
end

#default_rule ⇒ ::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::DefaultRule

Returns Optional. Default rule management of the data source. If set, the linked data sources will be replaced.

Returns:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb', line 86

class PrimaryProductDataSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default rule management of the data source.
  # @!attribute [rw] take_from_data_sources
  #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSourceReference>]
  #     Required. The list of data sources linked in the [default
  #     rule](https://support.google.com/merchants/answer/7450276).
  #     This list is ordered by the default rule priority of joining the data.
  #     It might include none or multiple references to `self` and supplemental
  #     data sources.
  #
  #     The list must not be empty.
  #
  #     To link the data source to the default rule, you need to add a
  #     new reference to this list (in sequential order).
  #
  #     To unlink the data source from the default rule, you need to
  #     remove the given reference from this list.
  #
  #     Changing the order of this list will result in changing the priority of
  #     data sources in the default rule.
  #
  #     For example, providing the following list: [`1001`, `self`] will
  #     take attribute values from supplemental data source `1001`, and fallback
  #     to `self` if the attribute is not set in `1001`.
  class DefaultRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destinations also known as [Marketing
  # methods](https://support.google.com/merchants/answer/15130232) selections.
  # @!attribute [rw] destination
  #   @return [::Google::Shopping::Type::Destination::DestinationEnum]
  #     [Marketing methods](https://support.google.com/merchants/answer/15130232)
  #     (also known as destination) selections.
  # @!attribute [rw] state
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination::State]
  #     The state of the destination.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the destination.
    module State
      # Not specified.
      STATE_UNSPECIFIED = 0

      # Indicates that the destination is enabled.
      ENABLED = 1

      # Indicates that the destination is disabled.
      DISABLED = 2
    end
  end

  # Data Source Channel.
  #
  # Channel is used to distinguish between data sources for different product
  # verticals.
  module Channel
    # Not specified.
    CHANNEL_UNSPECIFIED = 0

    # Online product.
    ONLINE_PRODUCTS = 1

    # Local product.
    LOCAL_PRODUCTS = 2

    # Unified data source for both local and online products.
    # Note: Products management through the API is not possible for this
    # channel.
    PRODUCTS = 3
  end
end

#destinations ⇒ ::Array<::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination>

Returns Optional. A list of destinations describing where products of the data source can be shown.

When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account.

Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source.

If unset, during creation, the destinations will be inherited based on the account level program participation.

If set, during creation or update, the data source will be set only for the specified destinations.

Updating this field requires at least one destination.

Returns:

  • (::Array<::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination>) —

    Optional. A list of destinations describing where products of the data source can be shown.

    When retrieving the data source, the list contains all the destinations that can be used for the data source, including the ones that are disabled for the data source but enabled for the account.

    Only destinations that are enabled on the account, for example through program participation, can be enabled on the data source.

    If unset, during creation, the destinations will be inherited based on the account level program participation.

    If set, during creation or update, the data source will be set only for the specified destinations.

    Updating this field requires at least one destination.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb', line 86

class PrimaryProductDataSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default rule management of the data source.
  # @!attribute [rw] take_from_data_sources
  #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSourceReference>]
  #     Required. The list of data sources linked in the [default
  #     rule](https://support.google.com/merchants/answer/7450276).
  #     This list is ordered by the default rule priority of joining the data.
  #     It might include none or multiple references to `self` and supplemental
  #     data sources.
  #
  #     The list must not be empty.
  #
  #     To link the data source to the default rule, you need to add a
  #     new reference to this list (in sequential order).
  #
  #     To unlink the data source from the default rule, you need to
  #     remove the given reference from this list.
  #
  #     Changing the order of this list will result in changing the priority of
  #     data sources in the default rule.
  #
  #     For example, providing the following list: [`1001`, `self`] will
  #     take attribute values from supplemental data source `1001`, and fallback
  #     to `self` if the attribute is not set in `1001`.
  class DefaultRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destinations also known as [Marketing
  # methods](https://support.google.com/merchants/answer/15130232) selections.
  # @!attribute [rw] destination
  #   @return [::Google::Shopping::Type::Destination::DestinationEnum]
  #     [Marketing methods](https://support.google.com/merchants/answer/15130232)
  #     (also known as destination) selections.
  # @!attribute [rw] state
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination::State]
  #     The state of the destination.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the destination.
    module State
      # Not specified.
      STATE_UNSPECIFIED = 0

      # Indicates that the destination is enabled.
      ENABLED = 1

      # Indicates that the destination is disabled.
      DISABLED = 2
    end
  end

  # Data Source Channel.
  #
  # Channel is used to distinguish between data sources for different product
  # verticals.
  module Channel
    # Not specified.
    CHANNEL_UNSPECIFIED = 0

    # Online product.
    ONLINE_PRODUCTS = 1

    # Local product.
    LOCAL_PRODUCTS = 2

    # Unified data source for both local and online products.
    # Note: Products management through the API is not possible for this
    # channel.
    PRODUCTS = 3
  end
end

#feed_label ⇒ ::String

Returns Optional. Immutable. The feed label that is specified on the data source level.

Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).

See also migration to feed labels.

feedLabel and contentLanguage must be either both set or unset for data sources with product content type. They must be set for data sources with a file input.

If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.

Returns:

  • (::String) —

    Optional. Immutable. The feed label that is specified on the data source level.

    Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).

    See also migration to feed labels.

    feedLabel and contentLanguage must be either both set or unset for data sources with product content type. They must be set for data sources with a file input.

    If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/datasourcetypes.rb', line 86

class PrimaryProductDataSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Default rule management of the data source.
  # @!attribute [rw] take_from_data_sources
  #   @return [::Array<::Google::Shopping::Merchant::DataSources::V1beta::DataSourceReference>]
  #     Required. The list of data sources linked in the [default
  #     rule](https://support.google.com/merchants/answer/7450276).
  #     This list is ordered by the default rule priority of joining the data.
  #     It might include none or multiple references to `self` and supplemental
  #     data sources.
  #
  #     The list must not be empty.
  #
  #     To link the data source to the default rule, you need to add a
  #     new reference to this list (in sequential order).
  #
  #     To unlink the data source from the default rule, you need to
  #     remove the given reference from this list.
  #
  #     Changing the order of this list will result in changing the priority of
  #     data sources in the default rule.
  #
  #     For example, providing the following list: [`1001`, `self`] will
  #     take attribute values from supplemental data source `1001`, and fallback
  #     to `self` if the attribute is not set in `1001`.
  class DefaultRule
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Destinations also known as [Marketing
  # methods](https://support.google.com/merchants/answer/15130232) selections.
  # @!attribute [rw] destination
  #   @return [::Google::Shopping::Type::Destination::DestinationEnum]
  #     [Marketing methods](https://support.google.com/merchants/answer/15130232)
  #     (also known as destination) selections.
  # @!attribute [rw] state
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::PrimaryProductDataSource::Destination::State]
  #     The state of the destination.
  class Destination
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The state of the destination.
    module State
      # Not specified.
      STATE_UNSPECIFIED = 0

      # Indicates that the destination is enabled.
      ENABLED = 1

      # Indicates that the destination is disabled.
      DISABLED = 2
    end
  end

  # Data Source Channel.
  #
  # Channel is used to distinguish between data sources for different product
  # verticals.
  module Channel
    # Not specified.
    CHANNEL_UNSPECIFIED = 0

    # Online product.
    ONLINE_PRODUCTS = 1

    # Local product.
    LOCAL_PRODUCTS = 2

    # Unified data source for both local and online products.
    # Note: Products management through the API is not possible for this
    # channel.
    PRODUCTS = 3
  end
end