YouTube Data API v3 . sponsors

Instance Methods

list(part, pageToken=None, maxResults=None, filter=None, x__xgafv=None)

Retrieves a list of sponsors that match the request criteria for a

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(part, pageToken=None, maxResults=None, filter=None, x__xgafv=None)
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.
  }
list_next(previous_request, previous_response)
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.