google-api-ruby-client/generated/google/apis/youtubereporting_v1/service.rb

387 lines
22 KiB
Ruby
Raw Normal View History

2015-12-03 01:10:07 +00:00
# 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 YoutubereportingV1
# YouTube Reporting API
#
2016-05-25 16:16:15 +00:00
# Schedules reporting jobs containing your YouTube Analytics data and downloads
# the resulting bulk data reports in the form of CSV files.
2015-12-03 01:10:07 +00:00
#
# @example
# require 'google/apis/youtubereporting_v1'
#
# Youtubereporting = Google::Apis::YoutubereportingV1 # Alias the module
# service = Youtubereporting::YouTubeReportingService.new
#
# @see https://developers.google.com/youtube/reporting/v1/reports/
class YouTubeReportingService < Google::Apis::Core::BaseService
2017-03-27 22:14:47 +00:00
# @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
2017-03-31 19:53:27 +00:00
# @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
2015-12-03 01:10:07 +00:00
def initialize
super('https://youtubereporting.googleapis.com/', '')
2017-04-03 20:18:48 +00:00
@batch_path = 'batch'
2015-12-03 01:10:07 +00:00
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).
2017-01-13 23:04:35 +00:00
# @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.
2017-01-13 23:04:35 +00:00
# @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
2017-01-13 23:04:35 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubereportingV1::Job]
2017-01-13 23:04:35 +00:00
#
# @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?
2017-03-27 22:14:47 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-04-03 20:18:48 +00:00
execute_or_queue_command(command, &block)
end
# Deletes a job.
# @param [String] job_id
# The ID of the job to delete.
# @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] 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.
2017-04-03 20:18:48 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubereportingV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubereportingV1::Empty]
#
# @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)
2017-04-03 20:18:48 +00:00
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?
2017-03-27 22:14:47 +00:00
execute_or_queue_command(command, &block)
end
2017-03-10 21:11:09 +00:00
# Lists jobs.
# @param [String] page_token
# A token identifying a page of results the server should return. Typically,
# this is the value of
# ListReportTypesResponse.next_page_token
# returned in response to the previous call to the `ListJobs` method.
# @param [Boolean] include_system_managed
# If set to true, also system-managed jobs will be returned; otherwise only
# user-created jobs will be returned. System-managed jobs can neither be
# modified nor deleted.
2017-03-30 22:30:51 +00:00
# @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).
2015-12-03 01:10:07 +00:00
# @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.
2015-12-03 01:10:07 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubereportingV1::ListJobsResponse] parsed result object
2015-12-03 01:10:07 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubereportingV1::ListJobsResponse]
2015-12-03 01:10:07 +00:00
#
# @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)
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['pageToken'] = page_token unless page_token.nil?
command.query['includeSystemManaged'] = include_system_managed unless include_system_managed.nil?
2017-03-30 22:30:51 +00:00
command.query['pageSize'] = page_size unless page_size.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2017-04-03 20:18:48 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2015-12-03 01:10:07 +00:00
execute_or_queue_command(command, &block)
end
2017-01-13 23:04:35 +00:00
# Gets a job.
# @param [String] job_id
# The ID of the job to retrieve.
2015-12-03 01:10:07 +00:00
# @param [String] on_behalf_of_content_owner
2017-01-13 23:04:35 +00:00
# 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).
2015-12-03 01:10:07 +00:00
# @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.
2015-12-03 01:10:07 +00:00
# @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 get_job(job_id, on_behalf_of_content_owner: nil, quota_user: nil, fields: nil, options: nil, &block)
2017-01-13 23:04:35 +00:00
command = make_simple_command(:get, 'v1/jobs/{jobId}', options)
2015-12-03 01:10:07 +00:00
command.response_representation = Google::Apis::YoutubereportingV1::Job::Representation
command.response_class = Google::Apis::YoutubereportingV1::Job
2017-01-13 23:04:35 +00:00
command.params['jobId'] = job_id unless job_id.nil?
2015-12-03 01:10:07 +00:00
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2017-04-03 20:18:48 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-03-30 22:30:51 +00:00
execute_or_queue_command(command, &block)
end
# Lists reports created by a specific job.
# Returns NOT_FOUND if the job does not exist.
# @param [String] job_id
# The ID of the job.
2017-04-03 20:18:48 +00:00
# @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] 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.
2015-12-03 01:10:07 +00:00
# @param [Fixnum] page_size
# Requested page size. Server may return fewer report types than requested.
2017-01-13 23:04:35 +00:00
# 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).
2015-12-03 01:10:07 +00:00
# @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.
2015-12-03 01:10:07 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubereportingV1::ListReportsResponse] parsed result object
2015-12-03 01:10:07 +00:00
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubereportingV1::ListReportsResponse]
2015-12-03 01:10:07 +00:00
#
# @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)
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
2015-12-03 01:10:07 +00:00
command.params['jobId'] = job_id unless job_id.nil?
2017-04-03 20:18:48 +00:00
command.query['startTimeBefore'] = start_time_before unless start_time_before.nil?
command.query['createdAfter'] = created_after unless created_after.nil?
2017-03-10 21:11:09 +00:00
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['pageSize'] = page_size unless page_size.nil?
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2017-04-03 20:18:48 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2015-12-03 01:10:07 +00:00
execute_or_queue_command(command, &block)
end
2017-01-13 23:04:35 +00:00
# Gets the metadata of a specific report.
2015-12-03 01:10:07 +00:00
# @param [String] job_id
2017-01-13 23:04:35 +00:00
# The ID of the job.
# @param [String] report_id
# The ID of the report to retrieve.
2015-12-03 01:10:07 +00:00
# @param [String] on_behalf_of_content_owner
2017-01-13 23:04:35 +00:00
# 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).
2015-12-03 01:10:07 +00:00
# @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.
2015-12-03 01:10:07 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
2017-01-13 23:04:35 +00:00
# @yieldparam result [Google::Apis::YoutubereportingV1::Report] parsed result object
2015-12-03 01:10:07 +00:00
# @yieldparam err [StandardError] error object if request failed
#
2017-01-13 23:04:35 +00:00
# @return [Google::Apis::YoutubereportingV1::Report]
2015-12-03 01:10:07 +00:00
#
# @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)
2017-01-13 23:04:35 +00:00
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
2015-12-03 01:10:07 +00:00
command.params['jobId'] = job_id unless job_id.nil?
2017-01-13 23:04:35 +00:00
command.params['reportId'] = report_id unless report_id.nil?
2015-12-03 01:10:07 +00:00
command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
2017-04-03 20:18:48 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2015-12-03 01:10:07 +00:00
execute_or_queue_command(command, &block)
end
2017-03-31 19:53:27 +00:00
# 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).
2017-03-31 19:53:27 +00:00
# @param [String] page_token
# A token identifying a page of results the server should return. Typically,
# this is the value of
# ListReportTypesResponse.next_page_token
# returned in response to the previous call to the `ListReportTypes` method.
# @param [Boolean] include_system_managed
# If set to true, also system-managed report types will be returned;
# otherwise only the report types that can be used to create new reporting
# jobs will be 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] 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.
2017-03-31 19:53:27 +00:00
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::YoutubereportingV1::ListReportTypesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::YoutubereportingV1::ListReportTypesResponse]
#
# @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)
2017-03-31 19:53:27 +00:00
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?
2017-03-31 19:53:27 +00:00
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?
2017-03-31 19:53:27 +00:00
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?
2017-04-03 20:18:48 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
command.query['fields'] = fields unless fields.nil?
2017-03-31 19:53:27 +00:00
execute_or_queue_command(command, &block)
end
2015-12-03 01:10:07 +00:00
protected
def apply_command_defaults(command)
2017-03-27 22:14:47 +00:00
command.query['key'] = key unless key.nil?
2017-03-31 19:53:27 +00:00
command.query['quotaUser'] = quota_user unless quota_user.nil?
2015-12-03 01:10:07 +00:00
end
end
end
end
end