Activities: list

YouTube прекратил поддержку функции бюллетеня канала. Метод activities.list по-прежнему не возвращает бюллетени канала, а метод activities.insert больше не поддерживается. Дополнительные сведения см. в Справочном центре YouTube .

Возвращает список событий активности канала, соответствующих критериям запроса. Например, вы можете получить события, связанные с определенным каналом или с собственным каналом пользователя.

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

Общие варианты использования

Запрос

HTTP-запрос

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

Параметры

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

Параметры
Обязательные параметры
part string
Параметр part указывает разделенный запятыми список одного или нескольких свойств ресурсов activity , которые будут включены в ответ API.

Если параметр определяет свойство, которое содержит дочерние свойства, дочерние свойства будут включены в ответ. Например, в ресурсе activity свойство snippet содержит другие свойства, определяющие тип действия, отображаемый заголовок для действия и т. д. Если вы установите part=snippet , ответ API также будет содержать все эти вложенные свойства.

Следующий список содержит имена part , которые можно включить в значение параметра:
  • contentDetails
  • id
  • snippet
Фильтры (укажите ровно один из следующих параметров)
channelId string
Параметр channelId указывает уникальный идентификатор канала YouTube. Затем API вернет список действий этого канала.
home boolean
Примечание. Этот параметр устарел.
Для запросов, в которых задан этот параметр, ответ API содержит элементы, аналогичные тем, которые пользователь, вышедший из системы, увидит на главной странице YouTube. Обратите внимание, что этот параметр можно использовать только в правильно авторизованном запросе .
mine boolean
Этот параметр можно использовать только в правильно авторизованном запросе . Установите для этого параметра значение true , чтобы получить канал действий аутентифицированного пользователя.
Дополнительные параметры
maxResults unsigned integer
Параметр maxResults указывает максимальное количество элементов, которые должны быть возвращены в результирующем наборе. Допустимые значения: от 0 до 50 включительно. Значение по умолчанию — 5 .
pageToken string
Параметр pageToken определяет конкретную страницу в наборе результатов, которая должна быть возвращена. В ответе API свойства nextPageToken и prevPageToken определяют другие страницы, которые можно получить.
publishedAfter datetime
Параметр publishedAfter указывает самую раннюю дату и время, когда могло произойти действие, чтобы это действие было включено в ответ API. Если значение параметра указывает день, но не время, то все действия, произошедшие в этот день, будут включены в набор результатов. Значение указывается в формате ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ).
publishedBefore datetime
Параметр publishedBefore указывает дату и время, до которых должно произойти действие, чтобы это действие было включено в ответ API. Если значение параметра указывает день, но не время, то любые действия, которые произошли в этот день, будут исключены из набора результатов. Значение указывается в формате ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ ).
regionCode string
Параметр regionCode указывает API возвращать результаты для указанной страны. Значением параметра является код страны ISO 3166-1 alpha-2 . YouTube использует это значение, когда предыдущая активность авторизованного пользователя на YouTube не предоставляет достаточно информации для создания канала активности.

Тело запроса

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

Ответ

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

{
  "kind": "youtube#activityListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    activity Resource
  ]
}

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

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

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

Ошибки

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

Тип ошибки Сведения об ошибке Описание
forbidden (403) forbidden Запрос не авторизован должным образом.
forbidden (403) homeParameterDeprecated Данные о действиях пользователя на домашней странице недоступны через этот API. Эта ошибка может возникнуть, если вы установите для параметра home значение true в неавторизованном запросе.
notFound (404) channelNotFound Не удается найти идентификатор канала, указанный параметром channelId запроса.
notFound (404) homeChannelNotFound Канал главной страницы YouTube не может быть найден для текущего пользователя, прошедшего проверку подлинности.
unauthorized (401) authorizationRequired Запрос использует home параметр, но не авторизован должным образом.

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

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