google-apis-businessprofileperformance_v1 0.7.0 → 0.8.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 40346f4b2bfb6a62e5ba251db6cf39213c77f7a724855dd62a67745fdd3a6c9d
4
- data.tar.gz: 67a6c1e35a04342922c8700264a061a8aeaa66465ab223d48c8f71d06e7637f2
3
+ metadata.gz: 4e0dba98b79d1006955ae0d705ce22d624e33a2a7fe3c04f528060f982f57a3b
4
+ data.tar.gz: 82a999878573841b15d4447418b17c157cdf02c24affa7f6b727d0852c15b46e
5
5
  SHA512:
6
- metadata.gz: 6e9138d10c1c34a8a13779f4d1c8c09e5428e94a5cfcfa202ffb7104b0164d1636ab236f88afacbcc2cca2f02294dc983e4b84fb0fcc8d97bbd534fb78a27bc1
7
- data.tar.gz: 5aa602c41a02e1a3a2f096dc411ff4892775b073fe068f2a3b80adb45563267bfa334c781075592630e590ca9016d82a40e24c08753d2066738a998060de6143
6
+ metadata.gz: a821e21017e0f767afdcd190ce16ff681b6fe0299d46499fb3162719668d4b3545ba652061ce418fa90425dcda9d9b81dcc123717e184a9ef17ad7cfc1f859aa
7
+ data.tar.gz: 5a0cd92bcf00adfec67cbd6a42abdc0e7dfb6cebd7a1d443fa5ac5c32d66cff697c4d8abb3b0d4a22f1ebef29c15a725f96d49183299a5d20cd82fbecfe8d413
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release history for google-apis-businessprofileperformance_v1
2
2
 
3
+ ### v0.8.0 (2023-03-12)
4
+
5
+ * Regenerated from discovery document revision 20230308
6
+
3
7
  ### v0.7.0 (2023-02-19)
4
8
 
5
9
  * Regenerated from discovery document revision 20230215
@@ -22,6 +22,65 @@ module Google
22
22
  module Apis
23
23
  module BusinessprofileperformanceV1
24
24
 
25
+ # Represents a single datapoint, where each datapoint is a DailyMetric-
26
+ # DailySubEntityType-TimeSeries tuple.
27
+ class DailyMetricTimeSeries
28
+ include Google::Apis::Core::Hashable
29
+
30
+ # The DailyMetric that the TimeSeries represents.
31
+ # Corresponds to the JSON property `dailyMetric`
32
+ # @return [String]
33
+ attr_accessor :daily_metric
34
+
35
+ # Represents all possible subentity types that are associated with DailyMetrics.
36
+ # Corresponds to the JSON property `dailySubEntityType`
37
+ # @return [Google::Apis::BusinessprofileperformanceV1::DailySubEntityType]
38
+ attr_accessor :daily_sub_entity_type
39
+
40
+ # Represents a timeseries.
41
+ # Corresponds to the JSON property `timeSeries`
42
+ # @return [Google::Apis::BusinessprofileperformanceV1::TimeSeries]
43
+ attr_accessor :time_series
44
+
45
+ def initialize(**args)
46
+ update!(**args)
47
+ end
48
+
49
+ # Update properties of this object
50
+ def update!(**args)
51
+ @daily_metric = args[:daily_metric] if args.key?(:daily_metric)
52
+ @daily_sub_entity_type = args[:daily_sub_entity_type] if args.key?(:daily_sub_entity_type)
53
+ @time_series = args[:time_series] if args.key?(:time_series)
54
+ end
55
+ end
56
+
57
+ # Represents all possible subentity types that are associated with DailyMetrics.
58
+ class DailySubEntityType
59
+ include Google::Apis::Core::Hashable
60
+
61
+ # Represents the day of the week. Eg: MONDAY.
62
+ # Corresponds to the JSON property `dayOfWeek`
63
+ # @return [String]
64
+ attr_accessor :day_of_week
65
+
66
+ # Represents a time of day. The date and time zone are either not significant or
67
+ # are specified elsewhere. An API may choose to allow leap seconds. Related
68
+ # types are google.type.Date and `google.protobuf.Timestamp`.
69
+ # Corresponds to the JSON property `timeOfDay`
70
+ # @return [Google::Apis::BusinessprofileperformanceV1::TimeOfDay]
71
+ attr_accessor :time_of_day
72
+
73
+ def initialize(**args)
74
+ update!(**args)
75
+ end
76
+
77
+ # Update properties of this object
78
+ def update!(**args)
79
+ @day_of_week = args[:day_of_week] if args.key?(:day_of_week)
80
+ @time_of_day = args[:time_of_day] if args.key?(:time_of_day)
81
+ end
82
+ end
83
+
25
84
  # Represents a whole or partial calendar date, such as a birthday. The time of
26
85
  # day and time zone are either specified elsewhere or are insignificant. The
27
86
  # date is relative to the Gregorian Calendar. This can represent one of the
@@ -96,6 +155,25 @@ module Google
96
155
  end
97
156
  end
98
157
 
158
+ # Represents the response for FetchMultiDailyMetricsTimeSeries.
159
+ class FetchMultiDailyMetricsTimeSeriesResponse
160
+ include Google::Apis::Core::Hashable
161
+
162
+ # DailyMetrics and their corresponding time series.
163
+ # Corresponds to the JSON property `multiDailyMetricTimeSeries`
164
+ # @return [Array<Google::Apis::BusinessprofileperformanceV1::MultiDailyMetricTimeSeries>]
165
+ attr_accessor :multi_daily_metric_time_series
166
+
167
+ def initialize(**args)
168
+ update!(**args)
169
+ end
170
+
171
+ # Update properties of this object
172
+ def update!(**args)
173
+ @multi_daily_metric_time_series = args[:multi_daily_metric_time_series] if args.key?(:multi_daily_metric_time_series)
174
+ end
175
+ end
176
+
99
177
  # Represents the response for GetDailyMetricsTimeSeries.
100
178
  class GetDailyMetricsTimeSeriesResponse
101
179
  include Google::Apis::Core::Hashable
@@ -168,6 +246,25 @@ module Google
168
246
  end
169
247
  end
170
248
 
249
+ # Represents a list of tuples of DailyMetric-DailySubEntityType-TimeSeries.
250
+ class MultiDailyMetricTimeSeries
251
+ include Google::Apis::Core::Hashable
252
+
253
+ # List of DailyMetric-TimeSeries pairs.
254
+ # Corresponds to the JSON property `dailyMetricTimeSeries`
255
+ # @return [Array<Google::Apis::BusinessprofileperformanceV1::DailyMetricTimeSeries>]
256
+ attr_accessor :daily_metric_time_series
257
+
258
+ def initialize(**args)
259
+ update!(**args)
260
+ end
261
+
262
+ # Update properties of this object
263
+ def update!(**args)
264
+ @daily_metric_time_series = args[:daily_metric_time_series] if args.key?(:daily_metric_time_series)
265
+ end
266
+ end
267
+
171
268
  # Represents a single search keyword and its value.
172
269
  class SearchKeywordCount
173
270
  include Google::Apis::Core::Hashable
@@ -193,6 +290,47 @@ module Google
193
290
  end
194
291
  end
195
292
 
293
+ # Represents a time of day. The date and time zone are either not significant or
294
+ # are specified elsewhere. An API may choose to allow leap seconds. Related
295
+ # types are google.type.Date and `google.protobuf.Timestamp`.
296
+ class TimeOfDay
297
+ include Google::Apis::Core::Hashable
298
+
299
+ # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to
300
+ # allow the value "24:00:00" for scenarios like business closing time.
301
+ # Corresponds to the JSON property `hours`
302
+ # @return [Fixnum]
303
+ attr_accessor :hours
304
+
305
+ # Minutes of hour of day. Must be from 0 to 59.
306
+ # Corresponds to the JSON property `minutes`
307
+ # @return [Fixnum]
308
+ attr_accessor :minutes
309
+
310
+ # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
311
+ # Corresponds to the JSON property `nanos`
312
+ # @return [Fixnum]
313
+ attr_accessor :nanos
314
+
315
+ # Seconds of minutes of the time. Must normally be from 0 to 59. An API may
316
+ # allow the value 60 if it allows leap-seconds.
317
+ # Corresponds to the JSON property `seconds`
318
+ # @return [Fixnum]
319
+ attr_accessor :seconds
320
+
321
+ def initialize(**args)
322
+ update!(**args)
323
+ end
324
+
325
+ # Update properties of this object
326
+ def update!(**args)
327
+ @hours = args[:hours] if args.key?(:hours)
328
+ @minutes = args[:minutes] if args.key?(:minutes)
329
+ @nanos = args[:nanos] if args.key?(:nanos)
330
+ @seconds = args[:seconds] if args.key?(:seconds)
331
+ end
332
+ end
333
+
196
334
  # Represents a timeseries.
197
335
  class TimeSeries
198
336
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module BusinessprofileperformanceV1
18
18
  # Version of the google-apis-businessprofileperformance_v1 gem
19
- GEM_VERSION = "0.7.0"
19
+ GEM_VERSION = "0.8.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
22
  GENERATOR_VERSION = "0.12.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20230215"
25
+ REVISION = "20230308"
26
26
  end
27
27
  end
28
28
  end
@@ -22,6 +22,18 @@ module Google
22
22
  module Apis
23
23
  module BusinessprofileperformanceV1
24
24
 
25
+ class DailyMetricTimeSeries
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class DailySubEntityType
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
25
37
  class Date
26
38
  class Representation < Google::Apis::Core::JsonRepresentation; end
27
39
 
@@ -34,6 +46,12 @@ module Google
34
46
  include Google::Apis::Core::JsonObjectSupport
35
47
  end
36
48
 
49
+ class FetchMultiDailyMetricsTimeSeriesResponse
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
37
55
  class GetDailyMetricsTimeSeriesResponse
38
56
  class Representation < Google::Apis::Core::JsonRepresentation; end
39
57
 
@@ -52,18 +70,50 @@ module Google
52
70
  include Google::Apis::Core::JsonObjectSupport
53
71
  end
54
72
 
73
+ class MultiDailyMetricTimeSeries
74
+ class Representation < Google::Apis::Core::JsonRepresentation; end
75
+
76
+ include Google::Apis::Core::JsonObjectSupport
77
+ end
78
+
55
79
  class SearchKeywordCount
56
80
  class Representation < Google::Apis::Core::JsonRepresentation; end
57
81
 
58
82
  include Google::Apis::Core::JsonObjectSupport
59
83
  end
60
84
 
85
+ class TimeOfDay
86
+ class Representation < Google::Apis::Core::JsonRepresentation; end
87
+
88
+ include Google::Apis::Core::JsonObjectSupport
89
+ end
90
+
61
91
  class TimeSeries
62
92
  class Representation < Google::Apis::Core::JsonRepresentation; end
63
93
 
64
94
  include Google::Apis::Core::JsonObjectSupport
65
95
  end
66
96
 
97
+ class DailyMetricTimeSeries
98
+ # @private
99
+ class Representation < Google::Apis::Core::JsonRepresentation
100
+ property :daily_metric, as: 'dailyMetric'
101
+ property :daily_sub_entity_type, as: 'dailySubEntityType', class: Google::Apis::BusinessprofileperformanceV1::DailySubEntityType, decorator: Google::Apis::BusinessprofileperformanceV1::DailySubEntityType::Representation
102
+
103
+ property :time_series, as: 'timeSeries', class: Google::Apis::BusinessprofileperformanceV1::TimeSeries, decorator: Google::Apis::BusinessprofileperformanceV1::TimeSeries::Representation
104
+
105
+ end
106
+ end
107
+
108
+ class DailySubEntityType
109
+ # @private
110
+ class Representation < Google::Apis::Core::JsonRepresentation
111
+ property :day_of_week, as: 'dayOfWeek'
112
+ property :time_of_day, as: 'timeOfDay', class: Google::Apis::BusinessprofileperformanceV1::TimeOfDay, decorator: Google::Apis::BusinessprofileperformanceV1::TimeOfDay::Representation
113
+
114
+ end
115
+ end
116
+
67
117
  class Date
68
118
  # @private
69
119
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -82,6 +132,14 @@ module Google
82
132
  end
83
133
  end
84
134
 
135
+ class FetchMultiDailyMetricsTimeSeriesResponse
136
+ # @private
137
+ class Representation < Google::Apis::Core::JsonRepresentation
138
+ collection :multi_daily_metric_time_series, as: 'multiDailyMetricTimeSeries', class: Google::Apis::BusinessprofileperformanceV1::MultiDailyMetricTimeSeries, decorator: Google::Apis::BusinessprofileperformanceV1::MultiDailyMetricTimeSeries::Representation
139
+
140
+ end
141
+ end
142
+
85
143
  class GetDailyMetricsTimeSeriesResponse
86
144
  # @private
87
145
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -107,6 +165,14 @@ module Google
107
165
  end
108
166
  end
109
167
 
168
+ class MultiDailyMetricTimeSeries
169
+ # @private
170
+ class Representation < Google::Apis::Core::JsonRepresentation
171
+ collection :daily_metric_time_series, as: 'dailyMetricTimeSeries', class: Google::Apis::BusinessprofileperformanceV1::DailyMetricTimeSeries, decorator: Google::Apis::BusinessprofileperformanceV1::DailyMetricTimeSeries::Representation
172
+
173
+ end
174
+ end
175
+
110
176
  class SearchKeywordCount
111
177
  # @private
112
178
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -116,6 +182,16 @@ module Google
116
182
  end
117
183
  end
118
184
 
185
+ class TimeOfDay
186
+ # @private
187
+ class Representation < Google::Apis::Core::JsonRepresentation
188
+ property :hours, as: 'hours'
189
+ property :minutes, as: 'minutes'
190
+ property :nanos, as: 'nanos'
191
+ property :seconds, as: 'seconds'
192
+ end
193
+ end
194
+
119
195
  class TimeSeries
120
196
  # @private
121
197
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -51,6 +51,70 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
+ # Returns the values for each date from a given time range and optionally the
55
+ # sub entity type, where applicable, that are associated with the specific daily
56
+ # metrics. Example request: `GET https://businessprofileperformance.googleapis.
57
+ # com/v1/locations/12345:fetchMultiDailyMetricsTimeSeries?dailyMetrics=
58
+ # WEBSITE_CLICKS&dailyMetrics=CALL_CLICKS&daily_range.start_date.year=2022&
59
+ # daily_range.start_date.month=1&daily_range.start_date.day=1&daily_range.
60
+ # end_date.year=2022&daily_range.end_date.month=3&daily_range.end_date.day=31`
61
+ # @param [String] location
62
+ # Required. The location for which the time series should be fetched. Format:
63
+ # locations/`location_id` where location_id is an unobfuscated listing id.
64
+ # @param [Array<String>, String] daily_metrics
65
+ # Required. The metrics to retrieve time series for.
66
+ # @param [Fixnum] daily_range_end_date_day
67
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
68
+ # specify a year by itself or a year and month where the day isn't significant.
69
+ # @param [Fixnum] daily_range_end_date_month
70
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
71
+ # and day.
72
+ # @param [Fixnum] daily_range_end_date_year
73
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
74
+ # year.
75
+ # @param [Fixnum] daily_range_start_date_day
76
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
77
+ # specify a year by itself or a year and month where the day isn't significant.
78
+ # @param [Fixnum] daily_range_start_date_month
79
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
80
+ # and day.
81
+ # @param [Fixnum] daily_range_start_date_year
82
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
83
+ # year.
84
+ # @param [String] fields
85
+ # Selector specifying which fields to include in a partial response.
86
+ # @param [String] quota_user
87
+ # Available to use for quota purposes for server-side applications. Can be any
88
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
89
+ # @param [Google::Apis::RequestOptions] options
90
+ # Request-specific options
91
+ #
92
+ # @yield [result, err] Result & error if block supplied
93
+ # @yieldparam result [Google::Apis::BusinessprofileperformanceV1::FetchMultiDailyMetricsTimeSeriesResponse] parsed result object
94
+ # @yieldparam err [StandardError] error object if request failed
95
+ #
96
+ # @return [Google::Apis::BusinessprofileperformanceV1::FetchMultiDailyMetricsTimeSeriesResponse]
97
+ #
98
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
99
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
100
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
101
+ def fetch_location_multi_daily_metrics_time_series(location, daily_metrics: nil, daily_range_end_date_day: nil, daily_range_end_date_month: nil, daily_range_end_date_year: nil, daily_range_start_date_day: nil, daily_range_start_date_month: nil, daily_range_start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
102
+ command = make_simple_command(:get, 'v1/{+location}:fetchMultiDailyMetricsTimeSeries', options)
103
+ command.response_representation = Google::Apis::BusinessprofileperformanceV1::FetchMultiDailyMetricsTimeSeriesResponse::Representation
104
+ command.response_class = Google::Apis::BusinessprofileperformanceV1::FetchMultiDailyMetricsTimeSeriesResponse
105
+ command.params['location'] = location unless location.nil?
106
+ command.query['dailyMetrics'] = daily_metrics unless daily_metrics.nil?
107
+ command.query['dailyRange.endDate.day'] = daily_range_end_date_day unless daily_range_end_date_day.nil?
108
+ command.query['dailyRange.endDate.month'] = daily_range_end_date_month unless daily_range_end_date_month.nil?
109
+ command.query['dailyRange.endDate.year'] = daily_range_end_date_year unless daily_range_end_date_year.nil?
110
+ command.query['dailyRange.startDate.day'] = daily_range_start_date_day unless daily_range_start_date_day.nil?
111
+ command.query['dailyRange.startDate.month'] = daily_range_start_date_month unless daily_range_start_date_month.nil?
112
+ command.query['dailyRange.startDate.year'] = daily_range_start_date_year unless daily_range_start_date_year.nil?
113
+ command.query['fields'] = fields unless fields.nil?
114
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
115
+ execute_or_queue_command(command, &block)
116
+ end
117
+
54
118
  # Returns the values for each date from a given time range that are associated
55
119
  # with the specific daily metric. Example request: `GET https://
56
120
  # businessprofileperformance.googleapis.com/v1/locations/12345:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-businessprofileperformance_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.7.0
4
+ version: 0.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-02-19 00:00:00.000000000 Z
11
+ date: 2023-03-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-businessprofileperformance_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-businessprofileperformance_v1/v0.7.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-businessprofileperformance_v1/v0.8.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-businessprofileperformance_v1
63
63
  post_install_message:
64
64
  rdoc_options: []