File: service.rb

package info (click to toggle)
ruby-google-api-client 0.53.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 75,020 kB
  • sloc: ruby: 626,567; makefile: 4
file content (458 lines) | stat: -rw-r--r-- 29,827 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
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
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'

module Google
  module Apis
    module YoutubeAnalyticsV2
      # YouTube Analytics API
      #
      # Retrieves your YouTube Analytics data.
      #
      # @example
      #    require 'google/apis/youtube_analytics_v2'
      #
      #    YoutubeAnalytics = Google::Apis::YoutubeAnalyticsV2 # Alias the module
      #    service = YoutubeAnalytics::YouTubeAnalyticsService.new
      #
      # @see https://developers.google.com/youtube/analytics
      class YouTubeAnalyticsService < Google::Apis::Core::BaseService
        # @return [String]
        #  API key. Your API key identifies your project and provides you with API access,
        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
        attr_accessor :key

        # @return [String]
        #  Available to use for quota purposes for server-side applications. Can be any
        #  arbitrary string assigned to a user, but should not exceed 40 characters.
        attr_accessor :quota_user

        def initialize
          super('https://youtubeanalytics.googleapis.com/', '')
          @batch_path = 'batch'
        end
        
        # Removes an item from a group.
        # @param [String] id
        #   The `id` parameter specifies the YouTube group item ID of the group item that
        #   is being deleted.
        # @param [String] on_behalf_of_content_owner
        #   This parameter can only be used in a properly authorized request. **Note:**
        #   This parameter is intended exclusively for YouTube content partners that own
        #   and manage many different YouTube channels. The `onBehalfOfContentOwner`
        #   parameter indicates that the request's authorization credentials identify a
        #   YouTube user who is acting on behalf of the content owner specified in the
        #   parameter value. It allows content owners to authenticate once and get access
        #   to all their video and channel data, without having to provide authentication
        #   credentials for each individual channel. The account that the user
        #   authenticates with must be linked to the specified YouTube content owner.
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::EmptyResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::EmptyResponse]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def delete_group_item(id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:delete, 'v2/groupItems', options)
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::EmptyResponse::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::EmptyResponse
          command.query['id'] = id unless id.nil?
          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Creates a group item.
        # @param [Google::Apis::YoutubeAnalyticsV2::GroupItem] group_item_object
        # @param [String] on_behalf_of_content_owner
        #   This parameter can only be used in a properly authorized request. **Note:**
        #   This parameter is intended exclusively for YouTube content partners that own
        #   and manage many different YouTube channels. The `onBehalfOfContentOwner`
        #   parameter indicates that the request's authorization credentials identify a
        #   YouTube user who is acting on behalf of the content owner specified in the
        #   parameter value. It allows content owners to authenticate once and get access
        #   to all their video and channel data, without having to provide authentication
        #   credentials for each individual channel. The account that the user
        #   authenticates with must be linked to the specified YouTube content owner.
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::GroupItem] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::GroupItem]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def insert_group_item(group_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v2/groupItems', options)
          command.request_representation = Google::Apis::YoutubeAnalyticsV2::GroupItem::Representation
          command.request_object = group_item_object
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::GroupItem::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::GroupItem
          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Returns a collection of group items that match the API request parameters.
        # @param [String] group_id
        #   The `groupId` parameter specifies the unique ID of the group for which you
        #   want to retrieve group items.
        # @param [String] on_behalf_of_content_owner
        #   This parameter can only be used in a properly authorized request. **Note:**
        #   This parameter is intended exclusively for YouTube content partners that own
        #   and manage many different YouTube channels. The `onBehalfOfContentOwner`
        #   parameter indicates that the request's authorization credentials identify a
        #   YouTube user who is acting on behalf of the content owner specified in the
        #   parameter value. It allows content owners to authenticate once and get access
        #   to all their video and channel data, without having to provide authentication
        #   credentials for each individual channel. The account that the user
        #   authenticates with must be linked to the specified YouTube content owner.
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::ListGroupItemsResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::ListGroupItemsResponse]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def list_group_items(group_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:get, 'v2/groupItems', options)
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::ListGroupItemsResponse::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::ListGroupItemsResponse
          command.query['groupId'] = group_id unless group_id.nil?
          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Deletes a group.
        # @param [String] id
        #   The `id` parameter specifies the YouTube group ID of the group that is being
        #   deleted.
        # @param [String] on_behalf_of_content_owner
        #   This parameter can only be used in a properly authorized request. **Note:**
        #   This parameter is intended exclusively for YouTube content partners that own
        #   and manage many different YouTube channels. The `onBehalfOfContentOwner`
        #   parameter indicates that the request's authorization credentials identify a
        #   YouTube user who is acting on behalf of the content owner specified in the
        #   parameter value. It allows content owners to authenticate once and get access
        #   to all their video and channel data, without having to provide authentication
        #   credentials for each individual channel. The account that the user
        #   authenticates with must be linked to the specified YouTube content owner.
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::EmptyResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::EmptyResponse]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def delete_group(id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:delete, 'v2/groups', options)
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::EmptyResponse::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::EmptyResponse
          command.query['id'] = id unless id.nil?
          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Creates a group.
        # @param [Google::Apis::YoutubeAnalyticsV2::Group] group_object
        # @param [String] on_behalf_of_content_owner
        #   This parameter can only be used in a properly authorized request. **Note:**
        #   This parameter is intended exclusively for YouTube content partners that own
        #   and manage many different YouTube channels. The `onBehalfOfContentOwner`
        #   parameter indicates that the request's authorization credentials identify a
        #   YouTube user who is acting on behalf of the content owner specified in the
        #   parameter value. It allows content owners to authenticate once and get access
        #   to all their video and channel data, without having to provide authentication
        #   credentials for each individual channel. The account that the user
        #   authenticates with must be linked to the specified YouTube content owner.
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::Group] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::Group]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def insert_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v2/groups', options)
          command.request_representation = Google::Apis::YoutubeAnalyticsV2::Group::Representation
          command.request_object = group_object
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::Group::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::Group
          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Returns a collection of groups that match the API request parameters. For
        # example, you can retrieve all groups that the authenticated user owns, or you
        # can retrieve one or more groups by their unique IDs.
        # @param [String] id
        #   The `id` parameter specifies a comma-separated list of the YouTube group ID(s)
        #   for the resource(s) that are being retrieved. Each group must be owned by the
        #   authenticated user. In a `group` resource, the `id` property specifies the
        #   group's YouTube group ID. Note that if you do not specify a value for the `id`
        #   parameter, then you must set the `mine` parameter to `true`.
        # @param [Boolean] mine
        #   This parameter can only be used in a properly authorized request. Set this
        #   parameter's value to true to retrieve all groups owned by the authenticated
        #   user.
        # @param [String] on_behalf_of_content_owner
        #   This parameter can only be used in a properly authorized request. **Note:**
        #   This parameter is intended exclusively for YouTube content partners that own
        #   and manage many different YouTube channels. The `onBehalfOfContentOwner`
        #   parameter indicates that the request's authorization credentials identify a
        #   YouTube user who is acting on behalf of the content owner specified in the
        #   parameter value. It allows content owners to authenticate once and get access
        #   to all their video and channel data, without having to provide authentication
        #   credentials for each individual channel. The account that the user
        #   authenticates with must be linked to the specified YouTube content owner.
        # @param [String] page_token
        #   The `pageToken` parameter identifies a specific page in the result set that
        #   should be returned. In an API response, the `nextPageToken` property
        #   identifies the next page that can be retrieved.
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::ListGroupsResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::ListGroupsResponse]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def list_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:get, 'v2/groups', options)
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::ListGroupsResponse::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::ListGroupsResponse
          command.query['id'] = id unless id.nil?
          command.query['mine'] = mine unless mine.nil?
          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
          command.query['pageToken'] = page_token unless page_token.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Modifies a group. For example, you could change a group's title.
        # @param [Google::Apis::YoutubeAnalyticsV2::Group] group_object
        # @param [String] on_behalf_of_content_owner
        #   This parameter can only be used in a properly authorized request. **Note:**
        #   This parameter is intended exclusively for YouTube content partners that own
        #   and manage many different YouTube channels. The `onBehalfOfContentOwner`
        #   parameter indicates that the request's authorization credentials identify a
        #   YouTube user who is acting on behalf of the content owner specified in the
        #   parameter value. It allows content owners to authenticate once and get access
        #   to all their video and channel data, without having to provide authentication
        #   credentials for each individual channel. The account that the user
        #   authenticates with must be linked to the specified YouTube content owner.
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::Group] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::Group]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def update_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:put, 'v2/groups', options)
          command.request_representation = Google::Apis::YoutubeAnalyticsV2::Group::Representation
          command.request_object = group_object
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::Group::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::Group
          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
        
        # Retrieve your YouTube Analytics reports.
        # @param [String] currency
        #   The currency to which financial metrics should be converted. The default is US
        #   Dollar (USD). If the result contains no financial metrics, this flag will be
        #   ignored. Responds with an error if the specified currency is not recognized.",
        #   pattern: [A-Z]`3`
        # @param [String] dimensions
        #   A comma-separated list of YouTube Analytics dimensions, such as `views` or `
        #   ageGroup,gender`. See the [Available Reports](/youtube/analytics/v2/
        #   available_reports) document for a list of the reports that you can retrieve
        #   and the dimensions used for those reports. Also see the [Dimensions](/youtube/
        #   analytics/v2/dimsmets/dims) document for definitions of those dimensions."
        #   pattern: [0-9a-zA-Z,]+
        # @param [String] end_date
        #   The end date for fetching YouTube Analytics data. The value should be in `YYYY-
        #   MM-DD` format. required: true, pattern: [0-9]`4`-[0-9]`2`-[0-9]`2`
        # @param [String] filters
        #   A list of filters that should be applied when retrieving YouTube Analytics
        #   data. The [Available Reports](/youtube/analytics/v2/available_reports)
        #   document identifies the dimensions that can be used to filter each report, and
        #   the [Dimensions](/youtube/analytics/v2/dimsmets/dims) document defines those
        #   dimensions. If a request uses multiple filters, join them together with a
        #   semicolon (`;`), and the returned result table will satisfy both filters. For
        #   example, a filters parameter value of `video==dMH0bHeiRNg;country==IT`
        #   restricts the result set to include data for the given video in Italy.",
        # @param [String] ids
        #   Identifies the YouTube channel or content owner for which you are retrieving
        #   YouTube Analytics data. - To request data for a YouTube user, set the `ids`
        #   parameter value to `channel==CHANNEL_ID`, where `CHANNEL_ID` specifies the
        #   unique YouTube channel ID. - To request data for a YouTube CMS content owner,
        #   set the `ids` parameter value to `contentOwner==OWNER_NAME`, where `OWNER_NAME`
        #   is the CMS name of the content owner. required: true, pattern: [a-zA-Z]+==[a-
        #   zA-Z0-9_+-]+
        # @param [Boolean] include_historical_channel_data
        #   If set to true historical data (i.e. channel data from before the linking of
        #   the channel to the content owner) will be retrieved.",
        # @param [Fixnum] max_results
        #   The maximum number of rows to include in the response.", minValue: 1
        # @param [String] metrics
        #   A comma-separated list of YouTube Analytics metrics, such as `views` or `likes,
        #   dislikes`. See the [Available Reports](/youtube/analytics/v2/available_reports)
        #   document for a list of the reports that you can retrieve and the metrics
        #   available in each report, and see the [Metrics](/youtube/analytics/v2/dimsmets/
        #   mets) document for definitions of those metrics. required: true, pattern: [0-
        #   9a-zA-Z,]+
        # @param [String] sort
        #   A comma-separated list of dimensions or metrics that determine the sort order
        #   for YouTube Analytics data. By default the sort order is ascending. The '`-`'
        #   prefix causes descending sort order.", pattern: [-0-9a-zA-Z,]+
        # @param [String] start_date
        #   The start date for fetching YouTube Analytics data. The value should be in `
        #   YYYY-MM-DD` format. required: true, pattern: "[0-9]`4`-[0-9]`2`-[0-9]`2`
        # @param [Fixnum] start_index
        #   An index of the first entity to retrieve. Use this parameter as a pagination
        #   mechanism along with the max-results parameter (one-based, inclusive).",
        #   minValue: 1
        # @param [String] fields
        #   Selector specifying which fields to include in a partial response.
        # @param [String] quota_user
        #   Available to use for quota purposes for server-side applications. Can be any
        #   arbitrary string assigned to a user, but should not exceed 40 characters.
        # @param [Google::Apis::RequestOptions] options
        #   Request-specific options
        #
        # @yield [result, err] Result & error if block supplied
        # @yieldparam result [Google::Apis::YoutubeAnalyticsV2::QueryResponse] parsed result object
        # @yieldparam err [StandardError] error object if request failed
        #
        # @return [Google::Apis::YoutubeAnalyticsV2::QueryResponse]
        #
        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
        # @raise [Google::Apis::AuthorizationError] Authorization is required
        def query_report(currency: nil, dimensions: nil, end_date: nil, filters: nil, ids: nil, include_historical_channel_data: nil, max_results: nil, metrics: nil, sort: nil, start_date: nil, start_index: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:get, 'v2/reports', options)
          command.response_representation = Google::Apis::YoutubeAnalyticsV2::QueryResponse::Representation
          command.response_class = Google::Apis::YoutubeAnalyticsV2::QueryResponse
          command.query['currency'] = currency unless currency.nil?
          command.query['dimensions'] = dimensions unless dimensions.nil?
          command.query['endDate'] = end_date unless end_date.nil?
          command.query['filters'] = filters unless filters.nil?
          command.query['ids'] = ids unless ids.nil?
          command.query['includeHistoricalChannelData'] = include_historical_channel_data unless include_historical_channel_data.nil?
          command.query['maxResults'] = max_results unless max_results.nil?
          command.query['metrics'] = metrics unless metrics.nil?
          command.query['sort'] = sort unless sort.nil?
          command.query['startDate'] = start_date unless start_date.nil?
          command.query['startIndex'] = start_index unless start_index.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end

        protected

        def apply_command_defaults(command)
          command.query['key'] = key unless key.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
        end
      end
    end
  end
end