Возвращает список видео, соответствующих параметрам запроса API.
Влияние квоты: вызов этого метода имеет стоимость квоты , равную 1 единице.
Общие варианты использования
Запрос
HTTP-запрос
GET https://www.googleapis.com/youtube/v3/videos
Параметры
В следующей таблице перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.
Параметры | ||
---|---|---|
Обязательные параметры | ||
part | string Параметр part указывает разделенный запятыми список одного или нескольких свойств video , которые будут включены в ответ API.Если параметр определяет свойство, которое содержит дочерние свойства, дочерние свойства будут включены в ответ. Например, в video свойство snippet содержит свойства channelId , title , description , tags и categoryId . Таким образом, если вы установите part=snippet , ответ API будет содержать все эти свойства.Следующий список содержит имена part , которые можно включить в значение параметра:
| |
Фильтры (укажите ровно один из следующих параметров) | ||
chart | string Параметр chart определяет диаграмму, которую вы хотите получить.Допустимые значения:
| |
id | string Параметр id указывает разделенный запятыми список идентификаторов видео YouTube для извлекаемых ресурсов. В video свойство id указывает идентификатор видео. | |
myRating | string Этот параметр можно использовать только в правильно авторизованном запросе . Установите для этого параметра значение « like » или dislike , чтобы API возвращал только те видео, которые понравились или не понравились аутентифицированному пользователю.Допустимые значения:
| |
Дополнительные параметры | ||
hl | string Параметр hl дает указание API получить метаданные локализованных ресурсов для определенного языка приложения, поддерживаемого веб-сайтом YouTube . Значение параметра должно быть кодом языка, включенным в список, возвращаемый методом i18nLanguages.list .Если сведения о локализованных ресурсах доступны на этом языке, объект snippet.localized ресурса будет содержать локализованные значения. Однако если локализованные сведения недоступны, объект snippet.localized будет содержать сведения о ресурсе на языке ресурса по умолчанию . | |
maxHeight | unsigned integer Параметр maxHeight указывает максимальную высоту встроенного проигрывателя, возвращаемую в свойстве player.embedHtml . Вы можете использовать этот параметр, чтобы указать, что вместо размеров по умолчанию код внедрения должен использовать высоту, соответствующую макету вашего приложения. Если также указан параметр maxWidth , проигрыватель может быть короче, чем maxHeight , чтобы не нарушать максимальную ширину. Допустимые значения: от 72 до 8192 включительно. | |
maxResults | unsigned integer Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в результирующем наборе.Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating , но не поддерживается для использования в сочетании с параметром id . Допустимые значения: от 1 до 50 включительно. Значение по умолчанию — 5 . | |
maxWidth | unsigned integer Параметр maxWidth указывает максимальную ширину встроенного проигрывателя, возвращаемую в свойстве player.embedHtml . Вы можете использовать этот параметр, чтобы указать, что вместо размеров по умолчанию код внедрения должен использовать ширину, соответствующую макету вашего приложения.Если также указан параметр maxHeight , проигрыватель может быть уже, чем maxWidth , чтобы не нарушать максимальную высоту. Допустимые значения: от 72 до 8192 включительно. | |
onBehalfOfContentOwner | string Этот параметр можно использовать только в правильно авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube. Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя CMS YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют множеством различных каналов YouTube и управляют ими. Это позволяет владельцам контента пройти аутентификацию один раз и получить доступ ко всем своим видео и данным канала без необходимости предоставлять учетные данные для аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube. | |
pageToken | string Параметр pageToken определяет конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойства nextPageToken и prevPageToken определяют другие страницы, которые можно получить.Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating , но не поддерживается для использования в сочетании с параметром id . | |
regionCode | string Параметр regionCode указывает API выбрать видеодиаграмму, доступную в указанном регионе. Этот параметр можно использовать только вместе с параметром chart . Значением параметра является код страны ISO 3166-1 alpha-2. | |
videoCategoryId | string Параметр videoCategoryId определяет категорию видео , для которой необходимо получить диаграмму. Этот параметр можно использовать только вместе с параметром chart . По умолчанию диаграммы не ограничены определенной категорией. Значение по умолчанию — 0 . |
Тело запроса
Не указывайте тело запроса при вызове этого метода.
Ответ
В случае успеха этот метод возвращает тело ответа со следующей структурой:
{ "kind": "youtube#videoListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ video Resource ] }
Характеристики
В следующей таблице определены свойства, которые появляются в этом ресурсе:
Характеристики | |
---|---|
kind | string Идентифицирует тип ресурса API. Значение будет youtube#videoListResponse . |
etag | etag Etag этого ресурса. |
nextPageToken | string Маркер, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в результирующем наборе. |
prevPageToken | string Маркер, который можно использовать в качестве значения параметра pageToken для получения предыдущей страницы в результирующем наборе. |
pageInfo | object Объект pageInfo инкапсулирует информацию о подкачке для результирующего набора. |
pageInfo. totalResults | integer Общее количество результатов в результирующем наборе. |
pageInfo. resultsPerPage | integer Количество результатов, включенных в ответ API. |
items[] | list Список видео, соответствующих критериям запроса. |
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Более подробную информацию см. в документации по сообщениям об ошибках .
Тип ошибки | Сведения об ошибке | Описание |
---|---|---|
badRequest (400) | videoChartNotFound | Запрошенная видеодиаграмма не поддерживается или недоступна. |
forbidden (403) | forbidden | Запрос не авторизован должным образом для доступа к видеофайлу или информации об обработке. Обратите внимание, что части fileDetails , processingDetails и suggestions доступны только владельцу этого видео. |
forbidden (403) | forbidden | Запрос не может получить доступ к информации о рейтинге пользователя. Эта ошибка может возникнуть из-за того, что запрос не авторизован должным образом для использования параметра myRating . |
notFound (404) | videoNotFound | Видео, которое вы пытаетесь получить, не найдено. Проверьте значение параметра id запроса, чтобы убедиться, что оно правильное. |
Попробуй это!
Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.
Возвращает список видео, соответствующих параметрам запроса API.
Влияние квоты: вызов этого метода имеет стоимость квоты , равную 1 единице.
Общие варианты использования
Запрос
HTTP-запрос
GET https://www.googleapis.com/youtube/v3/videos
Параметры
В следующей таблице перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.
Параметры | ||
---|---|---|
Обязательные параметры | ||
part | string Параметр part указывает разделенный запятыми список одного или нескольких свойств video , которые будут включены в ответ API.Если параметр определяет свойство, которое содержит дочерние свойства, дочерние свойства будут включены в ответ. Например, в video свойство snippet содержит свойства channelId , title , description , tags и categoryId . Таким образом, если вы установите part=snippet , ответ API будет содержать все эти свойства.Следующий список содержит имена part , которые можно включить в значение параметра:
| |
Фильтры (укажите ровно один из следующих параметров) | ||
chart | string Параметр chart определяет диаграмму, которую вы хотите получить.Допустимые значения:
| |
id | string Параметр id указывает разделенный запятыми список идентификаторов видео YouTube для извлекаемых ресурсов. В video свойство id указывает идентификатор видео. | |
myRating | string Этот параметр можно использовать только в правильно авторизованном запросе . Установите для этого параметра значение « like » или dislike , чтобы API возвращал только те видео, которые понравились или не понравились аутентифицированному пользователю.Допустимые значения:
| |
Дополнительные параметры | ||
hl | string Параметр hl дает указание API получить метаданные локализованных ресурсов для определенного языка приложения, поддерживаемого веб-сайтом YouTube . Значение параметра должно быть кодом языка, включенным в список, возвращаемый методом i18nLanguages.list .Если сведения о локализованных ресурсах доступны на этом языке, объект snippet.localized ресурса будет содержать локализованные значения. Однако если локализованные сведения недоступны, объект snippet.localized будет содержать сведения о ресурсе на языке ресурса по умолчанию . | |
maxHeight | unsigned integer Параметр maxHeight указывает максимальную высоту встроенного проигрывателя, возвращаемую в свойстве player.embedHtml . Вы можете использовать этот параметр, чтобы указать, что вместо размеров по умолчанию код внедрения должен использовать высоту, соответствующую макету вашего приложения. Если также указан параметр maxWidth , проигрыватель может быть короче, чем maxHeight , чтобы не нарушать максимальную ширину. Допустимые значения: от 72 до 8192 включительно. | |
maxResults | unsigned integer Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в результирующем наборе.Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating , но не поддерживается для использования в сочетании с параметром id . Допустимые значения: от 1 до 50 включительно. Значение по умолчанию — 5 . | |
maxWidth | unsigned integer Параметр maxWidth указывает максимальную ширину встроенного проигрывателя, возвращаемую в свойстве player.embedHtml . Вы можете использовать этот параметр, чтобы указать, что вместо размеров по умолчанию код внедрения должен использовать ширину, соответствующую макету вашего приложения.Если также указан параметр maxHeight , проигрыватель может быть уже, чем maxWidth , чтобы не нарушать максимальную высоту. Допустимые значения: от 72 до 8192 включительно. | |
onBehalfOfContentOwner | string Этот параметр можно использовать только в правильно авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube. Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя CMS YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют множеством различных каналов YouTube и управляют ими. Это позволяет владельцам контента пройти аутентификацию один раз и получить доступ ко всем своим видео и данным канала без необходимости предоставлять учетные данные для аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube. | |
pageToken | string Параметр pageToken определяет конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойства nextPageToken и prevPageToken определяют другие страницы, которые можно получить.Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating , но не поддерживается для использования в сочетании с параметром id . | |
regionCode | string Параметр regionCode указывает API выбрать видеодиаграмму, доступную в указанном регионе. Этот параметр можно использовать только вместе с параметром chart . Значением параметра является код страны ISO 3166-1 alpha-2. | |
videoCategoryId | string Параметр videoCategoryId определяет категорию видео , для которой необходимо получить диаграмму. Этот параметр можно использовать только вместе с параметром chart . По умолчанию диаграммы не ограничены определенной категорией. Значение по умолчанию — 0 . |
Тело запроса
Не указывайте тело запроса при вызове этого метода.
Ответ
В случае успеха этот метод возвращает тело ответа со следующей структурой:
{ "kind": "youtube#videoListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ video Resource ] }
Характеристики
В следующей таблице определены свойства, которые появляются в этом ресурсе:
Характеристики | |
---|---|
kind | string Идентифицирует тип ресурса API. Значение будет youtube#videoListResponse . |
etag | etag Etag этого ресурса. |
nextPageToken | string Маркер, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в результирующем наборе. |
prevPageToken | string Маркер, который можно использовать в качестве значения параметра pageToken для получения предыдущей страницы в результирующем наборе. |
pageInfo | object Объект pageInfo инкапсулирует информацию о подкачке для результирующего набора. |
pageInfo. totalResults | integer Общее количество результатов в результирующем наборе. |
pageInfo. resultsPerPage | integer Количество результатов, включенных в ответ API. |
items[] | list Список видео, соответствующих критериям запроса. |
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Более подробную информацию см. в документации по сообщениям об ошибках .
Тип ошибки | Сведения об ошибке | Описание |
---|---|---|
badRequest (400) | videoChartNotFound | Запрошенная видеодиаграмма не поддерживается или недоступна. |
forbidden (403) | forbidden | Запрос не авторизован должным образом для доступа к видеофайлу или информации об обработке. Обратите внимание, что части fileDetails , processingDetails и suggestions доступны только владельцу этого видео. |
forbidden (403) | forbidden | Запрос не может получить доступ к информации о рейтинге пользователя. Эта ошибка может возникнуть из-за того, что запрос не авторизован должным образом для использования параметра myRating . |
notFound (404) | videoNotFound | Видео, которое вы пытаетесь получить, не найдено. Проверьте значение параметра id запроса, чтобы убедиться, что оно правильное. |
Попробуй это!
Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.
Возвращает список видео, соответствующих параметрам запроса API.
Влияние квоты: вызов этого метода имеет стоимость квоты , равную 1 единице.
Общие варианты использования
Запрос
HTTP-запрос
GET https://www.googleapis.com/youtube/v3/videos
Параметры
В следующей таблице перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.
Параметры | ||
---|---|---|
Обязательные параметры | ||
part | string Параметр part указывает разделенный запятыми список одного или нескольких свойств video , которые будут включены в ответ API.Если параметр определяет свойство, которое содержит дочерние свойства, дочерние свойства будут включены в ответ. Например, в video свойство snippet содержит свойства channelId , title , description , tags и categoryId . Таким образом, если вы установите part=snippet , ответ API будет содержать все эти свойства.Следующий список содержит имена part , которые можно включить в значение параметра:
| |
Фильтры (укажите ровно один из следующих параметров) | ||
chart | string Параметр chart определяет диаграмму, которую вы хотите получить.Допустимые значения:
| |
id | string Параметр id указывает разделенный запятыми список идентификаторов видео YouTube для извлекаемых ресурсов. В video свойство id указывает идентификатор видео. | |
myRating | string Этот параметр можно использовать только в правильно авторизованном запросе . Установите для этого параметра значение « like » или dislike , чтобы API возвращал только те видео, которые понравились или не понравились аутентифицированному пользователю.Допустимые значения:
| |
Дополнительные параметры | ||
hl | string Параметр hl дает указание API получить метаданные локализованных ресурсов для определенного языка приложения, поддерживаемого веб-сайтом YouTube . Значение параметра должно быть кодом языка, включенным в список, возвращаемый методом i18nLanguages.list .Если сведения о локализованных ресурсах доступны на этом языке, объект snippet.localized ресурса будет содержать локализованные значения. Однако если локализованные сведения недоступны, объект snippet.localized будет содержать сведения о ресурсе на языке ресурса по умолчанию . | |
maxHeight | unsigned integer Параметр maxHeight указывает максимальную высоту встроенного проигрывателя, возвращаемую в свойстве player.embedHtml . Вы можете использовать этот параметр, чтобы указать, что вместо размеров по умолчанию код внедрения должен использовать высоту, соответствующую макету вашего приложения. Если также указан параметр maxWidth , проигрыватель может быть короче, чем maxHeight , чтобы не нарушать максимальную ширину. Допустимые значения: от 72 до 8192 включительно. | |
maxResults | unsigned integer Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в результирующем наборе.Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating , но не поддерживается для использования в сочетании с параметром id . Допустимые значения: от 1 до 50 включительно. Значение по умолчанию — 5 . | |
maxWidth | unsigned integer Параметр maxWidth указывает максимальную ширину встроенного проигрывателя, возвращаемую в свойстве player.embedHtml . Вы можете использовать этот параметр, чтобы указать, что вместо размеров по умолчанию код внедрения должен использовать ширину, соответствующую макету вашего приложения.Если также указан параметр maxHeight , проигрыватель может быть уже, чем maxWidth , чтобы не нарушать максимальную высоту. Допустимые значения: от 72 до 8192 включительно. | |
onBehalfOfContentOwner | string Этот параметр можно использовать только в правильно авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube. Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя CMS YouTube, который действует от имени владельца контента, указанного в значении параметра. Этот параметр предназначен для контент-партнеров YouTube, которые владеют множеством различных каналов YouTube и управляют ими. Это позволяет владельцам контента пройти аутентификацию один раз и получить доступ ко всем своим видео и данным канала без необходимости предоставлять учетные данные для аутентификации для каждого отдельного канала. Учетная запись CMS, с помощью которой пользователь проходит аутентификацию, должна быть связана с указанным владельцем контента YouTube. | |
pageToken | string Параметр pageToken определяет конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойства nextPageToken и prevPageToken определяют другие страницы, которые можно получить.Примечание. Этот параметр поддерживается для использования в сочетании с параметром myRating , но не поддерживается для использования в сочетании с параметром id . | |
regionCode | string Параметр regionCode указывает API выбрать видеодиаграмму, доступную в указанном регионе. Этот параметр можно использовать только вместе с параметром chart . Значением параметра является код страны ISO 3166-1 alpha-2. | |
videoCategoryId | string Параметр videoCategoryId определяет категорию видео , для которой необходимо получить диаграмму. Этот параметр можно использовать только вместе с параметром chart . По умолчанию диаграммы не ограничены определенной категорией. Значение по умолчанию — 0 . |
Тело запроса
Не указывайте тело запроса при вызове этого метода.
Ответ
В случае успеха этот метод возвращает тело ответа со следующей структурой:
{ "kind": "youtube#videoListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ video Resource ] }
Характеристики
В следующей таблице определены свойства, которые появляются в этом ресурсе:
Характеристики | |
---|---|
kind | string Идентифицирует тип ресурса API. Значение будет youtube#videoListResponse . |
etag | etag Etag этого ресурса. |
nextPageToken | string Маркер, который можно использовать в качестве значения параметра pageToken для получения следующей страницы в результирующем наборе. |
prevPageToken | string Маркер, который можно использовать в качестве значения параметра pageToken для получения предыдущей страницы в результирующем наборе. |
pageInfo | object Объект pageInfo инкапсулирует информацию о подкачке для результирующего набора. |
pageInfo. totalResults | integer Общее количество результатов в результирующем наборе. |
pageInfo. resultsPerPage | integer Количество результатов, включенных в ответ API. |
items[] | list Список видео, соответствующих критериям запроса. |
Ошибки
В следующей таблице указаны сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Более подробную информацию см. в документации по сообщениям об ошибках .
Тип ошибки | Сведения об ошибке | Описание |
---|---|---|
badRequest (400) | videoChartNotFound | Запрошенная видеодиаграмма не поддерживается или недоступна. |
forbidden (403) | forbidden | Запрос не авторизован должным образом для доступа к видеофайлу или информации об обработке. Обратите внимание, что части fileDetails , processingDetails и suggestions доступны только владельцу этого видео. |
forbidden (403) | forbidden | Запрос не может получить доступ к информации о рейтинге пользователя. Эта ошибка может возникнуть из-за того, что запрос не авторизован должным образом для использования параметра myRating . |
notFound (404) | videoNotFound | Видео, которое вы пытаетесь получить, не найдено. Проверьте значение параметра id запроса, чтобы убедиться, что оно правильное. |
Попробуй это!
Используйте APIs Explorer , чтобы вызвать этот API и просмотреть запрос и ответ API.