Class: Google::Apis::YoutubeAnalyticsV1beta1::YouTubeAnalyticsService

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

Overview

YouTube Analytics API

Retrieves your YouTube Analytics data.

Examples:

require 'google/apis/youtube_analytics_v1beta1'

YoutubeAnalytics = Google::Apis::YoutubeAnalyticsV1beta1 # Alias the module
service = YoutubeAnalytics::YouTubeAnalyticsService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeYouTubeAnalyticsService


49
50
51
52
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', 'youtube/analytics/v1beta1/')
  @batch_path = 'batch/youtubeAnalytics/v1beta1'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString


47
48
49
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#delete_group(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a group.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


219
220
221
222
223
224
225
226
227
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 219

def delete_group(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'groups', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_group_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes an item from a group.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (NilClass)

    No result returned for this method

  • err (StandardError)

    error object if request failed

Raises:


87
88
89
90
91
92
93
94
95
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 87

def delete_group_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'groupItems', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1beta1::Group

Creates a group.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


260
261
262
263
264
265
266
267
268
269
270
271
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 260

def insert_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'groups', options)
  command.request_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
  command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_group_item(group_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1beta1::GroupItem

Creates a group item.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


128
129
130
131
132
133
134
135
136
137
138
139
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 128

def insert_group_item(group_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'groupItems', options)
  command.request_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Representation
  command.request_object = group_item_object
  command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupItem::Representation
  command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_group_items(group_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1beta1::GroupItemListResponse

Returns a collection of group items that match the API request parameters.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


174
175
176
177
178
179
180
181
182
183
184
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 174

def list_group_items(group_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'groupItems', options)
  command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupItemListResponse::Representation
  command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::GroupItemListResponse
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1beta1::GroupListResponse

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 316

def list_groups(id: nil, mine: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'groups', options)
  command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::GroupListResponse::Representation
  command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::GroupListResponse
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#query_report(ids, start_date, end_date, metrics, currency: nil, dimensions: nil, filters: nil, include_historical_channel_data: nil, max_results: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1beta1::ResultTable

Retrieve your YouTube Analytics reports.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 442

def query_report(ids, start_date, end_date, metrics, currency: nil, dimensions: nil, filters: nil, include_historical_channel_data: nil, max_results: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'reports', options)
  command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::ResultTable::Representation
  command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::ResultTable
  command.query['currency'] = currency unless currency.nil?
  command.query['dimensions'] = dimensions unless dimensions.nil?
  command.query['end-date'] = end_date unless end_date.nil?
  command.query['filters'] = filters unless filters.nil?
  command.query['ids'] = ids unless ids.nil?
  command.query['include-historical-channel-data'] = include_historical_channel_data unless include_historical_channel_data.nil?
  command.query['max-results'] = max_results unless max_results.nil?
  command.query['metrics'] = metrics unless metrics.nil?
  command.query['sort'] = sort unless sort.nil?
  command.query['start-date'] = start_date unless start_date.nil?
  command.query['start-index'] = start_index unless start_index.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1beta1::Group

Modifies a group. For example, you could change a group's title.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


361
362
363
364
365
366
367
368
369
370
371
372
# File 'generated/google/apis/youtube_analytics_v1beta1/service.rb', line 361

def update_group(group_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'groups', options)
  command.request_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
  command.request_object = group_object
  command.response_representation = Google::Apis::YoutubeAnalyticsV1beta1::Group::Representation
  command.response_class = Google::Apis::YoutubeAnalyticsV1beta1::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end