GuideCategories: list

Примечание. Это объявление об устаревании.

Ресурс guideCategories и метод guideCategories.list устарели с 9 сентября 2020 г.

Возвращает список категорий, которые можно связать с каналами YouTube.

Влияние квоты: вызов этого метода имеет стоимость квоты , равную 1 единице.

Запрос

HTTP-запрос

GET https://www.googleapis.com/youtube/v3/guideCategories

Параметры

В таблице ниже перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.

Параметры
Обязательные параметры
part string
Параметр part указывает свойства ресурса guideCategory , которые будут включены в ответ API. Установите значение параметра на snippet .
Фильтры (укажите ровно один из следующих параметров)
id string
Параметр id указывает разделенный запятыми список идентификаторов категорий каналов YouTube для извлекаемых ресурсов. В ресурсе guideCategory свойство id указывает идентификатор категории канала YouTube.
regionCode string
Параметр regionCode указывает API вернуть список категорий справочников, доступных в указанной стране. Значением параметра является код страны ISO 3166-1 alpha-2 .
Дополнительные параметры
hl string
Параметр hl указывает язык, который будет использоваться для текстовых значений в ответе API. Значение по умолчанию en-US .

Тело запроса

Не указывайте тело запроса при вызове этого метода.

Ответ

В случае успеха этот метод возвращает тело ответа со следующей структурой:

{
  "kind": "youtube#guideCategoryListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    guideCategory resource
  ]
}

Характеристики

В следующей таблице определены свойства, которые появляются в этом ресурсе:

Характеристики
kind string
Идентифицирует тип ресурса API. Значение будет youtube#guideCategoryListResponse .
etag etag
Etag этого ресурса.
nextPageToken string
Маркер, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в результирующем наборе.
prevPageToken string
Маркер, который можно использовать в качестве значения параметра pageToken для получения предыдущей страницы в результирующем наборе.
pageInfo object
Объект pageInfo инкапсулирует информацию о подкачке для результирующего набора.
pageInfo. totalResults integer
Общее количество результатов в результирующем наборе.
pageInfo. resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список категорий, которые можно связать с каналами YouTube. В этой карте ID категории — это ключ карты, а его значение — соответствующий ресурс guideCategory .

Ошибки

В таблице ниже указаны сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Более подробную информацию см. в документации по сообщениям об ошибках .

Тип ошибки Сведения об ошибке Описание
notFound (404) notFound Категория справочника, указанная параметром id не может быть найдена. Используйте метод guideCategories.list для получения списка допустимых значений.

Попробуй это!

Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.