YouTube Data API v3 . sponsors

close()

Close httplib2 connections.

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

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

Args:
  part: string, The *part* parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet. (required) (repeated)
  filter: string, Parameter that specifies which channel sponsors to return.
    Allowed values
      sponsorFilterUnknown - 
      newest - Return the most recent sponsors, from newest to oldest.
      all - Return all sponsors, from newest to oldest.
  maxResults: integer, The *maxResults* parameter specifies the maximum number of items that should be returned in the result set.
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "etag": "A String", # Etag of this resource.
  "eventId": "A String", # Serialized EventId of the request which produced this response.
  "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.
      "kind": "youtube#sponsor", # Identifies what kind of resource this is. Value: the fixed string `"youtube#sponsor"`.
      "snippet": { # The `snippet` object contains basic details about the sponsor.
        "channelId": "A String", # The id of the channel being sponsored.
        "cumulativeDurationMonths": 42, # The cumulative time a user has been a sponsor in months.
        "sponsorDetails": { # Details about the sponsor.
          "channelId": "A String", # The YouTube channel ID.
          "channelUrl": "A String", # The channel's URL.
          "displayName": "A String", # The channel's display name.
          "profileImageUrl": "A String", # The channels's avatar URL.
        },
        "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.
      },
    },
  ],
  "kind": "youtube#sponsorListResponse", # Identifies what kind of resource this is. Value: the fixed string `"youtube#sponsorListResponse".
  "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.
  "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.
  },
  "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.