| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="youtube_v3.html">YouTube Data API v3</a> . <a href="youtube_v3.sponsors.html">sponsors</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#list">list(part, pageToken=None, maxResults=None, filter=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a list of sponsors that match the request criteria for a</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="list">list(part, pageToken=None, maxResults=None, filter=None, x__xgafv=None)</code> |
| <pre>Retrieves a list of sponsors that match the request criteria for a |
| channel. |
| |
| Args: |
| part: string, The <code><strong>part</strong></code> parameter specifies the |
| <code>sponsor</code> resource parts that the API response will include. |
| Supported values are <code>id</code> and <code>snippet</code>. (required) (repeated) |
| pageToken: string, The <code><strong>pageToken</strong></code> parameter identifies a specific |
| page in the result set that should be returned. In an API response, the |
| <code>nextPageToken</code> and <code>prevPageToken</code> properties |
| identify other pages that could be retrieved. |
| maxResults: integer, The <code><strong>maxResults</strong></code> parameter specifies the |
| maximum number of items that should be returned in the result set. |
| filter: string, Parameter that specifies which channel sponsors to return. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "items": [ # A list of sponsors that match the request criteria. |
| { # A `__sponsor__` resource represents a sponsor for a YouTube channel. A |
| # sponsor provides recurring monetary support to a creator and receives special |
| # benefits. |
| "etag": "A String", # Etag of this resource. |
| "snippet": { # The `snippet` object contains basic details about the sponsor. |
| "cumulativeDurationMonths": 42, # The cumulative time a user has been a sponsor in months. |
| "sponsorDetails": { # Details about the sponsor. |
| "profileImageUrl": "A String", # The channels's avatar URL. |
| "channelUrl": "A String", # The channel's URL. |
| "displayName": "A String", # The channel's display name. |
| "channelId": "A String", # The YouTube channel ID. |
| }, |
| "sponsorSince": "A String", # The date and time when the user became a sponsor. The value is |
| # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a> |
| # (`YYYY-MM-DDThh:mm:ss.sZ`) format. |
| "channelId": "A String", # The id of the channel being sponsored. |
| }, |
| "kind": "youtube#sponsor", # Identifies what kind of resource this is. Value: the fixed string |
| # `"youtube#sponsor"`. |
| }, |
| ], |
| "pageInfo": { # Paging details for lists of resources, including total number of items |
| # available and number of resources returned in a single page. |
| "resultsPerPage": 42, # The number of results included in the API response. |
| "totalResults": 42, # The total number of results in the result set. |
| }, |
| "tokenPagination": { # Stub token pagination template to suppress results. |
| }, |
| "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. |
| "eventId": "A String", # Serialized EventId of the request which produced this response. |
| "kind": "youtube#sponsorListResponse", # Identifies what kind of resource this is. Value: the fixed string |
| # `"youtube#sponsorListResponse". |
| "etag": "A String", # Etag of this resource. |
| "visitorId": "A String", # The `visitorId` identifies the visitor. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
