Captions
Query YouTube Captions. A Caption resource represents a YouTube caption track.
Table Specific Information
Select
YouTube Analytics allows only a subset of columns to be used as filter criteria. The VideoId column must be specified. Extra optional columns supported are Id and OnBehalfOfContentOwner.
All columns support the '=' operator.
SELECT * FROM Captions WHERE VideoId = '123456789'
Columns
| Name | Type | Dimension | DefaultMetric | DefaultDimension | Description |
| Id [KEY] | String | The Id that YouTube uses to uniquely identify the caption track. | |||
| VideoId | String | The Id that YouTube uses to uniquely identify the video associated with the caption track. | |||
| LastUpdated | Datetime | The date and time when the caption track was last updated. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. | |||
| TrackKind | String | The type of the caption track. Valid values for this column: ASR (a caption track generated using automatic speech recognition); Forced (a caption track that plays when no other track is selected in the player. For example, a video that shows aliens speaking in an alien language might have a forced caption track to only show subtitles for the alien language); standard (a regular caption track. This is the default value). | |||
| Language | String | The language of the caption track. The column value is a BCP-47 language tag. | |||
| Name | String | The name of the caption track. The name is intended to be visible to the user as an option during playback. | |||
| AudioTrackType | String | The type of audio track associated with the caption track. Valid values for this column: commentary (the caption track corresponds to an alternate audio track that includes commentary, such as director commentary); descriptive (the caption track corresponds to an alternate audio track that includes additional descriptive audio); primary (the caption track corresponds to the primary audio track for the video, which is the audio track normally associated with the video); unknown (this is the default value). | |||
| IsCC | Boolean | Indicates whether the track contains closed captions for the deaf and hard of hearing. The default value is false. | |||
| IsLarge | Boolean | Indicates whether the caption track uses large text for the vision-impaired. The default value is false. | |||
| IsEasyReader | Boolean | Indicates whether the caption track is formatted for easy reader, meaning it is at a third-grade level for language learners. The default value is false. | |||
| IsDraft | Boolean | Indicates whether the caption track is a draft. If the value is true, then the track is not publicly visible. The default value is false. | |||
| IsAutoSynced | Boolean | Indicates whether YouTube synchronized the caption track to the audio track in the video. The value will be true if a sync was explicitly requested when the caption track was uploaded. If the value is false, YouTube uses the time codes in the uploaded caption track to determine when to display captions. | |||
| Status | String | The status of the caption track. Valid values for this column: failed, serving, syncing. | |||
| FailureReason | String | The reason that YouTube failed to process the caption track. Valid values: processingFailed (YouTube failed to process the uploaded caption track); unknownFormat (the format of the caption track was not recognized); unsupportedFormat (the format of the caption track is not supported). |