• 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/campaign_group_status.proto";
20import "google/api/field_behavior.proto";
21import "google/api/resource.proto";
22
23option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources";
24option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources";
25option java_multiple_files = true;
26option java_outer_classname = "CampaignGroupProto";
27option java_package = "com.google.ads.googleads.v16.resources";
28option objc_class_prefix = "GAA";
29option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources";
30option ruby_package = "Google::Ads::GoogleAds::V16::Resources";
31
32// Proto file describing the Campaign group resource.
33
34// A campaign group.
35message CampaignGroup {
36  option (google.api.resource) = {
37    type: "googleads.googleapis.com/CampaignGroup"
38    pattern: "customers/{customer_id}/campaignGroups/{campaign_group_id}"
39  };
40
41  // Immutable. The resource name of the campaign group.
42  // Campaign group resource names have the form:
43  //
44  // `customers/{customer_id}/campaignGroups/{campaign_group_id}`
45  string resource_name = 1 [
46    (google.api.field_behavior) = IMMUTABLE,
47    (google.api.resource_reference) = {
48      type: "googleads.googleapis.com/CampaignGroup"
49    }
50  ];
51
52  // Output only. The ID of the campaign group.
53  int64 id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
54
55  // The name of the campaign group.
56  //
57  // This field is required and should not be empty when creating new campaign
58  // groups.
59  //
60  // It must not contain any null (code point 0x0), NL line feed
61  // (code point 0xA) or carriage return (code point 0xD) characters.
62  string name = 4;
63
64  // The status of the campaign group.
65  //
66  // When a new campaign group is added, the status defaults to ENABLED.
67  google.ads.googleads.v16.enums.CampaignGroupStatusEnum.CampaignGroupStatus
68      status = 5;
69}
70