Youtube · Schema

ChannelListResponse

A list of channel resources matching the request criteria.

GoogleMediaSocialStreamingVideoVideos

Properties

Name Type Description
kind string Identifies the API resource's type. Value is youtube#channelListResponse.
etag string The Etag of this resource.
nextPageToken string The token for the next page of results.
prevPageToken string The token for the previous page of results.
pageInfo object Paging details for a list operation, including information about the total number of resources and the number per page.
items array A list of channels that match the request criteria.
View JSON Schema on GitHub

JSON Schema

youtube-data-channel-list-response-schema.json Raw ↑
{
  "type": "object",
  "description": "A list of channel resources matching the request criteria.",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Identifies the API resource's type. Value is youtube#channelListResponse.",
      "example": "youtube#video"
    },
    "etag": {
      "type": "string",
      "description": "The Etag of this resource.",
      "example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
    },
    "nextPageToken": {
      "type": "string",
      "description": "The token for the next page of results.",
      "example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "prevPageToken": {
      "type": "string",
      "description": "The token for the previous page of results.",
      "example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "pageInfo": {
      "type": "object",
      "description": "Paging details for a list operation, including information about the total number of resources and the number per page.",
      "properties": {
        "totalResults": {
          "type": "integer",
          "description": "The total number of results in the result set.",
          "example": 42
        },
        "resultsPerPage": {
          "type": "integer",
          "description": "The number of results included in the API response.",
          "example": 10
        }
      }
    },
    "items": {
      "type": "array",
      "description": "A list of channels that match the request criteria.",
      "example": [],
      "items": {
        "type": "object",
        "description": "A channel resource represents a YouTube channel.",
        "properties": {
          "kind": {
            "type": "string",
            "description": "Identifies the API resource's type. Value is youtube#channel.",
            "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 channel.",
            "example": "abc123def456"
          },
          "snippet": {
            "type": "object",
            "description": "Basic details about a channel, including its title, description, and thumbnails.",
            "properties": {
              "title": {
                "type": "string",
                "description": "The channel title.",
                "example": "Example Title"
              },
              "description": {
                "type": "string",
                "description": "The channel description.",
                "example": "A sample description for this resource."
              },
              "customUrl": {
                "type": "string",
                "description": "The channel's custom URL.",
                "example": "https://www.example.com"
              },
              "publishedAt": {
                "type": "string",
                "description": "The date and time that the channel was created.",
                "example": "2026-01-15T10:30:00Z",
                "format": "date-time"
              },
              "thumbnails": {
                "type": "object",
                "description": "A map of thumbnail images associated with the channel.",
                "example": "example_value"
              },
              "country": {
                "type": "string",
                "description": "The country with which the channel is associated.",
                "example": 42
              },
              "localized": {
                "type": "object",
                "description": "The snippet.localized object contains a localized title and description for the channel.",
                "example": "example_value",
                "properties": {
                  "title": {
                    "type": "string",
                    "description": "The localized channel title."
                  },
                  "description": {
                    "type": "string",
                    "description": "The localized channel description."
                  }
                }
              }
            }
          },
          "statistics": {
            "type": "object",
            "description": "Statistics about a YouTube channel.",
            "properties": {
              "viewCount": {
                "type": "string",
                "description": "The number of times the channel has been viewed.",
                "example": 42
              },
              "subscriberCount": {
                "type": "string",
                "description": "The number of subscribers that the channel has.",
                "example": 42
              },
              "hiddenSubscriberCount": {
                "type": "boolean",
                "description": "Indicates whether the channel's subscriber count is publicly visible.",
                "example": 42
              },
              "videoCount": {
                "type": "string",
                "description": "The number of public videos uploaded to the channel.",
                "example": 42
              }
            }
          },
          "contentDetails": {
            "type": "object",
            "description": "The contentDetails object encapsulates information about the channel's content.",
            "example": "example_value",
            "properties": {
              "relatedPlaylists": {
                "type": "object",
                "description": "A map that identifies playlists associated with the channel.",
                "properties": {
                  "uploads": {
                    "type": "string",
                    "description": "The ID of the playlist that contains the channel's uploaded videos."
                  },
                  "likes": {
                    "type": "string",
                    "description": "The ID of the playlist that contains the videos that the channel has liked."
                  }
                }
              }
            }
          },
          "brandingSettings": {
            "type": "object",
            "description": "The brandingSettings object encapsulates information about the branding of the channel.",
            "example": "example_value",
            "properties": {
              "channel": {
                "type": "object",
                "description": "Branding settings for the channel page.",
                "properties": {
                  "title": {
                    "type": "string",
                    "description": "The channel title."
                  },
                  "description": {
                    "type": "string",
                    "description": "The channel description."
                  },
                  "keywords": {
                    "type": "string",
                    "description": "Keywords associated with the channel."
                  },
                  "defaultLanguage": {
                    "type": "string",
                    "description": "The content tab that users should display by default on the channel page."
                  }
                }
              },
              "image": {
                "type": "object",
                "description": "Branding images associated with the channel page.",
                "properties": {
                  "bannerExternalUrl": {
                    "type": "string",
                    "description": "The URL for the banner image shown on the channel page on the YouTube website."
                  }
                }
              }
            }
          }
        },
        "required": [
          "kind",
          "etag"
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ChannelListResponse",
  "x-schema-source": "openapi",
  "x-source-url": "openapi/youtube-data-api-openapi.yml"
}