Class: Google::Apis::YoutubereportingV1::YouTubeReportingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/youtubereporting_v1/service.rb

Overview

YouTube Reporting API

Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.

Examples:

require 'google/apis/youtubereporting_v1'

Youtubereporting = Google::Apis::YoutubereportingV1 # Alias the module
service = Youtubereporting::YouTubeReportingService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://youtubereporting.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ YouTubeReportingService

Returns a new instance of YouTubeReportingService.



48
49
50
51
52
53
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-youtubereporting_v1',
        client_version: Google::Apis::YoutubereportingV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns 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.

Returns:

  • (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.



41
42
43
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns 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.

Returns:

  • (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.



46
47
48
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#create_job(job_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::Job

Creates a job and returns it.

Parameters:

  • job_object (Google::Apis::YoutubereportingV1::Job) (defaults to: nil)
  • on_behalf_of_content_owner (String) (defaults to: nil) —

    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).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 77

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

#delete_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::Empty

Deletes a job.

Parameters:

  • job_id (String) —

    The ID of the job to delete.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    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).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 112

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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_medium(resource_name, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::GdataMedia

Method for media download. Download is supported on the URI /v1/media/+name? alt=media.

Parameters:

  • resource_name (String) —

    Name of the media that is being downloaded.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • download_dest (IO, String) (defaults to: nil) —

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 317

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::GdataMedia::Representation
  command.response_class = Google::Apis::YoutubereportingV1::GdataMedia
  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

#get_job(job_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::Job

Gets a job.

Parameters:

  • job_id (String) —

    The ID of the job to retrieve.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    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).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 146

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

#get_job_report(job_id, report_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::Report

Gets the metadata of a specific report.

Parameters:

  • job_id (String) —

    The ID of the job.

  • report_id (String) —

    The ID of the report to retrieve.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    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).

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 227

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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_job_reports(job_id, created_after: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, start_time_at_or_after: nil, start_time_before: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::ListReportsResponse

Lists reports created by a specific job. Returns NOT_FOUND if the job does not exist.

Parameters:

  • job_id (String) —

    The ID of the job.

  • created_after (String) (defaults to: nil) —

    If set, only reports created after the specified date/time are returned.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    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).

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    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.

  • start_time_at_or_after (String) (defaults to: nil) —

    If set, only reports whose start time is greater than or equal the specified date/time are returned.

  • start_time_before (String) (defaults to: nil) —

    If set, only reports whose start time is smaller than the specified date/time are returned.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 278

def list_job_reports(job_id, created_after: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, start_time_at_or_after: nil, start_time_before: 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['createdAfter'] = created_after unless created_after.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageSize'] = page_size unless page_size.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['startTimeBefore'] = start_time_before unless start_time_before.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_jobs(include_system_managed: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::ListJobsResponse

Lists jobs.

Parameters:

  • include_system_managed (Boolean) (defaults to: nil) —

    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.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    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).

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer jobs than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 189

def list_jobs(include_system_managed: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: 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['includeSystemManaged'] = include_system_managed unless include_system_managed.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageSize'] = page_size unless page_size.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

#list_report_types(include_system_managed: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubereportingV1::ListReportTypesResponse

Lists report types.

Parameters:

  • include_system_managed (Boolean) (defaults to: nil) —

    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.

  • on_behalf_of_content_owner (String) (defaults to: nil) —

    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).

  • page_size (Fixnum) (defaults to: nil) —

    Requested page size. Server may return fewer report types than requested. If unspecified, server will pick an appropriate default.

  • page_token (String) (defaults to: nil) —

    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.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/apis/youtubereporting_v1/service.rb', line 364

def list_report_types(include_system_managed: nil, on_behalf_of_content_owner: nil, page_size: nil, page_token: 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['includeSystemManaged'] = include_system_managed unless include_system_managed.nil?
  command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil?
  command.query['pageSize'] = page_size unless page_size.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