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 75 <h1><a href="youtube_v3.html">YouTube Data API</a> . <a href="youtube_v3.sponsors.html">sponsors</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#list">list(part, filter=None, pageToken=None, maxResults=None)</a></code></p> 79 <p class="firstline">Lists sponsors for a channel.</p> 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"> 85 <code class="details" id="list">list(part, filter=None, pageToken=None, maxResults=None)</code> 86 <pre>Lists sponsors for a channel. 87 88 Args: 89 part: string, The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet. (required) 90 filter: string, The filter parameter specifies which channel sponsors to return. 91 Allowed values 92 all - Return all sponsors, from newest to oldest. 93 newest - Return the most recent sponsors, from newest to oldest. 94 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. 95 maxResults: integer, The maxResults parameter specifies the maximum number of items that should be returned in the result set. 96 97 Returns: 98 An object of the form: 99 100 { 101 "eventId": "A String", # Serialized EventId of the request which produced this response. 102 "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. 103 "kind": "youtube#sponsorListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#sponsorListResponse". 104 "visitorId": "A String", # The visitorId identifies the visitor. 105 "items": [ # A list of sponsors that match the request criteria. 106 { # A sponsor resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits. 107 "snippet": { # The snippet object contains basic details about the sponsor. 108 "sponsorDetails": { # Details about the sponsor. 109 "channelId": "A String", # The YouTube channel ID. 110 "displayName": "A String", # The channel's display name. 111 "profileImageUrl": "A String", # The channels's avatar URL. 112 "channelUrl": "A String", # The channel's URL. 113 }, 114 "channelId": "A String", # The id of the channel being sponsored. 115 "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. 116 }, 117 "kind": "youtube#sponsor", # Identifies what kind of resource this is. Value: the fixed string "youtube#sponsor". 118 "etag": "A String", # Etag of this resource. 119 "id": "A String", # The ID that YouTube assigns to uniquely identify the sponsor. 120 }, 121 ], 122 "tokenPagination": { # Stub token pagination template to suppress results. 123 }, 124 "etag": "A String", # Etag of this resource. 125 "pageInfo": { # Paging details for lists of resources, including total number of items available and number of resources returned in a single page. 126 "totalResults": 42, # The total number of results in the result set. 127 "resultsPerPage": 42, # The number of results included in the API response. 128 }, 129 }</pre> 130 </div> 131 132 <div class="method"> 133 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 134 <pre>Retrieves the next page of results. 135 136 Args: 137 previous_request: The request for the previous page. (required) 138 previous_response: The response from the request for the previous page. (required) 139 140 Returns: 141 A request object that you can call 'execute()' on to request the next 142 page. Returns None if there are no more items in the collection. 143 </pre> 144 </div> 145 146 </body></html>
