Youtube · Schema

CaptionListResponse

A list of caption resources associated with the specified video.

GoogleMediaSocialStreamingVideoVideos

Properties

Name Type Description
kind string Identifies the API resource's type. Value is youtube#captionListResponse.
etag string The Etag of this resource.
items array A list of captions that match the request criteria.
View JSON Schema on GitHub

JSON Schema

youtube-data-caption-list-response-schema.json Raw ↑
{
  "type": "object",
  "description": "A list of caption resources associated with the specified video.",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Identifies the API resource's type. Value is youtube#captionListResponse.",
      "example": "youtube#video"
    },
    "etag": {
      "type": "string",
      "description": "The Etag of this resource.",
      "example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
    },
    "items": {
      "type": "array",
      "description": "A list of captions that match the request criteria.",
      "example": [],
      "items": {
        "type": "object",
        "description": "A caption resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.",
        "properties": {
          "kind": {
            "type": "string",
            "description": "Identifies the API resource's type. Value is youtube#caption.",
            "example": "youtube#video"
          },
          "etag": {
            "type": "string",
            "description": "The Etag of this resource.",
            "example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
          },
          "id": {
            "type": "string",
            "description": "The ID that YouTube uses to uniquely identify the caption track.",
            "example": "abc123def456"
          },
          "snippet": {
            "type": "object",
            "description": "The snippet object contains basic details about the caption.",
            "example": "example_value",
            "properties": {
              "videoId": {
                "type": "string",
                "description": "The ID of the video that the caption track is associated with."
              },
              "lastUpdated": {
                "type": "string",
                "description": "The date and time when the caption track was last updated.",
                "format": "date-time"
              },
              "trackKind": {
                "type": "string",
                "description": "The caption track's type.",
                "enum": [
                  "asr",
                  "forced",
                  "standard"
                ]
              },
              "language": {
                "type": "string",
                "description": "The language of the caption track. The property value is a BCP-47 language tag."
              },
              "name": {
                "type": "string",
                "description": "The name of the caption track."
              },
              "audioTrackType": {
                "type": "string",
                "description": "The type of audio track associated with the caption track.",
                "enum": [
                  "commentary",
                  "descriptive",
                  "primary",
                  "unknown"
                ]
              },
              "isCC": {
                "type": "boolean",
                "description": "Indicates whether the track contains closed captions for the deaf and hard of hearing."
              },
              "isLarge": {
                "type": "boolean",
                "description": "Indicates whether the caption track uses large text for the vision-impaired."
              },
              "isEasyReader": {
                "type": "boolean",
                "description": "Indicates whether caption track is formatted for easy reader."
              },
              "isDraft": {
                "type": "boolean",
                "description": "Indicates whether the caption track is a draft."
              },
              "isAutoSynced": {
                "type": "boolean",
                "description": "Indicates whether YouTube synchronized the caption track to the audio track in the video."
              },
              "status": {
                "type": "string",
                "description": "The caption track's status.",
                "enum": [
                  "failed",
                  "serving",
                  "syncing"
                ]
              }
            }
          }
        },
        "required": [
          "kind",
          "etag"
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CaptionListResponse",
  "x-schema-source": "openapi",
  "x-source-url": "openapi/youtube-data-api-openapi.yml"
}