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
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> live-chat-bans 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:
LiveChatBan:
etag: string
id: string
kind: string
snippet:
ban-duration-seconds: string
banned-user-details:
channel-id: string
channel-url: string
display-name: string
profile-image-url: string
live-chat-id: string
type: 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 . etag=diam
- Etag of this resource.
id=amet
- The ID that YouTube assigns to uniquely identify the ban.
kind=at
- Identifies what kind of resource this is. Value: the fixed string
"youtube#liveChatBan"
.
- Identifies what kind of resource this is. Value: the fixed string
snippet ban-duration-seconds=eirmod
- The duration of a ban, only filled if the ban has type TEMPORARY.
banned-user-details channel-id=erat
- The YouTube channel ID.
channel-url=duo
- The channel's URL.
display-name=et
- The channel's display name.
-
profile-image-url=erat
- The channels's avatar URL.
-
.. live-chat-id=sit
- The chat this ban is pertinent to.
type=accusam
- The type of ban.
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 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").