From c2e0bb3a5de57fdf7c4148b195ddf4a87a4ec5fe Mon Sep 17 00:00:00 2001 From: Google APIs Date: Tue, 7 Jul 2020 00:38:22 +0000 Subject: [PATCH] Autogenerated update (2020-07-07) Update: - civicinfo_v2 - games_v1 - gameservices_v1beta - youtube_partner_v1 - youtube_v3 --- api_names_out.yaml | 228 ++ generated/google/apis/civicinfo_v2.rb | 2 +- generated/google/apis/civicinfo_v2/classes.rb | 10 +- .../apis/civicinfo_v2/representations.rb | 1 + generated/google/apis/civicinfo_v2/service.rb | 2 +- generated/google/apis/games_v1.rb | 8 +- generated/google/apis/games_v1/classes.rb | 2412 ++------------- .../google/apis/games_v1/representations.rb | 659 +--- generated/google/apis/games_v1/service.rb | 1366 ++------- generated/google/apis/gameservices_v1beta.rb | 2 +- .../apis/gameservices_v1beta/classes.rb | 12 +- generated/google/apis/youtube_partner_v1.rb | 7 +- .../google/apis/youtube_partner_v1/classes.rb | 2676 ++++++++++------- .../youtube_partner_v1/representations.rb | 625 ++-- .../google/apis/youtube_partner_v1/service.rb | 2296 ++++++-------- generated/google/apis/youtube_v3.rb | 2 +- generated/google/apis/youtube_v3/classes.rb | 554 ++++ .../google/apis/youtube_v3/representations.rb | 281 ++ generated/google/apis/youtube_v3/service.rb | 261 ++ 19 files changed, 4813 insertions(+), 6591 deletions(-) diff --git a/api_names_out.yaml b/api_names_out.yaml index d8abbf43f..7d826ee9a 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -17413,6 +17413,8 @@ "/civicinfo:v2/Contest/numberElected": number_elected "/civicinfo:v2/Contest/numberVotingFor": number_voting_for "/civicinfo:v2/Contest/office": office +"/civicinfo:v2/Contest/primaryParties": primary_parties +"/civicinfo:v2/Contest/primaryParties/primary_party": primary_party "/civicinfo:v2/Contest/primaryParty": primary_party "/civicinfo:v2/Contest/referendumBallotResponses": referendum_ballot_responses "/civicinfo:v2/Contest/referendumBallotResponses/referendum_ballot_response": referendum_ballot_response @@ -145758,6 +145760,15 @@ "/websecurityscanner:v1beta/websecurityscanner.projects.scanConfigs.scanRuns.stop/name": name "/websecurityscanner:v1beta/websecurityscanner.projects.scanConfigs.start": start_scan_config_scan_run "/websecurityscanner:v1beta/websecurityscanner.projects.scanConfigs.start/name": name +"/youtube:v3/AbuseReport": abuse_report +"/youtube:v3/AbuseReport/abuseTypes": abuse_types +"/youtube:v3/AbuseReport/abuseTypes/abuse_type": abuse_type +"/youtube:v3/AbuseReport/description": description +"/youtube:v3/AbuseReport/relatedEntities": related_entities +"/youtube:v3/AbuseReport/relatedEntities/related_entity": related_entity +"/youtube:v3/AbuseReport/subject": subject +"/youtube:v3/AbuseType": abuse_type +"/youtube:v3/AbuseType/id": id "/youtube:v3/AccessPolicy": access_policy "/youtube:v3/AccessPolicy/allowed": allowed "/youtube:v3/AccessPolicy/exception": exception @@ -145904,6 +145915,9 @@ "/youtube:v3/ChannelBrandingSettings/hints/hint": hint "/youtube:v3/ChannelBrandingSettings/image": image "/youtube:v3/ChannelBrandingSettings/watch": watch +"/youtube:v3/ChannelCard": channel_card +"/youtube:v3/ChannelCard/channelId": channel_id +"/youtube:v3/ChannelCard/customMessage": custom_message "/youtube:v3/ChannelContentDetails": channel_content_details "/youtube:v3/ChannelContentDetails/relatedPlaylists": related_playlists "/youtube:v3/ChannelContentDetails/relatedPlaylists/favorites": favorites @@ -146014,6 +146028,9 @@ "/youtube:v3/ChannelStatus/madeForKids": made_for_kids "/youtube:v3/ChannelStatus/privacyStatus": privacy_status "/youtube:v3/ChannelStatus/selfDeclaredMadeForKids": self_declared_made_for_kids +"/youtube:v3/ChannelToStoreLinkDetails": channel_to_store_link_details +"/youtube:v3/ChannelToStoreLinkDetails/storeName": store_name +"/youtube:v3/ChannelToStoreLinkDetails/storeUrl": store_url "/youtube:v3/ChannelTopicDetails": channel_topic_details "/youtube:v3/ChannelTopicDetails/topicCategories": topic_categories "/youtube:v3/ChannelTopicDetails/topicCategories/topic_category": topic_category @@ -146152,6 +146169,10 @@ "/youtube:v3/ContentRating/smsaRating": smsa_rating "/youtube:v3/ContentRating/tvpgRating": tvpg_rating "/youtube:v3/ContentRating/ytRating": yt_rating +"/youtube:v3/Entity": entity +"/youtube:v3/Entity/id": id +"/youtube:v3/Entity/typeId": type_id +"/youtube:v3/Entity/url": url "/youtube:v3/FanFundingEvent": fan_funding_event "/youtube:v3/FanFundingEvent/etag": etag "/youtube:v3/FanFundingEvent/id": id @@ -146251,6 +146272,28 @@ "/youtube:v3/ImageSettings/smallBrandedBannerImageUrl": small_branded_banner_image_url "/youtube:v3/ImageSettings/trackingImageUrl": tracking_image_url "/youtube:v3/ImageSettings/watchIconImageUrl": watch_icon_image_url +"/youtube:v3/InfoCard": info_card +"/youtube:v3/InfoCard/etag": etag +"/youtube:v3/InfoCard/id": id +"/youtube:v3/InfoCard/kind": kind +"/youtube:v3/InfoCard/snippet": snippet +"/youtube:v3/InfoCardSnippet": info_card_snippet +"/youtube:v3/InfoCardSnippet/channelInfocard": channel_infocard +"/youtube:v3/InfoCardSnippet/linkInfocard": link_infocard +"/youtube:v3/InfoCardSnippet/playlistInfocard": playlist_infocard +"/youtube:v3/InfoCardSnippet/teaser": teaser +"/youtube:v3/InfoCardSnippet/videoInfocard": video_infocard +"/youtube:v3/InfoCardSnippetTeaser": info_card_snippet_teaser +"/youtube:v3/InfoCardSnippetTeaser/teaserStartOffset": teaser_start_offset +"/youtube:v3/InfoCardSnippetTeaser/teaserText": teaser_text +"/youtube:v3/InfoCards": info_cards +"/youtube:v3/InfoCards/items": items +"/youtube:v3/InfoCards/items/item": item +"/youtube:v3/InfocardListResponse": infocard_list_response +"/youtube:v3/InfocardListResponse/etag": etag +"/youtube:v3/InfocardListResponse/items": items +"/youtube:v3/InfocardListResponse/items/item": item +"/youtube:v3/InfocardListResponse/kind": kind "/youtube:v3/IngestionInfo": ingestion_info "/youtube:v3/IngestionInfo/backupIngestionAddress": backup_ingestion_address "/youtube:v3/IngestionInfo/ingestionAddress": ingestion_address @@ -146280,6 +146323,15 @@ "/youtube:v3/LanguageTag/value": value "/youtube:v3/LevelDetails": level_details "/youtube:v3/LevelDetails/displayName": display_name +"/youtube:v3/LinkCard": link_card +"/youtube:v3/LinkCard/customLinkText": custom_link_text +"/youtube:v3/LinkCard/externalImageUrl": external_image_url +"/youtube:v3/LinkCard/targetUrl": target_url +"/youtube:v3/LinkCard/title": title +"/youtube:v3/LinkCard/uploadedImage": uploaded_image +"/youtube:v3/LinkCardUploadedImage": link_card_uploaded_image +"/youtube:v3/LinkCardUploadedImage/imageFile": image_file +"/youtube:v3/LinkCardUploadedImage/version": version "/youtube:v3/LiveBroadcast": live_broadcast "/youtube:v3/LiveBroadcast/contentDetails": content_details "/youtube:v3/LiveBroadcast/etag": etag @@ -146588,6 +146640,10 @@ "/youtube:v3/Playlist/player": player "/youtube:v3/Playlist/snippet": snippet "/youtube:v3/Playlist/status": status +"/youtube:v3/PlaylistCard": playlist_card +"/youtube:v3/PlaylistCard/customMessage": custom_message +"/youtube:v3/PlaylistCard/playlistId": playlist_id +"/youtube:v3/PlaylistCard/startVideoId": start_video_id "/youtube:v3/PlaylistContentDetails": playlist_content_details "/youtube:v3/PlaylistContentDetails/itemCount": item_count "/youtube:v3/PlaylistItem": playlist_item @@ -146668,6 +146724,8 @@ "/youtube:v3/PropertyValue": property_value "/youtube:v3/PropertyValue/property": property "/youtube:v3/PropertyValue/value": value +"/youtube:v3/RelatedEntity": related_entity +"/youtube:v3/RelatedEntity/entity": entity "/youtube:v3/ResourceId": resource_id "/youtube:v3/ResourceId/channelId": channel_id "/youtube:v3/ResourceId/kind": kind @@ -146789,6 +146847,17 @@ "/youtube:v3/TestItem/id": id "/youtube:v3/TestItem/snippet": snippet "/youtube:v3/TestItemTestItemSnippet": test_item_test_item_snippet +"/youtube:v3/ThirdPartyLink": third_party_link +"/youtube:v3/ThirdPartyLink/etag": etag +"/youtube:v3/ThirdPartyLink/kind": kind +"/youtube:v3/ThirdPartyLink/linkingToken": linking_token +"/youtube:v3/ThirdPartyLink/snippet": snippet +"/youtube:v3/ThirdPartyLink/status": status +"/youtube:v3/ThirdPartyLinkSnippet": third_party_link_snippet +"/youtube:v3/ThirdPartyLinkSnippet/channelToStoreLink": channel_to_store_link +"/youtube:v3/ThirdPartyLinkSnippet/type": type +"/youtube:v3/ThirdPartyLinkStatus": third_party_link_status +"/youtube:v3/ThirdPartyLinkStatus/linkStatus": link_status "/youtube:v3/Thumbnail": thumbnail "/youtube:v3/Thumbnail/height": height "/youtube:v3/Thumbnail/url": url @@ -146857,6 +146926,10 @@ "/youtube:v3/VideoAgeGating/alcoholContent": alcohol_content "/youtube:v3/VideoAgeGating/restricted": restricted "/youtube:v3/VideoAgeGating/videoGameRating": video_game_rating +"/youtube:v3/VideoCard": video_card +"/youtube:v3/VideoCard/customMessage": custom_message +"/youtube:v3/VideoCard/playbackStartOffset": playback_start_offset +"/youtube:v3/VideoCard/videoId": video_id "/youtube:v3/VideoCategory": video_category "/youtube:v3/VideoCategory/etag": etag "/youtube:v3/VideoCategory/id": id @@ -147044,6 +147117,8 @@ "/youtube:v3/key": key "/youtube:v3/quotaUser": quota_user "/youtube:v3/userIp": user_ip +"/youtube:v3/youtube.abuseReports.insert": insert_abuse_report +"/youtube:v3/youtube.abuseReports.insert/part": part "/youtube:v3/youtube.activities.insert": insert_activity "/youtube:v3/youtube.activities.insert/part": part "/youtube:v3/youtube.activities.list": list_activities @@ -147360,6 +147435,19 @@ "/youtube:v3/youtube.superChatEvents.list/maxResults": max_results "/youtube:v3/youtube.superChatEvents.list/pageToken": page_token "/youtube:v3/youtube.superChatEvents.list/part": part +"/youtube:v3/youtube.thirdPartyLinks.delete": delete_third_party_link +"/youtube:v3/youtube.thirdPartyLinks.delete/linkingToken": linking_token +"/youtube:v3/youtube.thirdPartyLinks.delete/part": part +"/youtube:v3/youtube.thirdPartyLinks.delete/resourceId": resource_id +"/youtube:v3/youtube.thirdPartyLinks.delete/type": type +"/youtube:v3/youtube.thirdPartyLinks.insert": insert_third_party_link +"/youtube:v3/youtube.thirdPartyLinks.insert/part": part +"/youtube:v3/youtube.thirdPartyLinks.list": list_third_party_links +"/youtube:v3/youtube.thirdPartyLinks.list/linkingToken": linking_token +"/youtube:v3/youtube.thirdPartyLinks.list/part": part +"/youtube:v3/youtube.thirdPartyLinks.list/type": type +"/youtube:v3/youtube.thirdPartyLinks.update": update_third_party_link +"/youtube:v3/youtube.thirdPartyLinks.update/part": part "/youtube:v3/youtube.thumbnails.set": set_thumbnail "/youtube:v3/youtube.thumbnails.set/onBehalfOfContentOwner": on_behalf_of_content_owner "/youtube:v3/youtube.thumbnails.set/videoId": video_id @@ -147412,6 +147500,14 @@ "/youtube:v3/youtube.watermarks.unset": unset_watermark "/youtube:v3/youtube.watermarks.unset/channelId": channel_id "/youtube:v3/youtube.watermarks.unset/onBehalfOfContentOwner": on_behalf_of_content_owner +"/youtube:v3/youtube.youtube.v3.infocards": infocards_youtube_v3 +"/youtube:v3/youtube.youtube.v3.infocards.list": list_youtube_v3_infocards +"/youtube:v3/youtube.youtube.v3.infocards.list/onBehalfOfContentOwner": on_behalf_of_content_owner +"/youtube:v3/youtube.youtube.v3.infocards.list/part": part +"/youtube:v3/youtube.youtube.v3.infocards.list/videoId": video_id +"/youtube:v3/youtube.youtube.v3.infocards/onBehalfOfContentOwner": on_behalf_of_content_owner +"/youtube:v3/youtube.youtube.v3.infocards/part": part +"/youtube:v3/youtube.youtube.v3.infocards/videoId": video_id "/youtube:v3/youtube.youtube.v3.tests.create": create_youtube_v3_test "/youtube:v3/youtube.youtube.v3.tests.create/part": part "/youtubeAnalytics:v1/Group": group @@ -147750,6 +147846,12 @@ "/youtubePartner:v1/AssetSnippet/timeCreated": time_created "/youtubePartner:v1/AssetSnippet/title": title "/youtubePartner:v1/AssetSnippet/type": type +"/youtubePartner:v1/Blobstore2Info": blobstore2_info +"/youtubePartner:v1/Blobstore2Info/blobGeneration": blob_generation +"/youtubePartner:v1/Blobstore2Info/blobId": blob_id +"/youtubePartner:v1/Blobstore2Info/downloadReadHandle": download_read_handle +"/youtubePartner:v1/Blobstore2Info/readToken": read_token +"/youtubePartner:v1/Blobstore2Info/uploadMetadataContainer": upload_metadata_container "/youtubePartner:v1/Campaign": campaign "/youtubePartner:v1/Campaign/campaignData": campaign_data "/youtubePartner:v1/Campaign/id": id @@ -147855,6 +147957,18 @@ "/youtubePartner:v1/ClaimedVideoDefaults/kind": kind "/youtubePartner:v1/ClaimedVideoDefaults/newVideoDefaults": new_video_defaults "/youtubePartner:v1/ClaimedVideoDefaults/newVideoDefaults/new_video_default": new_video_default +"/youtubePartner:v1/CompositeMedia": composite_media +"/youtubePartner:v1/CompositeMedia/blobRef": blob_ref +"/youtubePartner:v1/CompositeMedia/blobstore2Info": blobstore2_info +"/youtubePartner:v1/CompositeMedia/cosmoBinaryReference": cosmo_binary_reference +"/youtubePartner:v1/CompositeMedia/crc32cHash": crc32c_hash +"/youtubePartner:v1/CompositeMedia/inline": inline +"/youtubePartner:v1/CompositeMedia/length": length +"/youtubePartner:v1/CompositeMedia/md5Hash": md5_hash +"/youtubePartner:v1/CompositeMedia/objectId": object_id_prop +"/youtubePartner:v1/CompositeMedia/path": path +"/youtubePartner:v1/CompositeMedia/referenceType": reference_type +"/youtubePartner:v1/CompositeMedia/sha1Hash": sha1_hash "/youtubePartner:v1/Conditions": conditions "/youtubePartner:v1/Conditions/contentMatchType": content_match_type "/youtubePartner:v1/Conditions/contentMatchType/content_match_type": content_match_type @@ -147890,6 +148004,12 @@ "/youtubePartner:v1/ContentOwnerListResponse/items": items "/youtubePartner:v1/ContentOwnerListResponse/items/item": item "/youtubePartner:v1/ContentOwnerListResponse/kind": kind +"/youtubePartner:v1/ContentTypeInfo": content_type_info +"/youtubePartner:v1/ContentTypeInfo/bestGuess": best_guess +"/youtubePartner:v1/ContentTypeInfo/fromBytes": from_bytes +"/youtubePartner:v1/ContentTypeInfo/fromFileName": from_file_name +"/youtubePartner:v1/ContentTypeInfo/fromHeader": from_header +"/youtubePartner:v1/ContentTypeInfo/fromUrlPath": from_url_path "/youtubePartner:v1/CountriesRestriction": countries_restriction "/youtubePartner:v1/CountriesRestriction/adFormats": ad_formats "/youtubePartner:v1/CountriesRestriction/adFormats/ad_format": ad_format @@ -147908,6 +148028,28 @@ "/youtubePartner:v1/DateRange/end": end "/youtubePartner:v1/DateRange/kind": kind "/youtubePartner:v1/DateRange/start": start +"/youtubePartner:v1/DiffChecksumsResponse": diff_checksums_response +"/youtubePartner:v1/DiffChecksumsResponse/checksumsLocation": checksums_location +"/youtubePartner:v1/DiffChecksumsResponse/chunkSizeBytes": chunk_size_bytes +"/youtubePartner:v1/DiffChecksumsResponse/objectLocation": object_location +"/youtubePartner:v1/DiffChecksumsResponse/objectSizeBytes": object_size_bytes +"/youtubePartner:v1/DiffChecksumsResponse/objectVersion": object_version +"/youtubePartner:v1/DiffDownloadResponse": diff_download_response +"/youtubePartner:v1/DiffDownloadResponse/objectLocation": object_location +"/youtubePartner:v1/DiffUploadRequest": diff_upload_request +"/youtubePartner:v1/DiffUploadRequest/checksumsInfo": checksums_info +"/youtubePartner:v1/DiffUploadRequest/objectInfo": object_info +"/youtubePartner:v1/DiffUploadRequest/objectVersion": object_version +"/youtubePartner:v1/DiffUploadResponse": diff_upload_response +"/youtubePartner:v1/DiffUploadResponse/objectVersion": object_version +"/youtubePartner:v1/DiffUploadResponse/originalObject": original_object +"/youtubePartner:v1/DiffVersionResponse": diff_version_response +"/youtubePartner:v1/DiffVersionResponse/objectSizeBytes": object_size_bytes +"/youtubePartner:v1/DiffVersionResponse/objectVersion": object_version +"/youtubePartner:v1/DownloadParameters": download_parameters +"/youtubePartner:v1/DownloadParameters/allowGzipCompression": allow_gzip_compression +"/youtubePartner:v1/DownloadParameters/ignoreRange": ignore_range +"/youtubePartner:v1/Empty": empty "/youtubePartner:v1/ExcludedInterval": excluded_interval "/youtubePartner:v1/ExcludedInterval/high": high "/youtubePartner:v1/ExcludedInterval/low": low @@ -147921,11 +148063,70 @@ "/youtubePartner:v1/LiveCuepoint/id": id "/youtubePartner:v1/LiveCuepoint/kind": kind "/youtubePartner:v1/LiveCuepoint/settings": settings +"/youtubePartner:v1/LongestMatch": longest_match +"/youtubePartner:v1/LongestMatch/durationSecs": duration_secs +"/youtubePartner:v1/LongestMatch/referenceOffset": reference_offset +"/youtubePartner:v1/LongestMatch/userVideoOffset": user_video_offset +"/youtubePartner:v1/MatchInfo": match_info +"/youtubePartner:v1/MatchInfo/longestMatch": longest_match +"/youtubePartner:v1/MatchInfo/matchSegments": match_segments +"/youtubePartner:v1/MatchInfo/matchSegments/match_segment": match_segment +"/youtubePartner:v1/MatchInfo/referenceId": reference_id +"/youtubePartner:v1/MatchInfo/totalMatch": total_match "/youtubePartner:v1/MatchSegment": match_segment "/youtubePartner:v1/MatchSegment/channel": channel "/youtubePartner:v1/MatchSegment/manual_segment": manual_segment "/youtubePartner:v1/MatchSegment/reference_segment": reference_segment "/youtubePartner:v1/MatchSegment/video_segment": video_segment +"/youtubePartner:v1/Media": media +"/youtubePartner:v1/Media/algorithm": algorithm +"/youtubePartner:v1/Media/bigstoreObjectRef": bigstore_object_ref +"/youtubePartner:v1/Media/blobRef": blob_ref +"/youtubePartner:v1/Media/blobstore2Info": blobstore2_info +"/youtubePartner:v1/Media/compositeMedia": composite_media +"/youtubePartner:v1/Media/compositeMedia/composite_medium": composite_medium +"/youtubePartner:v1/Media/contentType": content_type +"/youtubePartner:v1/Media/contentTypeInfo": content_type_info +"/youtubePartner:v1/Media/cosmoBinaryReference": cosmo_binary_reference +"/youtubePartner:v1/Media/crc32cHash": crc32c_hash +"/youtubePartner:v1/Media/diffChecksumsResponse": diff_checksums_response +"/youtubePartner:v1/Media/diffDownloadResponse": diff_download_response +"/youtubePartner:v1/Media/diffUploadRequest": diff_upload_request +"/youtubePartner:v1/Media/diffUploadResponse": diff_upload_response +"/youtubePartner:v1/Media/diffVersionResponse": diff_version_response +"/youtubePartner:v1/Media/downloadParameters": download_parameters +"/youtubePartner:v1/Media/filename": filename +"/youtubePartner:v1/Media/hash": hash_prop +"/youtubePartner:v1/Media/hashVerified": hash_verified +"/youtubePartner:v1/Media/inline": inline +"/youtubePartner:v1/Media/isPotentialRetry": is_potential_retry +"/youtubePartner:v1/Media/length": length +"/youtubePartner:v1/Media/md5Hash": md5_hash +"/youtubePartner:v1/Media/mediaId": media_id +"/youtubePartner:v1/Media/objectId": object_id_prop +"/youtubePartner:v1/Media/path": path +"/youtubePartner:v1/Media/referenceType": reference_type +"/youtubePartner:v1/Media/sha1Hash": sha1_hash +"/youtubePartner:v1/Media/sha256Hash": sha256_hash +"/youtubePartner:v1/Media/timestamp": timestamp +"/youtubePartner:v1/Media/token": token +"/youtubePartner:v1/MediaRequestInfo": media_request_info +"/youtubePartner:v1/MediaRequestInfo/currentBytes": current_bytes +"/youtubePartner:v1/MediaRequestInfo/customData": custom_data +"/youtubePartner:v1/MediaRequestInfo/diffObjectVersion": diff_object_version +"/youtubePartner:v1/MediaRequestInfo/notificationType": notification_type +"/youtubePartner:v1/MediaRequestInfo/requestId": request_id +"/youtubePartner:v1/MediaRequestInfo/totalBytes": total_bytes +"/youtubePartner:v1/MediaRequestInfo/totalBytesIsEstimated": total_bytes_is_estimated +"/youtubePartner:v1/MediaResponseInfo": media_response_info +"/youtubePartner:v1/MediaResponseInfo/customData": custom_data +"/youtubePartner:v1/MediaResponseInfo/dataStorageTransform": data_storage_transform +"/youtubePartner:v1/MediaResponseInfo/dynamicDropTarget": dynamic_drop_target +"/youtubePartner:v1/MediaResponseInfo/dynamicDropzone": dynamic_dropzone +"/youtubePartner:v1/MediaResponseInfo/mediaForDiff": media_for_diff +"/youtubePartner:v1/MediaResponseInfo/requestClass": request_class +"/youtubePartner:v1/MediaResponseInfo/trafficClassField": traffic_class_field +"/youtubePartner:v1/MediaResponseInfo/verifyHashFromHeader": verify_hash_from_header "/youtubePartner:v1/Metadata": metadata "/youtubePartner:v1/Metadata/actor": actor "/youtubePartner:v1/Metadata/actor/actor": actor @@ -147985,6 +148186,10 @@ "/youtubePartner:v1/MetadataHistoryListResponse/items": items "/youtubePartner:v1/MetadataHistoryListResponse/items/item": item "/youtubePartner:v1/MetadataHistoryListResponse/kind": kind +"/youtubePartner:v1/ObjectId": object_id_prop +"/youtubePartner:v1/ObjectId/bucketName": bucket_name +"/youtubePartner:v1/ObjectId/generation": generation +"/youtubePartner:v1/ObjectId/objectName": object_name "/youtubePartner:v1/Order": order "/youtubePartner:v1/Order/availGroupId": avail_group_id "/youtubePartner:v1/Order/channelId": channel_id @@ -148014,6 +148219,8 @@ "/youtubePartner:v1/OrderListResponse/nextPageToken": next_page_token "/youtubePartner:v1/OrderListResponse/pageInfo": page_info "/youtubePartner:v1/OrderListResponse/previousPageToken": previous_page_token +"/youtubePartner:v1/Origin": origin +"/youtubePartner:v1/Origin/source": source "/youtubePartner:v1/Origination": origination "/youtubePartner:v1/Origination/owner": owner "/youtubePartner:v1/Origination/source": source @@ -148101,11 +148308,14 @@ "/youtubePartner:v1/Reference/excludedIntervals": excluded_intervals "/youtubePartner:v1/Reference/excludedIntervals/excluded_interval": excluded_interval "/youtubePartner:v1/Reference/fpDirect": fp_direct +"/youtubePartner:v1/Reference/gdataMedia": gdata_media "/youtubePartner:v1/Reference/hashCode": hash_code "/youtubePartner:v1/Reference/id": id "/youtubePartner:v1/Reference/ignoreFpMatch": ignore_fp_match "/youtubePartner:v1/Reference/kind": kind "/youtubePartner:v1/Reference/length": length +"/youtubePartner:v1/Reference/mediaRequestInfo": media_request_info +"/youtubePartner:v1/Reference/mediaResponseInfo": media_response_info "/youtubePartner:v1/Reference/origination": origination "/youtubePartner:v1/Reference/status": status "/youtubePartner:v1/Reference/statusReason": status_reason @@ -148164,11 +148374,19 @@ "/youtubePartner:v1/Segment/finish": finish "/youtubePartner:v1/Segment/kind": kind "/youtubePartner:v1/Segment/start": start +"/youtubePartner:v1/Segment2": segment2 +"/youtubePartner:v1/Segment2/finish": finish +"/youtubePartner:v1/Segment2/kind": kind +"/youtubePartner:v1/Segment2/start": start "/youtubePartner:v1/ShowDetails": show_details "/youtubePartner:v1/ShowDetails/episodeNumber": episode_number "/youtubePartner:v1/ShowDetails/episodeTitle": episode_title "/youtubePartner:v1/ShowDetails/seasonNumber": season_number "/youtubePartner:v1/ShowDetails/title": title +"/youtubePartner:v1/Source": source +"/youtubePartner:v1/Source/contentOwnerId": content_owner_id +"/youtubePartner:v1/Source/type": type +"/youtubePartner:v1/Source/userEmail": user_email "/youtubePartner:v1/SpreadsheetTemplate": spreadsheet_template "/youtubePartner:v1/SpreadsheetTemplate/kind": kind "/youtubePartner:v1/SpreadsheetTemplate/status": status @@ -148201,6 +148419,14 @@ "/youtubePartner:v1/TerritoryOwners/territories": territories "/youtubePartner:v1/TerritoryOwners/territories/territory": territory "/youtubePartner:v1/TerritoryOwners/type": type +"/youtubePartner:v1/TotalMatch": total_match +"/youtubePartner:v1/TotalMatch/referenceDurationSecs": reference_duration_secs +"/youtubePartner:v1/TotalMatch/userVideoDurationSecs": user_video_duration_secs +"/youtubePartner:v1/TypeDetails": type_details +"/youtubePartner:v1/TypeDetails/appealExplanation": appeal_explanation +"/youtubePartner:v1/TypeDetails/disputeNotes": dispute_notes +"/youtubePartner:v1/TypeDetails/disputeReason": dispute_reason +"/youtubePartner:v1/TypeDetails/updateStatus": update_status "/youtubePartner:v1/Uploader": uploader "/youtubePartner:v1/Uploader/kind": kind "/youtubePartner:v1/Uploader/uploaderName": uploader_name @@ -148274,6 +148500,8 @@ "/youtubePartner:v1/WhitelistListResponse/kind": kind "/youtubePartner:v1/WhitelistListResponse/nextPageToken": next_page_token "/youtubePartner:v1/WhitelistListResponse/pageInfo": page_info +"/youtubePartner:v1/YoutubePartnerApiProtoFrontendV1Origin": youtube_partner_api_proto_frontend_v1_origin +"/youtubePartner:v1/YoutubePartnerApiProtoFrontendV1Origin/source": source "/youtubePartner:v1/fields": fields "/youtubePartner:v1/key": key "/youtubePartner:v1/quotaUser": quota_user diff --git a/generated/google/apis/civicinfo_v2.rb b/generated/google/apis/civicinfo_v2.rb index 5475e3b7e..0e1ec64ad 100644 --- a/generated/google/apis/civicinfo_v2.rb +++ b/generated/google/apis/civicinfo_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/civic-information/ module CivicinfoV2 VERSION = 'V2' - REVISION = '20200624' + REVISION = '20200706' end end end diff --git a/generated/google/apis/civicinfo_v2/classes.rb b/generated/google/apis/civicinfo_v2/classes.rb index ef8c6e2b8..e7c519e60 100644 --- a/generated/google/apis/civicinfo_v2/classes.rb +++ b/generated/google/apis/civicinfo_v2/classes.rb @@ -317,7 +317,14 @@ module Google # @return [String] attr_accessor :office - # If this is a partisan election, the name of the party it is for. + # If this is a partisan election, the name of the party/parties it is for. + # Corresponds to the JSON property `primaryParties` + # @return [Array] + attr_accessor :primary_parties + + # [DEPRECATED] If this is a partisan election, the name of the party it is for. + # This field as deprecated in favor of the array "primaryParties", as contests + # may contain more than one party. # Corresponds to the JSON property `primaryParty` # @return [String] attr_accessor :primary_party @@ -425,6 +432,7 @@ module Google @number_elected = args[:number_elected] if args.key?(:number_elected) @number_voting_for = args[:number_voting_for] if args.key?(:number_voting_for) @office = args[:office] if args.key?(:office) + @primary_parties = args[:primary_parties] if args.key?(:primary_parties) @primary_party = args[:primary_party] if args.key?(:primary_party) @referendum_ballot_responses = args[:referendum_ballot_responses] if args.key?(:referendum_ballot_responses) @referendum_brief = args[:referendum_brief] if args.key?(:referendum_brief) diff --git a/generated/google/apis/civicinfo_v2/representations.rb b/generated/google/apis/civicinfo_v2/representations.rb index b92ab19a7..d119c6883 100644 --- a/generated/google/apis/civicinfo_v2/representations.rb +++ b/generated/google/apis/civicinfo_v2/representations.rb @@ -216,6 +216,7 @@ module Google property :number_elected, :numeric_string => true, as: 'numberElected' property :number_voting_for, :numeric_string => true, as: 'numberVotingFor' property :office, as: 'office' + collection :primary_parties, as: 'primaryParties' property :primary_party, as: 'primaryParty' collection :referendum_ballot_responses, as: 'referendumBallotResponses' property :referendum_brief, as: 'referendumBrief' diff --git a/generated/google/apis/civicinfo_v2/service.rb b/generated/google/apis/civicinfo_v2/service.rb index 012257a4c..3865ccebe 100644 --- a/generated/google/apis/civicinfo_v2/service.rb +++ b/generated/google/apis/civicinfo_v2/service.rb @@ -121,7 +121,7 @@ module Google # @param [Boolean] official_only # If set to true, only data from official state sources will be returned. # @param [Boolean] return_all_available_data - # If set to true, the query will return the success codeand include any partial + # If set to true, the query will return the success code and include any partial # information when it is unable to determine a matching address or unable to # determine the election for electionId=0 queries. # @param [String] fields diff --git a/generated/google/apis/games_v1.rb b/generated/google/apis/games_v1.rb index 36644c736..90373aac9 100644 --- a/generated/google/apis/games_v1.rb +++ b/generated/google/apis/games_v1.rb @@ -18,11 +18,13 @@ require 'google/apis/games_v1/representations.rb' module Google module Apis - # Google Play Game Services API + # Google Play Game Services # - # The API for Google Play Game Services. + # The Google Play games service allows developers to enhance games with social + # leaderboards, + # achievements, game state, sign-in with Google, and more. # - # @see https://developers.google.com/games/services/ + # @see https://developers.google.com/games/ module GamesV1 VERSION = 'V1' REVISION = '20200625' diff --git a/generated/google/apis/games_v1/classes.rb b/generated/google/apis/games_v1/classes.rb index 19c010b6d..1603fa066 100644 --- a/generated/google/apis/games_v1/classes.rb +++ b/generated/google/apis/games_v1/classes.rb @@ -22,14 +22,11 @@ module Google module Apis module GamesV1 - # This is a JSON template for an achievement definition object. + # An achievement definition object. class AchievementDefinition include Google::Apis::Core::Hashable # The type of the achievement. - # Possible values are: - # - "STANDARD" - Achievement is either locked or unlocked. - # - "INCREMENTAL" - Achievement is incremental. # Corresponds to the JSON property `achievementType` # @return [String] attr_accessor :achievement_type @@ -55,30 +52,26 @@ module Google attr_accessor :id # The initial state of the achievement. - # Possible values are: - # - "HIDDEN" - Achievement is hidden. - # - "REVEALED" - Achievement is revealed. - # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `initialState` # @return [String] attr_accessor :initial_state - # Indicates whether the revealed icon image being returned is a default image, - # or is provided by the game. + # Indicates whether the revealed icon image being returned is a default + # image, or is provided by the game. # Corresponds to the JSON property `isRevealedIconUrlDefault` # @return [Boolean] attr_accessor :is_revealed_icon_url_default alias_method :is_revealed_icon_url_default?, :is_revealed_icon_url_default - # Indicates whether the unlocked icon image being returned is a default image, - # or is game-provided. + # Indicates whether the unlocked icon image being returned is a default + # image, or is game-provided. # Corresponds to the JSON property `isUnlockedIconUrlDefault` # @return [Boolean] attr_accessor :is_unlocked_icon_url_default alias_method :is_unlocked_icon_url_default?, :is_unlocked_icon_url_default # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementDefinition. + # string `games#achievementDefinition`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -125,7 +118,7 @@ module Google end end - # This is a JSON template for a list of achievement definition objects. + # A list of achievement definition objects. class ListAchievementDefinitionsResponse include Google::Apis::Core::Hashable @@ -135,7 +128,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementDefinitionsListResponse. + # string `games#achievementDefinitionsListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -157,7 +150,7 @@ module Google end end - # This is a JSON template for an achievement increment response + # An achievement increment response class AchievementIncrementResponse include Google::Apis::Core::Hashable @@ -167,76 +160,12 @@ module Google attr_accessor :current_steps # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementIncrementResponse. + # string `games#achievementIncrementResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Whether the current steps for the achievement has reached the number of steps - # required to unlock. - # Corresponds to the JSON property `newlyUnlocked` - # @return [Boolean] - attr_accessor :newly_unlocked - alias_method :newly_unlocked?, :newly_unlocked - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @current_steps = args[:current_steps] if args.key?(:current_steps) - @kind = args[:kind] if args.key?(:kind) - @newly_unlocked = args[:newly_unlocked] if args.key?(:newly_unlocked) - end - end - - # This is a JSON template for an achievement reveal response - class AchievementRevealResponse - include Google::Apis::Core::Hashable - - # The current state of the achievement for which a reveal was attempted. This - # might be UNLOCKED if the achievement was already unlocked. - # Possible values are: - # - "REVEALED" - Achievement is revealed. - # - "UNLOCKED" - Achievement is unlocked. - # Corresponds to the JSON property `currentState` - # @return [String] - attr_accessor :current_state - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementRevealResponse. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @current_state = args[:current_state] if args.key?(:current_state) - @kind = args[:kind] if args.key?(:kind) - end - end - - # This is a JSON template for an achievement set steps at least response. - class AchievementSetStepsAtLeastResponse - include Google::Apis::Core::Hashable - - # The current steps recorded for this incremental achievement. - # Corresponds to the JSON property `currentSteps` - # @return [Fixnum] - attr_accessor :current_steps - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementSetStepsAtLeastResponse. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Whether the the current steps for the achievement has reached the number of + # Whether the current steps for the achievement has reached the number of # steps required to unlock. # Corresponds to the JSON property `newlyUnlocked` # @return [Boolean] @@ -255,12 +184,73 @@ module Google end end - # This is a JSON template for an achievement unlock response + # An achievement reveal response + class AchievementRevealResponse + include Google::Apis::Core::Hashable + + # The current state of the achievement for which a reveal was attempted. This + # might be `UNLOCKED` if the achievement was already unlocked. + # Corresponds to the JSON property `currentState` + # @return [String] + attr_accessor :current_state + + # Uniquely identifies the type of this resource. Value is always the fixed + # string `games#achievementRevealResponse`. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_state = args[:current_state] if args.key?(:current_state) + @kind = args[:kind] if args.key?(:kind) + end + end + + # An achievement set steps at least response. + class AchievementSetStepsAtLeastResponse + include Google::Apis::Core::Hashable + + # The current steps recorded for this incremental achievement. + # Corresponds to the JSON property `currentSteps` + # @return [Fixnum] + attr_accessor :current_steps + + # Uniquely identifies the type of this resource. Value is always the fixed + # string `games#achievementSetStepsAtLeastResponse`. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # Whether the current steps for the achievement has reached the number of + # steps required to unlock. + # Corresponds to the JSON property `newlyUnlocked` + # @return [Boolean] + attr_accessor :newly_unlocked + alias_method :newly_unlocked?, :newly_unlocked + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_steps = args[:current_steps] if args.key?(:current_steps) + @kind = args[:kind] if args.key?(:kind) + @newly_unlocked = args[:newly_unlocked] if args.key?(:newly_unlocked) + end + end + + # An achievement unlock response class AchievementUnlockResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementUnlockResponse. + # string `games#achievementUnlockResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -283,12 +273,12 @@ module Google end end - # This is a JSON template for a list of achievement update requests. + # A list of achievement update requests. class AchievementUpdateMultipleRequest include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementUpdateMultipleRequest. + # string `games#achievementUpdateMultipleRequest`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -309,12 +299,12 @@ module Google end end - # This is a JSON template for an achievement unlock response. + # class AchievementUpdateMultipleResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementUpdateMultipleResponse. + # string `games#achievementUpdateMultipleResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -335,7 +325,7 @@ module Google end end - # This is a JSON template for a request to update an achievement. + # A request to update an achievement. class UpdateAchievementRequest include Google::Apis::Core::Hashable @@ -344,29 +334,25 @@ module Google # @return [String] attr_accessor :achievement_id - # This is a JSON template for the payload to request to increment an achievement. + # The payload to request to increment an + # achievement. # Corresponds to the JSON property `incrementPayload` # @return [Google::Apis::GamesV1::GamesAchievementIncrement] attr_accessor :increment_payload # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementUpdateRequest. + # string `games#achievementUpdateRequest`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for the payload to request to increment an achievement. + # The payload to request to increment an + # achievement. # Corresponds to the JSON property `setStepsAtLeastPayload` # @return [Google::Apis::GamesV1::GamesAchievementSetStepsAtLeast] attr_accessor :set_steps_at_least_payload # The type of update being applied. - # Possible values are: - # - "REVEAL" - Achievement is revealed. - # - "UNLOCK" - Achievement is unlocked. - # - "INCREMENT" - Achievement is incremented. - # - "SET_STEPS_AT_LEAST" - Achievement progress is set to at least the passed - # value. # Corresponds to the JSON property `updateType` # @return [String] attr_accessor :update_type @@ -385,7 +371,7 @@ module Google end end - # This is a JSON template for an achievement update response. + # An updated achievement. class UpdateAchievementResponse include Google::Apis::Core::Hashable @@ -395,10 +381,6 @@ module Google attr_accessor :achievement_id # The current state of the achievement. - # Possible values are: - # - "HIDDEN" - Achievement is hidden. - # - "REVEALED" - Achievement is revealed. - # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `currentState` # @return [String] attr_accessor :current_state @@ -409,7 +391,7 @@ module Google attr_accessor :current_steps # Uniquely identifies the type of this resource. Value is always the fixed - # string games#achievementUpdateResponse. + # string `games#achievementUpdateResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -442,83 +424,7 @@ module Google end end - # This is a JSON template for aggregate stats. - class AggregateStats - include Google::Apis::Core::Hashable - - # The number of messages sent between a pair of peers. - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#aggregateStats. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The maximum amount. - # Corresponds to the JSON property `max` - # @return [Fixnum] - attr_accessor :max - - # The minimum amount. - # Corresponds to the JSON property `min` - # @return [Fixnum] - attr_accessor :min - - # The total number of bytes sent for messages between a pair of peers. - # Corresponds to the JSON property `sum` - # @return [Fixnum] - attr_accessor :sum - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @count = args[:count] if args.key?(:count) - @kind = args[:kind] if args.key?(:kind) - @max = args[:max] if args.key?(:max) - @min = args[:min] if args.key?(:min) - @sum = args[:sum] if args.key?(:sum) - end - end - - # This is a JSON template for an anonymous player - class AnonymousPlayer - include Google::Apis::Core::Hashable - - # The base URL for the image to display for the anonymous player. - # Corresponds to the JSON property `avatarImageUrl` - # @return [String] - attr_accessor :avatar_image_url - - # The name to display for the anonymous player. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#anonymousPlayer. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @avatar_image_url = args[:avatar_image_url] if args.key?(:avatar_image_url) - @display_name = args[:display_name] if args.key?(:display_name) - @kind = args[:kind] if args.key?(:kind) - end - end - - # This is a JSON template for the Application resource. + # The Application resource. class Application include Google::Apis::Core::Hashable @@ -537,7 +443,7 @@ module Google # @return [String] attr_accessor :author - # This is a JSON template for an application category object. + # An application category object. # Corresponds to the JSON property `category` # @return [Google::Apis::GamesV1::ApplicationCategory] attr_accessor :category @@ -548,8 +454,6 @@ module Google attr_accessor :description # A list of features that have been enabled for the application. - # Possible values are: - # - "SNAPSHOTS" - Snapshots has been enabled # Corresponds to the JSON property `enabledFeatures` # @return [Array] attr_accessor :enabled_features @@ -565,7 +469,7 @@ module Google attr_accessor :instances # Uniquely identifies the type of this resource. Value is always the fixed - # string games#application. + # string `games#application`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -613,12 +517,12 @@ module Google end end - # This is a JSON template for an application category object. + # An application category object. class ApplicationCategory include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#applicationCategory. + # string `games#applicationCategory`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -645,8 +549,7 @@ module Google end end - # This is a JSON template for a third party application verification response - # resource. + # A third party application verification response resource. class ApplicationVerifyResponse include Google::Apis::Core::Hashable @@ -657,7 +560,7 @@ module Google attr_accessor :alternate_player_id # Uniquely identifies the type of this resource. Value is always the fixed - # string games#applicationVerifyResponse. + # string `games#applicationVerifyResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -679,7 +582,7 @@ module Google end end - # This is a JSON template for data related to individual game categories. + # Data related to individual game categories. class Category include Google::Apis::Core::Hashable @@ -694,7 +597,7 @@ module Google attr_accessor :experience_points # Uniquely identifies the type of this resource. Value is always the fixed - # string games#category. + # string `games#category`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -711,7 +614,7 @@ module Google end end - # This is a JSON template for a list of category data objects. + # A third party list metagame categories response. class ListCategoryResponse include Google::Apis::Core::Hashable @@ -721,7 +624,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#categoryListResponse. + # string `games#categoryListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -743,33 +646,22 @@ module Google end end - # This is a JSON template for a batch update failure resource. + # A batch update failure resource. class EventBatchRecordFailure include Google::Apis::Core::Hashable # The cause for the update failure. - # Possible values are: - # - "TOO_LARGE": A batch request was issued with more events than are allowed in - # a single batch. - # - "TIME_PERIOD_EXPIRED": A batch was sent with data too far in the past to - # record. - # - "TIME_PERIOD_SHORT": A batch was sent with a time range that was too short. - # - "TIME_PERIOD_LONG": A batch was sent with a time range that was too long. - # - "ALREADY_UPDATED": An attempt was made to record a batch of data which was - # already seen. - # - "RECORD_RATE_HIGH": An attempt was made to record data faster than the - # server will apply updates. # Corresponds to the JSON property `failureCause` # @return [String] attr_accessor :failure_cause # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventBatchRecordFailure. + # string `games#eventBatchRecordFailure`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for an event period time range. + # An event period time range. # Corresponds to the JSON property `range` # @return [Google::Apis::GamesV1::EventPeriodRange] attr_accessor :range @@ -786,7 +678,7 @@ module Google end end - # This is a JSON template for an event child relationship resource. + # An event child relationship resource. class EventChild include Google::Apis::Core::Hashable @@ -796,7 +688,7 @@ module Google attr_accessor :child_id # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventChild. + # string `games#eventChild`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -812,7 +704,7 @@ module Google end end - # This is a JSON template for an event definition resource. + # An event definition resource. class EventDefinition include Google::Apis::Core::Hashable @@ -841,24 +733,20 @@ module Google # @return [String] attr_accessor :image_url - # Indicates whether the icon image being returned is a default image, or is game- - # provided. + # Indicates whether the icon image being returned is a default image, or is + # game-provided. # Corresponds to the JSON property `isDefaultImageUrl` # @return [Boolean] attr_accessor :is_default_image_url alias_method :is_default_image_url?, :is_default_image_url # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventDefinition. + # string `games#eventDefinition`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The visibility of event being tracked in this definition. - # Possible values are: - # - "REVEALED": This event should be visible to all users. - # - "HIDDEN": This event should only be shown to users that have recorded this - # event at least once. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -880,7 +768,7 @@ module Google end end - # This is a JSON template for a ListDefinitions response. + # A ListDefinitions response. class ListEventDefinitionResponse include Google::Apis::Core::Hashable @@ -890,7 +778,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventDefinitionListResponse. + # string `games#eventDefinitionListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -912,23 +800,24 @@ module Google end end - # This is a JSON template for an event period time range. + # An event period time range. class EventPeriodRange include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventPeriodRange. + # string `games#eventPeriodRange`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The time when this update period ends, in millis, since 1970 UTC (Unix Epoch). + # The time when this update period ends, in millis, since 1970 UTC (Unix + # Epoch). # Corresponds to the JSON property `periodEndMillis` # @return [Fixnum] attr_accessor :period_end_millis - # The time when this update period begins, in millis, since 1970 UTC (Unix Epoch) - # . + # The time when this update period begins, in millis, since 1970 UTC (Unix + # Epoch). # Corresponds to the JSON property `periodStartMillis` # @return [Fixnum] attr_accessor :period_start_millis @@ -945,17 +834,17 @@ module Google end end - # This is a JSON template for an event period update resource. + # An event period update resource. class EventPeriodUpdate include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventPeriodUpdate. + # string `games#eventPeriodUpdate`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for an event period time range. + # An event period time range. # Corresponds to the JSON property `timePeriod` # @return [Google::Apis::GamesV1::EventPeriodRange] attr_accessor :time_period @@ -977,7 +866,7 @@ module Google end end - # This is a JSON template for an event update failure resource. + # An event update failure resource. class EventRecordFailure include Google::Apis::Core::Hashable @@ -987,16 +876,12 @@ module Google attr_accessor :event_id # The cause for the update failure. - # Possible values are: - # - "NOT_FOUND" - An attempt was made to set an event that was not defined. - # - "INVALID_UPDATE_VALUE" - An attempt was made to increment an event by a non- - # positive value. # Corresponds to the JSON property `failureCause` # @return [String] attr_accessor :failure_cause # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventRecordFailure. + # string `games#eventRecordFailure`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1013,18 +898,18 @@ module Google end end - # This is a JSON template for an event period update resource. + # An event period update resource. class EventRecordRequest include Google::Apis::Core::Hashable - # The current time when this update was sent, in milliseconds, since 1970 UTC ( - # Unix Epoch). + # The current time when this update was sent, in milliseconds, since 1970 UTC + # (Unix Epoch). # Corresponds to the JSON property `currentTimeMillis` # @return [Fixnum] attr_accessor :current_time_millis # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventRecordRequest. + # string `games#eventRecordRequest`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1052,7 +937,7 @@ module Google end end - # This is a JSON template for an event period update resource. + # An event period update resource. class UpdateEventRequest include Google::Apis::Core::Hashable @@ -1062,7 +947,7 @@ module Google attr_accessor :definition_id # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventUpdateRequest. + # string `games#eventUpdateRequest`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1084,7 +969,7 @@ module Google end end - # This is a JSON template for an event period update resource. + # An event period update resource. class UpdateEventResponse include Google::Apis::Core::Hashable @@ -1099,7 +984,7 @@ module Google attr_accessor :event_failures # Uniquely identifies the type of this resource. Value is always the fixed - # string games#eventUpdateResponse. + # string `games#eventUpdateResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1122,12 +1007,13 @@ module Google end end - # This is a JSON template for the payload to request to increment an achievement. + # The payload to request to increment an + # achievement. class GamesAchievementIncrement include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#GamesAchievementIncrement. + # string `games#GamesAchievementIncrement`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1154,12 +1040,13 @@ module Google end end - # This is a JSON template for the payload to request to increment an achievement. + # The payload to request to increment an + # achievement. class GamesAchievementSetStepsAtLeast include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#GamesAchievementSetStepsAtLeast. + # string `games#GamesAchievementSetStepsAtLeast`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1180,7 +1067,7 @@ module Google end end - # This is a JSON template for an image asset object. + # An image asset object. class ImageAsset include Google::Apis::Core::Hashable @@ -1190,7 +1077,7 @@ module Google attr_accessor :height # Uniquely identifies the type of this resource. Value is always the fixed - # string games#imageAsset. + # string `games#imageAsset`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1224,7 +1111,7 @@ module Google end end - # This is a JSON template for the Instance resource. + # The Instance resource. class Instance include Google::Apis::Core::Hashable @@ -1233,18 +1120,18 @@ module Google # @return [String] attr_accessor :acquisition_uri - # This is a JSON template for the Android instance details resource. + # The Android instance details resource. # Corresponds to the JSON property `androidInstance` # @return [Google::Apis::GamesV1::InstanceAndroidDetails] attr_accessor :android_instance - # This is a JSON template for the iOS details resource. + # The iOS details resource. # Corresponds to the JSON property `iosInstance` # @return [Google::Apis::GamesV1::InstanceIosDetails] attr_accessor :ios_instance # Uniquely identifies the type of this resource. Value is always the fixed - # string games#instance. + # string `games#instance`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1255,10 +1142,6 @@ module Google attr_accessor :name # The platform type. - # Possible values are: - # - "ANDROID" - Instance is for Android. - # - "IOS" - Instance is for iOS - # - "WEB_APP" - Instance is for Web App. # Corresponds to the JSON property `platformType` # @return [String] attr_accessor :platform_type @@ -1275,7 +1158,7 @@ module Google attr_accessor :turn_based_play alias_method :turn_based_play?, :turn_based_play - # This is a JSON template for the Web details resource. + # The Web details resource. # Corresponds to the JSON property `webInstance` # @return [Google::Apis::GamesV1::InstanceWebDetails] attr_accessor :web_instance @@ -1298,7 +1181,7 @@ module Google end end - # This is a JSON template for the Android instance details resource. + # The Android instance details resource. class InstanceAndroidDetails include Google::Apis::Core::Hashable @@ -1309,7 +1192,7 @@ module Google alias_method :enable_piracy_check?, :enable_piracy_check # Uniquely identifies the type of this resource. Value is always the fixed - # string games#instanceAndroidDetails. + # string `games#instanceAndroidDetails`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1338,7 +1221,7 @@ module Google end end - # This is a JSON template for the iOS details resource. + # The iOS details resource. class InstanceIosDetails include Google::Apis::Core::Hashable @@ -1353,7 +1236,7 @@ module Google attr_accessor :itunes_app_id # Uniquely identifies the type of this resource. Value is always the fixed - # string games#instanceIosDetails. + # string `games#instanceIosDetails`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1400,12 +1283,12 @@ module Google end end - # This is a JSON template for the Web details resource. + # The Web details resource. class InstanceWebDetails include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#instanceWebDetails. + # string `games#instanceWebDetails`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1433,7 +1316,7 @@ module Google end end - # This is a JSON template for the Leaderboard resource. + # The Leaderboard resource. class Leaderboard include Google::Apis::Core::Hashable @@ -1447,15 +1330,15 @@ module Google # @return [String] attr_accessor :id - # Indicates whether the icon image being returned is a default image, or is game- - # provided. + # Indicates whether the icon image being returned is a default image, or is + # game-provided. # Corresponds to the JSON property `isIconUrlDefault` # @return [Boolean] attr_accessor :is_icon_url_default alias_method :is_icon_url_default?, :is_icon_url_default # Uniquely identifies the type of this resource. Value is always the fixed - # string games#leaderboard. + # string `games#leaderboard`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1466,11 +1349,6 @@ module Google attr_accessor :name # How scores are ordered. - # Possible values are: - # - "LARGER_IS_BETTER" - Larger values are better; scores are sorted in - # descending order. - # - "SMALLER_IS_BETTER" - Smaller values are better; scores are sorted in - # ascending order. # Corresponds to the JSON property `order` # @return [String] attr_accessor :order @@ -1490,7 +1368,7 @@ module Google end end - # This is a JSON template for the Leaderboard Entry resource. + # The Leaderboard Entry resource. class LeaderboardEntry include Google::Apis::Core::Hashable @@ -1505,12 +1383,12 @@ module Google attr_accessor :formatted_score_rank # Uniquely identifies the type of this resource. Value is always the fixed - # string games#leaderboardEntry. + # string `games#leaderboardEntry`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for a Player resource. + # A Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesV1::Player] attr_accessor :player @@ -1520,8 +1398,8 @@ module Google # @return [Fixnum] attr_accessor :score_rank - # Additional information about the score. Values must contain no more than 64 - # URI-safe characters as defined by section 2.3 of RFC 3986. + # Additional information about the score. Values must contain no more than + # 64 URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag @@ -1532,10 +1410,6 @@ module Google attr_accessor :score_value # The time span of this high score. - # Possible values are: - # - "ALL_TIME" - The score is an all-time high score. - # - "WEEKLY" - The score is a weekly high score. - # - "DAILY" - The score is a daily high score. # Corresponds to the JSON property `timeSpan` # @return [String] attr_accessor :time_span @@ -1564,7 +1438,7 @@ module Google end end - # This is a JSON template for a list of leaderboard objects. + # A list of leaderboard objects. class ListLeaderboardResponse include Google::Apis::Core::Hashable @@ -1574,7 +1448,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#leaderboardListResponse. + # string `games#leaderboardListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1596,7 +1470,7 @@ module Google end end - # This is a JSON template for a score rank in a leaderboard. + # A score rank in a leaderboard. class LeaderboardScoreRank include Google::Apis::Core::Hashable @@ -1611,7 +1485,7 @@ module Google attr_accessor :formatted_rank # Uniquely identifies the type of this resource. Value is always the fixed - # string games#leaderboardScoreRank. + # string `games#leaderboardScoreRank`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1640,7 +1514,7 @@ module Google end end - # This is a JSON template for a ListScores response. + # A ListScores response. class LeaderboardScores include Google::Apis::Core::Hashable @@ -1650,7 +1524,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#leaderboardScores. + # string `games#leaderboardScores`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1665,7 +1539,7 @@ module Google # @return [Fixnum] attr_accessor :num_scores - # This is a JSON template for the Leaderboard Entry resource. + # The Leaderboard Entry resource. # Corresponds to the JSON property `playerScore` # @return [Google::Apis::GamesV1::LeaderboardEntry] attr_accessor :player_score @@ -1690,18 +1564,18 @@ module Google end end - # This is a JSON template for the metagame config resource + # The metagame config resource class MetagameConfig include Google::Apis::Core::Hashable - # Current version of the metagame configuration data. When this data is updated, - # the version number will be increased by one. + # Current version of the metagame configuration data. When this data is + # updated, the version number will be increased by one. # Corresponds to the JSON property `currentVersion` # @return [Fixnum] attr_accessor :current_version # Uniquely identifies the type of this resource. Value is always the fixed - # string games#metagameConfig. + # string `games#metagameConfig`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1723,262 +1597,7 @@ module Google end end - # This is a JSON template for network diagnostics reported for a client. - class NetworkDiagnostics - include Google::Apis::Core::Hashable - - # The Android network subtype. - # Corresponds to the JSON property `androidNetworkSubtype` - # @return [Fixnum] - attr_accessor :android_network_subtype - - # The Android network type. - # Corresponds to the JSON property `androidNetworkType` - # @return [Fixnum] - attr_accessor :android_network_type - - # iOS network type as defined in Reachability.h. - # Corresponds to the JSON property `iosNetworkType` - # @return [Fixnum] - attr_accessor :ios_network_type - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#networkDiagnostics. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The MCC+MNC code for the client's network connection. On Android: http:// - # developer.android.com/reference/android/telephony/TelephonyManager.html# - # getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/ - # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html - # Corresponds to the JSON property `networkOperatorCode` - # @return [String] - attr_accessor :network_operator_code - - # The name of the carrier of the client's network connection. On Android: http:// - # developer.android.com/reference/android/telephony/TelephonyManager.html# - # getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/ - # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#/ - # /apple_ref/occ/instp/CTCarrier/carrierName - # Corresponds to the JSON property `networkOperatorName` - # @return [String] - attr_accessor :network_operator_name - - # The amount of time in milliseconds it took for the client to establish a - # connection with the XMPP server. - # Corresponds to the JSON property `registrationLatencyMillis` - # @return [Fixnum] - attr_accessor :registration_latency_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @android_network_subtype = args[:android_network_subtype] if args.key?(:android_network_subtype) - @android_network_type = args[:android_network_type] if args.key?(:android_network_type) - @ios_network_type = args[:ios_network_type] if args.key?(:ios_network_type) - @kind = args[:kind] if args.key?(:kind) - @network_operator_code = args[:network_operator_code] if args.key?(:network_operator_code) - @network_operator_name = args[:network_operator_name] if args.key?(:network_operator_name) - @registration_latency_millis = args[:registration_latency_millis] if args.key?(:registration_latency_millis) - end - end - - # This is a JSON template for a result for a match participant. - class ParticipantResult - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#participantResult. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The ID of the participant. - # Corresponds to the JSON property `participantId` - # @return [String] - attr_accessor :participant_id - - # The placement or ranking of the participant in the match results; a number - # from one to the number of participants in the match. Multiple participants may - # have the same placing value in case of a type. - # Corresponds to the JSON property `placing` - # @return [Fixnum] - attr_accessor :placing - - # The result of the participant for this match. - # Possible values are: - # - "MATCH_RESULT_WIN" - The participant won the match. - # - "MATCH_RESULT_LOSS" - The participant lost the match. - # - "MATCH_RESULT_TIE" - The participant tied the match. - # - "MATCH_RESULT_NONE" - There was no winner for the match (nobody wins or - # loses this kind of game.) - # - "MATCH_RESULT_DISCONNECT" - The participant disconnected / left during the - # match. - # - "MATCH_RESULT_DISAGREED" - Different clients reported different results for - # this participant. - # Corresponds to the JSON property `result` - # @return [String] - attr_accessor :result - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @participant_id = args[:participant_id] if args.key?(:participant_id) - @placing = args[:placing] if args.key?(:placing) - @result = args[:result] if args.key?(:result) - end - end - - # This is a JSON template for peer channel diagnostics. - class PeerChannelDiagnostics - include Google::Apis::Core::Hashable - - # This is a JSON template for aggregate stats. - # Corresponds to the JSON property `bytesReceived` - # @return [Google::Apis::GamesV1::AggregateStats] - attr_accessor :bytes_received - - # This is a JSON template for aggregate stats. - # Corresponds to the JSON property `bytesSent` - # @return [Google::Apis::GamesV1::AggregateStats] - attr_accessor :bytes_sent - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#peerChannelDiagnostics. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Number of messages lost. - # Corresponds to the JSON property `numMessagesLost` - # @return [Fixnum] - attr_accessor :num_messages_lost - - # Number of messages received. - # Corresponds to the JSON property `numMessagesReceived` - # @return [Fixnum] - attr_accessor :num_messages_received - - # Number of messages sent. - # Corresponds to the JSON property `numMessagesSent` - # @return [Fixnum] - attr_accessor :num_messages_sent - - # Number of send failures. - # Corresponds to the JSON property `numSendFailures` - # @return [Fixnum] - attr_accessor :num_send_failures - - # This is a JSON template for aggregate stats. - # Corresponds to the JSON property `roundtripLatencyMillis` - # @return [Google::Apis::GamesV1::AggregateStats] - attr_accessor :roundtrip_latency_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @bytes_received = args[:bytes_received] if args.key?(:bytes_received) - @bytes_sent = args[:bytes_sent] if args.key?(:bytes_sent) - @kind = args[:kind] if args.key?(:kind) - @num_messages_lost = args[:num_messages_lost] if args.key?(:num_messages_lost) - @num_messages_received = args[:num_messages_received] if args.key?(:num_messages_received) - @num_messages_sent = args[:num_messages_sent] if args.key?(:num_messages_sent) - @num_send_failures = args[:num_send_failures] if args.key?(:num_send_failures) - @roundtrip_latency_millis = args[:roundtrip_latency_millis] if args.key?(:roundtrip_latency_millis) - end - end - - # This is a JSON template for peer session diagnostics. - class PeerSessionDiagnostics - include Google::Apis::Core::Hashable - - # Connected time in milliseconds. - # Corresponds to the JSON property `connectedTimestampMillis` - # @return [Fixnum] - attr_accessor :connected_timestamp_millis - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#peerSessionDiagnostics. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The participant ID of the peer. - # Corresponds to the JSON property `participantId` - # @return [String] - attr_accessor :participant_id - - # This is a JSON template for peer channel diagnostics. - # Corresponds to the JSON property `reliableChannel` - # @return [Google::Apis::GamesV1::PeerChannelDiagnostics] - attr_accessor :reliable_channel - - # This is a JSON template for peer channel diagnostics. - # Corresponds to the JSON property `unreliableChannel` - # @return [Google::Apis::GamesV1::PeerChannelDiagnostics] - attr_accessor :unreliable_channel - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @connected_timestamp_millis = args[:connected_timestamp_millis] if args.key?(:connected_timestamp_millis) - @kind = args[:kind] if args.key?(:kind) - @participant_id = args[:participant_id] if args.key?(:participant_id) - @reliable_channel = args[:reliable_channel] if args.key?(:reliable_channel) - @unreliable_channel = args[:unreliable_channel] if args.key?(:unreliable_channel) - end - end - - # This is a JSON template for metadata about a player playing a game with the - # currently authenticated user. - class Played - include Google::Apis::Core::Hashable - - # True if the player was auto-matched with the currently authenticated user. - # Corresponds to the JSON property `autoMatched` - # @return [Boolean] - attr_accessor :auto_matched - alias_method :auto_matched?, :auto_matched - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#played. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The last time the player played the game in milliseconds since the epoch in - # UTC. - # Corresponds to the JSON property `timeMillis` - # @return [Fixnum] - attr_accessor :time_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_matched = args[:auto_matched] if args.key?(:auto_matched) - @kind = args[:kind] if args.key?(:kind) - @time_millis = args[:time_millis] if args.key?(:time_millis) - end - end - - # This is a JSON template for a Player resource. + # A Player resource. class Player include Google::Apis::Core::Hashable @@ -2002,7 +1621,7 @@ module Google # @return [String] attr_accessor :display_name - # This is a JSON template for 1P/3P metadata about the player's experience. + # 1P/3P metadata about the player's experience. # Corresponds to the JSON property `experienceInfo` # @return [Google::Apis::GamesV1::PlayerExperienceInfo] attr_accessor :experience_info @@ -2014,27 +1633,20 @@ module Google attr_accessor :friend_status # Uniquely identifies the type of this resource. Value is always the fixed - # string games#player. + # string `games#player` # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # This is a JSON template for metadata about a player playing a game with the - # currently authenticated user. - # Corresponds to the JSON property `lastPlayedWith` - # @return [Google::Apis::GamesV1::Played] - attr_accessor :last_played_with - - # An object representation of the individual components of the player's name. - # For some players, these fields may not be present. + # A representation of the individual components of the name. # Corresponds to the JSON property `name` # @return [Google::Apis::GamesV1::Player::Name] attr_accessor :name # The player ID that was used for this player the first time they signed into - # the game in question. This is only populated for calls to player.get for the - # requesting player, only if the player ID has subsequently changed, and only to - # clients that support remapping player IDs. + # the game in question. This is only populated for calls to player.get for + # the requesting player, only if the player ID has subsequently changed, and + # only to clients that support remapping player IDs. # Corresponds to the JSON property `originalPlayerId` # @return [String] attr_accessor :original_player_id @@ -2044,7 +1656,7 @@ module Google # @return [String] attr_accessor :player_id - # This is a JSON template for profile settings + # Profile settings # Corresponds to the JSON property `profileSettings` # @return [Google::Apis::GamesV1::ProfileSettings] attr_accessor :profile_settings @@ -2067,7 +1679,6 @@ module Google @experience_info = args[:experience_info] if args.key?(:experience_info) @friend_status = args[:friend_status] if args.key?(:friend_status) @kind = args[:kind] if args.key?(:kind) - @last_played_with = args[:last_played_with] if args.key?(:last_played_with) @name = args[:name] if args.key?(:name) @original_player_id = args[:original_player_id] if args.key?(:original_player_id) @player_id = args[:player_id] if args.key?(:player_id) @@ -2075,17 +1686,18 @@ module Google @title = args[:title] if args.key?(:title) end - # An object representation of the individual components of the player's name. - # For some players, these fields may not be present. + # A representation of the individual components of the name. class Name include Google::Apis::Core::Hashable - # The family name of this player. In some places, this is known as the last name. + # The family name of this player. In some places, this is known as the last + # name. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name - # The given name of this player. In some places, this is known as the first name. + # The given name of this player. In some places, this is known as the first + # name. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name @@ -2102,15 +1714,11 @@ module Google end end - # This is a JSON template for an achievement object. + # An achievement object. class PlayerAchievement include Google::Apis::Core::Hashable # The state of the achievement. - # Possible values are: - # - "HIDDEN" - Achievement is hidden. - # - "REVEALED" - Achievement is revealed. - # - "UNLOCKED" - Achievement is unlocked. # Corresponds to the JSON property `achievementState` # @return [String] attr_accessor :achievement_state @@ -2121,8 +1729,8 @@ module Google attr_accessor :current_steps # Experience points earned for the achievement. This field is absent for - # achievements that have not yet been unlocked and 0 for achievements that have - # been unlocked by testers but that are unpublished. + # achievements that have not yet been unlocked and 0 for achievements that + # have been unlocked by testers but that are unpublished. # Corresponds to the JSON property `experiencePoints` # @return [Fixnum] attr_accessor :experience_points @@ -2138,7 +1746,7 @@ module Google attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerAchievement. + # string `games#playerAchievement`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2164,7 +1772,7 @@ module Google end end - # This is a JSON template for a list of achievement objects. + # A list of achievement objects. class ListPlayerAchievementResponse include Google::Apis::Core::Hashable @@ -2174,7 +1782,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerAchievementListResponse. + # string `games#playerAchievementListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2196,7 +1804,7 @@ module Google end end - # This is a JSON template for an event status resource. + # An event status resource. class PlayerEvent include Google::Apis::Core::Hashable @@ -2213,7 +1821,7 @@ module Google attr_accessor :formatted_num_events # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerEvent. + # string `games#playerEvent`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2242,7 +1850,7 @@ module Google end end - # This is a JSON template for a ListByPlayer response. + # A ListByPlayer response. class ListPlayerEventResponse include Google::Apis::Core::Hashable @@ -2252,7 +1860,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerEventListResponse. + # string `games#playerEventListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2274,7 +1882,7 @@ module Google end end - # This is a JSON template for 1P/3P metadata about the player's experience. + # 1P/3P metadata about the player's experience. class PlayerExperienceInfo include Google::Apis::Core::Hashable @@ -2283,23 +1891,24 @@ module Google # @return [Fixnum] attr_accessor :current_experience_points - # This is a JSON template for 1P/3P metadata about a user's level. + # 1P/3P metadata about a user's level. # Corresponds to the JSON property `currentLevel` # @return [Google::Apis::GamesV1::PlayerLevel] attr_accessor :current_level # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerExperienceInfo. + # string `games#playerExperienceInfo`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The timestamp when the player was leveled up, in millis since Unix epoch UTC. + # The timestamp when the player was leveled up, in millis since Unix epoch + # UTC. # Corresponds to the JSON property `lastLevelUpTimestampMillis` # @return [Fixnum] attr_accessor :last_level_up_timestamp_millis - # This is a JSON template for 1P/3P metadata about a user's level. + # 1P/3P metadata about a user's level. # Corresponds to the JSON property `nextLevel` # @return [Google::Apis::GamesV1::PlayerLevel] attr_accessor :next_level @@ -2318,12 +1927,12 @@ module Google end end - # This is a JSON template for a player leaderboard score object. + # A player leaderboard score object. class PlayerLeaderboardScore include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerLeaderboardScore. + # string `games#playerLeaderboardScore`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2333,7 +1942,7 @@ module Google # @return [String] attr_accessor :leaderboard_id - # This is a JSON template for a score rank in a leaderboard. + # A score rank in a leaderboard. # Corresponds to the JSON property `publicRank` # @return [Google::Apis::GamesV1::LeaderboardScoreRank] attr_accessor :public_rank @@ -2343,8 +1952,8 @@ module Google # @return [String] attr_accessor :score_string - # Additional information about the score. Values must contain no more than 64 - # URI-safe characters as defined by section 2.3 of RFC 3986. + # Additional information about the score. Values must contain no more than + # 64 URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag @@ -2354,16 +1963,12 @@ module Google # @return [Fixnum] attr_accessor :score_value - # This is a JSON template for a score rank in a leaderboard. + # A score rank in a leaderboard. # Corresponds to the JSON property `socialRank` # @return [Google::Apis::GamesV1::LeaderboardScoreRank] attr_accessor :social_rank # The time span of this score. - # Possible values are: - # - "ALL_TIME" - The score is an all-time score. - # - "WEEKLY" - The score is a weekly score. - # - "DAILY" - The score is a daily score. # Corresponds to the JSON property `timeSpan` # @return [String] attr_accessor :time_span @@ -2392,7 +1997,7 @@ module Google end end - # This is a JSON template for a list of player leaderboard scores. + # A list of player leaderboard scores. class ListPlayerLeaderboardScoreResponse include Google::Apis::Core::Hashable @@ -2402,7 +2007,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerLeaderboardScoreListResponse. + # string `games#playerLeaderboardScoreListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2412,7 +2017,7 @@ module Google # @return [String] attr_accessor :next_page_token - # This is a JSON template for a Player resource. + # A Player resource. # Corresponds to the JSON property `player` # @return [Google::Apis::GamesV1::Player] attr_accessor :player @@ -2430,12 +2035,12 @@ module Google end end - # This is a JSON template for 1P/3P metadata about a user's level. + # 1P/3P metadata about a user's level. class PlayerLevel include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerLevel. + # string `games#playerLevel`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2468,7 +2073,7 @@ module Google end end - # This is a JSON template for a third party player list response. + # A third party player list response. class ListPlayerResponse include Google::Apis::Core::Hashable @@ -2478,7 +2083,7 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerListResponse. + # string `games#playerListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2500,7 +2105,7 @@ module Google end end - # This is a JSON template for a player score. + # A player score. class PlayerScore include Google::Apis::Core::Hashable @@ -2510,7 +2115,7 @@ module Google attr_accessor :formatted_score # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerScore. + # string `games#playerScore`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2520,17 +2125,13 @@ module Google # @return [Fixnum] attr_accessor :score - # Additional information about this score. Values will contain no more than 64 - # URI-safe characters as defined by section 2.3 of RFC 3986. + # Additional information about this score. Values will contain no more than + # 64 URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag # The time span for this player score. - # Possible values are: - # - "ALL_TIME" - The score is an all-time score. - # - "WEEKLY" - The score is a weekly score. - # - "DAILY" - The score is a daily score. # Corresponds to the JSON property `timeSpan` # @return [String] attr_accessor :time_span @@ -2549,12 +2150,12 @@ module Google end end - # This is a JSON template for a list of score submission statuses. + # A list of score submission statuses. class ListPlayerScoreResponse include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerScoreListResponse. + # string `games#playerScoreListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2575,16 +2176,12 @@ module Google end end - # This is a JSON template for a list of leaderboard entry resources. + # A list of leaderboard entry resources. class PlayerScoreResponse include Google::Apis::Core::Hashable - # The time spans where the submitted score is better than the existing score for - # that time span. - # Possible values are: - # - "ALL_TIME" - The score is an all-time score. - # - "WEEKLY" - The score is a weekly score. - # - "DAILY" - The score is a daily score. + # The time spans where the submitted score is better than the existing score + # for that time span. # Corresponds to the JSON property `beatenScoreTimeSpans` # @return [Array] attr_accessor :beaten_score_time_spans @@ -2595,7 +2192,7 @@ module Google attr_accessor :formatted_score # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerScoreResponse. + # string `games#playerScoreResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2605,15 +2202,16 @@ module Google # @return [String] attr_accessor :leaderboard_id - # Additional information about this score. Values will contain no more than 64 - # URI-safe characters as defined by section 2.3 of RFC 3986. + # Additional information about this score. Values will contain no more than + # 64 URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag - # The scores in time spans that have not been beaten. As an example, the - # submitted score may be better than the player's DAILY score, but not better - # than the player's scores for the WEEKLY or ALL_TIME time spans. + # The scores in time spans that have not been beaten. As an example, the + # submitted score may be better than the + # player's `DAILY` score, but not better than the player's scores + # for the `WEEKLY` or `ALL_TIME` time spans. # Corresponds to the JSON property `unbeatenScores` # @return [Array] attr_accessor :unbeaten_scores @@ -2633,12 +2231,12 @@ module Google end end - # This is a JSON template for a list of score submission requests + # A list of score submission requests. class PlayerScoreSubmissionList include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#playerScoreSubmissionList. + # string `games#playerScoreSubmissionList`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2659,22 +2257,22 @@ module Google end end - # This is a JSON template for profile settings + # Profile settings class ProfileSettings include Google::Apis::Core::Hashable - # Whether the player's friends list is visible to the game. + # # Corresponds to the JSON property `friendsListVisibility` # @return [String] attr_accessor :friends_list_visibility # Uniquely identifies the type of this resource. Value is always the fixed - # string games#profileSettings. + # string `games#profileSettings`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # + # Whether the player's profile is visible to the currently signed in player. # Corresponds to the JSON property `profileVisible` # @return [Boolean] attr_accessor :profile_visible @@ -2692,103 +2290,7 @@ module Google end end - # This is a JSON template for a push token resource. - class PushToken - include Google::Apis::Core::Hashable - - # The revision of the client SDK used by your application, in the same format - # that's used by revisions.check. Used to send backward compatible messages. - # Format: [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - # - # - IOS - Push token is for iOS - # Corresponds to the JSON property `clientRevision` - # @return [String] - attr_accessor :client_revision - - # This is a JSON template for a push token ID resource. - # Corresponds to the JSON property `id` - # @return [Google::Apis::GamesV1::PushTokenId] - attr_accessor :id - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#pushToken. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The preferred language for notifications that are sent using this token. - # Corresponds to the JSON property `language` - # @return [String] - attr_accessor :language - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @client_revision = args[:client_revision] if args.key?(:client_revision) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @language = args[:language] if args.key?(:language) - end - end - - # This is a JSON template for a push token ID resource. - class PushTokenId - include Google::Apis::Core::Hashable - - # A push token ID for iOS devices. - # Corresponds to the JSON property `ios` - # @return [Google::Apis::GamesV1::PushTokenId::Ios] - attr_accessor :ios - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#pushTokenId. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @ios = args[:ios] if args.key?(:ios) - @kind = args[:kind] if args.key?(:kind) - end - - # A push token ID for iOS devices. - class Ios - include Google::Apis::Core::Hashable - - # Device token supplied by an iOS system call to register for remote - # notifications. Encode this field as web-safe base64. - # Corresponds to the JSON property `apns_device_token` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :apns_device_token - - # Indicates whether this token should be used for the production or sandbox APNS - # server. - # Corresponds to the JSON property `apns_environment` - # @return [String] - attr_accessor :apns_environment - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apns_device_token = args[:apns_device_token] if args.key?(:apns_device_token) - @apns_environment = args[:apns_environment] if args.key?(:apns_environment) - end - end - end - - # This is a JSON template for the result of checking a revision. + # A third party checking a revision response. class CheckRevisionResponse include Google::Apis::Core::Hashable @@ -2799,17 +2301,12 @@ module Google attr_accessor :api_version # Uniquely identifies the type of this resource. Value is always the fixed - # string games#revisionCheckResponse. + # string `games#revisionCheckResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The result of the revision check. - # Possible values are: - # - "OK" - The revision being used is current. - # - "DEPRECATED" - There is currently a newer version available, but the - # revision being used still works. - # - "INVALID" - The revision being used is not supported in any released version. # Corresponds to the JSON property `revisionStatus` # @return [String] attr_accessor :revision_status @@ -2826,760 +2323,12 @@ module Google end end - # This is a JSON template for a room resource object. - class Room - include Google::Apis::Core::Hashable - - # The ID of the application being played. - # Corresponds to the JSON property `applicationId` - # @return [String] - attr_accessor :application_id - - # This is a JSON template for a room auto-match criteria object. - # Corresponds to the JSON property `autoMatchingCriteria` - # @return [Google::Apis::GamesV1::RoomAutoMatchingCriteria] - attr_accessor :auto_matching_criteria - - # This is a JSON template for status of room automatching that is in progress. - # Corresponds to the JSON property `autoMatchingStatus` - # @return [Google::Apis::GamesV1::RoomAutoMatchStatus] - attr_accessor :auto_matching_status - - # This is a JSON template for room modification metadata. - # Corresponds to the JSON property `creationDetails` - # @return [Google::Apis::GamesV1::RoomModification] - attr_accessor :creation_details - - # This short description is generated by our servers and worded relative to the - # player requesting the room. It is intended to be displayed when the room is - # shown in a list (that is, an invitation to a room.) - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The ID of the participant that invited the user to the room. Not set if the - # user was not invited to the room. - # Corresponds to the JSON property `inviterId` - # @return [String] - attr_accessor :inviter_id - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#room. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # This is a JSON template for room modification metadata. - # Corresponds to the JSON property `lastUpdateDetails` - # @return [Google::Apis::GamesV1::RoomModification] - attr_accessor :last_update_details - - # The participants involved in the room, along with their statuses. Includes - # participants who have left or declined invitations. - # Corresponds to the JSON property `participants` - # @return [Array] - attr_accessor :participants - - # Globally unique ID for a room. - # Corresponds to the JSON property `roomId` - # @return [String] - attr_accessor :room_id - - # The version of the room status: an increasing counter, used by the client to - # ignore out-of-order updates to room status. - # Corresponds to the JSON property `roomStatusVersion` - # @return [Fixnum] - attr_accessor :room_status_version - - # The status of the room. - # Possible values are: - # - "ROOM_INVITING" - One or more players have been invited and not responded. - # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - # - "ROOM_CONNECTING" - Players have joined and are connecting to each other ( - # either before or after auto-matching). - # - "ROOM_ACTIVE" - All players have joined and connected to each other. - # - "ROOM_DELETED" - The room should no longer be shown on the client. Returned - # in sync calls when a player joins a room (as a tombstone), or for rooms where - # all joined participants have left. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # The variant / mode of the application being played; can be any integer value, - # or left blank. - # Corresponds to the JSON property `variant` - # @return [Fixnum] - attr_accessor :variant - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @application_id = args[:application_id] if args.key?(:application_id) - @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) - @auto_matching_status = args[:auto_matching_status] if args.key?(:auto_matching_status) - @creation_details = args[:creation_details] if args.key?(:creation_details) - @description = args[:description] if args.key?(:description) - @inviter_id = args[:inviter_id] if args.key?(:inviter_id) - @kind = args[:kind] if args.key?(:kind) - @last_update_details = args[:last_update_details] if args.key?(:last_update_details) - @participants = args[:participants] if args.key?(:participants) - @room_id = args[:room_id] if args.key?(:room_id) - @room_status_version = args[:room_status_version] if args.key?(:room_status_version) - @status = args[:status] if args.key?(:status) - @variant = args[:variant] if args.key?(:variant) - end - end - - # This is a JSON template for status of room automatching that is in progress. - class RoomAutoMatchStatus - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomAutoMatchStatus. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # An estimate for the amount of time (in seconds) that auto-matching is expected - # to take to complete. - # Corresponds to the JSON property `waitEstimateSeconds` - # @return [Fixnum] - attr_accessor :wait_estimate_seconds - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @wait_estimate_seconds = args[:wait_estimate_seconds] if args.key?(:wait_estimate_seconds) - end - end - - # This is a JSON template for a room auto-match criteria object. - class RoomAutoMatchingCriteria - include Google::Apis::Core::Hashable - - # A bitmask indicating when auto-matches are valid. When ANDed with other - # exclusive bitmasks, the result must be zero. Can be used to support exclusive - # roles within a game. - # Corresponds to the JSON property `exclusiveBitmask` - # @return [Fixnum] - attr_accessor :exclusive_bitmask - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomAutoMatchingCriteria. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The maximum number of players that should be added to the room by auto- - # matching. - # Corresponds to the JSON property `maxAutoMatchingPlayers` - # @return [Fixnum] - attr_accessor :max_auto_matching_players - - # The minimum number of players that should be added to the room by auto- - # matching. - # Corresponds to the JSON property `minAutoMatchingPlayers` - # @return [Fixnum] - attr_accessor :min_auto_matching_players - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @exclusive_bitmask = args[:exclusive_bitmask] if args.key?(:exclusive_bitmask) - @kind = args[:kind] if args.key?(:kind) - @max_auto_matching_players = args[:max_auto_matching_players] if args.key?(:max_auto_matching_players) - @min_auto_matching_players = args[:min_auto_matching_players] if args.key?(:min_auto_matching_players) - end - end - - # This is a JSON template for the client address when setting up a room. - class RoomClientAddress - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomClientAddress. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The XMPP address of the client on the Google Games XMPP network. - # Corresponds to the JSON property `xmppAddress` - # @return [String] - attr_accessor :xmpp_address - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @xmpp_address = args[:xmpp_address] if args.key?(:xmpp_address) - end - end - - # This is a JSON template for a room creation request. - class CreateRoomRequest - include Google::Apis::Core::Hashable - - # This is a JSON template for a room auto-match criteria object. - # Corresponds to the JSON property `autoMatchingCriteria` - # @return [Google::Apis::GamesV1::RoomAutoMatchingCriteria] - attr_accessor :auto_matching_criteria - - # The capabilities that this client supports for realtime communication. - # Corresponds to the JSON property `capabilities` - # @return [Array] - attr_accessor :capabilities - - # This is a JSON template for the client address when setting up a room. - # Corresponds to the JSON property `clientAddress` - # @return [Google::Apis::GamesV1::RoomClientAddress] - attr_accessor :client_address - - # The player IDs to invite to the room. - # Corresponds to the JSON property `invitedPlayerIds` - # @return [Array] - attr_accessor :invited_player_ids - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomCreateRequest. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # This is a JSON template for network diagnostics reported for a client. - # Corresponds to the JSON property `networkDiagnostics` - # @return [Google::Apis::GamesV1::NetworkDiagnostics] - attr_accessor :network_diagnostics - - # A randomly generated numeric ID. This number is used at the server to ensure - # that the request is handled correctly across retries. - # Corresponds to the JSON property `requestId` - # @return [Fixnum] - attr_accessor :request_id - - # The variant / mode of the application to be played. This can be any integer - # value, or left blank. You should use a small number of variants to keep the - # auto-matching pool as large as possible. - # Corresponds to the JSON property `variant` - # @return [Fixnum] - attr_accessor :variant - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) - @capabilities = args[:capabilities] if args.key?(:capabilities) - @client_address = args[:client_address] if args.key?(:client_address) - @invited_player_ids = args[:invited_player_ids] if args.key?(:invited_player_ids) - @kind = args[:kind] if args.key?(:kind) - @network_diagnostics = args[:network_diagnostics] if args.key?(:network_diagnostics) - @request_id = args[:request_id] if args.key?(:request_id) - @variant = args[:variant] if args.key?(:variant) - end - end - - # This is a JSON template for a join room request. - class JoinRoomRequest - include Google::Apis::Core::Hashable - - # The capabilities that this client supports for realtime communication. - # Corresponds to the JSON property `capabilities` - # @return [Array] - attr_accessor :capabilities - - # This is a JSON template for the client address when setting up a room. - # Corresponds to the JSON property `clientAddress` - # @return [Google::Apis::GamesV1::RoomClientAddress] - attr_accessor :client_address - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomJoinRequest. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # This is a JSON template for network diagnostics reported for a client. - # Corresponds to the JSON property `networkDiagnostics` - # @return [Google::Apis::GamesV1::NetworkDiagnostics] - attr_accessor :network_diagnostics - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @capabilities = args[:capabilities] if args.key?(:capabilities) - @client_address = args[:client_address] if args.key?(:client_address) - @kind = args[:kind] if args.key?(:kind) - @network_diagnostics = args[:network_diagnostics] if args.key?(:network_diagnostics) - end - end - - # This is a JSON template for room leave diagnostics. - class RoomLeaveDiagnostics - include Google::Apis::Core::Hashable - - # Android network subtype. http://developer.android.com/reference/android/net/ - # NetworkInfo.html#getSubtype() - # Corresponds to the JSON property `androidNetworkSubtype` - # @return [Fixnum] - attr_accessor :android_network_subtype - - # Android network type. http://developer.android.com/reference/android/net/ - # NetworkInfo.html#getType() - # Corresponds to the JSON property `androidNetworkType` - # @return [Fixnum] - attr_accessor :android_network_type - - # iOS network type as defined in Reachability.h. - # Corresponds to the JSON property `iosNetworkType` - # @return [Fixnum] - attr_accessor :ios_network_type - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomLeaveDiagnostics. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The MCC+MNC code for the client's network connection. On Android: http:// - # developer.android.com/reference/android/telephony/TelephonyManager.html# - # getNetworkOperator() On iOS, see: https://developer.apple.com/library/ios/ - # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html - # Corresponds to the JSON property `networkOperatorCode` - # @return [String] - attr_accessor :network_operator_code - - # The name of the carrier of the client's network connection. On Android: http:// - # developer.android.com/reference/android/telephony/TelephonyManager.html# - # getNetworkOperatorName() On iOS: https://developer.apple.com/library/ios/ - # documentation/NetworkingInternet/Reference/CTCarrier/Reference/Reference.html#/ - # /apple_ref/occ/instp/CTCarrier/carrierName - # Corresponds to the JSON property `networkOperatorName` - # @return [String] - attr_accessor :network_operator_name - - # Diagnostics about all peer sessions. - # Corresponds to the JSON property `peerSession` - # @return [Array] - attr_accessor :peer_session - - # Whether or not sockets were used. - # Corresponds to the JSON property `socketsUsed` - # @return [Boolean] - attr_accessor :sockets_used - alias_method :sockets_used?, :sockets_used - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @android_network_subtype = args[:android_network_subtype] if args.key?(:android_network_subtype) - @android_network_type = args[:android_network_type] if args.key?(:android_network_type) - @ios_network_type = args[:ios_network_type] if args.key?(:ios_network_type) - @kind = args[:kind] if args.key?(:kind) - @network_operator_code = args[:network_operator_code] if args.key?(:network_operator_code) - @network_operator_name = args[:network_operator_name] if args.key?(:network_operator_name) - @peer_session = args[:peer_session] if args.key?(:peer_session) - @sockets_used = args[:sockets_used] if args.key?(:sockets_used) - end - end - - # This is a JSON template for a leave room request. - class LeaveRoomRequest - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomLeaveRequest. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # This is a JSON template for room leave diagnostics. - # Corresponds to the JSON property `leaveDiagnostics` - # @return [Google::Apis::GamesV1::RoomLeaveDiagnostics] - attr_accessor :leave_diagnostics - - # Reason for leaving the match. - # Possible values are: - # - "PLAYER_LEFT" - The player chose to leave the room.. - # - "GAME_LEFT" - The game chose to remove the player from the room. - # - "REALTIME_ABANDONED" - The player switched to another application and - # abandoned the room. - # - "REALTIME_PEER_CONNECTION_FAILURE" - The client was unable to establish a - # connection to other peer(s). - # - "REALTIME_SERVER_CONNECTION_FAILURE" - The client was unable to communicate - # with the server. - # - "REALTIME_SERVER_ERROR" - The client received an error response when it - # tried to communicate with the server. - # - "REALTIME_TIMEOUT" - The client timed out while waiting for a room. - # - "REALTIME_CLIENT_DISCONNECTING" - The client disconnects without first - # calling Leave. - # - "REALTIME_SIGN_OUT" - The user signed out of G+ while in the room. - # - "REALTIME_GAME_CRASHED" - The game crashed. - # - "REALTIME_ROOM_SERVICE_CRASHED" - RoomAndroidService crashed. - # - "REALTIME_DIFFERENT_CLIENT_ROOM_OPERATION" - Another client is trying to - # enter a room. - # - "REALTIME_SAME_CLIENT_ROOM_OPERATION" - The same client is trying to enter a - # new room. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @leave_diagnostics = args[:leave_diagnostics] if args.key?(:leave_diagnostics) - @reason = args[:reason] if args.key?(:reason) - end - end - - # This is a JSON template for a list of rooms. - class RoomList - include Google::Apis::Core::Hashable - - # The rooms. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomList. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The pagination token for the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # This is a JSON template for room modification metadata. - class RoomModification - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomModification. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The timestamp at which they modified the room, in milliseconds since the epoch - # in UTC. - # Corresponds to the JSON property `modifiedTimestampMillis` - # @return [Fixnum] - attr_accessor :modified_timestamp_millis - - # The ID of the participant that modified the room. - # Corresponds to the JSON property `participantId` - # @return [String] - attr_accessor :participant_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @modified_timestamp_millis = args[:modified_timestamp_millis] if args.key?(:modified_timestamp_millis) - @participant_id = args[:participant_id] if args.key?(:participant_id) - end - end - - # This is a JSON template for an update on the status of a peer in a room. - class RoomP2PStatus - include Google::Apis::Core::Hashable - - # The amount of time in milliseconds it took to establish connections with this - # peer. - # Corresponds to the JSON property `connectionSetupLatencyMillis` - # @return [Fixnum] - attr_accessor :connection_setup_latency_millis - - # The error code in event of a failure. - # Possible values are: - # - "P2P_FAILED" - The client failed to establish a P2P connection with the peer. - # - # - "PRESENCE_FAILED" - The client failed to register to receive P2P connections. - # - # - "RELAY_SERVER_FAILED" - The client received an error when trying to use the - # relay server to establish a P2P connection with the peer. - # Corresponds to the JSON property `error` - # @return [String] - attr_accessor :error - - # More detailed diagnostic message returned in event of a failure. - # Corresponds to the JSON property `error_reason` - # @return [String] - attr_accessor :error_reason - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomP2PStatus. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The ID of the participant. - # Corresponds to the JSON property `participantId` - # @return [String] - attr_accessor :participant_id - - # The status of the peer in the room. - # Possible values are: - # - "CONNECTION_ESTABLISHED" - The client established a P2P connection with the - # peer. - # - "CONNECTION_FAILED" - The client failed to establish directed presence with - # the peer. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # The amount of time in milliseconds it took to send packets back and forth on - # the unreliable channel with this peer. - # Corresponds to the JSON property `unreliableRoundtripLatencyMillis` - # @return [Fixnum] - attr_accessor :unreliable_roundtrip_latency_millis - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @connection_setup_latency_millis = args[:connection_setup_latency_millis] if args.key?(:connection_setup_latency_millis) - @error = args[:error] if args.key?(:error) - @error_reason = args[:error_reason] if args.key?(:error_reason) - @kind = args[:kind] if args.key?(:kind) - @participant_id = args[:participant_id] if args.key?(:participant_id) - @status = args[:status] if args.key?(:status) - @unreliable_roundtrip_latency_millis = args[:unreliable_roundtrip_latency_millis] if args.key?(:unreliable_roundtrip_latency_millis) - end - end - - # This is a JSON template for an update on the status of peers in a room. - class RoomP2PStatuses - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomP2PStatuses. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The updates for the peers. - # Corresponds to the JSON property `updates` - # @return [Array] - attr_accessor :updates - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @updates = args[:updates] if args.key?(:updates) - end - end - - # This is a JSON template for a participant in a room. - class RoomParticipant - include Google::Apis::Core::Hashable - - # True if this participant was auto-matched with the requesting player. - # Corresponds to the JSON property `autoMatched` - # @return [Boolean] - attr_accessor :auto_matched - alias_method :auto_matched?, :auto_matched - - # This is a JSON template for an anonymous player - # Corresponds to the JSON property `autoMatchedPlayer` - # @return [Google::Apis::GamesV1::AnonymousPlayer] - attr_accessor :auto_matched_player - - # The capabilities which can be used when communicating with this participant. - # Corresponds to the JSON property `capabilities` - # @return [Array] - attr_accessor :capabilities - - # This is a JSON template for the client address when setting up a room. - # Corresponds to the JSON property `clientAddress` - # @return [Google::Apis::GamesV1::RoomClientAddress] - attr_accessor :client_address - - # True if this participant is in the fully connected set of peers in the room. - # Corresponds to the JSON property `connected` - # @return [Boolean] - attr_accessor :connected - alias_method :connected?, :connected - - # An identifier for the participant in the scope of the room. Cannot be used to - # identify a player across rooms or in other contexts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomParticipant. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The reason the participant left the room; populated if the participant status - # is PARTICIPANT_LEFT. - # Possible values are: - # - "PLAYER_LEFT" - The player explicitly chose to leave the room. - # - "GAME_LEFT" - The game chose to remove the player from the room. - # - "ABANDONED" - The player switched to another application and abandoned the - # room. - # - "PEER_CONNECTION_FAILURE" - The client was unable to establish or maintain a - # connection to other peer(s) in the room. - # - "SERVER_ERROR" - The client received an error response when it tried to - # communicate with the server. - # - "TIMEOUT" - The client timed out while waiting for players to join and - # connect. - # - "PRESENCE_FAILURE" - The client's XMPP connection ended abruptly. - # Corresponds to the JSON property `leaveReason` - # @return [String] - attr_accessor :leave_reason - - # This is a JSON template for a Player resource. - # Corresponds to the JSON property `player` - # @return [Google::Apis::GamesV1::Player] - attr_accessor :player - - # The status of the participant with respect to the room. - # Possible values are: - # - "PARTICIPANT_INVITED" - The participant has been invited to join the room, - # but has not yet responded. - # - "PARTICIPANT_JOINED" - The participant has joined the room (either after - # creating it or accepting an invitation.) - # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the - # room. - # - "PARTICIPANT_LEFT" - The participant joined the room and then left it. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_matched = args[:auto_matched] if args.key?(:auto_matched) - @auto_matched_player = args[:auto_matched_player] if args.key?(:auto_matched_player) - @capabilities = args[:capabilities] if args.key?(:capabilities) - @client_address = args[:client_address] if args.key?(:client_address) - @connected = args[:connected] if args.key?(:connected) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @leave_reason = args[:leave_reason] if args.key?(:leave_reason) - @player = args[:player] if args.key?(:player) - @status = args[:status] if args.key?(:status) - end - end - - # This is a JSON template for the status of a room that the player has joined. - class RoomStatus - include Google::Apis::Core::Hashable - - # This is a JSON template for status of room automatching that is in progress. - # Corresponds to the JSON property `autoMatchingStatus` - # @return [Google::Apis::GamesV1::RoomAutoMatchStatus] - attr_accessor :auto_matching_status - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#roomStatus. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The participants involved in the room, along with their statuses. Includes - # participants who have left or declined invitations. - # Corresponds to the JSON property `participants` - # @return [Array] - attr_accessor :participants - - # Globally unique ID for a room. - # Corresponds to the JSON property `roomId` - # @return [String] - attr_accessor :room_id - - # The status of the room. - # Possible values are: - # - "ROOM_INVITING" - One or more players have been invited and not responded. - # - "ROOM_AUTO_MATCHING" - One or more slots need to be filled by auto-matching. - # - "ROOM_CONNECTING" - Players have joined are connecting to each other (either - # before or after auto-matching). - # - "ROOM_ACTIVE" - All players have joined and connected to each other. - # - "ROOM_DELETED" - All joined players have left. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # The version of the status for the room: an increasing counter, used by the - # client to ignore out-of-order updates to room status. - # Corresponds to the JSON property `statusVersion` - # @return [Fixnum] - attr_accessor :status_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_matching_status = args[:auto_matching_status] if args.key?(:auto_matching_status) - @kind = args[:kind] if args.key?(:kind) - @participants = args[:participants] if args.key?(:participants) - @room_id = args[:room_id] if args.key?(:room_id) - @status = args[:status] if args.key?(:status) - @status_version = args[:status_version] if args.key?(:status_version) - end - end - - # This is a JSON template for a request to submit a score to leaderboards. + # A request to submit a score to leaderboards. class ScoreSubmission include Google::Apis::Core::Hashable # Uniquely identifies the type of this resource. Value is always the fixed - # string games#scoreSubmission. + # string `games#scoreSubmission`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3594,14 +2343,14 @@ module Google # @return [Fixnum] attr_accessor :score - # Additional information about this score. Values will contain no more than 64 - # URI-safe characters as defined by section 2.3 of RFC 3986. + # Additional information about this score. Values will contain no more than + # 64 URI-safe characters as defined by section 2.3 of RFC 3986. # Corresponds to the JSON property `scoreTag` # @return [String] attr_accessor :score_tag - # Signature Values will contain URI-safe characters as defined by section 2.3 of - # RFC 3986. + # Signature Values will contain URI-safe characters as defined by section 2.3 + # of RFC 3986. # Corresponds to the JSON property `signature` # @return [String] attr_accessor :signature @@ -3620,11 +2369,11 @@ module Google end end - # This is a JSON template for an snapshot object. + # An snapshot object. class Snapshot include Google::Apis::Core::Hashable - # This is a JSON template for an image of a snapshot. + # An image of a snapshot. # Corresponds to the JSON property `coverImage` # @return [Google::Apis::GamesV1::SnapshotImage] attr_accessor :cover_image @@ -3634,8 +2383,9 @@ module Google # @return [String] attr_accessor :description - # The ID of the file underlying this snapshot in the Drive API. Only present if - # the snapshot is a view on a Drive file and the file is owned by the caller. + # The ID of the file underlying this snapshot in the Drive API. Only present + # if the snapshot is a view on a Drive file and the file is owned by the + # caller. # Corresponds to the JSON property `driveId` # @return [String] attr_accessor :drive_id @@ -3651,7 +2401,7 @@ module Google attr_accessor :id # Uniquely identifies the type of this resource. Value is always the fixed - # string games#snapshot. + # string `games#snapshot`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3674,8 +2424,6 @@ module Google attr_accessor :title # The type of this snapshot. - # Possible values are: - # - "SAVE_GAME" - A snapshot representing a save game. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3705,7 +2453,7 @@ module Google end end - # This is a JSON template for an image of a snapshot. + # An image of a snapshot. class SnapshotImage include Google::Apis::Core::Hashable @@ -3715,7 +2463,7 @@ module Google attr_accessor :height # Uniquely identifies the type of this resource. Value is always the fixed - # string games#snapshotImage. + # string `games#snapshotImage`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3725,8 +2473,8 @@ module Google # @return [String] attr_accessor :mime_type - # The URL of the image. This URL may be invalidated at any time and should not - # be cached. + # The URL of the image. This URL may be invalidated at any time and should + # not be cached. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -3750,7 +2498,7 @@ module Google end end - # This is a JSON template for a list of snapshot objects. + # A third party list snapshots response. class ListSnapshotResponse include Google::Apis::Core::Hashable @@ -3760,13 +2508,13 @@ module Google attr_accessor :items # Uniquely identifies the type of this resource. Value is always the fixed - # string games#snapshotListResponse. + # string `games#snapshotListResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # Token corresponding to the next page of results. If there are no more results, - # the token is omitted. + # Token corresponding to the next page of results. If there are no more + # results, the token is omitted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3783,34 +2531,83 @@ module Google end end - # This is a JSON template for an turn-based auto-match criteria object. - class TurnBasedAutoMatchingCriteria + # A third party stats resource. + class StatsResponse include Google::Apis::Core::Hashable - # A bitmask indicating when auto-matches are valid. When ANDed with other - # exclusive bitmasks, the result must be zero. Can be used to support exclusive - # roles within a game. - # Corresponds to the JSON property `exclusiveBitmask` + # Average session length in minutes of the player. E.g., 1, 30, 60, ... . Not + # populated if there is not enough information. + # Corresponds to the JSON property `avg_session_length_minutes` + # @return [Float] + attr_accessor :avg_session_length_minutes + + # The probability of the player not returning to play the game in the next + # day. E.g., 0, 0.1, 0.5, ..., 1.0. Not populated if there is not enough + # information. + # Corresponds to the JSON property `churn_probability` + # @return [Float] + attr_accessor :churn_probability + + # Number of days since the player last played this game. E.g., 0, 1, 5, 10, + # ... . Not populated if there is not enough information. + # Corresponds to the JSON property `days_since_last_played` # @return [Fixnum] - attr_accessor :exclusive_bitmask + attr_accessor :days_since_last_played + + # The probability of the player going to spend beyond a threshold amount of + # money. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough + # information. + # Corresponds to the JSON property `high_spender_probability` + # @return [Float] + attr_accessor :high_spender_probability # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedAutoMatchingCriteria. + # string `games#statsResponse`. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The maximum number of players that should be added to the match by auto- - # matching. - # Corresponds to the JSON property `maxAutoMatchingPlayers` + # Number of in-app purchases made by the player in this game. E.g., 0, 1, 5, + # 10, ... . Not populated if there is not enough information. + # Corresponds to the JSON property `num_purchases` # @return [Fixnum] - attr_accessor :max_auto_matching_players + attr_accessor :num_purchases - # The minimum number of players that should be added to the match by auto- - # matching. - # Corresponds to the JSON property `minAutoMatchingPlayers` + # The approximate number of sessions of the player within the last 28 days, + # where a session begins when the player is connected to Play Games Services + # and ends when they are disconnected. E.g., 0, 1, 5, 10, ... . Not populated + # if there is not enough information. + # Corresponds to the JSON property `num_sessions` # @return [Fixnum] - attr_accessor :min_auto_matching_players + attr_accessor :num_sessions + + # The approximation of the sessions percentile of the player within the last + # 30 days, where a session begins when the player is connected to Play Games + # Services and ends when they are disconnected. E.g., 0, 0.25, 0.5, 0.75. Not + # populated if there is not enough information. + # Corresponds to the JSON property `num_sessions_percentile` + # @return [Float] + attr_accessor :num_sessions_percentile + + # The approximate spend percentile of the player in this game. E.g., 0, 0.25, + # 0.5, 0.75. Not populated if there is not enough information. + # Corresponds to the JSON property `spend_percentile` + # @return [Float] + attr_accessor :spend_percentile + + # The probability of the player going to spend the game in the next seven + # days. E.g., 0, 0.25, 0.50, 0.75. Not populated if there is not enough + # information. + # Corresponds to the JSON property `spend_probability` + # @return [Float] + attr_accessor :spend_probability + + # The predicted amount of money that the player going to spend in the next 28 + # days. E.g., 1, 30, 60, ... . Not populated if there is not enough + # information. + # Corresponds to the JSON property `total_spend_next_28_days` + # @return [Float] + attr_accessor :total_spend_next_28_days def initialize(**args) update!(**args) @@ -3818,572 +2615,17 @@ module Google # Update properties of this object def update!(**args) - @exclusive_bitmask = args[:exclusive_bitmask] if args.key?(:exclusive_bitmask) + @avg_session_length_minutes = args[:avg_session_length_minutes] if args.key?(:avg_session_length_minutes) + @churn_probability = args[:churn_probability] if args.key?(:churn_probability) + @days_since_last_played = args[:days_since_last_played] if args.key?(:days_since_last_played) + @high_spender_probability = args[:high_spender_probability] if args.key?(:high_spender_probability) @kind = args[:kind] if args.key?(:kind) - @max_auto_matching_players = args[:max_auto_matching_players] if args.key?(:max_auto_matching_players) - @min_auto_matching_players = args[:min_auto_matching_players] if args.key?(:min_auto_matching_players) - end - end - - # This is a JSON template for a turn-based match resource object. - class TurnBasedMatch - include Google::Apis::Core::Hashable - - # The ID of the application being played. - # Corresponds to the JSON property `applicationId` - # @return [String] - attr_accessor :application_id - - # This is a JSON template for an turn-based auto-match criteria object. - # Corresponds to the JSON property `autoMatchingCriteria` - # @return [Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria] - attr_accessor :auto_matching_criteria - - # This is a JSON template for turn-based match modification metadata. - # Corresponds to the JSON property `creationDetails` - # @return [Google::Apis::GamesV1::TurnBasedMatchModification] - attr_accessor :creation_details - - # This is a JSON template for a turn-based match data object. - # Corresponds to the JSON property `data` - # @return [Google::Apis::GamesV1::TurnBasedMatchData] - attr_accessor :data - - # This short description is generated by our servers based on turn state and is - # localized and worded relative to the player requesting the match. It is - # intended to be displayed when the match is shown in a list. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The ID of the participant that invited the user to the match. Not set if the - # user was not invited to the match. - # Corresponds to the JSON property `inviterId` - # @return [String] - attr_accessor :inviter_id - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatch. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # This is a JSON template for turn-based match modification metadata. - # Corresponds to the JSON property `lastUpdateDetails` - # @return [Google::Apis::GamesV1::TurnBasedMatchModification] - attr_accessor :last_update_details - - # Globally unique ID for a turn-based match. - # Corresponds to the JSON property `matchId` - # @return [String] - attr_accessor :match_id - - # The number of the match in a chain of rematches. Will be set to 1 for the - # first match and incremented by 1 for each rematch. - # Corresponds to the JSON property `matchNumber` - # @return [Fixnum] - attr_accessor :match_number - - # The version of this match: an increasing counter, used to avoid out-of-date - # updates to the match. - # Corresponds to the JSON property `matchVersion` - # @return [Fixnum] - attr_accessor :match_version - - # The participants involved in the match, along with their statuses. Includes - # participants who have left or declined invitations. - # Corresponds to the JSON property `participants` - # @return [Array] - attr_accessor :participants - - # The ID of the participant that is taking a turn. - # Corresponds to the JSON property `pendingParticipantId` - # @return [String] - attr_accessor :pending_participant_id - - # This is a JSON template for a turn-based match data object. - # Corresponds to the JSON property `previousMatchData` - # @return [Google::Apis::GamesV1::TurnBasedMatchData] - attr_accessor :previous_match_data - - # The ID of a rematch of this match. Only set for completed matches that have - # been rematched. - # Corresponds to the JSON property `rematchId` - # @return [String] - attr_accessor :rematch_id - - # The results reported for this match. - # Corresponds to the JSON property `results` - # @return [Array] - attr_accessor :results - - # The status of the match. - # Possible values are: - # - "MATCH_AUTO_MATCHING" - One or more slots need to be filled by auto-matching; - # the match cannot be established until they are filled. - # - "MATCH_ACTIVE" - The match has started. - # - "MATCH_COMPLETE" - The match has finished. - # - "MATCH_CANCELED" - The match was canceled. - # - "MATCH_EXPIRED" - The match expired due to inactivity. - # - "MATCH_DELETED" - The match should no longer be shown on the client. - # Returned only for tombstones for matches when sync is called. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # The status of the current user in the match. Derived from the match type, - # match status, the user's participant status, and the pending participant for - # the match. - # Possible values are: - # - "USER_INVITED" - The user has been invited to join the match and has not - # responded yet. - # - "USER_AWAITING_TURN" - The user is waiting for their turn. - # - "USER_TURN" - The user has an action to take in the match. - # - "USER_MATCH_COMPLETED" - The match has ended (it is completed, canceled, or - # expired.) - # Corresponds to the JSON property `userMatchStatus` - # @return [String] - attr_accessor :user_match_status - - # The variant / mode of the application being played; can be any integer value, - # or left blank. - # Corresponds to the JSON property `variant` - # @return [Fixnum] - attr_accessor :variant - - # The ID of another participant in the match that can be used when describing - # the participants the user is playing with. - # Corresponds to the JSON property `withParticipantId` - # @return [String] - attr_accessor :with_participant_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @application_id = args[:application_id] if args.key?(:application_id) - @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) - @creation_details = args[:creation_details] if args.key?(:creation_details) - @data = args[:data] if args.key?(:data) - @description = args[:description] if args.key?(:description) - @inviter_id = args[:inviter_id] if args.key?(:inviter_id) - @kind = args[:kind] if args.key?(:kind) - @last_update_details = args[:last_update_details] if args.key?(:last_update_details) - @match_id = args[:match_id] if args.key?(:match_id) - @match_number = args[:match_number] if args.key?(:match_number) - @match_version = args[:match_version] if args.key?(:match_version) - @participants = args[:participants] if args.key?(:participants) - @pending_participant_id = args[:pending_participant_id] if args.key?(:pending_participant_id) - @previous_match_data = args[:previous_match_data] if args.key?(:previous_match_data) - @rematch_id = args[:rematch_id] if args.key?(:rematch_id) - @results = args[:results] if args.key?(:results) - @status = args[:status] if args.key?(:status) - @user_match_status = args[:user_match_status] if args.key?(:user_match_status) - @variant = args[:variant] if args.key?(:variant) - @with_participant_id = args[:with_participant_id] if args.key?(:with_participant_id) - end - end - - # This is a JSON template for a turn-based match creation request. - class CreateTurnBasedMatchRequest - include Google::Apis::Core::Hashable - - # This is a JSON template for an turn-based auto-match criteria object. - # Corresponds to the JSON property `autoMatchingCriteria` - # @return [Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria] - attr_accessor :auto_matching_criteria - - # The player ids to invite to the match. - # Corresponds to the JSON property `invitedPlayerIds` - # @return [Array] - attr_accessor :invited_player_ids - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchCreateRequest. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # A randomly generated numeric ID. This number is used at the server to ensure - # that the request is handled correctly across retries. - # Corresponds to the JSON property `requestId` - # @return [Fixnum] - attr_accessor :request_id - - # The variant / mode of the application to be played. This can be any integer - # value, or left blank. You should use a small number of variants to keep the - # auto-matching pool as large as possible. - # Corresponds to the JSON property `variant` - # @return [Fixnum] - attr_accessor :variant - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_matching_criteria = args[:auto_matching_criteria] if args.key?(:auto_matching_criteria) - @invited_player_ids = args[:invited_player_ids] if args.key?(:invited_player_ids) - @kind = args[:kind] if args.key?(:kind) - @request_id = args[:request_id] if args.key?(:request_id) - @variant = args[:variant] if args.key?(:variant) - end - end - - # This is a JSON template for a turn-based match data object. - class TurnBasedMatchData - include Google::Apis::Core::Hashable - - # The byte representation of the data (limited to 128 kB), as a Base64-encoded - # string with the URL_SAFE encoding option. - # Corresponds to the JSON property `data` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :data - - # True if this match has data available but it wasn't returned in a list - # response; fetching the match individually will retrieve this data. - # Corresponds to the JSON property `dataAvailable` - # @return [Boolean] - attr_accessor :data_available - alias_method :data_available?, :data_available - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchData. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @data = args[:data] if args.key?(:data) - @data_available = args[:data_available] if args.key?(:data_available) - @kind = args[:kind] if args.key?(:kind) - end - end - - # This is a JSON template for sending a turn-based match data object. - class TurnBasedMatchDataRequest - include Google::Apis::Core::Hashable - - # The byte representation of the data (limited to 128 kB), as a Base64-encoded - # string with the URL_SAFE encoding option. - # Corresponds to the JSON property `data` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :data - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchDataRequest. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @data = args[:data] if args.key?(:data) - @kind = args[:kind] if args.key?(:kind) - end - end - - # This is a JSON template for a list of turn-based matches. - class TurnBasedMatchList - include Google::Apis::Core::Hashable - - # The matches. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchList. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The pagination token for the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # This is a JSON template for turn-based match modification metadata. - class TurnBasedMatchModification - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchModification. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The timestamp at which they modified the match, in milliseconds since the - # epoch in UTC. - # Corresponds to the JSON property `modifiedTimestampMillis` - # @return [Fixnum] - attr_accessor :modified_timestamp_millis - - # The ID of the participant that modified the match. - # Corresponds to the JSON property `participantId` - # @return [String] - attr_accessor :participant_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @modified_timestamp_millis = args[:modified_timestamp_millis] if args.key?(:modified_timestamp_millis) - @participant_id = args[:participant_id] if args.key?(:participant_id) - end - end - - # This is a JSON template for a participant in a turn-based match. - class TurnBasedMatchParticipant - include Google::Apis::Core::Hashable - - # True if this participant was auto-matched with the requesting player. - # Corresponds to the JSON property `autoMatched` - # @return [Boolean] - attr_accessor :auto_matched - alias_method :auto_matched?, :auto_matched - - # This is a JSON template for an anonymous player - # Corresponds to the JSON property `autoMatchedPlayer` - # @return [Google::Apis::GamesV1::AnonymousPlayer] - attr_accessor :auto_matched_player - - # An identifier for the participant in the scope of the match. Cannot be used to - # identify a player across matches or in other contexts. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchParticipant. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # This is a JSON template for a Player resource. - # Corresponds to the JSON property `player` - # @return [Google::Apis::GamesV1::Player] - attr_accessor :player - - # The status of the participant with respect to the match. - # Possible values are: - # - "PARTICIPANT_NOT_INVITED_YET" - The participant is slated to be invited to - # the match, but the invitation has not been sent; the invite will be sent when - # it becomes their turn. - # - "PARTICIPANT_INVITED" - The participant has been invited to join the match, - # but has not yet responded. - # - "PARTICIPANT_JOINED" - The participant has joined the match (either after - # creating it or accepting an invitation.) - # - "PARTICIPANT_DECLINED" - The participant declined an invitation to join the - # match. - # - "PARTICIPANT_LEFT" - The participant joined the match and then left it. - # - "PARTICIPANT_FINISHED" - The participant finished playing in the match. - # - "PARTICIPANT_UNRESPONSIVE" - The participant did not take their turn in the - # allotted time. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @auto_matched = args[:auto_matched] if args.key?(:auto_matched) - @auto_matched_player = args[:auto_matched_player] if args.key?(:auto_matched_player) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @player = args[:player] if args.key?(:player) - @status = args[:status] if args.key?(:status) - end - end - - # This is a JSON template for a rematch response. - class TurnBasedMatchRematch - include Google::Apis::Core::Hashable - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchRematch. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # This is a JSON template for a turn-based match resource object. - # Corresponds to the JSON property `previousMatch` - # @return [Google::Apis::GamesV1::TurnBasedMatch] - attr_accessor :previous_match - - # This is a JSON template for a turn-based match resource object. - # Corresponds to the JSON property `rematch` - # @return [Google::Apis::GamesV1::TurnBasedMatch] - attr_accessor :rematch - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @kind = args[:kind] if args.key?(:kind) - @previous_match = args[:previous_match] if args.key?(:previous_match) - @rematch = args[:rematch] if args.key?(:rematch) - end - end - - # This is a JSON template for a turn-based match results object. - class TurnBasedMatchResults - include Google::Apis::Core::Hashable - - # This is a JSON template for sending a turn-based match data object. - # Corresponds to the JSON property `data` - # @return [Google::Apis::GamesV1::TurnBasedMatchDataRequest] - attr_accessor :data - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchResults. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The version of the match being updated. - # Corresponds to the JSON property `matchVersion` - # @return [Fixnum] - attr_accessor :match_version - - # The match results for the participants in the match. - # Corresponds to the JSON property `results` - # @return [Array] - attr_accessor :results - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @data = args[:data] if args.key?(:data) - @kind = args[:kind] if args.key?(:kind) - @match_version = args[:match_version] if args.key?(:match_version) - @results = args[:results] if args.key?(:results) - end - end - - # This is a JSON template for a list of turn-based matches returned from a sync. - class TurnBasedMatchSync - include Google::Apis::Core::Hashable - - # The matches. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchSync. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # True if there were more matches available to fetch at the time the response - # was generated (which were not returned due to page size limits.) - # Corresponds to the JSON property `moreAvailable` - # @return [Boolean] - attr_accessor :more_available - alias_method :more_available?, :more_available - - # The pagination token for the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - @more_available = args[:more_available] if args.key?(:more_available) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # This is a JSON template for the object representing a turn. - class TurnBasedMatchTurn - include Google::Apis::Core::Hashable - - # This is a JSON template for sending a turn-based match data object. - # Corresponds to the JSON property `data` - # @return [Google::Apis::GamesV1::TurnBasedMatchDataRequest] - attr_accessor :data - - # Uniquely identifies the type of this resource. Value is always the fixed - # string games#turnBasedMatchTurn. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # The version of this match: an increasing counter, used to avoid out-of-date - # updates to the match. - # Corresponds to the JSON property `matchVersion` - # @return [Fixnum] - attr_accessor :match_version - - # The ID of the participant who should take their turn next. May be set to the - # current player's participant ID to update match state without changing the - # turn. If not set, the match will wait for other player(s) to join via - # automatching; this is only valid if automatch criteria is set on the match - # with remaining slots for automatched players. - # Corresponds to the JSON property `pendingParticipantId` - # @return [String] - attr_accessor :pending_participant_id - - # The match results for the participants in the match. - # Corresponds to the JSON property `results` - # @return [Array] - attr_accessor :results - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @data = args[:data] if args.key?(:data) - @kind = args[:kind] if args.key?(:kind) - @match_version = args[:match_version] if args.key?(:match_version) - @pending_participant_id = args[:pending_participant_id] if args.key?(:pending_participant_id) - @results = args[:results] if args.key?(:results) + @num_purchases = args[:num_purchases] if args.key?(:num_purchases) + @num_sessions = args[:num_sessions] if args.key?(:num_sessions) + @num_sessions_percentile = args[:num_sessions_percentile] if args.key?(:num_sessions_percentile) + @spend_percentile = args[:spend_percentile] if args.key?(:spend_percentile) + @spend_probability = args[:spend_probability] if args.key?(:spend_probability) + @total_spend_next_28_days = args[:total_spend_next_28_days] if args.key?(:total_spend_next_28_days) end end end diff --git a/generated/google/apis/games_v1/representations.rb b/generated/google/apis/games_v1/representations.rb index 8c47c37d8..75ecd3888 100644 --- a/generated/google/apis/games_v1/representations.rb +++ b/generated/google/apis/games_v1/representations.rb @@ -82,18 +82,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class AggregateStats - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AnonymousPlayer - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Application class Representation < Google::Apis::Core::JsonRepresentation; end @@ -262,36 +250,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class NetworkDiagnostics - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ParticipantResult - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PeerChannelDiagnostics - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PeerSessionDiagnostics - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Played - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Player class Representation < Google::Apis::Core::JsonRepresentation; end @@ -388,114 +346,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class PushToken - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PushTokenId - class Representation < Google::Apis::Core::JsonRepresentation; end - - class Ios - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - include Google::Apis::Core::JsonObjectSupport - end - class CheckRevisionResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class Room - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomAutoMatchStatus - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomAutoMatchingCriteria - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomClientAddress - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CreateRoomRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class JoinRoomRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomLeaveDiagnostics - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class LeaveRoomRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomList - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomModification - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomP2PStatus - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomP2PStatuses - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomParticipant - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RoomStatus - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class ScoreSubmission class Representation < Google::Apis::Core::JsonRepresentation; end @@ -520,73 +376,7 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class TurnBasedAutoMatchingCriteria - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatch - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CreateTurnBasedMatchRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchData - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchDataRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchList - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchModification - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchParticipant - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchRematch - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchResults - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchSync - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TurnBasedMatchTurn + class StatsResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -698,26 +488,6 @@ module Google end end - class AggregateStats - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :count, :numeric_string => true, as: 'count' - property :kind, as: 'kind' - property :max, :numeric_string => true, as: 'max' - property :min, :numeric_string => true, as: 'min' - property :sum, :numeric_string => true, as: 'sum' - end - end - - class AnonymousPlayer - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :avatar_image_url, as: 'avatarImageUrl' - property :display_name, as: 'displayName' - property :kind, as: 'kind' - end - end - class Application # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1033,68 +803,6 @@ module Google end end - class NetworkDiagnostics - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :android_network_subtype, as: 'androidNetworkSubtype' - property :android_network_type, as: 'androidNetworkType' - property :ios_network_type, as: 'iosNetworkType' - property :kind, as: 'kind' - property :network_operator_code, as: 'networkOperatorCode' - property :network_operator_name, as: 'networkOperatorName' - property :registration_latency_millis, as: 'registrationLatencyMillis' - end - end - - class ParticipantResult - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :participant_id, as: 'participantId' - property :placing, as: 'placing' - property :result, as: 'result' - end - end - - class PeerChannelDiagnostics - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :bytes_received, as: 'bytesReceived', class: Google::Apis::GamesV1::AggregateStats, decorator: Google::Apis::GamesV1::AggregateStats::Representation - - property :bytes_sent, as: 'bytesSent', class: Google::Apis::GamesV1::AggregateStats, decorator: Google::Apis::GamesV1::AggregateStats::Representation - - property :kind, as: 'kind' - property :num_messages_lost, as: 'numMessagesLost' - property :num_messages_received, as: 'numMessagesReceived' - property :num_messages_sent, as: 'numMessagesSent' - property :num_send_failures, as: 'numSendFailures' - property :roundtrip_latency_millis, as: 'roundtripLatencyMillis', class: Google::Apis::GamesV1::AggregateStats, decorator: Google::Apis::GamesV1::AggregateStats::Representation - - end - end - - class PeerSessionDiagnostics - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :connected_timestamp_millis, :numeric_string => true, as: 'connectedTimestampMillis' - property :kind, as: 'kind' - property :participant_id, as: 'participantId' - property :reliable_channel, as: 'reliableChannel', class: Google::Apis::GamesV1::PeerChannelDiagnostics, decorator: Google::Apis::GamesV1::PeerChannelDiagnostics::Representation - - property :unreliable_channel, as: 'unreliableChannel', class: Google::Apis::GamesV1::PeerChannelDiagnostics, decorator: Google::Apis::GamesV1::PeerChannelDiagnostics::Representation - - end - end - - class Played - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_matched, as: 'autoMatched' - property :kind, as: 'kind' - property :time_millis, :numeric_string => true, as: 'timeMillis' - end - end - class Player # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1106,8 +814,6 @@ module Google property :friend_status, as: 'friendStatus' property :kind, as: 'kind' - property :last_played_with, as: 'lastPlayedWith', class: Google::Apis::GamesV1::Played, decorator: Google::Apis::GamesV1::Played::Representation - property :name, as: 'name', class: Google::Apis::GamesV1::Player::Name, decorator: Google::Apis::GamesV1::Player::Name::Representation property :original_player_id, as: 'originalPlayerId' @@ -1283,34 +989,6 @@ module Google end end - class PushToken - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :client_revision, as: 'clientRevision' - property :id, as: 'id', class: Google::Apis::GamesV1::PushTokenId, decorator: Google::Apis::GamesV1::PushTokenId::Representation - - property :kind, as: 'kind' - property :language, as: 'language' - end - end - - class PushTokenId - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :ios, as: 'ios', class: Google::Apis::GamesV1::PushTokenId::Ios, decorator: Google::Apis::GamesV1::PushTokenId::Ios::Representation - - property :kind, as: 'kind' - end - - class Ios - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apns_device_token, :base64 => true, as: 'apns_device_token' - property :apns_environment, as: 'apns_environment' - end - end - end - class CheckRevisionResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1320,184 +998,6 @@ module Google end end - class Room - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :application_id, as: 'applicationId' - property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::RoomAutoMatchingCriteria, decorator: Google::Apis::GamesV1::RoomAutoMatchingCriteria::Representation - - property :auto_matching_status, as: 'autoMatchingStatus', class: Google::Apis::GamesV1::RoomAutoMatchStatus, decorator: Google::Apis::GamesV1::RoomAutoMatchStatus::Representation - - property :creation_details, as: 'creationDetails', class: Google::Apis::GamesV1::RoomModification, decorator: Google::Apis::GamesV1::RoomModification::Representation - - property :description, as: 'description' - property :inviter_id, as: 'inviterId' - property :kind, as: 'kind' - property :last_update_details, as: 'lastUpdateDetails', class: Google::Apis::GamesV1::RoomModification, decorator: Google::Apis::GamesV1::RoomModification::Representation - - collection :participants, as: 'participants', class: Google::Apis::GamesV1::RoomParticipant, decorator: Google::Apis::GamesV1::RoomParticipant::Representation - - property :room_id, as: 'roomId' - property :room_status_version, as: 'roomStatusVersion' - property :status, as: 'status' - property :variant, as: 'variant' - end - end - - class RoomAutoMatchStatus - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :wait_estimate_seconds, as: 'waitEstimateSeconds' - end - end - - class RoomAutoMatchingCriteria - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :exclusive_bitmask, :numeric_string => true, as: 'exclusiveBitmask' - property :kind, as: 'kind' - property :max_auto_matching_players, as: 'maxAutoMatchingPlayers' - property :min_auto_matching_players, as: 'minAutoMatchingPlayers' - end - end - - class RoomClientAddress - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :xmpp_address, as: 'xmppAddress' - end - end - - class CreateRoomRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::RoomAutoMatchingCriteria, decorator: Google::Apis::GamesV1::RoomAutoMatchingCriteria::Representation - - collection :capabilities, as: 'capabilities' - property :client_address, as: 'clientAddress', class: Google::Apis::GamesV1::RoomClientAddress, decorator: Google::Apis::GamesV1::RoomClientAddress::Representation - - collection :invited_player_ids, as: 'invitedPlayerIds' - property :kind, as: 'kind' - property :network_diagnostics, as: 'networkDiagnostics', class: Google::Apis::GamesV1::NetworkDiagnostics, decorator: Google::Apis::GamesV1::NetworkDiagnostics::Representation - - property :request_id, :numeric_string => true, as: 'requestId' - property :variant, as: 'variant' - end - end - - class JoinRoomRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :capabilities, as: 'capabilities' - property :client_address, as: 'clientAddress', class: Google::Apis::GamesV1::RoomClientAddress, decorator: Google::Apis::GamesV1::RoomClientAddress::Representation - - property :kind, as: 'kind' - property :network_diagnostics, as: 'networkDiagnostics', class: Google::Apis::GamesV1::NetworkDiagnostics, decorator: Google::Apis::GamesV1::NetworkDiagnostics::Representation - - end - end - - class RoomLeaveDiagnostics - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :android_network_subtype, as: 'androidNetworkSubtype' - property :android_network_type, as: 'androidNetworkType' - property :ios_network_type, as: 'iosNetworkType' - property :kind, as: 'kind' - property :network_operator_code, as: 'networkOperatorCode' - property :network_operator_name, as: 'networkOperatorName' - collection :peer_session, as: 'peerSession', class: Google::Apis::GamesV1::PeerSessionDiagnostics, decorator: Google::Apis::GamesV1::PeerSessionDiagnostics::Representation - - property :sockets_used, as: 'socketsUsed' - end - end - - class LeaveRoomRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :leave_diagnostics, as: 'leaveDiagnostics', class: Google::Apis::GamesV1::RoomLeaveDiagnostics, decorator: Google::Apis::GamesV1::RoomLeaveDiagnostics::Representation - - property :reason, as: 'reason' - end - end - - class RoomList - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::GamesV1::Room, decorator: Google::Apis::GamesV1::Room::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - end - end - - class RoomModification - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :modified_timestamp_millis, :numeric_string => true, as: 'modifiedTimestampMillis' - property :participant_id, as: 'participantId' - end - end - - class RoomP2PStatus - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :connection_setup_latency_millis, as: 'connectionSetupLatencyMillis' - property :error, as: 'error' - property :error_reason, as: 'error_reason' - property :kind, as: 'kind' - property :participant_id, as: 'participantId' - property :status, as: 'status' - property :unreliable_roundtrip_latency_millis, as: 'unreliableRoundtripLatencyMillis' - end - end - - class RoomP2PStatuses - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - collection :updates, as: 'updates', class: Google::Apis::GamesV1::RoomP2PStatus, decorator: Google::Apis::GamesV1::RoomP2PStatus::Representation - - end - end - - class RoomParticipant - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_matched, as: 'autoMatched' - property :auto_matched_player, as: 'autoMatchedPlayer', class: Google::Apis::GamesV1::AnonymousPlayer, decorator: Google::Apis::GamesV1::AnonymousPlayer::Representation - - collection :capabilities, as: 'capabilities' - property :client_address, as: 'clientAddress', class: Google::Apis::GamesV1::RoomClientAddress, decorator: Google::Apis::GamesV1::RoomClientAddress::Representation - - property :connected, as: 'connected' - property :id, as: 'id' - property :kind, as: 'kind' - property :leave_reason, as: 'leaveReason' - property :player, as: 'player', class: Google::Apis::GamesV1::Player, decorator: Google::Apis::GamesV1::Player::Representation - - property :status, as: 'status' - end - end - - class RoomStatus - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_matching_status, as: 'autoMatchingStatus', class: Google::Apis::GamesV1::RoomAutoMatchStatus, decorator: Google::Apis::GamesV1::RoomAutoMatchStatus::Representation - - property :kind, as: 'kind' - collection :participants, as: 'participants', class: Google::Apis::GamesV1::RoomParticipant, decorator: Google::Apis::GamesV1::RoomParticipant::Representation - - property :room_id, as: 'roomId' - property :status, as: 'status' - property :status_version, as: 'statusVersion' - end - end - class ScoreSubmission # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1548,155 +1048,20 @@ module Google end end - class TurnBasedAutoMatchingCriteria + class StatsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :exclusive_bitmask, :numeric_string => true, as: 'exclusiveBitmask' + property :avg_session_length_minutes, as: 'avg_session_length_minutes' + property :churn_probability, as: 'churn_probability' + property :days_since_last_played, as: 'days_since_last_played' + property :high_spender_probability, as: 'high_spender_probability' property :kind, as: 'kind' - property :max_auto_matching_players, as: 'maxAutoMatchingPlayers' - property :min_auto_matching_players, as: 'minAutoMatchingPlayers' - end - end - - class TurnBasedMatch - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :application_id, as: 'applicationId' - property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria, decorator: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria::Representation - - property :creation_details, as: 'creationDetails', class: Google::Apis::GamesV1::TurnBasedMatchModification, decorator: Google::Apis::GamesV1::TurnBasedMatchModification::Representation - - property :data, as: 'data', class: Google::Apis::GamesV1::TurnBasedMatchData, decorator: Google::Apis::GamesV1::TurnBasedMatchData::Representation - - property :description, as: 'description' - property :inviter_id, as: 'inviterId' - property :kind, as: 'kind' - property :last_update_details, as: 'lastUpdateDetails', class: Google::Apis::GamesV1::TurnBasedMatchModification, decorator: Google::Apis::GamesV1::TurnBasedMatchModification::Representation - - property :match_id, as: 'matchId' - property :match_number, as: 'matchNumber' - property :match_version, as: 'matchVersion' - collection :participants, as: 'participants', class: Google::Apis::GamesV1::TurnBasedMatchParticipant, decorator: Google::Apis::GamesV1::TurnBasedMatchParticipant::Representation - - property :pending_participant_id, as: 'pendingParticipantId' - property :previous_match_data, as: 'previousMatchData', class: Google::Apis::GamesV1::TurnBasedMatchData, decorator: Google::Apis::GamesV1::TurnBasedMatchData::Representation - - property :rematch_id, as: 'rematchId' - collection :results, as: 'results', class: Google::Apis::GamesV1::ParticipantResult, decorator: Google::Apis::GamesV1::ParticipantResult::Representation - - property :status, as: 'status' - property :user_match_status, as: 'userMatchStatus' - property :variant, as: 'variant' - property :with_participant_id, as: 'withParticipantId' - end - end - - class CreateTurnBasedMatchRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_matching_criteria, as: 'autoMatchingCriteria', class: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria, decorator: Google::Apis::GamesV1::TurnBasedAutoMatchingCriteria::Representation - - collection :invited_player_ids, as: 'invitedPlayerIds' - property :kind, as: 'kind' - property :request_id, :numeric_string => true, as: 'requestId' - property :variant, as: 'variant' - end - end - - class TurnBasedMatchData - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :data, :base64 => true, as: 'data' - property :data_available, as: 'dataAvailable' - property :kind, as: 'kind' - end - end - - class TurnBasedMatchDataRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :data, :base64 => true, as: 'data' - property :kind, as: 'kind' - end - end - - class TurnBasedMatchList - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - end - end - - class TurnBasedMatchModification - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :modified_timestamp_millis, :numeric_string => true, as: 'modifiedTimestampMillis' - property :participant_id, as: 'participantId' - end - end - - class TurnBasedMatchParticipant - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :auto_matched, as: 'autoMatched' - property :auto_matched_player, as: 'autoMatchedPlayer', class: Google::Apis::GamesV1::AnonymousPlayer, decorator: Google::Apis::GamesV1::AnonymousPlayer::Representation - - property :id, as: 'id' - property :kind, as: 'kind' - property :player, as: 'player', class: Google::Apis::GamesV1::Player, decorator: Google::Apis::GamesV1::Player::Representation - - property :status, as: 'status' - end - end - - class TurnBasedMatchRematch - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :kind, as: 'kind' - property :previous_match, as: 'previousMatch', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation - - property :rematch, as: 'rematch', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation - - end - end - - class TurnBasedMatchResults - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :data, as: 'data', class: Google::Apis::GamesV1::TurnBasedMatchDataRequest, decorator: Google::Apis::GamesV1::TurnBasedMatchDataRequest::Representation - - property :kind, as: 'kind' - property :match_version, as: 'matchVersion' - collection :results, as: 'results', class: Google::Apis::GamesV1::ParticipantResult, decorator: Google::Apis::GamesV1::ParticipantResult::Representation - - end - end - - class TurnBasedMatchSync - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::GamesV1::TurnBasedMatch, decorator: Google::Apis::GamesV1::TurnBasedMatch::Representation - - property :kind, as: 'kind' - property :more_available, as: 'moreAvailable' - property :next_page_token, as: 'nextPageToken' - end - end - - class TurnBasedMatchTurn - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :data, as: 'data', class: Google::Apis::GamesV1::TurnBasedMatchDataRequest, decorator: Google::Apis::GamesV1::TurnBasedMatchDataRequest::Representation - - property :kind, as: 'kind' - property :match_version, as: 'matchVersion' - property :pending_participant_id, as: 'pendingParticipantId' - collection :results, as: 'results', class: Google::Apis::GamesV1::ParticipantResult, decorator: Google::Apis::GamesV1::ParticipantResult::Representation - + property :num_purchases, as: 'num_purchases' + property :num_sessions, as: 'num_sessions' + property :num_sessions_percentile, as: 'num_sessions_percentile' + property :spend_percentile, as: 'spend_percentile' + property :spend_probability, as: 'spend_probability' + property :total_spend_next_28_days, as: 'total_spend_next_28_days' end end end diff --git a/generated/google/apis/games_v1/service.rb b/generated/google/apis/games_v1/service.rb index 5835fbace..d61c75cd1 100644 --- a/generated/google/apis/games_v1/service.rb +++ b/generated/google/apis/games_v1/service.rb @@ -20,9 +20,11 @@ require 'google/apis/errors' module Google module Apis module GamesV1 - # Google Play Game Services API + # Google Play Game Services # - # The API for Google Play Game Services. + # The Google Play games service allows developers to enhance games with social + # leaderboards, + # achievements, game state, sign-in with Google, and more. # # @example # require 'google/apis/games_v1' @@ -30,7 +32,7 @@ module Google # Games = Google::Apis::GamesV1 # Alias the module # service = Games::GamesService.new # - # @see https://developers.google.com/games/services/ + # @see https://developers.google.com/games/ class GamesService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,16 +40,12 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'games/v1/') + super('https://www.googleapis.com/', '') @batch_path = 'batch/games/v1' end @@ -57,16 +55,14 @@ module Google # @param [Fixnum] max_results # The maximum number of achievement resources to return in the response, used # for paging. For any response, the actual number of achievement resources - # returned may be less than the specified maxResults. + # returned may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -79,8 +75,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'achievements', options) + def list_achievement_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/achievements', options) command.response_representation = Google::Apis::GamesV1::ListAchievementDefinitionsResponse::Representation command.response_class = Google::Apis::GamesV1::ListAchievementDefinitionsResponse command.query['language'] = language unless language.nil? @@ -88,7 +84,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -99,16 +94,14 @@ module Google # @param [Fixnum] steps_to_increment # The number of steps to increment. # @param [Fixnum] request_id - # A randomly generated numeric ID for each request specified by the caller. This - # number is used at the server to ensure that the request is handled correctly - # across retries. + # A randomly generated numeric ID for each request specified by the caller. + # This number is used at the server to ensure that the request is handled + # correctly across retries. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -121,8 +114,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/{achievementId}/increment', options) + def increment_achievement(achievement_id, steps_to_increment, request_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/increment', options) command.response_representation = Google::Apis::GamesV1::AchievementIncrementResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementIncrementResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? @@ -130,33 +123,30 @@ module Google command.query['stepsToIncrement'] = steps_to_increment unless steps_to_increment.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Lists the progress for all your application's achievements for the currently - # authenticated player. + # Lists the progress for all your application's achievements for the + # currently authenticated player. # @param [String] player_id - # A player ID. A value of me may be used in place of the authenticated player's - # ID. + # A player ID. A value of `me` may be used in place of the + # authenticated player's ID. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of achievement resources to return in the response, used # for paging. For any response, the actual number of achievement resources - # returned may be less than the specified maxResults. + # returned may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] state - # Tells the server to return only achievements with the specified state. If this - # parameter isn't specified, all achievements are returned. + # Tells the server to return only achievements with the specified state. If + # this parameter isn't specified, all achievements are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -169,8 +159,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'players/{playerId}/achievements', options) + def list_achievements(player_id, language: nil, max_results: nil, page_token: nil, state: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/players/{playerId}/achievements', options) command.response_representation = Google::Apis::GamesV1::ListPlayerAchievementResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerAchievementResponse command.params['playerId'] = player_id unless player_id.nil? @@ -180,21 +170,18 @@ module Google command.query['state'] = state unless state.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Sets the state of the achievement with the given ID to REVEALED for the - # currently authenticated player. + # Sets the state of the achievement with the given ID to + # `REVEALED` for the currently authenticated player. # @param [String] achievement_id # The ID of the achievement used by this method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -207,21 +194,20 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def reveal_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/{achievementId}/reveal', options) + def reveal_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/reveal', options) command.response_representation = Google::Apis::GamesV1::AchievementRevealResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementRevealResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Sets the steps for the currently authenticated player towards unlocking an - # achievement. If the steps parameter is less than the current number of steps - # that the player already gained for the achievement, the achievement is not - # modified. + # achievement. If the steps parameter is less than the current number of + # steps that the player already gained for the achievement, the achievement + # is not modified. # @param [String] achievement_id # The ID of the achievement used by this method. # @param [Fixnum] steps @@ -229,10 +215,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -245,15 +229,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/{achievementId}/setStepsAtLeast', options) + def set_achievement_steps_at_least(achievement_id, steps, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/setStepsAtLeast', options) command.response_representation = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementSetStepsAtLeastResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['steps'] = steps unless steps.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -263,10 +246,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -279,14 +260,13 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def unlock_achievement(achievement_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/{achievementId}/unlock', options) + def unlock_achievement(achievement_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/achievements/{achievementId}/unlock', options) command.response_representation = Google::Apis::GamesV1::AchievementUnlockResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementUnlockResponse command.params['achievementId'] = achievement_id unless achievement_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -295,10 +275,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -311,21 +289,21 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'achievements/updateMultiple', options) + def update_multiple_achievements(achievement_update_multiple_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/achievements/updateMultiple', options) command.request_representation = Google::Apis::GamesV1::AchievementUpdateMultipleRequest::Representation command.request_object = achievement_update_multiple_request_object command.response_representation = Google::Apis::GamesV1::AchievementUpdateMultipleResponse::Representation command.response_class = Google::Apis::GamesV1::AchievementUpdateMultipleResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves the metadata of the application with the given ID. If the requested - # application is not available for the specified platformType, the returned - # response will not include any instance data. + # Retrieves the metadata of the application with the given ID. If the + # requested application is not available for the specified + # `platformType`, the returned response will not include any + # instance data. # @param [String] application_id # The application ID from the Google Play developer console. # @param [String] language @@ -335,10 +313,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -351,8 +327,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'applications/{applicationId}', options) + def get_application(application_id, language: nil, platform_type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/applications/{applicationId}', options) command.response_representation = Google::Apis::GamesV1::Application::Representation command.response_class = Google::Apis::GamesV1::Application command.params['applicationId'] = application_id unless application_id.nil? @@ -360,18 +336,16 @@ module Google command.query['platformType'] = platform_type unless platform_type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Indicate that the the currently authenticated user is playing your application. + # Indicate that the currently authenticated user is playing your + # application. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -384,25 +358,22 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def played_application(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'applications/played', options) + def played_application(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/applications/played', options) command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Verifies the auth token provided with this request is for the application with - # the specified ID, and returns the ID of the player it was granted for. + # Verifies the auth token provided with this request is for the application + # with the specified ID, and returns the ID of the player it was granted for. # @param [String] application_id # The application ID from the Google Play developer console. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -415,34 +386,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def verify_application(application_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'applications/{applicationId}/verify', options) + def verify_application(application_id, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/applications/{applicationId}/verify', options) command.response_representation = Google::Apis::GamesV1::ApplicationVerifyResponse::Representation command.response_class = Google::Apis::GamesV1::ApplicationVerifyResponse command.params['applicationId'] = application_id unless application_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Returns a list showing the current progress on events in this application for - # the currently authenticated user. + # Returns a list showing the current progress on events in this application + # for the currently authenticated user. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results - # The maximum number of events to return in the response, used for paging. For - # any response, the actual number of events to return may be less than the - # specified maxResults. + # The maximum number of events to return in the response, used for paging. + # For any response, the actual number of events to return may be less than + # the specified maxResults. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -455,8 +423,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'events', options) + def list_event_by_player(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/events', options) command.response_representation = Google::Apis::GamesV1::ListPlayerEventResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerEventResponse command.query['language'] = language unless language.nil? @@ -464,7 +432,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -473,17 +440,15 @@ module Google # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of event definitions to return in the response, used for - # paging. For any response, the actual number of event definitions to return may - # be less than the specified maxResults. + # paging. For any response, the actual number of event definitions to return + # may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -496,8 +461,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'eventDefinitions', options) + def list_event_definitions(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/eventDefinitions', options) command.response_representation = Google::Apis::GamesV1::ListEventDefinitionResponse::Representation command.response_class = Google::Apis::GamesV1::ListEventDefinitionResponse command.query['language'] = language unless language.nil? @@ -505,22 +470,19 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Records a batch of changes to the number of times events have occurred for the - # currently authenticated user of this application. + # Records a batch of changes to the number of times events have occurred for + # the currently authenticated user of this application. # @param [Google::Apis::GamesV1::EventRecordRequest] event_record_request_object # @param [String] language # The preferred language to use for strings returned by this method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -533,8 +495,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'events', options) + def record_event(event_record_request_object = nil, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/events', options) command.request_representation = Google::Apis::GamesV1::EventRecordRequest::Representation command.request_object = event_record_request_object command.response_representation = Google::Apis::GamesV1::UpdateEventResponse::Representation @@ -542,7 +504,6 @@ module Google command.query['language'] = language unless language.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -554,10 +515,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -570,15 +529,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'leaderboards/{leaderboardId}', options) + def get_leaderboard(leaderboard_id, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}', options) command.response_representation = Google::Apis::GamesV1::Leaderboard::Representation command.response_class = Google::Apis::GamesV1::Leaderboard command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? command.query['language'] = language unless language.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -586,18 +544,16 @@ module Google # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results - # The maximum number of leaderboards to return in the response. For any response, - # the actual number of leaderboards returned may be less than the specified - # maxResults. + # The maximum number of leaderboards to return in the response. For any + # response, the actual number of leaderboards returned may be less than the + # specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -610,8 +566,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'leaderboards', options) + def list_leaderboards(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/leaderboards', options) command.response_representation = Google::Apis::GamesV1::ListLeaderboardResponse::Representation command.response_class = Google::Apis::GamesV1::ListLeaderboardResponse command.query['language'] = language unless language.nil? @@ -619,7 +575,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -627,10 +582,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -643,38 +596,35 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_metagame_config(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'metagameConfig', options) + def get_metagame_config(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/metagameConfig', options) command.response_representation = Google::Apis::GamesV1::MetagameConfig::Representation command.response_class = Google::Apis::GamesV1::MetagameConfig command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # List play data aggregated per category for the player corresponding to - # playerId. + # `playerId`. # @param [String] player_id - # A player ID. A value of me may be used in place of the authenticated player's - # ID. + # A player ID. A value of `me` may be used in place of the + # authenticated player's ID. # @param [String] collection # The collection of categories for which data will be returned. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results - # The maximum number of category resources to return in the response, used for - # paging. For any response, the actual number of category resources returned may - # be less than the specified maxResults. + # The maximum number of category resources to return in the response, used + # for paging. For any response, the actual number of category resources + # returned may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -687,8 +637,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'players/{playerId}/categories/{collection}', options) + def list_metagame_categories_by_player(player_id, collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/players/{playerId}/categories/{collection}', options) command.response_representation = Google::Apis::GamesV1::ListCategoryResponse::Representation command.response_class = Google::Apis::GamesV1::ListCategoryResponse command.params['playerId'] = player_id unless player_id.nil? @@ -698,24 +648,21 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves the Player resource with the given ID. To retrieve the player for - # the currently authenticated user, set playerId to me. + # Retrieves the Player resource with the given ID. To retrieve the player + # for the currently authenticated user, set `playerId` to `me`. # @param [String] player_id - # A player ID. A value of me may be used in place of the authenticated player's - # ID. + # A player ID. A value of `me` may be used in place of the + # authenticated player's ID. # @param [String] language # The preferred language to use for strings returned by this method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -728,15 +675,14 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_player(player_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'players/{playerId}', options) + def get_player(player_id, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/players/{playerId}', options) command.response_representation = Google::Apis::GamesV1::Player::Representation command.response_class = Google::Apis::GamesV1::Player command.params['playerId'] = player_id unless player_id.nil? command.query['language'] = language unless language.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -747,17 +693,15 @@ module Google # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results # The maximum number of player resources to return in the response, used for - # paging. For any response, the actual number of player resources returned may - # be less than the specified maxResults. + # paging. For any response, the actual number of player resources returned + # may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -770,8 +714,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'players/me/players/{collection}', options) + def list_players(collection, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/players/me/players/{collection}', options) command.response_representation = Google::Apis::GamesV1::ListPlayerResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerResponse command.params['collection'] = collection unless collection.nil? @@ -780,88 +724,21 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Removes a push token for the current user and application. Removing a non- - # existent push token will report success. - # @param [Google::Apis::GamesV1::PushTokenId] push_token_id_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def remove_pushtoken(push_token_id_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'pushtokens/remove', options) - command.request_representation = Google::Apis::GamesV1::PushTokenId::Representation - command.request_object = push_token_id_object - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Registers a push token for the current user and application. - # @param [Google::Apis::GamesV1::PushToken] push_token_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_pushtoken(push_token_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'pushtokens', options) - command.request_representation = Google::Apis::GamesV1::PushToken::Representation - command.request_object = push_token_object - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Checks whether the games client is out of date. # @param [String] client_revision # The revision of the client SDK used by your application. Format: - # [PLATFORM_TYPE]:[VERSION_NUMBER]. Possible values of PLATFORM_TYPE are: - # - # - "ANDROID" - Client is running the Android SDK. - # - "IOS" - Client is running the iOS SDK. - # - "WEB_APP" - Client is running as a Web App. + # `[PLATFORM_TYPE]:[VERSION_NUMBER]`. Possible values of `PLATFORM_TYPE` are: + # * `ANDROID` - Client is running the Android SDK. + # * `IOS` - Client is running the iOS SDK. + # * `WEB_APP` - Client is running as a Web App. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -874,330 +751,27 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def check_revision(client_revision, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'revisions/check', options) + def check_revision(client_revision, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/revisions/check', options) command.response_representation = Google::Apis::GamesV1::CheckRevisionResponse::Representation command.response_class = Google::Apis::GamesV1::CheckRevisionResponse command.query['clientRevision'] = client_revision unless client_revision.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Create a room. For internal use by the Games SDK only. Calling this method - # directly is unsupported. - # @param [Google::Apis::GamesV1::CreateRoomRequest] create_room_request_object - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::Room] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_room(create_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/create', options) - command.request_representation = Google::Apis::GamesV1::CreateRoomRequest::Representation - command.request_object = create_room_request_object - command.response_representation = Google::Apis::GamesV1::Room::Representation - command.response_class = Google::Apis::GamesV1::Room - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Decline an invitation to join a room. For internal use by the Games SDK only. - # Calling this method directly is unsupported. - # @param [String] room_id - # The ID of the room. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::Room] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def decline_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/{roomId}/decline', options) - command.response_representation = Google::Apis::GamesV1::Room::Representation - command.response_class = Google::Apis::GamesV1::Room - command.params['roomId'] = room_id unless room_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Dismiss an invitation to join a room. For internal use by the Games SDK only. - # Calling this method directly is unsupported. - # @param [String] room_id - # The ID of the room. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def dismiss_room(room_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/{roomId}/dismiss', options) - command.params['roomId'] = room_id unless room_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Get the data for a room. - # @param [String] room_id - # The ID of the room. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::Room] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_room(room_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'rooms/{roomId}', options) - command.response_representation = Google::Apis::GamesV1::Room::Representation - command.response_class = Google::Apis::GamesV1::Room - command.params['roomId'] = room_id unless room_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Join a room. For internal use by the Games SDK only. Calling this method - # directly is unsupported. - # @param [String] room_id - # The ID of the room. - # @param [Google::Apis::GamesV1::JoinRoomRequest] join_room_request_object - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::Room] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def join_room(room_id, join_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/{roomId}/join', options) - command.request_representation = Google::Apis::GamesV1::JoinRoomRequest::Representation - command.request_object = join_room_request_object - command.response_representation = Google::Apis::GamesV1::Room::Representation - command.response_class = Google::Apis::GamesV1::Room - command.params['roomId'] = room_id unless room_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Leave a room. For internal use by the Games SDK only. Calling this method - # directly is unsupported. - # @param [String] room_id - # The ID of the room. - # @param [Google::Apis::GamesV1::LeaveRoomRequest] leave_room_request_object - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::Room] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::Room] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def leave_room(room_id, leave_room_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/{roomId}/leave', options) - command.request_representation = Google::Apis::GamesV1::LeaveRoomRequest::Representation - command.request_object = leave_room_request_object - command.response_representation = Google::Apis::GamesV1::Room::Representation - command.response_class = Google::Apis::GamesV1::Room - command.params['roomId'] = room_id unless room_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns invitations to join rooms. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [Fixnum] max_results - # The maximum number of rooms to return in the response, used for paging. For - # any response, the actual number of rooms to return may be less than the - # specified maxResults. - # @param [String] page_token - # The token returned by the previous request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::RoomList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::RoomList] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_rooms(language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'rooms', options) - command.response_representation = Google::Apis::GamesV1::RoomList::Representation - command.response_class = Google::Apis::GamesV1::RoomList - command.query['language'] = language unless language.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates sent by a client reporting the status of peers in a room. For internal - # use by the Games SDK only. Calling this method directly is unsupported. - # @param [String] room_id - # The ID of the room. - # @param [Google::Apis::GamesV1::RoomP2PStatuses] room_p2_p_statuses_object - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::RoomStatus] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::RoomStatus] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def report_room_status(room_id, room_p2_p_statuses_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'rooms/{roomId}/reportstatus', options) - command.request_representation = Google::Apis::GamesV1::RoomP2PStatuses::Representation - command.request_object = room_p2_p_statuses_object - command.response_representation = Google::Apis::GamesV1::RoomStatus::Representation - command.response_class = Google::Apis::GamesV1::RoomStatus - command.params['roomId'] = room_id unless room_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Get high scores, and optionally ranks, in leaderboards for the currently - # authenticated player. For a specific time span, leaderboardId can be set to - # ALL to retrieve data for all leaderboards in a given time span. - # NOTE: You cannot ask for 'ALL' leaderboards and 'ALL' timeSpans in the same - # request; only one parameter may be set to 'ALL'. + # authenticated player. For a specific time span, `leaderboardId` + # can be set to `ALL` to retrieve data for all leaderboards in a + # given time span. `NOTE: You cannot ask for 'ALL' leaderboards and + # 'ALL' timeSpans in the same request; only one parameter may be set to + # 'ALL'. # @param [String] player_id - # A player ID. A value of me may be used in place of the authenticated player's - # ID. + # A player ID. A value of `me` may be used in place of the + # authenticated player's ID. # @param [String] leaderboard_id - # The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all + # The ID of the leaderboard. Can be set to 'ALL' to retrieve data for all # leaderboards for this application. # @param [String] time_span # The time span for the scores and ranks you're requesting. @@ -1207,18 +781,16 @@ module Google # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results - # The maximum number of leaderboard scores to return in the response. For any - # response, the actual number of leaderboard scores returned may be less than - # the specified maxResults. + # The maximum number of leaderboard scores to return in the response. For + # any response, the actual number of leaderboard scores returned may be less + # than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1231,8 +803,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}', options) + def get_score(player_id, leaderboard_id, time_span, include_rank_type: nil, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/players/{playerId}/leaderboards/{leaderboardId}/scores/{timeSpan}', options) command.response_representation = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse::Representation command.response_class = Google::Apis::GamesV1::ListPlayerLeaderboardScoreResponse command.params['playerId'] = player_id unless player_id.nil? @@ -1244,7 +816,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1258,18 +829,16 @@ module Google # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results - # The maximum number of leaderboard scores to return in the response. For any - # response, the actual number of leaderboard scores returned may be less than - # the specified maxResults. + # The maximum number of leaderboard scores to return in the response. For + # any response, the actual number of leaderboard scores returned may be less + # than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1282,8 +851,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'leaderboards/{leaderboardId}/scores/{collection}', options) + def list_scores(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}/scores/{collection}', options) command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation command.response_class = Google::Apis::GamesV1::LeaderboardScores command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? @@ -1294,7 +863,6 @@ module Google command.query['timeSpan'] = time_span unless time_span.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1308,26 +876,24 @@ module Google # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results - # The maximum number of leaderboard scores to return in the response. For any - # response, the actual number of leaderboard scores returned may be less than - # the specified maxResults. + # The maximum number of leaderboard scores to return in the response. For + # any response, the actual number of leaderboard scores returned may be less + # than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [Fixnum] results_above - # The preferred number of scores to return above the player's score. More scores - # may be returned if the player is at the bottom of the leaderboard; fewer may - # be returned if the player is at the top. Must be less than or equal to - # maxResults. + # The preferred number of scores to return above the player's score. More + # scores may be returned if the player is at the bottom of the leaderboard; + # fewer may be returned if the player is at the top. Must be less than or + # equal to maxResults. # @param [Boolean] return_top_if_absent # True if the top scores should be returned when the player is not in the # leaderboard. Defaults to true. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1340,8 +906,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'leaderboards/{leaderboardId}/window/{collection}', options) + def list_score_window(leaderboard_id, collection, time_span, language: nil, max_results: nil, page_token: nil, results_above: nil, return_top_if_absent: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/leaderboards/{leaderboardId}/window/{collection}', options) command.response_representation = Google::Apis::GamesV1::LeaderboardScores::Representation command.response_class = Google::Apis::GamesV1::LeaderboardScores command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? @@ -1354,7 +920,6 @@ module Google command.query['timeSpan'] = time_span unless time_span.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1363,23 +928,22 @@ module Google # The ID of the leaderboard. # @param [Fixnum] score # The score you're submitting. The submitted score is ignored if it is worse - # than a previously submitted score, where worse depends on the leaderboard sort - # order. The meaning of the score value depends on the leaderboard format type. - # For fixed-point, the score represents the raw value. For time, the score - # represents elapsed time in milliseconds. For currency, the score represents a - # value in micro units. + # than a previously submitted score, where worse depends on the leaderboard + # sort order. The meaning of the score value depends on the leaderboard + # format type. For fixed-point, the score represents the raw value. For + # time, the score represents elapsed time in milliseconds. For currency, the + # score represents a value in micro units. # @param [String] language # The preferred language to use for strings returned by this method. # @param [String] score_tag - # Additional information about the score you're submitting. Values must contain - # no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. + # Additional information about the score you're submitting. Values must + # contain no more than 64 URI-safe characters as defined by section 2.3 of + # RFC 3986. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1392,8 +956,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'leaderboards/{leaderboardId}/scores', options) + def submit_score(leaderboard_id, score, language: nil, score_tag: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/leaderboards/{leaderboardId}/scores', options) command.response_representation = Google::Apis::GamesV1::PlayerScoreResponse::Representation command.response_class = Google::Apis::GamesV1::PlayerScoreResponse command.params['leaderboardId'] = leaderboard_id unless leaderboard_id.nil? @@ -1402,7 +966,6 @@ module Google command.query['scoreTag'] = score_tag unless score_tag.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1413,10 +976,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1429,8 +990,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'leaderboards/scores', options) + def submit_score_multiple(player_score_submission_list_object = nil, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'games/v1/leaderboards/scores', options) command.request_representation = Google::Apis::GamesV1::PlayerScoreSubmissionList::Representation command.request_object = player_score_submission_list_object command.response_representation = Google::Apis::GamesV1::ListPlayerScoreResponse::Representation @@ -1438,7 +999,6 @@ module Google command.query['language'] = language unless language.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -1450,10 +1010,8 @@ module Google # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1466,38 +1024,35 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'snapshots/{snapshotId}', options) + def get_snapshot(snapshot_id, language: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/snapshots/{snapshotId}', options) command.response_representation = Google::Apis::GamesV1::Snapshot::Representation command.response_class = Google::Apis::GamesV1::Snapshot command.params['snapshotId'] = snapshot_id unless snapshot_id.nil? command.query['language'] = language unless language.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of snapshots created by your application for the player # corresponding to the player ID. # @param [String] player_id - # A player ID. A value of me may be used in place of the authenticated player's - # ID. + # A player ID. A value of `me` may be used in place of the authenticated + # player's ID. # @param [String] language # The preferred language to use for strings returned by this method. # @param [Fixnum] max_results - # The maximum number of snapshot resources to return in the response, used for - # paging. For any response, the actual number of snapshot resources returned may - # be less than the specified maxResults. + # The maximum number of snapshot resources to return in the response, used + # for paging. For any response, the actual number of snapshot resources + # returned may be less than the specified `maxResults`. # @param [String] page_token # The token returned by the previous request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1510,8 +1065,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'players/{playerId}/snapshots', options) + def list_snapshots(player_id, language: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/players/{playerId}/snapshots', options) command.response_representation = Google::Apis::GamesV1::ListSnapshotResponse::Representation command.response_class = Google::Apis::GamesV1::ListSnapshotResponse command.params['playerId'] = player_id unless player_id.nil? @@ -1520,530 +1075,34 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Cancel a turn-based match. - # @param [String] match_id - # The ID of the match. + # Returns engagement and spend statistics in this application for the + # currently authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::GamesV1::StatsResponse] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::GamesV1::StatsResponse] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/cancel', options) - command.params['matchId'] = match_id unless match_id.nil? + def get_stat(fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'games/v1/stats', options) + command.response_representation = Google::Apis::GamesV1::StatsResponse::Representation + command.response_class = Google::Apis::GamesV1::StatsResponse command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Create a turn-based match. - # @param [Google::Apis::GamesV1::CreateTurnBasedMatchRequest] create_turn_based_match_request_object - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_turn_based_match(create_turn_based_match_request_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'turnbasedmatches/create', options) - command.request_representation = Google::Apis::GamesV1::CreateTurnBasedMatchRequest::Representation - command.request_object = create_turn_based_match_request_object - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Decline an invitation to play a turn-based match. - # @param [String] match_id - # The ID of the match. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def decline_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/decline', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.params['matchId'] = match_id unless match_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Dismiss a turn-based match from the match list. The match will no longer show - # up in the list and will not generate notifications. - # @param [String] match_id - # The ID of the match. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def dismiss_turn_based_match(match_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/dismiss', options) - command.params['matchId'] = match_id unless match_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Finish a turn-based match. Each player should make this call once, after all - # results are in. Only the player whose turn it is may make the first call to - # Finish, and can pass in the final match state. - # @param [String] match_id - # The ID of the match. - # @param [Google::Apis::GamesV1::TurnBasedMatchResults] turn_based_match_results_object - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def finish_turn_based_match(match_id, turn_based_match_results_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/finish', options) - command.request_representation = Google::Apis::GamesV1::TurnBasedMatchResults::Representation - command.request_object = turn_based_match_results_object - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.params['matchId'] = match_id unless match_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Get the data for a turn-based match. - # @param [String] match_id - # The ID of the match. - # @param [Boolean] include_match_data - # Get match data along with metadata. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_turn_based_match(match_id, include_match_data: nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'turnbasedmatches/{matchId}', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.params['matchId'] = match_id unless match_id.nil? - command.query['includeMatchData'] = include_match_data unless include_match_data.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Join a turn-based match. - # @param [String] match_id - # The ID of the match. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def join_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/join', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.params['matchId'] = match_id unless match_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Leave a turn-based match when it is not the current player's turn, without - # canceling the match. - # @param [String] match_id - # The ID of the match. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def leave_turn_based_match(match_id, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leave', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.params['matchId'] = match_id unless match_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Leave a turn-based match during the current player's turn, without canceling - # the match. - # @param [String] match_id - # The ID of the match. - # @param [Fixnum] match_version - # The version of the match being updated. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] pending_participant_id - # The ID of another participant who should take their turn next. If not set, the - # match will wait for other player(s) to join via automatching; this is only - # valid if automatch criteria is set on the match with remaining slots for - # automatched players. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def leave_turn(match_id, match_version, language: nil, pending_participant_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/leaveTurn', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.params['matchId'] = match_id unless match_id.nil? - command.query['language'] = language unless language.nil? - command.query['matchVersion'] = match_version unless match_version.nil? - command.query['pendingParticipantId'] = pending_participant_id unless pending_participant_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns turn-based matches the player is or was involved in. - # @param [Boolean] include_match_data - # True if match data should be returned in the response. Note that not all data - # will necessarily be returned if include_match_data is true; the server may - # decide to only return data for some of the matches to limit download size for - # the client. The remainder of the data for these matches will be retrievable on - # request. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [Fixnum] max_completed_matches - # The maximum number of completed or canceled matches to return in the response. - # If not set, all matches returned could be completed or canceled. - # @param [Fixnum] max_results - # The maximum number of matches to return in the response, used for paging. For - # any response, the actual number of matches to return may be less than the - # specified maxResults. - # @param [String] page_token - # The token returned by the previous request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchList] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatchList] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_turn_based_matches(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'turnbasedmatches', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatchList::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatchList - command.query['includeMatchData'] = include_match_data unless include_match_data.nil? - command.query['language'] = language unless language.nil? - command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Create a rematch of a match that was previously completed, with the same - # participants. This can be called by only one player on a match still in their - # list; the player must have called Finish first. Returns the newly created - # match; it will be the caller's turn. - # @param [String] match_id - # The ID of the match. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [Fixnum] request_id - # A randomly generated numeric ID for each request specified by the caller. This - # number is used at the server to ensure that the request is handled correctly - # across retries. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchRematch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatchRematch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def rematch_turn_based_match(match_id, language: nil, request_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'turnbasedmatches/{matchId}/rematch', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatchRematch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatchRematch - command.params['matchId'] = match_id unless match_id.nil? - command.query['language'] = language unless language.nil? - command.query['requestId'] = request_id unless request_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Returns turn-based matches the player is or was involved in that changed since - # the last sync call, with the least recent changes coming first. Matches that - # should be removed from the local cache will have a status of MATCH_DELETED. - # @param [Boolean] include_match_data - # True if match data should be returned in the response. Note that not all data - # will necessarily be returned if include_match_data is true; the server may - # decide to only return data for some of the matches to limit download size for - # the client. The remainder of the data for these matches will be retrievable on - # request. - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [Fixnum] max_completed_matches - # The maximum number of completed or canceled matches to return in the response. - # If not set, all matches returned could be completed or canceled. - # @param [Fixnum] max_results - # The maximum number of matches to return in the response, used for paging. For - # any response, the actual number of matches to return may be less than the - # specified maxResults. - # @param [String] page_token - # The token returned by the previous request. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatchSync] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatchSync] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def sync_turn_based_match(include_match_data: nil, language: nil, max_completed_matches: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'turnbasedmatches/sync', options) - command.response_representation = Google::Apis::GamesV1::TurnBasedMatchSync::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatchSync - command.query['includeMatchData'] = include_match_data unless include_match_data.nil? - command.query['language'] = language unless language.nil? - command.query['maxCompletedMatches'] = max_completed_matches unless max_completed_matches.nil? - command.query['maxResults'] = max_results unless max_results.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Commit the results of a player turn. - # @param [String] match_id - # The ID of the match. - # @param [Google::Apis::GamesV1::TurnBasedMatchTurn] turn_based_match_turn_object - # @param [String] language - # The preferred language to use for strings returned by this method. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::GamesV1::TurnBasedMatch] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::GamesV1::TurnBasedMatch] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def take_turn(match_id, turn_based_match_turn_object = nil, language: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'turnbasedmatches/{matchId}/turn', options) - command.request_representation = Google::Apis::GamesV1::TurnBasedMatchTurn::Representation - command.request_object = turn_based_match_turn_object - command.response_representation = Google::Apis::GamesV1::TurnBasedMatch::Representation - command.response_class = Google::Apis::GamesV1::TurnBasedMatch - command.params['matchId'] = match_id unless match_id.nil? - command.query['language'] = language unless language.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2052,7 +1111,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/gameservices_v1beta.rb b/generated/google/apis/gameservices_v1beta.rb index 07b108e91..bf8ce6704 100644 --- a/generated/google/apis/gameservices_v1beta.rb +++ b/generated/google/apis/gameservices_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/solutions/gaming/ module GameservicesV1beta VERSION = 'V1beta' - REVISION = '20200507' + REVISION = '20200630' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/gameservices_v1beta/classes.rb b/generated/google/apis/gameservices_v1beta/classes.rb index efbfe5f71..460845146 100644 --- a/generated/google/apis/gameservices_v1beta/classes.rb +++ b/generated/google/apis/gameservices_v1beta/classes.rb @@ -34,7 +34,7 @@ module Google # ` # "audit_configs": [ # ` - # "service": "allServices" + # "service": "allServices", # "audit_log_configs": [ # ` # "log_type": "DATA_READ", @@ -43,18 +43,18 @@ module Google # ] # `, # ` - # "log_type": "DATA_WRITE", + # "log_type": "DATA_WRITE" # `, # ` - # "log_type": "ADMIN_READ", + # "log_type": "ADMIN_READ" # ` # ] # `, # ` - # "service": "sampleservice.googleapis.com" + # "service": "sampleservice.googleapis.com", # "audit_log_configs": [ # ` - # "log_type": "DATA_READ", + # "log_type": "DATA_READ" # `, # ` # "log_type": "DATA_WRITE", @@ -112,7 +112,7 @@ module Google # ] # `, # ` - # "log_type": "DATA_WRITE", + # "log_type": "DATA_WRITE" # ` # ] # ` diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index db91d63f0..bf9d55b70 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -20,12 +20,13 @@ module Google module Apis # YouTube Content ID API # - # API for YouTube partners. To use this API a YouTube CMS account is required. + # The YouTube Content ID API allows the management of YouTube assets along with + # their associated content, references, ownership, rights and policies. # - # @see https://developers.google.com/youtube/partner/ + # @see https://devsite.googleplex.com/youtube/partner/docs/v1/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20200525' + REVISION = '20200706' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner' diff --git a/generated/google/apis/youtube_partner_v1/classes.rb b/generated/google/apis/youtube_partner_v1/classes.rb index aa7c85970..6e0d68e76 100644 --- a/generated/google/apis/youtube_partner_v1/classes.rb +++ b/generated/google/apis/youtube_partner_v1/classes.rb @@ -26,8 +26,8 @@ module Google class AdBreak include Google::Apis::Core::Hashable - # The time of the ad break specified as the number of seconds after the start of - # the video when the break occurs. + # The time of the ad break specified as the number of seconds after the start + # of the video when the break occurs. # Corresponds to the JSON property `midrollSeconds` # @return [Fixnum] attr_accessor :midroll_seconds @@ -48,56 +48,15 @@ module Google end end - # - class AllowedAdvertisingOptions - include Google::Apis::Core::Hashable - - # This setting indicates whether the partner can display ads when videos run in - # an embedded player. - # Corresponds to the JSON property `adsOnEmbeds` - # @return [Boolean] - attr_accessor :ads_on_embeds - alias_method :ads_on_embeds?, :ads_on_embeds - - # This property identifies the resource type. Its value is youtubePartner# - # allowedAdvertisingOptions. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # A list of ad formats that the partner is allowed to use for its uploaded - # videos. - # Corresponds to the JSON property `licAdFormats` - # @return [Array] - attr_accessor :lic_ad_formats - - # A list of ad formats that the partner is allowed to use for claimed, user- - # uploaded content. - # Corresponds to the JSON property `ugcAdFormats` - # @return [Array] - attr_accessor :ugc_ad_formats - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @ads_on_embeds = args[:ads_on_embeds] if args.key?(:ads_on_embeds) - @kind = args[:kind] if args.key?(:kind) - @lic_ad_formats = args[:lic_ad_formats] if args.key?(:lic_ad_formats) - @ugc_ad_formats = args[:ugc_ad_formats] if args.key?(:ugc_ad_formats) - end - end - # class Asset include Google::Apis::Core::Hashable - # A list of asset IDs that can be used to refer to the asset. The list contains - # values if the asset represents multiple constituent assets that have been - # merged. In that case, any of the asset IDs originally assigned to the - # constituent assets could be used to update the master, or synthesized, asset. + # A list of asset IDs that can be used to refer to the asset. The list + # contains values if the asset represents multiple constituent assets that + # have been merged. In that case, any of the asset IDs originally assigned to + # the constituent assets could be used to update the master, or synthesized, + # asset. # Corresponds to the JSON property `aliasId` # @return [Array] attr_accessor :alias_id @@ -107,8 +66,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For asset resources, the value is youtubePartner# - # asset. + # The type of the API resource. For asset resources, the value + # is youtubePartner#asset. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -118,8 +77,9 @@ module Google # @return [Array] attr_accessor :label - # The matchPolicy object contains information about the asset's match policy, - # which YouTube applies to user-uploaded videos that match the asset. + # The matchPolicy object contains information about the asset's + # match policy, which YouTube applies to user-uploaded videos that match the + # asset. # Corresponds to the JSON property `matchPolicy` # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] attr_accessor :match_policy @@ -134,9 +94,9 @@ module Google # @return [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] attr_accessor :match_policy_mine - # The metadata object contains information that identifies and describes the - # asset. This information could be used to search for the asset or to eliminate - # duplication within YouTube's database. + # The metadata object contains information that identifies and + # describes the asset. This information could be used to search for the asset + # or to eliminate duplication within YouTube's database. # Corresponds to the JSON property `metadata` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata @@ -151,15 +111,15 @@ module Google # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata_mine - # The ownership object identifies an asset's owners and provides additional - # details about their ownership, such as the territories where they own the - # asset. + # The ownership object identifies an asset's owners and provides + # additional details about their ownership, such as the territories where + # they own the asset. # Corresponds to the JSON property `ownership` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership - # The ownershipConflicts object contains information about the asset's ownership - # conflicts. + # The ownershipConflicts object contains information about the + # asset's ownership conflicts. # Corresponds to the JSON property `ownershipConflicts` # @return [Google::Apis::YoutubePartnerV1::OwnershipConflicts] attr_accessor :ownership_conflicts @@ -179,15 +139,16 @@ module Google # @return [String] attr_accessor :status - # The date and time the asset was created. The value is specified in RFC 3339 ( - # YYYY-MM-DDThh:mm:ss.000Z) format. + # The date and time the asset was created. The value is specified in RFC 3339 + # (YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` - # @return [DateTime] + # @return [String] attr_accessor :time_created - # The asset's type. This value determines the metadata fields that you can set - # for the asset. In addition, certain API functions may only be supported for - # specific types of assets. For example, composition assets may have more + # The asset's type. This value determines the metadata fields that you can + # set for the asset. In addition, certain API functions may only be supported + # for specific types of assets. For example, composition assets may have more # complex ownership data than other types of assets. # Corresponds to the JSON property `type` # @return [String] @@ -223,8 +184,8 @@ module Google class AssetLabel include Google::Apis::Core::Hashable - # The type of the API resource. For assetLabel resources, this value is - # youtubePartner#assetLabel. + # The type of the API resource. For assetLabel resources, this + # value is youtubePartner#assetLabel. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -249,13 +210,14 @@ module Google class AssetLabelListResponse include Google::Apis::Core::Hashable - # A list of assetLabel resources that match the request criteria. + # A list of assetLabel resources that match the request + # criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # assetLabelList. + # The type of the API response. For this operation, the value is + # youtubePartner#assetLabelList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -275,13 +237,13 @@ module Google class AssetListResponse include Google::Apis::Core::Hashable - # A list of asset resources that match the request criteria. + # A list of asset resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # assetList. + # The type of the API response. For this operation, the value is + # youtubePartner#assetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -301,21 +263,22 @@ module Google class AssetMatchPolicy include Google::Apis::Core::Hashable - # The type of the API resource. Value: youtubePartner#assetMatchPolicy. + # The type of the API resource. Value: + # youtubePartner#assetMatchPolicy. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # A value that uniquely identifies the Policy resource that YouTube applies to - # user-uploaded videos that match the asset. + # A value that uniquely identifies the Policy resource that + # YouTube applies to user-uploaded videos that match the asset. # Corresponds to the JSON property `policyId` # @return [String] attr_accessor :policy_id # A list of rules that collectively define the policy that the content owner # wants to apply to user-uploaded videos that match the asset. Each rule - # specifies the action that YouTube should take and may optionally specify the - # conditions under which that action is enforced. + # specifies the action that YouTube should take and may optionally specify + # the conditions under which that action is enforced. # Corresponds to the JSON property `rules` # @return [Array] attr_accessor :rules @@ -347,8 +310,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For this resource, the value is youtubePartner# - # assetRelationship. + # The type of the API resource. For this resource, the value is + # youtubePartner#assetRelationship. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -375,24 +338,26 @@ module Google class AssetRelationshipListResponse include Google::Apis::Core::Hashable - # A list of assetRelationship resources that match the request criteria. + # A list of assetRelationship resources that match the request + # criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # assetRelationshipList. + # The type of the API response. For this operation, the value is + # youtubePartner#assetRelationshipList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page of results. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -419,19 +384,20 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # assetSnippetList. + # The type of the API response. For this operation, the value is + # youtubePartner#assetSnippetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page of results. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -453,8 +419,8 @@ module Google class AssetShare include Google::Apis::Core::Hashable - # The type of the API resource. For this resource, the value is youtubePartner# - # assetShare. + # The type of the API resource. For this resource, the value is + # youtubePartner#assetShare. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -485,24 +451,25 @@ module Google class AssetShareListResponse include Google::Apis::Core::Hashable - # An assetShare resource that matches the request criteria. + # An assetShare resource that matches the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # assetShareList. + # The type of the API response. For this operation, the value is + # youtubePartner#assetShareList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page of results. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -544,16 +511,17 @@ module Google # @return [String] attr_accessor :iswc - # The type of the API resource. For this operation, the value is youtubePartner# - # assetSnippet. + # The type of the API resource. For this operation, the value is + # youtubePartner#assetSnippet. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The date and time the asset was created. The value is specified in RFC 3339 ( - # YYYY-MM-DDThh:mm:ss.000Z) format. + # The date and time the asset was created. The value is specified in RFC 3339 + # (YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` - # @return [DateTime] + # @return [String] attr_accessor :time_created # Title of this asset. @@ -562,7 +530,7 @@ module Google attr_accessor :title # The asset's type. This value determines which metadata fields might be - # included in the metadata object. + # included in the metadata object. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -584,12 +552,64 @@ module Google end end + # Information to read/write to blobstore2. + class Blobstore2Info + include Google::Apis::Core::Hashable + + # The blob generation id. + # Corresponds to the JSON property `blobGeneration` + # @return [Fixnum] + attr_accessor :blob_generation + + # The blob id, e.g., /blobstore/prod/playground/scotty + # Corresponds to the JSON property `blobId` + # @return [String] + attr_accessor :blob_id + + # Read handle passed from Bigstore -> Scotty for a GCS download. + # This is a signed, serialized blobstore2.ReadHandle proto which must never + # be set outside of Bigstore, and is not applicable to non-GCS media + # downloads. + # Corresponds to the JSON property `downloadReadHandle` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :download_read_handle + + # The blob read token. Needed to read blobs that have not been + # replicated. Might not be available until the final call. + # Corresponds to the JSON property `readToken` + # @return [String] + attr_accessor :read_token + + # Metadata passed from Blobstore -> Scotty for a new GCS upload. + # This is a signed, serialized blobstore2.BlobMetadataContainer proto which + # must never be consumed outside of Bigstore, and is not applicable to + # non-GCS media uploads. + # Corresponds to the JSON property `uploadMetadataContainer` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :upload_metadata_container + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @blob_generation = args[:blob_generation] if args.key?(:blob_generation) + @blob_id = args[:blob_id] if args.key?(:blob_id) + @download_read_handle = args[:download_read_handle] if args.key?(:download_read_handle) + @read_token = args[:read_token] if args.key?(:read_token) + @upload_metadata_container = args[:upload_metadata_container] if args.key?(:upload_metadata_container) + end + end + # class Campaign include Google::Apis::Core::Hashable - # The campaignData object contains details like the campaign's start and end - # dates, target and source. + # The campaignData object contains details like the campaign's + # start and end dates, target and source. # Corresponds to the JSON property `campaignData` # @return [Google::Apis::YoutubePartnerV1::CampaignData] attr_accessor :campaign_data @@ -599,8 +619,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For campaign resources, this value is - # youtubePartner#campaign. + # The type of the API resource. For campaign resources, this + # value is youtubePartner#campaign. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -612,12 +632,12 @@ module Google # The time the campaign was created. # Corresponds to the JSON property `timeCreated` - # @return [DateTime] + # @return [String] attr_accessor :time_created # The time the campaign was last modified. # Corresponds to the JSON property `timeLastModified` - # @return [DateTime] + # @return [String] attr_accessor :time_last_modified def initialize(**args) @@ -639,8 +659,8 @@ module Google class CampaignData include Google::Apis::Core::Hashable - # The campaignSource object contains information about the assets for which the - # campaign will generate links. + # The campaignSource object contains information about the + # assets for which the campaign will generate links. # Corresponds to the JSON property `campaignSource` # @return [Google::Apis::YoutubePartnerV1::CampaignSource] attr_accessor :campaign_source @@ -648,7 +668,7 @@ module Google # The time at which the campaign should expire. Do not specify a value if the # campaign has no expiration time. # Corresponds to the JSON property `expireTime` - # @return [DateTime] + # @return [String] attr_accessor :expire_time # The user-given name of the campaign. @@ -656,8 +676,8 @@ module Google # @return [String] attr_accessor :name - # A list of videos or channels that will be linked to from claimed videos that - # are included in the campaign. + # A list of videos or channels that will be linked to from claimed videos + # that are included in the campaign. # Corresponds to the JSON property `promotedContent` # @return [Array] attr_accessor :promoted_content @@ -665,7 +685,7 @@ module Google # The time at which the campaign should start. Do not specify a value if the # campaign should start immediately. # Corresponds to the JSON property `startTime` - # @return [DateTime] + # @return [String] attr_accessor :start_time def initialize(**args) @@ -691,8 +711,8 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # campaignList. + # The type of the API response. For this operation, the value is + # youtubePartner#campaignList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -762,9 +782,9 @@ module Google class Claim include Google::Apis::Core::Hashable - # The applied policy for the viewing owner on the claim. This might not be the - # same as the final claim policy on the video as it does not consider other - # partners' policy of the same claim. + # The applied policy for the viewing owner on the claim. This might not be + # the same as the final claim policy on the video as it does not consider + # other partners' policy of the same claim. # Corresponds to the JSON property `appliedPolicy` # @return [Google::Apis::YoutubePartnerV1::Policy] attr_accessor :applied_policy @@ -782,8 +802,8 @@ module Google attr_accessor :block_outside_ownership alias_method :block_outside_ownership?, :block_outside_ownership - # This value indicates whether the claim covers the audio, video, or audiovisual - # portion of the claimed content. + # This value indicates whether the claim covers the audio, video, or + # audiovisual portion of the claimed content. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -799,21 +819,21 @@ module Google attr_accessor :is_partner_uploaded alias_method :is_partner_uploaded?, :is_partner_uploaded - # The type of the API resource. For claim resources, this value is - # youtubePartner#claim. + # The type of the API resource. For claim resources, this value + # is youtubePartner#claim. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # If this claim was auto-generated based on a provided reference, this section - # will provide details of the match that generated the claim. + # If this claim was auto-generated based on a provided reference, this + # section will provide details of the match that generated the claim. # Corresponds to the JSON property `matchInfo` - # @return [Google::Apis::YoutubePartnerV1::Claim::MatchInfo] + # @return [Google::Apis::YoutubePartnerV1::MatchInfo] attr_accessor :match_info # # Corresponds to the JSON property `origin` - # @return [Google::Apis::YoutubePartnerV1::Claim::Origin] + # @return [Google::Apis::YoutubePartnerV1::Origin] attr_accessor :origin # The policy provided by the viewing owner on the claim. @@ -822,15 +842,15 @@ module Google attr_accessor :policy # The claim's status. When updating a claim, you can update its status from - # active to inactive to effectively release the claim, but the API does not - # support other updates to a claim's status. + # active to inactive to effectively release the + # claim, but the API does not support other updates to a claim's status. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status # The time the claim was created. # Corresponds to the JSON property `timeCreated` - # @return [DateTime] + # @return [String] attr_accessor :time_created # The unique YouTube video ID that identifies the video associated with the @@ -859,138 +879,14 @@ module Google @time_created = args[:time_created] if args.key?(:time_created) @video_id = args[:video_id] if args.key?(:video_id) end - - # If this claim was auto-generated based on a provided reference, this section - # will provide details of the match that generated the claim. - class MatchInfo - include Google::Apis::Core::Hashable - - # Details of the longest match between the reference and the user video. - # Corresponds to the JSON property `longestMatch` - # @return [Google::Apis::YoutubePartnerV1::Claim::MatchInfo::LongestMatch] - attr_accessor :longest_match - - # Details about each match segment. Each item in the list contains information - # about one match segment associated with the claim. It is possible to have - # multiple match segments. For example, if the audio and video content of an - # uploaded video match that of a reference video, there would be two match - # segments. One segment would describe the audio match and the other would - # describe the video match. - # Corresponds to the JSON property `matchSegments` - # @return [Array] - attr_accessor :match_segments - - # The reference ID that generated this match. - # Corresponds to the JSON property `referenceId` - # @return [String] - attr_accessor :reference_id - - # Details of the total amount of reference and user video content which matched - # each other. Note these two values may differ if either the reference or the - # user video contains a loop. - # Corresponds to the JSON property `totalMatch` - # @return [Google::Apis::YoutubePartnerV1::Claim::MatchInfo::TotalMatch] - attr_accessor :total_match - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @longest_match = args[:longest_match] if args.key?(:longest_match) - @match_segments = args[:match_segments] if args.key?(:match_segments) - @reference_id = args[:reference_id] if args.key?(:reference_id) - @total_match = args[:total_match] if args.key?(:total_match) - end - - # Details of the longest match between the reference and the user video. - class LongestMatch - include Google::Apis::Core::Hashable - - # The duration of the longest match between the reference and the user video. - # Corresponds to the JSON property `durationSecs` - # @return [Fixnum] - attr_accessor :duration_secs - - # The offset in seconds into the reference at which the longest match began. - # Corresponds to the JSON property `referenceOffset` - # @return [Fixnum] - attr_accessor :reference_offset - - # The offset in seconds into the user video at which the longest match began. - # Corresponds to the JSON property `userVideoOffset` - # @return [Fixnum] - attr_accessor :user_video_offset - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration_secs = args[:duration_secs] if args.key?(:duration_secs) - @reference_offset = args[:reference_offset] if args.key?(:reference_offset) - @user_video_offset = args[:user_video_offset] if args.key?(:user_video_offset) - end - end - - # Details of the total amount of reference and user video content which matched - # each other. Note these two values may differ if either the reference or the - # user video contains a loop. - class TotalMatch - include Google::Apis::Core::Hashable - - # The total amount of content in the reference which matched the user video in - # seconds. - # Corresponds to the JSON property `referenceDurationSecs` - # @return [Fixnum] - attr_accessor :reference_duration_secs - - # The total amount of content in the user video which matched the reference in - # seconds. - # Corresponds to the JSON property `userVideoDurationSecs` - # @return [Fixnum] - attr_accessor :user_video_duration_secs - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @reference_duration_secs = args[:reference_duration_secs] if args.key?(:reference_duration_secs) - @user_video_duration_secs = args[:user_video_duration_secs] if args.key?(:user_video_duration_secs) - end - end - end - - # - class Origin - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `source` - # @return [String] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @source = args[:source] if args.key?(:source) - end - end end # class ClaimEvent include Google::Apis::Core::Hashable - # The type of the API resource. For claimEvent resources, this value is - # youtubePartner#claimEvent. + # The type of the API resource. For claimEvent resources, this + # value is youtubePartner#claimEvent. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1002,12 +898,12 @@ module Google # Data related to source of the event. # Corresponds to the JSON property `source` - # @return [Google::Apis::YoutubePartnerV1::ClaimEvent::Source] + # @return [Google::Apis::YoutubePartnerV1::Source] attr_accessor :source # The time when the event occurred. # Corresponds to the JSON property `time` - # @return [DateTime] + # @return [String] attr_accessor :time # Type of the event. @@ -1017,7 +913,7 @@ module Google # Details of event's type. # Corresponds to the JSON property `typeDetails` - # @return [Google::Apis::YoutubePartnerV1::ClaimEvent::TypeDetails] + # @return [Google::Apis::YoutubePartnerV1::TypeDetails] attr_accessor :type_details def initialize(**args) @@ -1033,74 +929,6 @@ module Google @type = args[:type] if args.key?(:type) @type_details = args[:type_details] if args.key?(:type_details) end - - # Data related to source of the event. - class Source - include Google::Apis::Core::Hashable - - # Id of content owner that initiated the event. - # Corresponds to the JSON property `contentOwnerId` - # @return [String] - attr_accessor :content_owner_id - - # Type of the event source. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Email of user who initiated the event. - # Corresponds to the JSON property `userEmail` - # @return [String] - attr_accessor :user_email - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @content_owner_id = args[:content_owner_id] if args.key?(:content_owner_id) - @type = args[:type] if args.key?(:type) - @user_email = args[:user_email] if args.key?(:user_email) - end - end - - # Details of event's type. - class TypeDetails - include Google::Apis::Core::Hashable - - # Appeal explanations for dispute_appeal event. - # Corresponds to the JSON property `appealExplanation` - # @return [String] - attr_accessor :appeal_explanation - - # Dispute notes for dispute_create events. - # Corresponds to the JSON property `disputeNotes` - # @return [String] - attr_accessor :dispute_notes - - # Dispute reason for dispute_create and dispute_appeal events. - # Corresponds to the JSON property `disputeReason` - # @return [String] - attr_accessor :dispute_reason - - # Status that was a result of update for claim_update event. - # Corresponds to the JSON property `updateStatus` - # @return [String] - attr_accessor :update_status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @appeal_explanation = args[:appeal_explanation] if args.key?(:appeal_explanation) - @dispute_notes = args[:dispute_notes] if args.key?(:dispute_notes) - @dispute_reason = args[:dispute_reason] if args.key?(:dispute_reason) - @update_status = args[:update_status] if args.key?(:update_status) - end - end end # @@ -1117,8 +945,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For claimHistory resources, this value is - # youtubePartner#claimHistory. + # The type of the API resource. For claimHistory resources, this + # value is youtubePartner#claimHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1150,25 +978,26 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # claimList. + # The type of the API response. For this operation, the value is + # youtubePartner#claimList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page in the result set. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken parameter to retrieve - # the previous page in the result set. + # The token that can be used as the value of the pageToken + # parameter to retrieve the previous page in the result set. # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token @@ -1196,25 +1025,26 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # claimSnippetList. + # The type of the API response. For this operation, the value is + # youtubePartner#claimSnippetList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page in the result set. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info - # The token that can be used as the value of the pageToken parameter to retrieve - # the previous page in the result set. + # The token that can be used as the value of the pageToken + # parameter to retrieve the previous page in the result set. # Corresponds to the JSON property `previousPageToken` # @return [String] attr_accessor :previous_page_token @@ -1243,8 +1073,8 @@ module Google # @return [String] attr_accessor :asset_id - # This value indicates whether the claim covers the audio, video, or audiovisual - # portion of the claimed content. + # This value indicates whether the claim covers the audio, video, or + # audiovisual portion of the claimed content. # Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -1260,15 +1090,15 @@ module Google attr_accessor :is_partner_uploaded alias_method :is_partner_uploaded?, :is_partner_uploaded - # The type of the API resource. For this operation, the value is youtubePartner# - # claimSnippet. + # The type of the API resource. For this operation, the value is + # youtubePartner#claimSnippet. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # # Corresponds to the JSON property `origin` - # @return [Google::Apis::YoutubePartnerV1::ClaimSnippet::Origin] + # @return [Google::Apis::YoutubePartnerV1::YoutubePartnerApiProtoFrontendV1Origin] attr_accessor :origin # The claim's status. @@ -1284,12 +1114,12 @@ module Google # The time the claim was created. # Corresponds to the JSON property `timeCreated` - # @return [DateTime] + # @return [String] attr_accessor :time_created # The time the claim status and/or status detail was last modified. # Corresponds to the JSON property `timeStatusLastModified` - # @return [DateTime] + # @return [String] attr_accessor :time_status_last_modified # The unique YouTube video ID that identifies the video associated with the @@ -1328,59 +1158,84 @@ module Google @video_title = args[:video_title] if args.key?(:video_title) @video_views = args[:video_views] if args.key?(:video_views) end - - # - class Origin - include Google::Apis::Core::Hashable - - # - # Corresponds to the JSON property `source` - # @return [String] - attr_accessor :source - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @source = args[:source] if args.key?(:source) - end - end end - # - class ClaimedVideoDefaults + # A sequence of media data references representing composite data. + # Introduced to support Bigstore composite objects. For details, visit + # http://go/bigstore-composites. + class CompositeMedia include Google::Apis::Core::Hashable - # Set this property to true to enable automatically generated breaks for a newly - # claimed video longer than 10 minutes. The first partner that claims the video - # sets its default advertising options to that video. claimedVideoOptions. - # auto_generated_breaks_default - # Corresponds to the JSON property `autoGeneratedBreaks` - # @return [Boolean] - attr_accessor :auto_generated_breaks - alias_method :auto_generated_breaks?, :auto_generated_breaks - - # Set this property to true to indicate that the channel's claimedVideoOptions - # can override the content owner's claimedVideoOptions. - # Corresponds to the JSON property `channelOverride` - # @return [Boolean] - attr_accessor :channel_override - alias_method :channel_override?, :channel_override - - # Identifies this resource as default options for newly claimed video. Value: " - # youtubePartner#claimedVideoDefaults". - # Corresponds to the JSON property `kind` + # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF + # This should be the byte representation of a blobstore.BlobRef. + # Since Blobstore is deprecating v1, use blobstore2_info instead. + # For now, any v2 blob will also be represented in this field as + # v1 BlobRef. + # Corresponds to the JSON property `blobRef` + # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] - attr_accessor :kind + attr_accessor :blob_ref - # A list of ad formats that could be used as the default settings for a newly - # claimed video. The first partner that claims the video sets its default - # advertising options to that video. - # Corresponds to the JSON property `newVideoDefaults` - # @return [Array] - attr_accessor :new_video_defaults + # Information to read/write to blobstore2. + # Corresponds to the JSON property `blobstore2Info` + # @return [Google::Apis::YoutubePartnerV1::Blobstore2Info] + attr_accessor :blobstore2_info + + # A binary data reference for a media download. Serves as a + # technology-agnostic binary reference in some Google infrastructure. + # This value is a serialized storage_cosmo.BinaryReference proto. Storing + # it as bytes is a hack to get around the fact that the cosmo proto + # (as well as others it includes) doesn't support JavaScript. This + # prevents us from including the actual type of this field. + # Corresponds to the JSON property `cosmoBinaryReference` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :cosmo_binary_reference + + # crc32.c hash for the payload. + # Corresponds to the JSON property `crc32cHash` + # @return [Fixnum] + attr_accessor :crc32c_hash + + # Media data, set if reference_type is INLINE + # Corresponds to the JSON property `inline` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :inline + + # Size of the data, in bytes + # Corresponds to the JSON property `length` + # @return [Fixnum] + attr_accessor :length + + # MD5 hash for the payload. + # Corresponds to the JSON property `md5Hash` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :md5_hash + + # This is a copy of the tech.blob.ObjectId proto, which could not + # be used directly here due to transitive closure issues with + # JavaScript support; see http://b/8801763. + # Corresponds to the JSON property `objectId` + # @return [Google::Apis::YoutubePartnerV1::ObjectIdProp] + attr_accessor :object_id_prop + + # Path to the data, set if reference_type is PATH + # Corresponds to the JSON property `path` + # @return [String] + attr_accessor :path + + # Describes what the field reference contains. + # Corresponds to the JSON property `referenceType` + # @return [String] + attr_accessor :reference_type + + # SHA-1 hash for the payload. + # Corresponds to the JSON property `sha1Hash` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :sha1_hash def initialize(**args) update!(**args) @@ -1388,10 +1243,17 @@ module Google # Update properties of this object def update!(**args) - @auto_generated_breaks = args[:auto_generated_breaks] if args.key?(:auto_generated_breaks) - @channel_override = args[:channel_override] if args.key?(:channel_override) - @kind = args[:kind] if args.key?(:kind) - @new_video_defaults = args[:new_video_defaults] if args.key?(:new_video_defaults) + @blob_ref = args[:blob_ref] if args.key?(:blob_ref) + @blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info) + @cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference) + @crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash) + @inline = args[:inline] if args.key?(:inline) + @length = args[:length] if args.key?(:length) + @md5_hash = args[:md5_hash] if args.key?(:md5_hash) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + @path = args[:path] if args.key?(:path) + @reference_type = args[:reference_type] if args.key?(:reference_type) + @sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash) end end @@ -1399,9 +1261,9 @@ module Google class Conditions include Google::Apis::Core::Hashable - # This match condition specifies whether the user- or partner-uploaded content - # needs to match the audio, video or audiovisual content of a reference file for - # the rule to apply. + # This match condition specifies whether the user- or partner-uploaded + # content needs to match the audio, video or audiovisual content of a + # reference file for the rule to apply. # Corresponds to the JSON property `contentMatchType` # @return [Array] attr_accessor :content_match_type @@ -1412,27 +1274,29 @@ module Google # @return [Array] attr_accessor :match_duration - # This match condition specifies a percentage of the user- or partner-uploaded - # content that needs to match a reference file for the rule to apply. + # This match condition specifies a percentage of the user- or + # partner-uploaded content that needs to match a reference file for the rule + # to apply. # Corresponds to the JSON property `matchPercent` # @return [Array] attr_accessor :match_percent - # This match condition indicates that the reference must be a certain duration - # for the rule to apply. + # This match condition indicates that the reference must be a certain + # duration for the rule to apply. # Corresponds to the JSON property `referenceDuration` # @return [Array] attr_accessor :reference_duration # This match condition indicates that the specified percentage of a reference - # file must match the user- or partner-uploaded content for the rule to apply. + # file must match the user- or partner-uploaded content for the rule to + # apply. # Corresponds to the JSON property `referencePercent` # @return [Array] attr_accessor :reference_percent - # This watch condition specifies where users are (or or not) allowed to watch ( - # or listen to) an asset. YouTube determines whether the condition is satisfied - # based on the user's location. + # This watch condition specifies where users are (or or not) allowed to watch + # (or listen to) an asset. YouTube determines whether the condition is + # satisfied based on the user's location. # Corresponds to the JSON property `requiredTerritories` # @return [Google::Apis::YoutubePartnerV1::TerritoryCondition] attr_accessor :required_territories @@ -1492,8 +1356,8 @@ module Google # @return [String] attr_accessor :display_name - # The email address(es) to which YouTube sends claim dispute notifications and - # possible claim notifications. + # The email address(es) to which YouTube sends claim dispute notifications + # and possible claim notifications. # Corresponds to the JSON property `disputeNotificationEmails` # @return [Array] attr_accessor :dispute_notification_emails @@ -1509,7 +1373,7 @@ module Google attr_accessor :id # The type of the API resource. For content owner resources, the value is - # youtubePartner#contentOwner. + # youtubePartner#contentOwner. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1536,45 +1400,6 @@ module Google end end - # - class ContentOwnerAdvertisingOption - include Google::Apis::Core::Hashable - - # This object identifies the ad formats that the content owner is allowed to use. - # Corresponds to the JSON property `allowedOptions` - # @return [Google::Apis::YoutubePartnerV1::AllowedAdvertisingOptions] - attr_accessor :allowed_options - - # This object identifies the advertising options used by default for the content - # owner's newly claimed videos. - # Corresponds to the JSON property `claimedVideoOptions` - # @return [Google::Apis::YoutubePartnerV1::ClaimedVideoDefaults] - attr_accessor :claimed_video_options - - # The value that YouTube uses to uniquely identify the content owner. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # The type of the API resource. For this resource, the value is youtubePartner# - # contentOwnerAdvertisingOption. - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @allowed_options = args[:allowed_options] if args.key?(:allowed_options) - @claimed_video_options = args[:claimed_video_options] if args.key?(:claimed_video_options) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - end - end - # class ContentOwnerListResponse include Google::Apis::Core::Hashable @@ -1584,8 +1409,8 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # contentOwnerList. + # The type of the API response. For this operation, the value is + # youtubePartner#contentOwnerList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -1601,6 +1426,58 @@ module Google end end + # Detailed Content-Type information from Scotty. The Content-Type of the media + # will typically be filled in by the header or Scotty's best_guess, but this + # extended information provides the backend with more information so that it + # can make a better decision if needed. This is only used on media upload + # requests from Scotty. + class ContentTypeInfo + include Google::Apis::Core::Hashable + + # Scotty's best guess of what the content type of the file is. + # Corresponds to the JSON property `bestGuess` + # @return [String] + attr_accessor :best_guess + + # The content type of the file derived by looking at specific + # bytes (i.e. "magic bytes") of the actual file. + # Corresponds to the JSON property `fromBytes` + # @return [String] + attr_accessor :from_bytes + + # The content type of the file derived from the file extension of + # the original file name used by the client. + # Corresponds to the JSON property `fromFileName` + # @return [String] + attr_accessor :from_file_name + + # The content type of the file as specified in the request headers, + # multipart headers, or RUPIO start request. + # Corresponds to the JSON property `fromHeader` + # @return [String] + attr_accessor :from_header + + # The content type of the file derived from the file extension of the + # URL path. The URL path is assumed to represent a file name (which + # is typically only true for agents that are providing a REST API). + # Corresponds to the JSON property `fromUrlPath` + # @return [String] + attr_accessor :from_url_path + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @best_guess = args[:best_guess] if args.key?(:best_guess) + @from_bytes = args[:from_bytes] if args.key?(:from_bytes) + @from_file_name = args[:from_file_name] if args.key?(:from_file_name) + @from_header = args[:from_header] if args.key?(:from_header) + @from_url_path = args[:from_url_path] if args.key?(:from_url_path) + end + end + # class CountriesRestriction include Google::Apis::Core::Hashable @@ -1610,8 +1487,11 @@ module Google # @return [Array] attr_accessor :ad_formats - # A list of ISO 3166-1 alpha-2 country codes that identify the countries where - # ads are enabled. + # A list of ISO + # 3166-1 alpha-2 country codes that identify the countries where ads are + # enabled. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories @@ -1631,40 +1511,52 @@ module Google class CuepointSettings include Google::Apis::Core::Hashable - # The cuepoint's type. See the Getting started guide for an explanation of the - # different types of cuepoints. Also see the Life of a broadcast document for - # best practices about inserting cuepoints during your broadcast. + # The cuepoint's type. See the Getting + # started guide for an explanation of the different types of cuepoints. + # Also see the Life of a + # broadcast document for best practices about inserting cuepoints during + # your broadcast. # Corresponds to the JSON property `cueType` # @return [String] attr_accessor :cue_type # The cuepoint's duration, in seconds. This value must be specified if the - # cueType is ad and is ignored otherwise. + # cueType is ad and is + # ignored otherwise. # Corresponds to the JSON property `durationSecs` # @return [Fixnum] attr_accessor :duration_secs - # This value specifies a point in time in the video when viewers should see an - # ad or in-stream slate. The property value identifies a time offset, in - # milliseconds, from the beginning of the monitor stream. Though measured in - # milliseconds, the value is actually an approximation, and YouTube will insert - # the cuepoint as closely as possible to that time. You should not specify a - # value for this parameter if your broadcast does not have a monitor stream. - # This property's default value is 0, which indicates that the cuepoint should - # be inserted as soon as possible. If your broadcast stream is not delayed, then - # 0 is also the only valid value. However, if your broadcast stream is delayed, - # then the property value can specify the time when the cuepoint should be - # inserted. See the Getting started guide for more details. - # Note: If your broadcast had a testing phase, the offset is measured from the - # time that the testing phase began. + # This value specifies a point in time in the video when viewers should see + # an ad or in-stream + # slate. The property value identifies a time offset, in milliseconds, + # from the beginning of the monitor stream. Though measured in milliseconds, + # the value is actually an approximation, and YouTube will insert the + # cuepoint as closely as possible to that time. You should not specify a + # value for this parameter if your broadcast does not have a monitor + # stream.

This + # property's default value is 0, which indicates that the + # cuepoint should be inserted as soon as possible. If your broadcast stream + # is not delayed, then 0 is also the only valid value. However, + # if your broadcast stream is delayed, then the property value can specify + # the time when the cuepoint should be inserted. See the Getting + # started guide for more details.

Note: If your + # broadcast had a testing phase, the offset is measured from the time that + # the testing phase began. # Corresponds to the JSON property `offsetTimeMs` # @return [Fixnum] attr_accessor :offset_time_ms # This value specifies the wall clock time at which the cuepoint should be - # inserted. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. + # inserted. The value is specified in ISO 8601 + # (YYYY-MM-DDThh:mm:ss.sssZ) format. # Corresponds to the JSON property `walltime` - # @return [DateTime] + # @return [String] attr_accessor :walltime def initialize(**args) @@ -1684,13 +1576,14 @@ module Google class Date include Google::Apis::Core::Hashable - # The date's day. The value should be an integer between 1 and 31. Note that - # some day-month combinations are not valid. + # The date's day. The value should be an integer between 1 and + # 31. Note that some day-month combinations are not valid. # Corresponds to the JSON property `day` # @return [Fixnum] attr_accessor :day - # The date's month. The value should be an integer between 1 and 12. + # The date's month. The value should be an integer between 1 and + # 12. # Corresponds to the JSON property `month` # @return [Fixnum] attr_accessor :month @@ -1712,26 +1605,216 @@ module Google end end - # - class DateRange + # Backend response for a Diff get checksums response. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + class DiffChecksumsResponse include Google::Apis::Core::Hashable - # The end date (inclusive) for the date range. This value is required for video- - # on-demand (VOD) orders and optional for electronic sell-through (EST) orders. - # Corresponds to the JSON property `end` - # @return [Google::Apis::YoutubePartnerV1::Date] - attr_accessor :end + # A sequence of media data references representing composite data. + # Introduced to support Bigstore composite objects. For details, visit + # http://go/bigstore-composites. + # Corresponds to the JSON property `checksumsLocation` + # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] + attr_accessor :checksums_location - # Identifies this resource as order date range. Value: "youtubePartner#dateRange" - # . - # Corresponds to the JSON property `kind` + # The chunk size of checksums. Must be a multiple of 256KB. + # Corresponds to the JSON property `chunkSizeBytes` + # @return [Fixnum] + attr_accessor :chunk_size_bytes + + # A sequence of media data references representing composite data. + # Introduced to support Bigstore composite objects. For details, visit + # http://go/bigstore-composites. + # Corresponds to the JSON property `objectLocation` + # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] + attr_accessor :object_location + + # The total size of the server object. + # Corresponds to the JSON property `objectSizeBytes` + # @return [Fixnum] + attr_accessor :object_size_bytes + + # The object version of the object the checksums are being returned for. + # Corresponds to the JSON property `objectVersion` # @return [String] - attr_accessor :kind - - # The start date for the date range. This value is required for all date ranges. - # Corresponds to the JSON property `start` - # @return [Google::Apis::YoutubePartnerV1::Date] - attr_accessor :start + attr_accessor :object_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @checksums_location = args[:checksums_location] if args.key?(:checksums_location) + @chunk_size_bytes = args[:chunk_size_bytes] if args.key?(:chunk_size_bytes) + @object_location = args[:object_location] if args.key?(:object_location) + @object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes) + @object_version = args[:object_version] if args.key?(:object_version) + end + end + + # Backend response for a Diff download response. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + class DiffDownloadResponse + include Google::Apis::Core::Hashable + + # A sequence of media data references representing composite data. + # Introduced to support Bigstore composite objects. For details, visit + # http://go/bigstore-composites. + # Corresponds to the JSON property `objectLocation` + # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] + attr_accessor :object_location + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @object_location = args[:object_location] if args.key?(:object_location) + end + end + + # A Diff upload request. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + class DiffUploadRequest + include Google::Apis::Core::Hashable + + # A sequence of media data references representing composite data. + # Introduced to support Bigstore composite objects. For details, visit + # http://go/bigstore-composites. + # Corresponds to the JSON property `checksumsInfo` + # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] + attr_accessor :checksums_info + + # A sequence of media data references representing composite data. + # Introduced to support Bigstore composite objects. For details, visit + # http://go/bigstore-composites. + # Corresponds to the JSON property `objectInfo` + # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] + attr_accessor :object_info + + # The object version of the object that is the base version the incoming + # diff script will be applied to. + # This field will always be filled in. + # Corresponds to the JSON property `objectVersion` + # @return [String] + attr_accessor :object_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @checksums_info = args[:checksums_info] if args.key?(:checksums_info) + @object_info = args[:object_info] if args.key?(:object_info) + @object_version = args[:object_version] if args.key?(:object_version) + end + end + + # Backend response for a Diff upload request. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + class DiffUploadResponse + include Google::Apis::Core::Hashable + + # The object version of the object at the server. Must be included in the + # end notification response. + # The version in the end notification response must correspond to the new + # version of the object that is now stored at the server, after the upload. + # Corresponds to the JSON property `objectVersion` + # @return [String] + attr_accessor :object_version + + # A sequence of media data references representing composite data. + # Introduced to support Bigstore composite objects. For details, visit + # http://go/bigstore-composites. + # Corresponds to the JSON property `originalObject` + # @return [Google::Apis::YoutubePartnerV1::CompositeMedia] + attr_accessor :original_object + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @object_version = args[:object_version] if args.key?(:object_version) + @original_object = args[:original_object] if args.key?(:original_object) + end + end + + # Backend response for a Diff get version response. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + class DiffVersionResponse + include Google::Apis::Core::Hashable + + # The total size of the server object. + # Corresponds to the JSON property `objectSizeBytes` + # @return [Fixnum] + attr_accessor :object_size_bytes + + # The version of the object stored at the server. + # Corresponds to the JSON property `objectVersion` + # @return [String] + attr_accessor :object_version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @object_size_bytes = args[:object_size_bytes] if args.key?(:object_size_bytes) + @object_version = args[:object_version] if args.key?(:object_version) + end + end + + # Parameters specific to media downloads. + class DownloadParameters + include Google::Apis::Core::Hashable + + # A boolean to be returned in the response to Scotty. Allows/disallows gzip + # encoding of the payload content when the server thinks it's + # advantageous (hence, does not guarantee compression) which allows + # Scotty to GZip the response to the client. + # Corresponds to the JSON property `allowGzipCompression` + # @return [Boolean] + attr_accessor :allow_gzip_compression + alias_method :allow_gzip_compression?, :allow_gzip_compression + + # Determining whether or not Apiary should skip the inclusion + # of any Content-Range header on its response to Scotty. + # Corresponds to the JSON property `ignoreRange` + # @return [Boolean] + attr_accessor :ignore_range + alias_method :ignore_range?, :ignore_range + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_gzip_compression = args[:allow_gzip_compression] if args.key?(:allow_gzip_compression) + @ignore_range = args[:ignore_range] if args.key?(:ignore_range) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable def initialize(**args) update!(**args) @@ -1739,9 +1822,6 @@ module Google # Update properties of this object def update!(**args) - @end = args[:end] if args.key?(:end) - @kind = args[:kind] if args.key?(:kind) - @start = args[:start] if args.key?(:start) end end @@ -1749,16 +1829,18 @@ module Google class ExcludedInterval include Google::Apis::Core::Hashable - # The end (inclusive) time in seconds of the time window. The value can be any - # value greater than low. If high is greater than the length of the reference, - # the interval between low and the end of the reference will be excluded. Every - # interval must specify a value for this field. + # The end (inclusive) time in seconds of the time window. The value can be + # any value greater than low. If high is greater + # than the length of the reference, the interval between low and + # the end of the reference will be excluded. Every interval must specify a + # value for this field. # Corresponds to the JSON property `high` # @return [Float] attr_accessor :high - # The start (inclusive) time in seconds of the time window. The value can be any - # value between 0 and high. Every interval must specify a value for this field. + # The start (inclusive) time in seconds of the time window. The value can be + # any value between 0 and high. Every interval must + # specify a value for this field. # Corresponds to the JSON property `low` # @return [Float] attr_accessor :low @@ -1769,9 +1851,10 @@ module Google attr_accessor :origin # The date and time that the exclusion was created. The value is specified in - # RFC 3339 (YYYY-MM-DDThh:mm:ss.000Z) format. + # RFC 3339 + # (YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` - # @return [DateTime] + # @return [String] attr_accessor :time_created def initialize(**args) @@ -1791,14 +1874,14 @@ module Google class IntervalCondition include Google::Apis::Core::Hashable - # The maximum (inclusive) allowed value for the condition to be satisfied. The - # default value is ∞. + # The maximum (inclusive) allowed value for the condition to be satisfied. + # The default value is ∞. # Corresponds to the JSON property `high` # @return [Float] attr_accessor :high - # The minimum (inclusive) allowed value for the condition to be satisfied. The - # default value is -∞. + # The minimum (inclusive) allowed value for the condition to be satisfied. + # The default value is -∞. # Corresponds to the JSON property `low` # @return [Float] attr_accessor :low @@ -1818,8 +1901,8 @@ module Google class LiveCuepoint include Google::Apis::Core::Hashable - # The ID that YouTube assigns to uniquely identify the broadcast into which the - # cuepoint is being inserted. + # The ID that YouTube assigns to uniquely identify the broadcast into which + # the cuepoint is being inserted. # Corresponds to the JSON property `broadcastId` # @return [String] attr_accessor :broadcast_id @@ -1829,13 +1912,14 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For liveCuepoint resources, the value is - # youtubePartner#liveCuepoint. + # The type of the API resource. For liveCuepoint resources, the + # value is youtubePartner#liveCuepoint. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The settings object defines the cuepoint's settings. + # The settings object defines the cuepoint's + # settings. # Corresponds to the JSON property `settings` # @return [Google::Apis::YoutubePartnerV1::CuepointSettings] attr_accessor :settings @@ -1853,30 +1937,110 @@ module Google end end + # + class LongestMatch + include Google::Apis::Core::Hashable + + # The duration of the longest match between the reference and the user + # video. + # Corresponds to the JSON property `durationSecs` + # @return [Fixnum] + attr_accessor :duration_secs + + # The offset in seconds into the reference at which the longest match + # began. + # Corresponds to the JSON property `referenceOffset` + # @return [Fixnum] + attr_accessor :reference_offset + + # The offset in seconds into the user video at which the longest match + # began. + # Corresponds to the JSON property `userVideoOffset` + # @return [Fixnum] + attr_accessor :user_video_offset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration_secs = args[:duration_secs] if args.key?(:duration_secs) + @reference_offset = args[:reference_offset] if args.key?(:reference_offset) + @user_video_offset = args[:user_video_offset] if args.key?(:user_video_offset) + end + end + + # + class MatchInfo + include Google::Apis::Core::Hashable + + # Details of the longest match between the reference and the user video. + # Corresponds to the JSON property `longestMatch` + # @return [Google::Apis::YoutubePartnerV1::LongestMatch] + attr_accessor :longest_match + + # Details about each match segment. Each item in the list contains + # information about one match segment associated with the claim. It is + # possible to have multiple match segments. For example, if the audio and + # video content of an uploaded video match that of a reference video, there + # would be two match segments. One segment would describe the audio match + # and the other would describe the video match. + # Corresponds to the JSON property `matchSegments` + # @return [Array] + attr_accessor :match_segments + + # The reference ID that + # generated this match. + # Corresponds to the JSON property `referenceId` + # @return [String] + attr_accessor :reference_id + + # Details of the total amount of reference and user video content which + # matched each other. Note these two values may differ if either the + # reference or the user video contains a loop. + # Corresponds to the JSON property `totalMatch` + # @return [Google::Apis::YoutubePartnerV1::TotalMatch] + attr_accessor :total_match + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @longest_match = args[:longest_match] if args.key?(:longest_match) + @match_segments = args[:match_segments] if args.key?(:match_segments) + @reference_id = args[:reference_id] if args.key?(:reference_id) + @total_match = args[:total_match] if args.key?(:total_match) + end + end + # class MatchSegment include Google::Apis::Core::Hashable - # Identifies the manner in which the claimed video matches the reference video. + # Identifies the manner in which the claimed video matches the reference + # video. # Corresponds to the JSON property `channel` # @return [String] attr_accessor :channel - # On insert operation of manual claims, the manual_segment object contains - # information about the specific portion of the video that is claimed to be - # matching. + # On insert operation of manual claims, the manual_segment + # object contains information about the specific portion of the video that is + # claimed to be matching. # Corresponds to the JSON property `manual_segment` - # @return [Google::Apis::YoutubePartnerV1::Segment] + # @return [Google::Apis::YoutubePartnerV1::Segment2] attr_accessor :manual_segment - # The reference_segment object contains information about the matched portion of - # the reference content. + # The reference_segment object contains information about the + # matched portion of the reference content. # Corresponds to the JSON property `reference_segment` # @return [Google::Apis::YoutubePartnerV1::Segment] attr_accessor :reference_segment - # The video_segment object contains information about the matched portion of the - # claimed video. + # The video_segment object contains information about the + # matched portion of the claimed video. # Corresponds to the JSON property `video_segment` # @return [Google::Apis::YoutubePartnerV1::Segment] attr_accessor :video_segment @@ -1894,12 +2058,423 @@ module Google end end + # A reference to data stored on the filesystem, on GFS or in blobstore. + class Media + include Google::Apis::Core::Hashable + + # Deprecated, use one of explicit hash type fields instead. + # Algorithm used for calculating the hash. + # As of 2011/01/21, "MD5" is the only possible value for this field. + # New values may be added at any time. + # Corresponds to the JSON property `algorithm` + # @return [String] + attr_accessor :algorithm + + # Use object_id instead. + # Corresponds to the JSON property `bigstoreObjectRef` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :bigstore_object_ref + + # Blobstore v1 reference, set if reference_type is BLOBSTORE_REF + # This should be the byte representation of a blobstore.BlobRef. + # Since Blobstore is deprecating v1, use blobstore2_info instead. + # For now, any v2 blob will also be represented in this field as + # v1 BlobRef. + # Corresponds to the JSON property `blobRef` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :blob_ref + + # Information to read/write to blobstore2. + # Corresponds to the JSON property `blobstore2Info` + # @return [Google::Apis::YoutubePartnerV1::Blobstore2Info] + attr_accessor :blobstore2_info + + # A composite media composed of one or more media objects, set if + # reference_type is COMPOSITE_MEDIA. The media length field must be set + # to the sum of the lengths of all composite media objects. + # Note: All composite media must have length specified. + # Corresponds to the JSON property `compositeMedia` + # @return [Array] + attr_accessor :composite_media + + # MIME type of the data + # Corresponds to the JSON property `contentType` + # @return [String] + attr_accessor :content_type + + # Detailed Content-Type information from Scotty. The Content-Type of the media + # will typically be filled in by the header or Scotty's best_guess, but this + # extended information provides the backend with more information so that it + # can make a better decision if needed. This is only used on media upload + # requests from Scotty. + # Corresponds to the JSON property `contentTypeInfo` + # @return [Google::Apis::YoutubePartnerV1::ContentTypeInfo] + attr_accessor :content_type_info + + # A binary data reference for a media download. Serves as a + # technology-agnostic binary reference in some Google infrastructure. + # This value is a serialized storage_cosmo.BinaryReference proto. Storing + # it as bytes is a hack to get around the fact that the cosmo proto + # (as well as others it includes) doesn't support JavaScript. This + # prevents us from including the actual type of this field. + # Corresponds to the JSON property `cosmoBinaryReference` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :cosmo_binary_reference + + # For Scotty Uploads: + # Scotty-provided hashes for uploads + # For Scotty Downloads: + # (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) + # A Hash provided by the agent to be used to verify the data being + # downloaded. Currently only supported for inline payloads. + # Further, only crc32c_hash is currently supported. + # Corresponds to the JSON property `crc32cHash` + # @return [Fixnum] + attr_accessor :crc32c_hash + + # Backend response for a Diff get checksums response. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + # Corresponds to the JSON property `diffChecksumsResponse` + # @return [Google::Apis::YoutubePartnerV1::DiffChecksumsResponse] + attr_accessor :diff_checksums_response + + # Backend response for a Diff download response. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + # Corresponds to the JSON property `diffDownloadResponse` + # @return [Google::Apis::YoutubePartnerV1::DiffDownloadResponse] + attr_accessor :diff_download_response + + # A Diff upload request. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + # Corresponds to the JSON property `diffUploadRequest` + # @return [Google::Apis::YoutubePartnerV1::DiffUploadRequest] + attr_accessor :diff_upload_request + + # Backend response for a Diff upload request. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + # Corresponds to the JSON property `diffUploadResponse` + # @return [Google::Apis::YoutubePartnerV1::DiffUploadResponse] + attr_accessor :diff_upload_response + + # Backend response for a Diff get version response. + # For details on the Scotty Diff protocol, + # visit http://go/scotty-diff-protocol. + # Corresponds to the JSON property `diffVersionResponse` + # @return [Google::Apis::YoutubePartnerV1::DiffVersionResponse] + attr_accessor :diff_version_response + + # Parameters specific to media downloads. + # Corresponds to the JSON property `downloadParameters` + # @return [Google::Apis::YoutubePartnerV1::DownloadParameters] + attr_accessor :download_parameters + + # Original file name + # Corresponds to the JSON property `filename` + # @return [String] + attr_accessor :filename + + # Deprecated, use one of explicit hash type fields instead. + # These two hash related fields will only be populated on Scotty based media + # uploads and will contain the content of the hash group in the + # NotificationRequest: + # http://cs/#google3/uploader/service/proto/upload_listener.proto&q=class:Hash + # Hex encoded hash value of the uploaded media. + # Corresponds to the JSON property `hash` + # @return [String] + attr_accessor :hash_prop + + # For Scotty uploads only. If a user sends a hash code and the backend has + # requested that Scotty verify the upload against the client hash, + # Scotty will perform the check on behalf of the backend and will reject it + # if the hashes don't match. This is set to true if Scotty performed + # this verification. + # Corresponds to the JSON property `hashVerified` + # @return [Boolean] + attr_accessor :hash_verified + alias_method :hash_verified?, :hash_verified + + # Media data, set if reference_type is INLINE + # Corresponds to the JSON property `inline` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :inline + + # |is_potential_retry| is set false only when Scotty is + # certain that it has not sent the request before. When a client resumes + # an upload, this field must be set true in agent calls, because Scotty + # cannot be certain that it has never sent the request before due + # to potential failure in the session state persistence. + # Corresponds to the JSON property `isPotentialRetry` + # @return [Boolean] + attr_accessor :is_potential_retry + alias_method :is_potential_retry?, :is_potential_retry + + # Size of the data, in bytes + # Corresponds to the JSON property `length` + # @return [Fixnum] + attr_accessor :length + + # Scotty-provided MD5 hash for an upload. + # Corresponds to the JSON property `md5Hash` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :md5_hash + + # Media id to forward to the operation GetMedia. + # Can be set if reference_type is GET_MEDIA. + # Corresponds to the JSON property `mediaId` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :media_id + + # This is a copy of the tech.blob.ObjectId proto, which could not + # be used directly here due to transitive closure issues with + # JavaScript support; see http://b/8801763. + # Corresponds to the JSON property `objectId` + # @return [Google::Apis::YoutubePartnerV1::ObjectIdProp] + attr_accessor :object_id_prop + + # Path to the data, set if reference_type is PATH + # Corresponds to the JSON property `path` + # @return [String] + attr_accessor :path + + # Describes what the field reference contains. + # Corresponds to the JSON property `referenceType` + # @return [String] + attr_accessor :reference_type + + # Scotty-provided SHA1 hash for an upload. + # Corresponds to the JSON property `sha1Hash` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :sha1_hash + + # Scotty-provided SHA256 hash for an upload. + # Corresponds to the JSON property `sha256Hash` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :sha256_hash + + # Time at which the media data was last updated, + # in milliseconds since UNIX epoch + # Corresponds to the JSON property `timestamp` + # @return [Fixnum] + attr_accessor :timestamp + + # A unique fingerprint/version id for the media data + # Corresponds to the JSON property `token` + # @return [String] + attr_accessor :token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @algorithm = args[:algorithm] if args.key?(:algorithm) + @bigstore_object_ref = args[:bigstore_object_ref] if args.key?(:bigstore_object_ref) + @blob_ref = args[:blob_ref] if args.key?(:blob_ref) + @blobstore2_info = args[:blobstore2_info] if args.key?(:blobstore2_info) + @composite_media = args[:composite_media] if args.key?(:composite_media) + @content_type = args[:content_type] if args.key?(:content_type) + @content_type_info = args[:content_type_info] if args.key?(:content_type_info) + @cosmo_binary_reference = args[:cosmo_binary_reference] if args.key?(:cosmo_binary_reference) + @crc32c_hash = args[:crc32c_hash] if args.key?(:crc32c_hash) + @diff_checksums_response = args[:diff_checksums_response] if args.key?(:diff_checksums_response) + @diff_download_response = args[:diff_download_response] if args.key?(:diff_download_response) + @diff_upload_request = args[:diff_upload_request] if args.key?(:diff_upload_request) + @diff_upload_response = args[:diff_upload_response] if args.key?(:diff_upload_response) + @diff_version_response = args[:diff_version_response] if args.key?(:diff_version_response) + @download_parameters = args[:download_parameters] if args.key?(:download_parameters) + @filename = args[:filename] if args.key?(:filename) + @hash_prop = args[:hash_prop] if args.key?(:hash_prop) + @hash_verified = args[:hash_verified] if args.key?(:hash_verified) + @inline = args[:inline] if args.key?(:inline) + @is_potential_retry = args[:is_potential_retry] if args.key?(:is_potential_retry) + @length = args[:length] if args.key?(:length) + @md5_hash = args[:md5_hash] if args.key?(:md5_hash) + @media_id = args[:media_id] if args.key?(:media_id) + @object_id_prop = args[:object_id_prop] if args.key?(:object_id_prop) + @path = args[:path] if args.key?(:path) + @reference_type = args[:reference_type] if args.key?(:reference_type) + @sha1_hash = args[:sha1_hash] if args.key?(:sha1_hash) + @sha256_hash = args[:sha256_hash] if args.key?(:sha256_hash) + @timestamp = args[:timestamp] if args.key?(:timestamp) + @token = args[:token] if args.key?(:token) + end + end + + # Extra information added to operations that support Scotty media requests. + class MediaRequestInfo + include Google::Apis::Core::Hashable + + # The number of current bytes uploaded or downloaded. + # Corresponds to the JSON property `currentBytes` + # @return [Fixnum] + attr_accessor :current_bytes + + # Data to be copied to backend requests. Custom data is returned to Scotty in + # the agent_state field, which Scotty will then provide in subsequent upload + # notifications. + # Corresponds to the JSON property `customData` + # @return [String] + attr_accessor :custom_data + + # Set if the http request info is diff encoded. The value of + # this field is the version number of the base revision. + # This is corresponding to Apiary's mediaDiffObjectVersion + # (//depot/google3/java/com/google/api/server/media/variable/ + # DiffObjectVersionVariable.java). + # See go/esf-scotty-diff-upload for more information. + # Corresponds to the JSON property `diffObjectVersion` + # @return [String] + attr_accessor :diff_object_version + + # The type of notification received from Scotty. + # Corresponds to the JSON property `notificationType` + # @return [String] + attr_accessor :notification_type + + # The Scotty request ID. + # Corresponds to the JSON property `requestId` + # @return [String] + attr_accessor :request_id + + # The total size of the file. + # Corresponds to the JSON property `totalBytes` + # @return [Fixnum] + attr_accessor :total_bytes + + # Whether the total bytes field contains an estimated data. + # Corresponds to the JSON property `totalBytesIsEstimated` + # @return [Boolean] + attr_accessor :total_bytes_is_estimated + alias_method :total_bytes_is_estimated?, :total_bytes_is_estimated + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_bytes = args[:current_bytes] if args.key?(:current_bytes) + @custom_data = args[:custom_data] if args.key?(:custom_data) + @diff_object_version = args[:diff_object_version] if args.key?(:diff_object_version) + @notification_type = args[:notification_type] if args.key?(:notification_type) + @request_id = args[:request_id] if args.key?(:request_id) + @total_bytes = args[:total_bytes] if args.key?(:total_bytes) + @total_bytes_is_estimated = args[:total_bytes_is_estimated] if args.key?(:total_bytes_is_estimated) + end + end + + # This message is for backends to pass their scotty media specific fields to + # ESF. Backend will include this in their response message to ESF. + # Example: + # ExportFile is an rpc defined for upload using scotty from ESF. + # rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) + # Message ExportFileResponse will include apiserving.MediaResponseInfo to tell + # ESF about data like dynamic_dropzone it needs to pass to Scotty. + # message ExportFileResponse ` + # optional gdata.Media blob = 1; + # optional apiserving.MediaResponseInfo media_response_info = 2 + # ` + class MediaResponseInfo + include Google::Apis::Core::Hashable + + # Data to copy from backend response to the next backend requests. Custom + # data is returned to Scotty in the agent_state field, which Scotty will then + # provide in subsequent upload notifications. + # Corresponds to the JSON property `customData` + # @return [String] + attr_accessor :custom_data + + # Specifies any transformation to be applied to data before persisting it or + # retrieving from storage. E.g., encryption options for blobstore2. + # This should be of the form uploader_service.DataStorageTransform. + # Corresponds to the JSON property `dataStorageTransform` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :data_storage_transform + + # Specifies the Scotty Drop Target to use for uploads. If present in a media + # response, Scotty does not upload to a standard drop zone. Instead, Scotty + # saves the upload directly to the location specified in this drop target. + # Unlike drop zones, the drop target is the final storage location for an + # upload. So, the agent does not need to clone the blob at the end of the + # upload. The agent is responsible for garbage collecting any orphaned blobs + # that may occur due to aborted uploads. For more information, see the drop + # target design doc here: http://goto/ScottyDropTarget This field will be + # preferred to dynamicDropzone. If provided, the identified field in the + # response must be of the type uploader.agent.DropTarget. + # Corresponds to the JSON property `dynamicDropTarget` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @return [String] + attr_accessor :dynamic_drop_target + + # Specifies the Scotty dropzone to use for uploads. + # Corresponds to the JSON property `dynamicDropzone` + # @return [String] + attr_accessor :dynamic_dropzone + + # A reference to data stored on the filesystem, on GFS or in blobstore. + # Corresponds to the JSON property `mediaForDiff` + # @return [Google::Apis::YoutubePartnerV1::Media] + attr_accessor :media_for_diff + + # Request class to use for all Blobstore operations for this request. + # Corresponds to the JSON property `requestClass` + # @return [String] + attr_accessor :request_class + + # Specifies the TrafficClass that Scotty should use for any RPCs to fetch the + # response bytes. Will override the traffic class GTOS of the incoming http + # request. This is a temporary field to facilitate whitelisting and + # experimentation by the bigstore agent only. For instance, this does not + # apply to RTMP reads. + # WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM. + # Corresponds to the JSON property `trafficClassField` + # @return [String] + attr_accessor :traffic_class_field + + # Tells Scotty to verify hashes on the agent's behalf by parsing out the + # X-Goog-Hash header. + # Corresponds to the JSON property `verifyHashFromHeader` + # @return [Boolean] + attr_accessor :verify_hash_from_header + alias_method :verify_hash_from_header?, :verify_hash_from_header + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_data = args[:custom_data] if args.key?(:custom_data) + @data_storage_transform = args[:data_storage_transform] if args.key?(:data_storage_transform) + @dynamic_drop_target = args[:dynamic_drop_target] if args.key?(:dynamic_drop_target) + @dynamic_dropzone = args[:dynamic_dropzone] if args.key?(:dynamic_dropzone) + @media_for_diff = args[:media_for_diff] if args.key?(:media_for_diff) + @request_class = args[:request_class] if args.key?(:request_class) + @traffic_class_field = args[:traffic_class_field] if args.key?(:traffic_class_field) + @verify_hash_from_header = args[:verify_hash_from_header] if args.key?(:verify_hash_from_header) + end + end + # class Metadata include Google::Apis::Core::Hashable - # A list that identifies actors associated with the asset. You can specify up to - # 50 actors for an asset. + # A list that identifies actors associated with the asset. You can specify up + # to 50 actors for an asset. # Corresponds to the JSON property `actor` # @return [Array] attr_accessor :actor @@ -1910,18 +2485,18 @@ module Google # @return [String] attr_accessor :album - # The artist associated with a music video or sound recording asset. This field - # is only valid for music video and sound recording assets. It is required for - # sound recordings included in the AudioSwap program. + # The artist associated with a music video or sound recording asset. This + # field is only valid for music video and sound recording assets. It is + # required for sound recordings included in the AudioSwap program. # Corresponds to the JSON property `artist` # @return [Array] attr_accessor :artist - # Identifies the network or channel that originally broadcast a show or a season - # of a show. This field should only be included for an asset if the broadcaster - # associated with the asset is different from the partner uploading the asset to - # YouTube. Note that a show may have multiple broadcasters; for example, a show - # may switch networks between seasons. + # Identifies the network or channel that originally broadcast a show or a + # season of a show. This field should only be included for an asset if the + # broadcaster associated with the asset is different from the partner + # uploading the asset to YouTube. Note that a show may have multiple + # broadcasters; for example, a show may switch networks between seasons. # Corresponds to the JSON property `broadcaster` # @return [Array] attr_accessor :broadcaster @@ -1931,11 +2506,12 @@ module Google # @return [String] attr_accessor :category - # The type of video content that the asset represents. This field is only valid - # for movie and episode assets, and is required for the following types of those - # assets: - # - Episode assets that are linked to a show - # - Movie assets that appear in YouTube's Movies category + # The type of video content that the asset represents. This field is only + # valid for movie and episode assets, and is required for the following types + # of those assets:
  • Episode assets that are linked to a show
    • + #
  • Movie assets that appear in + # YouTube's Movies category
    • + #
# Corresponds to the JSON property `contentType` # @return [String] attr_accessor :content_type @@ -1945,112 +2521,116 @@ module Google # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :copyright_date - # A unique value that you, the metadata provider, use to identify an asset. The - # value could be a unique ID that you created for the asset or a standard + # A unique value that you, the metadata provider, use to identify an asset. + # The value could be a unique ID that you created for the asset or a standard # identifier, such as an ISRC. The value has a maximum length of 64 bytes and - # may contain alphanumeric characters, hyphens (-), underscores (_), periods (.), - # "at" symbols (@), or forward slashes (/). + # may contain alphanumeric characters, hyphens (-), underscores + # (_), periods (.), "at" symbols (@), + # or forward slashes (/). # Corresponds to the JSON property `customId` # @return [String] attr_accessor :custom_id - # A description of the asset. The description may be displayed on YouTube or in - # CMS. This field has a maximum length of 5,000 bytes. + # A description of the asset. The description may be displayed on YouTube or + # in CMS. This field has a maximum length of 5,000 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # A list that identifies directors associated with the asset. You can specify up - # to 50 directors for an asset. + # A list that identifies directors associated with the asset. You can specify + # up to 50 directors for an asset. # Corresponds to the JSON property `director` # @return [Array] attr_accessor :director - # The Entertainment Identifier Registry (EIDR) assigned to an asset. This value - # is only used for episode and movie assets and is optional in both cases. The - # value contains a standard prefix for EIDR registry, followed by a forward - # slash, a 20-character hexadecimal string, and an alphanumeric (0-9A-Z) check - # character. + # The Entertainment Identifier Registry (EIDR) assigned to an asset. This + # value is only used for episode and movie assets and is optional in both + # cases. The value contains a standard prefix for EIDR registry, followed by + # a forward slash, a 20-character hexadecimal string, and an alphanumeric + # (0-9A-Z) check character. # Corresponds to the JSON property `eidr` # @return [String] attr_accessor :eidr - # The last year that a television show aired. This value is only used for show - # assets, for which it is optional. Do not specify a value if new show episodes - # are still being created. + # The last year that a television show aired. This value is only used for + # show assets, for which it is optional. Do not specify a value if new show + # episodes are still being created. # Corresponds to the JSON property `endYear` # @return [Fixnum] attr_accessor :end_year # The episode number associated with an episode asset. This field is required - # for and only used for episode assets that are linked to show assets. It has a - # maximum length of 5 bytes. + # for and only used for episode assets that are linked to show assets. It has + # a maximum length of 5 bytes. # Corresponds to the JSON property `episodeNumber` # @return [String] attr_accessor :episode_number - # This value indicates that the episodes associated with a particular show asset - # or a particular season asset are untitled. An untitled show (or season) has - # episodes which are identified by their episode number or date. If this field - # is set to true, then YouTube will optimize the title displayed for associated - # episodes. + # This value indicates that the episodes associated with a particular show + # asset or a particular season asset are untitled. An untitled show (or + # season) has episodes which are identified by their episode number or date. + # If this field is set to true, then YouTube will optimize the + # title displayed for associated episodes. # Corresponds to the JSON property `episodesAreUntitled` # @return [Boolean] attr_accessor :episodes_are_untitled alias_method :episodes_are_untitled?, :episodes_are_untitled - # This field specifies a genre that can be used to categorize an asset. Assets - # may be categorized in more than one genre, and YouTube uses different sets of - # genres to categorize different types of assets. For example, Soaps might be a - # valid genre for a show but not for a movie or sound recording. - # - Show assets - # - Movie assets that appear in YouTube's Movies category - # - Sound recordings included in the AudioSwap program + # This field specifies a genre that can be used to categorize an asset. + # Assets may be categorized in more than one genre, and YouTube uses + # different sets of genres to categorize different types of assets. For + # example, Soaps might be a valid genre for a show but not for a + # movie or sound recording.
  • Show assets
  • Movie assets that + # appear in + # YouTube's Movies category
    • + #
  • Sound recordings included in the AudioSwap program
# Corresponds to the JSON property `genre` # @return [Array] attr_accessor :genre - # The GRID (Global Release Identifier) of a music video or sound recording. This - # field's value must contain exactly 18 alphanumeric characters. + # The GRID (Global Release Identifier) of a music video or sound recording. + # This field's value must contain exactly 18 alphanumeric characters. # Corresponds to the JSON property `grid` # @return [String] attr_accessor :grid - # The six-character Harry Fox Agency (HFA) song code issued to uniquely identify - # a composition. This value is only valid for composition assets. + # The six-character Harry Fox Agency (HFA) song code issued to uniquely + # identify a composition. This value is only valid for composition assets. # Corresponds to the JSON property `hfa` # @return [String] attr_accessor :hfa - # An official URL associated with the asset. This field has a maximum length of - # 1536 bytes. Please do not submit a 1537-byte URL. Your efforts would be futile. + # An official URL associated with the asset. This field has a maximum length + # of 1536 bytes. Please do not submit a 1537-byte URL. Your efforts would be + # futile. # Corresponds to the JSON property `infoUrl` # @return [String] attr_accessor :info_url - # The ISAN (International Standard Audiovisual Number) for the asset. This value - # is only used for episode and movie assets and is optional in both cases. The - # value contains 26 characters, which includes the 24 hexadecimal characters of - # the ISAN as well as two check characters, in the following format: - # - The first 16 characters in the tag value contain hexadecimal characters - # specifying the 'root' and 'episode' components of the ISAN. - # - The seventeenth character is a check character (a letter from A-Z). - # - Characters 18 to 25 are the remaining eight characters of the ISAN, which - # specify the 'version' component of the ISAN. - # - The twenty-sixth character is another check character (A-Z). + # The ISAN (International Standard Audiovisual Number) for the asset. This + # value is only used for episode and movie assets and is optional in both + # cases. The value contains 26 characters, which includes the 24 hexadecimal + # characters of the ISAN as well as two check characters, in the following + # format:
  • The first 16 characters in the tag value contain + # hexadecimal characters specifying the 'root' and 'episode' components of + # the ISAN.
  • The seventeenth character is a check character (a letter + # from A-Z).
  • Characters 18 to 25 are the remaining eight characters + # of the ISAN, which specify the 'version' component of the ISAN.
    • + #
  • The twenty-sixth character is another check character (A-Z).
# Corresponds to the JSON property `isan` # @return [String] attr_accessor :isan # The ISRC (International Standard Recording Code) of a music video or sound - # recording asset. This field's value must contain exactly 12 alphanumeric - # characters. + # recording asset. This + # field's value must contain exactly 12 alphanumeric characters. # Corresponds to the JSON property `isrc` # @return [String] attr_accessor :isrc - # The ISWC (International Standard Musical Work Code) for a composition asset. - # The field's value must contain exactly 11 characters in the format of a letter + # The ISWC (International Standard Musical Work Code) for a composition + # asset. The + # field's value must contain exactly 11 characters in the format of a letter # (T) followed by 10 digits. # Corresponds to the JSON property `iswc` # @return [String] @@ -2068,17 +2648,18 @@ module Google # @return [String] attr_accessor :label - # Additional information that does not map directly to one of the other metadata - # fields. This field has a maximum length of 255 bytes. + # Additional information that does not map directly to one of the other + # metadata fields. This field has a maximum length of 255 bytes. # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes # The method by which people first had the opportunity to see a video asset. - # This value is only used for episode and movie assets. It is required for the - # assets listed below and otherwise optional: - # - Episode assets that are linked to a show - # - Movie assets that appear in YouTube's Movies category + # This value is only used for episode and movie assets. It is required for + # the assets listed below and otherwise optional:
  • Episode assets + # that are linked to a show
  • Movie assets that appear in + # YouTube's Movies category
    • + #
# Corresponds to the JSON property `originalReleaseMedium` # @return [String] attr_accessor :original_release_medium @@ -2089,50 +2670,55 @@ module Google # @return [Array] attr_accessor :producer - # A list of ratings that an asset received. The rating must be valid under the - # specified rating system. + # A list of ratings that an asset received. The rating must be valid under + # the specified rating system. # Corresponds to the JSON property `ratings` # @return [Array] attr_accessor :ratings # The date that an asset was publicly released. For season assets, this value - # specifies the first date that the season aired. Dates prior to the year 1902 - # are not supported. This value is valid for episode, season, movie, music video, - # and sound recording assets. It is required for the assets listed below and - # otherwise optional: - # - Episode assets that are linked to a show - # - Movie assets that appear in YouTube's Movies category + # specifies the first date that the season aired. Dates prior to the year + # 1902 are not supported. This value is valid for episode, season, movie, + # music video, and sound recording assets. It is required for the assets + # listed below and otherwise optional:
  • Episode assets that are + # linked to a show
  • Movie assets that appear in + # YouTube's Movies category
    • + #
# Corresponds to the JSON property `releaseDate` # @return [Google::Apis::YoutubePartnerV1::Date] attr_accessor :release_date - # The season number that identifies a season asset, or the season number that is - # associated with an episode asset. This field has a maximum length of 5 bytes. + # The season number that identifies a season asset, or the season number that + # is associated with an episode asset. This field has a maximum length of 5 + # bytes. # Corresponds to the JSON property `seasonNumber` # @return [String] attr_accessor :season_number - # The customId of the show asset that a season or episode asset is associated - # with. It is required for season and episode assets that appear in the Shows - # category on YouTube, and it is not valid for other types of assets. This field - # has a maximum length of 64 bytes and may contain alphanumeric characters, - # hyphens (-), underscores (_), periods (.), "at" symbols (@), or forward - # slashes (/). + # The customId of the show asset that a season or episode asset + # is associated with. It is required for season and episode assets that + # appear in the Shows category on + # YouTube, and it is not valid for other types of assets. This field has a + # maximum length of 64 bytes and may contain alphanumeric characters, hyphens + # (-), underscores (_), periods (.), + # "at" symbols (@), or forward slashes (/). # Corresponds to the JSON property `showCustomId` # @return [String] attr_accessor :show_custom_id - # The name of the show that an episode asset is associated with. Note: This tag - # is only used for and valid for episodes that are not associated with show - # assets and enables those assets to still display a show title in the asset - # metadata section of CMS. This field has a maximum length of 120 bytes. + # The name of the show that an episode asset is associated with. + # Note: This tag is only used for and valid for episodes + # that are not associated with show assets and enables those assets to still + # display a show title in the asset metadata section of CMS. This field has a + # maximum length of 120 bytes. # Corresponds to the JSON property `showTitle` # @return [String] attr_accessor :show_title - # The video's primary spoken language. The value can be any ISO 639-1 two-letter - # language code. This value is only used for episode and movie assets and is not - # valid for other types of assets. + # The video's primary spoken language. The value can be any ISO 639-1 + # two-letter language code. This value is only used for episode and movie + # assets and is not valid for other types of assets. # Corresponds to the JSON property `spokenLanguage` # @return [String] attr_accessor :spoken_language @@ -2143,21 +2729,22 @@ module Google # @return [Fixnum] attr_accessor :start_year - # A list of languages for which the video has either a separate caption track or - # burnt-in captions that are part of the video. Each value in the list should be - # an ISO 639-1 two-letter language code. This value is only used for episode and - # movie assets and is not valid for other types of assets. + # A list of languages for which the video has either a separate caption track + # or burnt-in captions that are part of the video. Each value in the list + # should be an ISO 639-1 + # two-letter language code. This value is only used for episode and movie + # assets and is not valid for other types of assets. # Corresponds to the JSON property `subtitledLanguage` # @return [Array] attr_accessor :subtitled_language - # The asset's title or name. The value has a maximum length of 255 bytes. This - # value is required for the assets listed below and optional for all other - # assets: - # - Show assets - # - Episode assets that are linked to a show - # - Movie assets that appear in YouTube's Movies category - # - Sound recordings included in the AudioSwap program + # The asset's title or name. The value has a maximum length of 255 bytes. + # This value is required for the assets listed below and optional for all + # other assets:
  • Show assets
  • Episode assets that are linked + # to a show
  • Movie assets that appear in + # YouTube's Movies category
    • + #
  • Sound recordings included in the AudioSwap program
# Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -2167,8 +2754,8 @@ module Google # @return [String] attr_accessor :tms_id - # Specifies the total number of full-length episodes in the season. This value - # is used only for season assets. + # Specifies the total number of full-length episodes in the season. This + # value is used only for season assets. # Corresponds to the JSON property `totalEpisodesExpected` # @return [Fixnum] attr_accessor :total_episodes_expected @@ -2178,8 +2765,8 @@ module Google # @return [String] attr_accessor :upc - # A list that identifies writers associated with the asset. You can specify up - # to 50 writers for an asset. + # A list that identifies writers associated with the asset. You can specify + # up to 50 writers for an asset. # Corresponds to the JSON property `writer` # @return [Array] attr_accessor :writer @@ -2237,25 +2824,27 @@ module Google include Google::Apis::Core::Hashable # The type of the API resource. For metadata history resources, the value is - # youtubePartner#metadataHistory. + # youtubePartner#metadataHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The metadata object contains the metadata provided by the specified source ( - # origination) at the specified time (timeProvided). + # The metadata object contains the metadata provided by the + # specified source (origination) at the specified time + # (timeProvided). # Corresponds to the JSON property `metadata` # @return [Google::Apis::YoutubePartnerV1::Metadata] attr_accessor :metadata - # The origination object contains information that describes the metadata source. + # The origination object contains information that describes the + # metadata source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination # The time the metadata was provided. # Corresponds to the JSON property `timeProvided` - # @return [DateTime] + # @return [String] attr_accessor :time_provided def initialize(**args) @@ -2275,14 +2864,14 @@ module Google class MetadataHistoryListResponse include Google::Apis::Core::Hashable - # A list of metadata history (youtubePartner#metadataHistory) resources that - # match the request criteria. + # A list of metadata history (youtubePartner#metadataHistory) + # resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # metadataHistoryList. + # The type of the API response. For this operation, the value is + # youtubePartner#metadataHistoryList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2298,115 +2887,30 @@ module Google end end - # - class Order + # This is a copy of the tech.blob.ObjectId proto, which could not + # be used directly here due to transitive closure issues with + # JavaScript support; see http://b/8801763. + class ObjectIdProp include Google::Apis::Core::Hashable - # Links an order to the avails associated with it. - # Corresponds to the JSON property `availGroupId` + # The name of the bucket to which this object belongs. + # Corresponds to the JSON property `bucketName` # @return [String] - attr_accessor :avail_group_id + attr_accessor :bucket_name - # Channel ID - identifies the channel this order and video are associated with - # Corresponds to the JSON property `channelId` + # Generation of the object. Generations are monotonically increasing + # across writes, allowing them to be be compared to determine which + # generation is newer. If this is omitted in a request, then you are + # requesting the live object. + # See http://go/bigstore-versions + # Corresponds to the JSON property `generation` + # @return [Fixnum] + attr_accessor :generation + + # The name of the object. + # Corresponds to the JSON property `objectName` # @return [String] - attr_accessor :channel_id - - # Type of content possible values are - # - MOVIE - # - SHOW - # Corresponds to the JSON property `contentType` - # @return [String] - attr_accessor :content_type - - # Two letter country code for the order only countries where YouTube does - # transactional business are allowed. - # Corresponds to the JSON property `country` - # @return [String] - attr_accessor :country - - # Secondary id to be used to identify content in other systems like partner - # database - # Corresponds to the JSON property `customId` - # @return [String] - attr_accessor :custom_id - - # Date when this content was first made available on DVD - # Corresponds to the JSON property `dvdReleaseDate` - # @return [Google::Apis::YoutubePartnerV1::Date] - attr_accessor :dvd_release_date - - # Range of time content is to be available for rental. - # Corresponds to the JSON property `estDates` - # @return [Google::Apis::YoutubePartnerV1::DateRange] - attr_accessor :est_dates - - # History log of events for this order - # Corresponds to the JSON property `events` - # @return [Array] - attr_accessor :events - - # Order Id unique identifier for an order. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # Identifies this resource as order. Value: "youtubePartner#order". - # Corresponds to the JSON property `kind` - # @return [String] - attr_accessor :kind - - # Title if the order is type movie. - # Corresponds to the JSON property `movie` - # @return [String] - attr_accessor :movie - - # Date when this content was first made available to the public - # Corresponds to the JSON property `originalReleaseDate` - # @return [Google::Apis::YoutubePartnerV1::Date] - attr_accessor :original_release_date - - # The priority for the order in the QC review queue once the content is ready - # for QC. - # Corresponds to the JSON property `priority` - # @return [String] - attr_accessor :priority - - # Post production house that is to process this order - # Corresponds to the JSON property `productionHouse` - # @return [String] - attr_accessor :production_house - - # Youtube purchase order reference for the post production house. - # Corresponds to the JSON property `purchaseOrder` - # @return [String] - attr_accessor :purchase_order - - # Minumim set of requirements for this order to be complete such as is a trailer - # required. - # Corresponds to the JSON property `requirements` - # @return [Google::Apis::YoutubePartnerV1::Requirements] - attr_accessor :requirements - - # Details of a show, show name, season number, episode etc. - # Corresponds to the JSON property `show` - # @return [Google::Apis::YoutubePartnerV1::ShowDetails] - attr_accessor :show - - # The order's status. - # Corresponds to the JSON property `status` - # @return [String] - attr_accessor :status - - # Video ID the video that this order is associated with if any. - # Corresponds to the JSON property `videoId` - # @return [String] - attr_accessor :video_id - - # Range of time content is to be available for purchase. - # Corresponds to the JSON property `vodDates` - # @return [Google::Apis::YoutubePartnerV1::DateRange] - attr_accessor :vod_dates + attr_accessor :object_name def initialize(**args) update!(**args) @@ -2414,60 +2918,20 @@ module Google # Update properties of this object def update!(**args) - @avail_group_id = args[:avail_group_id] if args.key?(:avail_group_id) - @channel_id = args[:channel_id] if args.key?(:channel_id) - @content_type = args[:content_type] if args.key?(:content_type) - @country = args[:country] if args.key?(:country) - @custom_id = args[:custom_id] if args.key?(:custom_id) - @dvd_release_date = args[:dvd_release_date] if args.key?(:dvd_release_date) - @est_dates = args[:est_dates] if args.key?(:est_dates) - @events = args[:events] if args.key?(:events) - @id = args[:id] if args.key?(:id) - @kind = args[:kind] if args.key?(:kind) - @movie = args[:movie] if args.key?(:movie) - @original_release_date = args[:original_release_date] if args.key?(:original_release_date) - @priority = args[:priority] if args.key?(:priority) - @production_house = args[:production_house] if args.key?(:production_house) - @purchase_order = args[:purchase_order] if args.key?(:purchase_order) - @requirements = args[:requirements] if args.key?(:requirements) - @show = args[:show] if args.key?(:show) - @status = args[:status] if args.key?(:status) - @video_id = args[:video_id] if args.key?(:video_id) - @vod_dates = args[:vod_dates] if args.key?(:vod_dates) + @bucket_name = args[:bucket_name] if args.key?(:bucket_name) + @generation = args[:generation] if args.key?(:generation) + @object_name = args[:object_name] if args.key?(:object_name) end end # - class OrderListResponse + class Origin include Google::Apis::Core::Hashable - # A list of orders that match the request criteria. - # Corresponds to the JSON property `items` - # @return [Array] - attr_accessor :items - - # The type of the API response. For this operation, the value is youtubePartner# - # orderList. - # Corresponds to the JSON property `kind` + # + # Corresponds to the JSON property `source` # @return [String] - attr_accessor :kind - - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page in the result set. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The pageInfo object encapsulates paging information for the result set. - # Corresponds to the JSON property `pageInfo` - # @return [Google::Apis::YoutubePartnerV1::PageInfo] - attr_accessor :page_info - - # The token that can be used as the value of the pageToken parameter to retrieve - # the previous page in the result set. - # Corresponds to the JSON property `previousPageToken` - # @return [String] - attr_accessor :previous_page_token + attr_accessor :source def initialize(**args) update!(**args) @@ -2475,11 +2939,7 @@ module Google # Update properties of this object def update!(**args) - @items = args[:items] if args.key?(:items) - @kind = args[:kind] if args.key?(:kind) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @page_info = args[:page_info] if args.key?(:page_info) - @previous_page_token = args[:previous_page_token] if args.key?(:previous_page_token) + @source = args[:source] if args.key?(:source) end end @@ -2519,26 +2979,29 @@ module Google # @return [Array] attr_accessor :general - # The type of the API resource. For ownershipConflicts resources, the value is - # youtubePartner#ownershipConflicts. + # The type of the API resource. For ownershipConflicts + # resources, the value is youtubePartner#ownershipConflicts. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # A list that identifies ownership conflicts of the mechanical rights for a - # composition asset and the territories where conflicting ownership is inserted. + # composition asset and the territories where conflicting ownership is + # inserted. # Corresponds to the JSON property `mechanical` # @return [Array] attr_accessor :mechanical # A list that identifies ownership conflicts of the performance rights for a - # composition asset and the territories where conflicting ownership is inserted. + # composition asset and the territories where conflicting ownership is + # inserted. # Corresponds to the JSON property `performance` # @return [Array] attr_accessor :performance - # A list that identifies ownership conflicts of the synchronization rights for a - # composition asset and the territories where conflicting ownership is inserted. + # A list that identifies ownership conflicts of the synchronization rights + # for a composition asset and the territories where conflicting ownership is + # inserted. # Corresponds to the JSON property `synchronization` # @return [Array] attr_accessor :synchronization @@ -2561,14 +3024,14 @@ module Google class OwnershipHistoryListResponse include Google::Apis::Core::Hashable - # A list of ownership history (youtubePartner#ownershipHistory) resources that - # match the request criteria. + # A list of ownership history (youtubePartner#ownershipHistory) + # resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # ownershipHistoryList. + # The type of the API response. For this operation, the value is + # youtubePartner#ownershipHistoryList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2603,15 +3066,16 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For package resources, this value is - # youtubePartner#package. + # The type of the API resource. For package resources, this + # value is youtubePartner#package. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The desired locale of the error messages as defined in BCP 47 (http://tools. - # ietf.org/html/bcp47). For example, "en-US" or "de". If not specified we will - # return the error messages in English ("en"). + # The desired locale of the error messages as defined in BCP 47 + # (http: + # //tools.ietf.org/html/bcp47). For example, "en-US" or "de". If not + # // specified we will return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -2631,10 +3095,11 @@ module Google # @return [Array] attr_accessor :status_reports - # The package creation time. The value is specified in RFC 3339 (YYYY-MM-DDThh: - # mm:ss.000Z) format. + # The package creation time. The value is specified in RFC 3339 + # (YYYY-MM-DDThh:mm:ss.000Z) format. # Corresponds to the JSON property `timeCreated` - # @return [DateTime] + # @return [String] attr_accessor :time_created # The package type. @@ -2676,22 +3141,23 @@ module Google # @return [Array] attr_accessor :errors - # The type of the API response. For this operation, the value is youtubePartner# - # packageInsert. + # The type of the API response. For this operation, the value is + # youtubePartner#packageInsert. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The package resource. + # The package resource. # Corresponds to the JSON property `resource` # @return [Google::Apis::YoutubePartnerV1::Package] attr_accessor :resource # The package insert status. Indicates whether the insert operation completed - # successfully or identifies the general cause of failure. For most cases where - # the insert operation failed, the errors are described in the API response's - # errors object. However, if the operation failed because the package contained - # non-metadata files, the errors object is not included in the response. + # successfully or identifies the general cause of failure. For most cases + # where the insert operation failed, the errors are described in the API + # response's errors object. However, if the operation failed + # because the package contained non-metadata files, the errors + # object is not included in the response. # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -2754,7 +3220,7 @@ module Google # @return [String] attr_accessor :id - # Identifies this as a policy. Value: "youtubePartner#policy" + # Identifies this as a policy. Value: "youtubePartner#policy" # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2772,7 +3238,7 @@ module Google # The time the policy was updated. # Corresponds to the JSON property `timeUpdated` - # @return [DateTime] + # @return [String] attr_accessor :time_updated def initialize(**args) @@ -2799,8 +3265,8 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # policyList. + # The type of the API response. For this operation, the value is + # youtubePartner#policyList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2820,20 +3286,20 @@ module Google class PolicyRule include Google::Apis::Core::Hashable - # The policy that YouTube should enforce if the rule's conditions are all valid - # for an asset or for an attempt to view that asset on YouTube. + # The policy that YouTube should enforce if the rule's conditions are all + # valid for an asset or for an attempt to view that asset on YouTube. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # A set of conditions that must be met for the rule's action (and subactions) to - # be enforced. For a rule to be valid, all of its conditions must be met. + # A set of conditions that must be met for the rule's action (and subactions) + # to be enforced. For a rule to be valid, all of its conditions must be met. # Corresponds to the JSON property `conditions` # @return [Google::Apis::YoutubePartnerV1::Conditions] attr_accessor :conditions - # A list of additional actions that YouTube should take if the conditions in the - # rule are met. + # A list of additional actions that YouTube should take if the conditions in + # the rule are met. # Corresponds to the JSON property `subaction` # @return [Array] attr_accessor :subaction @@ -2854,10 +3320,11 @@ module Google class PromotedContent include Google::Apis::Core::Hashable - # A list of link targets that will be used to generate the annotation link that - # appears on videos included in the campaign. If more than one link is - # specified, the link that is displayed to viewers will be randomly selected - # from the list. + # A list of link targets that will be used to generate the annotation link + # that appears on videos included in the + # campaign. If more than one link is specified, the link that is + # displayed to viewers will be randomly selected from the list. # Corresponds to the JSON property `link` # @return [Array] attr_accessor :link @@ -2907,17 +3374,18 @@ module Google # @return [String] attr_accessor :asset_id - # Set this field's value to true to indicate that the reference content should - # be included in YouTube's AudioSwap program. + # Set this field's value to true to indicate that the reference + # content should be included in YouTube's AudioSwap program. # Corresponds to the JSON property `audioswapEnabled` # @return [Boolean] attr_accessor :audioswap_enabled alias_method :audioswap_enabled?, :audioswap_enabled # This field is present if the reference was created by associating an asset - # with an existing YouTube video that was uploaded to a YouTube channel linked - # to your CMS account. In that case, this field contains the ID of the claim - # representing the resulting association between the asset and the video. + # with an existing YouTube video that was uploaded to a YouTube channel + # linked to your CMS account. In that case, this field contains the ID of the + # claim representing the resulting association between the asset and the + # video. # Corresponds to the JSON property `claimId` # @return [String] attr_accessor :claim_id @@ -2927,27 +3395,33 @@ module Google # @return [String] attr_accessor :content_type - # The ID that uniquely identifies the reference that this reference duplicates. - # This field is only present if the reference's status is inactive with reason - # REASON_DUPLICATE_FOR_OWNERS. + # The ID that uniquely identifies the reference that this reference + # duplicates. This field is only present if the + # reference's status is inactive with reason + # REASON_DUPLICATE_FOR_OWNERS. # Corresponds to the JSON property `duplicateLeader` # @return [String] attr_accessor :duplicate_leader - # The list of time intervals from this reference that will be ignored during the - # match process. + # The list of time intervals from this reference that will be ignored during + # the match process. # Corresponds to the JSON property `excludedIntervals` # @return [Array] attr_accessor :excluded_intervals - # When uploading a reference, set this value to true to indicate that the - # reference is a pre-generated fingerprint. + # When uploading a reference, set this value to true to indicate + # that the reference is a pre-generated fingerprint. # Corresponds to the JSON property `fpDirect` # @return [Boolean] attr_accessor :fp_direct alias_method :fp_direct?, :fp_direct - # The MD5 hashcode of the reference content. Deprecated! This is no longer + # A reference to data stored on the filesystem, on GFS or in blobstore. + # Corresponds to the JSON property `gdataMedia` + # @return [Google::Apis::YoutubePartnerV1::Media] + attr_accessor :gdata_media + + # The MD5 hashcode of the reference content. Deprecated! This is no longer # populated. # Corresponds to the JSON property `hashCode` # @return [String] @@ -2958,15 +3432,16 @@ module Google # @return [String] attr_accessor :id - # Set this value to true to indicate that the reference should not be used to - # generate claims. This field is only used on AudioSwap references. + # Set this value to true to indicate that the reference should + # not be used to generate claims. This field is only used on AudioSwap + # references. # Corresponds to the JSON property `ignoreFpMatch` # @return [Boolean] attr_accessor :ignore_fp_match alias_method :ignore_fp_match?, :ignore_fp_match - # The type of the API resource. For reference resources, the value is - # youtubePartner#reference. + # The type of the API resource. For reference resources, the + # value is youtubePartner#reference. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -2976,8 +3451,28 @@ module Google # @return [Float] attr_accessor :length - # The origination object contains information that describes the reference - # source. + # Extra information added to operations that support Scotty media requests. + # Corresponds to the JSON property `mediaRequestInfo` + # @return [Google::Apis::YoutubePartnerV1::MediaRequestInfo] + attr_accessor :media_request_info + + # This message is for backends to pass their scotty media specific fields to + # ESF. Backend will include this in their response message to ESF. + # Example: + # ExportFile is an rpc defined for upload using scotty from ESF. + # rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) + # Message ExportFileResponse will include apiserving.MediaResponseInfo to tell + # ESF about data like dynamic_dropzone it needs to pass to Scotty. + # message ExportFileResponse ` + # optional gdata.Media blob = 1; + # optional apiserving.MediaResponseInfo media_response_info = 2 + # ` + # Corresponds to the JSON property `mediaResponseInfo` + # @return [Google::Apis::YoutubePartnerV1::MediaResponseInfo] + attr_accessor :media_response_info + + # The origination object contains information that describes the + # reference source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination @@ -2988,28 +3483,29 @@ module Google attr_accessor :status # An explanation of how a reference entered its current state. This value is - # only present if the reference's status is either inactive or deleted. + # only present if the + # reference's status is either inactive or deleted. # Corresponds to the JSON property `statusReason` # @return [String] attr_accessor :status_reason - # Set this value to true to indicate that YouTube should prioritize Content ID - # processing for a video file. YouTube processes urgent video files before other - # files that are not marked as urgent. This setting is primarily used for videos - # of live events or other videos that require time-sensitive processing. The - # sooner YouTube completes Content ID processing for a video, the sooner YouTube - # can match user-uploaded videos to that video. - # Note that marking all of your files as urgent could delay processing for those - # files. + # Set this value to true to indicate that YouTube should + # prioritize Content ID processing for a video file. YouTube processes urgent + # video files before other files that are not marked as urgent. This setting + # is primarily used for videos of live events or other videos that require + # time-sensitive processing. The sooner YouTube completes Content ID + # processing for a video, the sooner YouTube can match user-uploaded videos + # to that video.

Note that marking all of your files as urgent could + # delay processing for those files. # Corresponds to the JSON property `urgent` # @return [Boolean] attr_accessor :urgent alias_method :urgent?, :urgent # This field is present if the reference was created by associating an asset - # with an existing YouTube video that was uploaded to a YouTube channel linked - # to your CMS account. In that case, this field contains the ID of the source - # video. + # with an existing YouTube video that was uploaded to a YouTube channel + # linked to your CMS account. In that case, this field contains the ID of the + # source video. # Corresponds to the JSON property `videoId` # @return [String] attr_accessor :video_id @@ -3027,11 +3523,14 @@ module Google @duplicate_leader = args[:duplicate_leader] if args.key?(:duplicate_leader) @excluded_intervals = args[:excluded_intervals] if args.key?(:excluded_intervals) @fp_direct = args[:fp_direct] if args.key?(:fp_direct) + @gdata_media = args[:gdata_media] if args.key?(:gdata_media) @hash_code = args[:hash_code] if args.key?(:hash_code) @id = args[:id] if args.key?(:id) @ignore_fp_match = args[:ignore_fp_match] if args.key?(:ignore_fp_match) @kind = args[:kind] if args.key?(:kind) @length = args[:length] if args.key?(:length) + @media_request_info = args[:media_request_info] if args.key?(:media_request_info) + @media_response_info = args[:media_response_info] if args.key?(:media_response_info) @origination = args[:origination] if args.key?(:origination) @status = args[:status] if args.key?(:status) @status_reason = args[:status_reason] if args.key?(:status_reason) @@ -3051,7 +3550,7 @@ module Google # Conflict review expiry time. # Corresponds to the JSON property `expiryTime` - # @return [DateTime] + # @return [String] attr_accessor :expiry_time # A value that YouTube assigns and uses to uniquely identify a reference @@ -3060,14 +3559,14 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For referenceConflict resources, the value is - # youtubePartner#referenceConflict. + # The type of the API resource. For referenceConflict resources, + # the value is youtubePartner#referenceConflict. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The list of matches between conflicting and original references at the time of - # conflict creation. + # The list of matches between conflicting and original references at the time + # of conflict creation. # Corresponds to the JSON property `matches` # @return [Array] attr_accessor :matches @@ -3107,19 +3606,20 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # referenceConflictList. + # The type of the API response. For this operation, the value is + # youtubePartner#referenceConflictList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page in the result set. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -3183,19 +3683,20 @@ module Google # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # referenceList. + # The type of the API response. For this operation, the value is + # youtubePartner#referenceList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page in the result set. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page in the result set. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -3213,83 +3714,28 @@ module Google end end - # - class Requirements - include Google::Apis::Core::Hashable - - # This value indicates whether the order requires closed captions. - # Corresponds to the JSON property `caption` - # @return [Boolean] - attr_accessor :caption - alias_method :caption?, :caption - - # This value indicates whether the order requires HD-quality video. - # Corresponds to the JSON property `hdTranscode` - # @return [Boolean] - attr_accessor :hd_transcode - alias_method :hd_transcode?, :hd_transcode - - # This value indicates whether the order requires poster artwork. - # Corresponds to the JSON property `posterArt` - # @return [Boolean] - attr_accessor :poster_art - alias_method :poster_art?, :poster_art - - # This value indicates whether the order requires spotlight artwork. - # Corresponds to the JSON property `spotlightArt` - # @return [Boolean] - attr_accessor :spotlight_art - alias_method :spotlight_art?, :spotlight_art - - # This value indicates whether the spotlight artwork for the order needs to be - # reviewed. - # Corresponds to the JSON property `spotlightReview` - # @return [Boolean] - attr_accessor :spotlight_review - alias_method :spotlight_review?, :spotlight_review - - # This value indicates whether the order requires a trailer. - # Corresponds to the JSON property `trailer` - # @return [Boolean] - attr_accessor :trailer - alias_method :trailer?, :trailer - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @caption = args[:caption] if args.key?(:caption) - @hd_transcode = args[:hd_transcode] if args.key?(:hd_transcode) - @poster_art = args[:poster_art] if args.key?(:poster_art) - @spotlight_art = args[:spotlight_art] if args.key?(:spotlight_art) - @spotlight_review = args[:spotlight_review] if args.key?(:spotlight_review) - @trailer = args[:trailer] if args.key?(:trailer) - end - end - # class RightsOwnership include Google::Apis::Core::Hashable - # A list that identifies the owners of an asset and the territories where each - # owner has ownership. General asset ownership is used for all types of assets - # and is the only type of ownership data that can be provided for assets that - # are not compositions. - # Note: You cannot specify general ownership rights and also specify either - # mechanical, performance, or synchronization rights. + # A list that identifies the owners of an asset and the territories where + # each owner has ownership. General asset ownership is used for all types of + # assets and is the only type of ownership data that can be provided for + # assets that are not compositions.

Note: You + # cannot specify general ownership rights and also specify either mechanical, + # performance, or synchronization rights. # Corresponds to the JSON property `general` # @return [Array] attr_accessor :general - # The type of the API resource. For rightsOwnership resources, the value is - # youtubePartner#rightsOwnership. + # The type of the API resource. For rightsOwnership resources, + # the value is youtubePartner#rightsOwnership. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # A list that identifies owners of the mechanical rights for a composition asset. + # A list that identifies owners of the mechanical rights for a composition + # asset. # Corresponds to the JSON property `mechanical` # @return [Array] attr_accessor :mechanical @@ -3300,8 +3746,8 @@ module Google # @return [Array] attr_accessor :performance - # A list that identifies owners of the synchronization rights for a composition - # asset. + # A list that identifies owners of the synchronization rights for a + # composition asset. # Corresponds to the JSON property `synchronization` # @return [Array] attr_accessor :synchronization @@ -3325,25 +3771,27 @@ module Google include Google::Apis::Core::Hashable # The type of the API resource. For ownership history resources, the value is - # youtubePartner#rightsOwnershipHistory. + # youtubePartner#rightsOwnershipHistory. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The origination object contains information that describes the metadata source. + # The origination object contains information that describes the + # metadata source. # Corresponds to the JSON property `origination` # @return [Google::Apis::YoutubePartnerV1::Origination] attr_accessor :origination - # The ownership object contains the ownership data provided by the specified - # source (origination) at the specified time (timeProvided). + # The ownership object contains the ownership data provided by + # the specified source (origination) at the specified time + # (timeProvided). # Corresponds to the JSON property `ownership` # @return [Google::Apis::YoutubePartnerV1::RightsOwnership] attr_accessor :ownership # The time that the ownership data was provided. # Corresponds to the JSON property `timeProvided` - # @return [DateTime] + # @return [String] attr_accessor :time_provided def initialize(**args) @@ -3368,13 +3816,41 @@ module Google # @return [Fixnum] attr_accessor :duration - # The finish time of the segment, measured in milliseconds from the beginning. + # The type of the API resource. For segment resources, the value is + # youtubePartner#segment. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The start time of the segment, measured in milliseconds from the beginning. + # Corresponds to the JSON property `start` + # @return [Fixnum] + attr_accessor :start + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @duration = args[:duration] if args.key?(:duration) + @kind = args[:kind] if args.key?(:kind) + @start = args[:start] if args.key?(:start) + end + end + + # + class Segment2 + include Google::Apis::Core::Hashable + + # The finish time of the segment, measured in milliseconds from the + # beginning. # Corresponds to the JSON property `finish` # @return [String] attr_accessor :finish # The type of the API resource. For segment resources, the value is - # youtubePartner#segment. + # youtubePartner#segment. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3390,7 +3866,6 @@ module Google # Update properties of this object def update!(**args) - @duration = args[:duration] if args.key?(:duration) @finish = args[:finish] if args.key?(:finish) @kind = args[:kind] if args.key?(:kind) @start = args[:start] if args.key?(:start) @@ -3398,28 +3873,23 @@ module Google end # - class ShowDetails + class Source include Google::Apis::Core::Hashable - # The episode number associated with the episode. - # Corresponds to the JSON property `episodeNumber` + # Id of content owner that initiated the event. + # Corresponds to the JSON property `contentOwnerId` # @return [String] - attr_accessor :episode_number + attr_accessor :content_owner_id - # The episode's title. - # Corresponds to the JSON property `episodeTitle` + # Type of the event source. + # Corresponds to the JSON property `type` # @return [String] - attr_accessor :episode_title + attr_accessor :type - # The season number associated with the episode. - # Corresponds to the JSON property `seasonNumber` + # Email of user who initiated the event. + # Corresponds to the JSON property `userEmail` # @return [String] - attr_accessor :season_number - - # The show's title - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title + attr_accessor :user_email def initialize(**args) update!(**args) @@ -3427,10 +3897,9 @@ module Google # Update properties of this object def update!(**args) - @episode_number = args[:episode_number] if args.key?(:episode_number) - @episode_title = args[:episode_title] if args.key?(:episode_title) - @season_number = args[:season_number] if args.key?(:season_number) - @title = args[:title] if args.key?(:title) + @content_owner_id = args[:content_owner_id] if args.key?(:content_owner_id) + @type = args[:type] if args.key?(:type) + @user_email = args[:user_email] if args.key?(:user_email) end end @@ -3438,8 +3907,8 @@ module Google class SpreadsheetTemplate include Google::Apis::Core::Hashable - # The type of the API resource. For spreadsheet template resources, the value is - # youtubePartner#spreadsheetTemplate. + # The type of the API resource. For spreadsheet template resources, the value + # is youtubePartner#spreadsheetTemplate. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3482,14 +3951,15 @@ module Google class SpreadsheetTemplateListResponse include Google::Apis::Core::Hashable - # A list of spreadsheet templates (youtubePartner#spreadsheetTemplate) resources - # that match the request criteria. + # A list of spreadsheet templates + # (youtubePartner#spreadsheetTemplate) resources that match the + # request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # spreadsheetTemplateList. + # The type of the API response. For this operation, the value is + # youtubePartner#spreadsheetTemplateList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3511,31 +3981,6 @@ module Google end end - # - class StateCompleted - include Google::Apis::Core::Hashable - - # The state that the order entered. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # The time that the state transition occurred. - # Corresponds to the JSON property `timeCompleted` - # @return [Fixnum] - attr_accessor :time_completed - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @state = args[:state] if args.key?(:state) - @time_completed = args[:time_completed] if args.key?(:time_completed) - end - end - # class StatusReport include Google::Apis::Core::Hashable @@ -3565,13 +4010,16 @@ module Google class TerritoryCondition include Google::Apis::Core::Hashable - # A list of territories. Each territory is an ISO 3166 two-letter country code.. + # A list of territories. Each territory is an ISO + # 3166 two-letter country code.. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories - # This field indicates whether the associated policy rule is or is not valid in - # the specified territories. + # This field indicates whether the associated policy rule is or is not valid + # in the specified territories. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3596,8 +4044,10 @@ module Google # @return [Array] attr_accessor :conflicting_ownership - # A territories where the ownership conflict is present. Territory is an ISO - # 3166 two-letter country code.. + # A territories where the ownership conflict is present. Territory is an ISO + # 3166 two-letter country code.. # Corresponds to the JSON property `territory` # @return [String] attr_accessor :territory @@ -3630,23 +4080,26 @@ module Google attr_accessor :publisher # The percentage of the asset that the owner controls or administers. For - # composition assets, the value can be any value between 0 and 100 inclusive. - # For all other assets, the only valid values are 100, which indicates that the - # owner completely owns the asset in the specified territories, and 0, which - # indicates that you are removing ownership of the asset in the specified - # territories. + # composition assets, the value can be any value between 0 and + # 100 inclusive. For all other assets, the only valid values are + # 100, which indicates that the owner completely owns the asset + # in the specified territories, and 0, which indicates that you + # are removing ownership of the asset in the specified territories. # Corresponds to the JSON property `ratio` # @return [Float] attr_accessor :ratio - # A list of territories where the owner owns (or does not own) the asset. Each - # territory is an ISO 3166 two-letter country code.. + # A list of territories where the owner owns (or does not own) the asset. + # Each territory is an ISO + # 3166 two-letter country code.. # Corresponds to the JSON property `territories` # @return [Array] attr_accessor :territories - # This field indicates whether the ownership data applies or does not apply in - # the specified territories. + # This field indicates whether the ownership data applies or does not apply + # in the specified territories. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -3665,12 +4118,77 @@ module Google end end + # + class TotalMatch + include Google::Apis::Core::Hashable + + # The total amount of content in the reference which matched the user + # video in seconds. + # Corresponds to the JSON property `referenceDurationSecs` + # @return [Fixnum] + attr_accessor :reference_duration_secs + + # The total amount of content in the user video which matched the + # reference in seconds. + # Corresponds to the JSON property `userVideoDurationSecs` + # @return [Fixnum] + attr_accessor :user_video_duration_secs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @reference_duration_secs = args[:reference_duration_secs] if args.key?(:reference_duration_secs) + @user_video_duration_secs = args[:user_video_duration_secs] if args.key?(:user_video_duration_secs) + end + end + + # + class TypeDetails + include Google::Apis::Core::Hashable + + # Appeal explanations for dispute_appeal event. + # Corresponds to the JSON property `appealExplanation` + # @return [String] + attr_accessor :appeal_explanation + + # Dispute notes for dispute_create events. + # Corresponds to the JSON property `disputeNotes` + # @return [String] + attr_accessor :dispute_notes + + # Dispute reason for dispute_create and + # dispute_appeal events. + # Corresponds to the JSON property `disputeReason` + # @return [String] + attr_accessor :dispute_reason + + # Status that was a result of update for claim_update event. + # Corresponds to the JSON property `updateStatus` + # @return [String] + attr_accessor :update_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @appeal_explanation = args[:appeal_explanation] if args.key?(:appeal_explanation) + @dispute_notes = args[:dispute_notes] if args.key?(:dispute_notes) + @dispute_reason = args[:dispute_reason] if args.key?(:dispute_reason) + @update_status = args[:update_status] if args.key?(:update_status) + end + end + # class Uploader include Google::Apis::Core::Hashable # The type of the API resource. For uploader resources, the value is - # youtubePartner#uploader. + # youtubePartner#uploader. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3695,14 +4213,14 @@ module Google class UploaderListResponse include Google::Apis::Core::Hashable - # A list of uploader (youtubePartner#uploader) resources that match the request - # criteria. + # A list of uploader (youtubePartner#uploader) resources that + # match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # uploaderList. + # The type of the API response. For this operation, the value is + # youtubePartner#uploaderList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3727,8 +4245,8 @@ module Google # @return [String] attr_accessor :content - # The type of the API resource. For this operation, the value is youtubePartner# - # validateAsyncRequest. + # The type of the API resource. For this operation, the value is + # youtubePartner#validateAsyncRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3754,8 +4272,8 @@ module Google class ValidateAsyncResponse include Google::Apis::Core::Hashable - # The type of the API resource. For this operation, the value is youtubePartner# - # validateAsyncResponse. + # The type of the API resource. For this operation, the value is + # youtubePartner#validateAsyncResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3840,15 +4358,16 @@ module Google # @return [String] attr_accessor :content - # The type of the API resource. For this operation, the value is youtubePartner# - # validateRequest. + # The type of the API resource. For this operation, the value is + # youtubePartner#validateRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The desired locale of the error messages as defined in BCP 47 (http://tools. - # ietf.org/html/bcp47). For example, "en-US" or "de". If not specified we will - # return the error messages in English ("en"). + # The desired locale of the error messages as defined in BCP 47 + # (http: + # //tools.ietf.org/html/bcp47). For example, "en-US" or "de". If not + # // specified we will return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -3880,8 +4399,8 @@ module Google # @return [Array] attr_accessor :errors - # The type of the API resource. For this operation, the value is youtubePartner# - # validateResponse. + # The type of the API resource. For this operation, the value is + # youtubePartner#validateResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -3907,15 +4426,16 @@ module Google class ValidateStatusRequest include Google::Apis::Core::Hashable - # The type of the API resource. For this operation, the value is youtubePartner# - # validateStatusRequest. + # The type of the API resource. For this operation, the value is + # youtubePartner#validateStatusRequest. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The desired locale of the error messages as defined in BCP 47 (http://tools. - # ietf.org/html/bcp47). For example, "en-US" or "de". If not specified we will - # return the error messages in English ("en"). + # The desired locale of the error messages as defined in BCP 47 + # (http: + # //tools.ietf.org/html/bcp47). For example, "en-US" or "de". If not + # // specified we will return the error messages in English ("en"). # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -3952,8 +4472,8 @@ module Google attr_accessor :is_metadata_only alias_method :is_metadata_only?, :is_metadata_only - # The type of the API resource. For this operation, the value is youtubePartner# - # validateStatusResponse. + # The type of the API resource. For this operation, the value is + # youtubePartner#validateStatusResponse. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4008,8 +4528,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For this resource, the value is youtubePartner# - # videoAdvertisingOption. + # The type of the API resource. For this resource, the value is + # youtubePartner#videoAdvertisingOption. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4019,14 +4539,14 @@ module Google # @return [String] attr_accessor :tp_ad_server_video_id - # The base URL for a third-party ad server from which YouTube can retrieve in- - # stream ads for the video. + # The base URL for a third-party ad server from which YouTube can retrieve + # in-stream ads for the video. # Corresponds to the JSON property `tpTargetingUrl` # @return [String] attr_accessor :tp_targeting_url - # A parameter string to append to the end of the request to the third-party ad - # server. + # A parameter string to append to the end of the request to the third-party + # ad server. # Corresponds to the JSON property `tpUrlParameters` # @return [String] attr_accessor :tp_url_parameters @@ -4058,8 +4578,8 @@ module Google # @return [Array] attr_accessor :ad_breaks - # This field indicates whether YouTube can show ads when the video is played in - # an embedded player. + # This field indicates whether YouTube can show ads when the video is played + # in an embedded player. # Corresponds to the JSON property `adsOnEmbeds` # @return [Boolean] attr_accessor :ads_on_embeds @@ -4076,8 +4596,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For this resource, the value is youtubePartner# - # videoAdvertisingOptionGetEnabledAds. + # The type of the API resource. For this resource, the value is + # youtubePartner#videoAdvertisingOptionGetEnabledAds. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4105,8 +4625,8 @@ module Google # @return [String] attr_accessor :id - # The type of the API resource. For whitelist resources, this value is - # youtubePartner#whitelist. + # The type of the API resource. For whitelist resources, this + # value is youtubePartner#whitelist. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind @@ -4132,24 +4652,25 @@ module Google class WhitelistListResponse include Google::Apis::Core::Hashable - # A list of whitelist resources that match the request criteria. + # A list of whitelist resources that match the request criteria. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items - # The type of the API response. For this operation, the value is youtubePartner# - # whitelistList. + # The type of the API response. For this operation, the value is + # youtubePartner#whitelistList. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The token that can be used as the value of the pageToken parameter to retrieve - # the next page of results. + # The token that can be used as the value of the pageToken + # parameter to retrieve the next page of results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # The pageInfo object encapsulates paging information for the result set. + # The pageInfo object encapsulates paging information for the + # result set. # Corresponds to the JSON property `pageInfo` # @return [Google::Apis::YoutubePartnerV1::PageInfo] attr_accessor :page_info @@ -4166,6 +4687,25 @@ module Google @page_info = args[:page_info] if args.key?(:page_info) end end + + # + class YoutubePartnerApiProtoFrontendV1Origin + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @source = args[:source] if args.key?(:source) + end + end end end end diff --git a/generated/google/apis/youtube_partner_v1/representations.rb b/generated/google/apis/youtube_partner_v1/representations.rb index 9770878a4..ca00de122 100644 --- a/generated/google/apis/youtube_partner_v1/representations.rb +++ b/generated/google/apis/youtube_partner_v1/representations.rb @@ -28,12 +28,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class AllowedAdvertisingOptions - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class Asset class Representation < Google::Apis::Core::JsonRepresentation; end @@ -100,6 +94,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Blobstore2Info + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Campaign class Representation < Google::Apis::Core::JsonRepresentation; end @@ -132,48 +132,12 @@ module Google class Claim class Representation < Google::Apis::Core::JsonRepresentation; end - - class MatchInfo - class Representation < Google::Apis::Core::JsonRepresentation; end - - class LongestMatch - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TotalMatch - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - include Google::Apis::Core::JsonObjectSupport - end - - class Origin - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end include Google::Apis::Core::JsonObjectSupport end class ClaimEvent class Representation < Google::Apis::Core::JsonRepresentation; end - - class Source - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TypeDetails - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end include Google::Apis::Core::JsonObjectSupport end @@ -198,17 +162,11 @@ module Google class ClaimSnippet class Representation < Google::Apis::Core::JsonRepresentation; end - - class Origin - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end include Google::Apis::Core::JsonObjectSupport end - class ClaimedVideoDefaults + class CompositeMedia class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -232,13 +190,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ContentOwnerAdvertisingOption + class ContentOwnerListResponse class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class ContentOwnerListResponse + class ContentTypeInfo class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -262,7 +220,43 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class DateRange + class DiffChecksumsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DiffDownloadResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DiffUploadRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DiffUploadResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DiffVersionResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class DownloadParameters + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Empty class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -286,12 +280,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class LongestMatch + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MatchInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class MatchSegment class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class Media + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MediaRequestInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class MediaResponseInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Metadata class Representation < Google::Apis::Core::JsonRepresentation; end @@ -310,13 +334,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Order + class ObjectIdProp class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end - class OrderListResponse + class Origin class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -418,12 +442,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class Requirements - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class RightsOwnership class Representation < Google::Apis::Core::JsonRepresentation; end @@ -442,7 +460,13 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class ShowDetails + class Segment2 + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class Source class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport @@ -460,12 +484,6 @@ module Google include Google::Apis::Core::JsonObjectSupport end - class StateCompleted - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - class StatusReport class Representation < Google::Apis::Core::JsonRepresentation; end @@ -490,6 +508,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class TotalMatch + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class TypeDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Uploader class Representation < Google::Apis::Core::JsonRepresentation; end @@ -568,6 +598,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class YoutubePartnerApiProtoFrontendV1Origin + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AdBreak # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -576,16 +612,6 @@ module Google end end - class AllowedAdvertisingOptions - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :ads_on_embeds, as: 'adsOnEmbeds' - property :kind, as: 'kind' - collection :lic_ad_formats, as: 'licAdFormats' - collection :ugc_ad_formats, as: 'ugcAdFormats' - end - end - class Asset # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -614,8 +640,7 @@ module Google property :ownership_mine, as: 'ownershipMine', class: Google::Apis::YoutubePartnerV1::RightsOwnership, decorator: Google::Apis::YoutubePartnerV1::RightsOwnership::Representation property :status, as: 'status' - property :time_created, as: 'timeCreated', type: DateTime - + property :time_created, as: 'timeCreated' property :type, as: 'type' end end @@ -719,13 +744,23 @@ module Google property :isrc, as: 'isrc' property :iswc, as: 'iswc' property :kind, as: 'kind' - property :time_created, as: 'timeCreated', type: DateTime - + property :time_created, as: 'timeCreated' property :title, as: 'title' property :type, as: 'type' end end + class Blobstore2Info + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :blob_generation, :numeric_string => true, as: 'blobGeneration' + property :blob_id, as: 'blobId' + property :download_read_handle, :base64 => true, as: 'downloadReadHandle' + property :read_token, as: 'readToken' + property :upload_metadata_container, :base64 => true, as: 'uploadMetadataContainer' + end + end + class Campaign # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -734,10 +769,8 @@ module Google property :id, as: 'id' property :kind, as: 'kind' property :status, as: 'status' - property :time_created, as: 'timeCreated', type: DateTime - - property :time_last_modified, as: 'timeLastModified', type: DateTime - + property :time_created, as: 'timeCreated' + property :time_last_modified, as: 'timeLastModified' end end @@ -746,13 +779,11 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :campaign_source, as: 'campaignSource', class: Google::Apis::YoutubePartnerV1::CampaignSource, decorator: Google::Apis::YoutubePartnerV1::CampaignSource::Representation - property :expire_time, as: 'expireTime', type: DateTime - + property :expire_time, as: 'expireTime' property :name, as: 'name' collection :promoted_content, as: 'promotedContent', class: Google::Apis::YoutubePartnerV1::PromotedContent, decorator: Google::Apis::YoutubePartnerV1::PromotedContent::Representation - property :start_time, as: 'startTime', type: DateTime - + property :start_time, as: 'startTime' end end @@ -792,54 +823,16 @@ module Google property :id, as: 'id' property :is_partner_uploaded, as: 'isPartnerUploaded' property :kind, as: 'kind' - property :match_info, as: 'matchInfo', class: Google::Apis::YoutubePartnerV1::Claim::MatchInfo, decorator: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::Representation + property :match_info, as: 'matchInfo', class: Google::Apis::YoutubePartnerV1::MatchInfo, decorator: Google::Apis::YoutubePartnerV1::MatchInfo::Representation - property :origin, as: 'origin', class: Google::Apis::YoutubePartnerV1::Claim::Origin, decorator: Google::Apis::YoutubePartnerV1::Claim::Origin::Representation + property :origin, as: 'origin', class: Google::Apis::YoutubePartnerV1::Origin, decorator: Google::Apis::YoutubePartnerV1::Origin::Representation property :policy, as: 'policy', class: Google::Apis::YoutubePartnerV1::Policy, decorator: Google::Apis::YoutubePartnerV1::Policy::Representation property :status, as: 'status' - property :time_created, as: 'timeCreated', type: DateTime - + property :time_created, as: 'timeCreated' property :video_id, as: 'videoId' end - - class MatchInfo - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :longest_match, as: 'longestMatch', class: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::LongestMatch, decorator: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::LongestMatch::Representation - - collection :match_segments, as: 'matchSegments', class: Google::Apis::YoutubePartnerV1::MatchSegment, decorator: Google::Apis::YoutubePartnerV1::MatchSegment::Representation - - property :reference_id, as: 'referenceId' - property :total_match, as: 'totalMatch', class: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::TotalMatch, decorator: Google::Apis::YoutubePartnerV1::Claim::MatchInfo::TotalMatch::Representation - - end - - class LongestMatch - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration_secs, :numeric_string => true, as: 'durationSecs' - property :reference_offset, :numeric_string => true, as: 'referenceOffset' - property :user_video_offset, :numeric_string => true, as: 'userVideoOffset' - end - end - - class TotalMatch - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :reference_duration_secs, :numeric_string => true, as: 'referenceDurationSecs' - property :user_video_duration_secs, :numeric_string => true, as: 'userVideoDurationSecs' - end - end - end - - class Origin - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :source, as: 'source' - end - end end class ClaimEvent @@ -847,33 +840,13 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :kind, as: 'kind' property :reason, as: 'reason' - property :source, as: 'source', class: Google::Apis::YoutubePartnerV1::ClaimEvent::Source, decorator: Google::Apis::YoutubePartnerV1::ClaimEvent::Source::Representation - - property :time, as: 'time', type: DateTime + property :source, as: 'source', class: Google::Apis::YoutubePartnerV1::Source, decorator: Google::Apis::YoutubePartnerV1::Source::Representation + property :time, as: 'time' property :type, as: 'type' - property :type_details, as: 'typeDetails', class: Google::Apis::YoutubePartnerV1::ClaimEvent::TypeDetails, decorator: Google::Apis::YoutubePartnerV1::ClaimEvent::TypeDetails::Representation + property :type_details, as: 'typeDetails', class: Google::Apis::YoutubePartnerV1::TypeDetails, decorator: Google::Apis::YoutubePartnerV1::TypeDetails::Representation end - - class Source - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :content_owner_id, as: 'contentOwnerId' - property :type, as: 'type' - property :user_email, as: 'userEmail' - end - end - - class TypeDetails - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :appeal_explanation, as: 'appealExplanation' - property :dispute_notes, as: 'disputeNotes' - property :dispute_reason, as: 'disputeReason' - property :update_status, as: 'updateStatus' - end - end end class ClaimHistory @@ -921,34 +894,34 @@ module Google property :id, as: 'id' property :is_partner_uploaded, as: 'isPartnerUploaded' property :kind, as: 'kind' - property :origin, as: 'origin', class: Google::Apis::YoutubePartnerV1::ClaimSnippet::Origin, decorator: Google::Apis::YoutubePartnerV1::ClaimSnippet::Origin::Representation + property :origin, as: 'origin', class: Google::Apis::YoutubePartnerV1::YoutubePartnerApiProtoFrontendV1Origin, decorator: Google::Apis::YoutubePartnerV1::YoutubePartnerApiProtoFrontendV1Origin::Representation property :status, as: 'status' property :third_party_claim, as: 'thirdPartyClaim' - property :time_created, as: 'timeCreated', type: DateTime - - property :time_status_last_modified, as: 'timeStatusLastModified', type: DateTime - + property :time_created, as: 'timeCreated' + property :time_status_last_modified, as: 'timeStatusLastModified' property :video_id, as: 'videoId' property :video_title, as: 'videoTitle' property :video_views, :numeric_string => true, as: 'videoViews' end - - class Origin - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :source, as: 'source' - end - end end - class ClaimedVideoDefaults + class CompositeMedia # @private class Representation < Google::Apis::Core::JsonRepresentation - property :auto_generated_breaks, as: 'autoGeneratedBreaks' - property :channel_override, as: 'channelOverride' - property :kind, as: 'kind' - collection :new_video_defaults, as: 'newVideoDefaults' + property :blob_ref, :base64 => true, as: 'blobRef' + property :blobstore2_info, as: 'blobstore2Info', class: Google::Apis::YoutubePartnerV1::Blobstore2Info, decorator: Google::Apis::YoutubePartnerV1::Blobstore2Info::Representation + + property :cosmo_binary_reference, :base64 => true, as: 'cosmoBinaryReference' + property :crc32c_hash, as: 'crc32cHash' + property :inline, :base64 => true, as: 'inline' + property :length, :numeric_string => true, as: 'length' + property :md5_hash, :base64 => true, as: 'md5Hash' + property :object_id_prop, as: 'objectId', class: Google::Apis::YoutubePartnerV1::ObjectIdProp, decorator: Google::Apis::YoutubePartnerV1::ObjectIdProp::Representation + + property :path, as: 'path' + property :reference_type, as: 'referenceType' + property :sha1_hash, :base64 => true, as: 'sha1Hash' end end @@ -990,18 +963,6 @@ module Google end end - class ContentOwnerAdvertisingOption - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :allowed_options, as: 'allowedOptions', class: Google::Apis::YoutubePartnerV1::AllowedAdvertisingOptions, decorator: Google::Apis::YoutubePartnerV1::AllowedAdvertisingOptions::Representation - - property :claimed_video_options, as: 'claimedVideoOptions', class: Google::Apis::YoutubePartnerV1::ClaimedVideoDefaults, decorator: Google::Apis::YoutubePartnerV1::ClaimedVideoDefaults::Representation - - property :id, as: 'id' - property :kind, as: 'kind' - end - end - class ContentOwnerListResponse # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1011,6 +972,17 @@ module Google end end + class ContentTypeInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :best_guess, as: 'bestGuess' + property :from_bytes, as: 'fromBytes' + property :from_file_name, as: 'fromFileName' + property :from_header, as: 'fromHeader' + property :from_url_path, as: 'fromUrlPath' + end + end + class CountriesRestriction # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1025,8 +997,7 @@ module Google property :cue_type, as: 'cueType' property :duration_secs, as: 'durationSecs' property :offset_time_ms, :numeric_string => true, as: 'offsetTimeMs' - property :walltime, as: 'walltime', type: DateTime - + property :walltime, as: 'walltime' end end @@ -1039,14 +1010,66 @@ module Google end end - class DateRange + class DiffChecksumsResponse # @private class Representation < Google::Apis::Core::JsonRepresentation - property :end, as: 'end', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation + property :checksums_location, as: 'checksumsLocation', class: Google::Apis::YoutubePartnerV1::CompositeMedia, decorator: Google::Apis::YoutubePartnerV1::CompositeMedia::Representation - property :kind, as: 'kind' - property :start, as: 'start', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation + property :chunk_size_bytes, :numeric_string => true, as: 'chunkSizeBytes' + property :object_location, as: 'objectLocation', class: Google::Apis::YoutubePartnerV1::CompositeMedia, decorator: Google::Apis::YoutubePartnerV1::CompositeMedia::Representation + property :object_size_bytes, :numeric_string => true, as: 'objectSizeBytes' + property :object_version, as: 'objectVersion' + end + end + + class DiffDownloadResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :object_location, as: 'objectLocation', class: Google::Apis::YoutubePartnerV1::CompositeMedia, decorator: Google::Apis::YoutubePartnerV1::CompositeMedia::Representation + + end + end + + class DiffUploadRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :checksums_info, as: 'checksumsInfo', class: Google::Apis::YoutubePartnerV1::CompositeMedia, decorator: Google::Apis::YoutubePartnerV1::CompositeMedia::Representation + + property :object_info, as: 'objectInfo', class: Google::Apis::YoutubePartnerV1::CompositeMedia, decorator: Google::Apis::YoutubePartnerV1::CompositeMedia::Representation + + property :object_version, as: 'objectVersion' + end + end + + class DiffUploadResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :object_version, as: 'objectVersion' + property :original_object, as: 'originalObject', class: Google::Apis::YoutubePartnerV1::CompositeMedia, decorator: Google::Apis::YoutubePartnerV1::CompositeMedia::Representation + + end + end + + class DiffVersionResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :object_size_bytes, :numeric_string => true, as: 'objectSizeBytes' + property :object_version, as: 'objectVersion' + end + end + + class DownloadParameters + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_gzip_compression, as: 'allowGzipCompression' + property :ignore_range, as: 'ignoreRange' + end + end + + class Empty + # @private + class Representation < Google::Apis::Core::JsonRepresentation end end @@ -1056,8 +1079,7 @@ module Google property :high, as: 'high' property :low, as: 'low' property :origin, as: 'origin' - property :time_created, as: 'timeCreated', type: DateTime - + property :time_created, as: 'timeCreated' end end @@ -1080,11 +1102,33 @@ module Google end end + class LongestMatch + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :duration_secs, :numeric_string => true, as: 'durationSecs' + property :reference_offset, :numeric_string => true, as: 'referenceOffset' + property :user_video_offset, :numeric_string => true, as: 'userVideoOffset' + end + end + + class MatchInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :longest_match, as: 'longestMatch', class: Google::Apis::YoutubePartnerV1::LongestMatch, decorator: Google::Apis::YoutubePartnerV1::LongestMatch::Representation + + collection :match_segments, as: 'matchSegments', class: Google::Apis::YoutubePartnerV1::MatchSegment, decorator: Google::Apis::YoutubePartnerV1::MatchSegment::Representation + + property :reference_id, as: 'referenceId' + property :total_match, as: 'totalMatch', class: Google::Apis::YoutubePartnerV1::TotalMatch, decorator: Google::Apis::YoutubePartnerV1::TotalMatch::Representation + + end + end + class MatchSegment # @private class Representation < Google::Apis::Core::JsonRepresentation property :channel, as: 'channel' - property :manual_segment, as: 'manual_segment', class: Google::Apis::YoutubePartnerV1::Segment, decorator: Google::Apis::YoutubePartnerV1::Segment::Representation + property :manual_segment, as: 'manual_segment', class: Google::Apis::YoutubePartnerV1::Segment2, decorator: Google::Apis::YoutubePartnerV1::Segment2::Representation property :reference_segment, as: 'reference_segment', class: Google::Apis::YoutubePartnerV1::Segment, decorator: Google::Apis::YoutubePartnerV1::Segment::Representation @@ -1093,6 +1137,80 @@ module Google end end + class Media + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :algorithm, as: 'algorithm' + property :bigstore_object_ref, :base64 => true, as: 'bigstoreObjectRef' + property :blob_ref, :base64 => true, as: 'blobRef' + property :blobstore2_info, as: 'blobstore2Info', class: Google::Apis::YoutubePartnerV1::Blobstore2Info, decorator: Google::Apis::YoutubePartnerV1::Blobstore2Info::Representation + + collection :composite_media, as: 'compositeMedia', class: Google::Apis::YoutubePartnerV1::CompositeMedia, decorator: Google::Apis::YoutubePartnerV1::CompositeMedia::Representation + + property :content_type, as: 'contentType' + property :content_type_info, as: 'contentTypeInfo', class: Google::Apis::YoutubePartnerV1::ContentTypeInfo, decorator: Google::Apis::YoutubePartnerV1::ContentTypeInfo::Representation + + property :cosmo_binary_reference, :base64 => true, as: 'cosmoBinaryReference' + property :crc32c_hash, as: 'crc32cHash' + property :diff_checksums_response, as: 'diffChecksumsResponse', class: Google::Apis::YoutubePartnerV1::DiffChecksumsResponse, decorator: Google::Apis::YoutubePartnerV1::DiffChecksumsResponse::Representation + + property :diff_download_response, as: 'diffDownloadResponse', class: Google::Apis::YoutubePartnerV1::DiffDownloadResponse, decorator: Google::Apis::YoutubePartnerV1::DiffDownloadResponse::Representation + + property :diff_upload_request, as: 'diffUploadRequest', class: Google::Apis::YoutubePartnerV1::DiffUploadRequest, decorator: Google::Apis::YoutubePartnerV1::DiffUploadRequest::Representation + + property :diff_upload_response, as: 'diffUploadResponse', class: Google::Apis::YoutubePartnerV1::DiffUploadResponse, decorator: Google::Apis::YoutubePartnerV1::DiffUploadResponse::Representation + + property :diff_version_response, as: 'diffVersionResponse', class: Google::Apis::YoutubePartnerV1::DiffVersionResponse, decorator: Google::Apis::YoutubePartnerV1::DiffVersionResponse::Representation + + property :download_parameters, as: 'downloadParameters', class: Google::Apis::YoutubePartnerV1::DownloadParameters, decorator: Google::Apis::YoutubePartnerV1::DownloadParameters::Representation + + property :filename, as: 'filename' + property :hash_prop, as: 'hash' + property :hash_verified, as: 'hashVerified' + property :inline, :base64 => true, as: 'inline' + property :is_potential_retry, as: 'isPotentialRetry' + property :length, :numeric_string => true, as: 'length' + property :md5_hash, :base64 => true, as: 'md5Hash' + property :media_id, :base64 => true, as: 'mediaId' + property :object_id_prop, as: 'objectId', class: Google::Apis::YoutubePartnerV1::ObjectIdProp, decorator: Google::Apis::YoutubePartnerV1::ObjectIdProp::Representation + + property :path, as: 'path' + property :reference_type, as: 'referenceType' + property :sha1_hash, :base64 => true, as: 'sha1Hash' + property :sha256_hash, :base64 => true, as: 'sha256Hash' + property :timestamp, :numeric_string => true, as: 'timestamp' + property :token, as: 'token' + end + end + + class MediaRequestInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :current_bytes, :numeric_string => true, as: 'currentBytes' + property :custom_data, as: 'customData' + property :diff_object_version, as: 'diffObjectVersion' + property :notification_type, as: 'notificationType' + property :request_id, as: 'requestId' + property :total_bytes, :numeric_string => true, as: 'totalBytes' + property :total_bytes_is_estimated, as: 'totalBytesIsEstimated' + end + end + + class MediaResponseInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_data, as: 'customData' + property :data_storage_transform, :base64 => true, as: 'dataStorageTransform' + property :dynamic_drop_target, :base64 => true, as: 'dynamicDropTarget' + property :dynamic_dropzone, as: 'dynamicDropzone' + property :media_for_diff, as: 'mediaForDiff', class: Google::Apis::YoutubePartnerV1::Media, decorator: Google::Apis::YoutubePartnerV1::Media::Representation + + property :request_class, as: 'requestClass' + property :traffic_class_field, as: 'trafficClassField' + property :verify_hash_from_header, as: 'verifyHashFromHeader' + end + end + class Metadata # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1149,8 +1267,7 @@ module Google property :origination, as: 'origination', class: Google::Apis::YoutubePartnerV1::Origination, decorator: Google::Apis::YoutubePartnerV1::Origination::Representation - property :time_provided, as: 'timeProvided', type: DateTime - + property :time_provided, as: 'timeProvided' end end @@ -1163,49 +1280,19 @@ module Google end end - class Order + class ObjectIdProp # @private class Representation < Google::Apis::Core::JsonRepresentation - property :avail_group_id, as: 'availGroupId' - property :channel_id, as: 'channelId' - property :content_type, as: 'contentType' - property :country, as: 'country' - property :custom_id, as: 'customId' - property :dvd_release_date, as: 'dvdReleaseDate', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation - - property :est_dates, as: 'estDates', class: Google::Apis::YoutubePartnerV1::DateRange, decorator: Google::Apis::YoutubePartnerV1::DateRange::Representation - - collection :events, as: 'events', class: Google::Apis::YoutubePartnerV1::StateCompleted, decorator: Google::Apis::YoutubePartnerV1::StateCompleted::Representation - - property :id, as: 'id' - property :kind, as: 'kind' - property :movie, as: 'movie' - property :original_release_date, as: 'originalReleaseDate', class: Google::Apis::YoutubePartnerV1::Date, decorator: Google::Apis::YoutubePartnerV1::Date::Representation - - property :priority, as: 'priority' - property :production_house, as: 'productionHouse' - property :purchase_order, as: 'purchaseOrder' - property :requirements, as: 'requirements', class: Google::Apis::YoutubePartnerV1::Requirements, decorator: Google::Apis::YoutubePartnerV1::Requirements::Representation - - property :show, as: 'show', class: Google::Apis::YoutubePartnerV1::ShowDetails, decorator: Google::Apis::YoutubePartnerV1::ShowDetails::Representation - - property :status, as: 'status' - property :video_id, as: 'videoId' - property :vod_dates, as: 'vodDates', class: Google::Apis::YoutubePartnerV1::DateRange, decorator: Google::Apis::YoutubePartnerV1::DateRange::Representation - + property :bucket_name, as: 'bucketName' + property :generation, :numeric_string => true, as: 'generation' + property :object_name, as: 'objectName' end end - class OrderListResponse + class Origin # @private class Representation < Google::Apis::Core::JsonRepresentation - collection :items, as: 'items', class: Google::Apis::YoutubePartnerV1::Order, decorator: Google::Apis::YoutubePartnerV1::Order::Representation - - property :kind, as: 'kind' - property :next_page_token, as: 'nextPageToken' - property :page_info, as: 'pageInfo', class: Google::Apis::YoutubePartnerV1::PageInfo, decorator: Google::Apis::YoutubePartnerV1::PageInfo::Representation - - property :previous_page_token, as: 'previousPageToken' + property :source, as: 'source' end end @@ -1253,8 +1340,7 @@ module Google property :status, as: 'status' collection :status_reports, as: 'statusReports', class: Google::Apis::YoutubePartnerV1::StatusReport, decorator: Google::Apis::YoutubePartnerV1::StatusReport::Representation - property :time_created, as: 'timeCreated', type: DateTime - + property :time_created, as: 'timeCreated' property :type, as: 'type' property :uploader_name, as: 'uploaderName' end @@ -1290,8 +1376,7 @@ module Google property :name, as: 'name' collection :rules, as: 'rules', class: Google::Apis::YoutubePartnerV1::PolicyRule, decorator: Google::Apis::YoutubePartnerV1::PolicyRule::Representation - property :time_updated, as: 'timeUpdated', type: DateTime - + property :time_updated, as: 'timeUpdated' end end @@ -1341,11 +1426,17 @@ module Google collection :excluded_intervals, as: 'excludedIntervals', class: Google::Apis::YoutubePartnerV1::ExcludedInterval, decorator: Google::Apis::YoutubePartnerV1::ExcludedInterval::Representation property :fp_direct, as: 'fpDirect' + property :gdata_media, as: 'gdataMedia', class: Google::Apis::YoutubePartnerV1::Media, decorator: Google::Apis::YoutubePartnerV1::Media::Representation + property :hash_code, as: 'hashCode' property :id, as: 'id' property :ignore_fp_match, as: 'ignoreFpMatch' property :kind, as: 'kind' property :length, as: 'length' + property :media_request_info, as: 'mediaRequestInfo', class: Google::Apis::YoutubePartnerV1::MediaRequestInfo, decorator: Google::Apis::YoutubePartnerV1::MediaRequestInfo::Representation + + property :media_response_info, as: 'mediaResponseInfo', class: Google::Apis::YoutubePartnerV1::MediaResponseInfo, decorator: Google::Apis::YoutubePartnerV1::MediaResponseInfo::Representation + property :origination, as: 'origination', class: Google::Apis::YoutubePartnerV1::Origination, decorator: Google::Apis::YoutubePartnerV1::Origination::Representation property :status, as: 'status' @@ -1359,8 +1450,7 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :conflicting_reference_id, as: 'conflictingReferenceId' - property :expiry_time, as: 'expiryTime', type: DateTime - + property :expiry_time, as: 'expiryTime' property :id, as: 'id' property :kind, as: 'kind' collection :matches, as: 'matches', class: Google::Apis::YoutubePartnerV1::ReferenceConflictMatch, decorator: Google::Apis::YoutubePartnerV1::ReferenceConflictMatch::Representation @@ -1404,18 +1494,6 @@ module Google end end - class Requirements - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :caption, as: 'caption' - property :hd_transcode, as: 'hdTranscode' - property :poster_art, as: 'posterArt' - property :spotlight_art, as: 'spotlightArt' - property :spotlight_review, as: 'spotlightReview' - property :trailer, as: 'trailer' - end - end - class RightsOwnership # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1439,8 +1517,7 @@ module Google property :ownership, as: 'ownership', class: Google::Apis::YoutubePartnerV1::RightsOwnership, decorator: Google::Apis::YoutubePartnerV1::RightsOwnership::Representation - property :time_provided, as: 'timeProvided', type: DateTime - + property :time_provided, as: 'timeProvided' end end @@ -1448,19 +1525,26 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :duration, :numeric_string => true, as: 'duration' + property :kind, as: 'kind' + property :start, :numeric_string => true, as: 'start' + end + end + + class Segment2 + # @private + class Representation < Google::Apis::Core::JsonRepresentation property :finish, as: 'finish' property :kind, as: 'kind' property :start, as: 'start' end end - class ShowDetails + class Source # @private class Representation < Google::Apis::Core::JsonRepresentation - property :episode_number, as: 'episodeNumber' - property :episode_title, as: 'episodeTitle' - property :season_number, as: 'seasonNumber' - property :title, as: 'title' + property :content_owner_id, as: 'contentOwnerId' + property :type, as: 'type' + property :user_email, as: 'userEmail' end end @@ -1485,14 +1569,6 @@ module Google end end - class StateCompleted - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :state, as: 'state' - property :time_completed, :numeric_string => true, as: 'timeCompleted' - end - end - class StatusReport # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1529,6 +1605,24 @@ module Google end end + class TotalMatch + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :reference_duration_secs, :numeric_string => true, as: 'referenceDurationSecs' + property :user_video_duration_secs, :numeric_string => true, as: 'userVideoDurationSecs' + end + end + + class TypeDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :appeal_explanation, as: 'appealExplanation' + property :dispute_notes, as: 'disputeNotes' + property :dispute_reason, as: 'disputeReason' + property :update_status, as: 'updateStatus' + end + end + class Uploader # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1665,6 +1759,13 @@ module Google end end + + class YoutubePartnerApiProtoFrontendV1Origin + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :source, as: 'source' + end + end end end end diff --git a/generated/google/apis/youtube_partner_v1/service.rb b/generated/google/apis/youtube_partner_v1/service.rb index 925736e78..c10da97f5 100644 --- a/generated/google/apis/youtube_partner_v1/service.rb +++ b/generated/google/apis/youtube_partner_v1/service.rb @@ -22,7 +22,8 @@ module Google module YoutubePartnerV1 # YouTube Content ID API # - # API for YouTube partners. To use this API a YouTube CMS account is required. + # The YouTube Content ID API allows the management of YouTube assets along with + # their associated content, references, ownership, rights and policies. # # @example # require 'google/apis/youtube_partner_v1' @@ -30,7 +31,7 @@ module Google # YoutubePartner = Google::Apis::YoutubePartnerV1 # Alias the module # service = YoutubePartner::YouTubePartnerService.new # - # @see https://developers.google.com/youtube/partner/ + # @see https://devsite.googleplex.com/youtube/partner/docs/v1/ class YouTubePartnerService < Google::Apis::Core::BaseService # @return [String] # API key. Your API key identifies your project and provides you with API access, @@ -38,32 +39,27 @@ module Google attr_accessor :key # @return [String] - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. attr_accessor :quota_user - # @return [String] - # Deprecated. Please use quotaUser instead. - attr_accessor :user_ip - def initialize - super('https://www.googleapis.com/', 'youtube/partner/v1/') - @batch_path = 'batch/youtubePartner/v1' + super('https://youtubepartner.googleapis.com/', '') + @batch_path = 'batch' end # Insert an asset label for an owner. # @param [Google::Apis::YoutubePartnerV1::AssetLabel] asset_label_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -76,8 +72,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_asset_label(asset_label_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'assetLabels', options) + def insert_asset_label(asset_label_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/assetLabels', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation command.request_object = asset_label_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabel::Representation @@ -85,27 +81,27 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of all asset labels for an owner. # @param [String] label_prefix - # The labelPrefix parameter identifies the prefix of asset labels to retrieve. + # The labelPrefix parameter identifies the + # prefix of asset labels to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] q - # The q parameter specifies the query string to use to filter search results. - # YouTube searches for the query string in the labelName field of asset labels. + # The q parameter specifies the query string to + # use to filter search results. YouTube searches for the query string in the + # labelName field of asset labels. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -118,8 +114,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_asset_labels(label_prefix: nil, on_behalf_of_content_owner: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assetLabels', options) + def list_asset_labels(label_prefix: nil, on_behalf_of_content_owner: nil, q: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assetLabels', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetLabelListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetLabelListResponse command.query['labelPrefix'] = label_prefix unless label_prefix.nil? @@ -127,7 +123,6 @@ module Google command.query['q'] = q unless q.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -135,19 +130,18 @@ module Google # owner associated with the authenticated user. This information is only # accessible to an owner of the asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset for which - # you are retrieving the match policy. + # The assetId parameter specifies the YouTube + # asset ID of the asset for which you are retrieving the match policy. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -160,37 +154,35 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_asset_match_policy(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assets/{assetId}/matchPolicy', options) + def get_asset_match_policy(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetMatchPolicy command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the asset's match policy. If an asset has multiple owners, each owner - # may set its own match policy for the asset. YouTube then computes the match - # policy that is actually applied for the asset based on the territories where - # each owner owns the asset. This method supports patch semantics. + # Patches the asset's match policy. If an asset has multiple owners, each + # owner may set its own match policy for the asset. YouTube then computes the + # match policy that is actually applied for the asset based on the + # territories where each owner owns the asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset for which - # you are retrieving the match policy. + # The assetId parameter specifies the YouTube + # asset ID of the asset for which you are retrieving the match policy. # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -203,8 +195,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'assets/{assetId}/matchPolicy', options) + def patch_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.request_object = asset_match_policy_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation @@ -213,29 +205,27 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the asset's match policy. If an asset has multiple owners, each owner - # may set its own match policy for the asset. YouTube then computes the match - # policy that is actually applied for the asset based on the territories where - # each owner owns the asset. + # Updates the asset's match policy. If an asset has multiple owners, each + # owner may set its own match policy for the asset. YouTube then computes the + # match policy that is actually applied for the asset based on the + # territories where each owner owns the asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset for which - # you are retrieving the match policy. + # The assetId parameter specifies the YouTube + # asset ID of the asset for which you are retrieving the match policy. # @param [Google::Apis::YoutubePartnerV1::AssetMatchPolicy] asset_match_policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -248,8 +238,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'assets/{assetId}/matchPolicy', options) + def update_asset_match_policy(asset_id, asset_match_policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}/matchPolicy', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation command.request_object = asset_match_policy_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetMatchPolicy::Representation @@ -258,60 +248,58 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes a relationship between two assets. # @param [String] asset_relationship_id - # The assetRelationshipId parameter specifies a value that uniquely identifies - # the relationship you are deleting. + # The assetRelationshipId parameter specifies a + # value that uniquely identifies the relationship you are deleting. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::YoutubePartnerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::YoutubePartnerV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'assetRelationships/{assetRelationshipId}', options) + def delete_asset_relationship(asset_relationship_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'youtube/partner/v1/assetRelationships/{assetRelationshipId}', options) + command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation + command.response_class = Google::Apis::YoutubePartnerV1::Empty command.params['assetRelationshipId'] = asset_relationship_id unless asset_relationship_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a relationship that links two assets. # @param [Google::Apis::YoutubePartnerV1::AssetRelationship] asset_relationship_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -324,8 +312,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_asset_relationship(asset_relationship_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'assetRelationships', options) + def insert_asset_relationship(asset_relationship_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/assetRelationships', options) command.request_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation command.request_object = asset_relationship_object command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationship::Representation @@ -333,7 +321,6 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -341,23 +328,23 @@ module Google # relationships where the specified asset is either the parent (embedding) or # child (embedded) asset in the relationship. # @param [String] asset_id - # The assetId parameter specifies the asset ID of the asset for which you are - # retrieving relationships. + # The assetId parameter specifies the asset ID + # of the asset for which you are retrieving relationships. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. Set this parameter to the value of the nextPageToken value - # from the previous API response to retrieve the next page of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. Set this parameter + # to the value of the nextPageToken value from the previous API + # response to retrieve the next page of search results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -370,8 +357,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assetRelationships', options) + def list_asset_relationships(asset_id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assetRelationships', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse command.query['assetId'] = asset_id unless asset_id.nil? @@ -379,72 +366,82 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Searches for assets based on asset metadata. The method can retrieve all # assets or only assets owned by the content owner. This method mimics the - # functionality of the advanced search feature on the Assets page in CMS. - # @param [DateTime] created_after - # The createdAfter parameter restricts the set of returned assets to ones - # originally created on or after the specified datetime. For example: 2015-01- - # 29T23:00:00Z - # @param [DateTime] created_before - # The createdBefore parameter restricts the set of returned assets to ones - # originally created on or before the specified datetime. For example: 2015-01- - # 29T23:00:00Z + # functionality of the advanced search feature on the Assets page in CMS. + # @param [String] created_after + # The createdAfter parameter restricts the set + # of returned assets to ones originally created on or after the specified + # datetime. For example: 2015-01-29T23:00:00Z + # @param [String] created_before + # The createdBefore parameter restricts the set + # of returned assets to ones originally created on or before the specified + # datetime. For example: 2015-01-29T23:00:00Z # @param [Boolean] has_conflicts - # The hasConflicts parameter enables you to only retrieve assets that have - # ownership conflicts. The only valid value is true. Setting the parameter value - # to false does not affect the results. + # The hasConflicts parameter enables you to + # only retrieve assets that have ownership conflicts. The only valid value is + # true. Setting the parameter value to false does + # not affect the results. # @param [Boolean] include_any_providedlabel - # If includeAnyProvidedlabel parameter is set to true, will search for assets - # that contain any of the provided labels; else will search for assets that - # contain all the provided labels. + # If includeAnyProvidedlabel parameter is set + # to true, will search for assets that contain any of the provided labels; + # else will search for assets that contain all the provided labels. # @param [String] isrcs # A comma-separated list of up to 50 ISRCs. If you specify a value for this - # parameter, the API server ignores any values set for the following parameters: - # q, includeAnyProvidedLabel, hasConflicts, labels, metadataSearchFields, sort, - # and type. + # parameter, the API server ignores any values set for the following + # parameters: q, includeAnyProvidedLabel, + # hasConflicts, labels, + # metadataSearchFields, sort, and + # type. # @param [String] labels - # The labels parameter specifies the assets with certain asset labels that you - # want to retrieve. The parameter value is a comma-separated list of asset - # labels. + # The labels parameter specifies the assets + # with certain asset labels that you want to retrieve. The parameter value is + # a comma-separated list of asset labels. # @param [String] metadata_search_fields - # The metadataSearchField parameter specifies which metadata fields to search by. - # It is a comma-separated list of metadata field and value pairs connected by - # colon(:). For example: customId:my_custom_id,artist:Dandexx + # The metadataSearchField parameter specifies + # which metadata fields to search by. It is a comma-separated list of + # metadata field and value pairs connected by colon(:). For example: + # customId:my_custom_id,artist:Dandexx # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] ownership_restriction - # The ownershipRestriction parameter specifies the ownership filtering option - # for the search. By default the search is performed in the assets owned by - # currently authenticated user only. + # The ownershipRestriction parameter specifies + # the ownership filtering option for the search. By default the search is + # performed in the assets owned by currently authenticated user only. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. Set this parameter to the value of the nextPageToken value - # from the previous API response to retrieve the next page of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. Set this parameter + # to the value of the nextPageToken value from the previous API + # response to retrieve the next page of search results. # @param [String] q - # YouTube searches within the id, type, and customId fields for all assets as - # well as in numerous other metadata fields – such as actor, album, director, - # isrc, and tmsId – that vary for different types of assets (movies, music - # videos, etc.). + # YouTube searches within the id, + # type, and + # customId fields for all assets as well as in + # numerous other metadata fields – such as + # actor, album, + # director, isrc, + # and tmsId – that vary for different + # types of assets (movies, music videos, etc.). # @param [String] sort - # The sort parameter specifies how the search results should be sorted. Note - # that results are always sorted in descending order. + # The sort parameter specifies how the search + # results should be sorted. Note that results are always sorted in descending + # order. # @param [String] type - # The type parameter specifies the types of assets that you want to retrieve. - # The parameter value is a comma-separated list of asset types. + # The type parameter specifies the types of + # assets that you want to retrieve. The parameter value is a comma-separated + # list of asset types. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -457,8 +454,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_asset_searches(created_after: nil, created_before: nil, has_conflicts: nil, include_any_providedlabel: nil, isrcs: nil, labels: nil, metadata_search_fields: nil, on_behalf_of_content_owner: nil, ownership_restriction: nil, page_token: nil, q: nil, sort: nil, type: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assetSearch', options) + def list_asset_searches(created_after: nil, created_before: nil, has_conflicts: nil, include_any_providedlabel: nil, isrcs: nil, labels: nil, metadata_search_fields: nil, on_behalf_of_content_owner: nil, ownership_restriction: nil, page_token: nil, q: nil, sort: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assetSearch', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetSearchResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetSearchResponse command.query['createdAfter'] = created_after unless created_after.nil? @@ -476,35 +473,35 @@ module Google command.query['type'] = type unless type.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # This method either retrieves a list of asset shares the partner owns and that - # map to a specified asset view ID or it retrieves a list of asset views - # associated with a specified asset share ID owned by the partner. + # This method either retrieves a list of asset shares the partner owns and + # that map to a specified asset view ID or it retrieves a list of + # asset views associated with a specified asset share ID owned by the + # partner. # @param [String] asset_id - # The assetId parameter specifies the asset ID for which you are retrieving data. - # The parameter can be an asset view ID or an asset share ID. - # - If the value is an asset view ID, the API response identifies any asset - # share ids mapped to the asset view. - # - If the value is an asset share ID, the API response identifies any asset - # view ids that maps to that asset share. + # The assetId parameter specifies the asset ID + # for which you are retrieving data. The parameter can be an asset view ID or + # an asset share ID.
  • If the value is an asset view ID, the API + # response identifies any asset share ids mapped to the asset + # view.
  • If the value is an asset share ID, the API response + # identifies any asset view ids that maps to that asset share.
# @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. Set this parameter to the value of the nextPageToken value - # from the previous API response to retrieve the next page of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. Set this parameter + # to the value of the nextPageToken value from the previous API + # response to retrieve the next page of search results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -517,8 +514,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assetShares', options) + def list_asset_shares(asset_id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assetShares', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetShareListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetShareListResponse command.query['assetId'] = asset_id unless asset_id.nil? @@ -526,7 +523,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -535,34 +531,37 @@ module Google # YouTube identified the requested asset as a duplicate, then the request # retrieves the merged, or synthesized, asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset being - # retrieved. + # The assetId parameter specifies the YouTube + # asset ID of the asset being retrieved. # @param [String] fetch_match_policy - # The fetchMatchPolicy parameter specifies the version of the asset's match - # policy that should be returned in the API response. + # The fetchMatchPolicy parameter specifies the + # version of the + # asset's match policy that should be returned in the API response. # @param [String] fetch_metadata - # The fetchMetadata parameter specifies the version of the asset's metadata that - # should be returned in the API response. In some cases, YouTube receives - # metadata for an asset from multiple sources, such as when different partners - # own the asset in different territories. + # The fetchMetadata parameter specifies the + # version of the + # asset's metadata that should be returned in the API response. In some + # cases, YouTube receives metadata for an asset from multiple sources, such + # as when different partners own the asset in different territories. # @param [String] fetch_ownership - # The fetchOwnership parameter specifies the version of the asset's ownership - # data that should be returned in the API response. As with asset metadata, - # YouTube can receive asset ownership data from multiple sources. + # The fetchOwnership parameter specifies the + # version of the + # asset's ownership data that should be returned in the API response. As with + # asset metadata, YouTube can receive asset ownership data from multiple + # sources. # @param [Boolean] fetch_ownership_conflicts - # The fetchOwnershipConflicts parameter allows you to retrieve information about - # ownership conflicts. + # The fetchOwnershipConflicts parameter allows + # you to retrieve information about ownership conflicts. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -575,8 +574,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_asset(asset_id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assets/{assetId}', options) + def get_asset(asset_id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.response_class = Google::Apis::YoutubePartnerV1::Asset command.params['assetId'] = asset_id unless asset_id.nil? @@ -587,24 +586,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts an asset with the specified metadata. After inserting an asset, you - # can set its ownership data and match policy. + # can set its ownership + # data and match policy. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -617,8 +616,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'assets', options) + def insert_asset(asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/assets', options) command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.request_object = asset_object command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation @@ -626,51 +625,55 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of assets based on asset metadata. The method can retrieve - # all assets or only assets owned by the content owner. - # Note that in cases where duplicate assets have been merged, the API response - # only contains the synthesized asset. (It does not contain the constituent - # assets that were merged into the synthesized asset.) - # @param [String] id - # The id parameter specifies a comma-separated list of YouTube Asset IDs that - # identify the assets you want to retrieve. As noted in the method description, - # if you try to retrieve an asset that YouTube identified as a duplicate and - # merged with another asset, the API response only returns the synthesized asset. - # In that case, the aliasId property in the asset resource specifies a list of - # other asset IDs that can be used to identify that asset. - # Also note that the API response does not contain duplicates. As such, if your - # request identifies three asset IDs, and all of those have been merged into a - # single asset, then the API response identifies one matching asset. + # all assets or only assets owned by the content owner.

Note that in + # cases where duplicate assets have been merged, the API response only + # contains the synthesized asset. (It does not contain the constituent assets + # that were merged into the synthesized asset.) # @param [String] fetch_match_policy - # The fetchMatchPolicy parameter specifies the version of the asset's match - # policy that should be returned in the API response. + # The fetchMatchPolicy parameter specifies the + # version of the + # asset's match policy that should be returned in the API response. # @param [String] fetch_metadata - # The fetchMetadata parameter specifies the version of the asset's metadata that - # should be returned in the API response. In some cases, YouTube receives - # metadata for an asset from multiple sources, such as when different partners - # own the asset in different territories. + # The fetchMetadata parameter specifies the + # version of the + # asset's metadata that should be returned in the API response. In some + # cases, YouTube receives metadata for an asset from multiple sources, such + # as when different partners own the asset in different territories. # @param [String] fetch_ownership - # The fetchOwnership parameter specifies the version of the asset's ownership - # data that should be returned in the API response. As with asset metadata, - # YouTube can receive asset ownership data from multiple sources. + # The fetchOwnership parameter specifies the + # version of the + # asset's ownership data that should be returned in the API response. As with + # asset metadata, YouTube can receive asset ownership data from multiple + # sources. # @param [Boolean] fetch_ownership_conflicts - # The fetchOwnershipConflicts parameter allows you to retrieve information about - # ownership conflicts. + # The fetchOwnershipConflicts parameter allows + # you to retrieve information about ownership conflicts. + # @param [String] id + # The id parameter specifies a comma-separated + # list of YouTube Asset IDs that identify the assets you want to retrieve. As + # noted in the method description, if you try to retrieve an asset that + # YouTube identified as a duplicate and merged with another asset, the API + # response only returns the synthesized asset. In that case, the + # aliasId property in the asset resource specifies + # a list of other asset IDs that can be used to identify that + # asset.

Also note that the API response does not contain + # duplicates. As such, if your request identifies three asset IDs, and all of + # those have been merged into a single asset, then the API response + # identifies one matching asset. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -683,8 +686,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_assets(id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assets', options) + def list_assets(fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assets', options) command.response_representation = Google::Apis::YoutubePartnerV1::AssetListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::AssetListResponse command.query['fetchMatchPolicy'] = fetch_match_policy unless fetch_match_policy.nil? @@ -695,26 +698,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Patches the metadata for the specified asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset being - # patched. + # The assetId parameter specifies the YouTube + # asset ID of the asset being patched. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -727,8 +728,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'assets/{assetId}', options) + def patch_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.request_object = asset_object command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation @@ -737,26 +738,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates the metadata for the specified asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset being - # updated. + # The assetId parameter specifies the YouTube + # asset ID of the asset being updated. # @param [Google::Apis::YoutubePartnerV1::Asset] asset_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -769,8 +768,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'assets/{assetId}', options) + def update_asset(asset_id, asset_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Asset::Representation command.request_object = asset_object command.response_representation = Google::Apis::YoutubePartnerV1::Asset::Representation @@ -779,62 +778,60 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Deletes a specified campaign for an owner. # @param [String] campaign_id - # The campaignId parameter specifies the YouTube campaign ID of the campaign - # being deleted. + # The campaignId parameter specifies the + # YouTube campaign ID of the campaign being deleted. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::YoutubePartnerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::YoutubePartnerV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'campaigns/{campaignId}', options) + def delete_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'youtube/partner/v1/campaigns/{campaignId}', options) + command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation + command.response_class = Google::Apis::YoutubePartnerV1::Empty command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a particular campaign for an owner. # @param [String] campaign_id - # The campaignId parameter specifies the YouTube campaign ID of the campaign - # being retrieved. + # The campaignId parameter specifies the + # YouTube campaign ID of the campaign being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -847,31 +844,29 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'campaigns/{campaignId}', options) + def get_campaign(campaign_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/campaigns/{campaignId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.response_class = Google::Apis::YoutubePartnerV1::Campaign command.params['campaignId'] = campaign_id unless campaign_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Insert a new campaign for an owner using the specified campaign data. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -884,8 +879,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_campaign(campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'campaigns', options) + def insert_campaign(campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/campaigns', options) command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation @@ -893,27 +888,25 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of campaigns for an owner. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. For example, set this parameter to the value of the - # nextPageToken value from the previous API response to retrieve the next page - # of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. For example, set + # this parameter to the value of the nextPageToken value from + # the previous API response to retrieve the next page of search results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -926,34 +919,32 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_campaigns(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'campaigns', options) + def list_campaigns(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/campaigns', options) command.response_representation = Google::Apis::YoutubePartnerV1::CampaignList::Representation command.response_class = Google::Apis::YoutubePartnerV1::CampaignList command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Update the data for a specific campaign. This method supports patch semantics. + # Patch the data for a specific campaign. # @param [String] campaign_id - # The campaignId parameter specifies the YouTube campaign ID of the campaign - # being retrieved. + # The campaignId parameter specifies the + # YouTube campaign ID of the campaign being retrieved. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -966,8 +957,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'campaigns/{campaignId}', options) + def patch_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/campaigns/{campaignId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation @@ -976,26 +967,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Update the data for a specific campaign. # @param [String] campaign_id - # The campaignId parameter specifies the YouTube campaign ID of the campaign - # being retrieved. + # The campaignId parameter specifies the + # YouTube campaign ID of the campaign being retrieved. # @param [Google::Apis::YoutubePartnerV1::Campaign] campaign_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1008,8 +997,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'campaigns/{campaignId}', options) + def update_campaign(campaign_id, campaign_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/campaigns/{campaignId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation command.request_object = campaign_object command.response_representation = Google::Apis::YoutubePartnerV1::Campaign::Representation @@ -1018,25 +1007,23 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the claim history for a specified claim. # @param [String] claim_id - # The claimId parameter specifies the YouTube claim ID of the claim for which - # you are retrieving the claim history. + # The claimId parameter specifies the YouTube + # claim ID of the claim for which you are retrieving the claim history. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1049,91 +1036,103 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_claim_history(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'claimHistory/{claimId}', options) + def get_claim_history(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/claimHistory/{claimId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::ClaimHistory::Representation command.response_class = Google::Apis::YoutubePartnerV1::ClaimHistory command.params['claimId'] = claim_id unless claim_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves a list of claims that match the search criteria. You can search for - # claims that are associated with a specific asset or video or that match a - # specified query string. + # Retrieves a list of claims that match the search criteria. You can search + # for claims that are associated with a specific asset or video or that match + # a specified query string. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset for which - # you are retrieving claims. + # The assetId parameter specifies the YouTube + # asset ID of the asset for which you are retrieving claims. # @param [String] content_type - # The contentType parameter specifies the content type of claims that you want - # to retrieve. - # @param [DateTime] created_after - # The createdAfter parameter allows you to restrict the set of returned claims - # to ones created on or after the specified date (inclusive). - # @param [DateTime] created_before - # The createdBefore parameter allows you to restrict the set of returned claims - # to ones created before the specified date (exclusive). + # The contentType parameter specifies the + # content type of claims that you want to retrieve. + # @param [String] created_after + # The createdAfter parameter allows you to + # restrict the set of returned claims to ones created on or after the + # specified date (inclusive). + # @param [String] created_before + # The createdBefore parameter allows you to + # restrict the set of returned claims to ones created before the specified + # date (exclusive). # @param [String] inactive_reasons - # The inactiveReasons parameter allows you to specify what kind of inactive - # claims you want to find based on the reasons why the claims became inactive. + # The inactiveReasons parameter allows you to + # specify what kind of inactive claims you want to find based on the reasons + # why the claims became inactive. # @param [Boolean] include_third_party_claims - # Used along with the videoId parameter this parameter determines whether or not - # to include third party claims in the search results. + # Used along with the videoId parameter this + # parameter determines whether or not to include third party claims in the + # search results. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] origin - # The origin parameter specifies the origins you want to find claims for. It is - # a comma-separated list of origin values. + # The origin parameter specifies the origins + # you want to find claims for. It is a comma-separated list of origin values. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. For example, set this parameter to the value of the - # nextPageToken value from the previous API response to retrieve the next page - # of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. For example, set + # this parameter to the value of the nextPageToken value from + # the previous API response to retrieve the next page of search results. # @param [Boolean] partner_uploaded - # The partnerUploaded parameter specifies whether you want to filter your search - # results to only partner uploaded or non partner uploaded claims. + # The partnerUploaded parameter specifies + # whether you want to filter your search results to only partner uploaded or + # non partner uploaded claims. # @param [String] q - # The q parameter specifies the query string to use to filter search results. - # YouTube searches for the query string in the following claim fields: - # video_title, video_keywords, user_name, isrc, iswc, grid, custom_id, and in - # the content owner's email address. + # The q parameter specifies the query string to + # use to filter search results. YouTube searches for the query string in the + # following claim fields: video_title, + # video_keywords, + # user_name, + # isrc, iswc, + # grid, + # custom_id, and in the content + # owner's email address. # @param [String] reference_id - # The referenceId parameter specifies the YouTube reference ID of the reference - # for which you are retrieving claims. + # The referenceId parameter specifies the + # YouTube reference ID of the reference for which you are retrieving claims. # @param [String] sort - # The sort parameter specifies the method that will be used to order resources - # in the API response. The default value is date. However, if the status - # parameter value is either appealed, disputed, pending, potential, or - # routedForReview, then results will be sorted by the time that the claim review - # period expires. + # The sort parameter specifies the method that + # will be used to order resources in the API response. The default value is + # date. However, if the status parameter value is + # either appealed, disputed, pending, + # potential, or routedForReview, then results will + # be sorted by the time that the claim review period expires. # @param [String] status - # The status parameter restricts your results to only claims in the specified - # status. - # @param [DateTime] status_modified_after - # The statusModifiedAfter parameter allows you to restrict the result set to - # only include claims that have had their status modified on or after the - # specified date (inclusive). The date specified must be on or after June 30, - # 2016 (2016-06-30). The parameter value's format is YYYY-MM-DD. - # @param [DateTime] status_modified_before - # The statusModifiedBefore parameter allows you to restrict the result set to - # only include claims that have had their status modified before the specified - # date (exclusive). The date specified must be on or after July 1, 2016 (2016-07- - # 01). The parameter value's format is YYYY-MM-DD. + # The status parameter restricts your results + # to only claims in the specified status. + # @param [String] status_modified_after + # The statusModifiedAfter parameter allows you + # to restrict the result set to only include claims that have had their + # status modified on or after the specified date (inclusive). The date + # specified must be on or after June 30, 2016 (2016-06-30). The parameter + # value's format is YYYY-MM-DD. + # @param [String] status_modified_before + # The statusModifiedBefore parameter allows you + # to restrict the result set to only include claims that have had their + # status modified before the specified date (exclusive). The date specified + # must be on or after July 1, 2016 (2016-07-01). The parameter + # value's format is YYYY-MM-DD. # @param [String] video_id - # The videoId parameter specifies comma-separated list of YouTube video IDs for - # which you are retrieving claims. + # The videoId parameter specifies + # comma-separated list of YouTube video IDs for which you are retrieving + # claims. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1146,8 +1145,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_claim_searches(asset_id: nil, content_type: nil, created_after: nil, created_before: nil, inactive_reasons: nil, include_third_party_claims: nil, on_behalf_of_content_owner: nil, origin: nil, page_token: nil, partner_uploaded: nil, q: nil, reference_id: nil, sort: nil, status: nil, status_modified_after: nil, status_modified_before: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'claimSearch', options) + def list_claim_searches(asset_id: nil, content_type: nil, created_after: nil, created_before: nil, inactive_reasons: nil, include_third_party_claims: nil, on_behalf_of_content_owner: nil, origin: nil, page_token: nil, partner_uploaded: nil, q: nil, reference_id: nil, sort: nil, status: nil, status_modified_after: nil, status_modified_before: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/claimSearch', options) command.response_representation = Google::Apis::YoutubePartnerV1::ClaimSearchResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ClaimSearchResponse command.query['assetId'] = asset_id unless asset_id.nil? @@ -1169,24 +1168,23 @@ module Google command.query['videoId'] = video_id unless video_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a specific claim by ID. # @param [String] claim_id - # The claimId parameter specifies the claim ID of the claim being retrieved. + # The claimId parameter specifies the claim ID + # of the claim being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1199,38 +1197,38 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_claim(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'claims/{claimId}', options) + def get_claim(claim_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/claims/{claimId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.response_class = Google::Apis::YoutubePartnerV1::Claim command.params['claimId'] = claim_id unless claim_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a claim. The video being claimed must have been uploaded to a channel - # associated with the same content owner as the API user sending the request. - # You can set the claim's policy in any of the following ways: - # - Use the claim resource's policy property to identify a saved policy by its - # unique ID. - # - Use the claim resource's policy property to specify a custom set of rules. + # Creates a claim. The video being claimed must have been uploaded to a + # channel associated with the same content owner as the API user sending the + # request. You can set the + # claim's policy in any of the following ways:
  • Use the + # claim resource's policy property to identify a + # saved policy by its unique ID.
  • Use the claim + # resource's policy property to specify a custom set of + # rules.
# @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [Boolean] is_manual_claim # restricted # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1243,8 +1241,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_claim(claim_object = nil, is_manual_claim: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'claims', options) + def insert_claim(claim_object = nil, is_manual_claim: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/claims', options) command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.request_object = claim_object command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation @@ -1253,47 +1251,52 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves a list of claims administered by the content owner associated with - # the currently authenticated user. Results are sorted in descending order of - # creation time. + # Retrieves a list of claims administered by the content owner associated + # with the currently authenticated user. Results are sorted in descending + # order of creation time. # @param [String] asset_id - # Use the claimSearch.list method's assetId parameter to search for claim - # snippets by asset ID. You can then retrieve the claim resources for those - # claims by using this method's id parameter to specify a comma-separated list - # of claim IDs. + # Use the claimSearch.list method's assetId + # parameter to search for claim snippets by asset ID. You can then retrieve + # the claim resources for those claims by using this + # method's id parameter to specify a + # comma-separated list of claim IDs. # @param [String] id - # The id parameter specifies a list of comma-separated YouTube claim IDs to - # retrieve. + # The id parameter specifies a list of + # comma-separated YouTube claim IDs to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. For example, set this parameter to the value of the - # nextPageToken value from the previous API response to retrieve the next page - # of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. For example, set + # this parameter to the value of the nextPageToken value from + # the previous API response to retrieve the next page of search results. # @param [String] q - # Use the claimSearch.list method's q parameter to search for claim snippets - # that match a particular query string. You can then retrieve the claim - # resources for those claims by using this method's id parameter to specify a + # Use the claimSearch.list method's q parameter + # to search for claim snippets that match a particular query string. You can + # then retrieve the claim resources for those claims by using + # this + # method's id parameter to specify a # comma-separated list of claim IDs. # @param [String] video_id - # Use the claimSearch.list method's videoId parameter to search for claim - # snippets by video ID. You can then retrieve the claim resources for those - # claims by using this method's id parameter to specify a comma-separated list - # of claim IDs. + # Use the claimSearch.list method's videoId + # parameter to search for claim snippets by video ID. You can then retrieve + # the claim resources for those claims by using this + # method's id parameter to specify a + # comma-separated list of claim IDs. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1306,8 +1309,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_claims(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, q: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'claims', options) + def list_claims(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, q: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/claims', options) command.response_representation = Google::Apis::YoutubePartnerV1::ClaimListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ClaimListResponse command.query['assetId'] = asset_id unless asset_id.nil? @@ -1318,27 +1321,27 @@ module Google command.query['videoId'] = video_id unless video_id.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Patches an existing claim by either changing its policy or its status. You can - # update a claim's status from active to inactive to effectively release the - # claim. + # Patches an existing claim by either changing its policy or its status. You + # can update a + # claim's status from active to inactive to + # effectively release the claim. # @param [String] claim_id - # The claimId parameter specifies the claim ID of the claim being updated. + # The claimId parameter specifies the claim ID + # of the claim being updated. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1351,8 +1354,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'claims/{claimId}', options) + def patch_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/claims/{claimId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.request_object = claim_object command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation @@ -1361,27 +1364,27 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates an existing claim by either changing its policy or its status. You can - # update a claim's status from active to inactive to effectively release the - # claim. + # Updates an existing claim by either changing its policy or its status. You + # can update a + # claim's status from active to inactive to + # effectively release the claim. # @param [String] claim_id - # The claimId parameter specifies the claim ID of the claim being updated. + # The claimId parameter specifies the claim ID + # of the claim being updated. # @param [Google::Apis::YoutubePartnerV1::Claim] claim_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1394,8 +1397,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'claims/{claimId}', options) + def update_claim(claim_id, claim_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/claims/{claimId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Claim::Representation command.request_object = claim_object command.response_representation = Google::Apis::YoutubePartnerV1::Claim::Representation @@ -1404,139 +1407,23 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves advertising options for the content owner associated with the - # authenticated user. - # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_content_owner_advertising_option(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'contentOwnerAdvertisingOptions', options) - command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation - command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates advertising options for the content owner associated with the - # authenticated API user. This method supports patch semantics. - # @param [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] content_owner_advertising_option_object - # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'contentOwnerAdvertisingOptions', options) - command.request_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation - command.request_object = content_owner_advertising_option_object - command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation - command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Updates advertising options for the content owner associated with the - # authenticated API user. - # @param [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] content_owner_advertising_option_object - # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_content_owner_advertising_option(content_owner_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'contentOwnerAdvertisingOptions', options) - command.request_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation - command.request_object = content_owner_advertising_option_object - command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption::Representation - command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerAdvertisingOption - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves information about the specified content owner. # @param [String] content_owner_id - # The contentOwnerId parameter specifies a value that uniquely identifies the - # content owner. + # The contentOwnerId parameter specifies a + # value that uniquely identifies the content owner. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1549,36 +1436,36 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_content_owner(content_owner_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'contentOwners/{contentOwnerId}', options) + def get_content_owner(content_owner_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/contentOwners/{contentOwnerId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwner::Representation command.response_class = Google::Apis::YoutubePartnerV1::ContentOwner command.params['contentOwnerId'] = content_owner_id unless content_owner_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves a list of content owners that match the request criteria. + # Retrieves a list of content owners + # that match the request criteria. # @param [Boolean] fetch_mine - # The fetchMine parameter restricts the result set to content owners associated - # with the currently authenticated API user. + # The fetchMine parameter restricts the result + # set to content owners associated with the currently authenticated API user. # @param [String] id - # The id parameter specifies a comma-separated list of YouTube content owner IDs - # to retrieve. + # The id parameter specifies a comma-separated + # list of YouTube content owner IDs to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1591,8 +1478,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_content_owners(fetch_mine: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'contentOwners', options) + def list_content_owners(fetch_mine: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/contentOwners', options) command.response_representation = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ContentOwnerListResponse command.query['fetchMine'] = fetch_mine unless fetch_mine.nil? @@ -1600,28 +1487,29 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a cuepoint into a live broadcast. - # @param [String] channel_id - # The channelId parameter identifies the channel that owns the broadcast into - # which the cuepoint is being inserted. # @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object + # @param [String] channel_id + # The channelId parameter identifies the + # channel that owns the broadcast into which the cuepoint is being inserted. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. You can obtain the content owner ID - # that will serve as the parameter value by calling the YouTube Content ID API's - # contentOwners.list method. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. You can obtain the content owner ID that will serve as the + # parameter value by calling the YouTube Content ID + # API's contentOwners.list + # method. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1634,8 +1522,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'liveCuepoints', options) + def insert_live_cuepoint(live_cuepoint_object = nil, channel_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/liveCuepoints', options) command.request_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation command.request_object = live_cuepoint_object command.response_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation @@ -1644,26 +1532,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of all metadata provided for an asset, regardless of which # content owner provided the data. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset for which - # you are retrieving a metadata history. + # The assetId parameter specifies the YouTube + # asset ID of the asset for which you are retrieving a metadata history. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1676,294 +1562,32 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_metadata_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'metadataHistory', options) + def list_metadata_histories(asset_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/metadataHistory', options) command.response_representation = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Delete an order, which moves orders to inactive state and removes any - # associated video. - # @param [String] order_id - # Id of the order to delete. - # @param [String] on_behalf_of_content_owner - # ContentOwnerId that super admin acts in behalf of. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'orders/{orderId}', options) - command.params['orderId'] = order_id unless order_id.nil? - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieve the details of an existing order. - # @param [String] order_id - # The id of the order. - # @param [String] on_behalf_of_content_owner - # ContentOnwerId that super admin acts in behalf of. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::Order] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_order(order_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'orders/{orderId}', options) - command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation - command.response_class = Google::Apis::YoutubePartnerV1::Order - command.params['orderId'] = order_id unless order_id.nil? - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new basic order entry in the YouTube premium asset order management - # system. You must supply at least a country and channel in the new order. - # @param [Google::Apis::YoutubePartnerV1::Order] order_object - # @param [String] on_behalf_of_content_owner - # ContentOnwerId that super admin acts in behalf of. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::Order] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_order(order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'orders', options) - command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation - command.request_object = order_object - command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation - command.response_class = Google::Apis::YoutubePartnerV1::Order - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Return a list of orders, filtered by the parameters below, may return more - # than a single page of results. - # @param [String] channel_id - # Filter results to only a specific channel ( use encrypted ID). - # @param [String] content_type - # Filter the results by type, possible values are SHOW or MOVIE. - # @param [String] country - # Filter results by country, two letter ISO country codes are used. - # @param [String] custom_id - # Filter result by orders that have this custom ID. - # @param [String] on_behalf_of_content_owner - # ContentOnwerId that super admin acts in behalf of. - # @param [String] page_token - # The continuation token is an optional value that is only used to page through - # large result sets. - # - To retrieve the next page of results for a request, set this parameter to - # the value of the nextPageToken value from the previous response. - # - To get the previous page of results, set this parameter to the value of the - # previousPageToken value from the previous response. - # @param [String] priority - # Filter results by priority. P0, P1, P2, P3 and P4 are the acceptable options. - # @param [String] production_house - # Filter results by a particular production house. Specified by the name of the - # production house. - # @param [String] q - # Filter results to only orders that contain this string in the title. - # @param [String] status - # Filter results to have this status, available options are STATUS_AVAILED, - # STATUS_ORDERED, STATUS_RECEIVED, STATUS_READY_FOR_QC, STATUS_MOC_FIX, - # STATUS_PARTNER_FIX, STATUS_YOUTUBE_FIX, STATUS_QC_APPROVED, STATUS_INACTIVE, - # STATUS_INGESTION_COMPLETE, STATUS_REORDERED - # @param [String] video_id - # Filter results to orders that are associated with this YouTube external video - # id. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::OrderListResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::OrderListResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_orders(channel_id: nil, content_type: nil, country: nil, custom_id: nil, on_behalf_of_content_owner: nil, page_token: nil, priority: nil, production_house: nil, q: nil, status: nil, video_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'orders', options) - command.response_representation = Google::Apis::YoutubePartnerV1::OrderListResponse::Representation - command.response_class = Google::Apis::YoutubePartnerV1::OrderListResponse - command.query['channelId'] = channel_id unless channel_id.nil? - command.query['contentType'] = content_type unless content_type.nil? - command.query['country'] = country unless country.nil? - command.query['customId'] = custom_id unless custom_id.nil? - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['priority'] = priority unless priority.nil? - command.query['productionHouse'] = production_house unless production_house.nil? - command.query['q'] = q unless q.nil? - command.query['status'] = status unless status.nil? - command.query['videoId'] = video_id unless video_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Update the values in an existing order. This method supports patch semantics. - # @param [String] order_id - # The id of the order. - # @param [Google::Apis::YoutubePartnerV1::Order] order_object - # @param [String] on_behalf_of_content_owner - # ContentOwnerId that super admin acts in behalf of. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::Order] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'orders/{orderId}', options) - command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation - command.request_object = order_object - command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation - command.response_class = Google::Apis::YoutubePartnerV1::Order - command.params['orderId'] = order_id unless order_id.nil? - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Update the values in an existing order. - # @param [String] order_id - # The id of the order. - # @param [Google::Apis::YoutubePartnerV1::Order] order_object - # @param [String] on_behalf_of_content_owner - # ContentOwnerId that super admin acts in behalf of. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::YoutubePartnerV1::Order] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::YoutubePartnerV1::Order] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_order(order_id, order_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'orders/{orderId}', options) - command.request_representation = Google::Apis::YoutubePartnerV1::Order::Representation - command.request_object = order_object - command.response_representation = Google::Apis::YoutubePartnerV1::Order::Representation - command.response_class = Google::Apis::YoutubePartnerV1::Order - command.params['orderId'] = order_id unless order_id.nil? - command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? - execute_or_queue_command(command, &block) - end - - # Retrieves the ownership data provided for the specified asset by the content - # owner associated with the authenticated user. + # Retrieves the ownership data provided for the specified asset by the + # content owner associated with the authenticated user. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID for which you are - # retrieving ownership data. + # The assetId parameter specifies the YouTube + # asset ID for which you are retrieving ownership data. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -1976,40 +1600,38 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'assets/{assetId}/ownership', options) + def get_ownership(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/assets/{assetId}/ownership', options) command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.response_class = Google::Apis::YoutubePartnerV1::RightsOwnership command.params['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Provides new ownership information for the specified asset. Note that YouTube - # may receive ownership information from multiple sources. For example, if an - # asset has multiple owners, each owner might send ownership data for the asset. - # YouTube algorithmically combines the ownership data received from all of those - # sources to generate the asset's canonical ownership data, which should provide - # the most comprehensive and accurate representation of the asset's ownership. - # This method supports patch semantics. + # Provides new ownership information for the specified asset. Note that + # YouTube may receive ownership information from multiple sources. For + # example, if an asset has multiple owners, each owner might send ownership + # data for the asset. YouTube algorithmically combines the ownership data + # received from all of those sources to generate the + # asset's canonical ownership data, which should provide the most + # comprehensive and accurate representation of the asset's ownership. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset being - # updated. + # The assetId parameter specifies the YouTube + # asset ID of the asset being updated. # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2022,8 +1644,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'assets/{assetId}/ownership', options) + def patch_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/assets/{assetId}/ownership', options) command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.request_object = rights_ownership_object command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation @@ -2032,31 +1654,30 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Provides new ownership information for the specified asset. Note that YouTube - # may receive ownership information from multiple sources. For example, if an - # asset has multiple owners, each owner might send ownership data for the asset. - # YouTube algorithmically combines the ownership data received from all of those - # sources to generate the asset's canonical ownership data, which should provide - # the most comprehensive and accurate representation of the asset's ownership. + # Provides new ownership information for the specified asset. Note that + # YouTube may receive ownership information from multiple sources. For + # example, if an asset has multiple owners, each owner might send ownership + # data for the asset. YouTube algorithmically combines the ownership data + # received from all of those sources to generate the + # asset's canonical ownership data, which should provide the most + # comprehensive and accurate representation of the asset's ownership. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset being - # updated. + # The assetId parameter specifies the YouTube + # asset ID of the asset being updated. # @param [Google::Apis::YoutubePartnerV1::RightsOwnership] rights_ownership_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2069,8 +1690,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'assets/{assetId}/ownership', options) + def update_ownership(asset_id, rights_ownership_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/assets/{assetId}/ownership', options) command.request_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation command.request_object = rights_ownership_object command.response_representation = Google::Apis::YoutubePartnerV1::RightsOwnership::Representation @@ -2079,7 +1700,6 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -2087,22 +1707,22 @@ module Google # content owner provided the data. The list only includes the most recent # ownership data for each content owner. However, if the content owner has # submitted ownership data through multiple data sources (API, content feeds, - # etc.), the list will contain the most recent data for each content owner and - # data source. + # etc.), the list will contain the most recent data for each content owner + # and data source. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset for which - # you are retrieving an ownership data history. + # The assetId parameter specifies the YouTube + # asset ID of the asset for which you are retrieving an ownership data + # history. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2115,33 +1735,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'ownershipHistory', options) + def list_ownership_histories(asset_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/ownershipHistory', options) command.response_representation = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse command.query['assetId'] = asset_id unless asset_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves information for the specified package. # @param [String] package_id - # The packageId parameter specifies the Content Delivery package ID of the - # package being retrieved. + # The packageId parameter specifies the Content + # Delivery package ID of the package being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2154,31 +1772,29 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_package(package_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'package/{packageId}', options) + def get_package(package_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/package/{packageId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Package::Representation command.response_class = Google::Apis::YoutubePartnerV1::Package command.params['packageId'] = package_id unless package_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Inserts a metadata-only package. # @param [Google::Apis::YoutubePartnerV1::Package] package_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2191,8 +1807,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_package(package_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'package', options) + def insert_package(package_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/package', options) command.request_representation = Google::Apis::YoutubePartnerV1::Package::Representation command.request_object = package_object command.response_representation = Google::Apis::YoutubePartnerV1::PackageInsertResponse::Representation @@ -2200,25 +1816,23 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves the specified saved policy. # @param [String] policy_id - # The policyId parameter specifies a value that uniquely identifies the policy - # being retrieved. + # The policyId parameter specifies a value that + # uniquely identifies the policy being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2231,31 +1845,29 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_policy(policy_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'policies/{policyId}', options) + def get_policy(policy_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/policies/{policyId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.response_class = Google::Apis::YoutubePartnerV1::Policy command.params['policyId'] = policy_id unless policy_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Creates a saved policy. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2268,8 +1880,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_policy(policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'policies', options) + def insert_policy(policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/policies', options) command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation @@ -2277,28 +1889,27 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of the content owner's saved policies. # @param [String] id - # The id parameter specifies a comma-separated list of saved policy IDs to - # retrieve. Only policies belonging to the currently authenticated content owner - # will be available. + # The id parameter specifies a comma-separated + # list of saved policy IDs to retrieve. Only policies belonging to the + # currently authenticated content owner will be available. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] sort - # The sort parameter specifies how the search results should be sorted. + # The sort parameter specifies how the search + # results should be sorted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2311,8 +1922,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_policies(id: nil, on_behalf_of_content_owner: nil, sort: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'policies', options) + def list_policies(id: nil, on_behalf_of_content_owner: nil, sort: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/policies', options) command.response_representation = Google::Apis::YoutubePartnerV1::PolicyList::Representation command.response_class = Google::Apis::YoutubePartnerV1::PolicyList command.query['id'] = id unless id.nil? @@ -2320,26 +1931,24 @@ module Google command.query['sort'] = sort unless sort.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the specified saved policy. This method supports patch semantics. + # Patches the specified saved policy. # @param [String] policy_id - # The policyId parameter specifies a value that uniquely identifies the policy - # being updated. + # The policyId parameter specifies a value that + # uniquely identifies the policy being updated. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2352,8 +1961,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'policies/{policyId}', options) + def patch_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/policies/{policyId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation @@ -2362,26 +1971,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates the specified saved policy. # @param [String] policy_id - # The policyId parameter specifies a value that uniquely identifies the policy - # being updated. + # The policyId parameter specifies a value that + # uniquely identifies the policy being updated. # @param [Google::Apis::YoutubePartnerV1::Policy] policy_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2394,8 +2001,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'policies/{policyId}', options) + def update_policy(policy_id, policy_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/policies/{policyId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Policy::Representation command.request_object = policy_object command.response_representation = Google::Apis::YoutubePartnerV1::Policy::Representation @@ -2404,25 +2011,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves information about the specified reference conflict. # @param [String] reference_conflict_id - # The referenceConflictId parameter specifies the YouTube reference conflict ID - # of the reference conflict being retrieved. + # The referenceConflictId parameter specifies + # the YouTube reference conflict ID of the reference conflict being + # retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2435,34 +2041,33 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_reference_conflict(reference_conflict_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'referenceConflicts/{referenceConflictId}', options) + def get_reference_conflict(reference_conflict_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/referenceConflicts/{referenceConflictId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflict::Representation command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflict command.params['referenceConflictId'] = reference_conflict_id unless reference_conflict_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of unresolved reference conflicts. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. Set this parameter to the value of the nextPageToken value - # from the previous API response to retrieve the next page of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. Set this parameter + # to the value of the nextPageToken value from the previous API + # response to retrieve the next page of search results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2475,33 +2080,31 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_reference_conflicts(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'referenceConflicts', options) + def list_reference_conflicts(on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/referenceConflicts', options) command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ReferenceConflictListResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves information about the specified reference. # @param [String] reference_id - # The referenceId parameter specifies the YouTube reference ID of the reference - # being retrieved. + # The referenceId parameter specifies the + # YouTube reference ID of the reference being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2514,43 +2117,46 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_reference(reference_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'references/{referenceId}', options) + def get_reference(reference_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/references/{referenceId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.response_class = Google::Apis::YoutubePartnerV1::Reference command.params['referenceId'] = reference_id unless reference_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Creates a reference in one of the following ways: - # - If your request is uploading a reference file, YouTube creates the reference - # from the provided content. You can provide either a video/audio file or a pre- - # generated fingerprint. If you are providing a pre-generated fingerprint, set - # the reference resource's fpDirect property to true in the request body. In - # this flow, you can use either the multipart or resumable upload flows to - # provide the reference content. - # - If you want to create a reference using a claimed video as the reference - # content, use the claimId parameter to identify the claim. + # Creates a reference in one of the following ways:
  • If your request is + # uploading a reference file, YouTube creates the reference from the provided + # content. You can provide either a video/audio file or a pre-generated + # fingerprint. If you are providing a pre-generated fingerprint, set the + # reference + # resource's fpDirect + # property to true in the request body. In this flow, you can + # use either the multipart or resumable upload flows + # to provide the reference content.
  • If you want to create a reference + # using a claimed video as the reference content, use the + # claimId parameter to identify the claim.
# @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] claim_id - # The claimId parameter specifies the YouTube claim ID of an existing claim from - # which a reference should be created. (The claimed video is used as the - # reference content.) + # The claimId parameter specifies the YouTube + # claim ID of an existing claim from which a reference should be created. + # (The claimed video is used as the reference content.) # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [IO, String] upload_source # IO stream or filename containing content to upload # @param [String] content_type @@ -2567,11 +2173,11 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_reference(reference_object = nil, claim_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block) + def insert_reference(reference_object = nil, claim_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block) if upload_source.nil? - command = make_simple_command(:post, 'references', options) + command = make_simple_command(:post, 'youtube/partner/v1/references', options) else - command = make_upload_command(:post, 'references', options) + command = make_upload_command(:post, 'youtube/partner/v1/references', options) command.upload_source = upload_source command.upload_content_type = content_type end @@ -2583,33 +2189,32 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of references by ID or the list of references for the # specified asset. # @param [String] asset_id - # The assetId parameter specifies the YouTube asset ID of the asset for which - # you are retrieving references. + # The assetId parameter specifies the YouTube + # asset ID of the asset for which you are retrieving references. # @param [String] id - # The id parameter specifies a comma-separated list of YouTube reference IDs to - # retrieve. + # The id parameter specifies a comma-separated + # list of YouTube reference IDs to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. Set this parameter to the value of the nextPageToken value - # from the previous API response to retrieve the next page of search results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. Set this parameter + # to the value of the nextPageToken value from the previous API + # response to retrieve the next page of search results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2622,8 +2227,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_references(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'references', options) + def list_references(asset_id: nil, id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/references', options) command.response_representation = Google::Apis::YoutubePartnerV1::ReferenceListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::ReferenceListResponse command.query['assetId'] = asset_id unless asset_id.nil? @@ -2632,31 +2237,31 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates a reference. This method supports patch semantics. + # Patches a reference. # @param [String] reference_id - # The referenceId parameter specifies the YouTube reference ID of the reference - # being updated. + # The referenceId parameter specifies the + # YouTube reference ID of the reference being updated. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [Boolean] release_claims - # The releaseClaims parameter indicates that you want to release all match - # claims associated with this reference. This parameter only works when the - # claim's status is being updated to 'inactive' - you can then set the parameter' - # s value to true to release all match claims produced by this reference. + # The releaseClaims parameter indicates that + # you want to release all match claims associated with this reference. This + # parameter only works when the + # claim's status is being updated to 'inactive' - you can then set the + # parameter's value to true to release all match claims produced + # by this reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2669,8 +2274,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'references/{referenceId}', options) + def patch_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/references/{referenceId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.request_object = reference_object command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation @@ -2680,31 +2285,31 @@ module Google command.query['releaseClaims'] = release_claims unless release_claims.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates a reference. # @param [String] reference_id - # The referenceId parameter specifies the YouTube reference ID of the reference - # being updated. + # The referenceId parameter specifies the + # YouTube reference ID of the reference being updated. # @param [Google::Apis::YoutubePartnerV1::Reference] reference_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [Boolean] release_claims - # The releaseClaims parameter indicates that you want to release all match - # claims associated with this reference. This parameter only works when the - # claim's status is being updated to 'inactive' - you can then set the parameter' - # s value to true to release all match claims produced by this reference. + # The releaseClaims parameter indicates that + # you want to release all match claims associated with this reference. This + # parameter only works when the + # claim's status is being updated to 'inactive' - you can then set the + # parameter's value to true to release all match claims produced + # by this reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2717,8 +2322,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'references/{referenceId}', options) + def update_reference(reference_id, reference_object = nil, on_behalf_of_content_owner: nil, release_claims: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/references/{referenceId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::Reference::Representation command.request_object = reference_object command.response_representation = Google::Apis::YoutubePartnerV1::Reference::Representation @@ -2728,26 +2333,24 @@ module Google command.query['releaseClaims'] = release_claims unless release_claims.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of spreadsheet templates for a content owner. # @param [String] locale - # The locale parameter identifies the desired language for templates in the API - # response. The value is a string that contains a BCP-47 language code. The - # default value is en. + # The locale parameter identifies the desired + # language for templates in the API response. The value is a string that + # contains a BCP-47 language code. The default value is en. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2760,30 +2363,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'spreadsheetTemplate', options) + def list_spreadsheet_templates(locale: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/spreadsheetTemplate', options) command.response_representation = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::SpreadsheetTemplateListResponse command.query['locale'] = locale unless locale.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of uploaders for a content owner. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2796,30 +2397,28 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_uploaders(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'uploader', options) + def list_uploaders(on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/uploader', options) command.response_representation = Google::Apis::YoutubePartnerV1::UploaderListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::UploaderListResponse command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Validate a metadata file. # @param [Google::Apis::YoutubePartnerV1::ValidateRequest] validate_request_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2832,8 +2431,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def validate_validator(validate_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'validator', options) + def validate_validator(validate_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/validator', options) command.request_representation = Google::Apis::YoutubePartnerV1::ValidateRequest::Representation command.request_object = validate_request_object command.response_representation = Google::Apis::YoutubePartnerV1::ValidateResponse::Representation @@ -2841,23 +2440,21 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Validate a metadata file asynchronously. # @param [Google::Apis::YoutubePartnerV1::ValidateAsyncRequest] validate_async_request_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2870,8 +2467,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def validate_validator_async(validate_async_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'validatorAsync', options) + def validate_validator_async(validate_async_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/validatorAsync', options) command.request_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncRequest::Representation command.request_object = validate_async_request_object command.response_representation = Google::Apis::YoutubePartnerV1::ValidateAsyncResponse::Representation @@ -2879,23 +2476,21 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Get the asynchronous validation status. # @param [Google::Apis::YoutubePartnerV1::ValidateStatusRequest] validate_status_request_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2908,8 +2503,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def validate_validator_async_status(validate_status_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'validatorAsyncStatus', options) + def validate_validator_async_status(validate_status_request_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/validatorAsyncStatus', options) command.request_representation = Google::Apis::YoutubePartnerV1::ValidateStatusRequest::Representation command.request_object = validate_status_request_object command.response_representation = Google::Apis::YoutubePartnerV1::ValidateStatusResponse::Representation @@ -2917,25 +2512,23 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves advertising settings for the specified video. # @param [String] video_id - # The videoId parameter specifies the YouTube video ID of the video for which - # you are retrieving advertising settings. + # The videoId parameter specifies the YouTube + # video ID of the video for which you are retrieving advertising settings. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2948,34 +2541,32 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_video_advertising_option(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'videoAdvertisingOptions/{videoId}', options) + def get_video_advertising_option(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options) command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption command.params['videoId'] = video_id unless video_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Retrieves details about the types of allowed ads for a specified partner- or - # user-uploaded video. + # Retrieves details about the types of allowed ads for a specified partner- + # or user-uploaded video. # @param [String] video_id - # The videoId parameter specifies the YouTube video ID of the video for which - # you are retrieving advertising options. + # The videoId parameter specifies the YouTube + # video ID of the video for which you are retrieving advertising options. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -2988,35 +2579,32 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_video_advertising_option_enabled_ads(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'videoAdvertisingOptions/{videoId}/getEnabledAds', options) + def get_video_advertising_option_enabled_ads(video_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}/getEnabledAds', options) command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::VideoAdvertisingOptionGetEnabledAdsResponse command.params['videoId'] = video_id unless video_id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Updates the advertising settings for the specified video. This method supports - # patch semantics. + # Patches the advertising settings for the specified video. # @param [String] video_id - # The videoId parameter specifies the YouTube video ID of the video for which - # you are updating advertising settings. + # The videoId parameter specifies the YouTube + # video ID of the video for which you are updating advertising settings. # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3029,8 +2617,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:patch, 'videoAdvertisingOptions/{videoId}', options) + def patch_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:patch, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.request_object = video_advertising_option_object command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation @@ -3039,26 +2627,24 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Updates the advertising settings for the specified video. # @param [String] video_id - # The videoId parameter specifies the YouTube video ID of the video for which - # you are updating advertising settings. + # The videoId parameter specifies the YouTube + # video ID of the video for which you are updating advertising settings. # @param [Google::Apis::YoutubePartnerV1::VideoAdvertisingOption] video_advertising_option_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3071,8 +2657,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:put, 'videoAdvertisingOptions/{videoId}', options) + def update_video_advertising_option(video_id, video_advertising_option_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/partner/v1/videoAdvertisingOptions/{videoId}', options) command.request_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation command.request_object = video_advertising_option_object command.response_representation = Google::Apis::YoutubePartnerV1::VideoAdvertisingOption::Representation @@ -3081,62 +2667,60 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Removes a whitelisted channel for a content owner. # @param [String] id - # The id parameter specifies the YouTube channel ID of the channel being removed - # from whitelist. + # The id parameter specifies the YouTube + # channel ID of the channel being removed from whitelist. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method + # @yieldparam result [Google::Apis::YoutubePartnerV1::Empty] parsed result object # @yieldparam err [StandardError] error object if request failed # - # @return [void] + # @return [Google::Apis::YoutubePartnerV1::Empty] # # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:delete, 'whitelists/{id}', options) + def delete_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'youtube/partner/v1/whitelists/{id}', options) + command.response_representation = Google::Apis::YoutubePartnerV1::Empty::Representation + command.response_class = Google::Apis::YoutubePartnerV1::Empty command.params['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a specific whitelisted channel by ID. # @param [String] id - # The id parameter specifies the YouTube channel ID of the whitelisted channel - # being retrieved. + # The id parameter specifies the YouTube + # channel ID of the whitelisted channel being retrieved. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3149,34 +2733,32 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'whitelists/{id}', options) + def get_whitelist(id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/whitelists/{id}', options) command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation command.response_class = Google::Apis::YoutubePartnerV1::Whitelist command.params['id'] = id unless id.nil? command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end - # Whitelist a YouTube channel for your content owner. Whitelisted channels are - # channels that are not owned or managed by you, but you would like to whitelist - # so that no claims from your assets are placed on videos uploaded to these - # channels. + # Whitelist a YouTube channel for your content owner. Whitelisted channels + # are channels that are not owned or managed by you, but you would like to + # whitelist so that no claims from your assets are placed on videos uploaded + # to these channels. # @param [Google::Apis::YoutubePartnerV1::Whitelist] whitelist_object # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3189,8 +2771,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def insert_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:post, 'whitelists', options) + def insert_whitelist(whitelist_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/partner/v1/whitelists', options) command.request_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation command.request_object = whitelist_object command.response_representation = Google::Apis::YoutubePartnerV1::Whitelist::Representation @@ -3198,29 +2780,29 @@ module Google command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end # Retrieves a list of whitelisted channels for a content owner. # @param [String] id - # The id parameter specifies a comma-separated list of YouTube channel IDs that - # identify the whitelisted channels you want to retrieve. + # The id parameter specifies a comma-separated + # list of YouTube channel IDs that identify the whitelisted channels you want + # to retrieve. # @param [String] on_behalf_of_content_owner - # The onBehalfOfContentOwner parameter identifies the content owner that the - # user is acting on behalf of. This parameter supports users whose accounts are - # associated with multiple content owners. + # The onBehalfOfContentOwner parameter + # identifies the content owner that the user is acting on behalf of. This + # parameter supports users whose accounts are associated with multiple + # content owners. # @param [String] page_token - # The pageToken parameter specifies a token that identifies a particular page of - # results to return. Set this parameter to the value of the nextPageToken value - # from the previous API response to retrieve the next page of results. + # The pageToken parameter specifies a token + # that identifies a particular page of results to return. Set this parameter + # to the value of the nextPageToken value from the previous API + # response to retrieve the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user - # An opaque string that represents a user for quota purposes. Must not exceed 40 - # characters. - # @param [String] user_ip - # Deprecated. Please use quotaUser instead. + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. # @param [Google::Apis::RequestOptions] options # Request-specific options # @@ -3233,8 +2815,8 @@ module Google # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_whitelists(id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) - command = make_simple_command(:get, 'whitelists', options) + def list_whitelists(id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/partner/v1/whitelists', options) command.response_representation = Google::Apis::YoutubePartnerV1::WhitelistListResponse::Representation command.response_class = Google::Apis::YoutubePartnerV1::WhitelistListResponse command.query['id'] = id unless id.nil? @@ -3242,7 +2824,6 @@ module Google command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? execute_or_queue_command(command, &block) end @@ -3251,7 +2832,6 @@ module Google def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? - command.query['userIp'] = user_ip unless user_ip.nil? end end end diff --git a/generated/google/apis/youtube_v3.rb b/generated/google/apis/youtube_v3.rb index 3869d1234..02abc7cf6 100644 --- a/generated/google/apis/youtube_v3.rb +++ b/generated/google/apis/youtube_v3.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/youtube/ module YoutubeV3 VERSION = 'V3' - REVISION = '20200618' + REVISION = '20200706' # Manage your YouTube account AUTH_YOUTUBE = 'https://www.googleapis.com/auth/youtube' diff --git a/generated/google/apis/youtube_v3/classes.rb b/generated/google/apis/youtube_v3/classes.rb index a3c2ec24f..037918098 100644 --- a/generated/google/apis/youtube_v3/classes.rb +++ b/generated/google/apis/youtube_v3/classes.rb @@ -22,6 +22,62 @@ module Google module Apis module YoutubeV3 + # + class AbuseReport + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `abuseTypes` + # @return [Array] + attr_accessor :abuse_types + + # + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # + # Corresponds to the JSON property `relatedEntities` + # @return [Array] + attr_accessor :related_entities + + # + # Corresponds to the JSON property `subject` + # @return [Google::Apis::YoutubeV3::Entity] + attr_accessor :subject + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @abuse_types = args[:abuse_types] if args.key?(:abuse_types) + @description = args[:description] if args.key?(:description) + @related_entities = args[:related_entities] if args.key?(:related_entities) + @subject = args[:subject] if args.key?(:subject) + end + end + + # + class AbuseType + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + end + end + # Rights management policy for YouTube resources. class AccessPolicy include Google::Apis::Core::Hashable @@ -1101,6 +1157,33 @@ module Google end end + # + class ChannelCard + include Google::Apis::Core::Hashable + + # External channel ID. + # Required. + # Corresponds to the JSON property `channelId` + # @return [String] + attr_accessor :channel_id + + # Each card can have a custom message. + # Required. + # Corresponds to the JSON property `customMessage` + # @return [String] + attr_accessor :custom_message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @channel_id = args[:channel_id] if args.key?(:channel_id) + @custom_message = args[:custom_message] if args.key?(:custom_message) + end + end + # Details about the content of a channel. class ChannelContentDetails include Google::Apis::Core::Hashable @@ -1894,6 +1977,32 @@ module Google end end + # Information specific to a store on a merchandising platform linked to a + # YouTube channel. + class ChannelToStoreLinkDetails + include Google::Apis::Core::Hashable + + # Name of the store. + # Corresponds to the JSON property `storeName` + # @return [String] + attr_accessor :store_name + + # Landing page of the store. + # Corresponds to the JSON property `storeUrl` + # @return [String] + attr_accessor :store_url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @store_name = args[:store_name] if args.key?(:store_name) + @store_url = args[:store_url] if args.key?(:store_url) + end + end + # Freebase topic information related to the channel. class ChannelTopicDetails include Google::Apis::Core::Hashable @@ -2842,6 +2951,37 @@ module Google end end + # + class Entity + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # + # Corresponds to the JSON property `typeId` + # @return [String] + attr_accessor :type_id + + # + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @type_id = args[:type_id] if args.key?(:type_id) + @url = args[:url] if args.key?(:url) + end + end + # Geographical coordinates of a point, in WGS84. class GeoPoint include Google::Apis::Core::Hashable @@ -3392,6 +3532,166 @@ module Google end end + # + class InfoCard + include Google::Apis::Core::Hashable + + # Etag of this resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # UUID for this infocard. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Identifies what kind of resource this is. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The snippet object contains basic details about the infocard. + # Corresponds to the JSON property `snippet` + # @return [Google::Apis::YoutubeV3::InfoCardSnippet] + attr_accessor :snippet + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @id = args[:id] if args.key?(:id) + @kind = args[:kind] if args.key?(:kind) + @snippet = args[:snippet] if args.key?(:snippet) + end + end + + # + class InfoCardSnippet + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `channelInfocard` + # @return [Google::Apis::YoutubeV3::ChannelCard] + attr_accessor :channel_infocard + + # + # Corresponds to the JSON property `linkInfocard` + # @return [Google::Apis::YoutubeV3::LinkCard] + attr_accessor :link_infocard + + # + # Corresponds to the JSON property `playlistInfocard` + # @return [Google::Apis::YoutubeV3::PlaylistCard] + attr_accessor :playlist_infocard + + # Each card can have a teaser. + # Required. + # Corresponds to the JSON property `teaser` + # @return [Google::Apis::YoutubeV3::InfoCardSnippetTeaser] + attr_accessor :teaser + + # + # Corresponds to the JSON property `videoInfocard` + # @return [Google::Apis::YoutubeV3::VideoCard] + attr_accessor :video_infocard + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @channel_infocard = args[:channel_infocard] if args.key?(:channel_infocard) + @link_infocard = args[:link_infocard] if args.key?(:link_infocard) + @playlist_infocard = args[:playlist_infocard] if args.key?(:playlist_infocard) + @teaser = args[:teaser] if args.key?(:teaser) + @video_infocard = args[:video_infocard] if args.key?(:video_infocard) + end + end + + # + class InfoCardSnippetTeaser + include Google::Apis::Core::Hashable + + # The offset from the video start at which the teaser should be displayed + # (activated), in milliseconds. + # Required. + # Corresponds to the JSON property `teaserStartOffset` + # @return [String] + attr_accessor :teaser_start_offset + + # The teaser text to show at the top of the player for the info-card. + # Required for channel and link type cards. + # Optional for video and playlist type cards. + # Corresponds to the JSON property `teaserText` + # @return [String] + attr_accessor :teaser_text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @teaser_start_offset = args[:teaser_start_offset] if args.key?(:teaser_start_offset) + @teaser_text = args[:teaser_text] if args.key?(:teaser_text) + end + end + + # + class InfoCards + include Google::Apis::Core::Hashable + + # A list of infocards. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + end + end + + # + class InfocardListResponse + include Google::Apis::Core::Hashable + + # Etag of this resource. + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # A list of infocards. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # Identifies what kind of resource this is. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @items = args[:items] if args.key?(:items) + @kind = args[:kind] if args.key?(:kind) + end + end + # Describes information necessary for ingesting an RTMP or an HTTP stream. class IngestionInfo include Google::Apis::Core::Hashable @@ -3639,6 +3939,77 @@ module Google end end + # + class LinkCard + include Google::Apis::Core::Hashable + + # Custom text to show as the website link. + # Required. + # Corresponds to the JSON property `customLinkText` + # @return [String] + attr_accessor :custom_link_text + + # URL to an externally hosted image. + # Corresponds to the JSON property `externalImageUrl` + # @return [String] + attr_accessor :external_image_url + + # The URL to which this card points. + # Required. + # Corresponds to the JSON property `targetUrl` + # @return [String] + attr_accessor :target_url + + # The title to show on the card. + # Required. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + # Previously uploaded image. + # Corresponds to the JSON property `uploadedImage` + # @return [Google::Apis::YoutubeV3::LinkCardUploadedImage] + attr_accessor :uploaded_image + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_link_text = args[:custom_link_text] if args.key?(:custom_link_text) + @external_image_url = args[:external_image_url] if args.key?(:external_image_url) + @target_url = args[:target_url] if args.key?(:target_url) + @title = args[:title] if args.key?(:title) + @uploaded_image = args[:uploaded_image] if args.key?(:uploaded_image) + end + end + + # + class LinkCardUploadedImage + include Google::Apis::Core::Hashable + + # Image reference on the thumbnail service. + # Corresponds to the JSON property `imageFile` + # @return [String] + attr_accessor :image_file + + # The version in the thumbnail service. + # Corresponds to the JSON property `version` + # @return [Fixnum] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @image_file = args[:image_file] if args.key?(:image_file) + @version = args[:version] if args.key?(:version) + end + end + # A liveBroadcast resource represents an event # that will be streamed, via live video, on YouTube. class LiveBroadcast @@ -5729,6 +6100,40 @@ module Google end end + # + class PlaylistCard + include Google::Apis::Core::Hashable + + # Each card can have a custom message. + # Optional. + # Corresponds to the JSON property `customMessage` + # @return [String] + attr_accessor :custom_message + + # External playlist ID. + # Required. + # Corresponds to the JSON property `playlistId` + # @return [String] + attr_accessor :playlist_id + + # Starting video, if not the first. + # Optional. + # Corresponds to the JSON property `startVideoId` + # @return [String] + attr_accessor :start_video_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_message = args[:custom_message] if args.key?(:custom_message) + @playlist_id = args[:playlist_id] if args.key?(:playlist_id) + @start_video_id = args[:start_video_id] if args.key?(:start_video_id) + end + end + # class PlaylistContentDetails include Google::Apis::Core::Hashable @@ -6365,6 +6770,25 @@ module Google end end + # + class RelatedEntity + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `entity` + # @return [Google::Apis::YoutubeV3::Entity] + attr_accessor :entity + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity = args[:entity] if args.key?(:entity) + end + end + # A resource id is a generic reference that points to another YouTube resource. class ResourceId include Google::Apis::Core::Hashable @@ -7238,6 +7662,102 @@ module Google end end + # A third party account link resource represents + # a link between a YouTube account or a channel and an account on a + # third-party service. + class ThirdPartyLink + include Google::Apis::Core::Hashable + + # Etag of this resource + # Corresponds to the JSON property `etag` + # @return [String] + attr_accessor :etag + + # Identifies what kind of resource this is. Value: the fixed string + # "youtube#thirdPartyLink". + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # The linking_token identifies a YouTube account and + # channel with which the third party account is linked. + # Corresponds to the JSON property `linkingToken` + # @return [String] + attr_accessor :linking_token + + # Basic information about a third party account link, including its type and + # type-specific information. + # Corresponds to the JSON property `snippet` + # @return [Google::Apis::YoutubeV3::ThirdPartyLinkSnippet] + attr_accessor :snippet + + # The third-party link status object contains information about + # the status of the link. + # Corresponds to the JSON property `status` + # @return [Google::Apis::YoutubeV3::ThirdPartyLinkStatus] + attr_accessor :status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @etag = args[:etag] if args.key?(:etag) + @kind = args[:kind] if args.key?(:kind) + @linking_token = args[:linking_token] if args.key?(:linking_token) + @snippet = args[:snippet] if args.key?(:snippet) + @status = args[:status] if args.key?(:status) + end + end + + # Basic information about a third party account link, including its type and + # type-specific information. + class ThirdPartyLinkSnippet + include Google::Apis::Core::Hashable + + # Information specific to a store on a merchandising platform linked to a + # YouTube channel. + # Corresponds to the JSON property `channelToStoreLink` + # @return [Google::Apis::YoutubeV3::ChannelToStoreLinkDetails] + attr_accessor :channel_to_store_link + + # Type of the link named after the entities that are being linked. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @channel_to_store_link = args[:channel_to_store_link] if args.key?(:channel_to_store_link) + @type = args[:type] if args.key?(:type) + end + end + + # The third-party link status object contains information about + # the status of the link. + class ThirdPartyLinkStatus + include Google::Apis::Core::Hashable + + # + # Corresponds to the JSON property `linkStatus` + # @return [String] + attr_accessor :link_status + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @link_status = args[:link_status] if args.key?(:link_status) + end + end + # A thumbnail is an image representing a YouTube resource. class Thumbnail include Google::Apis::Core::Hashable @@ -7719,6 +8239,40 @@ module Google end end + # + class VideoCard + include Google::Apis::Core::Hashable + + # Each card can have a custom message. + # Optional. + # Corresponds to the JSON property `customMessage` + # @return [String] + attr_accessor :custom_message + + # Playback start time offset in milliseconds. + # Optional. + # Corresponds to the JSON property `playbackStartOffset` + # @return [String] + attr_accessor :playback_start_offset + + # Encrypted Video ID. + # Required. + # Corresponds to the JSON property `videoId` + # @return [String] + attr_accessor :video_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @custom_message = args[:custom_message] if args.key?(:custom_message) + @playback_start_offset = args[:playback_start_offset] if args.key?(:playback_start_offset) + @video_id = args[:video_id] if args.key?(:video_id) + end + end + # A videoCategory resource identifies a # category that has been or could be associated with uploaded videos. class VideoCategory diff --git a/generated/google/apis/youtube_v3/representations.rb b/generated/google/apis/youtube_v3/representations.rb index dc2875b52..fe7f3e066 100644 --- a/generated/google/apis/youtube_v3/representations.rb +++ b/generated/google/apis/youtube_v3/representations.rb @@ -22,6 +22,18 @@ module Google module Apis module YoutubeV3 + class AbuseReport + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class AbuseType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class AccessPolicy class Representation < Google::Apis::Core::JsonRepresentation; end @@ -166,6 +178,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ChannelCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ChannelContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end @@ -274,6 +292,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ChannelToStoreLinkDetails + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ChannelTopicDetails class Representation < Google::Apis::Core::JsonRepresentation; end @@ -334,6 +358,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class Entity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GeoPoint class Representation < Google::Apis::Core::JsonRepresentation; end @@ -400,6 +430,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class InfoCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InfoCardSnippet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InfoCardSnippetTeaser + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InfoCards + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class InfocardListResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class IngestionInfo class Representation < Google::Apis::Core::JsonRepresentation; end @@ -442,6 +502,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class LinkCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class LinkCardUploadedImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class LiveBroadcast class Representation < Google::Apis::Core::JsonRepresentation; end @@ -700,6 +772,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PlaylistCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PlaylistContentDetails class Representation < Google::Apis::Core::JsonRepresentation; end @@ -784,6 +862,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RelatedEntity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ResourceId class Representation < Google::Apis::Core::JsonRepresentation; end @@ -892,6 +976,24 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ThirdPartyLink + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyLinkSnippet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ThirdPartyLinkStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class Thumbnail class Representation < Google::Apis::Core::JsonRepresentation; end @@ -958,6 +1060,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class VideoCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class VideoCategory class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1114,6 +1222,26 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class AbuseReport + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :abuse_types, as: 'abuseTypes', class: Google::Apis::YoutubeV3::AbuseType, decorator: Google::Apis::YoutubeV3::AbuseType::Representation + + property :description, as: 'description' + collection :related_entities, as: 'relatedEntities', class: Google::Apis::YoutubeV3::RelatedEntity, decorator: Google::Apis::YoutubeV3::RelatedEntity::Representation + + property :subject, as: 'subject', class: Google::Apis::YoutubeV3::Entity, decorator: Google::Apis::YoutubeV3::Entity::Representation + + end + end + + class AbuseType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + end + end + class AccessPolicy # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1417,6 +1545,14 @@ module Google end end + class ChannelCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :channel_id, as: 'channelId' + property :custom_message, as: 'customMessage' + end + end + class ChannelContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1621,6 +1757,14 @@ module Google end end + class ChannelToStoreLinkDetails + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :store_name, as: 'storeName' + property :store_url, as: 'storeUrl' + end + end + class ChannelTopicDetails # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1814,6 +1958,15 @@ module Google end end + class Entity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :type_id, as: 'typeId' + property :url, as: 'url' + end + end + class GeoPoint # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -1955,6 +2108,59 @@ module Google end end + class InfoCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :id, as: 'id' + property :kind, as: 'kind' + property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::InfoCardSnippet, decorator: Google::Apis::YoutubeV3::InfoCardSnippet::Representation + + end + end + + class InfoCardSnippet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :channel_infocard, as: 'channelInfocard', class: Google::Apis::YoutubeV3::ChannelCard, decorator: Google::Apis::YoutubeV3::ChannelCard::Representation + + property :link_infocard, as: 'linkInfocard', class: Google::Apis::YoutubeV3::LinkCard, decorator: Google::Apis::YoutubeV3::LinkCard::Representation + + property :playlist_infocard, as: 'playlistInfocard', class: Google::Apis::YoutubeV3::PlaylistCard, decorator: Google::Apis::YoutubeV3::PlaylistCard::Representation + + property :teaser, as: 'teaser', class: Google::Apis::YoutubeV3::InfoCardSnippetTeaser, decorator: Google::Apis::YoutubeV3::InfoCardSnippetTeaser::Representation + + property :video_infocard, as: 'videoInfocard', class: Google::Apis::YoutubeV3::VideoCard, decorator: Google::Apis::YoutubeV3::VideoCard::Representation + + end + end + + class InfoCardSnippetTeaser + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :teaser_start_offset, as: 'teaserStartOffset' + property :teaser_text, as: 'teaserText' + end + end + + class InfoCards + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::YoutubeV3::InfoCard, decorator: Google::Apis::YoutubeV3::InfoCard::Representation + + end + end + + class InfocardListResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + collection :items, as: 'items', class: Google::Apis::YoutubeV3::InfoCard, decorator: Google::Apis::YoutubeV3::InfoCard::Representation + + property :kind, as: 'kind' + end + end + class IngestionInfo # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2023,6 +2229,26 @@ module Google end end + class LinkCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_link_text, as: 'customLinkText' + property :external_image_url, as: 'externalImageUrl' + property :target_url, as: 'targetUrl' + property :title, as: 'title' + property :uploaded_image, as: 'uploadedImage', class: Google::Apis::YoutubeV3::LinkCardUploadedImage, decorator: Google::Apis::YoutubeV3::LinkCardUploadedImage::Representation + + end + end + + class LinkCardUploadedImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image_file, as: 'imageFile' + property :version, :numeric_string => true, as: 'version' + end + end + class LiveBroadcast # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2552,6 +2778,15 @@ module Google end end + class PlaylistCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_message, as: 'customMessage' + property :playlist_id, as: 'playlistId' + property :start_video_id, as: 'startVideoId' + end + end + class PlaylistContentDetails # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2714,6 +2949,14 @@ module Google end end + class RelatedEntity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :entity, as: 'entity', class: Google::Apis::YoutubeV3::Entity, decorator: Google::Apis::YoutubeV3::Entity::Representation + + end + end + class ResourceId # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -2945,6 +3188,35 @@ module Google end end + class ThirdPartyLink + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :etag, as: 'etag' + property :kind, as: 'kind' + property :linking_token, as: 'linkingToken' + property :snippet, as: 'snippet', class: Google::Apis::YoutubeV3::ThirdPartyLinkSnippet, decorator: Google::Apis::YoutubeV3::ThirdPartyLinkSnippet::Representation + + property :status, as: 'status', class: Google::Apis::YoutubeV3::ThirdPartyLinkStatus, decorator: Google::Apis::YoutubeV3::ThirdPartyLinkStatus::Representation + + end + end + + class ThirdPartyLinkSnippet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :channel_to_store_link, as: 'channelToStoreLink', class: Google::Apis::YoutubeV3::ChannelToStoreLinkDetails, decorator: Google::Apis::YoutubeV3::ChannelToStoreLinkDetails::Representation + + property :type, as: 'type' + end + end + + class ThirdPartyLinkStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :link_status, as: 'linkStatus' + end + end + class Thumbnail # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -3087,6 +3359,15 @@ module Google end end + class VideoCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :custom_message, as: 'customMessage' + property :playback_start_offset, as: 'playbackStartOffset' + property :video_id, as: 'videoId' + end + end + class VideoCategory # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/youtube_v3/service.rb b/generated/google/apis/youtube_v3/service.rb index 19c32b16f..d459bafda 100644 --- a/generated/google/apis/youtube_v3/service.rb +++ b/generated/google/apis/youtube_v3/service.rb @@ -48,6 +48,41 @@ module Google @batch_path = 'batch/youtube' end + # Inserts a new resource into this collection. + # @param [Array, String] part + # The part parameter serves two purposes in + # this operation. It identifies the properties that the write operation will + # set as well as the properties that the API response will include. + # @param [Google::Apis::YoutubeV3::AbuseReport] abuse_report_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::AbuseReport] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::AbuseReport] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_abuse_report(part, abuse_report_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/v3/abuseReports', options) + command.request_representation = Google::Apis::YoutubeV3::AbuseReport::Representation + command.request_object = abuse_report_object + command.response_representation = Google::Apis::YoutubeV3::AbuseReport::Representation + command.response_class = Google::Apis::YoutubeV3::AbuseReport + command.query['part'] = part unless part.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Retrieves a list of resources, possibly filtered. # @param [Array, String] part # The part parameter specifies a @@ -3414,6 +3449,153 @@ module Google execute_or_queue_command(command, &block) end + # Deletes a resource. + # @param [String] linking_token + # Delete the partner links with the given linking token. + # @param [String] type + # Type of the link to be deleted. + # @param [Array, String] part + # Do not use. Required for compatibility. + # @param [String] resource_id + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [NilClass] No result returned for this method + # @yieldparam err [StandardError] error object if request failed + # + # @return [void] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_third_party_link(linking_token, type, part: nil, resource_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'youtube/v3/thirdPartyLinks', options) + command.query['linkingToken'] = linking_token unless linking_token.nil? + command.query['part'] = part unless part.nil? + command.query['resourceId'] = resource_id unless resource_id.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Inserts a new resource into this collection. + # @param [Array, String] part + # The part parameter specifies the + # thirdPartyLink resource parts that the API request and + # response will include. Supported values are linkingToken, + # status, and snippet. + # @param [Google::Apis::YoutubeV3::ThirdPartyLink] third_party_link_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::ThirdPartyLink] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::ThirdPartyLink] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def insert_third_party_link(part, third_party_link_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/v3/thirdPartyLinks', options) + command.request_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation + command.request_object = third_party_link_object + command.response_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation + command.response_class = Google::Apis::YoutubeV3::ThirdPartyLink + command.query['part'] = part unless part.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves a list of resources, possibly filtered. + # @param [Array, String] part + # The part parameter specifies the + # thirdPartyLink resource parts that the API response will + # include. Supported values are linkingToken, + # status, and snippet. + # @param [String] linking_token + # Get a third party link with the given linking token. + # @param [String] type + # Get a third party link of the given type. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::ThirdPartyLink] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::ThirdPartyLink] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_third_party_links(part, linking_token: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/v3/thirdPartyLinks', options) + command.response_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation + command.response_class = Google::Apis::YoutubeV3::ThirdPartyLink + command.query['linkingToken'] = linking_token unless linking_token.nil? + command.query['part'] = part unless part.nil? + command.query['type'] = type unless type.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Updates an existing resource. + # @param [Array, String] part + # The part parameter specifies the + # thirdPartyLink resource parts that the API request and + # response will include. Supported values are linkingToken, + # status, and snippet. + # @param [Google::Apis::YoutubeV3::ThirdPartyLink] third_party_link_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::ThirdPartyLink] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::ThirdPartyLink] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def update_third_party_link(part, third_party_link_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:put, 'youtube/v3/thirdPartyLinks', options) + command.request_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation + command.request_object = third_party_link_object + command.response_representation = Google::Apis::YoutubeV3::ThirdPartyLink::Representation + command.response_class = Google::Apis::YoutubeV3::ThirdPartyLink + command.query['part'] = part unless part.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # As this is not an insert in a strict sense (it supports uploading/setting # of a thumbnail for multiple videos, which doesn't result in creation of a # single resource), I use a custom verb here. @@ -4059,6 +4241,85 @@ module Google execute_or_queue_command(command, &block) end + # Updates infocards for a given video. + # Note: + # * If the card id is not provided, a new card will be created. + # * If the card id is provided, that card will be updated. + # * Existing cards will be discarded if they're not included in the request. + # @param [Array, String] part + # The properties to update. + # @param [Google::Apis::YoutubeV3::InfoCards] info_cards_object + # @param [String] on_behalf_of_content_owner + # Content owner of the video. + # @param [String] video_id + # Encrypted id of the video. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::InfoCards] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::InfoCards] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def infocards_youtube_v3(part, info_cards_object = nil, on_behalf_of_content_owner: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'youtube/v3/infocards', options) + command.request_representation = Google::Apis::YoutubeV3::InfoCards::Representation + command.request_object = info_cards_object + command.response_representation = Google::Apis::YoutubeV3::InfoCards::Representation + command.response_class = Google::Apis::YoutubeV3::InfoCards + command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? + command.query['part'] = part unless part.nil? + command.query['videoId'] = video_id unless video_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Retrieves all infocards for a given video. + # @param [Array, String] part + # The properties to return. + # @param [String] on_behalf_of_content_owner + # Content owner of the video. + # @param [String] video_id + # Encrypted id of the video. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::YoutubeV3::InfocardListResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::YoutubeV3::InfocardListResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_youtube_v3_infocards(part, on_behalf_of_content_owner: nil, video_id: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'youtube/v3/infocards', options) + command.response_representation = Google::Apis::YoutubeV3::InfocardListResponse::Representation + command.response_class = Google::Apis::YoutubeV3::InfocardListResponse + command.query['onBehalfOfContentOwner'] = on_behalf_of_content_owner unless on_behalf_of_content_owner.nil? + command.query['part'] = part unless part.nil? + command.query['videoId'] = video_id unless video_id.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # POST method. # @param [Google::Apis::YoutubeV3::TestItem] test_item_object # @param [Array, String] part