| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 75 | <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.members.html">members</a></h1> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 78 | <code><a href="#list">list(part, pageToken=None, maxResults=None, filterByMemberChannelId=None, hasAccessToLevel=None, mode=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Retrieves a list of members that match the request criteria for a channel.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| 81 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 82 | <p class="firstline">Retrieves the next page of results.</p> |
| 83 | <h3>Method Details</h3> |
| 84 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 85 | <code class="details" id="list">list(part, pageToken=None, maxResults=None, filterByMemberChannelId=None, hasAccessToLevel=None, mode=None, x__xgafv=None)</code> |
| 86 | <pre>Retrieves a list of members that match the request criteria for a channel. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | |
| 88 | Args: |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 89 | part: string, The <code><strong>part</strong></code> parameter specifies the |
| 90 | <code>member</code> resource parts that the API response will include. Set |
| 91 | the parameter value to <code>snippet</code>. (required) (repeated) |
| 92 | pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| 93 | page in the result set that should be returned. In an API response, the |
| 94 | <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| 95 | identify other pages that could be retrieved. |
| 96 | maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| 97 | maximum number of items that should be returned in the result set. |
| 98 | filterByMemberChannelId: string, Comma separated list of channel IDs. Only data about members that are part |
| 99 | of this list will be included in the response. |
| 100 | hasAccessToLevel: string, Filter members in the results set to the ones that have access to a level. |
| 101 | mode: string, Parameter that specifies which channel members to return. |
| 102 | x__xgafv: string, V1 error format. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 103 | Allowed values |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 111 | "kind": "youtube#memberListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| 112 | # <code>"youtube#memberListResponse"</code>. |
| 113 | "visitorId": "A String", # The <code>visitorId</code> identifies the visitor. |
| 114 | "tokenPagination": { # Stub token pagination template to suppress results. |
| 115 | }, |
| 116 | "pageInfo": { # Paging details for lists of resources, including total number of items |
| 117 | # available and number of resources returned in a single page. |
| 118 | "resultsPerPage": 42, # The number of results included in the API response. |
| 119 | "totalResults": 42, # The total number of results in the result set. |
| 120 | }, |
| 121 | "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code> |
| 122 | # parameter to retrieve the next page in the result set. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 123 | "eventId": "A String", # Serialized EventId of the request which produced this response. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 124 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "items": [ # A list of members that match the request criteria. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 126 | { # A <code><strong>member</strong></code> resource represents a member for a |
| 127 | # YouTube channel. A member provides recurring monetary support to a creator |
| 128 | # and receives special benefits. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | "etag": "A String", # Etag of this resource. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 130 | "kind": "youtube#member", # Identifies what kind of resource this is. Value: the fixed string |
| 131 | # <code>"youtube#member"</code>. |
| 132 | "snippet": { # The <code>snippet</code> object contains basic details about the member. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | "creatorChannelId": "A String", # The id of the channel that's offering memberships. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 134 | "membershipsDetails": { # Details about the user's membership. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 135 | "highestAccessibleLevelDisplayName": "A String", # Display name for the highest level that the user has access to at the |
| 136 | # moment. |
| 137 | "membershipsDuration": { # Data about memberships duration without taking into consideration pricing |
| 138 | # levels. |
| 139 | "memberTotalDurationMonths": 42, # The cumulative time the user has been a member across all levels in |
| 140 | # complete months (the time is rounded down to the nearest integer). |
| 141 | "memberSince": "A String", # The date and time when the user became a continuous member across all |
| 142 | # levels. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 143 | }, |
| 144 | "membershipsDurationAtLevels": [ # Data about memberships duration on particular pricing levels. |
| 145 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 146 | "memberSince": "A String", # The date and time when the user became a continuous member for the given |
| 147 | # level. |
| 148 | "memberTotalDurationMonths": 42, # The cumulative time the user has been a member for the given level in |
| 149 | # complete months (the time is rounded down to the nearest integer). |
| 150 | "level": "A String", # Pricing level ID. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | }, |
| 152 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 153 | "accessibleLevels": [ # Ids of all levels that the user has access to. This includes the currently |
| 154 | # active level and all other levels that are included because of a higher |
| 155 | # purchase. |
| 156 | "A String", |
| 157 | ], |
| 158 | "highestAccessibleLevel": "A String", # Id of the highest level that the user has access to at the moment. |
| 159 | }, |
| 160 | "memberDetails": { # Details about the member. |
| 161 | "profileImageUrl": "A String", # The channels's avatar URL. |
| 162 | "channelUrl": "A String", # The channel's URL. |
| 163 | "displayName": "A String", # The channel's display name. |
| 164 | "channelId": "A String", # The YouTube channel ID. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | }, |
| 166 | }, |
| 167 | }, |
| 168 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 169 | }</pre> |
| 170 | </div> |
| 171 | |
| 172 | <div class="method"> |
| 173 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 174 | <pre>Retrieves the next page of results. |
| 175 | |
| 176 | Args: |
| 177 | previous_request: The request for the previous page. (required) |
| 178 | previous_response: The response from the request for the previous page. (required) |
| 179 | |
| 180 | Returns: |
| 181 | A request object that you can call 'execute()' on to request the next |
| 182 | page. Returns None if there are no more items in the collection. |
| 183 | </pre> |
| 184 | </div> |
| 185 | |
| 186 | </body></html> |