Class: Google::Apis::YoutubeAnalyticsV1::YouTubeAnalyticsService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::YoutubeAnalyticsV1::YouTubeAnalyticsService
- Defined in:
- generated/google/apis/youtube_analytics_v1/service.rb
Overview
YouTube Analytics API
Retrieves your YouTube Analytics data.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
-
#user_ip ⇒ String
IP address of the site where the request originates.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#delete_group(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Deletes a group.
-
#delete_group_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }
Removes an item from a group.
-
#initialize ⇒ YouTubeAnalyticsService
constructor
A new instance of YouTubeAnalyticsService.
-
#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::YoutubeAnalyticsV1::Group
Creates a group.
-
#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::YoutubeAnalyticsV1::GroupItem
Creates a group item.
-
#list_batch_report_definitions(on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1::BatchReportDefinitionList
Retrieves a list of available batch report definitions.
-
#list_batch_reports(batch_report_definition_id, on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1::BatchReportList
Retrieves a list of processed batch reports.
-
#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::YoutubeAnalyticsV1::ListGroupItemResponse
Returns a collection of group items that match the API request parameters.
-
#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::YoutubeAnalyticsV1::ListGroupsResponse
Returns a collection of groups that match the API request parameters.
-
#query_report(ids, start_date, end_date, metrics, currency: nil, dimensions: nil, filters: nil, max_results: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1::ResultTable
Retrieve your YouTube Analytics reports.
-
#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::YoutubeAnalyticsV1::Group
Modifies a group.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Constructor Details
#initialize ⇒ YouTubeAnalyticsService
Returns a new instance of YouTubeAnalyticsService.
51 52 53 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 51 def initialize super('https://www.googleapis.com/', 'youtube/analytics/v1/') 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.
38 39 40 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 38 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. Overrides userIp if both are provided.
44 45 46 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 44 def quota_user @quota_user end |
#user_ip ⇒ String
Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.
49 50 51 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 49 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.
304 305 306 307 308 309 310 311 312 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 304 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', ) 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.
166 167 168 169 170 171 172 173 174 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 166 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', ) 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::YoutubeAnalyticsV1::Group
Creates a group.
347 348 349 350 351 352 353 354 355 356 357 358 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 347 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', ) command.request_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::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::YoutubeAnalyticsV1::GroupItem
Creates a group item.
209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 209 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', ) command.request_representation = Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation command.request_object = group_item_object command.response_representation = Google::Apis::YoutubeAnalyticsV1::GroupItem::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::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_batch_report_definitions(on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1::BatchReportDefinitionList
Retrieves a list of available batch report definitions.
80 81 82 83 84 85 86 87 88 89 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 80 def list_batch_report_definitions(on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'batchReportDefinitions', ) command.response_representation = Google::Apis::YoutubeAnalyticsV1::BatchReportDefinitionList::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::BatchReportDefinitionList 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_batch_reports(batch_report_definition_id, on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1::BatchReportList
Retrieves a list of processed batch reports.
119 120 121 122 123 124 125 126 127 128 129 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 119 def list_batch_reports(batch_report_definition_id, on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'batchReports', ) command.response_representation = Google::Apis::YoutubeAnalyticsV1::BatchReportList::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::BatchReportList command.query['batchReportDefinitionId'] = batch_report_definition_id unless batch_report_definition_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_group_items(group_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse
Returns a collection of group items that match the API request parameters.
257 258 259 260 261 262 263 264 265 266 267 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 257 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', ) command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse 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::YoutubeAnalyticsV1::ListGroupsResponse
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.
405 406 407 408 409 410 411 412 413 414 415 416 417 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 405 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', ) command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupsResponse::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::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? 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, max_results: nil, sort: nil, start_index: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::YoutubeAnalyticsV1::ResultTable
Retrieve your YouTube Analytics reports.
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 532 def query_report(ids, start_date, end_date, metrics, currency: nil, dimensions: nil, filters: 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', ) command.response_representation = Google::Apis::YoutubeAnalyticsV1::ResultTable::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::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['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::YoutubeAnalyticsV1::Group
Modifies a group. For example, you could change a group's title.
452 453 454 455 456 457 458 459 460 461 462 463 |
# File 'generated/google/apis/youtube_analytics_v1/service.rb', line 452 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', ) command.request_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.request_object = group_object command.response_representation = Google::Apis::YoutubeAnalyticsV1::Group::Representation command.response_class = Google::Apis::YoutubeAnalyticsV1::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 |