# YouTube Data API v3 . superChatEvents

## Instance Methods

Retrieves a list of resources, possibly filtered.

Retrieves the next page of results.

### Method Details

`list(part, hl=None, pageToken=None, maxResults=None, x__xgafv=None)`

    Retrieves a list of resources, possibly filtered.

    Args:
      part: string, The <code><strong>part</strong></code> parameter specifies the
    <code>superChatEvent</code> resource parts that the API response will
    include. Supported values are <code>id</code> and <code>snippet</code>. (required) (repeated)
      hl: string, Return rendered funding amounts in specified language.
      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.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        {
        "kind": "youtube#superChatEventListResponse", # Identifies what kind of resource this is. Value: the fixed string
            # <code>"youtube#superChatEventListResponse"</code>.
        "tokenPagination": { # Stub token pagination template to suppress results.
        },
        "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
        "nextPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
            # parameter to retrieve the next page in the result set.
        "eventId": "A String", # Serialized EventId of the request which produced this response.
        "items": [ # A list of Super Chat purchases that match the request criteria.
          { # A `__superChatEvent__` resource represents a Super Chat purchase on a YouTube
              # channel.
            "id": "A String", # The ID that YouTube assigns to uniquely identify the Super Chat event.
            "kind": "youtube#superChatEvent", # Identifies what kind of resource this is. Value: the fixed string
                # `"youtube#superChatEvent"`.
            "etag": "A String", # Etag of this resource.
            "snippet": { # The `snippet` object contains basic details about the Super Chat event.
              "messageType": 42, # The tier for the paid message, which is based on the amount of money spent
                  # to purchase the message.
              "commentText": "A String", # The text contents of the comment left by the user.
              "displayString": "A String", # A rendered string that displays the purchase amount and currency
                  # (e.g., "$1.00").  The string is rendered for the given language.
              "createdAt": "A String", # The date and time when the event occurred. The value is
                  # specified in <a href="//www.w3.org/TR/NOTE-datetime">ISO 8601</a>
                  # format.
              "channelId": "A String", # Channel id where the event occurred.
              "amountMicros": "A String", # The purchase amount, in micros of the purchase currency.  e.g., 1 is
                  # represented as 1000000.
              "supporterDetails": { # Details about the supporter.
                "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.
              },
              "currency": "A String", # The currency in which the purchase was made.  ISO 4217.
              "isSuperStickerEvent": True or False, # True if this event is a Super Sticker event.
              "superStickerMetadata": { # If this event is a Super Sticker event, this field will contain metadata
                  # about the Super Sticker.
                "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
                "altText": "A String", # Internationalized alt text that describes the sticker image and any
                    # animation associated with it.
                "stickerId": "A String", # Unique identifier of the Super Sticker. This is a shorter form of the
                    # alt_text that includes pack name and a recognizable characteristic of the
                    # sticker.
              },
            },
          },
        ],
        "etag": "A String", # Etag of this resource.
        "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.
        },
      }

`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.