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. В этой карте идентификатор категории является ключом карты, а его значение — соответствующим ресурсом guideCategory .

Ошибки

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

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

Попробуйте!

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