xref: /aosp_15_r20/external/googleapis/google/ads/searchads360/v0/resources/ad.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/ad_type_infos.proto";
20import "google/ads/searchads360/v0/enums/ad_type.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23
24option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources";
25option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources";
26option java_multiple_files = true;
27option java_outer_classname = "AdProto";
28option java_package = "com.google.ads.searchads360.v0.resources";
29option objc_class_prefix = "GASA360";
30option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources";
31option ruby_package = "Google::Ads::SearchAds360::V0::Resources";
32
33// Proto file describing the ad type.
34
35// An ad.
36message Ad {
37  option (google.api.resource) = {
38    type: "searchads360.googleapis.com/Ad"
39    pattern: "customers/{customer_id}/ads/{ad_id}"
40  };
41
42  // Immutable. The resource name of the ad.
43  // Ad resource names have the form:
44  //
45  // `customers/{customer_id}/ads/{ad_id}`
46  string resource_name = 37 [
47    (google.api.field_behavior) = IMMUTABLE,
48    (google.api.resource_reference) = { type: "searchads360.googleapis.com/Ad" }
49  ];
50
51  // Output only. The ID of the ad.
52  optional int64 id = 40 [(google.api.field_behavior) = OUTPUT_ONLY];
53
54  // The list of possible final URLs after all cross-domain redirects for the
55  // ad.
56  repeated string final_urls = 41;
57
58  // The URL that appears in the ad description for some ad formats.
59  optional string display_url = 45;
60
61  // Output only. The type of ad.
62  google.ads.searchads360.v0.enums.AdTypeEnum.AdType type = 5
63      [(google.api.field_behavior) = OUTPUT_ONLY];
64
65  // Immutable. The name of the ad. This is only used to be able to identify the
66  // ad. It does not need to be unique and does not affect the served ad. The
67  // name field is currently only supported for DisplayUploadAd, ImageAd,
68  // ShoppingComparisonListingAd and VideoAd.
69  optional string name = 47 [(google.api.field_behavior) = IMMUTABLE];
70
71  // Details pertinent to the ad type. Exactly one value must be set.
72  oneof ad_data {
73    // Immutable. Details pertaining to a text ad.
74    google.ads.searchads360.v0.common.SearchAds360TextAdInfo text_ad = 55
75        [(google.api.field_behavior) = IMMUTABLE];
76
77    // Immutable. Details pertaining to an expanded text ad.
78    google.ads.searchads360.v0.common.SearchAds360ExpandedTextAdInfo
79        expanded_text_ad = 56 [(google.api.field_behavior) = IMMUTABLE];
80
81    // Immutable. Details pertaining to a responsive search ad.
82    google.ads.searchads360.v0.common.SearchAds360ResponsiveSearchAdInfo
83        responsive_search_ad = 57 [(google.api.field_behavior) = IMMUTABLE];
84
85    // Immutable. Details pertaining to a product ad.
86    google.ads.searchads360.v0.common.SearchAds360ProductAdInfo product_ad = 58
87        [(google.api.field_behavior) = IMMUTABLE];
88
89    // Immutable. Details pertaining to an expanded dynamic search ad.
90    google.ads.searchads360.v0.common.SearchAds360ExpandedDynamicSearchAdInfo
91        expanded_dynamic_search_ad = 59
92        [(google.api.field_behavior) = IMMUTABLE];
93  }
94}
95