xref: /aosp_15_r20/external/googleapis/google/ads/searchads360/v0/resources/asset.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
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.searchads360.v0.resources;
18
19import "google/ads/searchads360/v0/common/asset_types.proto";
20import "google/ads/searchads360/v0/enums/asset_engine_status.proto";
21import "google/ads/searchads360/v0/enums/asset_status.proto";
22import "google/ads/searchads360/v0/enums/asset_type.proto";
23import "google/api/field_behavior.proto";
24import "google/api/resource.proto";
25
26option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources";
27option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources";
28option java_multiple_files = true;
29option java_outer_classname = "AssetProto";
30option java_package = "com.google.ads.searchads360.v0.resources";
31option objc_class_prefix = "GASA360";
32option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources";
33option ruby_package = "Google::Ads::SearchAds360::V0::Resources";
34
35// Proto file describing the asset resource.
36
37// Asset is a part of an ad which can be shared across multiple ads.
38// It can be an image (ImageAsset), a video (YoutubeVideoAsset), etc.
39// Assets are immutable and cannot be removed. To stop an asset from serving,
40// remove the asset from the entity that is using it.
41message Asset {
42  option (google.api.resource) = {
43    type: "searchads360.googleapis.com/Asset"
44    pattern: "customers/{customer_id}/assets/{asset_id}"
45  };
46
47  // Immutable. The resource name of the asset.
48  // Asset resource names have the form:
49  //
50  // `customers/{customer_id}/assets/{asset_id}`
51  string resource_name = 1 [
52    (google.api.field_behavior) = IMMUTABLE,
53    (google.api.resource_reference) = {
54      type: "searchads360.googleapis.com/Asset"
55    }
56  ];
57
58  // Output only. The ID of the asset.
59  optional int64 id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
60
61  // Optional name of the asset.
62  optional string name = 12;
63
64  // Output only. Type of the asset.
65  google.ads.searchads360.v0.enums.AssetTypeEnum.AssetType type = 4
66      [(google.api.field_behavior) = OUTPUT_ONLY];
67
68  // A list of possible final URLs after all cross domain redirects.
69  repeated string final_urls = 14;
70
71  // URL template for constructing a tracking URL.
72  optional string tracking_url_template = 17;
73
74  // Output only. The status of the asset.
75  google.ads.searchads360.v0.enums.AssetStatusEnum.AssetStatus status = 42
76      [(google.api.field_behavior) = OUTPUT_ONLY];
77
78  // Output only. The timestamp when this asset was created. The timestamp is in
79  // the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format.
80  string creation_time = 43 [(google.api.field_behavior) = OUTPUT_ONLY];
81
82  // Output only. The datetime when this asset was last modified. The datetime
83  // is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
84  string last_modified_time = 44 [(google.api.field_behavior) = OUTPUT_ONLY];
85
86  // Output only. The Engine Status for an asset.
87  optional
88      google.ads.searchads360.v0.enums.AssetEngineStatusEnum.AssetEngineStatus
89          engine_status = 61 [(google.api.field_behavior) = OUTPUT_ONLY];
90
91  // The specific type of the asset.
92  oneof asset_data {
93    // Immutable. A YouTube video asset.
94    google.ads.searchads360.v0.common.YoutubeVideoAsset youtube_video_asset = 5
95        [(google.api.field_behavior) = IMMUTABLE];
96
97    // Output only. An image asset.
98    google.ads.searchads360.v0.common.ImageAsset image_asset = 7
99        [(google.api.field_behavior) = OUTPUT_ONLY];
100
101    // Output only. A text asset.
102    google.ads.searchads360.v0.common.TextAsset text_asset = 8
103        [(google.api.field_behavior) = OUTPUT_ONLY];
104
105    // Output only. A unified callout asset.
106    google.ads.searchads360.v0.common.UnifiedCalloutAsset callout_asset = 48
107        [(google.api.field_behavior) = OUTPUT_ONLY];
108
109    // Output only. A unified sitelink asset.
110    google.ads.searchads360.v0.common.UnifiedSitelinkAsset sitelink_asset = 45
111        [(google.api.field_behavior) = OUTPUT_ONLY];
112
113    // Output only. A unified page feed asset.
114    google.ads.searchads360.v0.common.UnifiedPageFeedAsset page_feed_asset = 46
115        [(google.api.field_behavior) = OUTPUT_ONLY];
116
117    // A mobile app asset.
118    google.ads.searchads360.v0.common.MobileAppAsset mobile_app_asset = 25;
119
120    // Output only. A unified call asset.
121    google.ads.searchads360.v0.common.UnifiedCallAsset call_asset = 47
122        [(google.api.field_behavior) = OUTPUT_ONLY];
123
124    // Immutable. A call to action asset.
125    google.ads.searchads360.v0.common.CallToActionAsset call_to_action_asset =
126        29 [(google.api.field_behavior) = IMMUTABLE];
127
128    // Output only. A unified location asset.
129    google.ads.searchads360.v0.common.UnifiedLocationAsset location_asset = 49
130        [(google.api.field_behavior) = OUTPUT_ONLY];
131  }
132}
133