Youtube · JSON Structure

Youtube Data Channel List Response Structure

A list of channel resources matching the request criteria.

Type: object Properties: 6
GoogleMediaSocialStreamingVideoVideos

ChannelListResponse is a JSON Structure definition published by Youtube, describing 6 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

kind etag nextPageToken prevPageToken pageInfo items

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

Raw ↑
{
  "type": "object",
  "description": "A list of channel resources matching the request criteria.",
  "name": "ChannelListResponse",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Identifies the API resource's type. Value is youtube#channelListResponse."
    },
    "etag": {
      "type": "string",
      "description": "The Etag of this resource."
    },
    "nextPageToken": {
      "type": "string",
      "description": "The token for the next page of results."
    },
    "prevPageToken": {
      "type": "string",
      "description": "The token for the previous page of results."
    },
    "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."
        },
        "resultsPerPage": {
          "type": "integer",
          "description": "The number of results included in the API response."
        }
      }
    },
    "items": {
      "type": "array",
      "description": "A list of channels that match the request criteria.",
      "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."
          },
          "etag": {
            "type": "string",
            "description": "The Etag of this resource."
          },
          "id": {
            "type": "string",
            "description": "The ID that YouTube uses to uniquely identify the channel."
          },
          "snippet": {
            "type": "object",
            "description": "Basic details about a channel, including its title, description, and thumbnails.",
            "properties": {
              "title": {
                "type": "string",
                "description": "The channel title."
              },
              "description": {
                "type": "string",
                "description": "The channel description."
              },
              "customUrl": {
                "type": "string",
                "description": "The channel's custom URL."
              },
              "publishedAt": {
                "type": "datetime",
                "description": "The date and time that the channel was created."
              },
              "thumbnails": {
                "type": "object",
                "description": "A map of thumbnail images associated with the channel."
              },
              "country": {
                "type": "string",
                "description": "The country with which the channel is associated."
              },
              "localized": {
                "type": "object",
                "description": "The snippet.localized object contains a localized title and description for the channel.",
                "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."
              },
              "subscriberCount": {
                "type": "string",
                "description": "The number of subscribers that the channel has."
              },
              "hiddenSubscriberCount": {
                "type": "boolean",
                "description": "Indicates whether the channel's subscriber count is publicly visible."
              },
              "videoCount": {
                "type": "string",
                "description": "The number of public videos uploaded to the channel."
              }
            }
          },
          "contentDetails": {
            "type": "object",
            "description": "The contentDetails object encapsulates information about the channel's content.",
            "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.",
            "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-structure.org/draft/2020-12/schema"
}