1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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 75<h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.sponsors.html">sponsors</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#list">list(part, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Retrieves a list of sponsors that match the request criteria for a channel.</p> 83<p class="toc_element"> 84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 85<p class="firstline">Retrieves the next page of results.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="list">list(part, filter=None, maxResults=None, pageToken=None, x__xgafv=None)</code> 94 <pre>Retrieves a list of sponsors that match the request criteria for a channel. 95 96Args: 97 part: string, The *part* parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet. (required) (repeated) 98 filter: string, Parameter that specifies which channel sponsors to return. 99 Allowed values 100 sponsorFilterUnknown - 101 newest - Return the most recent sponsors, from newest to oldest. 102 all - Return all sponsors, from newest to oldest. 103 maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set. 104 pageToken: string, The *pageToken* parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved. 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110Returns: 111 An object of the form: 112 113 { 114 "etag": "A String", # Etag of this resource. 115 "eventId": "A String", # Serialized EventId of the request which produced this response. 116 "items": [ # A list of sponsors that match the request criteria. 117 { # A `__sponsor__` resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits. 118 "etag": "A String", # Etag of this resource. 119 "kind": "youtube#sponsor", # Identifies what kind of resource this is. Value: the fixed string `"youtube#sponsor"`. 120 "snippet": { # The `snippet` object contains basic details about the sponsor. 121 "channelId": "A String", # The id of the channel being sponsored. 122 "cumulativeDurationMonths": 42, # The cumulative time a user has been a sponsor in months. 123 "sponsorDetails": { # Details about the sponsor. 124 "channelId": "A String", # The YouTube channel ID. 125 "channelUrl": "A String", # The channel's URL. 126 "displayName": "A String", # The channel's display name. 127 "profileImageUrl": "A String", # The channels's avatar URL. 128 }, 129 "sponsorSince": "A String", # The date and time when the user became a sponsor. The value is specified in ISO 8601 (`YYYY-MM-DDThh:mm:ss.sZ`) format. 130 }, 131 }, 132 ], 133 "kind": "youtube#sponsorListResponse", # Identifies what kind of resource this is. Value: the fixed string `"youtube#sponsorListResponse". 134 "nextPageToken": "A String", # The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. 135 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. 136 "resultsPerPage": 42, # The number of results included in the API response. 137 "totalResults": 42, # The total number of results in the result set. 138 }, 139 "tokenPagination": { # Stub token pagination template to suppress results. 140 }, 141 "visitorId": "A String", # The `visitorId` identifies the visitor. 142}</pre> 143</div> 144 145<div class="method"> 146 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 147 <pre>Retrieves the next page of results. 148 149Args: 150 previous_request: The request for the previous page. (required) 151 previous_response: The response from the request for the previous page. (required) 152 153Returns: 154 A request object that you can call 'execute()' on to request the next 155 page. Returns None if there are no more items in the collection. 156 </pre> 157</div> 158 159</body></html>