Class: Google::Shopping::Merchant::DataSources::V1beta::FileInput

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

Overview

The data specific for file data sources. This field is empty for other data source inputs.

Defined Under Namespace

Modules: FileInputType Classes: FetchSettings

Instance Attribute Summary collapse

Instance Attribute Details

#fetch_settings ⇒ ::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings

Returns Optional. Fetch details to deliver the data source. It contains settings for FETCH and GOOGLE_SHEETS file input types. The required fields vary based on the frequency of fetching.

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 39

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

  # Fetch details to deliver the data source.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Enables or pauses the fetch schedule.
  # @!attribute [rw] day_of_month
  #   @return [::Integer]
  #     Optional. The day of the month when the data source file should be
  #     fetched (1-31). This field can only be set for monthly frequency.
  # @!attribute [rw] time_of_day
  #   @return [::Google::Type::TimeOfDay]
  #     Optional. The hour of the day when the data source file should be
  #     fetched. Minutes and seconds are not supported and will be ignored.
  # @!attribute [rw] day_of_week
  #   @return [::Google::Type::DayOfWeek]
  #     Optional. The day of the week when the data source file should be
  #     fetched. This field can only be set for weekly frequency.
  # @!attribute [rw] time_zone
  #   @return [::String]
  #     Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by
  #     default. For example, "America/Los_Angeles".
  # @!attribute [rw] frequency
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings::Frequency]
  #     Required. The frequency describing fetch schedule.
  # @!attribute [rw] fetch_uri
  #   @return [::String]
  #     Optional. The URL where the data source file can be fetched. Google
  #     Merchant Center supports automatic scheduled uploads using the HTTP,
  #     HTTPS or SFTP protocols, so the value will need to be a valid link using
  #     one of those three protocols. Immutable for Google Sheets files.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. An optional user name for
  #     {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
  #     Used for [submitting data sources through
  #     SFTP](https://support.google.com/merchants/answer/13813117).
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. An optional password for
  #     {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
  #     Used for [submitting data sources through
  #     SFTP](https://support.google.com/merchants/answer/13813117).
  class FetchSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The required fields vary based on the frequency of fetching. For a
    # monthly
    # fetch schedule,
    # [day of
    # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
    # and
    # [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # are required. For a weekly fetch schedule,
    # [day of
    # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
    # and [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # are required. For a daily fetch schedule, only an [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # is required.
    module Frequency
      # Frequency unspecified.
      FREQUENCY_UNSPECIFIED = 0

      # The fetch happens every day.
      FREQUENCY_DAILY = 1

      # The fetch happens every week.
      FREQUENCY_WEEKLY = 2

      # The fetch happens every month.
      FREQUENCY_MONTHLY = 3
    end
  end

  # The method of file delivery.
  module FileInputType
    # File input type unspecified.
    FILE_INPUT_TYPE_UNSPECIFIED = 0

    # The file is uploaded through SFTP, Google Cloud Storage or manually in
    # the Merchant Center.
    UPLOAD = 1

    # The file is fetched from the configured
    # {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
    FETCH = 2

    # The file is fetched from Google Sheets specified in the
    # {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
    GOOGLE_SHEETS = 3
  end
end

#file_input_type ⇒ ::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FileInputType (readonly)

Returns Output only. The type of file input.

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 39

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

  # Fetch details to deliver the data source.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Enables or pauses the fetch schedule.
  # @!attribute [rw] day_of_month
  #   @return [::Integer]
  #     Optional. The day of the month when the data source file should be
  #     fetched (1-31). This field can only be set for monthly frequency.
  # @!attribute [rw] time_of_day
  #   @return [::Google::Type::TimeOfDay]
  #     Optional. The hour of the day when the data source file should be
  #     fetched. Minutes and seconds are not supported and will be ignored.
  # @!attribute [rw] day_of_week
  #   @return [::Google::Type::DayOfWeek]
  #     Optional. The day of the week when the data source file should be
  #     fetched. This field can only be set for weekly frequency.
  # @!attribute [rw] time_zone
  #   @return [::String]
  #     Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by
  #     default. For example, "America/Los_Angeles".
  # @!attribute [rw] frequency
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings::Frequency]
  #     Required. The frequency describing fetch schedule.
  # @!attribute [rw] fetch_uri
  #   @return [::String]
  #     Optional. The URL where the data source file can be fetched. Google
  #     Merchant Center supports automatic scheduled uploads using the HTTP,
  #     HTTPS or SFTP protocols, so the value will need to be a valid link using
  #     one of those three protocols. Immutable for Google Sheets files.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. An optional user name for
  #     {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
  #     Used for [submitting data sources through
  #     SFTP](https://support.google.com/merchants/answer/13813117).
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. An optional password for
  #     {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
  #     Used for [submitting data sources through
  #     SFTP](https://support.google.com/merchants/answer/13813117).
  class FetchSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The required fields vary based on the frequency of fetching. For a
    # monthly
    # fetch schedule,
    # [day of
    # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
    # and
    # [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # are required. For a weekly fetch schedule,
    # [day of
    # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
    # and [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # are required. For a daily fetch schedule, only an [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # is required.
    module Frequency
      # Frequency unspecified.
      FREQUENCY_UNSPECIFIED = 0

      # The fetch happens every day.
      FREQUENCY_DAILY = 1

      # The fetch happens every week.
      FREQUENCY_WEEKLY = 2

      # The fetch happens every month.
      FREQUENCY_MONTHLY = 3
    end
  end

  # The method of file delivery.
  module FileInputType
    # File input type unspecified.
    FILE_INPUT_TYPE_UNSPECIFIED = 0

    # The file is uploaded through SFTP, Google Cloud Storage or manually in
    # the Merchant Center.
    UPLOAD = 1

    # The file is fetched from the configured
    # {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
    FETCH = 2

    # The file is fetched from Google Sheets specified in the
    # {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
    GOOGLE_SHEETS = 3
  end
end

#file_name ⇒ ::String

Returns Optional. The file name of the data source. Required for UPLOAD file input type.

Returns:

  • (::String) —

    Optional. The file name of the data source. Required for UPLOAD file input type.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
 
# File 'proto_docs/google/shopping/merchant/datasources/v1beta/fileinputs.rb', line 39

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

  # Fetch details to deliver the data source.
  # @!attribute [rw] enabled
  #   @return [::Boolean]
  #     Optional. Enables or pauses the fetch schedule.
  # @!attribute [rw] day_of_month
  #   @return [::Integer]
  #     Optional. The day of the month when the data source file should be
  #     fetched (1-31). This field can only be set for monthly frequency.
  # @!attribute [rw] time_of_day
  #   @return [::Google::Type::TimeOfDay]
  #     Optional. The hour of the day when the data source file should be
  #     fetched. Minutes and seconds are not supported and will be ignored.
  # @!attribute [rw] day_of_week
  #   @return [::Google::Type::DayOfWeek]
  #     Optional. The day of the week when the data source file should be
  #     fetched. This field can only be set for weekly frequency.
  # @!attribute [rw] time_zone
  #   @return [::String]
  #     Optional. [Time zone](https://cldr.unicode.org) used for schedule. UTC by
  #     default. For example, "America/Los_Angeles".
  # @!attribute [rw] frequency
  #   @return [::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings::Frequency]
  #     Required. The frequency describing fetch schedule.
  # @!attribute [rw] fetch_uri
  #   @return [::String]
  #     Optional. The URL where the data source file can be fetched. Google
  #     Merchant Center supports automatic scheduled uploads using the HTTP,
  #     HTTPS or SFTP protocols, so the value will need to be a valid link using
  #     one of those three protocols. Immutable for Google Sheets files.
  # @!attribute [rw] username
  #   @return [::String]
  #     Optional. An optional user name for
  #     {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
  #     Used for [submitting data sources through
  #     SFTP](https://support.google.com/merchants/answer/13813117).
  # @!attribute [rw] password
  #   @return [::String]
  #     Optional. An optional password for
  #     {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
  #     Used for [submitting data sources through
  #     SFTP](https://support.google.com/merchants/answer/13813117).
  class FetchSettings
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The required fields vary based on the frequency of fetching. For a
    # monthly
    # fetch schedule,
    # [day of
    # month][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_month]
    # and
    # [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # are required. For a weekly fetch schedule,
    # [day of
    # week][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.day_of_week]
    # and [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # are required. For a daily fetch schedule, only an [hour of
    # day][google.shopping.content.bundles.DataSources.FileInput.FetchSchedule.time_of_day]
    # is required.
    module Frequency
      # Frequency unspecified.
      FREQUENCY_UNSPECIFIED = 0

      # The fetch happens every day.
      FREQUENCY_DAILY = 1

      # The fetch happens every week.
      FREQUENCY_WEEKLY = 2

      # The fetch happens every month.
      FREQUENCY_MONTHLY = 3
    end
  end

  # The method of file delivery.
  module FileInputType
    # File input type unspecified.
    FILE_INPUT_TYPE_UNSPECIFIED = 0

    # The file is uploaded through SFTP, Google Cloud Storage or manually in
    # the Merchant Center.
    UPLOAD = 1

    # The file is fetched from the configured
    # {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
    FETCH = 2

    # The file is fetched from Google Sheets specified in the
    # {::Google::Shopping::Merchant::DataSources::V1beta::FileInput::FetchSettings#fetch_uri fetch_uri}.
    GOOGLE_SHEETS = 3
  end
end