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/common/user_lists.proto"; 20import "google/ads/googleads/v16/enums/access_reason.proto"; 21import "google/ads/googleads/v16/enums/user_list_access_status.proto"; 22import "google/ads/googleads/v16/enums/user_list_closing_reason.proto"; 23import "google/ads/googleads/v16/enums/user_list_membership_status.proto"; 24import "google/ads/googleads/v16/enums/user_list_size_range.proto"; 25import "google/ads/googleads/v16/enums/user_list_type.proto"; 26import "google/api/field_behavior.proto"; 27import "google/api/resource.proto"; 28 29option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources"; 30option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources"; 31option java_multiple_files = true; 32option java_outer_classname = "UserListProto"; 33option java_package = "com.google.ads.googleads.v16.resources"; 34option objc_class_prefix = "GAA"; 35option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources"; 36option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; 37 38// Proto file describing the User List resource. 39 40// A user list. This is a list of users a customer may target. 41message UserList { 42 option (google.api.resource) = { 43 type: "googleads.googleapis.com/UserList" 44 pattern: "customers/{customer_id}/userLists/{user_list_id}" 45 }; 46 47 // Immutable. The resource name of the user list. 48 // User list resource names have the form: 49 // 50 // `customers/{customer_id}/userLists/{user_list_id}` 51 string resource_name = 1 [ 52 (google.api.field_behavior) = IMMUTABLE, 53 (google.api.resource_reference) = { 54 type: "googleads.googleapis.com/UserList" 55 } 56 ]; 57 58 // Output only. Id of the user list. 59 optional int64 id = 25 [(google.api.field_behavior) = OUTPUT_ONLY]; 60 61 // Output only. An option that indicates if a user may edit a list. Depends on 62 // the list ownership and list type. For example, external remarketing user 63 // lists are not editable. 64 // 65 // This field is read-only. 66 optional bool read_only = 26 [(google.api.field_behavior) = OUTPUT_ONLY]; 67 68 // Name of this user list. Depending on its access_reason, the user list name 69 // may not be unique (for example, if access_reason=SHARED) 70 optional string name = 27; 71 72 // Description of this user list. 73 optional string description = 28; 74 75 // Membership status of this user list. Indicates whether a user list is open 76 // or active. Only open user lists can accumulate more users and can be 77 // targeted to. 78 google.ads.googleads.v16.enums.UserListMembershipStatusEnum 79 .UserListMembershipStatus membership_status = 6; 80 81 // An ID from external system. It is used by user list sellers to correlate 82 // IDs on their systems. 83 optional string integration_code = 29; 84 85 // Number of days a user's cookie stays on your list since its most recent 86 // addition to the list. This field must be between 0 and 540 inclusive. 87 // However, for CRM based userlists, this field can be set to 10000 which 88 // means no expiration. 89 // 90 // This field is ignored for logical_user_list and rule_based_user_list types. 91 // Membership to lists of these types depends on the rules defined by the 92 // lists. 93 optional int64 membership_life_span = 30; 94 95 // Output only. Estimated number of users in this user list, on the Google 96 // Display Network. This value is null if the number of users has not yet been 97 // determined. 98 // 99 // This field is read-only. 100 optional int64 size_for_display = 31 101 [(google.api.field_behavior) = OUTPUT_ONLY]; 102 103 // Output only. Size range in terms of number of users of the UserList, on the 104 // Google Display Network. 105 // 106 // This field is read-only. 107 google.ads.googleads.v16.enums.UserListSizeRangeEnum.UserListSizeRange 108 size_range_for_display = 10 [(google.api.field_behavior) = OUTPUT_ONLY]; 109 110 // Output only. Estimated number of users in this user list in the google.com 111 // domain. These are the users available for targeting in Search campaigns. 112 // This value is null if the number of users has not yet been determined. 113 // 114 // This field is read-only. 115 optional int64 size_for_search = 32 116 [(google.api.field_behavior) = OUTPUT_ONLY]; 117 118 // Output only. Size range in terms of number of users of the UserList, for 119 // Search ads. 120 // 121 // This field is read-only. 122 google.ads.googleads.v16.enums.UserListSizeRangeEnum.UserListSizeRange 123 size_range_for_search = 12 [(google.api.field_behavior) = OUTPUT_ONLY]; 124 125 // Output only. Type of this list. 126 // 127 // This field is read-only. 128 google.ads.googleads.v16.enums.UserListTypeEnum.UserListType type = 13 129 [(google.api.field_behavior) = OUTPUT_ONLY]; 130 131 // Indicating the reason why this user list membership status is closed. It is 132 // only populated on lists that were automatically closed due to inactivity, 133 // and will be cleared once the list membership status becomes open. 134 google.ads.googleads.v16.enums.UserListClosingReasonEnum.UserListClosingReason 135 closing_reason = 14; 136 137 // Output only. Indicates the reason this account has been granted access to 138 // the list. The reason can be SHARED, OWNED, LICENSED or SUBSCRIBED. 139 // 140 // This field is read-only. 141 google.ads.googleads.v16.enums.AccessReasonEnum.AccessReason access_reason = 142 15 [(google.api.field_behavior) = OUTPUT_ONLY]; 143 144 // Indicates if this share is still enabled. When a UserList is shared with 145 // the user this field is set to ENABLED. Later the userList owner can decide 146 // to revoke the share and make it DISABLED. 147 // The default value of this field is set to ENABLED. 148 google.ads.googleads.v16.enums.UserListAccessStatusEnum.UserListAccessStatus 149 account_user_list_status = 16; 150 151 // Indicates if this user list is eligible for Google Search Network. 152 optional bool eligible_for_search = 33; 153 154 // Output only. Indicates this user list is eligible for Google Display 155 // Network. 156 // 157 // This field is read-only. 158 optional bool eligible_for_display = 34 159 [(google.api.field_behavior) = OUTPUT_ONLY]; 160 161 // Output only. Indicates match rate for Customer Match lists. The range of 162 // this field is [0-100]. This will be null for other list types or when it's 163 // not possible to calculate the match rate. 164 // 165 // This field is read-only. 166 optional int32 match_rate_percentage = 24 167 [(google.api.field_behavior) = OUTPUT_ONLY]; 168 169 // The user list. 170 // 171 // Exactly one must be set. 172 oneof user_list { 173 // User list of CRM users provided by the advertiser. 174 google.ads.googleads.v16.common.CrmBasedUserListInfo crm_based_user_list = 175 19; 176 177 // Output only. User list which are similar to users from another UserList. 178 // These lists are readonly and automatically created by google. 179 google.ads.googleads.v16.common.SimilarUserListInfo similar_user_list = 20 180 [(google.api.field_behavior) = OUTPUT_ONLY]; 181 182 // User list generated by a rule. 183 google.ads.googleads.v16.common.RuleBasedUserListInfo rule_based_user_list = 184 21; 185 186 // User list that is a custom combination of user lists and user interests. 187 google.ads.googleads.v16.common.LogicalUserListInfo logical_user_list = 22; 188 189 // User list targeting as a collection of conversion or remarketing actions. 190 google.ads.googleads.v16.common.BasicUserListInfo basic_user_list = 23; 191 192 // Immutable. Lookalike User List. 193 google.ads.googleads.v16.common.LookalikeUserListInfo lookalike_user_list = 194 36 [(google.api.field_behavior) = IMMUTABLE]; 195 } 196} 197