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/advertising_channel_type.proto"; 20import "google/ads/googleads/v16/enums/device.proto"; 21import "google/ads/googleads/v16/enums/seasonality_event_scope.proto"; 22import "google/ads/googleads/v16/enums/seasonality_event_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 = "BiddingDataExclusionProto"; 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// Represents a bidding data exclusion. 36// 37// See "About data exclusions" at 38// https://support.google.com/google-ads/answer/10370710. 39message BiddingDataExclusion { 40 option (google.api.resource) = { 41 type: "googleads.googleapis.com/BiddingDataExclusion" 42 pattern: "customers/{customer_id}/biddingDataExclusions/{seasonality_event_id}" 43 }; 44 45 // Immutable. The resource name of the data exclusion. 46 // Data exclusion resource names have the form: 47 // 48 // `customers/{customer_id}/biddingDataExclusions/{data_exclusion_id}` 49 string resource_name = 1 [ 50 (google.api.field_behavior) = IMMUTABLE, 51 (google.api.resource_reference) = { 52 type: "googleads.googleapis.com/BiddingDataExclusion" 53 } 54 ]; 55 56 // Output only. The ID of the data exclusion. 57 int64 data_exclusion_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 58 59 // The scope of the data exclusion. 60 google.ads.googleads.v16.enums.SeasonalityEventScopeEnum.SeasonalityEventScope 61 scope = 3; 62 63 // Output only. The status of the data exclusion. 64 google.ads.googleads.v16.enums.SeasonalityEventStatusEnum 65 .SeasonalityEventStatus status = 4 66 [(google.api.field_behavior) = OUTPUT_ONLY]; 67 68 // Required. The inclusive start time of the data exclusion in yyyy-MM-dd 69 // HH:mm:ss format. 70 // 71 // A data exclusion is backward looking and should be used for events that 72 // start in the past and end either in the past or future. 73 string start_date_time = 5 [(google.api.field_behavior) = REQUIRED]; 74 75 // Required. The exclusive end time of the data exclusion in yyyy-MM-dd 76 // HH:mm:ss format. 77 // 78 // The length of [start_date_time, end_date_time) interval must be 79 // within (0, 14 days]. 80 string end_date_time = 6 [(google.api.field_behavior) = REQUIRED]; 81 82 // The name of the data exclusion. The name can be at most 255 83 // characters. 84 string name = 7; 85 86 // The description of the data exclusion. The description can be at 87 // most 2048 characters. 88 string description = 8; 89 90 // If not specified, all devices will be included in this exclusion. 91 // Otherwise, only the specified targeted devices will be included in this 92 // exclusion. 93 repeated google.ads.googleads.v16.enums.DeviceEnum.Device devices = 9; 94 95 // The data exclusion will apply to the campaigns listed when the scope of 96 // this exclusion is CAMPAIGN. The maximum number of campaigns per event is 97 // 2000. 98 // Note: a data exclusion with both advertising_channel_types and 99 // campaign_ids is not supported. 100 repeated string campaigns = 10 [(google.api.resource_reference) = { 101 type: "googleads.googleapis.com/Campaign" 102 }]; 103 104 // The data_exclusion will apply to all the campaigns under the listed 105 // channels retroactively as well as going forward when the scope of this 106 // exclusion is CHANNEL. 107 // The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. 108 // Note: a data exclusion with both advertising_channel_types and 109 // campaign_ids is not supported. 110 repeated google.ads.googleads.v16.enums.AdvertisingChannelTypeEnum 111 .AdvertisingChannelType advertising_channel_types = 11; 112} 113