YouTube Data API v3 . superChatEvents

close()

Close httplib2 connections.

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

Retrieves a list of resources, possibly filtered.

Args:
  part: string, The *part* parameter specifies the superChatEvent resource parts that the API response will include. This parameter is currently not supported. (required) (repeated)
  hl: string, Return rendered funding amounts in specified language.
  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 Super Chat purchases that match the request criteria.
    { # A `__superChatEvent__` resource represents a Super Chat purchase on a YouTube channel.
      "etag": "A String", # Etag of this resource.
      "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"`.
      "snippet": { # The `snippet` object contains basic details about the Super Chat event.
        "amountMicros": "A String", # The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000.
        "channelId": "A String", # Channel id where the event occurred.
        "commentText": "A String", # The text contents of the comment left by the user.
        "createdAt": "A String", # The date and time when the event occurred.
        "currency": "A String", # The currency in which the purchase was made. ISO 4217.
        "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.
        "isSuperStickerEvent": True or False, # True if this event is a Super Sticker event.
        "messageType": 42, # The tier for the paid message, which is based on the amount of money spent to purchase the message.
        "superStickerMetadata": { # If this event is a Super Sticker event, this field will contain metadata about the Super Sticker.
          "altText": "A String", # Internationalized alt text that describes the sticker image and any animation associated with it.
          "altTextLanguage": "A String", # Specifies the localization language in which the alt text is returned.
          "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.
        },
        "supporterDetails": { # Details about the supporter.
          "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.
        },
      },
    },
  ],
  "kind": "youtube#superChatEventListResponse", # Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEventListResponse".
  "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.