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/targeting_setting.proto"; 20import "google/ads/searchads360/v0/enums/ad_group_ad_rotation_mode.proto"; 21import "google/ads/searchads360/v0/enums/ad_group_engine_status.proto"; 22import "google/ads/searchads360/v0/enums/ad_group_status.proto"; 23import "google/ads/searchads360/v0/enums/ad_group_type.proto"; 24import "google/api/field_behavior.proto"; 25import "google/api/resource.proto"; 26 27option csharp_namespace = "Google.Ads.SearchAds360.V0.Resources"; 28option go_package = "google.golang.org/genproto/googleapis/ads/searchads360/v0/resources;resources"; 29option java_multiple_files = true; 30option java_outer_classname = "AdGroupProto"; 31option java_package = "com.google.ads.searchads360.v0.resources"; 32option objc_class_prefix = "GASA360"; 33option php_namespace = "Google\\Ads\\SearchAds360\\V0\\Resources"; 34option ruby_package = "Google::Ads::SearchAds360::V0::Resources"; 35 36// Proto file describing the ad group resource. 37 38// An ad group. 39message AdGroup { 40 option (google.api.resource) = { 41 type: "searchads360.googleapis.com/AdGroup" 42 pattern: "customers/{customer_id}/adGroups/{ad_group_id}" 43 }; 44 45 // Immutable. The resource name of the ad group. 46 // Ad group resource names have the form: 47 // 48 // `customers/{customer_id}/adGroups/{ad_group_id}` 49 string resource_name = 1 [ 50 (google.api.field_behavior) = IMMUTABLE, 51 (google.api.resource_reference) = { 52 type: "searchads360.googleapis.com/AdGroup" 53 } 54 ]; 55 56 // Output only. The ID of the ad group. 57 optional int64 id = 34 [(google.api.field_behavior) = OUTPUT_ONLY]; 58 59 // The name of the ad group. 60 // 61 // This field is required and should not be empty when creating new ad 62 // groups. 63 // 64 // It must contain fewer than 255 UTF-8 full-width characters. 65 // 66 // It must not contain any null (code point 0x0), NL line feed 67 // (code point 0xA) or carriage return (code point 0xD) characters. 68 optional string name = 35; 69 70 // The status of the ad group. 71 google.ads.searchads360.v0.enums.AdGroupStatusEnum.AdGroupStatus status = 5; 72 73 // Immutable. The type of the ad group. 74 google.ads.searchads360.v0.enums.AdGroupTypeEnum.AdGroupType type = 12 75 [(google.api.field_behavior) = IMMUTABLE]; 76 77 // The ad rotation mode of the ad group. 78 google.ads.searchads360.v0.enums.AdGroupAdRotationModeEnum 79 .AdGroupAdRotationMode ad_rotation_mode = 22; 80 81 // The maximum CPC (cost-per-click) bid. 82 optional int64 cpc_bid_micros = 39; 83 84 // Output only. The timestamp when this ad_group was created. The timestamp is 85 // in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. 86 string creation_time = 60 [(google.api.field_behavior) = OUTPUT_ONLY]; 87 88 // Output only. The Engine Status for ad group. 89 optional google.ads.searchads360.v0.enums.AdGroupEngineStatusEnum 90 .AdGroupEngineStatus engine_status = 61 91 [(google.api.field_behavior) = OUTPUT_ONLY]; 92 93 // Setting for targeting related features. 94 google.ads.searchads360.v0.common.TargetingSetting targeting_setting = 25; 95 96 // Output only. The resource names of labels attached to this ad group. 97 repeated string labels = 49 [ 98 (google.api.field_behavior) = OUTPUT_ONLY, 99 (google.api.resource_reference) = { 100 type: "searchads360.googleapis.com/AdGroupLabel" 101 } 102 ]; 103 104 // Output only. ID of the ad group in the external engine account. This field 105 // is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, 106 // Baidu etc. For Google Ads entity, use "ad_group.id" instead. 107 string engine_id = 50 [(google.api.field_behavior) = OUTPUT_ONLY]; 108 109 // Output only. Date when this ad group starts serving ads. By default, the ad 110 // group starts now or the ad group's start date, whichever is later. If this 111 // field is set, then the ad group starts at the beginning of the specified 112 // date in the customer's time zone. This field is only available for 113 // Microsoft Advertising and Facebook gateway accounts. 114 // 115 // Format: YYYY-MM-DD 116 // Example: 2019-03-14 117 string start_date = 51 [(google.api.field_behavior) = OUTPUT_ONLY]; 118 119 // Output only. Date when the ad group ends serving ads. By default, the ad 120 // group ends on the ad group's end date. If this field is set, then the ad 121 // group ends at the end of the specified date in the customer's time zone. 122 // This field is only available for Microsoft Advertising and Facebook gateway 123 // accounts. 124 // 125 // Format: YYYY-MM-DD 126 // Example: 2019-03-14 127 string end_date = 52 [(google.api.field_behavior) = OUTPUT_ONLY]; 128 129 // Output only. The language of the ads and keywords in an ad group. This 130 // field is only available for Microsoft Advertising accounts. More details: 131 // https://docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13#adlanguage 132 string language_code = 53 [(google.api.field_behavior) = OUTPUT_ONLY]; 133 134 // Output only. The datetime when this ad group was last modified. The 135 // datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" 136 // format. 137 string last_modified_time = 55 [(google.api.field_behavior) = OUTPUT_ONLY]; 138} 139