1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.ads.googleads.v15.resources; 18 19import "google/ads/googleads/v15/common/asset_types.proto"; 20import "google/ads/googleads/v15/common/custom_parameter.proto"; 21import "google/ads/googleads/v15/common/policy.proto"; 22import "google/ads/googleads/v15/enums/asset_field_type.proto"; 23import "google/ads/googleads/v15/enums/asset_source.proto"; 24import "google/ads/googleads/v15/enums/asset_type.proto"; 25import "google/ads/googleads/v15/enums/policy_approval_status.proto"; 26import "google/ads/googleads/v15/enums/policy_review_status.proto"; 27import "google/api/field_behavior.proto"; 28import "google/api/resource.proto"; 29 30option csharp_namespace = "Google.Ads.GoogleAds.V15.Resources"; 31option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/resources;resources"; 32option java_multiple_files = true; 33option java_outer_classname = "AssetProto"; 34option java_package = "com.google.ads.googleads.v15.resources"; 35option objc_class_prefix = "GAA"; 36option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Resources"; 37option ruby_package = "Google::Ads::GoogleAds::V15::Resources"; 38 39// Proto file describing the asset resource. 40 41// Asset is a part of an ad which can be shared across multiple ads. 42// It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc. 43// Assets are immutable and cannot be removed. To stop an asset from serving, 44// remove the asset from the entity that is using it. 45message Asset { 46 option (google.api.resource) = { 47 type: "googleads.googleapis.com/Asset" 48 pattern: "customers/{customer_id}/assets/{asset_id}" 49 }; 50 51 // Immutable. The resource name of the asset. 52 // Asset resource names have the form: 53 // 54 // `customers/{customer_id}/assets/{asset_id}` 55 string resource_name = 1 [ 56 (google.api.field_behavior) = IMMUTABLE, 57 (google.api.resource_reference) = { type: "googleads.googleapis.com/Asset" } 58 ]; 59 60 // Output only. The ID of the asset. 61 optional int64 id = 11 [(google.api.field_behavior) = OUTPUT_ONLY]; 62 63 // Optional name of the asset. 64 optional string name = 12; 65 66 // Output only. Type of the asset. 67 google.ads.googleads.v15.enums.AssetTypeEnum.AssetType type = 4 68 [(google.api.field_behavior) = OUTPUT_ONLY]; 69 70 // A list of possible final URLs after all cross domain redirects. 71 repeated string final_urls = 14; 72 73 // A list of possible final mobile URLs after all cross domain redirects. 74 repeated string final_mobile_urls = 16; 75 76 // URL template for constructing a tracking URL. 77 optional string tracking_url_template = 17; 78 79 // A list of mappings to be used for substituting URL custom parameter tags in 80 // the tracking_url_template, final_urls, and/or final_mobile_urls. 81 repeated google.ads.googleads.v15.common.CustomParameter 82 url_custom_parameters = 18; 83 84 // URL template for appending params to landing page URLs served with parallel 85 // tracking. 86 optional string final_url_suffix = 19; 87 88 // Output only. Source of the asset. 89 google.ads.googleads.v15.enums.AssetSourceEnum.AssetSource source = 38 90 [(google.api.field_behavior) = OUTPUT_ONLY]; 91 92 // Output only. Policy information for the asset. 93 AssetPolicySummary policy_summary = 13 94 [(google.api.field_behavior) = OUTPUT_ONLY]; 95 96 // Output only. Policy information for the asset for each FieldType. 97 repeated AssetFieldTypePolicySummary field_type_policy_summaries = 40 98 [(google.api.field_behavior) = OUTPUT_ONLY]; 99 100 // The specific type of the asset. 101 oneof asset_data { 102 // Immutable. A YouTube video asset. 103 google.ads.googleads.v15.common.YoutubeVideoAsset youtube_video_asset = 5 104 [(google.api.field_behavior) = IMMUTABLE]; 105 106 // Immutable. A media bundle asset. 107 google.ads.googleads.v15.common.MediaBundleAsset media_bundle_asset = 6 108 [(google.api.field_behavior) = IMMUTABLE]; 109 110 // Output only. An image asset. 111 google.ads.googleads.v15.common.ImageAsset image_asset = 7 112 [(google.api.field_behavior) = OUTPUT_ONLY]; 113 114 // Immutable. A text asset. 115 google.ads.googleads.v15.common.TextAsset text_asset = 8 116 [(google.api.field_behavior) = IMMUTABLE]; 117 118 // A lead form asset. 119 google.ads.googleads.v15.common.LeadFormAsset lead_form_asset = 9; 120 121 // A book on google asset. 122 google.ads.googleads.v15.common.BookOnGoogleAsset book_on_google_asset = 10; 123 124 // A promotion asset. 125 google.ads.googleads.v15.common.PromotionAsset promotion_asset = 15; 126 127 // A callout asset. 128 google.ads.googleads.v15.common.CalloutAsset callout_asset = 20; 129 130 // A structured snippet asset. 131 google.ads.googleads.v15.common.StructuredSnippetAsset 132 structured_snippet_asset = 21; 133 134 // A sitelink asset. 135 google.ads.googleads.v15.common.SitelinkAsset sitelink_asset = 22; 136 137 // A page feed asset. 138 google.ads.googleads.v15.common.PageFeedAsset page_feed_asset = 23; 139 140 // A dynamic education asset. 141 google.ads.googleads.v15.common.DynamicEducationAsset 142 dynamic_education_asset = 24; 143 144 // A mobile app asset. 145 google.ads.googleads.v15.common.MobileAppAsset mobile_app_asset = 25; 146 147 // A hotel callout asset. 148 google.ads.googleads.v15.common.HotelCalloutAsset hotel_callout_asset = 26; 149 150 // A call asset. 151 google.ads.googleads.v15.common.CallAsset call_asset = 27; 152 153 // A price asset. 154 google.ads.googleads.v15.common.PriceAsset price_asset = 28; 155 156 // Immutable. A call to action asset. 157 google.ads.googleads.v15.common.CallToActionAsset call_to_action_asset = 29 158 [(google.api.field_behavior) = IMMUTABLE]; 159 160 // A dynamic real estate asset. 161 google.ads.googleads.v15.common.DynamicRealEstateAsset 162 dynamic_real_estate_asset = 30; 163 164 // A dynamic custom asset. 165 google.ads.googleads.v15.common.DynamicCustomAsset dynamic_custom_asset = 166 31; 167 168 // A dynamic hotels and rentals asset. 169 google.ads.googleads.v15.common.DynamicHotelsAndRentalsAsset 170 dynamic_hotels_and_rentals_asset = 32; 171 172 // A dynamic flights asset. 173 google.ads.googleads.v15.common.DynamicFlightsAsset dynamic_flights_asset = 174 33; 175 176 // Immutable. A discovery carousel card asset. 177 google.ads.googleads.v15.common.DiscoveryCarouselCardAsset 178 discovery_carousel_card_asset = 34 179 [(google.api.field_behavior) = IMMUTABLE]; 180 181 // A dynamic travel asset. 182 google.ads.googleads.v15.common.DynamicTravelAsset dynamic_travel_asset = 183 35; 184 185 // A dynamic local asset. 186 google.ads.googleads.v15.common.DynamicLocalAsset dynamic_local_asset = 36; 187 188 // A dynamic jobs asset. 189 google.ads.googleads.v15.common.DynamicJobsAsset dynamic_jobs_asset = 37; 190 191 // Output only. A location asset. 192 google.ads.googleads.v15.common.LocationAsset location_asset = 39 193 [(google.api.field_behavior) = OUTPUT_ONLY]; 194 195 // Immutable. A hotel property asset. 196 google.ads.googleads.v15.common.HotelPropertyAsset hotel_property_asset = 41 197 [(google.api.field_behavior) = IMMUTABLE]; 198 } 199} 200 201// Contains policy information for an asset under AssetFieldType context. 202message AssetFieldTypePolicySummary { 203 // Output only. FieldType of this asset. 204 optional google.ads.googleads.v15.enums.AssetFieldTypeEnum.AssetFieldType 205 asset_field_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 206 207 // Output only. Source of this asset. 208 optional google.ads.googleads.v15.enums.AssetSourceEnum.AssetSource 209 asset_source = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 210 211 // Output only. Policy summary. 212 optional AssetPolicySummary policy_summary_info = 3 213 [(google.api.field_behavior) = OUTPUT_ONLY]; 214} 215 216// Contains policy information for an asset. 217message AssetPolicySummary { 218 // Output only. The list of policy findings for this asset. 219 repeated google.ads.googleads.v15.common.PolicyTopicEntry 220 policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 221 222 // Output only. Where in the review process this asset is. 223 google.ads.googleads.v15.enums.PolicyReviewStatusEnum.PolicyReviewStatus 224 review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 225 226 // Output only. The overall approval status of this asset, calculated based on 227 // the status of its individual policy topic entries. 228 google.ads.googleads.v15.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus 229 approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; 230} 231