• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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/enums/ad_group_ad_engine_status.proto";
20import "google/ads/searchads360/v0/enums/ad_group_ad_status.proto";
21import "google/ads/searchads360/v0/resources/ad.proto";
22import "google/api/field_behavior.proto";
23import "google/api/resource.proto";
24
25option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources";
26option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources";
27option java_multiple_files = true;
28option java_outer_classname = "AdGroupAdProto";
29option java_package = "com.google.ads.searchads360.v0.resources";
30option objc_class_prefix = "GASA360";
31option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources";
32option ruby_package = "Google::Ads::SearchAds360::V0::Resources";
33
34// Proto file describing the ad group ad resource.
35
36// An ad group ad.
37message AdGroupAd {
38  option (google.api.resource) = {
39    type: "searchads360.googleapis.com/AdGroupAd"
40    pattern: "customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}"
41  };
42
43  // Immutable. The resource name of the ad.
44  // Ad group ad resource names have the form:
45  //
46  // `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
47  string resource_name = 1 [
48    (google.api.field_behavior) = IMMUTABLE,
49    (google.api.resource_reference) = {
50      type: "searchads360.googleapis.com/AdGroupAd"
51    }
52  ];
53
54  // The status of the ad.
55  google.ads.searchads360.v0.enums.AdGroupAdStatusEnum.AdGroupAdStatus status =
56      3;
57
58  // Immutable. The ad.
59  Ad ad = 5 [(google.api.field_behavior) = IMMUTABLE];
60
61  // Output only. The timestamp when this ad_group_ad was created. The datetime
62  // is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format.
63  string creation_time = 14 [(google.api.field_behavior) = OUTPUT_ONLY];
64
65  // Output only. The resource names of labels attached to this ad group ad.
66  repeated string labels = 10 [
67    (google.api.field_behavior) = OUTPUT_ONLY,
68    (google.api.resource_reference) = {
69      type: "searchads360.googleapis.com/AdGroupAdLabel"
70    }
71  ];
72
73  // Output only. ID of the ad in the external engine account. This field is for
74  // SearchAds 360 account only, for example, Yahoo Japan, Microsoft, Baidu etc.
75  // For non-SearchAds 360 entity, use "ad_group_ad.ad.id" instead.
76  string engine_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
77
78  // Output only. Additional status of the ad in the external engine account.
79  // Possible statuses (depending on the type of external account) include
80  // active, eligible, pending review, etc.
81  google.ads.searchads360.v0.enums.AdGroupAdEngineStatusEnum
82      .AdGroupAdEngineStatus engine_status = 15
83      [(google.api.field_behavior) = OUTPUT_ONLY];
84
85  // Output only. The datetime when this ad group ad was last modified. The
86  // datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss"
87  // format.
88  string last_modified_time = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
89}
90