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 альфа-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
Этаг этого ресурса.
nextPageToken string
Токен, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в наборе результатов.
prevPageToken string
Токен, который можно использовать в качестве значения параметра pageToken для получения предыдущей страницы в наборе результатов.
pageInfo object
Объект pageInfo инкапсулирует информацию о подкачке для набора результатов.
pageInfo. totalResults integer
Общее количество результатов в наборе результатов.
pageInfo. resultsPerPage integer
Количество результатов, включенных в ответ API.
items[] list
Список категорий, которые можно связать с каналами YouTube. В этой карте идентификатор категории — это ключ карты, а его значение — соответствующий guideCategory .

Ошибки

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

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

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

Используйте APIs Explorer для вызова этого API и просмотра запроса и ответа API.