google-api-client 0.9.pre2 → 0.9.pre3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +3 -0
- data/README.md +1 -1
- data/api_names_out.yaml +68 -5
- data/generated/google/apis/adexchangebuyer_v1_3/service.rb +3 -3
- data/generated/google/apis/adexchangeseller_v2_0.rb +1 -1
- data/generated/google/apis/adexchangeseller_v2_0/service.rb +5 -5
- data/generated/google/apis/admin_directory_v1.rb +1 -1
- data/generated/google/apis/admin_directory_v1/classes.rb +34 -0
- data/generated/google/apis/admin_directory_v1/representations.rb +5 -0
- data/generated/google/apis/adsense_v1_4.rb +1 -1
- data/generated/google/apis/adsense_v1_4/service.rb +10 -10
- data/generated/google/apis/adsensehost_v4_1.rb +1 -1
- data/generated/google/apis/adsensehost_v4_1/service.rb +19 -19
- data/generated/google/apis/analytics_v3/service.rb +35 -35
- data/generated/google/apis/androidenterprise_v1/service.rb +6 -6
- data/generated/google/apis/appstate_v1.rb +1 -1
- data/generated/google/apis/bigquery_v2.rb +1 -1
- data/generated/google/apis/bigquery_v2/classes.rb +16 -6
- data/generated/google/apis/bigquery_v2/representations.rb +2 -0
- data/generated/google/apis/bigquery_v2/service.rb +4 -4
- data/generated/google/apis/blogger_v3/service.rb +7 -7
- data/generated/google/apis/books_v1/service.rb +47 -47
- data/generated/google/apis/calendar_v3.rb +1 -1
- data/generated/google/apis/calendar_v3/classes.rb +43 -27
- data/generated/google/apis/calendar_v3/service.rb +20 -10
- data/generated/google/apis/civicinfo_v2/service.rb +1 -1
- data/generated/google/apis/cloudmonitoring_v2beta2.rb +1 -1
- data/generated/google/apis/cloudmonitoring_v2beta2/service.rb +8 -8
- data/generated/google/apis/cloudresourcemanager_v1beta1.rb +1 -1
- data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +372 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +155 -0
- data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +109 -0
- data/generated/google/apis/compute_v1.rb +1 -1
- data/generated/google/apis/compute_v1/classes.rb +21 -18
- data/generated/google/apis/compute_v1/representations.rb +0 -1
- data/generated/google/apis/compute_v1/service.rb +459 -819
- data/generated/google/apis/content_v2.rb +1 -1
- data/generated/google/apis/content_v2/classes.rb +25 -15
- data/generated/google/apis/content_v2/representations.rb +2 -0
- data/generated/google/apis/content_v2/service.rb +2 -1
- data/generated/google/apis/coordinate_v1/service.rb +11 -11
- data/generated/google/apis/customsearch_v1/service.rb +3 -3
- data/generated/google/apis/deploymentmanager_v2beta2.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta2/classes.rb +1 -1
- data/generated/google/apis/deploymentmanager_v2beta2/service.rb +50 -90
- data/generated/google/apis/dfareporting_v2_1.rb +1 -1
- data/generated/google/apis/dfareporting_v2_1/classes.rb +4 -4
- data/generated/google/apis/dfareporting_v2_1/service.rb +65 -62
- data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
- data/generated/google/apis/doubleclicksearch_v2/service.rb +11 -11
- data/generated/google/apis/drive_v2.rb +4 -1
- data/generated/google/apis/drive_v2/classes.rb +2 -2
- data/generated/google/apis/drive_v2/service.rb +15 -9
- data/generated/google/apis/fitness_v1.rb +1 -1
- data/generated/google/apis/fitness_v1/classes.rb +44 -31
- data/generated/google/apis/fitness_v1/representations.rb +0 -2
- data/generated/google/apis/fitness_v1/service.rb +5 -1
- data/generated/google/apis/fusiontables_v2/service.rb +9 -9
- data/generated/google/apis/games_configuration_v1configuration.rb +1 -1
- data/generated/google/apis/games_v1.rb +1 -1
- data/generated/google/apis/games_v1/service.rb +18 -18
- data/generated/google/apis/genomics_v1.rb +1 -1
- data/generated/google/apis/genomics_v1/classes.rb +56 -53
- data/generated/google/apis/genomics_v1/service.rb +1 -1
- data/generated/google/apis/licensing_v1/service.rb +2 -2
- data/generated/google/apis/mapsengine_v1/service.rb +8 -8
- data/generated/google/apis/mirror_v1.rb +1 -1
- data/generated/google/apis/pagespeedonline_v2/service.rb +3 -3
- data/generated/google/apis/plus_domains_v1.rb +1 -1
- data/generated/google/apis/plus_v1.rb +1 -1
- data/generated/google/apis/plus_v1/service.rb +6 -6
- data/generated/google/apis/pubsub_v1beta2.rb +1 -1
- data/generated/google/apis/pubsub_v1beta2/classes.rb +21 -20
- data/generated/google/apis/pubsub_v1beta2/service.rb +13 -13
- data/generated/google/apis/replicapool_v1beta2/service.rb +3 -3
- data/generated/google/apis/replicapoolupdater_v1beta1.rb +1 -1
- data/generated/google/apis/replicapoolupdater_v1beta1/classes.rb +8 -1
- data/generated/google/apis/replicapoolupdater_v1beta1/representations.rb +1 -0
- data/generated/google/apis/replicapoolupdater_v1beta1/service.rb +1 -5
- data/generated/google/apis/reseller_v1/service.rb +1 -1
- data/generated/google/apis/site_verification_v1/service.rb +2 -2
- data/generated/google/apis/sqladmin_v1beta4/service.rb +4 -4
- data/generated/google/apis/storage_v1/service.rb +6 -6
- data/generated/google/apis/taskqueue_v1beta2/service.rb +9 -9
- data/generated/google/apis/translate_v2/service.rb +6 -6
- data/generated/google/apis/urlshortener_v1/service.rb +3 -3
- data/generated/google/apis/webmasters_v3.rb +1 -1
- data/generated/google/apis/webmasters_v3/classes.rb +11 -11
- data/generated/google/apis/webmasters_v3/service.rb +3 -3
- data/generated/google/apis/youtube_analytics_v1/service.rb +25 -25
- data/generated/google/apis/youtube_v3/service.rb +305 -305
- data/lib/google/apis/generator/model.rb +10 -0
- data/lib/google/apis/generator/templates/_method.tmpl +3 -3
- data/lib/google/apis/version.rb +1 -1
- metadata +2 -2
@@ -76,7 +76,7 @@ module Google
|
|
76
76
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
77
77
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
78
78
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
79
|
-
def list_detections(q
|
79
|
+
def list_detections(q, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
80
80
|
path = 'v2/detect'
|
81
81
|
command = make_simple_command(:get, path, options)
|
82
82
|
command.response_representation = Google::Apis::TranslateV2::ListDetectionsResponse::Representation
|
@@ -125,16 +125,16 @@ module Google
|
|
125
125
|
end
|
126
126
|
|
127
127
|
# Returns text translations from one language to another.
|
128
|
+
# @param [Array<String>, String] q
|
129
|
+
# The text to translate
|
130
|
+
# @param [String] target
|
131
|
+
# The target language into which the text should be translated
|
128
132
|
# @param [Array<String>, String] cid
|
129
133
|
# The customization id for translate
|
130
134
|
# @param [String] format
|
131
135
|
# The format of the text
|
132
|
-
# @param [Array<String>, String] q
|
133
|
-
# The text to translate
|
134
136
|
# @param [String] source
|
135
137
|
# The source language of the text
|
136
|
-
# @param [String] target
|
137
|
-
# The target language into which the text should be translated
|
138
138
|
# @param [String] fields
|
139
139
|
# Selector specifying which fields to include in a partial response.
|
140
140
|
# @param [String] quota_user
|
@@ -156,7 +156,7 @@ module Google
|
|
156
156
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
157
157
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
158
158
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
159
|
-
def list_translations(
|
159
|
+
def list_translations(q, target, cid: nil, format: nil, source: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
160
160
|
path = 'v2'
|
161
161
|
command = make_simple_command(:get, path, options)
|
162
162
|
command.response_representation = Google::Apis::TranslateV2::ListTranslationsResponse::Representation
|
@@ -53,10 +53,10 @@ module Google
|
|
53
53
|
end
|
54
54
|
|
55
55
|
# Expands a short URL or gets creation time and analytics.
|
56
|
-
# @param [String] projection
|
57
|
-
# Additional information to return.
|
58
56
|
# @param [String] short_url
|
59
57
|
# The short URL, including the protocol.
|
58
|
+
# @param [String] projection
|
59
|
+
# Additional information to return.
|
60
60
|
# @param [String] fields
|
61
61
|
# Selector specifying which fields to include in a partial response.
|
62
62
|
# @param [String] quota_user
|
@@ -78,7 +78,7 @@ module Google
|
|
78
78
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
79
79
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
80
80
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
81
|
-
def get_url(
|
81
|
+
def get_url(short_url, projection: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
82
82
|
path = 'url'
|
83
83
|
command = make_simple_command(:get, path, options)
|
84
84
|
command.response_representation = Google::Apis::UrlshortenerV1::Url::Representation
|
@@ -25,7 +25,7 @@ module Google
|
|
25
25
|
# @see https://developers.google.com/webmaster-tools/
|
26
26
|
module WebmastersV3
|
27
27
|
VERSION = 'V3'
|
28
|
-
REVISION = '
|
28
|
+
REVISION = '20150715'
|
29
29
|
|
30
30
|
# View and modify Webmaster Tools data for your verified sites
|
31
31
|
AUTH_WEBMASTERS = 'https://www.googleapis.com/auth/webmasters'
|
@@ -125,12 +125,12 @@ module Google
|
|
125
125
|
class SearchAnalyticsQueryRequest
|
126
126
|
include Google::Apis::Core::Hashable
|
127
127
|
|
128
|
-
# [Optional; Default is
|
129
|
-
# all data for the same property is aggregated; if aggregated by page,
|
130
|
-
# is aggregated by canonical URI. If you filter or group by page,
|
131
|
-
# otherwise you can aggregate either by property or by page,
|
132
|
-
# you want your data calculated; see the help documentation to
|
133
|
-
# is calculated differently by site versus by page.
|
128
|
+
# [Optional; Default is "auto"] How data is aggregated. If aggregated by
|
129
|
+
# property, all data for the same property is aggregated; if aggregated by page,
|
130
|
+
# all data is aggregated by canonical URI. If you filter or group by page,
|
131
|
+
# choose AUTO; otherwise you can aggregate either by property or by page,
|
132
|
+
# depending on how you want your data calculated; see the help documentation to
|
133
|
+
# learn how data is calculated differently by site versus by page.
|
134
134
|
# Note: If you group or filter by page, you cannot aggregate by property.
|
135
135
|
# If you specify any value other than AUTO, the aggregation type in the result
|
136
136
|
# will match the requested type, or if you request an invalid type, you will get
|
@@ -141,9 +141,9 @@ module Google
|
|
141
141
|
attr_accessor :aggregation_type
|
142
142
|
|
143
143
|
# [Optional] Zero or more filters to apply to the dimension grouping values; for
|
144
|
-
# example, '
|
145
|
-
# contains the substring "
|
146
|
-
# grouping by it.
|
144
|
+
# example, 'query contains "buy"' to see only data where the query string
|
145
|
+
# contains the substring "buy" (not case-sensitive). You can filter by a
|
146
|
+
# dimension without grouping by it.
|
147
147
|
# Corresponds to the JSON property `dimensionFilterGroups`
|
148
148
|
# @return [Array<Google::Apis::WebmastersV3::ApiDimensionFilterGroup>]
|
149
149
|
attr_accessor :dimension_filter_groups
|
@@ -164,12 +164,12 @@ module Google
|
|
164
164
|
attr_accessor :end_date
|
165
165
|
|
166
166
|
# [Optional; Default is 1000] The maximum number of rows to return. Must be a
|
167
|
-
# number from 1 to
|
167
|
+
# number from 1 to 5,000 (inclusive).
|
168
168
|
# Corresponds to the JSON property `rowLimit`
|
169
169
|
# @return [Fixnum]
|
170
170
|
attr_accessor :row_limit
|
171
171
|
|
172
|
-
# [Optional; Default is
|
172
|
+
# [Optional; Default is "web"] The search type to filter for.
|
173
173
|
# Corresponds to the JSON property `searchType`
|
174
174
|
# @return [String]
|
175
175
|
attr_accessor :search_type
|
@@ -471,7 +471,7 @@ module Google
|
|
471
471
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
472
472
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
473
473
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
474
|
-
def get_errors_sample(site_url, url, category
|
474
|
+
def get_errors_sample(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
475
475
|
path = 'sites/{siteUrl}/urlCrawlErrorsSamples/{url}'
|
476
476
|
command = make_simple_command(:get, path, options)
|
477
477
|
command.response_representation = Google::Apis::WebmastersV3::UrlCrawlErrorsSample::Representation
|
@@ -514,7 +514,7 @@ module Google
|
|
514
514
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
515
515
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
516
516
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
517
|
-
def list_errors_samples(site_url, category
|
517
|
+
def list_errors_samples(site_url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
518
518
|
path = 'sites/{siteUrl}/urlCrawlErrorsSamples'
|
519
519
|
command = make_simple_command(:get, path, options)
|
520
520
|
command.response_representation = Google::Apis::WebmastersV3::ListUrlCrawlErrorsSamplesResponse::Representation
|
@@ -561,7 +561,7 @@ module Google
|
|
561
561
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
562
562
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
563
563
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
564
|
-
def mark_as_fixed(site_url, url, category
|
564
|
+
def mark_as_fixed(site_url, url, category, platform, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
565
565
|
path = 'sites/{siteUrl}/urlCrawlErrorsSamples/{url}'
|
566
566
|
command = make_simple_command(:delete, path, options)
|
567
567
|
command.params['siteUrl'] = site_url unless site_url.nil?
|
@@ -77,7 +77,7 @@ module Google
|
|
77
77
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
78
78
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
79
79
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
80
|
-
def list_batch_report_definitions(on_behalf_of_content_owner
|
80
|
+
def list_batch_report_definitions(on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
81
81
|
path = 'batchReportDefinitions'
|
82
82
|
command = make_simple_command(:get, path, options)
|
83
83
|
command.response_representation = Google::Apis::YoutubeAnalyticsV1::BatchReportDefinitionList::Representation
|
@@ -117,7 +117,7 @@ module Google
|
|
117
117
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
118
118
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
119
119
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
120
|
-
def list_batch_reports(batch_report_definition_id
|
120
|
+
def list_batch_reports(batch_report_definition_id, on_behalf_of_content_owner, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
121
121
|
path = 'batchReports'
|
122
122
|
command = make_simple_command(:get, path, options)
|
123
123
|
command.response_representation = Google::Apis::YoutubeAnalyticsV1::BatchReportList::Representation
|
@@ -165,7 +165,7 @@ module Google
|
|
165
165
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
166
166
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
167
167
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
168
|
-
def delete_group_item(id
|
168
|
+
def delete_group_item(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
169
169
|
path = 'groupItems'
|
170
170
|
command = make_simple_command(:delete, path, options)
|
171
171
|
command.query['id'] = id unless id.nil?
|
@@ -258,7 +258,7 @@ module Google
|
|
258
258
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
259
259
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
260
260
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
261
|
-
def list_group_items(group_id
|
261
|
+
def list_group_items(group_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
262
262
|
path = 'groupItems'
|
263
263
|
command = make_simple_command(:get, path, options)
|
264
264
|
command.response_representation = Google::Apis::YoutubeAnalyticsV1::ListGroupItemResponse::Representation
|
@@ -306,7 +306,7 @@ module Google
|
|
306
306
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
307
307
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
308
308
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
309
|
-
def delete_group(id
|
309
|
+
def delete_group(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
310
310
|
path = 'groups'
|
311
311
|
command = make_simple_command(:delete, path, options)
|
312
312
|
command.query['id'] = id unless id.nil?
|
@@ -467,6 +467,25 @@ module Google
|
|
467
467
|
end
|
468
468
|
|
469
469
|
# Retrieve your YouTube Analytics reports.
|
470
|
+
# @param [String] ids
|
471
|
+
# Identifies the YouTube channel or content owner for which you are retrieving
|
472
|
+
# YouTube Analytics data.
|
473
|
+
# - To request data for a YouTube user, set the ids parameter value to channel==
|
474
|
+
# CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.
|
475
|
+
# - To request data for a YouTube CMS content owner, set the ids parameter value
|
476
|
+
# to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content
|
477
|
+
# owner.
|
478
|
+
# @param [String] start_date
|
479
|
+
# The start date for fetching YouTube Analytics data. The value should be in
|
480
|
+
# YYYY-MM-DD format.
|
481
|
+
# @param [String] end_date
|
482
|
+
# The end date for fetching YouTube Analytics data. The value should be in YYYY-
|
483
|
+
# MM-DD format.
|
484
|
+
# @param [String] metrics
|
485
|
+
# A comma-separated list of YouTube Analytics metrics, such as views or likes,
|
486
|
+
# dislikes. See the Available Reports document for a list of the reports that
|
487
|
+
# you can retrieve and the metrics available in each report, and see the Metrics
|
488
|
+
# document for definitions of those metrics.
|
470
489
|
# @param [String] currency
|
471
490
|
# The currency to which financial metrics should be converted. The default is US
|
472
491
|
# Dollar (USD). If the result contains no financial metrics, this flag will be
|
@@ -476,9 +495,6 @@ module Google
|
|
476
495
|
# ageGroup,gender. See the Available Reports document for a list of the reports
|
477
496
|
# that you can retrieve and the dimensions used for those reports. Also see the
|
478
497
|
# Dimensions document for definitions of those dimensions.
|
479
|
-
# @param [String] end_date
|
480
|
-
# The end date for fetching YouTube Analytics data. The value should be in YYYY-
|
481
|
-
# MM-DD format.
|
482
498
|
# @param [String] filters
|
483
499
|
# A list of filters that should be applied when retrieving YouTube Analytics
|
484
500
|
# data. The Available Reports document identifies the dimensions that can be
|
@@ -487,28 +503,12 @@ module Google
|
|
487
503
|
# semicolon (;), and the returned result table will satisfy both filters. For
|
488
504
|
# example, a filters parameter value of video==dMH0bHeiRNg;country==IT restricts
|
489
505
|
# the result set to include data for the given video in Italy.
|
490
|
-
# @param [String] ids
|
491
|
-
# Identifies the YouTube channel or content owner for which you are retrieving
|
492
|
-
# YouTube Analytics data.
|
493
|
-
# - To request data for a YouTube user, set the ids parameter value to channel==
|
494
|
-
# CHANNEL_ID, where CHANNEL_ID specifies the unique YouTube channel ID.
|
495
|
-
# - To request data for a YouTube CMS content owner, set the ids parameter value
|
496
|
-
# to contentOwner==OWNER_NAME, where OWNER_NAME is the CMS name of the content
|
497
|
-
# owner.
|
498
506
|
# @param [Fixnum] max_results
|
499
507
|
# The maximum number of rows to include in the response.
|
500
|
-
# @param [String] metrics
|
501
|
-
# A comma-separated list of YouTube Analytics metrics, such as views or likes,
|
502
|
-
# dislikes. See the Available Reports document for a list of the reports that
|
503
|
-
# you can retrieve and the metrics available in each report, and see the Metrics
|
504
|
-
# document for definitions of those metrics.
|
505
508
|
# @param [String] sort
|
506
509
|
# A comma-separated list of dimensions or metrics that determine the sort order
|
507
510
|
# for YouTube Analytics data. By default the sort order is ascending. The '-'
|
508
511
|
# prefix causes descending sort order.
|
509
|
-
# @param [String] start_date
|
510
|
-
# The start date for fetching YouTube Analytics data. The value should be in
|
511
|
-
# YYYY-MM-DD format.
|
512
512
|
# @param [Fixnum] start_index
|
513
513
|
# An index of the first entity to retrieve. Use this parameter as a pagination
|
514
514
|
# mechanism along with the max-results parameter (one-based, inclusive).
|
@@ -533,7 +533,7 @@ module Google
|
|
533
533
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
534
534
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
535
535
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
536
|
-
def query_report(
|
536
|
+
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)
|
537
537
|
path = 'reports'
|
538
538
|
command = make_simple_command(:get, path, options)
|
539
539
|
command.response_representation = Google::Apis::YoutubeAnalyticsV1::ResultTable::Representation
|
@@ -59,11 +59,11 @@ module Google
|
|
59
59
|
# other API methods to generate those activity resources. For example, you would
|
60
60
|
# use the API's videos.rate() method to rate a video and the playlistItems.
|
61
61
|
# insert() method to mark a video as a favorite.
|
62
|
-
# @param [Google::Apis::YoutubeV3::Activity] activity_object
|
63
62
|
# @param [String] part
|
64
63
|
# The part parameter serves two purposes in this operation. It identifies the
|
65
64
|
# properties that the write operation will set as well as the properties that
|
66
65
|
# the API response will include.
|
66
|
+
# @param [Google::Apis::YoutubeV3::Activity] activity_object
|
67
67
|
# @param [String] fields
|
68
68
|
# Selector specifying which fields to include in a partial response.
|
69
69
|
# @param [String] quota_user
|
@@ -85,7 +85,7 @@ module Google
|
|
85
85
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
86
86
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
87
87
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
88
|
-
def insert_activity(activity_object = nil,
|
88
|
+
def insert_activity(part, activity_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
89
89
|
path = 'activities'
|
90
90
|
command = make_simple_command(:post, path, options)
|
91
91
|
command.request_representation = Google::Apis::YoutubeV3::Activity::Representation
|
@@ -103,6 +103,15 @@ module Google
|
|
103
103
|
# example, you can retrieve events associated with a particular channel, events
|
104
104
|
# associated with the user's subscriptions and Google+ friends, or the YouTube
|
105
105
|
# home page feed, which is customized for each user.
|
106
|
+
# @param [String] part
|
107
|
+
# The part parameter specifies a comma-separated list of one or more activity
|
108
|
+
# resource properties that the API response will include.
|
109
|
+
# If the parameter identifies a property that contains child properties, the
|
110
|
+
# child properties will be included in the response. For example, in an activity
|
111
|
+
# resource, the snippet property contains other properties that identify the
|
112
|
+
# type of activity, a display title for the activity, and so forth. If you set
|
113
|
+
# part=snippet, the API response will also contain all of those nested
|
114
|
+
# properties.
|
106
115
|
# @param [String] channel_id
|
107
116
|
# The channelId parameter specifies a unique YouTube channel ID. The API will
|
108
117
|
# then return a list of that channel's activities.
|
@@ -119,15 +128,6 @@ module Google
|
|
119
128
|
# The pageToken parameter identifies a specific page in the result set that
|
120
129
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
121
130
|
# properties identify other pages that could be retrieved.
|
122
|
-
# @param [String] part
|
123
|
-
# The part parameter specifies a comma-separated list of one or more activity
|
124
|
-
# resource properties that the API response will include.
|
125
|
-
# If the parameter identifies a property that contains child properties, the
|
126
|
-
# child properties will be included in the response. For example, in an activity
|
127
|
-
# resource, the snippet property contains other properties that identify the
|
128
|
-
# type of activity, a display title for the activity, and so forth. If you set
|
129
|
-
# part=snippet, the API response will also contain all of those nested
|
130
|
-
# properties.
|
131
131
|
# @param [DateTime] published_after
|
132
132
|
# The publishedAfter parameter specifies the earliest date and time that an
|
133
133
|
# activity could have occurred for that activity to be included in the API
|
@@ -166,7 +166,7 @@ module Google
|
|
166
166
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
167
167
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
168
168
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
169
|
-
def list_activities(channel_id: nil, home: nil, max_results: nil, mine: nil, page_token: nil,
|
169
|
+
def list_activities(part, channel_id: nil, home: nil, max_results: nil, mine: nil, page_token: nil, published_after: nil, published_before: nil, region_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
170
170
|
path = 'activities'
|
171
171
|
command = make_simple_command(:get, path, options)
|
172
172
|
command.response_representation = Google::Apis::YoutubeV3::ListActivitiesResponse::Representation
|
@@ -187,12 +187,12 @@ module Google
|
|
187
187
|
end
|
188
188
|
|
189
189
|
# Deletes a specified caption track.
|
190
|
-
# @param [String] debug_project_id_override
|
191
|
-
# The debugProjectIdOverride parameter should be used for mimicking a request
|
192
|
-
# for a certain project ID
|
193
190
|
# @param [String] id
|
194
191
|
# The id parameter identifies the caption track that is being deleted. The value
|
195
192
|
# is a caption track ID as identified by the id property in a caption resource.
|
193
|
+
# @param [String] debug_project_id_override
|
194
|
+
# The debugProjectIdOverride parameter should be used for mimicking a request
|
195
|
+
# for a certain project ID
|
196
196
|
# @param [String] on_behalf_of
|
197
197
|
# ID of the Google+ Page for the channel that the request is be on behalf of
|
198
198
|
# @param [String] on_behalf_of_content_owner
|
@@ -226,7 +226,7 @@ module Google
|
|
226
226
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
227
227
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
228
228
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
229
|
-
def delete_caption(
|
229
|
+
def delete_caption(id, debug_project_id_override: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
230
230
|
path = 'captions'
|
231
231
|
command = make_simple_command(:delete, path, options)
|
232
232
|
command.query['debugProjectIdOverride'] = debug_project_id_override unless debug_project_id_override.nil?
|
@@ -315,6 +315,9 @@ module Google
|
|
315
315
|
end
|
316
316
|
|
317
317
|
# Uploads a caption track.
|
318
|
+
# @param [String] part
|
319
|
+
# The part parameter specifies the caption resource parts that the API response
|
320
|
+
# will include. Set the parameter value to snippet.
|
318
321
|
# @param [Google::Apis::YoutubeV3::Caption] caption_object
|
319
322
|
# @param [String] debug_project_id_override
|
320
323
|
# The debugProjectIdOverride parameter should be used for mimicking a request
|
@@ -331,9 +334,6 @@ module Google
|
|
331
334
|
# to all their video and channel data, without having to provide authentication
|
332
335
|
# credentials for each individual channel. The actual CMS account that the user
|
333
336
|
# authenticates with must be linked to the specified YouTube content owner.
|
334
|
-
# @param [String] part
|
335
|
-
# The part parameter specifies the caption resource parts that the API response
|
336
|
-
# will include. Set the parameter value to snippet.
|
337
337
|
# @param [Boolean] sync
|
338
338
|
# The sync parameter indicates whether YouTube should automatically synchronize
|
339
339
|
# the caption file with the audio track of the video. If you set the value to
|
@@ -367,7 +367,7 @@ module Google
|
|
367
367
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
368
368
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
369
369
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
370
|
-
def insert_caption(caption_object = nil, debug_project_id_override: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil,
|
370
|
+
def insert_caption(part, caption_object = nil, debug_project_id_override: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, sync: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
371
371
|
path = 'captions'
|
372
372
|
if upload_source.nil?
|
373
373
|
command = make_simple_command(:post, path, options)
|
@@ -394,6 +394,13 @@ module Google
|
|
394
394
|
# Returns a list of caption tracks that are associated with a specified video.
|
395
395
|
# Note that the API response does not contain the actual captions and that the
|
396
396
|
# captions.download method provides the ability to retrieve a caption track.
|
397
|
+
# @param [String] part
|
398
|
+
# The part parameter specifies a comma-separated list of one or more caption
|
399
|
+
# resource parts that the API response will include. The part names that you can
|
400
|
+
# include in the parameter value are id and snippet.
|
401
|
+
# @param [String] video_id
|
402
|
+
# The videoId parameter specifies the YouTube video ID of the video for which
|
403
|
+
# the API should return caption tracks.
|
397
404
|
# @param [String] debug_project_id_override
|
398
405
|
# The debugProjectIdOverride parameter should be used for mimicking a request
|
399
406
|
# for a certain project ID.
|
@@ -413,13 +420,6 @@ module Google
|
|
413
420
|
# to all their video and channel data, without having to provide authentication
|
414
421
|
# credentials for each individual channel. The actual CMS account that the user
|
415
422
|
# authenticates with must be linked to the specified YouTube content owner.
|
416
|
-
# @param [String] part
|
417
|
-
# The part parameter specifies a comma-separated list of one or more caption
|
418
|
-
# resource parts that the API response will include. The part names that you can
|
419
|
-
# include in the parameter value are id and snippet.
|
420
|
-
# @param [String] video_id
|
421
|
-
# The videoId parameter specifies the YouTube video ID of the video for which
|
422
|
-
# the API should return caption tracks.
|
423
423
|
# @param [String] fields
|
424
424
|
# Selector specifying which fields to include in a partial response.
|
425
425
|
# @param [String] quota_user
|
@@ -441,7 +441,7 @@ module Google
|
|
441
441
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
442
442
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
443
443
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
444
|
-
def list_captions(debug_project_id_override: nil, id: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil,
|
444
|
+
def list_captions(part, video_id, debug_project_id_override: nil, id: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
445
445
|
path = 'captions'
|
446
446
|
command = make_simple_command(:get, path, options)
|
447
447
|
command.response_representation = Google::Apis::YoutubeV3::ListCaptionsResponse::Representation
|
@@ -460,6 +460,11 @@ module Google
|
|
460
460
|
|
461
461
|
# Updates a caption track. When updating a caption track, you can change the
|
462
462
|
# track's draft status, upload a new caption file for the track, or both.
|
463
|
+
# @param [String] part
|
464
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
465
|
+
# properties that the write operation will set as well as the properties that
|
466
|
+
# the API response will include. Set the property value to snippet if you are
|
467
|
+
# updating the track's draft status. Otherwise, set the property value to id.
|
463
468
|
# @param [Google::Apis::YoutubeV3::Caption] caption_object
|
464
469
|
# @param [String] debug_project_id_override
|
465
470
|
# The debugProjectIdOverride parameter should be used for mimicking a request
|
@@ -476,11 +481,6 @@ module Google
|
|
476
481
|
# to all their video and channel data, without having to provide authentication
|
477
482
|
# credentials for each individual channel. The actual CMS account that the user
|
478
483
|
# authenticates with must be linked to the specified YouTube content owner.
|
479
|
-
# @param [String] part
|
480
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
481
|
-
# properties that the write operation will set as well as the properties that
|
482
|
-
# the API response will include. Set the property value to snippet if you are
|
483
|
-
# updating the track's draft status. Otherwise, set the property value to id.
|
484
484
|
# @param [Boolean] sync
|
485
485
|
# Note: The API server only processes the parameter value if the request
|
486
486
|
# contains an updated caption file.
|
@@ -513,7 +513,7 @@ module Google
|
|
513
513
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
514
514
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
515
515
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
516
|
-
def update_caption(caption_object = nil, debug_project_id_override: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil,
|
516
|
+
def update_caption(part, caption_object = nil, debug_project_id_override: nil, on_behalf_of: nil, on_behalf_of_content_owner: nil, sync: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
517
517
|
path = 'captions'
|
518
518
|
if upload_source.nil?
|
519
519
|
command = make_simple_command(:put, path, options)
|
@@ -639,7 +639,7 @@ module Google
|
|
639
639
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
640
640
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
641
641
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
642
|
-
def delete_channel_section(id
|
642
|
+
def delete_channel_section(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
643
643
|
path = 'channelSections'
|
644
644
|
command = make_simple_command(:delete, path, options)
|
645
645
|
command.query['id'] = id unless id.nil?
|
@@ -651,6 +651,12 @@ module Google
|
|
651
651
|
end
|
652
652
|
|
653
653
|
# Adds a channelSection for the authenticated user's channel.
|
654
|
+
# @param [String] part
|
655
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
656
|
+
# properties that the write operation will set as well as the properties that
|
657
|
+
# the API response will include.
|
658
|
+
# The part names that you can include in the parameter value are snippet and
|
659
|
+
# contentDetails.
|
654
660
|
# @param [Google::Apis::YoutubeV3::ChannelSection] channel_section_object
|
655
661
|
# @param [String] on_behalf_of_content_owner
|
656
662
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -678,12 +684,6 @@ module Google
|
|
678
684
|
# many different YouTube channels. It allows content owners to authenticate once
|
679
685
|
# and perform actions on behalf of the channel specified in the parameter value,
|
680
686
|
# without having to provide authentication credentials for each separate channel.
|
681
|
-
# @param [String] part
|
682
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
683
|
-
# properties that the write operation will set as well as the properties that
|
684
|
-
# the API response will include.
|
685
|
-
# The part names that you can include in the parameter value are snippet and
|
686
|
-
# contentDetails.
|
687
687
|
# @param [String] fields
|
688
688
|
# Selector specifying which fields to include in a partial response.
|
689
689
|
# @param [String] quota_user
|
@@ -705,7 +705,7 @@ module Google
|
|
705
705
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
706
706
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
707
707
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
708
|
-
def insert_channel_section(channel_section_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil,
|
708
|
+
def insert_channel_section(part, channel_section_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
709
709
|
path = 'channelSections'
|
710
710
|
command = make_simple_command(:post, path, options)
|
711
711
|
command.request_representation = Google::Apis::YoutubeV3::ChannelSection::Representation
|
@@ -722,6 +722,16 @@ module Google
|
|
722
722
|
end
|
723
723
|
|
724
724
|
# Returns channelSection resources that match the API request criteria.
|
725
|
+
# @param [String] part
|
726
|
+
# The part parameter specifies a comma-separated list of one or more
|
727
|
+
# channelSection resource properties that the API response will include. The
|
728
|
+
# part names that you can include in the parameter value are id, snippet, and
|
729
|
+
# contentDetails.
|
730
|
+
# If the parameter identifies a property that contains child properties, the
|
731
|
+
# child properties will be included in the response. For example, in a
|
732
|
+
# channelSection resource, the snippet property contains other properties, such
|
733
|
+
# as a display title for the channelSection. If you set part=snippet, the API
|
734
|
+
# response will also contain all of those nested properties.
|
725
735
|
# @param [String] channel_id
|
726
736
|
# The channelId parameter specifies a YouTube channel ID. The API will only
|
727
737
|
# return that channel's channelSections.
|
@@ -751,16 +761,6 @@ module Google
|
|
751
761
|
# to all their video and channel data, without having to provide authentication
|
752
762
|
# credentials for each individual channel. The CMS account that the user
|
753
763
|
# authenticates with must be linked to the specified YouTube content owner.
|
754
|
-
# @param [String] part
|
755
|
-
# The part parameter specifies a comma-separated list of one or more
|
756
|
-
# channelSection resource properties that the API response will include. The
|
757
|
-
# part names that you can include in the parameter value are id, snippet, and
|
758
|
-
# contentDetails.
|
759
|
-
# If the parameter identifies a property that contains child properties, the
|
760
|
-
# child properties will be included in the response. For example, in a
|
761
|
-
# channelSection resource, the snippet property contains other properties, such
|
762
|
-
# as a display title for the channelSection. If you set part=snippet, the API
|
763
|
-
# response will also contain all of those nested properties.
|
764
764
|
# @param [String] fields
|
765
765
|
# Selector specifying which fields to include in a partial response.
|
766
766
|
# @param [String] quota_user
|
@@ -782,7 +782,7 @@ module Google
|
|
782
782
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
783
783
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
784
784
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
785
|
-
def list_channel_sections(channel_id: nil, hl: nil, id: nil, mine: nil, on_behalf_of_content_owner: nil,
|
785
|
+
def list_channel_sections(part, channel_id: nil, hl: nil, id: nil, mine: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
786
786
|
path = 'channelSections'
|
787
787
|
command = make_simple_command(:get, path, options)
|
788
788
|
command.response_representation = Google::Apis::YoutubeV3::ListChannelSectionsResponse::Representation
|
@@ -800,6 +800,12 @@ module Google
|
|
800
800
|
end
|
801
801
|
|
802
802
|
# Update a channelSection.
|
803
|
+
# @param [String] part
|
804
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
805
|
+
# properties that the write operation will set as well as the properties that
|
806
|
+
# the API response will include.
|
807
|
+
# The part names that you can include in the parameter value are snippet and
|
808
|
+
# contentDetails.
|
803
809
|
# @param [Google::Apis::YoutubeV3::ChannelSection] channel_section_object
|
804
810
|
# @param [String] on_behalf_of_content_owner
|
805
811
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -811,12 +817,6 @@ module Google
|
|
811
817
|
# to all their video and channel data, without having to provide authentication
|
812
818
|
# credentials for each individual channel. The CMS account that the user
|
813
819
|
# authenticates with must be linked to the specified YouTube content owner.
|
814
|
-
# @param [String] part
|
815
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
816
|
-
# properties that the write operation will set as well as the properties that
|
817
|
-
# the API response will include.
|
818
|
-
# The part names that you can include in the parameter value are snippet and
|
819
|
-
# contentDetails.
|
820
820
|
# @param [String] fields
|
821
821
|
# Selector specifying which fields to include in a partial response.
|
822
822
|
# @param [String] quota_user
|
@@ -838,7 +838,7 @@ module Google
|
|
838
838
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
839
839
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
840
840
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
841
|
-
def update_channel_section(channel_section_object = nil, on_behalf_of_content_owner: nil,
|
841
|
+
def update_channel_section(part, channel_section_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
842
842
|
path = 'channelSections'
|
843
843
|
command = make_simple_command(:put, path, options)
|
844
844
|
command.request_representation = Google::Apis::YoutubeV3::ChannelSection::Representation
|
@@ -855,6 +855,14 @@ module Google
|
|
855
855
|
|
856
856
|
# Returns a collection of zero or more channel resources that match the request
|
857
857
|
# criteria.
|
858
|
+
# @param [String] part
|
859
|
+
# The part parameter specifies a comma-separated list of one or more channel
|
860
|
+
# resource properties that the API response will include.
|
861
|
+
# If the parameter identifies a property that contains child properties, the
|
862
|
+
# child properties will be included in the response. For example, in a channel
|
863
|
+
# resource, the contentDetails property contains other properties, such as the
|
864
|
+
# uploads properties. As such, if you set part=contentDetails, the API response
|
865
|
+
# will also contain all of those nested properties.
|
858
866
|
# @param [String] category_id
|
859
867
|
# The categoryId parameter specifies a YouTube guide category, thereby
|
860
868
|
# requesting YouTube channels associated with that category.
|
@@ -897,14 +905,6 @@ module Google
|
|
897
905
|
# The pageToken parameter identifies a specific page in the result set that
|
898
906
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
899
907
|
# properties identify other pages that could be retrieved.
|
900
|
-
# @param [String] part
|
901
|
-
# The part parameter specifies a comma-separated list of one or more channel
|
902
|
-
# resource properties that the API response will include.
|
903
|
-
# If the parameter identifies a property that contains child properties, the
|
904
|
-
# child properties will be included in the response. For example, in a channel
|
905
|
-
# resource, the contentDetails property contains other properties, such as the
|
906
|
-
# uploads properties. As such, if you set part=contentDetails, the API response
|
907
|
-
# will also contain all of those nested properties.
|
908
908
|
# @param [String] fields
|
909
909
|
# Selector specifying which fields to include in a partial response.
|
910
910
|
# @param [String] quota_user
|
@@ -926,7 +926,7 @@ module Google
|
|
926
926
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
927
927
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
928
928
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
929
|
-
def list_channels(category_id: nil, for_username: nil, hl: nil, id: nil, managed_by_me: nil, max_results: nil, mine: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, page_token: nil,
|
929
|
+
def list_channels(part, category_id: nil, for_username: nil, hl: nil, id: nil, managed_by_me: nil, max_results: nil, mine: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
930
930
|
path = 'channels'
|
931
931
|
command = make_simple_command(:get, path, options)
|
932
932
|
command.response_representation = Google::Apis::YoutubeV3::ListChannelsResponse::Representation
|
@@ -951,6 +951,15 @@ module Google
|
|
951
951
|
# Updates a channel's metadata. Note that this method currently only supports
|
952
952
|
# updates to the channel resource's brandingSettings and invideoPromotion
|
953
953
|
# objects and their child properties.
|
954
|
+
# @param [String] part
|
955
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
956
|
+
# properties that the write operation will set as well as the properties that
|
957
|
+
# the API response will include.
|
958
|
+
# The API currently only allows the parameter value to be set to either
|
959
|
+
# brandingSettings or invideoPromotion. (You cannot update both of those parts
|
960
|
+
# with a single request.)
|
961
|
+
# Note that this method overrides the existing values for all of the mutable
|
962
|
+
# properties that are contained in any parts that the parameter value specifies.
|
954
963
|
# @param [Google::Apis::YoutubeV3::Channel] channel_object
|
955
964
|
# @param [String] on_behalf_of_content_owner
|
956
965
|
# The onBehalfOfContentOwner parameter indicates that the authenticated user is
|
@@ -961,15 +970,6 @@ module Google
|
|
961
970
|
# authentication credentials for each individual channel. The actual CMS account
|
962
971
|
# that the user authenticates with needs to be linked to the specified YouTube
|
963
972
|
# content owner.
|
964
|
-
# @param [String] part
|
965
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
966
|
-
# properties that the write operation will set as well as the properties that
|
967
|
-
# the API response will include.
|
968
|
-
# The API currently only allows the parameter value to be set to either
|
969
|
-
# brandingSettings or invideoPromotion. (You cannot update both of those parts
|
970
|
-
# with a single request.)
|
971
|
-
# Note that this method overrides the existing values for all of the mutable
|
972
|
-
# properties that are contained in any parts that the parameter value specifies.
|
973
973
|
# @param [String] fields
|
974
974
|
# Selector specifying which fields to include in a partial response.
|
975
975
|
# @param [String] quota_user
|
@@ -991,7 +991,7 @@ module Google
|
|
991
991
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
992
992
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
993
993
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
994
|
-
def update_channel(channel_object = nil, on_behalf_of_content_owner: nil,
|
994
|
+
def update_channel(part, channel_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
995
995
|
path = 'channels'
|
996
996
|
command = make_simple_command(:put, path, options)
|
997
997
|
command.request_representation = Google::Apis::YoutubeV3::Channel::Representation
|
@@ -1008,11 +1008,11 @@ module Google
|
|
1008
1008
|
|
1009
1009
|
# Creates a new top-level comment. To add a reply to an existing comment, use
|
1010
1010
|
# the comments.insert method instead.
|
1011
|
-
# @param [Google::Apis::YoutubeV3::CommentThread] comment_thread_object
|
1012
1011
|
# @param [String] part
|
1013
1012
|
# The part parameter identifies the properties that the API response will
|
1014
1013
|
# include. Set the parameter value to snippet. The snippet part has a quota cost
|
1015
1014
|
# of 2 units.
|
1015
|
+
# @param [Google::Apis::YoutubeV3::CommentThread] comment_thread_object
|
1016
1016
|
# @param [Boolean] share_on_google_plus
|
1017
1017
|
# The shareOnGooglePlus parameter indicates whether the top-level comment and
|
1018
1018
|
# any replies that are made to that comment should also be posted to the author'
|
@@ -1038,7 +1038,7 @@ module Google
|
|
1038
1038
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1039
1039
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1040
1040
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1041
|
-
def insert_comment_thread(comment_thread_object = nil,
|
1041
|
+
def insert_comment_thread(part, comment_thread_object = nil, share_on_google_plus: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1042
1042
|
path = 'commentThreads'
|
1043
1043
|
command = make_simple_command(:post, path, options)
|
1044
1044
|
command.request_representation = Google::Apis::YoutubeV3::CommentThread::Representation
|
@@ -1054,6 +1054,9 @@ module Google
|
|
1054
1054
|
end
|
1055
1055
|
|
1056
1056
|
# Returns a list of comment threads that match the API request parameters.
|
1057
|
+
# @param [String] part
|
1058
|
+
# The part parameter specifies a comma-separated list of one or more
|
1059
|
+
# commentThread resource properties that the API response will include.
|
1057
1060
|
# @param [String] all_threads_related_to_channel_id
|
1058
1061
|
# The allThreadsRelatedToChannelId parameter instructs the API to return all
|
1059
1062
|
# comment threads associated with the specified channel. The response can
|
@@ -1087,9 +1090,6 @@ module Google
|
|
1087
1090
|
# the next page of the result that can be retrieved.
|
1088
1091
|
# Note: This parameter is not supported for use in conjunction with the id
|
1089
1092
|
# parameter.
|
1090
|
-
# @param [String] part
|
1091
|
-
# The part parameter specifies a comma-separated list of one or more
|
1092
|
-
# commentThread resource properties that the API response will include.
|
1093
1093
|
# @param [String] search_terms
|
1094
1094
|
# The searchTerms parameter instructs the API to limit the API response to only
|
1095
1095
|
# contain comments that contain the specified search terms.
|
@@ -1122,7 +1122,7 @@ module Google
|
|
1122
1122
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1123
1123
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1124
1124
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1125
|
-
def list_comment_threads(all_threads_related_to_channel_id: nil, channel_id: nil, id: nil, max_results: nil, moderation_status: nil, order: nil, page_token: nil,
|
1125
|
+
def list_comment_threads(part, all_threads_related_to_channel_id: nil, channel_id: nil, id: nil, max_results: nil, moderation_status: nil, order: nil, page_token: nil, search_terms: nil, text_format: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1126
1126
|
path = 'commentThreads'
|
1127
1127
|
command = make_simple_command(:get, path, options)
|
1128
1128
|
command.response_representation = Google::Apis::YoutubeV3::ListCommentThreadsResponse::Representation
|
@@ -1145,12 +1145,12 @@ module Google
|
|
1145
1145
|
end
|
1146
1146
|
|
1147
1147
|
# Modifies the top-level comment in a comment thread.
|
1148
|
-
# @param [Google::Apis::YoutubeV3::CommentThread] comment_thread_object
|
1149
1148
|
# @param [String] part
|
1150
1149
|
# The part parameter specifies a comma-separated list of commentThread resource
|
1151
1150
|
# properties that the API response will include. You must at least include the
|
1152
1151
|
# snippet part in the parameter value since that part contains all of the
|
1153
1152
|
# properties that the API request can update.
|
1153
|
+
# @param [Google::Apis::YoutubeV3::CommentThread] comment_thread_object
|
1154
1154
|
# @param [String] fields
|
1155
1155
|
# Selector specifying which fields to include in a partial response.
|
1156
1156
|
# @param [String] quota_user
|
@@ -1172,7 +1172,7 @@ module Google
|
|
1172
1172
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1173
1173
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1174
1174
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1175
|
-
def update_comment_thread(comment_thread_object = nil,
|
1175
|
+
def update_comment_thread(part, comment_thread_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1176
1176
|
path = 'commentThreads'
|
1177
1177
|
command = make_simple_command(:put, path, options)
|
1178
1178
|
command.request_representation = Google::Apis::YoutubeV3::CommentThread::Representation
|
@@ -1211,7 +1211,7 @@ module Google
|
|
1211
1211
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1212
1212
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1213
1213
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1214
|
-
def delete_comment(id
|
1214
|
+
def delete_comment(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1215
1215
|
path = 'comments'
|
1216
1216
|
command = make_simple_command(:delete, path, options)
|
1217
1217
|
command.query['id'] = id unless id.nil?
|
@@ -1223,11 +1223,11 @@ module Google
|
|
1223
1223
|
|
1224
1224
|
# Creates a reply to an existing comment. Note: To create a top-level comment,
|
1225
1225
|
# use the commentThreads.insert method.
|
1226
|
-
# @param [Google::Apis::YoutubeV3::Comment] comment_object
|
1227
1226
|
# @param [String] part
|
1228
1227
|
# The part parameter identifies the properties that the API response will
|
1229
1228
|
# include. Set the parameter value to snippet. The snippet part has a quota cost
|
1230
1229
|
# of 2 units.
|
1230
|
+
# @param [Google::Apis::YoutubeV3::Comment] comment_object
|
1231
1231
|
# @param [String] fields
|
1232
1232
|
# Selector specifying which fields to include in a partial response.
|
1233
1233
|
# @param [String] quota_user
|
@@ -1249,7 +1249,7 @@ module Google
|
|
1249
1249
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1250
1250
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1251
1251
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1252
|
-
def insert_comment(comment_object = nil,
|
1252
|
+
def insert_comment(part, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1253
1253
|
path = 'comments'
|
1254
1254
|
command = make_simple_command(:post, path, options)
|
1255
1255
|
command.request_representation = Google::Apis::YoutubeV3::Comment::Representation
|
@@ -1264,6 +1264,9 @@ module Google
|
|
1264
1264
|
end
|
1265
1265
|
|
1266
1266
|
# Returns a list of comments that match the API request parameters.
|
1267
|
+
# @param [String] part
|
1268
|
+
# The part parameter specifies a comma-separated list of one or more comment
|
1269
|
+
# resource properties that the API response will include.
|
1267
1270
|
# @param [String] id
|
1268
1271
|
# The id parameter specifies a comma-separated list of comment IDs for the
|
1269
1272
|
# resources that are being retrieved. In a comment resource, the id property
|
@@ -1284,9 +1287,6 @@ module Google
|
|
1284
1287
|
# should be retrieved.
|
1285
1288
|
# Note: YouTube currently supports replies only for top-level comments. However,
|
1286
1289
|
# replies to replies may be supported in the future.
|
1287
|
-
# @param [String] part
|
1288
|
-
# The part parameter specifies a comma-separated list of one or more comment
|
1289
|
-
# resource properties that the API response will include.
|
1290
1290
|
# @param [String] text_format
|
1291
1291
|
# This parameter indicates whether the API should return comments formatted as
|
1292
1292
|
# HTML or as plain text.
|
@@ -1311,7 +1311,7 @@ module Google
|
|
1311
1311
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1312
1312
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1313
1313
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1314
|
-
def list_comments(id: nil, max_results: nil, page_token: nil, parent_id: nil,
|
1314
|
+
def list_comments(part, id: nil, max_results: nil, page_token: nil, parent_id: nil, text_format: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1315
1315
|
path = 'comments'
|
1316
1316
|
command = make_simple_command(:get, path, options)
|
1317
1317
|
command.response_representation = Google::Apis::YoutubeV3::ListCommentsResponse::Representation
|
@@ -1354,7 +1354,7 @@ module Google
|
|
1354
1354
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1355
1355
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1356
1356
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1357
|
-
def mark_as_spam_comment(id
|
1357
|
+
def mark_as_spam_comment(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1358
1358
|
path = 'comments/markAsSpam'
|
1359
1359
|
command = make_simple_command(:post, path, options)
|
1360
1360
|
command.query['id'] = id unless id.nil?
|
@@ -1366,17 +1366,17 @@ module Google
|
|
1366
1366
|
|
1367
1367
|
# Sets the moderation status of one or more comments. The API request must be
|
1368
1368
|
# authorized by the owner of the channel or video associated with the comments.
|
1369
|
+
# @param [String] id
|
1370
|
+
# The id parameter specifies a comma-separated list of IDs that identify the
|
1371
|
+
# comments for which you are updating the moderation status.
|
1372
|
+
# @param [String] moderation_status
|
1373
|
+
# Identifies the new moderation status of the specified comments.
|
1369
1374
|
# @param [Boolean] ban_author
|
1370
1375
|
# The banAuthor parameter lets you indicate that you want to automatically
|
1371
1376
|
# reject any additional comments written by the comment's author. Set the
|
1372
1377
|
# parameter value to true to ban the author.
|
1373
1378
|
# Note: This parameter is only valid if the moderationStatus parameter is also
|
1374
1379
|
# set to rejected.
|
1375
|
-
# @param [String] id
|
1376
|
-
# The id parameter specifies a comma-separated list of IDs that identify the
|
1377
|
-
# comments for which you are updating the moderation status.
|
1378
|
-
# @param [String] moderation_status
|
1379
|
-
# Identifies the new moderation status of the specified comments.
|
1380
1380
|
# @param [String] fields
|
1381
1381
|
# Selector specifying which fields to include in a partial response.
|
1382
1382
|
# @param [String] quota_user
|
@@ -1398,7 +1398,7 @@ module Google
|
|
1398
1398
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1399
1399
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1400
1400
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1401
|
-
def set_comment_moderation_status(
|
1401
|
+
def set_comment_moderation_status(id, moderation_status, ban_author: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1402
1402
|
path = 'comments/setModerationStatus'
|
1403
1403
|
command = make_simple_command(:post, path, options)
|
1404
1404
|
command.query['banAuthor'] = ban_author unless ban_author.nil?
|
@@ -1411,11 +1411,11 @@ module Google
|
|
1411
1411
|
end
|
1412
1412
|
|
1413
1413
|
# Modifies a comment.
|
1414
|
-
# @param [Google::Apis::YoutubeV3::Comment] comment_object
|
1415
1414
|
# @param [String] part
|
1416
1415
|
# The part parameter identifies the properties that the API response will
|
1417
1416
|
# include. You must at least include the snippet part in the parameter value
|
1418
1417
|
# since that part contains all of the properties that the API request can update.
|
1418
|
+
# @param [Google::Apis::YoutubeV3::Comment] comment_object
|
1419
1419
|
# @param [String] fields
|
1420
1420
|
# Selector specifying which fields to include in a partial response.
|
1421
1421
|
# @param [String] quota_user
|
@@ -1437,7 +1437,7 @@ module Google
|
|
1437
1437
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1438
1438
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1439
1439
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1440
|
-
def update_comment(comment_object = nil,
|
1440
|
+
def update_comment(part, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1441
1441
|
path = 'comments'
|
1442
1442
|
command = make_simple_command(:put, path, options)
|
1443
1443
|
command.request_representation = Google::Apis::YoutubeV3::Comment::Representation
|
@@ -1452,6 +1452,9 @@ module Google
|
|
1452
1452
|
end
|
1453
1453
|
|
1454
1454
|
# Returns a list of categories that can be associated with YouTube channels.
|
1455
|
+
# @param [String] part
|
1456
|
+
# The part parameter specifies the guideCategory resource properties that the
|
1457
|
+
# API response will include. Set the parameter value to snippet.
|
1455
1458
|
# @param [String] hl
|
1456
1459
|
# The hl parameter specifies the language that will be used for text values in
|
1457
1460
|
# the API response.
|
@@ -1460,9 +1463,6 @@ module Google
|
|
1460
1463
|
# category ID(s) for the resource(s) that are being retrieved. In a
|
1461
1464
|
# guideCategory resource, the id property specifies the YouTube channel category
|
1462
1465
|
# ID.
|
1463
|
-
# @param [String] part
|
1464
|
-
# The part parameter specifies the guideCategory resource properties that the
|
1465
|
-
# API response will include. Set the parameter value to snippet.
|
1466
1466
|
# @param [String] region_code
|
1467
1467
|
# The regionCode parameter instructs the API to return the list of guide
|
1468
1468
|
# categories available in the specified country. The parameter value is an ISO
|
@@ -1488,7 +1488,7 @@ module Google
|
|
1488
1488
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1489
1489
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1490
1490
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1491
|
-
def list_guide_categories(hl: nil, id: nil,
|
1491
|
+
def list_guide_categories(part, hl: nil, id: nil, region_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1492
1492
|
path = 'guideCategories'
|
1493
1493
|
command = make_simple_command(:get, path, options)
|
1494
1494
|
command.response_representation = Google::Apis::YoutubeV3::ListGuideCategoriesResponse::Representation
|
@@ -1504,12 +1504,12 @@ module Google
|
|
1504
1504
|
end
|
1505
1505
|
|
1506
1506
|
# Returns a list of application languages that the YouTube website supports.
|
1507
|
-
# @param [String] hl
|
1508
|
-
# The hl parameter specifies the language that should be used for text values in
|
1509
|
-
# the API response.
|
1510
1507
|
# @param [String] part
|
1511
1508
|
# The part parameter specifies the i18nLanguage resource properties that the API
|
1512
1509
|
# response will include. Set the parameter value to snippet.
|
1510
|
+
# @param [String] hl
|
1511
|
+
# The hl parameter specifies the language that should be used for text values in
|
1512
|
+
# the API response.
|
1513
1513
|
# @param [String] fields
|
1514
1514
|
# Selector specifying which fields to include in a partial response.
|
1515
1515
|
# @param [String] quota_user
|
@@ -1531,7 +1531,7 @@ module Google
|
|
1531
1531
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1532
1532
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1533
1533
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1534
|
-
def list_i18n_languages(
|
1534
|
+
def list_i18n_languages(part, hl: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1535
1535
|
path = 'i18nLanguages'
|
1536
1536
|
command = make_simple_command(:get, path, options)
|
1537
1537
|
command.response_representation = Google::Apis::YoutubeV3::ListI18nLanguagesResponse::Representation
|
@@ -1545,12 +1545,12 @@ module Google
|
|
1545
1545
|
end
|
1546
1546
|
|
1547
1547
|
# Returns a list of content regions that the YouTube website supports.
|
1548
|
-
# @param [String] hl
|
1549
|
-
# The hl parameter specifies the language that should be used for text values in
|
1550
|
-
# the API response.
|
1551
1548
|
# @param [String] part
|
1552
1549
|
# The part parameter specifies the i18nRegion resource properties that the API
|
1553
1550
|
# response will include. Set the parameter value to snippet.
|
1551
|
+
# @param [String] hl
|
1552
|
+
# The hl parameter specifies the language that should be used for text values in
|
1553
|
+
# the API response.
|
1554
1554
|
# @param [String] fields
|
1555
1555
|
# Selector specifying which fields to include in a partial response.
|
1556
1556
|
# @param [String] quota_user
|
@@ -1572,7 +1572,7 @@ module Google
|
|
1572
1572
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1573
1573
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1574
1574
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1575
|
-
def list_i18n_regions(
|
1575
|
+
def list_i18n_regions(part, hl: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1576
1576
|
path = 'i18nRegions'
|
1577
1577
|
command = make_simple_command(:get, path, options)
|
1578
1578
|
command.response_representation = Google::Apis::YoutubeV3::ListI18nRegionsResponse::Representation
|
@@ -1591,6 +1591,11 @@ module Google
|
|
1591
1591
|
# @param [String] id
|
1592
1592
|
# The id parameter specifies the unique ID of the broadcast that is being bound
|
1593
1593
|
# to a video stream.
|
1594
|
+
# @param [String] part
|
1595
|
+
# The part parameter specifies a comma-separated list of one or more
|
1596
|
+
# liveBroadcast resource properties that the API response will include. The part
|
1597
|
+
# names that you can include in the parameter value are id, snippet,
|
1598
|
+
# contentDetails, and status.
|
1594
1599
|
# @param [String] on_behalf_of_content_owner
|
1595
1600
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
1596
1601
|
# The onBehalfOfContentOwner parameter indicates that the request's
|
@@ -1617,11 +1622,6 @@ module Google
|
|
1617
1622
|
# many different YouTube channels. It allows content owners to authenticate once
|
1618
1623
|
# and perform actions on behalf of the channel specified in the parameter value,
|
1619
1624
|
# without having to provide authentication credentials for each separate channel.
|
1620
|
-
# @param [String] part
|
1621
|
-
# The part parameter specifies a comma-separated list of one or more
|
1622
|
-
# liveBroadcast resource properties that the API response will include. The part
|
1623
|
-
# names that you can include in the parameter value are id, snippet,
|
1624
|
-
# contentDetails, and status.
|
1625
1625
|
# @param [String] stream_id
|
1626
1626
|
# The streamId parameter specifies the unique ID of the video stream that is
|
1627
1627
|
# being bound to a broadcast. If this parameter is omitted, the API will remove
|
@@ -1647,7 +1647,7 @@ module Google
|
|
1647
1647
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1648
1648
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1649
1649
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1650
|
-
def bind_live_broadcast(id
|
1650
|
+
def bind_live_broadcast(id, part, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, stream_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1651
1651
|
path = 'liveBroadcasts/bind'
|
1652
1652
|
command = make_simple_command(:post, path, options)
|
1653
1653
|
command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
|
@@ -1669,6 +1669,11 @@ module Google
|
|
1669
1669
|
# @param [String] id
|
1670
1670
|
# The id parameter specifies the unique ID of the broadcast that is being bound
|
1671
1671
|
# to a video stream.
|
1672
|
+
# @param [String] part
|
1673
|
+
# The part parameter specifies a comma-separated list of one or more
|
1674
|
+
# liveBroadcast resource properties that the API response will include. The part
|
1675
|
+
# names that you can include in the parameter value are id, snippet,
|
1676
|
+
# contentDetails, and status.
|
1672
1677
|
# @param [String] on_behalf_of_content_owner
|
1673
1678
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
1674
1679
|
# The onBehalfOfContentOwner parameter indicates that the request's
|
@@ -1695,11 +1700,6 @@ module Google
|
|
1695
1700
|
# many different YouTube channels. It allows content owners to authenticate once
|
1696
1701
|
# and perform actions on behalf of the channel specified in the parameter value,
|
1697
1702
|
# without having to provide authentication credentials for each separate channel.
|
1698
|
-
# @param [String] part
|
1699
|
-
# The part parameter specifies a comma-separated list of one or more
|
1700
|
-
# liveBroadcast resource properties that the API response will include. The part
|
1701
|
-
# names that you can include in the parameter value are id, snippet,
|
1702
|
-
# contentDetails, and status.
|
1703
1703
|
# @param [String] stream_id
|
1704
1704
|
# The streamId parameter specifies the unique ID of the video stream that is
|
1705
1705
|
# being bound to a broadcast. If this parameter is omitted, the API will remove
|
@@ -1725,7 +1725,7 @@ module Google
|
|
1725
1725
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1726
1726
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1727
1727
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1728
|
-
def bind_direct_live_broadcast(id
|
1728
|
+
def bind_direct_live_broadcast(id, part, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, stream_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1729
1729
|
path = 'liveBroadcasts/bind/direct'
|
1730
1730
|
command = make_simple_command(:post, path, options)
|
1731
1731
|
command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
|
@@ -1743,12 +1743,17 @@ module Google
|
|
1743
1743
|
|
1744
1744
|
# Controls the settings for a slate that can be displayed in the broadcast
|
1745
1745
|
# stream.
|
1746
|
-
# @param [Boolean] display_slate
|
1747
|
-
# The displaySlate parameter specifies whether the slate is being enabled or
|
1748
|
-
# disabled.
|
1749
1746
|
# @param [String] id
|
1750
1747
|
# The id parameter specifies the YouTube live broadcast ID that uniquely
|
1751
1748
|
# identifies the broadcast in which the slate is being updated.
|
1749
|
+
# @param [String] part
|
1750
|
+
# The part parameter specifies a comma-separated list of one or more
|
1751
|
+
# liveBroadcast resource properties that the API response will include. The part
|
1752
|
+
# names that you can include in the parameter value are id, snippet,
|
1753
|
+
# contentDetails, and status.
|
1754
|
+
# @param [Boolean] display_slate
|
1755
|
+
# The displaySlate parameter specifies whether the slate is being enabled or
|
1756
|
+
# disabled.
|
1752
1757
|
# @param [String] offset_time_ms
|
1753
1758
|
# The offsetTimeMs parameter specifies a positive time offset when the specified
|
1754
1759
|
# slate change will occur. The value is measured in milliseconds from the
|
@@ -1786,11 +1791,6 @@ module Google
|
|
1786
1791
|
# many different YouTube channels. It allows content owners to authenticate once
|
1787
1792
|
# and perform actions on behalf of the channel specified in the parameter value,
|
1788
1793
|
# without having to provide authentication credentials for each separate channel.
|
1789
|
-
# @param [String] part
|
1790
|
-
# The part parameter specifies a comma-separated list of one or more
|
1791
|
-
# liveBroadcast resource properties that the API response will include. The part
|
1792
|
-
# names that you can include in the parameter value are id, snippet,
|
1793
|
-
# contentDetails, and status.
|
1794
1794
|
# @param [DateTime] walltime
|
1795
1795
|
# The walltime parameter specifies the wall clock time at which the specified
|
1796
1796
|
# slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:
|
@@ -1816,7 +1816,7 @@ module Google
|
|
1816
1816
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1817
1817
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1818
1818
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1819
|
-
def control_live_broadcast(
|
1819
|
+
def control_live_broadcast(id, part, display_slate: nil, offset_time_ms: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, walltime: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1820
1820
|
path = 'liveBroadcasts/control'
|
1821
1821
|
command = make_simple_command(:post, path, options)
|
1822
1822
|
command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
|
@@ -1885,7 +1885,7 @@ module Google
|
|
1885
1885
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1886
1886
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1887
1887
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1888
|
-
def delete_live_broadcast(id
|
1888
|
+
def delete_live_broadcast(id, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1889
1889
|
path = 'liveBroadcasts'
|
1890
1890
|
command = make_simple_command(:delete, path, options)
|
1891
1891
|
command.query['id'] = id unless id.nil?
|
@@ -1898,6 +1898,12 @@ module Google
|
|
1898
1898
|
end
|
1899
1899
|
|
1900
1900
|
# Creates a broadcast.
|
1901
|
+
# @param [String] part
|
1902
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
1903
|
+
# properties that the write operation will set as well as the properties that
|
1904
|
+
# the API response will include.
|
1905
|
+
# The part properties that you can include in the parameter value are id,
|
1906
|
+
# snippet, contentDetails, and status.
|
1901
1907
|
# @param [Google::Apis::YoutubeV3::LiveBroadcast] live_broadcast_object
|
1902
1908
|
# @param [String] on_behalf_of_content_owner
|
1903
1909
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -1925,12 +1931,6 @@ module Google
|
|
1925
1931
|
# many different YouTube channels. It allows content owners to authenticate once
|
1926
1932
|
# and perform actions on behalf of the channel specified in the parameter value,
|
1927
1933
|
# without having to provide authentication credentials for each separate channel.
|
1928
|
-
# @param [String] part
|
1929
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
1930
|
-
# properties that the write operation will set as well as the properties that
|
1931
|
-
# the API response will include.
|
1932
|
-
# The part properties that you can include in the parameter value are id,
|
1933
|
-
# snippet, contentDetails, and status.
|
1934
1934
|
# @param [String] fields
|
1935
1935
|
# Selector specifying which fields to include in a partial response.
|
1936
1936
|
# @param [String] quota_user
|
@@ -1952,7 +1952,7 @@ module Google
|
|
1952
1952
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1953
1953
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1954
1954
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1955
|
-
def insert_live_broadcast(live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil,
|
1955
|
+
def insert_live_broadcast(part, live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
1956
1956
|
path = 'liveBroadcasts'
|
1957
1957
|
command = make_simple_command(:post, path, options)
|
1958
1958
|
command.request_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
|
@@ -1969,6 +1969,11 @@ module Google
|
|
1969
1969
|
end
|
1970
1970
|
|
1971
1971
|
# Returns a list of YouTube broadcasts that match the API request parameters.
|
1972
|
+
# @param [String] part
|
1973
|
+
# The part parameter specifies a comma-separated list of one or more
|
1974
|
+
# liveBroadcast resource properties that the API response will include. The part
|
1975
|
+
# names that you can include in the parameter value are id, snippet,
|
1976
|
+
# contentDetails, and status.
|
1972
1977
|
# @param [String] broadcast_status
|
1973
1978
|
# The broadcastStatus parameter filters the API response to only include
|
1974
1979
|
# broadcasts with the specified status.
|
@@ -2013,11 +2018,6 @@ module Google
|
|
2013
2018
|
# The pageToken parameter identifies a specific page in the result set that
|
2014
2019
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
2015
2020
|
# properties identify other pages that could be retrieved.
|
2016
|
-
# @param [String] part
|
2017
|
-
# The part parameter specifies a comma-separated list of one or more
|
2018
|
-
# liveBroadcast resource properties that the API response will include. The part
|
2019
|
-
# names that you can include in the parameter value are id, snippet,
|
2020
|
-
# contentDetails, and status.
|
2021
2021
|
# @param [String] fields
|
2022
2022
|
# Selector specifying which fields to include in a partial response.
|
2023
2023
|
# @param [String] quota_user
|
@@ -2039,7 +2039,7 @@ module Google
|
|
2039
2039
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2040
2040
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2041
2041
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2042
|
-
def list_live_broadcasts(broadcast_status: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil,
|
2042
|
+
def list_live_broadcasts(part, broadcast_status: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2043
2043
|
path = 'liveBroadcasts'
|
2044
2044
|
command = make_simple_command(:get, path, options)
|
2045
2045
|
command.response_representation = Google::Apis::YoutubeV3::ListLiveBroadcastsResponse::Representation
|
@@ -2072,6 +2072,11 @@ module Google
|
|
2072
2072
|
# @param [String] id
|
2073
2073
|
# The id parameter specifies the unique ID of the broadcast that is
|
2074
2074
|
# transitioning to another status.
|
2075
|
+
# @param [String] part
|
2076
|
+
# The part parameter specifies a comma-separated list of one or more
|
2077
|
+
# liveBroadcast resource properties that the API response will include. The part
|
2078
|
+
# names that you can include in the parameter value are id, snippet,
|
2079
|
+
# contentDetails, and status.
|
2075
2080
|
# @param [String] on_behalf_of_content_owner
|
2076
2081
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
2077
2082
|
# The onBehalfOfContentOwner parameter indicates that the request's
|
@@ -2098,11 +2103,6 @@ module Google
|
|
2098
2103
|
# many different YouTube channels. It allows content owners to authenticate once
|
2099
2104
|
# and perform actions on behalf of the channel specified in the parameter value,
|
2100
2105
|
# without having to provide authentication credentials for each separate channel.
|
2101
|
-
# @param [String] part
|
2102
|
-
# The part parameter specifies a comma-separated list of one or more
|
2103
|
-
# liveBroadcast resource properties that the API response will include. The part
|
2104
|
-
# names that you can include in the parameter value are id, snippet,
|
2105
|
-
# contentDetails, and status.
|
2106
2106
|
# @param [String] fields
|
2107
2107
|
# Selector specifying which fields to include in a partial response.
|
2108
2108
|
# @param [String] quota_user
|
@@ -2124,7 +2124,7 @@ module Google
|
|
2124
2124
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2125
2125
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2126
2126
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2127
|
-
def transition_live_broadcast(broadcast_status
|
2127
|
+
def transition_live_broadcast(broadcast_status, id, part, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2128
2128
|
path = 'liveBroadcasts/transition'
|
2129
2129
|
command = make_simple_command(:post, path, options)
|
2130
2130
|
command.response_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
|
@@ -2142,6 +2142,20 @@ module Google
|
|
2142
2142
|
|
2143
2143
|
# Updates a broadcast. For example, you could modify the broadcast settings
|
2144
2144
|
# defined in the liveBroadcast resource's contentDetails object.
|
2145
|
+
# @param [String] part
|
2146
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
2147
|
+
# properties that the write operation will set as well as the properties that
|
2148
|
+
# the API response will include.
|
2149
|
+
# The part properties that you can include in the parameter value are id,
|
2150
|
+
# snippet, contentDetails, and status.
|
2151
|
+
# Note that this method will override the existing values for all of the mutable
|
2152
|
+
# properties that are contained in any parts that the parameter value specifies.
|
2153
|
+
# For example, a broadcast's privacy status is defined in the status part. As
|
2154
|
+
# such, if your request is updating a private or unlisted broadcast, and the
|
2155
|
+
# request's part parameter value includes the status part, the broadcast's
|
2156
|
+
# privacy setting will be updated to whatever value the request body specifies.
|
2157
|
+
# If the request body does not specify a value, the existing privacy setting
|
2158
|
+
# will be removed and the broadcast will revert to the default privacy setting.
|
2145
2159
|
# @param [Google::Apis::YoutubeV3::LiveBroadcast] live_broadcast_object
|
2146
2160
|
# @param [String] on_behalf_of_content_owner
|
2147
2161
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -2169,20 +2183,6 @@ module Google
|
|
2169
2183
|
# many different YouTube channels. It allows content owners to authenticate once
|
2170
2184
|
# and perform actions on behalf of the channel specified in the parameter value,
|
2171
2185
|
# without having to provide authentication credentials for each separate channel.
|
2172
|
-
# @param [String] part
|
2173
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
2174
|
-
# properties that the write operation will set as well as the properties that
|
2175
|
-
# the API response will include.
|
2176
|
-
# The part properties that you can include in the parameter value are id,
|
2177
|
-
# snippet, contentDetails, and status.
|
2178
|
-
# Note that this method will override the existing values for all of the mutable
|
2179
|
-
# properties that are contained in any parts that the parameter value specifies.
|
2180
|
-
# For example, a broadcast's privacy status is defined in the status part. As
|
2181
|
-
# such, if your request is updating a private or unlisted broadcast, and the
|
2182
|
-
# request's part parameter value includes the status part, the broadcast's
|
2183
|
-
# privacy setting will be updated to whatever value the request body specifies.
|
2184
|
-
# If the request body does not specify a value, the existing privacy setting
|
2185
|
-
# will be removed and the broadcast will revert to the default privacy setting.
|
2186
2186
|
# @param [String] fields
|
2187
2187
|
# Selector specifying which fields to include in a partial response.
|
2188
2188
|
# @param [String] quota_user
|
@@ -2204,7 +2204,7 @@ module Google
|
|
2204
2204
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2205
2205
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2206
2206
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2207
|
-
def update_live_broadcast(live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil,
|
2207
|
+
def update_live_broadcast(part, live_broadcast_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2208
2208
|
path = 'liveBroadcasts'
|
2209
2209
|
command = make_simple_command(:put, path, options)
|
2210
2210
|
command.request_representation = Google::Apis::YoutubeV3::LiveBroadcast::Representation
|
@@ -2271,7 +2271,7 @@ module Google
|
|
2271
2271
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2272
2272
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2273
2273
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2274
|
-
def delete_live_stream(id
|
2274
|
+
def delete_live_stream(id, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2275
2275
|
path = 'liveStreams'
|
2276
2276
|
command = make_simple_command(:delete, path, options)
|
2277
2277
|
command.query['id'] = id unless id.nil?
|
@@ -2285,6 +2285,12 @@ module Google
|
|
2285
2285
|
|
2286
2286
|
# Creates a video stream. The stream enables you to send your video to YouTube,
|
2287
2287
|
# which can then broadcast the video to your audience.
|
2288
|
+
# @param [String] part
|
2289
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
2290
|
+
# properties that the write operation will set as well as the properties that
|
2291
|
+
# the API response will include.
|
2292
|
+
# The part properties that you can include in the parameter value are id,
|
2293
|
+
# snippet, cdn, and status.
|
2288
2294
|
# @param [Google::Apis::YoutubeV3::LiveStream] live_stream_object
|
2289
2295
|
# @param [String] on_behalf_of_content_owner
|
2290
2296
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -2312,12 +2318,6 @@ module Google
|
|
2312
2318
|
# many different YouTube channels. It allows content owners to authenticate once
|
2313
2319
|
# and perform actions on behalf of the channel specified in the parameter value,
|
2314
2320
|
# without having to provide authentication credentials for each separate channel.
|
2315
|
-
# @param [String] part
|
2316
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
2317
|
-
# properties that the write operation will set as well as the properties that
|
2318
|
-
# the API response will include.
|
2319
|
-
# The part properties that you can include in the parameter value are id,
|
2320
|
-
# snippet, cdn, and status.
|
2321
2321
|
# @param [String] fields
|
2322
2322
|
# Selector specifying which fields to include in a partial response.
|
2323
2323
|
# @param [String] quota_user
|
@@ -2339,7 +2339,7 @@ module Google
|
|
2339
2339
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2340
2340
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2341
2341
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2342
|
-
def insert_live_stream(live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil,
|
2342
|
+
def insert_live_stream(part, live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2343
2343
|
path = 'liveStreams'
|
2344
2344
|
command = make_simple_command(:post, path, options)
|
2345
2345
|
command.request_representation = Google::Apis::YoutubeV3::LiveStream::Representation
|
@@ -2356,6 +2356,10 @@ module Google
|
|
2356
2356
|
end
|
2357
2357
|
|
2358
2358
|
# Returns a list of video streams that match the API request parameters.
|
2359
|
+
# @param [String] part
|
2360
|
+
# The part parameter specifies a comma-separated list of one or more liveStream
|
2361
|
+
# resource properties that the API response will include. The part names that
|
2362
|
+
# you can include in the parameter value are id, snippet, cdn, and status.
|
2359
2363
|
# @param [String] id
|
2360
2364
|
# The id parameter specifies a comma-separated list of YouTube stream IDs that
|
2361
2365
|
# identify the streams being retrieved. In a liveStream resource, the id
|
@@ -2397,10 +2401,6 @@ module Google
|
|
2397
2401
|
# The pageToken parameter identifies a specific page in the result set that
|
2398
2402
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
2399
2403
|
# properties identify other pages that could be retrieved.
|
2400
|
-
# @param [String] part
|
2401
|
-
# The part parameter specifies a comma-separated list of one or more liveStream
|
2402
|
-
# resource properties that the API response will include. The part names that
|
2403
|
-
# you can include in the parameter value are id, snippet, cdn, and status.
|
2404
2404
|
# @param [String] fields
|
2405
2405
|
# Selector specifying which fields to include in a partial response.
|
2406
2406
|
# @param [String] quota_user
|
@@ -2422,7 +2422,7 @@ module Google
|
|
2422
2422
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2423
2423
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2424
2424
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2425
|
-
def list_live_streams(id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil,
|
2425
|
+
def list_live_streams(part, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2426
2426
|
path = 'liveStreams'
|
2427
2427
|
command = make_simple_command(:get, path, options)
|
2428
2428
|
command.response_representation = Google::Apis::YoutubeV3::ListLiveStreamsResponse::Representation
|
@@ -2442,6 +2442,16 @@ module Google
|
|
2442
2442
|
|
2443
2443
|
# Updates a video stream. If the properties that you want to change cannot be
|
2444
2444
|
# updated, then you need to create a new stream with the proper settings.
|
2445
|
+
# @param [String] part
|
2446
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
2447
|
+
# properties that the write operation will set as well as the properties that
|
2448
|
+
# the API response will include.
|
2449
|
+
# The part properties that you can include in the parameter value are id,
|
2450
|
+
# snippet, cdn, and status.
|
2451
|
+
# Note that this method will override the existing values for all of the mutable
|
2452
|
+
# properties that are contained in any parts that the parameter value specifies.
|
2453
|
+
# If the request body does not specify a value for a mutable property, the
|
2454
|
+
# existing value for that property will be removed.
|
2445
2455
|
# @param [Google::Apis::YoutubeV3::LiveStream] live_stream_object
|
2446
2456
|
# @param [String] on_behalf_of_content_owner
|
2447
2457
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -2469,16 +2479,6 @@ module Google
|
|
2469
2479
|
# many different YouTube channels. It allows content owners to authenticate once
|
2470
2480
|
# and perform actions on behalf of the channel specified in the parameter value,
|
2471
2481
|
# without having to provide authentication credentials for each separate channel.
|
2472
|
-
# @param [String] part
|
2473
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
2474
|
-
# properties that the write operation will set as well as the properties that
|
2475
|
-
# the API response will include.
|
2476
|
-
# The part properties that you can include in the parameter value are id,
|
2477
|
-
# snippet, cdn, and status.
|
2478
|
-
# Note that this method will override the existing values for all of the mutable
|
2479
|
-
# properties that are contained in any parts that the parameter value specifies.
|
2480
|
-
# If the request body does not specify a value for a mutable property, the
|
2481
|
-
# existing value for that property will be removed.
|
2482
2482
|
# @param [String] fields
|
2483
2483
|
# Selector specifying which fields to include in a partial response.
|
2484
2484
|
# @param [String] quota_user
|
@@ -2500,7 +2500,7 @@ module Google
|
|
2500
2500
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2501
2501
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2502
2502
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2503
|
-
def update_live_stream(live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil,
|
2503
|
+
def update_live_stream(part, live_stream_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2504
2504
|
path = 'liveStreams'
|
2505
2505
|
command = make_simple_command(:put, path, options)
|
2506
2506
|
command.request_representation = Google::Apis::YoutubeV3::LiveStream::Representation
|
@@ -2542,7 +2542,7 @@ module Google
|
|
2542
2542
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2543
2543
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2544
2544
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2545
|
-
def delete_playlist_item(id
|
2545
|
+
def delete_playlist_item(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2546
2546
|
path = 'playlistItems'
|
2547
2547
|
command = make_simple_command(:delete, path, options)
|
2548
2548
|
command.query['id'] = id unless id.nil?
|
@@ -2553,6 +2553,10 @@ module Google
|
|
2553
2553
|
end
|
2554
2554
|
|
2555
2555
|
# Adds a resource to a playlist.
|
2556
|
+
# @param [String] part
|
2557
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
2558
|
+
# properties that the write operation will set as well as the properties that
|
2559
|
+
# the API response will include.
|
2556
2560
|
# @param [Google::Apis::YoutubeV3::PlaylistItem] playlist_item_object
|
2557
2561
|
# @param [String] on_behalf_of_content_owner
|
2558
2562
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -2564,10 +2568,6 @@ module Google
|
|
2564
2568
|
# to all their video and channel data, without having to provide authentication
|
2565
2569
|
# credentials for each individual channel. The CMS account that the user
|
2566
2570
|
# authenticates with must be linked to the specified YouTube content owner.
|
2567
|
-
# @param [String] part
|
2568
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
2569
|
-
# properties that the write operation will set as well as the properties that
|
2570
|
-
# the API response will include.
|
2571
2571
|
# @param [String] fields
|
2572
2572
|
# Selector specifying which fields to include in a partial response.
|
2573
2573
|
# @param [String] quota_user
|
@@ -2589,7 +2589,7 @@ module Google
|
|
2589
2589
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2590
2590
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2591
2591
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2592
|
-
def insert_playlist_item(playlist_item_object = nil, on_behalf_of_content_owner: nil,
|
2592
|
+
def insert_playlist_item(part, playlist_item_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2593
2593
|
path = 'playlistItems'
|
2594
2594
|
command = make_simple_command(:post, path, options)
|
2595
2595
|
command.request_representation = Google::Apis::YoutubeV3::PlaylistItem::Representation
|
@@ -2607,6 +2607,15 @@ module Google
|
|
2607
2607
|
# Returns a collection of playlist items that match the API request parameters.
|
2608
2608
|
# You can retrieve all of the playlist items in a specified playlist or retrieve
|
2609
2609
|
# one or more playlist items by their unique IDs.
|
2610
|
+
# @param [String] part
|
2611
|
+
# The part parameter specifies a comma-separated list of one or more
|
2612
|
+
# playlistItem resource properties that the API response will include.
|
2613
|
+
# If the parameter identifies a property that contains child properties, the
|
2614
|
+
# child properties will be included in the response. For example, in a
|
2615
|
+
# playlistItem resource, the snippet property contains numerous fields,
|
2616
|
+
# including the title, description, position, and resourceId properties. As such,
|
2617
|
+
# if you set part=snippet, the API response will contain all of those
|
2618
|
+
# properties.
|
2610
2619
|
# @param [String] id
|
2611
2620
|
# The id parameter specifies a comma-separated list of one or more unique
|
2612
2621
|
# playlist item IDs.
|
@@ -2627,15 +2636,6 @@ module Google
|
|
2627
2636
|
# The pageToken parameter identifies a specific page in the result set that
|
2628
2637
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
2629
2638
|
# properties identify other pages that could be retrieved.
|
2630
|
-
# @param [String] part
|
2631
|
-
# The part parameter specifies a comma-separated list of one or more
|
2632
|
-
# playlistItem resource properties that the API response will include.
|
2633
|
-
# If the parameter identifies a property that contains child properties, the
|
2634
|
-
# child properties will be included in the response. For example, in a
|
2635
|
-
# playlistItem resource, the snippet property contains numerous fields,
|
2636
|
-
# including the title, description, position, and resourceId properties. As such,
|
2637
|
-
# if you set part=snippet, the API response will contain all of those
|
2638
|
-
# properties.
|
2639
2639
|
# @param [String] playlist_id
|
2640
2640
|
# The playlistId parameter specifies the unique ID of the playlist for which you
|
2641
2641
|
# want to retrieve playlist items. Note that even though this is an optional
|
@@ -2665,7 +2665,7 @@ module Google
|
|
2665
2665
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2666
2666
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2667
2667
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2668
|
-
def list_playlist_items(id: nil, max_results: nil, on_behalf_of_content_owner: nil, page_token: nil,
|
2668
|
+
def list_playlist_items(part, id: nil, max_results: nil, on_behalf_of_content_owner: nil, page_token: nil, playlist_id: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2669
2669
|
path = 'playlistItems'
|
2670
2670
|
command = make_simple_command(:get, path, options)
|
2671
2671
|
command.response_representation = Google::Apis::YoutubeV3::ListPlaylistItemsResponse::Representation
|
@@ -2685,7 +2685,6 @@ module Google
|
|
2685
2685
|
|
2686
2686
|
# Modifies a playlist item. For example, you could update the item's position in
|
2687
2687
|
# the playlist.
|
2688
|
-
# @param [Google::Apis::YoutubeV3::PlaylistItem] playlist_item_object
|
2689
2688
|
# @param [String] part
|
2690
2689
|
# The part parameter serves two purposes in this operation. It identifies the
|
2691
2690
|
# properties that the write operation will set as well as the properties that
|
@@ -2700,6 +2699,7 @@ module Google
|
|
2700
2699
|
# to whatever value the request body specifies. If the request body does not
|
2701
2700
|
# specify values, the existing start and end times will be removed and replaced
|
2702
2701
|
# with the default settings.
|
2702
|
+
# @param [Google::Apis::YoutubeV3::PlaylistItem] playlist_item_object
|
2703
2703
|
# @param [String] fields
|
2704
2704
|
# Selector specifying which fields to include in a partial response.
|
2705
2705
|
# @param [String] quota_user
|
@@ -2721,7 +2721,7 @@ module Google
|
|
2721
2721
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2722
2722
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2723
2723
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2724
|
-
def update_playlist_item(playlist_item_object = nil,
|
2724
|
+
def update_playlist_item(part, playlist_item_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2725
2725
|
path = 'playlistItems'
|
2726
2726
|
command = make_simple_command(:put, path, options)
|
2727
2727
|
command.request_representation = Google::Apis::YoutubeV3::PlaylistItem::Representation
|
@@ -2771,7 +2771,7 @@ module Google
|
|
2771
2771
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2772
2772
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2773
2773
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2774
|
-
def delete_playlist(id
|
2774
|
+
def delete_playlist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2775
2775
|
path = 'playlists'
|
2776
2776
|
command = make_simple_command(:delete, path, options)
|
2777
2777
|
command.query['id'] = id unless id.nil?
|
@@ -2783,6 +2783,10 @@ module Google
|
|
2783
2783
|
end
|
2784
2784
|
|
2785
2785
|
# Creates a playlist.
|
2786
|
+
# @param [String] part
|
2787
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
2788
|
+
# properties that the write operation will set as well as the properties that
|
2789
|
+
# the API response will include.
|
2786
2790
|
# @param [Google::Apis::YoutubeV3::Playlist] playlist_object
|
2787
2791
|
# @param [String] on_behalf_of_content_owner
|
2788
2792
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -2810,10 +2814,6 @@ module Google
|
|
2810
2814
|
# many different YouTube channels. It allows content owners to authenticate once
|
2811
2815
|
# and perform actions on behalf of the channel specified in the parameter value,
|
2812
2816
|
# without having to provide authentication credentials for each separate channel.
|
2813
|
-
# @param [String] part
|
2814
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
2815
|
-
# properties that the write operation will set as well as the properties that
|
2816
|
-
# the API response will include.
|
2817
2817
|
# @param [String] fields
|
2818
2818
|
# Selector specifying which fields to include in a partial response.
|
2819
2819
|
# @param [String] quota_user
|
@@ -2835,7 +2835,7 @@ module Google
|
|
2835
2835
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2836
2836
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2837
2837
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2838
|
-
def insert_playlist(playlist_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil,
|
2838
|
+
def insert_playlist(part, playlist_object = nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2839
2839
|
path = 'playlists'
|
2840
2840
|
command = make_simple_command(:post, path, options)
|
2841
2841
|
command.request_representation = Google::Apis::YoutubeV3::Playlist::Representation
|
@@ -2854,6 +2854,14 @@ module Google
|
|
2854
2854
|
# Returns a collection of playlists that match the API request parameters. For
|
2855
2855
|
# example, you can retrieve all playlists that the authenticated user owns, or
|
2856
2856
|
# you can retrieve one or more playlists by their unique IDs.
|
2857
|
+
# @param [String] part
|
2858
|
+
# The part parameter specifies a comma-separated list of one or more playlist
|
2859
|
+
# resource properties that the API response will include.
|
2860
|
+
# If the parameter identifies a property that contains child properties, the
|
2861
|
+
# child properties will be included in the response. For example, in a playlist
|
2862
|
+
# resource, the snippet property contains properties like author, title,
|
2863
|
+
# description, tags, and timeCreated. As such, if you set part=snippet, the API
|
2864
|
+
# response will contain all of those properties.
|
2857
2865
|
# @param [String] channel_id
|
2858
2866
|
# This value indicates that the API should only return the specified channel's
|
2859
2867
|
# playlists.
|
@@ -2900,14 +2908,6 @@ module Google
|
|
2900
2908
|
# The pageToken parameter identifies a specific page in the result set that
|
2901
2909
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
2902
2910
|
# properties identify other pages that could be retrieved.
|
2903
|
-
# @param [String] part
|
2904
|
-
# The part parameter specifies a comma-separated list of one or more playlist
|
2905
|
-
# resource properties that the API response will include.
|
2906
|
-
# If the parameter identifies a property that contains child properties, the
|
2907
|
-
# child properties will be included in the response. For example, in a playlist
|
2908
|
-
# resource, the snippet property contains properties like author, title,
|
2909
|
-
# description, tags, and timeCreated. As such, if you set part=snippet, the API
|
2910
|
-
# response will contain all of those properties.
|
2911
2911
|
# @param [String] fields
|
2912
2912
|
# Selector specifying which fields to include in a partial response.
|
2913
2913
|
# @param [String] quota_user
|
@@ -2929,7 +2929,7 @@ module Google
|
|
2929
2929
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2930
2930
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2931
2931
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2932
|
-
def list_playlists(channel_id: nil, hl: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil,
|
2932
|
+
def list_playlists(part, channel_id: nil, hl: nil, id: nil, max_results: nil, mine: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2933
2933
|
path = 'playlists'
|
2934
2934
|
command = make_simple_command(:get, path, options)
|
2935
2935
|
command.response_representation = Google::Apis::YoutubeV3::ListPlaylistResponse::Representation
|
@@ -2951,6 +2951,16 @@ module Google
|
|
2951
2951
|
|
2952
2952
|
# Modifies a playlist. For example, you could change a playlist's title,
|
2953
2953
|
# description, or privacy status.
|
2954
|
+
# @param [String] part
|
2955
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
2956
|
+
# properties that the write operation will set as well as the properties that
|
2957
|
+
# the API response will include.
|
2958
|
+
# Note that this method will override the existing values for mutable properties
|
2959
|
+
# that are contained in any parts that the request body specifies. For example,
|
2960
|
+
# a playlist's description is contained in the snippet part, which must be
|
2961
|
+
# included in the request body. If the request does not specify a value for the
|
2962
|
+
# snippet.description property, the playlist's existing description will be
|
2963
|
+
# deleted.
|
2954
2964
|
# @param [Google::Apis::YoutubeV3::Playlist] playlist_object
|
2955
2965
|
# @param [String] on_behalf_of_content_owner
|
2956
2966
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
@@ -2962,16 +2972,6 @@ module Google
|
|
2962
2972
|
# to all their video and channel data, without having to provide authentication
|
2963
2973
|
# credentials for each individual channel. The CMS account that the user
|
2964
2974
|
# authenticates with must be linked to the specified YouTube content owner.
|
2965
|
-
# @param [String] part
|
2966
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
2967
|
-
# properties that the write operation will set as well as the properties that
|
2968
|
-
# the API response will include.
|
2969
|
-
# Note that this method will override the existing values for mutable properties
|
2970
|
-
# that are contained in any parts that the request body specifies. For example,
|
2971
|
-
# a playlist's description is contained in the snippet part, which must be
|
2972
|
-
# included in the request body. If the request does not specify a value for the
|
2973
|
-
# snippet.description property, the playlist's existing description will be
|
2974
|
-
# deleted.
|
2975
2975
|
# @param [String] fields
|
2976
2976
|
# Selector specifying which fields to include in a partial response.
|
2977
2977
|
# @param [String] quota_user
|
@@ -2993,7 +2993,7 @@ module Google
|
|
2993
2993
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2994
2994
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2995
2995
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2996
|
-
def update_playlist(playlist_object = nil, on_behalf_of_content_owner: nil,
|
2996
|
+
def update_playlist(part, playlist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
2997
2997
|
path = 'playlists'
|
2998
2998
|
command = make_simple_command(:put, path, options)
|
2999
2999
|
command.request_representation = Google::Apis::YoutubeV3::Playlist::Representation
|
@@ -3012,6 +3012,10 @@ module Google
|
|
3012
3012
|
# specified in the API request. By default, a search result set identifies
|
3013
3013
|
# matching video, channel, and playlist resources, but you can also configure
|
3014
3014
|
# queries to only retrieve a specific type of resource.
|
3015
|
+
# @param [String] part
|
3016
|
+
# The part parameter specifies a comma-separated list of one or more search
|
3017
|
+
# resource properties that the API response will include. Set the parameter
|
3018
|
+
# value to snippet.
|
3015
3019
|
# @param [String] channel_id
|
3016
3020
|
# The channelId parameter indicates that the API response should only contain
|
3017
3021
|
# resources created by the channel
|
@@ -3078,10 +3082,6 @@ module Google
|
|
3078
3082
|
# The pageToken parameter identifies a specific page in the result set that
|
3079
3083
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
3080
3084
|
# properties identify other pages that could be retrieved.
|
3081
|
-
# @param [String] part
|
3082
|
-
# The part parameter specifies a comma-separated list of one or more search
|
3083
|
-
# resource properties that the API response will include. Set the parameter
|
3084
|
-
# value to snippet.
|
3085
3085
|
# @param [DateTime] published_after
|
3086
3086
|
# The publishedAfter parameter indicates that the API response should only
|
3087
3087
|
# contain resources created after the specified time. The value is an RFC 3339
|
@@ -3186,7 +3186,7 @@ module Google
|
|
3186
3186
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3187
3187
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3188
3188
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3189
|
-
def list_searches(channel_id: nil, channel_type: nil, event_type: nil, for_content_owner: nil, for_developer: nil, for_mine: nil, location: nil, location_radius: nil, max_results: nil, on_behalf_of_content_owner: nil, order: nil, page_token: nil,
|
3189
|
+
def list_searches(part, channel_id: nil, channel_type: nil, event_type: nil, for_content_owner: nil, for_developer: nil, for_mine: nil, location: nil, location_radius: nil, max_results: nil, on_behalf_of_content_owner: nil, order: nil, page_token: nil, published_after: nil, published_before: nil, q: nil, region_code: nil, related_to_video_id: nil, relevance_language: nil, safe_search: nil, topic_id: nil, type: nil, video_caption: nil, video_category_id: nil, video_definition: nil, video_dimension: nil, video_duration: nil, video_embeddable: nil, video_license: nil, video_syndicated: nil, video_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3190
3190
|
path = 'search'
|
3191
3191
|
command = make_simple_command(:get, path, options)
|
3192
3192
|
command.response_representation = Google::Apis::YoutubeV3::SearchListsResponse::Representation
|
@@ -3254,7 +3254,7 @@ module Google
|
|
3254
3254
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3255
3255
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3256
3256
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3257
|
-
def delete_subscription(id
|
3257
|
+
def delete_subscription(id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3258
3258
|
path = 'subscriptions'
|
3259
3259
|
command = make_simple_command(:delete, path, options)
|
3260
3260
|
command.query['id'] = id unless id.nil?
|
@@ -3265,11 +3265,11 @@ module Google
|
|
3265
3265
|
end
|
3266
3266
|
|
3267
3267
|
# Adds a subscription for the authenticated user's channel.
|
3268
|
-
# @param [Google::Apis::YoutubeV3::Subscription] subscription_object
|
3269
3268
|
# @param [String] part
|
3270
3269
|
# The part parameter serves two purposes in this operation. It identifies the
|
3271
3270
|
# properties that the write operation will set as well as the properties that
|
3272
3271
|
# the API response will include.
|
3272
|
+
# @param [Google::Apis::YoutubeV3::Subscription] subscription_object
|
3273
3273
|
# @param [String] fields
|
3274
3274
|
# Selector specifying which fields to include in a partial response.
|
3275
3275
|
# @param [String] quota_user
|
@@ -3291,7 +3291,7 @@ module Google
|
|
3291
3291
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3292
3292
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3293
3293
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3294
|
-
def insert_subscription(subscription_object = nil,
|
3294
|
+
def insert_subscription(part, subscription_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3295
3295
|
path = 'subscriptions'
|
3296
3296
|
command = make_simple_command(:post, path, options)
|
3297
3297
|
command.request_representation = Google::Apis::YoutubeV3::Subscription::Representation
|
@@ -3306,6 +3306,14 @@ module Google
|
|
3306
3306
|
end
|
3307
3307
|
|
3308
3308
|
# Returns subscription resources that match the API request criteria.
|
3309
|
+
# @param [String] part
|
3310
|
+
# The part parameter specifies a comma-separated list of one or more
|
3311
|
+
# subscription resource properties that the API response will include.
|
3312
|
+
# If the parameter identifies a property that contains child properties, the
|
3313
|
+
# child properties will be included in the response. For example, in a
|
3314
|
+
# subscription resource, the snippet property contains other properties, such as
|
3315
|
+
# a display title for the subscription. If you set part=snippet, the API
|
3316
|
+
# response will also contain all of those nested properties.
|
3309
3317
|
# @param [String] channel_id
|
3310
3318
|
# The channelId parameter specifies a YouTube channel ID. The API will only
|
3311
3319
|
# return that channel's subscriptions.
|
@@ -3358,14 +3366,6 @@ module Google
|
|
3358
3366
|
# The pageToken parameter identifies a specific page in the result set that
|
3359
3367
|
# should be returned. In an API response, the nextPageToken and prevPageToken
|
3360
3368
|
# properties identify other pages that could be retrieved.
|
3361
|
-
# @param [String] part
|
3362
|
-
# The part parameter specifies a comma-separated list of one or more
|
3363
|
-
# subscription resource properties that the API response will include.
|
3364
|
-
# If the parameter identifies a property that contains child properties, the
|
3365
|
-
# child properties will be included in the response. For example, in a
|
3366
|
-
# subscription resource, the snippet property contains other properties, such as
|
3367
|
-
# a display title for the subscription. If you set part=snippet, the API
|
3368
|
-
# response will also contain all of those nested properties.
|
3369
3369
|
# @param [String] fields
|
3370
3370
|
# Selector specifying which fields to include in a partial response.
|
3371
3371
|
# @param [String] quota_user
|
@@ -3387,7 +3387,7 @@ module Google
|
|
3387
3387
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3388
3388
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3389
3389
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3390
|
-
def list_subscriptions(channel_id: nil, for_channel_id: nil, id: nil, max_results: nil, mine: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, order: nil, page_token: nil,
|
3390
|
+
def list_subscriptions(part, channel_id: nil, for_channel_id: nil, id: nil, max_results: nil, mine: nil, my_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, order: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3391
3391
|
path = 'subscriptions'
|
3392
3392
|
command = make_simple_command(:get, path, options)
|
3393
3393
|
command.response_representation = Google::Apis::YoutubeV3::ListSubscriptionResponse::Representation
|
@@ -3410,6 +3410,9 @@ module Google
|
|
3410
3410
|
end
|
3411
3411
|
|
3412
3412
|
# Uploads a custom video thumbnail to YouTube and sets it for a video.
|
3413
|
+
# @param [String] video_id
|
3414
|
+
# The videoId parameter specifies a YouTube video ID for which the custom video
|
3415
|
+
# thumbnail is being provided.
|
3413
3416
|
# @param [String] on_behalf_of_content_owner
|
3414
3417
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
3415
3418
|
# The onBehalfOfContentOwner parameter indicates that the request's
|
@@ -3420,9 +3423,6 @@ module Google
|
|
3420
3423
|
# to all their video and channel data, without having to provide authentication
|
3421
3424
|
# credentials for each individual channel. The actual CMS account that the user
|
3422
3425
|
# authenticates with must be linked to the specified YouTube content owner.
|
3423
|
-
# @param [String] video_id
|
3424
|
-
# The videoId parameter specifies a YouTube video ID for which the custom video
|
3425
|
-
# thumbnail is being provided.
|
3426
3426
|
# @param [String] fields
|
3427
3427
|
# Selector specifying which fields to include in a partial response.
|
3428
3428
|
# @param [String] quota_user
|
@@ -3448,7 +3448,7 @@ module Google
|
|
3448
3448
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3449
3449
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3450
3450
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3451
|
-
def set_thumbnail(
|
3451
|
+
def set_thumbnail(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
3452
3452
|
path = 'thumbnails/set'
|
3453
3453
|
if upload_source.nil?
|
3454
3454
|
command = make_simple_command(:post, path, options)
|
@@ -3468,12 +3468,12 @@ module Google
|
|
3468
3468
|
end
|
3469
3469
|
|
3470
3470
|
# Returns a list of abuse reasons that can be used for reporting abusive videos.
|
3471
|
-
# @param [String] hl
|
3472
|
-
# The hl parameter specifies the language that should be used for text values in
|
3473
|
-
# the API response.
|
3474
3471
|
# @param [String] part
|
3475
3472
|
# The part parameter specifies the videoCategory resource parts that the API
|
3476
3473
|
# response will include. Supported values are id and snippet.
|
3474
|
+
# @param [String] hl
|
3475
|
+
# The hl parameter specifies the language that should be used for text values in
|
3476
|
+
# the API response.
|
3477
3477
|
# @param [String] fields
|
3478
3478
|
# Selector specifying which fields to include in a partial response.
|
3479
3479
|
# @param [String] quota_user
|
@@ -3495,7 +3495,7 @@ module Google
|
|
3495
3495
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3496
3496
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3497
3497
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3498
|
-
def list_video_abuse_report_reasons(
|
3498
|
+
def list_video_abuse_report_reasons(part, hl: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3499
3499
|
path = 'videoAbuseReportReasons'
|
3500
3500
|
command = make_simple_command(:get, path, options)
|
3501
3501
|
command.response_representation = Google::Apis::YoutubeV3::ListVideoAbuseReportReasonResponse::Representation
|
@@ -3509,15 +3509,15 @@ module Google
|
|
3509
3509
|
end
|
3510
3510
|
|
3511
3511
|
# Returns a list of categories that can be associated with YouTube videos.
|
3512
|
+
# @param [String] part
|
3513
|
+
# The part parameter specifies the videoCategory resource properties that the
|
3514
|
+
# API response will include. Set the parameter value to snippet.
|
3512
3515
|
# @param [String] hl
|
3513
3516
|
# The hl parameter specifies the language that should be used for text values in
|
3514
3517
|
# the API response.
|
3515
3518
|
# @param [String] id
|
3516
3519
|
# The id parameter specifies a comma-separated list of video category IDs for
|
3517
3520
|
# the resources that you are retrieving.
|
3518
|
-
# @param [String] part
|
3519
|
-
# The part parameter specifies the videoCategory resource properties that the
|
3520
|
-
# API response will include. Set the parameter value to snippet.
|
3521
3521
|
# @param [String] region_code
|
3522
3522
|
# The regionCode parameter instructs the API to return the list of video
|
3523
3523
|
# categories available in the specified country. The parameter value is an ISO
|
@@ -3543,7 +3543,7 @@ module Google
|
|
3543
3543
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3544
3544
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3545
3545
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3546
|
-
def list_video_categories(hl: nil, id: nil,
|
3546
|
+
def list_video_categories(part, hl: nil, id: nil, region_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3547
3547
|
path = 'videoCategories'
|
3548
3548
|
command = make_simple_command(:get, path, options)
|
3549
3549
|
command.response_representation = Google::Apis::YoutubeV3::ListVideoCategoryResponse::Representation
|
@@ -3593,7 +3593,7 @@ module Google
|
|
3593
3593
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3594
3594
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3595
3595
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3596
|
-
def delete_video(id
|
3596
|
+
def delete_video(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3597
3597
|
path = 'videos'
|
3598
3598
|
command = make_simple_command(:delete, path, options)
|
3599
3599
|
command.query['id'] = id unless id.nil?
|
@@ -3641,7 +3641,7 @@ module Google
|
|
3641
3641
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3642
3642
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3643
3643
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3644
|
-
def get_rating_video(id
|
3644
|
+
def get_rating_video(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3645
3645
|
path = 'videos/getRating'
|
3646
3646
|
command = make_simple_command(:get, path, options)
|
3647
3647
|
command.response_representation = Google::Apis::YoutubeV3::GetVideoRatingResponse::Representation
|
@@ -3655,6 +3655,15 @@ module Google
|
|
3655
3655
|
end
|
3656
3656
|
|
3657
3657
|
# Uploads a video to YouTube and optionally sets the video's metadata.
|
3658
|
+
# @param [String] part
|
3659
|
+
# The part parameter serves two purposes in this operation. It identifies the
|
3660
|
+
# properties that the write operation will set as well as the properties that
|
3661
|
+
# the API response will include.
|
3662
|
+
# Note that not all parts contain properties that can be set when inserting or
|
3663
|
+
# updating a video. For example, the statistics object encapsulates statistics
|
3664
|
+
# that YouTube calculates for a video and does not contain values that you can
|
3665
|
+
# set or modify. If the parameter value specifies a part that does not contain
|
3666
|
+
# mutable values, that part will still be included in the API response.
|
3658
3667
|
# @param [Google::Apis::YoutubeV3::Video] video_object
|
3659
3668
|
# @param [Boolean] auto_levels
|
3660
3669
|
# The autoLevels parameter indicates whether YouTube should automatically
|
@@ -3692,15 +3701,6 @@ module Google
|
|
3692
3701
|
# many different YouTube channels. It allows content owners to authenticate once
|
3693
3702
|
# and perform actions on behalf of the channel specified in the parameter value,
|
3694
3703
|
# without having to provide authentication credentials for each separate channel.
|
3695
|
-
# @param [String] part
|
3696
|
-
# The part parameter serves two purposes in this operation. It identifies the
|
3697
|
-
# properties that the write operation will set as well as the properties that
|
3698
|
-
# the API response will include.
|
3699
|
-
# Note that not all parts contain properties that can be set when inserting or
|
3700
|
-
# updating a video. For example, the statistics object encapsulates statistics
|
3701
|
-
# that YouTube calculates for a video and does not contain values that you can
|
3702
|
-
# set or modify. If the parameter value specifies a part that does not contain
|
3703
|
-
# mutable values, that part will still be included in the API response.
|
3704
3704
|
# @param [Boolean] stabilize
|
3705
3705
|
# The stabilize parameter indicates whether YouTube should adjust the video to
|
3706
3706
|
# remove shaky camera motions.
|
@@ -3729,7 +3729,7 @@ module Google
|
|
3729
3729
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3730
3730
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3731
3731
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3732
|
-
def insert_video(video_object = nil, auto_levels: nil, notify_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil,
|
3732
|
+
def insert_video(part, video_object = nil, auto_levels: nil, notify_subscribers: nil, on_behalf_of_content_owner: nil, on_behalf_of_content_owner_channel: nil, stabilize: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
3733
3733
|
path = 'videos'
|
3734
3734
|
if upload_source.nil?
|
3735
3735
|
command = make_simple_command(:post, path, options)
|
@@ -3755,6 +3755,14 @@ module Google
|
|
3755
3755
|
end
|
3756
3756
|
|
3757
3757
|
# Returns a list of videos that match the API request parameters.
|
3758
|
+
# @param [String] part
|
3759
|
+
# The part parameter specifies a comma-separated list of one or more video
|
3760
|
+
# resource properties that the API response will include.
|
3761
|
+
# If the parameter identifies a property that contains child properties, the
|
3762
|
+
# child properties will be included in the response. For example, in a video
|
3763
|
+
# resource, the snippet property contains the channelId, title, description,
|
3764
|
+
# tags, and categoryId properties. As such, if you set part=snippet, the API
|
3765
|
+
# response will contain all of those properties.
|
3758
3766
|
# @param [String] chart
|
3759
3767
|
# The chart parameter identifies the chart that you want to retrieve.
|
3760
3768
|
# @param [String] debug_project_id_override
|
@@ -3801,14 +3809,6 @@ module Google
|
|
3801
3809
|
# Note: This parameter is supported for use in conjunction with the myRating
|
3802
3810
|
# parameter, but it is not supported for use in conjunction with the id
|
3803
3811
|
# parameter.
|
3804
|
-
# @param [String] part
|
3805
|
-
# The part parameter specifies a comma-separated list of one or more video
|
3806
|
-
# resource properties that the API response will include.
|
3807
|
-
# If the parameter identifies a property that contains child properties, the
|
3808
|
-
# child properties will be included in the response. For example, in a video
|
3809
|
-
# resource, the snippet property contains the channelId, title, description,
|
3810
|
-
# tags, and categoryId properties. As such, if you set part=snippet, the API
|
3811
|
-
# response will contain all of those properties.
|
3812
3812
|
# @param [String] region_code
|
3813
3813
|
# The regionCode parameter instructs the API to select a video chart available
|
3814
3814
|
# in the specified region. This parameter can only be used in conjunction with
|
@@ -3839,7 +3839,7 @@ module Google
|
|
3839
3839
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3840
3840
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3841
3841
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3842
|
-
def list_videos(chart: nil, debug_project_id_override: nil, hl: nil, id: nil, locale: nil, max_results: nil, my_rating: nil, on_behalf_of_content_owner: nil, page_token: nil,
|
3842
|
+
def list_videos(part, chart: nil, debug_project_id_override: nil, hl: nil, id: nil, locale: nil, max_results: nil, my_rating: nil, on_behalf_of_content_owner: nil, page_token: nil, region_code: nil, video_category_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3843
3843
|
path = 'videos'
|
3844
3844
|
command = make_simple_command(:get, path, options)
|
3845
3845
|
command.response_representation = Google::Apis::YoutubeV3::ListVideosResponse::Representation
|
@@ -3889,7 +3889,7 @@ module Google
|
|
3889
3889
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3890
3890
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3891
3891
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3892
|
-
def rate_video(id
|
3892
|
+
def rate_video(id, rating, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
3893
3893
|
path = 'videos/rate'
|
3894
3894
|
command = make_simple_command(:post, path, options)
|
3895
3895
|
command.query['id'] = id unless id.nil?
|
@@ -3946,17 +3946,6 @@ module Google
|
|
3946
3946
|
end
|
3947
3947
|
|
3948
3948
|
# Updates a video's metadata.
|
3949
|
-
# @param [Google::Apis::YoutubeV3::Video] video_object
|
3950
|
-
# @param [String] on_behalf_of_content_owner
|
3951
|
-
# Note: This parameter is intended exclusively for YouTube content partners.
|
3952
|
-
# The onBehalfOfContentOwner parameter indicates that the request's
|
3953
|
-
# authorization credentials identify a YouTube CMS user who is acting on behalf
|
3954
|
-
# of the content owner specified in the parameter value. This parameter is
|
3955
|
-
# intended for YouTube content partners that own and manage many different
|
3956
|
-
# YouTube channels. It allows content owners to authenticate once and get access
|
3957
|
-
# to all their video and channel data, without having to provide authentication
|
3958
|
-
# credentials for each individual channel. The actual CMS account that the user
|
3959
|
-
# authenticates with must be linked to the specified YouTube content owner.
|
3960
3949
|
# @param [String] part
|
3961
3950
|
# The part parameter serves two purposes in this operation. It identifies the
|
3962
3951
|
# properties that the write operation will set as well as the properties that
|
@@ -3975,6 +3964,17 @@ module Google
|
|
3975
3964
|
# that you can set or modify. If the parameter value specifies a part that does
|
3976
3965
|
# not contain mutable values, that part will still be included in the API
|
3977
3966
|
# response.
|
3967
|
+
# @param [Google::Apis::YoutubeV3::Video] video_object
|
3968
|
+
# @param [String] on_behalf_of_content_owner
|
3969
|
+
# Note: This parameter is intended exclusively for YouTube content partners.
|
3970
|
+
# The onBehalfOfContentOwner parameter indicates that the request's
|
3971
|
+
# authorization credentials identify a YouTube CMS user who is acting on behalf
|
3972
|
+
# of the content owner specified in the parameter value. This parameter is
|
3973
|
+
# intended for YouTube content partners that own and manage many different
|
3974
|
+
# YouTube channels. It allows content owners to authenticate once and get access
|
3975
|
+
# to all their video and channel data, without having to provide authentication
|
3976
|
+
# credentials for each individual channel. The actual CMS account that the user
|
3977
|
+
# authenticates with must be linked to the specified YouTube content owner.
|
3978
3978
|
# @param [String] fields
|
3979
3979
|
# Selector specifying which fields to include in a partial response.
|
3980
3980
|
# @param [String] quota_user
|
@@ -3996,7 +3996,7 @@ module Google
|
|
3996
3996
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3997
3997
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3998
3998
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3999
|
-
def update_video(video_object = nil, on_behalf_of_content_owner: nil,
|
3999
|
+
def update_video(part, video_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
4000
4000
|
path = 'videos'
|
4001
4001
|
command = make_simple_command(:put, path, options)
|
4002
4002
|
command.request_representation = Google::Apis::YoutubeV3::Video::Representation
|
@@ -4012,10 +4012,10 @@ module Google
|
|
4012
4012
|
end
|
4013
4013
|
|
4014
4014
|
# Uploads a watermark image to YouTube and sets it for a channel.
|
4015
|
-
# @param [Google::Apis::YoutubeV3::InvideoBranding] invideo_branding_object
|
4016
4015
|
# @param [String] channel_id
|
4017
4016
|
# The channelId parameter specifies the YouTube channel ID for which the
|
4018
4017
|
# watermark is being provided.
|
4018
|
+
# @param [Google::Apis::YoutubeV3::InvideoBranding] invideo_branding_object
|
4019
4019
|
# @param [String] on_behalf_of_content_owner
|
4020
4020
|
# Note: This parameter is intended exclusively for YouTube content partners.
|
4021
4021
|
# The onBehalfOfContentOwner parameter indicates that the request's
|
@@ -4051,7 +4051,7 @@ module Google
|
|
4051
4051
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4052
4052
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4053
4053
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4054
|
-
def set_watermark(invideo_branding_object = nil,
|
4054
|
+
def set_watermark(channel_id, invideo_branding_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
|
4055
4055
|
path = 'watermarks/set'
|
4056
4056
|
if upload_source.nil?
|
4057
4057
|
command = make_simple_command(:post, path, options)
|
@@ -4105,7 +4105,7 @@ module Google
|
|
4105
4105
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4106
4106
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4107
4107
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4108
|
-
def unset_watermark(channel_id
|
4108
|
+
def unset_watermark(channel_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
|
4109
4109
|
path = 'watermarks/unset'
|
4110
4110
|
command = make_simple_command(:post, path, options)
|
4111
4111
|
command.query['channelId'] = channel_id unless channel_id.nil?
|