google-api-client 0.11.2 → 0.11.3

data/generated/google/apis/youtubereporting_v1/service.rb

@@ -48,37 +48,42 @@ module Google
           @batch_path = 'batch'
         end
         
-        # Creates a job and returns it.
-        # @param [Google::Apis::YoutubereportingV1::Job] job_object
-        # @param [String] on_behalf_of_content_owner
-        #   The content owner's external ID on which behalf the user is acting on. If
-        #   not set, the user is acting for himself (his own channel).
+        # Method for media download. Download is supported
+        # on the URI `/v1/media/`+name`?alt=media`.
+        # @param [String] resource_name
+        #   Name of the media that is being downloaded.  See
+        #   ReadRequest.resource_name.
+        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
+        # @param [IO, String] download_dest
+        #   IO stream or filename to receive content download
         # @param [Google::Apis::RequestOptions] options
         #   Request-specific options
         #
         # @yield [result, err] Result & error if block supplied
-        # @yieldparam result [Google::Apis::YoutubereportingV1::Job] parsed result object
+        # @yieldparam result [Google::Apis::YoutubereportingV1::Media] parsed result object
         # @yieldparam err [StandardError] error object if request failed
         #
-        # @return [Google::Apis::YoutubereportingV1::Job]
+        # @return [Google::Apis::YoutubereportingV1::Media]
         #
         # @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 create_job(job_object = nil, on_behalf_of_content_owner: nil, quota_user: nil, fields: nil, options: nil, &block)
-          command =  make_simple_command(:post, 'v1/jobs', options)
-          command.request_representation = Google::Apis::YoutubereportingV1::Job::Representation
-          command.request_object = job_object
-          command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation
-          command.response_class = Google::Apis::YoutubereportingV1::Job
-          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        def download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
+          if download_dest.nil?
+            command =  make_simple_command(:get, 'v1/media/{+resourceName}', options)
+          else
+            command = make_download_command(:get, 'v1/media/{+resourceName}', options)
+            command.download_dest = download_dest
+          end
+          command.response_representation = Google::Apis::YoutubereportingV1::Media::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::Media
+          command.params['resourceName'] = resource_name unless resource_name.nil?
           command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
@@ -88,11 +93,11 @@ module Google
         # @param [String] on_behalf_of_content_owner
         #   The content owner's external ID on which behalf the user is acting on. If
         #   not set, the user is acting for himself (his own channel).
+        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
         # @param [Google::Apis::RequestOptions] options
         #   Request-specific options
         #
@@ -105,18 +110,21 @@ module Google
         # @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_job(job_id, on_behalf_of_content_owner: nil, quota_user: nil, fields: nil, options: nil, &block)
+        def delete_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
           command =  make_simple_command(:delete, 'v1/jobs/{jobId}', options)
           command.response_representation = Google::Apis::YoutubereportingV1::Empty::Representation
           command.response_class = Google::Apis::YoutubereportingV1::Empty
           command.params['jobId'] = job_id unless job_id.nil?
           command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Lists jobs.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If
+        #   not set, the user is acting for himself (his own channel).
         # @param [String] page_token
         #   A token identifying a page of results the server should return. Typically,
         #   this is the value of
@@ -129,14 +137,11 @@ module Google
         # @param [Fixnum] page_size
         #   Requested page size. Server may return fewer jobs than requested.
         #   If unspecified, server will pick an appropriate default.
-        # @param [String] on_behalf_of_content_owner
-        #   The content owner's external ID on which behalf the user is acting on. If
-        #   not set, the user is acting for himself (his own channel).
+        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
         # @param [Google::Apis::RequestOptions] options
         #   Request-specific options
         #
@@ -149,16 +154,16 @@ module Google
         # @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_jobs(page_token: nil, include_system_managed: nil, page_size: nil, on_behalf_of_content_owner: nil, quota_user: nil, fields: nil, options: nil, &block)
+        def list_jobs(on_behalf_of_content_owner: nil, page_token: nil, include_system_managed: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
           command =  make_simple_command(:get, 'v1/jobs', options)
           command.response_representation = Google::Apis::YoutubereportingV1::ListJobsResponse::Representation
           command.response_class = Google::Apis::YoutubereportingV1::ListJobsResponse
+          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['includeSystemManaged'] = include_system_managed unless include_system_managed.nil?
           command.query['pageSize'] = page_size unless page_size.nil?
-          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
@@ -168,11 +173,11 @@ module Google
         # @param [String] on_behalf_of_content_owner
         #   The content owner's external ID on which behalf the user is acting on. If
         #   not set, the user is acting for himself (his own channel).
+        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
         # @param [Google::Apis::RequestOptions] options
         #   Request-specific options
         #
@@ -185,14 +190,48 @@ module Google
         # @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 get_job(job_id, on_behalf_of_content_owner: nil, quota_user: nil, fields: nil, options: nil, &block)
+        def get_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
           command =  make_simple_command(:get, 'v1/jobs/{jobId}', options)
           command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation
           command.response_class = Google::Apis::YoutubereportingV1::Job
           command.params['jobId'] = job_id unless job_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 job and returns it.
+        # @param [Google::Apis::YoutubereportingV1::Job] job_object
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If
+        #   not set, the user is acting for himself (his own channel).
+        # @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::YoutubereportingV1::Job] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::YoutubereportingV1::Job]
+        #
+        # @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 create_job(job_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command =  make_simple_command(:post, 'v1/jobs', options)
+          command.request_representation = Google::Apis::YoutubereportingV1::Job::Representation
+          command.request_object = job_object
+          command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation
+          command.response_class = Google::Apis::YoutubereportingV1::Job
+          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
         
@@ -200,30 +239,30 @@ module Google
         # Returns NOT_FOUND if the job does not exist.
         # @param [String] job_id
         #   The ID of the job.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If
+        #   not set, the user is acting for himself (his own channel).
         # @param [String] start_time_before
         #   If set, only reports whose start time is smaller than the specified
         #   date/time are returned.
         # @param [String] created_after
         #   If set, only reports created after the specified date/time are returned.
+        # @param [String] start_time_at_or_after
+        #   If set, only reports whose start time is greater than or equal the
+        #   specified date/time are returned.
         # @param [String] page_token
         #   A token identifying a page of results the server should return. Typically,
         #   this is the value of
         #   ListReportsResponse.next_page_token
         #   returned in response to the previous call to the `ListReports` method.
-        # @param [String] start_time_at_or_after
-        #   If set, only reports whose start time is greater than or equal the
-        #   specified date/time are returned.
         # @param [Fixnum] page_size
         #   Requested page size. Server may return fewer report types than requested.
         #   If unspecified, server will pick an appropriate default.
-        # @param [String] on_behalf_of_content_owner
-        #   The content owner's external ID on which behalf the user is acting on. If
-        #   not set, the user is acting for himself (his own channel).
+        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
         # @param [Google::Apis::RequestOptions] options
         #   Request-specific options
         #
@@ -236,19 +275,19 @@ module Google
         # @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_job_reports(job_id, start_time_before: nil, created_after: nil, page_token: nil, start_time_at_or_after: nil, page_size: nil, on_behalf_of_content_owner: nil, quota_user: nil, fields: nil, options: nil, &block)
+        def list_job_reports(job_id, on_behalf_of_content_owner: nil, start_time_before: nil, created_after: nil, start_time_at_or_after: nil, page_token: nil, page_size: nil, fields: nil, quota_user: nil, options: nil, &block)
           command =  make_simple_command(:get, 'v1/jobs/{jobId}/reports', options)
           command.response_representation = Google::Apis::YoutubereportingV1::ListReportsResponse::Representation
           command.response_class = Google::Apis::YoutubereportingV1::ListReportsResponse
           command.params['jobId'] = job_id unless job_id.nil?
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
           command.query['startTimeBefore'] = start_time_before unless start_time_before.nil?
           command.query['createdAfter'] = created_after unless created_after.nil?
-          command.query['pageToken'] = page_token unless page_token.nil?
           command.query['startTimeAtOrAfter'] = start_time_at_or_after unless start_time_at_or_after.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
           command.query['pageSize'] = page_size unless page_size.nil?
-          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
@@ -260,11 +299,11 @@ module Google
         # @param [String] on_behalf_of_content_owner
         #   The content owner's external ID on which behalf the user is acting on. If
         #   not set, the user is acting for himself (his own channel).
+        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
         # @param [Google::Apis::RequestOptions] options
         #   Request-specific options
         #
@@ -277,22 +316,19 @@ module Google
         # @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 get_job_report(job_id, report_id, on_behalf_of_content_owner: nil, quota_user: nil, fields: nil, options: nil, &block)
+        def get_job_report(job_id, report_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
           command =  make_simple_command(:get, 'v1/jobs/{jobId}/reports/{reportId}', options)
           command.response_representation = Google::Apis::YoutubereportingV1::Report::Representation
           command.response_class = Google::Apis::YoutubereportingV1::Report
           command.params['jobId'] = job_id unless job_id.nil?
           command.params['reportId'] = report_id unless report_id.nil?
           command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
           command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
         
         # Lists report types.
-        # @param [String] on_behalf_of_content_owner
-        #   The content owner's external ID on which behalf the user is acting on. If
-        #   not set, the user is acting for himself (his own channel).
         # @param [String] page_token
         #   A token identifying a page of results the server should return. Typically,
         #   this is the value of
@@ -305,11 +341,14 @@ module Google
         # @param [Fixnum] page_size
         #   Requested page size. Server may return fewer report types than requested.
         #   If unspecified, server will pick an appropriate default.
+        # @param [String] on_behalf_of_content_owner
+        #   The content owner's external ID on which behalf the user is acting on. If
+        #   not set, the user is acting for himself (his own channel).
+        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
         # @param [Google::Apis::RequestOptions] options
         #   Request-specific options
         #
@@ -322,55 +361,16 @@ module Google
         # @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_report_types(on_behalf_of_content_owner: nil, page_token: nil, include_system_managed: nil, page_size: nil, quota_user: nil, fields: nil, options: nil, &block)
+        def list_report_types(page_token: nil, include_system_managed: nil, page_size: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
           command =  make_simple_command(:get, 'v1/reportTypes', options)
           command.response_representation = Google::Apis::YoutubereportingV1::ListReportTypesResponse::Representation
           command.response_class = Google::Apis::YoutubereportingV1::ListReportTypesResponse
-          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['includeSystemManaged'] = include_system_managed unless include_system_managed.nil?
           command.query['pageSize'] = page_size unless page_size.nil?
-          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
           command.query['fields'] = fields unless fields.nil?
-          execute_or_queue_command(command, &block)
-        end
-        
-        # Method for media download. Download is supported
-        # on the URI `/v1/media/`+name`?alt=media`.
-        # @param [String] resource_name
-        #   Name of the media that is being downloaded.  See
-        #   ReadRequest.resource_name.
-        # @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 [String] fields
-        #   Selector specifying which fields to include in a partial response.
-        # @param [IO, String] download_dest
-        #   IO stream or filename to receive content download
-        # @param [Google::Apis::RequestOptions] options
-        #   Request-specific options
-        #
-        # @yield [result, err] Result & error if block supplied
-        # @yieldparam result [Google::Apis::YoutubereportingV1::Media] parsed result object
-        # @yieldparam err [StandardError] error object if request failed
-        #
-        # @return [Google::Apis::YoutubereportingV1::Media]
-        #
-        # @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 download_medium(resource_name, quota_user: nil, fields: nil, download_dest: nil, options: nil, &block)
-          if download_dest.nil?
-            command =  make_simple_command(:get, 'v1/media/{+resourceName}', options)
-          else
-            command = make_download_command(:get, 'v1/media/{+resourceName}', options)
-            command.download_dest = download_dest
-          end
-          command.response_representation = Google::Apis::YoutubereportingV1::Media::Representation
-          command.response_class = Google::Apis::YoutubereportingV1::Media
-          command.params['resourceName'] = resource_name unless resource_name.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
-          command.query['fields'] = fields unless fields.nil?
           execute_or_queue_command(command, &block)
         end
 

data/lib/google/apis/core/api_command.rb

@@ -52,6 +52,9 @@ module Google
         #
         # @return [void]
         def prepare!
+          if options && options.api_format_version
+            header['X-Goog-Api-Format-Version'] = options.api_format_version.to_s
+          end
           query[FIELDS_PARAM] = normalize_fields_param(query[FIELDS_PARAM]) if query.key?(FIELDS_PARAM)
           if request_representation && request_object
             header['Content-Type'] ||= JSON_CONTENT_TYPE
@@ -100,15 +103,15 @@ module Google
         def check_status(status, header = nil, body = nil, message = nil)
           case status
           when 400, 402...500
-            error = parse_error(body)
-            if error
-              message = sprintf('%s: %s', error['reason'], error['message'])
-              raise ERROR_REASON_MAPPING[error['reason']].new(
+            reason, message = parse_error(body)
+            if reason
+              message = sprintf('%s: %s', reason, message)
+              raise ERROR_REASON_MAPPING[reason].new(
                 message,
                 status_code: status,
                 header: header,
                 body: body
-              ) if ERROR_REASON_MAPPING.key?(error['reason'])
+              ) if ERROR_REASON_MAPPING.key?(reason)
             end
             super(status, header, body, message)
           else
@@ -122,15 +125,45 @@ module Google
 
         private
 
-        # Attempt to parse a JSON error message, returning the first found error
+        # Attempt to parse a JSON error message
         # @param [String] body
         #  HTTP response body
-        # @return [Hash]
+        # @return [Array<(String, String)>]
+        #   Error reason and message
         def parse_error(body)
-          hash = JSON.load(body)
-          hash['error']['errors'].first
+          obj = JSON.load(body)
+          error = obj['error']
+          if error['details']
+            return extract_v2_error_details(error)
+          elsif error['errors']
+            return extract_v1_error_details(error)
+          else
+            fail 'Can not parse error message. No "details" or "errors" detected'
+          end
         rescue
-          nil
+          return [nil, nil]
+        end
+
+        # Extracts details from a v1 error message
+        # @param [Hash] error
+        #  Parsed JSON
+        # @return [Array<(String, String)>]
+        #   Error reason and message
+        def extract_v1_error_details(error)
+          reason = error['errors'].first['reason']
+          message = error['message']
+          return [reason, message]
+        end
+
+        # Extracts details from a v2error message
+        # @param [Hash] error
+        #  Parsed JSON
+        # @return [Array<(String, String)>]
+        #   Error reason and message
+        def extract_v2_error_details(error)
+          reason = error['status']
+          message = error['message']
+          return [reason, message]
         end
 
         # Convert field names from ruby conventions to original names in JSON