members
заменяет конечную точку sponsors
, sponsors.list
устарела и больше не будет поддерживаться 30 members.list
2020 г. или позже. Вместо этого используйте метод 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 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 Количество месяцев, округленное до ближайшего целого числа, в течение которых пользователь имел доступ к указанному уровню. Значение отражает количество полных месяцев, в течение которых участник имел доступ к уровню, но это число не означает, что участник постоянно имел членство в течение этого количества месяцев. |