YouTube Data API v3 . guideCategories

Instance Methods

list(part, regionCode=None, id=None, hl=None, x__xgafv=None)

Retrieves a list of guide categories.

Method Details

list(part, regionCode=None, id=None, hl=None, x__xgafv=None)
Retrieves a list of guide categories.

Args:
  part: string, The <code><strong>part</strong></code> parameter specifies the
<code>guideCategory</code> resource properties that the API response will
include. Set the parameter value to <code>snippet</code>. (required) (repeated)
  regionCode: string, Return all categories in the given region code.
  id: string, Return the guide categories with the given IDs. (repeated)
  hl: string, A parameter
  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 categories that can be associated with YouTube channels. In this
        # map, the category ID is the map key, and its value is the corresponding
        # <code>guideCategory</code> resource.
      { # A <code><strong>guideCategory</strong></code> resource identifies a category
          # that YouTube algorithmically assigns based on a
          # channel's content or other indicators, such as the channel's popularity. The
          # list is similar to <a
          # href=\"/youtube/v3/docs/videocategory.html\">video categories</a>, with the
          # difference being that a video's uploader can assign a video category but only
          # YouTube can assign a channel category.
        "kind": "youtube#guideCategory", # Identifies what kind of resource this is. Value: the fixed string
            # <code>"youtube#guideCategory"</code>.
        "id": "A String", # The ID that YouTube uses to uniquely identify the guide category.
        "snippet": { # Basic details about a guide category. # The <code>snippet</code> object contains basic details about the category,
            # such as its title.
          "channelId": "A String",
          "title": "A String", # Description of the guide category.
        },
        "etag": "A String", # Etag of this resource.
      },
    ],
    "tokenPagination": { # Stub token pagination template to suppress results.
    },
    "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.
    },
    "visitorId": "A String", # The <code>visitorId</code> identifies the visitor.
    "prevPageToken": "A String", # The token that can be used as the value of the <code>pageToken</code>
        # parameter to retrieve the previous page in the result set.
    "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.
    "kind": "youtube#guideCategoryListResponse", # Identifies what kind of resource this is. Value: the fixed string
        # <code>"youtube#guideCategoryListResponse"</code>.
    "eventId": "A String", # Serialized EventId of the request which produced this response.
  }