Inserts a new resource into this collection.
Scopes
You will need authorization for at least one of the following scopes to make a valid call:
- https://www.googleapis.com/auth/youtube
- https://www.googleapis.com/auth/youtube.force-ssl
- https://www.googleapis.com/auth/youtubepartner
If unset, the scope for this method defaults to https://www.googleapis.com/auth/youtube.
You can set the scope for this method like this: youtube3 --scope <scope> playlists insert ...
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
Playlist:
content-details:
item-count: integer
etag: string
id: string
kind: string
player:
embed-html: string
snippet:
channel-id: string
channel-title: string
default-language: string
description: string
localized:
description: string
title: string
published-at: string
tags: [string]
thumbnail-video-id: string
thumbnails:
default:
height: integer
url: string
width: integer
high:
height: integer
url: string
width: integer
maxres:
height: integer
url: string
width: integer
medium:
height: integer
url: string
width: integer
standard:
height: integer
url: string
width: integer
title: string
status:
privacy-status: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-
-r .content-details item-count=16
- The number of videos in the playlist.
-
.. etag=lorem
- Etag of this resource.
id=sit
- The ID that YouTube uses to uniquely identify the playlist.
kind=lorem
- Identifies what kind of resource this is. Value: the fixed string "youtube#playlist".
-
player embed-html=amet.
- An <iframe> tag that embeds a player that will play the playlist.
-
..snippet channel-id=diam
- The ID that YouTube uses to uniquely identify the channel that published the playlist.
channel-title=diam
- The channel title of the channel that the video belongs to.
default-language=et
- The language of the playlist's default title and description.
description=takimata
- The playlist's description.
localized description=et
- The localized strings for playlist's description.
-
title=dolores
- The localized strings for playlist's title.
-
.. published-at=dolores
- The date and time that the playlist was created.
tags=diam
- Keyword tags associated with the playlist.
- Each invocation of this argument appends the given value to the array.
thumbnail-video-id=ea
- Note: if the playlist has a custom thumbnail, this field will not be populated. The video id selected by the user that will be used as the thumbnail of this playlist. This field defaults to the first publicly viewable video in the playlist, if: 1. The user has never selected a video to be the thumbnail of the playlist. 2. The user selects a video to be the thumbnail, and then removes that video from the playlist. 3. The user selects a non-owned video to be the thumbnail, but that video becomes private, or gets deleted.
thumbnails.default height=91
- (Optional) Height of the thumbnail image.
url=dolore
- The thumbnail image's URL.
-
width=32
- (Optional) Width of the thumbnail image.
-
..high height=13
- (Optional) Height of the thumbnail image.
url=tempor
- The thumbnail image's URL.
-
width=79
- (Optional) Width of the thumbnail image.
-
..maxres height=23
- (Optional) Height of the thumbnail image.
url=et
- The thumbnail image's URL.
-
width=44
- (Optional) Width of the thumbnail image.
-
..medium height=86
- (Optional) Height of the thumbnail image.
url=dolor
- The thumbnail image's URL.
-
width=16
- (Optional) Width of the thumbnail image.
-
..standard height=65
- (Optional) Height of the thumbnail image.
url=labore
- The thumbnail image's URL.
-
width=83
- (Optional) Width of the thumbnail image.
-
... title=aliquyam
- The playlist's title.
-
..status privacy-status=ut
- The playlist's privacy status.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
-
-p on-behalf-of-content-owner=string
- Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
-
-p on-behalf-of-content-owner-channel=string
- This parameter can only be used in a properly authorized request. Note: This parameter is intended exclusively for YouTube content partners. The onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the onBehalfOfContentOwner parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the onBehalfOfContentOwner parameter specifies. Finally, the channel that the onBehalfOfContentOwnerChannel parameter value specifies must be linked to the content owner that the onBehalfOfContentOwner parameter specifies. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").