Members

Примечание. С 31 марта 2020 г. конечная точка members заменяет конечную точку sponsors , которая устарела и больше не будет поддерживаться 30 сентября 2020 г. или после этой даты. Клиенты API должны обновить вызовы метода sponsors.list , чтобы использовать members.list Вместо этого метод members.list .

Эту конечную точку могут использовать только отдельные авторы для отправки запросов на собственный канал YouTube с поддержкой членства. Обратитесь к своему представителю Google или YouTube, чтобы запросить доступ.

Ресурс member представляет участника канала YouTube. Участник предоставляет автору регулярную денежную поддержку и получает специальные преимущества. Например, участники могут общаться в чате, когда создатель включает режим чата только для участников.

Методы

API поддерживает следующие методы для ресурсов- member :

list
Перечисляет участников (ранее известных как «спонсоры») канала. Запрос API должен быть авторизован владельцем канала.

Представление ресурсов

Следующая структура JSON показывает формат ресурса- member :

{
  "kind": "youtube#member",
  "etag": etag,
  "snippet": {
    "creatorChannelId": string,
    "memberDetails": {
      "channelId": string,
      "channelUrl": string,
      "displayName": string,
      "profileImageUrl": string
    },
    "membershipsDetails": {
      "highestAccessibleLevel": string,
      "highestAccessibleLevelDisplayName": string,
      "accessibleLevels": [
        string
      ],
      "membershipsDuration": {
        "memberSince": datetime,
        "memberTotalDurationMonths": integer,
      },
      "membershipsDurationAtLevel": [
        {
          "level": string,
          "memberSince": datetime,
          "memberTotalDurationMonths": integer,
        }
      ]
    }
  }
}

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

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

Характеристики
kind string
Идентифицирует тип ресурса API. Значением будет youtube#member .
etag etag
Этаг этого ресурса.
snippet object
Объект snippet содержит сведения об элементе.
snippet. creatorChannelId string
Идентификатор канала YouTube автора, предлагающего членство.
snippet. memberDetails object
Этот объект содержит данные профиля канала YouTube, который платит за членство.

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

Ответы API включают ресурсы для этих участников, чтобы обеспечить точный подсчет, даже если сведения о профиле внутри memberDetails не заданы. Для таких участников по-прежнему предоставляются сведения membershipsDetails .
snippet.memberDetails. channelId string
Идентификатор канала YouTube участника. Если он установлен, идентификатор канала также можно рассматривать как уникальный идентификатор участника. Если он не установлен, участник не может быть однозначно идентифицирован, но ресурс по-прежнему передает сведения о членстве, такие как уровни, к которым участник может получить доступ, и продолжительность его членства.
snippet.memberDetails. channelUrl string
URL-адрес канала.
snippet.memberDetails. displayName string
Отображаемое имя канала.
snippet.memberDetails. profileImageUrl string
URL-адрес аватара канала.
snippet. membershipsDetails object
Этот объект содержит сведения о членстве в канале участников.
snippet.membershipsDetails. highestAccessibleLevel string
Идентификатор самого высокого уровня членства, к которому в данный момент имеет доступ канал участника. Значение соответствует значению свойства id в membershipsLevel .
snippet.membershipsDetails. highestAccessibleLevelDisplayName string
Имя самого высокого уровня членства, к которому в данный момент может получить доступ канал участника. Это значение соответствует значению свойства displayName в membershipsLevel .
snippet.membershipsDetails. accessibleLevels[] list (of strings)
Список идентификаторов для всех уровней членства, к которым пользователь может получить доступ в данный момент. Список включает текущий активный уровень и все уровни ниже него.
snippet. membershipsDuration object
Этот объект содержит информацию об общей продолжительности членства текущего участника без учета уровня цен. Свойство snippet.membershipsDetails.membershipsDurationAtLevel[] затем содержит список объектов, содержащих сведения о периоде членства, в течение которого участник имел доступ к определенному уровню членства.

В следующем примере показано, как работают эти свойства: Участник приобретает новое членство в январе на уровне членства 1 и сохраняет это членство до марта. В апреле и мае у участника нет членства. В июне участник возобновляет свое членство, снова на уровне 1. Затем, в августе, участник повышает свое членство до уровня 2. Таким образом, если вызов API будет выполнен в октябре, ресурс member будет содержать следующее: 
"membershipsDetails": {
  "membershipsDuration": {
    "memberSince": "2020-06-01T12:00:00",
    "memberTotalDurationMonths": 7,
  },
  "membershipsDurationAtLevel": [
    {
      "level": "level_1_ID",
      "memberSince": "2020-06-01T12:00:00",
      "memberTotalDurationMonths": 7
    },
    {
      "level": "level_2_ID",
      "memberSince": "2020-08-01T12:00:00",
      "memberTotalDurationMonths": 2
    },
  ]
}
snippet.membershipsDuration. memberSince datetime
Дата и время начала текущего членства участника. Другими словами, участник постоянно имел членство с этой даты и времени. Обратите внимание, что разные периоды членства могли быть проведены на разных уровнях членства.
snippet.membershipsDuration. memberTotalDurationMonths integer
Число месяцев, в течение которых пользователь был участником, округленное до ближайшего целого числа. Значение отражает количество полных месяцев, в течение которых участник имел членство, но это число не означает, что участник постоянно имел членство в течение этого количества месяцев.
snippet.memberDetails.membershipsDetails. membershipsDurationAtLevel[] list (of objects)
Список объектов, в котором каждый объект содержит сведения о периоде членства, в течение которого участник имел доступ к определенному уровню членства. Список включает по одному объекту для каждого уровня членства, к которому в данный момент имеет доступ участник.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel. level string
Идентификатор уровня членства. Значение соответствует значению свойства id в membershipsLevel .
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel. memberSince datetime
Дата и время, начиная с которого участник получил доступ к указанному уровню членства. Другими словами, участник постоянно имел доступ к уровню с этой даты и времени. Обратите внимание, что разные периоды членства могли быть проведены на более высоких уровнях членства.
snippet.memberDetails.membershipsDetails.membershipsDurationAtLevel. memberTotalDurationMonths integer
Количество месяцев, округленное до ближайшего целого числа, в течение которых пользователь имел доступ к указанному уровню. Значение отражает количество полных месяцев, в течение которых участник имел доступ к уровню, но это число не означает, что участник постоянно имел членство в течение этого количества месяцев.