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 и ответ.