google-api-python-client 2.91.0__py2.py3-none-any.whl → 2.93.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/youtube.v3.json

@@ -3833,7 +3833,7 @@
       }
     }
   },
-  "revision": "20230614",
+  "revision": "20230708",
   "rootUrl": "https://youtube.googleapis.com/",
   "schemas": {
     "AbuseReport": {
@@ -4201,6 +4201,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -4228,9 +4229,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -4342,6 +4345,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -4358,6 +4362,7 @@
           "type": "string"
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -4492,6 +4497,7 @@
               "youtube.liveStreams.update"
             ]
           },
+          "deprecated": true,
           "description": "The format of the video stream that you are sending to Youtube. ",
           "type": "string"
         },
@@ -4584,6 +4590,7 @@
         },
         "conversionPings": {
           "$ref": "ChannelConversionPings",
+          "deprecated": true,
           "description": "The conversionPings object encapsulates information about conversion pings that need to be respected by the channel."
         },
         "etag": {
@@ -4672,6 +4679,7 @@
           "description": "Branding properties for the channel view."
         },
         "hints": {
+          "deprecated": true,
           "description": "Additional experimental branding properties.",
           "items": {
             "$ref": "PropertyValue"
@@ -4684,6 +4692,7 @@
         },
         "watch": {
           "$ref": "WatchSettings",
+          "deprecated": true,
           "description": "Branding properties for the watch page."
         }
       },
@@ -4696,6 +4705,7 @@
         "relatedPlaylists": {
           "properties": {
             "favorites": {
+              "deprecated": true,
               "description": "The ID of the playlist that contains the channel\"s favorite videos. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.",
               "type": "string"
             },
@@ -4708,10 +4718,12 @@
               "type": "string"
             },
             "watchHistory": {
+              "deprecated": true,
               "description": "The ID of the playlist that contains the channel\"s watch history. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.",
               "type": "string"
             },
             "watchLater": {
+              "deprecated": true,
               "description": "The ID of the playlist that contains the channel\"s watch later playlist. Use the playlistItems.insert and playlistItems.delete to add or remove items from that list.",
               "type": "string"
             }
@@ -4784,6 +4796,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -4811,9 +4824,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -4881,6 +4896,7 @@
           "additionalProperties": {
             "$ref": "ChannelSectionLocalization"
           },
+          "deprecated": true,
           "description": "Localizations for different languages",
           "type": "object"
         },
@@ -4890,6 +4906,7 @@
         },
         "targeting": {
           "$ref": "ChannelSectionTargeting",
+          "deprecated": true,
           "description": "The targeting object contains basic targeting settings about the channel section."
         }
       },
@@ -4924,6 +4941,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -4940,6 +4958,7 @@
           "type": "string"
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -4951,6 +4970,7 @@
       "id": "ChannelSectionLocalization",
       "properties": {
         "title": {
+          "deprecated": true,
           "description": "The localized strings for channel section's title.",
           "type": "string"
         }
@@ -4966,11 +4986,13 @@
           "type": "string"
         },
         "defaultLanguage": {
+          "deprecated": true,
           "description": "The language of the channel section's default title and description.",
           "type": "string"
         },
         "localized": {
           "$ref": "ChannelSectionLocalization",
+          "deprecated": true,
           "description": "Localized title, read-only."
         },
         "position": {
@@ -4979,6 +5001,7 @@
           "type": "integer"
         },
         "style": {
+          "deprecated": true,
           "description": "The style of the channel section.",
           "enum": [
             "channelsectionStyleUnspecified",
@@ -5017,6 +5040,25 @@
             "postedPlaylists",
             "subscriptions"
           ],
+          "enumDeprecated": [
+            false,
+            false,
+            false,
+            false,
+            false,
+            true,
+            false,
+            true,
+            true,
+            true,
+            false,
+            false,
+            false,
+            false,
+            true,
+            true,
+            false
+          ],
           "enumDescriptions": [
             "",
             "",
@@ -5046,6 +5088,7 @@
       "id": "ChannelSectionTargeting",
       "properties": {
         "countries": {
+          "deprecated": true,
           "description": "The country the channel section is targeting.",
           "items": {
             "type": "string"
@@ -5053,6 +5096,7 @@
           "type": "array"
         },
         "languages": {
+          "deprecated": true,
           "description": "The language the channel section is targeting.",
           "items": {
             "type": "string"
@@ -5060,6 +5104,7 @@
           "type": "array"
         },
         "regions": {
+          "deprecated": true,
           "description": "The region the channel section is targeting.",
           "items": {
             "type": "string"
@@ -5081,6 +5126,7 @@
           "type": "string"
         },
         "defaultTab": {
+          "deprecated": true,
           "description": "Which content tab users should see when viewing the channel.",
           "type": "string"
         },
@@ -5089,10 +5135,12 @@
           "type": "string"
         },
         "featuredChannelsTitle": {
+          "deprecated": true,
           "description": "Title for the featured channels tab.",
           "type": "string"
         },
         "featuredChannelsUrls": {
+          "deprecated": true,
           "description": "The list of featured channels.",
           "items": {
             "type": "string"
@@ -5108,14 +5156,17 @@
           "type": "boolean"
         },
         "profileColor": {
+          "deprecated": true,
           "description": "A prominent color that can be rendered on this channel page.",
           "type": "string"
         },
         "showBrowseView": {
+          "deprecated": true,
           "description": "Whether the tab to browse the videos should be displayed.",
           "type": "boolean"
         },
         "showRelatedChannels": {
+          "deprecated": true,
           "description": "Whether related channels should be proposed.",
           "type": "boolean"
         },
@@ -5284,6 +5335,7 @@
           "type": "array"
         },
         "topicIds": {
+          "deprecated": true,
           "description": "A list of Freebase topic IDs associated with the channel. You can retrieve information about each topic using the Freebase Topic API.",
           "items": {
             "type": "string"
@@ -5325,6 +5377,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -5349,9 +5402,11 @@
           "description": "General pagination information."
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -5495,6 +5550,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -5519,9 +5575,11 @@
           "description": "General pagination information."
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -6272,6 +6330,7 @@
           "type": "string"
         },
         "fmocRating": {
+          "deprecated": true,
           "description": "This property has been deprecated. Use the contentDetails.contentRating.cncRating instead.",
           "enum": [
             "fmocUnspecified",
@@ -6588,6 +6647,18 @@
             "lsf21",
             "lsfUnrated"
           ],
+          "enumDeprecated": [
+            false,
+            false,
+            false,
+            true,
+            false,
+            true,
+            false,
+            true,
+            false,
+            true
+          ],
           "enumDescriptions": [
             "",
             "SU",
@@ -7501,6 +7572,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -7517,6 +7589,7 @@
           "type": "string"
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -7544,6 +7617,7 @@
       "properties": {
         "backgroundImageUrl": {
           "$ref": "LocalizedProperty",
+          "deprecated": true,
           "description": "The URL for the background image shown on the video watch page. The image should be 1200px by 615px, with a maximum file size of 128k."
         },
         "bannerExternalUrl": {
@@ -7551,82 +7625,102 @@
           "type": "string"
         },
         "bannerImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Desktop size (1060x175).",
           "type": "string"
         },
         "bannerMobileExtraHdImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Mobile size high resolution (1440x395).",
           "type": "string"
         },
         "bannerMobileHdImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Mobile size high resolution (1280x360).",
           "type": "string"
         },
         "bannerMobileImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Mobile size (640x175).",
           "type": "string"
         },
         "bannerMobileLowImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Mobile size low resolution (320x88).",
           "type": "string"
         },
         "bannerMobileMediumHdImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Mobile size medium/high resolution (960x263).",
           "type": "string"
         },
         "bannerTabletExtraHdImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Tablet size extra high resolution (2560x424).",
           "type": "string"
         },
         "bannerTabletHdImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Tablet size high resolution (2276x377).",
           "type": "string"
         },
         "bannerTabletImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Tablet size (1707x283).",
           "type": "string"
         },
         "bannerTabletLowImageUrl": {
+          "deprecated": true,
           "description": "Banner image. Tablet size low resolution (1138x188).",
           "type": "string"
         },
         "bannerTvHighImageUrl": {
+          "deprecated": true,
           "description": "Banner image. TV size high resolution (1920x1080).",
           "type": "string"
         },
         "bannerTvImageUrl": {
+          "deprecated": true,
           "description": "Banner image. TV size extra high resolution (2120x1192).",
           "type": "string"
         },
         "bannerTvLowImageUrl": {
+          "deprecated": true,
           "description": "Banner image. TV size low resolution (854x480).",
           "type": "string"
         },
         "bannerTvMediumImageUrl": {
+          "deprecated": true,
           "description": "Banner image. TV size medium resolution (1280x720).",
           "type": "string"
         },
         "largeBrandedBannerImageImapScript": {
           "$ref": "LocalizedProperty",
+          "deprecated": true,
           "description": "The image map script for the large banner image."
         },
         "largeBrandedBannerImageUrl": {
           "$ref": "LocalizedProperty",
+          "deprecated": true,
           "description": "The URL for the 854px by 70px image that appears below the video player in the expanded video view of the video watch page."
         },
         "smallBrandedBannerImageImapScript": {
           "$ref": "LocalizedProperty",
+          "deprecated": true,
           "description": "The image map script for the small banner image."
         },
         "smallBrandedBannerImageUrl": {
           "$ref": "LocalizedProperty",
+          "deprecated": true,
           "description": "The URL for the 640px by 70px banner image that appears below the video player in the default view of the video watch page. The URL for the image that appears above the top-left corner of the video player. This is a 25-pixel-high image with a flexible width that cannot exceed 170 pixels."
         },
         "trackingImageUrl": {
+          "deprecated": true,
           "description": "The URL for a 1px by 1px tracking pixel that can be used to collect statistics for views of the channel or video pages.",
           "type": "string"
         },
         "watchIconImageUrl": {
+          "deprecated": true,
           "type": "string"
         }
       },
@@ -7699,6 +7793,12 @@
             "bottomLeft",
             "bottomRight"
           ],
+          "enumDeprecated": [
+            true,
+            false,
+            true,
+            true
+          ],
           "enumDescriptions": [
             "",
             "",
@@ -7846,6 +7946,7 @@
           "type": "boolean"
         },
         "enableClosedCaptions": {
+          "deprecated": true,
           "description": "This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST.",
           "type": "boolean"
         },
@@ -7862,6 +7963,7 @@
           "type": "boolean"
         },
         "enableLowLatency": {
+          "deprecated": true,
           "description": "Indicates whether this broadcast has low latency enabled.",
           "type": "boolean"
         },
@@ -7941,6 +8043,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -7969,9 +8072,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -8365,6 +8470,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -8397,9 +8503,11 @@
           "type": "integer"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -8429,6 +8537,7 @@
         },
         "fanFundingEventDetails": {
           "$ref": "LiveChatFanFundingEventDetails",
+          "deprecated": true,
           "description": "Details about the funding event, this is only set if the type is 'fanFundingEvent'."
         },
         "giftMembershipReceivedDetails": {
@@ -8555,6 +8664,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -8583,9 +8693,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -8917,6 +9029,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -8944,9 +9057,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -9072,6 +9187,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -9095,9 +9211,11 @@
           "$ref": "PageInfo"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -9220,6 +9338,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -9236,6 +9355,7 @@
           "type": "string"
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -9393,6 +9513,7 @@
       "id": "PlaylistItemContentDetails",
       "properties": {
         "endAt": {
+          "deprecated": true,
           "description": "The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video.",
           "type": "string"
         },
@@ -9401,6 +9522,7 @@
           "type": "string"
         },
         "startAt": {
+          "deprecated": true,
           "description": "The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0.",
           "type": "string"
         },
@@ -9554,6 +9676,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -9582,9 +9705,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -9646,6 +9771,7 @@
           "type": "string"
         },
         "tags": {
+          "deprecated": true,
           "description": "Keyword tags associated with the playlist.",
           "items": {
             "type": "string"
@@ -9931,6 +10057,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -9958,9 +10085,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -10063,6 +10192,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -10086,9 +10216,11 @@
           "$ref": "PageInfo"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -10336,6 +10468,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -10352,6 +10485,7 @@
           "type": "string"
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -10423,6 +10557,7 @@
         },
         "projectDetails": {
           "$ref": "VideoProjectDetails",
+          "deprecated": true,
           "description": "The projectDetails object contains information about the project specific video metadata. b/157517979: This part was never populated after it was added. However, it sees non-zero traffic because there is generated client code in the wild that refers to it [1]. We keep this field and do NOT remove it because otherwise V3 would return an error when this part gets requested [2]. [1] https://developers.google.com/resources/api-libraries/documentation/youtube/v3/csharp/latest/classGoogle_1_1Apis_1_1YouTube_1_1v3_1_1Data_1_1VideoProjectDetails.html [2] http://google3/video/youtube/src/python/servers/data_api/common.py?l=1565-1569&rcl=344141677"
         },
         "recordingDetails": {
@@ -10510,6 +10645,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -10526,6 +10662,7 @@
           "type": "string"
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The `visitorId` identifies the visitor.",
           "type": "string"
         }
@@ -10626,6 +10763,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -10654,9 +10792,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -10748,6 +10888,7 @@
         },
         "regionRestriction": {
           "$ref": "VideoContentDetailsRegionRestriction",
+          "deprecated": true,
           "description": "The regionRestriction object contains information about the countries where a video is (or is not) viewable. The object will contain either the contentDetails.regionRestriction.allowed property or the contentDetails.regionRestriction.blocked property."
         }
       },
@@ -10935,6 +11076,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -10951,6 +11093,7 @@
           "type": "string"
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -10965,6 +11108,7 @@
           "type": "string"
         },
         "eventId": {
+          "deprecated": true,
           "description": "Serialized EventId of the request which produced this response.",
           "type": "string"
         },
@@ -10992,9 +11136,11 @@
           "type": "string"
         },
         "tokenPagination": {
-          "$ref": "TokenPagination"
+          "$ref": "TokenPagination",
+          "deprecated": true
         },
         "visitorId": {
+          "deprecated": true,
           "description": "The visitorId identifies the visitor.",
           "type": "string"
         }
@@ -11305,6 +11451,7 @@
           "type": "string"
         },
         "favoriteCount": {
+          "deprecated": true,
           "description": "The number of users who currently have the video marked as a favorite video.",
           "format": "uint64",
           "type": "string"