--- v22/services/shareable_preview_service.proto 2026-02-25 21:02:27.000000000 +0000 +++ v23/services/shareable_preview_service.proto 2026-03-18 23:35:03.000000000 +0000 @@ -1,102 +1,140 @@ // Copyright 2026 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. syntax = "proto3"; -package google.ads.googleads.v22.services; +package google.ads.googleads.v23.services; +import "google/ads/googleads/v23/enums/preview_type.proto"; import "google/api/annotations.proto"; import "google/api/client.proto"; import "google/api/field_behavior.proto"; import "google/rpc/status.proto"; -option csharp_namespace = "Google.Ads.GoogleAds.V22.Services"; -option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v22/services;services"; +option csharp_namespace = "Google.Ads.GoogleAds.V23.Services"; +option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v23/services;services"; option java_multiple_files = true; option java_outer_classname = "ShareablePreviewServiceProto"; -option java_package = "com.google.ads.googleads.v22.services"; +option java_package = "com.google.ads.googleads.v23.services"; option objc_class_prefix = "GAA"; -option php_namespace = "Google\\Ads\\GoogleAds\\V22\\Services"; -option ruby_package = "Google::Ads::GoogleAds::V22::Services"; +option php_namespace = "Google\\Ads\\GoogleAds\\V23\\Services"; +option ruby_package = "Google::Ads::GoogleAds::V23::Services"; // Service to generate Shareable Previews. service ShareablePreviewService { option (google.api.default_host) = "googleads.googleapis.com"; option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/adwords"; // Returns the requested Shareable Preview. rpc GenerateShareablePreviews(GenerateShareablePreviewsRequest) returns (GenerateShareablePreviewsResponse) { option (google.api.http) = { - post: "/v22/customers/{customer_id=*}:generateShareablePreviews" + post: "/v23/customers/{customer_id=*}:generateShareablePreviews" body: "*" }; option (google.api.method_signature) = "customer_id,shareable_previews"; } } // Request message for -// [ShareablePreviewService.GenerateShareablePreviews][google.ads.googleads.v22.services.ShareablePreviewService.GenerateShareablePreviews]. +// [ShareablePreviewService.GenerateShareablePreviews][google.ads.googleads.v23.services.ShareablePreviewService.GenerateShareablePreviews]. message GenerateShareablePreviewsRequest { // Required. The customer creating the shareable previews request. string customer_id = 1 [(google.api.field_behavior) = REQUIRED]; // Required. The list of shareable previews to generate. repeated ShareablePreview shareable_previews = 2 [(google.api.field_behavior) = REQUIRED]; } // A shareable preview with its identifier. message ShareablePreview { - // Required. Asset group of the shareable preview. + // Optional. Asset group of the shareable preview. Only supported for preview + // type UI_PREVIEW or unset. AssetGroupIdentifier asset_group_identifier = 1 - [(google.api.field_behavior) = REQUIRED]; + [(google.api.field_behavior) = OPTIONAL]; + + // Optional. The type of preview to generate. + google.ads.googleads.v23.enums.PreviewTypeEnum.PreviewType preview_type = 3 + [(google.api.field_behavior) = OPTIONAL]; + + // The identifier of the shareable preview. + oneof identifier { + // Ad group ad of the shareable preview. Only supported for preview type + // YOUTUBE_LIVE_PREVIEW. + // Format: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id} + string ad_group_ad = 2; + } } // Asset group of the shareable preview. message AssetGroupIdentifier { // Required. The asset group identifier. int64 asset_group_id = 1 [(google.api.field_behavior) = REQUIRED]; } // Response message for -// [ShareablePreviewService.GenerateShareablePreviews][google.ads.googleads.v22.services.ShareablePreviewService.GenerateShareablePreviews]. +// [ShareablePreviewService.GenerateShareablePreviews][google.ads.googleads.v23.services.ShareablePreviewService.GenerateShareablePreviews]. message GenerateShareablePreviewsResponse { // List of generate shareable preview results. repeated ShareablePreviewOrError responses = 1; } // Result of the generate shareable preview. message ShareablePreviewOrError { // The asset group of the shareable preview. AssetGroupIdentifier asset_group_identifier = 3; // The shareable preview result or error. oneof generate_shareable_preview_response { // The shareable preview result. ShareablePreviewResult shareable_preview_result = 1; // The shareable preview partial failure error. google.rpc.Status partial_failure_error = 2; } + + // The identifier of the shareable preview. + oneof identifier { + // The ad group ad of the shareable preview. + // Format: customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id} + string ad_group_ad = 4; + } } // Message to hold a shareable preview result. message ShareablePreviewResult { - // The shareable preview URL. + // The shareable preview URL. Only populated if preview type is UI_PREVIEW + // or unset. string shareable_preview_url = 1; // Expiration date time using the ISO-8601 format. string expiration_date_time = 2; + + // The result of the shareable preview. + oneof result { + // The result of a YouTube live preview. Only populated for preview type + // YOUTUBE_LIVE_PREVIEW. + YouTubeLivePreviewResult youtube_live_preview_result = 3; + } +} + +// Message to hold a YouTube live preview result. +message YouTubeLivePreviewResult { + // The shareable preview URL for YouTube videos. + string youtube_preview_url = 1; + + // The shareable preview URL for YouTube TV. + string youtube_tv_preview_url = 2; }
/services/shareable_preview_service.proto
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-24 UTC.