Class CaptionsResource.ListRequest
Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track.
Inheritance
Inherited Members
Namespace: Google.Apis.YouTube.v3
Assembly: Google.Apis.YouTube.v3.dll
Syntax
public class ListRequest : YouTubeBaseServiceRequest<CaptionListResponse>, IClientServiceRequest<CaptionListResponse>, IClientServiceRequestConstructors
ListRequest(IClientService, String, String)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string part, string videoId)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service | |
| System.String | part | |
| System.String | videoId |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
Id
The id parameter specifies a comma-separated list of IDs that identify the caption resources that should be retrieved. Each ID must identify a caption track associated with the specified video.
Declaration
[RequestParameter("id", RequestParameterType.Query)]
public virtual string Id { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
OnBehalfOf
ID of the Google+ Page for the channel that the request is on behalf of.
Declaration
[RequestParameter("onBehalfOf", RequestParameterType.Query)]
public virtual string OnBehalfOf { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
OnBehalfOfContentOwner
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 actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.
Declaration
[RequestParameter("onBehalfOfContentOwner", RequestParameterType.Query)]
public virtual string OnBehalfOfContentOwner { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Part
The part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.
Declaration
[RequestParameter("part", RequestParameterType.Query)]
public virtual string Part { get; }Property Value
| Type | Description |
|---|---|
| System.String |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Overrides
VideoId
The videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.
Declaration
[RequestParameter("videoId", RequestParameterType.Query)]
public virtual string VideoId { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()