/
ad_group_ad.proto
121 lines (102 loc) · 4.82 KB
/
ad_group_ad.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// Copyright 2023 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.v16.resources;
import "google/ads/googleads/v16/common/policy.proto";
import "google/ads/googleads/v16/enums/ad_group_ad_primary_status.proto";
import "google/ads/googleads/v16/enums/ad_group_ad_primary_status_reason.proto";
import "google/ads/googleads/v16/enums/ad_group_ad_status.proto";
import "google/ads/googleads/v16/enums/ad_strength.proto";
import "google/ads/googleads/v16/enums/policy_approval_status.proto";
import "google/ads/googleads/v16/enums/policy_review_status.proto";
import "google/ads/googleads/v16/resources/ad.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
option java_multiple_files = true;
option java_outer_classname = "AdGroupAdProto";
option java_package = "com.google.ads.googleads.v16.resources";
option objc_class_prefix = "GAA";
option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
// Proto file describing the ad group ad resource.
// An ad group ad.
message AdGroupAd {
option (google.api.resource) = {
type: "googleads.googleapis.com/AdGroupAd"
pattern: "customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}"
};
// Immutable. The resource name of the ad.
// Ad group ad resource names have the form:
//
// `customers/{customer_id}/adGroupAds/{ad_group_id}~{ad_id}`
string resource_name = 1 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
type: "googleads.googleapis.com/AdGroupAd"
}
];
// The status of the ad.
google.ads.googleads.v16.enums.AdGroupAdStatusEnum.AdGroupAdStatus status = 3;
// Immutable. The ad group to which the ad belongs.
optional string ad_group = 9 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.resource_reference) = {
type: "googleads.googleapis.com/AdGroup"
}
];
// Immutable. The ad.
Ad ad = 5 [(google.api.field_behavior) = IMMUTABLE];
// Output only. Policy information for the ad.
AdGroupAdPolicySummary policy_summary = 6
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Overall ad strength for this ad group ad.
google.ads.googleads.v16.enums.AdStrengthEnum.AdStrength ad_strength = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. A list of recommendations to improve the ad strength. For
// example, a recommendation could be "Try adding a few more unique headlines
// or unpinning some assets.".
repeated string action_items = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The resource names of labels attached to this ad group ad.
repeated string labels = 10 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "googleads.googleapis.com/AdGroupAdLabel"
}
];
// Output only. Provides aggregated view into why an ad group ad is not
// serving or not serving optimally.
google.ads.googleads.v16.enums.AdGroupAdPrimaryStatusEnum
.AdGroupAdPrimaryStatus primary_status = 16
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Provides reasons for why an ad group ad is not serving or not
// serving optimally.
repeated google.ads.googleads.v16.enums.AdGroupAdPrimaryStatusReasonEnum
.AdGroupAdPrimaryStatusReason primary_status_reasons = 17
[(google.api.field_behavior) = OUTPUT_ONLY];
}
// Contains policy information for an ad.
message AdGroupAdPolicySummary {
// Output only. The list of policy findings for this ad.
repeated google.ads.googleads.v16.common.PolicyTopicEntry
policy_topic_entries = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Where in the review process this ad is.
google.ads.googleads.v16.enums.PolicyReviewStatusEnum.PolicyReviewStatus
review_status = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The overall approval status of this ad, calculated based on
// the status of its individual policy topic entries.
google.ads.googleads.v16.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
approval_status = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
}