• 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.googleads.v16.resources;
18
19import "google/ads/googleads/v16/enums/ad_strength.proto";
20import "google/ads/googleads/v16/enums/asset_group_primary_status.proto";
21import "google/ads/googleads/v16/enums/asset_group_primary_status_reason.proto";
22import "google/ads/googleads/v16/enums/asset_group_status.proto";
23import "google/api/field_behavior.proto";
24import "google/api/resource.proto";
25
26option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
27option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
28option java_multiple_files = true;
29option java_outer_classname = "AssetGroupProto";
30option java_package = "com.google.ads.googleads.v16.resources";
31option objc_class_prefix = "GAA";
32option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
33option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
34
35// An asset group.
36// AssetGroupAsset is used to link an asset to the asset group.
37// AssetGroupSignal is used to associate a signal to an asset group.
38message AssetGroup {
39  option (google.api.resource) = {
40    type: "googleads.googleapis.com/AssetGroup"
41    pattern: "customers/{customer_id}/assetGroups/{asset_group_id}"
42  };
43
44  // Immutable. The resource name of the asset group.
45  // Asset group resource names have the form:
46  //
47  // `customers/{customer_id}/assetGroups/{asset_group_id}`
48  string resource_name = 1 [
49    (google.api.field_behavior) = IMMUTABLE,
50    (google.api.resource_reference) = {
51      type: "googleads.googleapis.com/AssetGroup"
52    }
53  ];
54
55  // Output only. The ID of the asset group.
56  int64 id = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
57
58  // Immutable. The campaign with which this asset group is associated.
59  // The asset which is linked to the asset group.
60  string campaign = 2 [
61    (google.api.field_behavior) = IMMUTABLE,
62    (google.api.resource_reference) = {
63      type: "googleads.googleapis.com/Campaign"
64    }
65  ];
66
67  // Required. Name of the asset group. Required. It must have a minimum length
68  // of 1 and maximum length of 128. It must be unique under a campaign.
69  string name = 3 [(google.api.field_behavior) = REQUIRED];
70
71  // A list of final URLs after all cross domain redirects. In performance max,
72  // by default, the urls are eligible for expansion unless opted out.
73  repeated string final_urls = 4;
74
75  // A list of final mobile URLs after all cross domain redirects. In
76  // performance max, by default, the urls are eligible for expansion
77  // unless opted out.
78  repeated string final_mobile_urls = 5;
79
80  // The status of the asset group.
81  google.ads.googleads.v16.enums.AssetGroupStatusEnum.AssetGroupStatus status =
82      6;
83
84  // Output only. The primary status of the asset group. Provides insights into
85  // why an asset group is not serving or not serving optimally.
86  google.ads.googleads.v16.enums.AssetGroupPrimaryStatusEnum
87      .AssetGroupPrimaryStatus primary_status = 11
88      [(google.api.field_behavior) = OUTPUT_ONLY];
89
90  // Output only. Provides reasons into why an asset group is not serving or not
91  // serving optimally. It will be empty when the asset group is serving without
92  // issues.
93  repeated google.ads.googleads.v16.enums.AssetGroupPrimaryStatusReasonEnum
94      .AssetGroupPrimaryStatusReason primary_status_reasons = 12
95      [(google.api.field_behavior) = OUTPUT_ONLY];
96
97  // First part of text that may appear appended to the url displayed in
98  // the ad.
99  string path1 = 7;
100
101  // Second part of text that may appear appended to the url displayed in
102  // the ad. This field can only be set when path1 is set.
103  string path2 = 8;
104
105  // Output only. Overall ad strength of this asset group.
106  google.ads.googleads.v16.enums.AdStrengthEnum.AdStrength ad_strength = 10
107      [(google.api.field_behavior) = OUTPUT_ONLY];
108}
109