GroupItems: list

Важно: API-запросы к этому методу требуют доступа к:
  • область https://www.googleapis.com/auth/youtube
    или
  • область https://www.googleapis.com/auth/youtube.readonly
    и
    область https://www.googleapis.com/auth/yt-analytics.readonly

В первом варианте используется одна область, которая является областью чтения-записи, а во втором варианте используются две области только для чтения.

Возвращает коллекцию элементов группы, соответствующих параметрам запроса API.

Запрос

HTTP-запрос

GET https://youtubeanalytics.googleapis.com/v2/groupItems

Авторизация

Этот запрос требует авторизации по крайней мере в одной из следующих областей ( подробнее об аутентификации и авторизации ).

Сферы
https://www.googleapis.com/auth/yt-analytics.readonly Просматривайте отчеты YouTube Analytics для своего контента на YouTube. Эта область обеспечивает доступ к показателям активности пользователей, таким как количество просмотров и оценка.
https://www.googleapis.com/auth/yt-analytics-monetary.readonly Просматривайте финансовые отчеты YouTube Analytics для своего контента на YouTube. Эта область обеспечивает доступ к показателям активности пользователей, а также к показателям предполагаемого дохода и эффективности рекламы.
https://www.googleapis.com/auth/youtube Управляйте своим аккаунтом YouTube. В API YouTube Analytics владельцы каналов используют эту область для управления группами и элементами групп YouTube Analytics.
https://www.googleapis.com/auth/youtubepartner Просматривайте ресурсы YouTube и связанный с ними контент на YouTube и управляйте ими. В API YouTube Analytics владельцы контента используют эту область для управления группами и элементами групп YouTube Analytics.

Параметры

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

Параметры
Обязательные параметры
groupId string
Параметр id указывает уникальный идентификатор группы, для которой вы хотите получить элементы группы.
Дополнительные параметры
onBehalfOfContentOwner string
Этот параметр можно использовать только в правильно авторизованном запросе . Примечание. Этот параметр предназначен исключительно для контент-партнеров YouTube, которые владеют и управляют множеством различных каналов YouTube.

Параметр onBehalfOfContentOwner указывает, что учетные данные авторизации запроса идентифицируют пользователя YouTube, который действует от имени владельца контента, указанного в значении параметра. Это позволяет владельцам контента пройти аутентификацию один раз и получить доступ ко всем своим видео и данным канала без необходимости предоставлять учетные данные для аутентификации для каждого отдельного канала. Аккаунт, с которым проходит аутентификацию пользователя, должен быть связан с указанным владельцем контента YouTube.

Тело запроса

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

Ответ

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

{
  "kind": "youtube#groupItemListResponse",
  "etag": etag,
  "items": [
    groupItem Resource
  ]
}

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

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

Характеристики
kind string
Идентифицирует тип ресурса API. Значение будет youtube#groupItemListResponse .
etag etag
Etag этого ресурса.
items[] list
Список элементов, которые содержит группа. Каждый элемент в списке представляет ресурс groupItem .

Ошибки

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

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

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