Groups: list

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

Запрос

HTTP-запрос

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

Авторизация

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

Сферы
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.

Параметры

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

Параметры
Фильтры (укажите ровно один из следующих параметров)
id string
Параметр id указывает разделенный запятыми список идентификаторов групп YouTube для извлекаемых ресурсов. Каждая группа должна принадлежать аутентифицированному пользователю. В group ресурсе свойство id указывает идентификатор группы YouTube.

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

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

Тело запроса

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

Ответ

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

{
  "kind": "youtube#groupListResponse",
  "etag": etag,
  "items": [
    group Resource
  ],
  "nextPageToken": string
}

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

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

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

Ошибки

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

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

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