LiveBroadcasts: bind
Stay organized with collections
Save and categorize content based on your preferences.
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast.
Common use cases
Request
HTTP request
POST https://www.googleapis.com/youtube/v3/liveBroadcasts/bind
Authorization
This request requires authorization with at least one of the following scopes (
read more about authentication and authorization
).
Scope
|
https://www.googleapis.com/auth/youtube
|
https://www.googleapis.com/auth/youtube.force-ssl
|
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters
|
Required parameters
|
id
|
string
The
id
parameter specifies the unique ID of the broadcast that is being bound to a video stream.
|
part
|
string
The
part
parameter specifies a comma-separated list of one or more
liveBroadcast
resource properties that the API response will include. The
part
names that you can include in the parameter value are
id
,
snippet
,
contentDetails
, and
status
.
|
Optional parameters
|
onBehalfOfContentOwner
|
string
This parameter can only be used in a properly
authorized request
.
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.
|
onBehalfOfContentOwnerChannel
|
string
This parameter can only be used in a properly
authorized request
. 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.
|
streamId
|
string
The
streamId
parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream.
|
Request body
Do not provide a request body when calling this method.
Errors
The following table identifies error messages that the API could return in response to a call to this method. Please see the
error message
documentation for more detail.
Error type
|
Error detail
|
Description
|
backendError
|
internalError
|
An internal error occurred during the bind.
|
forbidden (403)
|
liveBroadcastBindingNotAllowed
|
The current status of the live broadcast does not allow it to be bound to a stream.
|
insufficientPermissions
|
insufficientLivePermissions
|
The request is not authorized to retrieve the specified live broadcast. For more information, see
Implementing OAuth2 authentication
.
|
insufficientPermissions
|
liveStreamingNotEnabled
|
The user that authorized the request is not enabled to stream live video on YouTube. The user can find more information at
https://www.youtube.com/features
.
|
notFound (404)
|
liveBroadcastNotFound
|
The broadcast specified by the
id
parameter does not exist.
|
notFound (404)
|
liveStreamNotFound
|
The stream specified by the
streamId
parameter does not exist.
|
rateLimitExceeded
|
userRequestsExceedRateLimit
|
The user has sent too many requests in a given timeframe.
|
required (400)
|
idRequired
|
The required
id
parameter must identify the broadcast to bind.
|
Try it!
Use the
APIs Explorer
to call this API and see the API request and response.
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-26 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]