google-apis-datamanager_v1 0.3.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -128,16 +128,28 @@ module Google
128
128
  attr_accessor :mobile_data
129
129
 
130
130
  # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience.
131
- # At least one PAIR ID is required.
131
+ # At least one PAIR ID is required. This feature is only available to data
132
+ # partners.
132
133
  # Corresponds to the JSON property `pairData`
133
134
  # @return [Google::Apis::DatamanagerV1::PairData]
134
135
  attr_accessor :pair_data
135
136
 
137
+ # Publisher provided identifiers data holding the ppids. At least one ppid is
138
+ # required. This feature is only available to data partners.
139
+ # Corresponds to the JSON property `ppidData`
140
+ # @return [Google::Apis::DatamanagerV1::PpidData]
141
+ attr_accessor :ppid_data
142
+
136
143
  # Data that identifies the user. At least one identifier is required.
137
144
  # Corresponds to the JSON property `userData`
138
145
  # @return [Google::Apis::DatamanagerV1::UserData]
139
146
  attr_accessor :user_data
140
147
 
148
+ # User id data holding the user id.
149
+ # Corresponds to the JSON property `userIdData`
150
+ # @return [Google::Apis::DatamanagerV1::UserIdData]
151
+ attr_accessor :user_id_data
152
+
141
153
  def initialize(**args)
142
154
  update!(**args)
143
155
  end
@@ -148,7 +160,9 @@ module Google
148
160
  @destination_references = args[:destination_references] if args.key?(:destination_references)
149
161
  @mobile_data = args[:mobile_data] if args.key?(:mobile_data)
150
162
  @pair_data = args[:pair_data] if args.key?(:pair_data)
163
+ @ppid_data = args[:ppid_data] if args.key?(:ppid_data)
151
164
  @user_data = args[:user_data] if args.key?(:user_data)
165
+ @user_id_data = args[:user_id_data] if args.key?(:user_id_data)
152
166
  end
153
167
  end
154
168
 
@@ -193,6 +207,34 @@ module Google
193
207
  end
194
208
  end
195
209
 
210
+ # Baseline criteria against which insights are compared.
211
+ class Baseline
212
+ include Google::Apis::Core::Hashable
213
+
214
+ # The baseline location of the request. Baseline location is on OR-list of ISO
215
+ # 3166-1 alpha-2 region codes of the requested regions.
216
+ # Corresponds to the JSON property `baselineLocation`
217
+ # @return [Google::Apis::DatamanagerV1::Location]
218
+ attr_accessor :baseline_location
219
+
220
+ # If set to true, the service will try to automatically detect the baseline
221
+ # location for insights.
222
+ # Corresponds to the JSON property `locationAutoDetectionEnabled`
223
+ # @return [Boolean]
224
+ attr_accessor :location_auto_detection_enabled
225
+ alias_method :location_auto_detection_enabled?, :location_auto_detection_enabled
226
+
227
+ def initialize(**args)
228
+ update!(**args)
229
+ end
230
+
231
+ # Update properties of this object
232
+ def update!(**args)
233
+ @baseline_location = args[:baseline_location] if args.key?(:baseline_location)
234
+ @location_auto_detection_enabled = args[:location_auto_detection_enabled] if args.key?(:location_auto_detection_enabled)
235
+ end
236
+ end
237
+
196
238
  # The cart data associated with the event.
197
239
  class CartData
198
240
  include Google::Apis::Core::Hashable
@@ -263,6 +305,31 @@ module Google
263
305
  end
264
306
  end
265
307
 
308
+ # Additional information when `CONTACT_ID` is one of the `upload_key_types`.
309
+ class ContactIdInfo
310
+ include Google::Apis::Core::Hashable
311
+
312
+ # Optional. Immutable. Source of the upload data
313
+ # Corresponds to the JSON property `dataSourceType`
314
+ # @return [String]
315
+ attr_accessor :data_source_type
316
+
317
+ # Output only. Match rate for customer match user lists.
318
+ # Corresponds to the JSON property `matchRatePercentage`
319
+ # @return [Fixnum]
320
+ attr_accessor :match_rate_percentage
321
+
322
+ def initialize(**args)
323
+ update!(**args)
324
+ end
325
+
326
+ # Update properties of this object
327
+ def update!(**args)
328
+ @data_source_type = args[:data_source_type] if args.key?(:data_source_type)
329
+ @match_rate_percentage = args[:match_rate_percentage] if args.key?(:match_rate_percentage)
330
+ end
331
+ end
332
+
266
333
  # Custom variable for ads conversions.
267
334
  class CustomVariable
268
335
  include Google::Apis::Core::Hashable
@@ -377,6 +444,22 @@ module Google
377
444
  end
378
445
  end
379
446
 
447
+ # A generic empty message that you can re-use to avoid defining duplicated empty
448
+ # messages in your APIs. A typical example is to use it as the request or the
449
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
450
+ # protobuf.Empty) returns (google.protobuf.Empty); `
451
+ class Empty
452
+ include Google::Apis::Core::Hashable
453
+
454
+ def initialize(**args)
455
+ update!(**args)
456
+ end
457
+
458
+ # Update properties of this object
459
+ def update!(**args)
460
+ end
461
+ end
462
+
380
463
  # Encryption information for the data being ingested.
381
464
  class EncryptionInfo
382
465
  include Google::Apis::Core::Hashable
@@ -780,12 +863,24 @@ module Google
780
863
  # @return [Google::Apis::DatamanagerV1::IngestPairDataStatus]
781
864
  attr_accessor :pair_data_ingestion_status
782
865
 
866
+ # The status of the ppid data ingestion to the destination containing stats
867
+ # related to the ingestion.
868
+ # Corresponds to the JSON property `ppidDataIngestionStatus`
869
+ # @return [Google::Apis::DatamanagerV1::IngestPpidDataStatus]
870
+ attr_accessor :ppid_data_ingestion_status
871
+
783
872
  # The status of the user data ingestion to the destination containing stats
784
873
  # related to the ingestion.
785
874
  # Corresponds to the JSON property `userDataIngestionStatus`
786
875
  # @return [Google::Apis::DatamanagerV1::IngestUserDataStatus]
787
876
  attr_accessor :user_data_ingestion_status
788
877
 
878
+ # The status of the user id data ingestion to the destination containing stats
879
+ # related to the ingestion.
880
+ # Corresponds to the JSON property `userIdDataIngestionStatus`
881
+ # @return [Google::Apis::DatamanagerV1::IngestUserIdDataStatus]
882
+ attr_accessor :user_id_data_ingestion_status
883
+
789
884
  def initialize(**args)
790
885
  update!(**args)
791
886
  end
@@ -794,7 +889,9 @@ module Google
794
889
  def update!(**args)
795
890
  @mobile_data_ingestion_status = args[:mobile_data_ingestion_status] if args.key?(:mobile_data_ingestion_status)
796
891
  @pair_data_ingestion_status = args[:pair_data_ingestion_status] if args.key?(:pair_data_ingestion_status)
892
+ @ppid_data_ingestion_status = args[:ppid_data_ingestion_status] if args.key?(:ppid_data_ingestion_status)
797
893
  @user_data_ingestion_status = args[:user_data_ingestion_status] if args.key?(:user_data_ingestion_status)
894
+ @user_id_data_ingestion_status = args[:user_id_data_ingestion_status] if args.key?(:user_id_data_ingestion_status)
798
895
  end
799
896
  end
800
897
 
@@ -957,6 +1054,36 @@ module Google
957
1054
  end
958
1055
  end
959
1056
 
1057
+ # The status of the ppid data ingestion to the destination containing stats
1058
+ # related to the ingestion.
1059
+ class IngestPpidDataStatus
1060
+ include Google::Apis::Core::Hashable
1061
+
1062
+ # The total count of ppids sent in the upload request for the destination.
1063
+ # Includes all ppids in the request, regardless of whether they were
1064
+ # successfully ingested or not.
1065
+ # Corresponds to the JSON property `ppidCount`
1066
+ # @return [Fixnum]
1067
+ attr_accessor :ppid_count
1068
+
1069
+ # The total count of audience members sent in the upload request for the
1070
+ # destination. Includes all audience members in the request, regardless of
1071
+ # whether they were successfully ingested or not.
1072
+ # Corresponds to the JSON property `recordCount`
1073
+ # @return [Fixnum]
1074
+ attr_accessor :record_count
1075
+
1076
+ def initialize(**args)
1077
+ update!(**args)
1078
+ end
1079
+
1080
+ # Update properties of this object
1081
+ def update!(**args)
1082
+ @ppid_count = args[:ppid_count] if args.key?(:ppid_count)
1083
+ @record_count = args[:record_count] if args.key?(:record_count)
1084
+ end
1085
+ end
1086
+
960
1087
  # The status of the user data ingestion to the destination containing stats
961
1088
  # related to the ingestion.
962
1089
  class IngestUserDataStatus
@@ -993,6 +1120,93 @@ module Google
993
1120
  end
994
1121
  end
995
1122
 
1123
+ # The status of the user id data ingestion to the destination containing stats
1124
+ # related to the ingestion.
1125
+ class IngestUserIdDataStatus
1126
+ include Google::Apis::Core::Hashable
1127
+
1128
+ # The total count of audience members sent in the upload request for the
1129
+ # destination. Includes all audience members in the request, regardless of
1130
+ # whether they were successfully ingested or not.
1131
+ # Corresponds to the JSON property `recordCount`
1132
+ # @return [Fixnum]
1133
+ attr_accessor :record_count
1134
+
1135
+ # The total count of user ids sent in the upload request for the destination.
1136
+ # Includes all user ids in the request, regardless of whether they were
1137
+ # successfully ingested or not.
1138
+ # Corresponds to the JSON property `userIdCount`
1139
+ # @return [Fixnum]
1140
+ attr_accessor :user_id_count
1141
+
1142
+ def initialize(**args)
1143
+ update!(**args)
1144
+ end
1145
+
1146
+ # Update properties of this object
1147
+ def update!(**args)
1148
+ @record_count = args[:record_count] if args.key?(:record_count)
1149
+ @user_id_count = args[:user_id_count] if args.key?(:user_id_count)
1150
+ end
1151
+ end
1152
+
1153
+ # Represents a user list that is populated by user provided data.
1154
+ class IngestedUserListInfo
1155
+ include Google::Apis::Core::Hashable
1156
+
1157
+ # Additional information when `CONTACT_ID` is one of the `upload_key_types`.
1158
+ # Corresponds to the JSON property `contactIdInfo`
1159
+ # @return [Google::Apis::DatamanagerV1::ContactIdInfo]
1160
+ attr_accessor :contact_id_info
1161
+
1162
+ # Additional information when `MOBILE_ID` is one of the `upload_key_types`.
1163
+ # Corresponds to the JSON property `mobileIdInfo`
1164
+ # @return [Google::Apis::DatamanagerV1::MobileIdInfo]
1165
+ attr_accessor :mobile_id_info
1166
+
1167
+ # Additional information when `PAIR_ID` is one of the `upload_key_types`. This
1168
+ # feature is only available to data partners.
1169
+ # Corresponds to the JSON property `pairIdInfo`
1170
+ # @return [Google::Apis::DatamanagerV1::PairIdInfo]
1171
+ attr_accessor :pair_id_info
1172
+
1173
+ # Additional information for partner audiences. This feature is only available
1174
+ # to data partners.
1175
+ # Corresponds to the JSON property `partnerAudienceInfo`
1176
+ # @return [Google::Apis::DatamanagerV1::PartnerAudienceInfo]
1177
+ attr_accessor :partner_audience_info
1178
+
1179
+ # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
1180
+ # Corresponds to the JSON property `pseudonymousIdInfo`
1181
+ # @return [Google::Apis::DatamanagerV1::PseudonymousIdInfo]
1182
+ attr_accessor :pseudonymous_id_info
1183
+
1184
+ # Required. Immutable. Upload key types of this user list.
1185
+ # Corresponds to the JSON property `uploadKeyTypes`
1186
+ # @return [Array<String>]
1187
+ attr_accessor :upload_key_types
1188
+
1189
+ # Additional information when `USER_ID` is one of the `upload_key_types`.
1190
+ # Corresponds to the JSON property `userIdInfo`
1191
+ # @return [Google::Apis::DatamanagerV1::UserIdInfo]
1192
+ attr_accessor :user_id_info
1193
+
1194
+ def initialize(**args)
1195
+ update!(**args)
1196
+ end
1197
+
1198
+ # Update properties of this object
1199
+ def update!(**args)
1200
+ @contact_id_info = args[:contact_id_info] if args.key?(:contact_id_info)
1201
+ @mobile_id_info = args[:mobile_id_info] if args.key?(:mobile_id_info)
1202
+ @pair_id_info = args[:pair_id_info] if args.key?(:pair_id_info)
1203
+ @partner_audience_info = args[:partner_audience_info] if args.key?(:partner_audience_info)
1204
+ @pseudonymous_id_info = args[:pseudonymous_id_info] if args.key?(:pseudonymous_id_info)
1205
+ @upload_key_types = args[:upload_key_types] if args.key?(:upload_key_types)
1206
+ @user_id_info = args[:user_id_info] if args.key?(:user_id_info)
1207
+ end
1208
+ end
1209
+
996
1210
  # Represents an item in the cart associated with the event.
997
1211
  class Item
998
1212
  include Google::Apis::Core::Hashable
@@ -1068,15 +1282,20 @@ module Google
1068
1282
  end
1069
1283
  end
1070
1284
 
1071
- # Mobile IDs for the audience. At least one mobile ID is required.
1072
- class MobileData
1285
+ # Response from the ListUserListDirectLicensesRequest.
1286
+ class ListUserListDirectLicensesResponse
1073
1287
  include Google::Apis::Core::Hashable
1074
1288
 
1075
- # Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `
1076
- # mobileIds` can be provided in a single AudienceMember.
1077
- # Corresponds to the JSON property `mobileIds`
1078
- # @return [Array<String>]
1079
- attr_accessor :mobile_ids
1289
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1290
+ # field is omitted, there are no subsequent pages.
1291
+ # Corresponds to the JSON property `nextPageToken`
1292
+ # @return [String]
1293
+ attr_accessor :next_page_token
1294
+
1295
+ # The licenses for the given user list in the request.
1296
+ # Corresponds to the JSON property `userListDirectLicenses`
1297
+ # @return [Array<Google::Apis::DatamanagerV1::UserListDirectLicense>]
1298
+ attr_accessor :user_list_direct_licenses
1080
1299
 
1081
1300
  def initialize(**args)
1082
1301
  update!(**args)
@@ -1084,22 +1303,25 @@ module Google
1084
1303
 
1085
1304
  # Update properties of this object
1086
1305
  def update!(**args)
1087
- @mobile_ids = args[:mobile_ids] if args.key?(:mobile_ids)
1306
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1307
+ @user_list_direct_licenses = args[:user_list_direct_licenses] if args.key?(:user_list_direct_licenses)
1088
1308
  end
1089
1309
  end
1090
1310
 
1091
- # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience.
1092
- # At least one PAIR ID is required.
1093
- class PairData
1311
+ # Response from the ListUserListGlobalLicensesCustomerInfoRequest.
1312
+ class ListUserListGlobalLicenseCustomerInfosResponse
1094
1313
  include Google::Apis::Core::Hashable
1095
1314
 
1096
- # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with
1097
- # an EC commutative cipher using publisher key for the [PAIR]((//support.google.
1098
- # com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be
1099
- # provided in a single AudienceMember.
1100
- # Corresponds to the JSON property `pairIds`
1101
- # @return [Array<String>]
1102
- attr_accessor :pair_ids
1315
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1316
+ # field is omitted, there are no subsequent pages.
1317
+ # Corresponds to the JSON property `nextPageToken`
1318
+ # @return [String]
1319
+ attr_accessor :next_page_token
1320
+
1321
+ # The customer information for the given license in the request.
1322
+ # Corresponds to the JSON property `userListGlobalLicenseCustomerInfos`
1323
+ # @return [Array<Google::Apis::DatamanagerV1::UserListGlobalLicenseCustomerInfo>]
1324
+ attr_accessor :user_list_global_license_customer_infos
1103
1325
 
1104
1326
  def initialize(**args)
1105
1327
  update!(**args)
@@ -1107,30 +1329,25 @@ module Google
1107
1329
 
1108
1330
  # Update properties of this object
1109
1331
  def update!(**args)
1110
- @pair_ids = args[:pair_ids] if args.key?(:pair_ids)
1332
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1333
+ @user_list_global_license_customer_infos = args[:user_list_global_license_customer_infos] if args.key?(:user_list_global_license_customer_infos)
1111
1334
  end
1112
1335
  end
1113
1336
 
1114
- # Represents a specific account.
1115
- class ProductAccount
1337
+ # Response from the ListUserListGlobalLicensesRequest.
1338
+ class ListUserListGlobalLicensesResponse
1116
1339
  include Google::Apis::Core::Hashable
1117
1340
 
1118
- # Required. The ID of the account. For example, your Google Ads account ID.
1119
- # Corresponds to the JSON property `accountId`
1120
- # @return [String]
1121
- attr_accessor :account_id
1122
-
1123
- # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `
1124
- # account_type` or the deprecated `product` is required. If both are set, the
1125
- # values must match.
1126
- # Corresponds to the JSON property `accountType`
1341
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1342
+ # field is omitted, there are no subsequent pages.
1343
+ # Corresponds to the JSON property `nextPageToken`
1127
1344
  # @return [String]
1128
- attr_accessor :account_type
1345
+ attr_accessor :next_page_token
1129
1346
 
1130
- # Deprecated. Use `account_type` instead.
1131
- # Corresponds to the JSON property `product`
1132
- # @return [String]
1133
- attr_accessor :product
1347
+ # The licenses for the given user list in the request.
1348
+ # Corresponds to the JSON property `userListGlobalLicenses`
1349
+ # @return [Array<Google::Apis::DatamanagerV1::UserListGlobalLicense>]
1350
+ attr_accessor :user_list_global_licenses
1134
1351
 
1135
1352
  def initialize(**args)
1136
1353
  update!(**args)
@@ -1138,45 +1355,25 @@ module Google
1138
1355
 
1139
1356
  # Update properties of this object
1140
1357
  def update!(**args)
1141
- @account_id = args[:account_id] if args.key?(:account_id)
1142
- @account_type = args[:account_type] if args.key?(:account_type)
1143
- @product = args[:product] if args.key?(:product)
1358
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1359
+ @user_list_global_licenses = args[:user_list_global_licenses] if args.key?(:user_list_global_licenses)
1144
1360
  end
1145
1361
  end
1146
1362
 
1147
- # Request to remove users from an audience in the provided destinations. Returns
1148
- # a RemoveAudienceMembersResponse.
1149
- class RemoveAudienceMembersRequest
1363
+ # Response message for ListUserLists.
1364
+ class ListUserListsResponse
1150
1365
  include Google::Apis::Core::Hashable
1151
1366
 
1152
- # Required. The list of users to remove.
1153
- # Corresponds to the JSON property `audienceMembers`
1154
- # @return [Array<Google::Apis::DatamanagerV1::AudienceMember>]
1155
- attr_accessor :audience_members
1156
-
1157
- # Required. The list of destinations to remove the users from.
1158
- # Corresponds to the JSON property `destinations`
1159
- # @return [Array<Google::Apis::DatamanagerV1::Destination>]
1160
- attr_accessor :destinations
1161
-
1162
- # Optional. Required for UserData uploads. The encoding type of the user
1163
- # identifiers. Applies to only the outer encoding for encrypted user identifiers.
1164
- # For non `UserData` uploads, this field is ignored.
1165
- # Corresponds to the JSON property `encoding`
1367
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
1368
+ # field is omitted, there are no subsequent pages.
1369
+ # Corresponds to the JSON property `nextPageToken`
1166
1370
  # @return [String]
1167
- attr_accessor :encoding
1168
-
1169
- # Encryption information for the data being ingested.
1170
- # Corresponds to the JSON property `encryptionInfo`
1171
- # @return [Google::Apis::DatamanagerV1::EncryptionInfo]
1172
- attr_accessor :encryption_info
1371
+ attr_accessor :next_page_token
1173
1372
 
1174
- # Optional. For testing purposes. If `true`, the request is validated but not
1175
- # executed. Only errors are returned, not results.
1176
- # Corresponds to the JSON property `validateOnly`
1177
- # @return [Boolean]
1178
- attr_accessor :validate_only
1179
- alias_method :validate_only?, :validate_only
1373
+ # The user lists from the specified account.
1374
+ # Corresponds to the JSON property `userLists`
1375
+ # @return [Array<Google::Apis::DatamanagerV1::UserList>]
1376
+ attr_accessor :user_lists
1180
1377
 
1181
1378
  def initialize(**args)
1182
1379
  update!(**args)
@@ -1184,22 +1381,20 @@ module Google
1184
1381
 
1185
1382
  # Update properties of this object
1186
1383
  def update!(**args)
1187
- @audience_members = args[:audience_members] if args.key?(:audience_members)
1188
- @destinations = args[:destinations] if args.key?(:destinations)
1189
- @encoding = args[:encoding] if args.key?(:encoding)
1190
- @encryption_info = args[:encryption_info] if args.key?(:encryption_info)
1191
- @validate_only = args[:validate_only] if args.key?(:validate_only)
1384
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
1385
+ @user_lists = args[:user_lists] if args.key?(:user_lists)
1192
1386
  end
1193
1387
  end
1194
1388
 
1195
- # Response from the RemoveAudienceMembersRequest.
1196
- class RemoveAudienceMembersResponse
1389
+ # The baseline location of the request. Baseline location is on OR-list of ISO
1390
+ # 3166-1 alpha-2 region codes of the requested regions.
1391
+ class Location
1197
1392
  include Google::Apis::Core::Hashable
1198
1393
 
1199
- # The auto-generated ID of the request.
1200
- # Corresponds to the JSON property `requestId`
1201
- # @return [String]
1202
- attr_accessor :request_id
1394
+ # List of ISO 3166-1 alpha-2 region codes.
1395
+ # Corresponds to the JSON property `regionCodes`
1396
+ # @return [Array<String>]
1397
+ attr_accessor :region_codes
1203
1398
 
1204
1399
  def initialize(**args)
1205
1400
  update!(**args)
@@ -1207,28 +1402,23 @@ module Google
1207
1402
 
1208
1403
  # Update properties of this object
1209
1404
  def update!(**args)
1210
- @request_id = args[:request_id] if args.key?(:request_id)
1405
+ @region_codes = args[:region_codes] if args.key?(:region_codes)
1211
1406
  end
1212
1407
  end
1213
1408
 
1214
- # The status of the remove audience members request.
1215
- class RemoveAudienceMembersStatus
1409
+ # Insights for marketing data. This feature is only available to data partners.
1410
+ class MarketingDataInsight
1216
1411
  include Google::Apis::Core::Hashable
1217
1412
 
1218
- # The status of the mobile data removal from the destination.
1219
- # Corresponds to the JSON property `mobileDataRemovalStatus`
1220
- # @return [Google::Apis::DatamanagerV1::RemoveMobileDataStatus]
1221
- attr_accessor :mobile_data_removal_status
1222
-
1223
- # The status of the pair data removal from the destination.
1224
- # Corresponds to the JSON property `pairDataRemovalStatus`
1225
- # @return [Google::Apis::DatamanagerV1::RemovePairDataStatus]
1226
- attr_accessor :pair_data_removal_status
1413
+ # Insights for values of a given dimension.
1414
+ # Corresponds to the JSON property `attributes`
1415
+ # @return [Array<Google::Apis::DatamanagerV1::MarketingDataInsightsAttribute>]
1416
+ attr_accessor :attributes
1227
1417
 
1228
- # The status of the user data removal from the destination.
1229
- # Corresponds to the JSON property `userDataRemovalStatus`
1230
- # @return [Google::Apis::DatamanagerV1::RemoveUserDataStatus]
1231
- attr_accessor :user_data_removal_status
1418
+ # The dimension to which the insight belongs.
1419
+ # Corresponds to the JSON property `dimension`
1420
+ # @return [String]
1421
+ attr_accessor :dimension
1232
1422
 
1233
1423
  def initialize(**args)
1234
1424
  update!(**args)
@@ -1236,29 +1426,35 @@ module Google
1236
1426
 
1237
1427
  # Update properties of this object
1238
1428
  def update!(**args)
1239
- @mobile_data_removal_status = args[:mobile_data_removal_status] if args.key?(:mobile_data_removal_status)
1240
- @pair_data_removal_status = args[:pair_data_removal_status] if args.key?(:pair_data_removal_status)
1241
- @user_data_removal_status = args[:user_data_removal_status] if args.key?(:user_data_removal_status)
1429
+ @attributes = args[:attributes] if args.key?(:attributes)
1430
+ @dimension = args[:dimension] if args.key?(:dimension)
1242
1431
  end
1243
1432
  end
1244
1433
 
1245
- # The status of the mobile data removal from the destination.
1246
- class RemoveMobileDataStatus
1434
+ # Insights for a collection of related attributes of the same dimension.
1435
+ class MarketingDataInsightsAttribute
1247
1436
  include Google::Apis::Core::Hashable
1248
1437
 
1249
- # The total count of mobile Ids sent in the removal request. Includes all mobile
1250
- # ids in the request, regardless of whether they were successfully removed or
1251
- # not.
1252
- # Corresponds to the JSON property `mobileIdCount`
1253
- # @return [Fixnum]
1254
- attr_accessor :mobile_id_count
1438
+ # Age range of the audience for which the lift is provided.
1439
+ # Corresponds to the JSON property `ageRange`
1440
+ # @return [String]
1441
+ attr_accessor :age_range
1255
1442
 
1256
- # The total count of audience members sent in the removal request. Includes all
1257
- # audience members in the request, regardless of whether they were successfully
1258
- # removed or not.
1259
- # Corresponds to the JSON property `recordCount`
1443
+ # Gender of the audience for which the lift is provided.
1444
+ # Corresponds to the JSON property `gender`
1445
+ # @return [String]
1446
+ attr_accessor :gender
1447
+
1448
+ # Measure of lift that the audience has for the attribute value as compared to
1449
+ # the baseline. Range [0-1].
1450
+ # Corresponds to the JSON property `lift`
1451
+ # @return [Float]
1452
+ attr_accessor :lift
1453
+
1454
+ # The user interest ID.
1455
+ # Corresponds to the JSON property `userInterestId`
1260
1456
  # @return [Fixnum]
1261
- attr_accessor :record_count
1457
+ attr_accessor :user_interest_id
1262
1458
 
1263
1459
  def initialize(**args)
1264
1460
  update!(**args)
@@ -1266,27 +1462,22 @@ module Google
1266
1462
 
1267
1463
  # Update properties of this object
1268
1464
  def update!(**args)
1269
- @mobile_id_count = args[:mobile_id_count] if args.key?(:mobile_id_count)
1270
- @record_count = args[:record_count] if args.key?(:record_count)
1465
+ @age_range = args[:age_range] if args.key?(:age_range)
1466
+ @gender = args[:gender] if args.key?(:gender)
1467
+ @lift = args[:lift] if args.key?(:lift)
1468
+ @user_interest_id = args[:user_interest_id] if args.key?(:user_interest_id)
1271
1469
  end
1272
1470
  end
1273
1471
 
1274
- # The status of the pair data removal from the destination.
1275
- class RemovePairDataStatus
1472
+ # Mobile IDs for the audience. At least one mobile ID is required.
1473
+ class MobileData
1276
1474
  include Google::Apis::Core::Hashable
1277
1475
 
1278
- # The total count of pair ids sent in the removal request. Includes all pair ids
1279
- # in the request, regardless of whether they were successfully removed or not.
1280
- # Corresponds to the JSON property `pairIdCount`
1281
- # @return [Fixnum]
1282
- attr_accessor :pair_id_count
1283
-
1284
- # The total count of audience members sent in the removal request. Includes all
1285
- # audience members in the request, regardless of whether they were successfully
1286
- # removed or not.
1287
- # Corresponds to the JSON property `recordCount`
1288
- # @return [Fixnum]
1289
- attr_accessor :record_count
1476
+ # Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `
1477
+ # mobileIds` can be provided in a single AudienceMember.
1478
+ # Corresponds to the JSON property `mobileIds`
1479
+ # @return [Array<String>]
1480
+ attr_accessor :mobile_ids
1290
1481
 
1291
1482
  def initialize(**args)
1292
1483
  update!(**args)
@@ -1294,17 +1485,463 @@ module Google
1294
1485
 
1295
1486
  # Update properties of this object
1296
1487
  def update!(**args)
1297
- @pair_id_count = args[:pair_id_count] if args.key?(:pair_id_count)
1298
- @record_count = args[:record_count] if args.key?(:record_count)
1488
+ @mobile_ids = args[:mobile_ids] if args.key?(:mobile_ids)
1299
1489
  end
1300
1490
  end
1301
1491
 
1302
- # The status of the user data removal from the destination.
1303
- class RemoveUserDataStatus
1492
+ # Additional information when `MOBILE_ID` is one of the `upload_key_types`.
1493
+ class MobileIdInfo
1304
1494
  include Google::Apis::Core::Hashable
1305
1495
 
1306
- # The total count of audience members sent in the removal request. Includes all
1307
- # audience members in the request, regardless of whether they were successfully
1496
+ # Required. Immutable. A string that uniquely identifies a mobile application
1497
+ # from which the data was collected.
1498
+ # Corresponds to the JSON property `appId`
1499
+ # @return [String]
1500
+ attr_accessor :app_id
1501
+
1502
+ # Optional. Immutable. Source of the upload data.
1503
+ # Corresponds to the JSON property `dataSourceType`
1504
+ # @return [String]
1505
+ attr_accessor :data_source_type
1506
+
1507
+ # Required. Immutable. The key space of mobile IDs.
1508
+ # Corresponds to the JSON property `keySpace`
1509
+ # @return [String]
1510
+ attr_accessor :key_space
1511
+
1512
+ def initialize(**args)
1513
+ update!(**args)
1514
+ end
1515
+
1516
+ # Update properties of this object
1517
+ def update!(**args)
1518
+ @app_id = args[:app_id] if args.key?(:app_id)
1519
+ @data_source_type = args[:data_source_type] if args.key?(:data_source_type)
1520
+ @key_space = args[:key_space] if args.key?(:key_space)
1521
+ end
1522
+ end
1523
+
1524
+ # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience.
1525
+ # At least one PAIR ID is required. This feature is only available to data
1526
+ # partners.
1527
+ class PairData
1528
+ include Google::Apis::Core::Hashable
1529
+
1530
+ # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with
1531
+ # an EC commutative cipher using publisher key for the [PAIR]((//support.google.
1532
+ # com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be
1533
+ # provided in a single AudienceMember.
1534
+ # Corresponds to the JSON property `pairIds`
1535
+ # @return [Array<String>]
1536
+ attr_accessor :pair_ids
1537
+
1538
+ def initialize(**args)
1539
+ update!(**args)
1540
+ end
1541
+
1542
+ # Update properties of this object
1543
+ def update!(**args)
1544
+ @pair_ids = args[:pair_ids] if args.key?(:pair_ids)
1545
+ end
1546
+ end
1547
+
1548
+ # Additional information when `PAIR_ID` is one of the `upload_key_types`. This
1549
+ # feature is only available to data partners.
1550
+ class PairIdInfo
1551
+ include Google::Apis::Core::Hashable
1552
+
1553
+ # Output only. The count of the advertiser's first party data records that have
1554
+ # been uploaded to a clean room provider. This does not signify the size of a
1555
+ # PAIR user list.
1556
+ # Corresponds to the JSON property `advertiserIdentifierCount`
1557
+ # @return [Fixnum]
1558
+ attr_accessor :advertiser_identifier_count
1559
+
1560
+ # Required. Immutable. Identifies a unique advertiser to publisher relationship
1561
+ # with one clean room provider or across multiple clean room providers.
1562
+ # Corresponds to the JSON property `cleanRoomIdentifier`
1563
+ # @return [String]
1564
+ attr_accessor :clean_room_identifier
1565
+
1566
+ # Output only. This field denotes the percentage of membership match of this
1567
+ # user list with the corresponding publisher's first party data. Must be between
1568
+ # 0 and 100 inclusive.
1569
+ # Corresponds to the JSON property `matchRatePercentage`
1570
+ # @return [Fixnum]
1571
+ attr_accessor :match_rate_percentage
1572
+
1573
+ # Required. Immutable. Identifies the publisher that the Publisher Advertiser
1574
+ # Identity Reconciliation user list is reconciled with. This field is provided
1575
+ # by the cleanroom provider and is only unique in the scope of that cleanroom.
1576
+ # This cannot be used as a global identifier across multiple cleanrooms.
1577
+ # Corresponds to the JSON property `publisherId`
1578
+ # @return [Fixnum]
1579
+ attr_accessor :publisher_id
1580
+
1581
+ # Optional. Descriptive name of the publisher to be displayed in the UI for a
1582
+ # better targeting experience.
1583
+ # Corresponds to the JSON property `publisherName`
1584
+ # @return [String]
1585
+ attr_accessor :publisher_name
1586
+
1587
+ def initialize(**args)
1588
+ update!(**args)
1589
+ end
1590
+
1591
+ # Update properties of this object
1592
+ def update!(**args)
1593
+ @advertiser_identifier_count = args[:advertiser_identifier_count] if args.key?(:advertiser_identifier_count)
1594
+ @clean_room_identifier = args[:clean_room_identifier] if args.key?(:clean_room_identifier)
1595
+ @match_rate_percentage = args[:match_rate_percentage] if args.key?(:match_rate_percentage)
1596
+ @publisher_id = args[:publisher_id] if args.key?(:publisher_id)
1597
+ @publisher_name = args[:publisher_name] if args.key?(:publisher_name)
1598
+ end
1599
+ end
1600
+
1601
+ # Additional information for partner audiences. This feature is only available
1602
+ # to data partners.
1603
+ class PartnerAudienceInfo
1604
+ include Google::Apis::Core::Hashable
1605
+
1606
+ # Optional. The commerce partner name. Only allowed if `partner_audience_source`
1607
+ # is `COMMERCE_AUDIENCE`.
1608
+ # Corresponds to the JSON property `commercePartner`
1609
+ # @return [String]
1610
+ attr_accessor :commerce_partner
1611
+
1612
+ # Required. Immutable. The source of the partner audience.
1613
+ # Corresponds to the JSON property `partnerAudienceSource`
1614
+ # @return [String]
1615
+ attr_accessor :partner_audience_source
1616
+
1617
+ def initialize(**args)
1618
+ update!(**args)
1619
+ end
1620
+
1621
+ # Update properties of this object
1622
+ def update!(**args)
1623
+ @commerce_partner = args[:commerce_partner] if args.key?(:commerce_partner)
1624
+ @partner_audience_source = args[:partner_audience_source] if args.key?(:partner_audience_source)
1625
+ end
1626
+ end
1627
+
1628
+ # A partner link between an owning account and a partner account.
1629
+ class PartnerLink
1630
+ include Google::Apis::Core::Hashable
1631
+
1632
+ # Identifier. The name of the partner link. Format: accountTypes/`account_type`/
1633
+ # accounts/`account`/partnerLinks/`partner_link`
1634
+ # Corresponds to the JSON property `name`
1635
+ # @return [String]
1636
+ attr_accessor :name
1637
+
1638
+ # Represents a specific account.
1639
+ # Corresponds to the JSON property `owningAccount`
1640
+ # @return [Google::Apis::DatamanagerV1::ProductAccount]
1641
+ attr_accessor :owning_account
1642
+
1643
+ # Represents a specific account.
1644
+ # Corresponds to the JSON property `partnerAccount`
1645
+ # @return [Google::Apis::DatamanagerV1::ProductAccount]
1646
+ attr_accessor :partner_account
1647
+
1648
+ # Output only. The partner link ID.
1649
+ # Corresponds to the JSON property `partnerLinkId`
1650
+ # @return [String]
1651
+ attr_accessor :partner_link_id
1652
+
1653
+ def initialize(**args)
1654
+ update!(**args)
1655
+ end
1656
+
1657
+ # Update properties of this object
1658
+ def update!(**args)
1659
+ @name = args[:name] if args.key?(:name)
1660
+ @owning_account = args[:owning_account] if args.key?(:owning_account)
1661
+ @partner_account = args[:partner_account] if args.key?(:partner_account)
1662
+ @partner_link_id = args[:partner_link_id] if args.key?(:partner_link_id)
1663
+ end
1664
+ end
1665
+
1666
+ # Publisher provided identifiers data holding the ppids. At least one ppid is
1667
+ # required. This feature is only available to data partners.
1668
+ class PpidData
1669
+ include Google::Apis::Core::Hashable
1670
+
1671
+ # Required. The list of publisher provided identifiers for a user.
1672
+ # Corresponds to the JSON property `ppids`
1673
+ # @return [Array<String>]
1674
+ attr_accessor :ppids
1675
+
1676
+ def initialize(**args)
1677
+ update!(**args)
1678
+ end
1679
+
1680
+ # Update properties of this object
1681
+ def update!(**args)
1682
+ @ppids = args[:ppids] if args.key?(:ppids)
1683
+ end
1684
+ end
1685
+
1686
+ # Represents a specific account.
1687
+ class ProductAccount
1688
+ include Google::Apis::Core::Hashable
1689
+
1690
+ # Required. The ID of the account. For example, your Google Ads account ID.
1691
+ # Corresponds to the JSON property `accountId`
1692
+ # @return [String]
1693
+ attr_accessor :account_id
1694
+
1695
+ # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `
1696
+ # account_type` or the deprecated `product` is required. If both are set, the
1697
+ # values must match.
1698
+ # Corresponds to the JSON property `accountType`
1699
+ # @return [String]
1700
+ attr_accessor :account_type
1701
+
1702
+ # Deprecated. Use `account_type` instead.
1703
+ # Corresponds to the JSON property `product`
1704
+ # @return [String]
1705
+ attr_accessor :product
1706
+
1707
+ def initialize(**args)
1708
+ update!(**args)
1709
+ end
1710
+
1711
+ # Update properties of this object
1712
+ def update!(**args)
1713
+ @account_id = args[:account_id] if args.key?(:account_id)
1714
+ @account_type = args[:account_type] if args.key?(:account_type)
1715
+ @product = args[:product] if args.key?(:product)
1716
+ end
1717
+ end
1718
+
1719
+ # Additional information when `PSEUDONYMOUS_ID` is one of the `upload_key_types`.
1720
+ class PseudonymousIdInfo
1721
+ include Google::Apis::Core::Hashable
1722
+
1723
+ # Optional. Immutable. The number of billable records (e.g. uploaded or matched).
1724
+ # Corresponds to the JSON property `billableRecordCount`
1725
+ # @return [Fixnum]
1726
+ attr_accessor :billable_record_count
1727
+
1728
+ # Output only. Sync status of the user list.
1729
+ # Corresponds to the JSON property `syncStatus`
1730
+ # @return [String]
1731
+ attr_accessor :sync_status
1732
+
1733
+ def initialize(**args)
1734
+ update!(**args)
1735
+ end
1736
+
1737
+ # Update properties of this object
1738
+ def update!(**args)
1739
+ @billable_record_count = args[:billable_record_count] if args.key?(:billable_record_count)
1740
+ @sync_status = args[:sync_status] if args.key?(:sync_status)
1741
+ end
1742
+ end
1743
+
1744
+ # Request to remove users from an audience in the provided destinations. Returns
1745
+ # a RemoveAudienceMembersResponse.
1746
+ class RemoveAudienceMembersRequest
1747
+ include Google::Apis::Core::Hashable
1748
+
1749
+ # Required. The list of users to remove.
1750
+ # Corresponds to the JSON property `audienceMembers`
1751
+ # @return [Array<Google::Apis::DatamanagerV1::AudienceMember>]
1752
+ attr_accessor :audience_members
1753
+
1754
+ # Required. The list of destinations to remove the users from.
1755
+ # Corresponds to the JSON property `destinations`
1756
+ # @return [Array<Google::Apis::DatamanagerV1::Destination>]
1757
+ attr_accessor :destinations
1758
+
1759
+ # Optional. Required for UserData uploads. The encoding type of the user
1760
+ # identifiers. Applies to only the outer encoding for encrypted user identifiers.
1761
+ # For non `UserData` uploads, this field is ignored.
1762
+ # Corresponds to the JSON property `encoding`
1763
+ # @return [String]
1764
+ attr_accessor :encoding
1765
+
1766
+ # Encryption information for the data being ingested.
1767
+ # Corresponds to the JSON property `encryptionInfo`
1768
+ # @return [Google::Apis::DatamanagerV1::EncryptionInfo]
1769
+ attr_accessor :encryption_info
1770
+
1771
+ # Optional. For testing purposes. If `true`, the request is validated but not
1772
+ # executed. Only errors are returned, not results.
1773
+ # Corresponds to the JSON property `validateOnly`
1774
+ # @return [Boolean]
1775
+ attr_accessor :validate_only
1776
+ alias_method :validate_only?, :validate_only
1777
+
1778
+ def initialize(**args)
1779
+ update!(**args)
1780
+ end
1781
+
1782
+ # Update properties of this object
1783
+ def update!(**args)
1784
+ @audience_members = args[:audience_members] if args.key?(:audience_members)
1785
+ @destinations = args[:destinations] if args.key?(:destinations)
1786
+ @encoding = args[:encoding] if args.key?(:encoding)
1787
+ @encryption_info = args[:encryption_info] if args.key?(:encryption_info)
1788
+ @validate_only = args[:validate_only] if args.key?(:validate_only)
1789
+ end
1790
+ end
1791
+
1792
+ # Response from the RemoveAudienceMembersRequest.
1793
+ class RemoveAudienceMembersResponse
1794
+ include Google::Apis::Core::Hashable
1795
+
1796
+ # The auto-generated ID of the request.
1797
+ # Corresponds to the JSON property `requestId`
1798
+ # @return [String]
1799
+ attr_accessor :request_id
1800
+
1801
+ def initialize(**args)
1802
+ update!(**args)
1803
+ end
1804
+
1805
+ # Update properties of this object
1806
+ def update!(**args)
1807
+ @request_id = args[:request_id] if args.key?(:request_id)
1808
+ end
1809
+ end
1810
+
1811
+ # The status of the remove audience members request.
1812
+ class RemoveAudienceMembersStatus
1813
+ include Google::Apis::Core::Hashable
1814
+
1815
+ # The status of the mobile data removal from the destination.
1816
+ # Corresponds to the JSON property `mobileDataRemovalStatus`
1817
+ # @return [Google::Apis::DatamanagerV1::RemoveMobileDataStatus]
1818
+ attr_accessor :mobile_data_removal_status
1819
+
1820
+ # The status of the pair data removal from the destination.
1821
+ # Corresponds to the JSON property `pairDataRemovalStatus`
1822
+ # @return [Google::Apis::DatamanagerV1::RemovePairDataStatus]
1823
+ attr_accessor :pair_data_removal_status
1824
+
1825
+ # The status of the ppid data removal from the destination.
1826
+ # Corresponds to the JSON property `ppidDataRemovalStatus`
1827
+ # @return [Google::Apis::DatamanagerV1::RemovePpidDataStatus]
1828
+ attr_accessor :ppid_data_removal_status
1829
+
1830
+ # The status of the user data removal from the destination.
1831
+ # Corresponds to the JSON property `userDataRemovalStatus`
1832
+ # @return [Google::Apis::DatamanagerV1::RemoveUserDataStatus]
1833
+ attr_accessor :user_data_removal_status
1834
+
1835
+ # The status of the user id data removal from the destination.
1836
+ # Corresponds to the JSON property `userIdDataRemovalStatus`
1837
+ # @return [Google::Apis::DatamanagerV1::RemoveUserIdDataStatus]
1838
+ attr_accessor :user_id_data_removal_status
1839
+
1840
+ def initialize(**args)
1841
+ update!(**args)
1842
+ end
1843
+
1844
+ # Update properties of this object
1845
+ def update!(**args)
1846
+ @mobile_data_removal_status = args[:mobile_data_removal_status] if args.key?(:mobile_data_removal_status)
1847
+ @pair_data_removal_status = args[:pair_data_removal_status] if args.key?(:pair_data_removal_status)
1848
+ @ppid_data_removal_status = args[:ppid_data_removal_status] if args.key?(:ppid_data_removal_status)
1849
+ @user_data_removal_status = args[:user_data_removal_status] if args.key?(:user_data_removal_status)
1850
+ @user_id_data_removal_status = args[:user_id_data_removal_status] if args.key?(:user_id_data_removal_status)
1851
+ end
1852
+ end
1853
+
1854
+ # The status of the mobile data removal from the destination.
1855
+ class RemoveMobileDataStatus
1856
+ include Google::Apis::Core::Hashable
1857
+
1858
+ # The total count of mobile Ids sent in the removal request. Includes all mobile
1859
+ # ids in the request, regardless of whether they were successfully removed or
1860
+ # not.
1861
+ # Corresponds to the JSON property `mobileIdCount`
1862
+ # @return [Fixnum]
1863
+ attr_accessor :mobile_id_count
1864
+
1865
+ # The total count of audience members sent in the removal request. Includes all
1866
+ # audience members in the request, regardless of whether they were successfully
1867
+ # removed or not.
1868
+ # Corresponds to the JSON property `recordCount`
1869
+ # @return [Fixnum]
1870
+ attr_accessor :record_count
1871
+
1872
+ def initialize(**args)
1873
+ update!(**args)
1874
+ end
1875
+
1876
+ # Update properties of this object
1877
+ def update!(**args)
1878
+ @mobile_id_count = args[:mobile_id_count] if args.key?(:mobile_id_count)
1879
+ @record_count = args[:record_count] if args.key?(:record_count)
1880
+ end
1881
+ end
1882
+
1883
+ # The status of the pair data removal from the destination.
1884
+ class RemovePairDataStatus
1885
+ include Google::Apis::Core::Hashable
1886
+
1887
+ # The total count of pair ids sent in the removal request. Includes all pair ids
1888
+ # in the request, regardless of whether they were successfully removed or not.
1889
+ # Corresponds to the JSON property `pairIdCount`
1890
+ # @return [Fixnum]
1891
+ attr_accessor :pair_id_count
1892
+
1893
+ # The total count of audience members sent in the removal request. Includes all
1894
+ # audience members in the request, regardless of whether they were successfully
1895
+ # removed or not.
1896
+ # Corresponds to the JSON property `recordCount`
1897
+ # @return [Fixnum]
1898
+ attr_accessor :record_count
1899
+
1900
+ def initialize(**args)
1901
+ update!(**args)
1902
+ end
1903
+
1904
+ # Update properties of this object
1905
+ def update!(**args)
1906
+ @pair_id_count = args[:pair_id_count] if args.key?(:pair_id_count)
1907
+ @record_count = args[:record_count] if args.key?(:record_count)
1908
+ end
1909
+ end
1910
+
1911
+ # The status of the ppid data removal from the destination.
1912
+ class RemovePpidDataStatus
1913
+ include Google::Apis::Core::Hashable
1914
+
1915
+ # The total count of ppids sent in the removal request. Includes all ppids in
1916
+ # the request, regardless of whether they were successfully removed or not.
1917
+ # Corresponds to the JSON property `ppidCount`
1918
+ # @return [Fixnum]
1919
+ attr_accessor :ppid_count
1920
+
1921
+ # The total count of audience members sent in the removal request. Includes all
1922
+ # audience members in the request, regardless of whether they were successfully
1923
+ # removed or not.
1924
+ # Corresponds to the JSON property `recordCount`
1925
+ # @return [Fixnum]
1926
+ attr_accessor :record_count
1927
+
1928
+ def initialize(**args)
1929
+ update!(**args)
1930
+ end
1931
+
1932
+ # Update properties of this object
1933
+ def update!(**args)
1934
+ @ppid_count = args[:ppid_count] if args.key?(:ppid_count)
1935
+ @record_count = args[:record_count] if args.key?(:record_count)
1936
+ end
1937
+ end
1938
+
1939
+ # The status of the user data removal from the destination.
1940
+ class RemoveUserDataStatus
1941
+ include Google::Apis::Core::Hashable
1942
+
1943
+ # The total count of audience members sent in the removal request. Includes all
1944
+ # audience members in the request, regardless of whether they were successfully
1308
1945
  # removed or not.
1309
1946
  # Corresponds to the JSON property `recordCount`
1310
1947
  # @return [Fixnum]
@@ -1323,49 +1960,237 @@ module Google
1323
1960
 
1324
1961
  # Update properties of this object
1325
1962
  def update!(**args)
1326
- @record_count = args[:record_count] if args.key?(:record_count)
1327
- @user_identifier_count = args[:user_identifier_count] if args.key?(:user_identifier_count)
1963
+ @record_count = args[:record_count] if args.key?(:record_count)
1964
+ @user_identifier_count = args[:user_identifier_count] if args.key?(:user_identifier_count)
1965
+ end
1966
+ end
1967
+
1968
+ # The status of the user id data removal from the destination.
1969
+ class RemoveUserIdDataStatus
1970
+ include Google::Apis::Core::Hashable
1971
+
1972
+ # The total count of audience members sent in the removal request. Includes all
1973
+ # audience members in the request, regardless of whether they were successfully
1974
+ # removed or not.
1975
+ # Corresponds to the JSON property `recordCount`
1976
+ # @return [Fixnum]
1977
+ attr_accessor :record_count
1978
+
1979
+ # The total count of user ids sent in the removal request. Includes all user ids
1980
+ # in the request, regardless of whether they were successfully removed or not.
1981
+ # Corresponds to the JSON property `userIdCount`
1982
+ # @return [Fixnum]
1983
+ attr_accessor :user_id_count
1984
+
1985
+ def initialize(**args)
1986
+ update!(**args)
1987
+ end
1988
+
1989
+ # Update properties of this object
1990
+ def update!(**args)
1991
+ @record_count = args[:record_count] if args.key?(:record_count)
1992
+ @user_id_count = args[:user_id_count] if args.key?(:user_id_count)
1993
+ end
1994
+ end
1995
+
1996
+ # A request status per destination.
1997
+ class RequestStatusPerDestination
1998
+ include Google::Apis::Core::Hashable
1999
+
2000
+ # The status of the ingest audience members request.
2001
+ # Corresponds to the JSON property `audienceMembersIngestionStatus`
2002
+ # @return [Google::Apis::DatamanagerV1::IngestAudienceMembersStatus]
2003
+ attr_accessor :audience_members_ingestion_status
2004
+
2005
+ # The status of the remove audience members request.
2006
+ # Corresponds to the JSON property `audienceMembersRemovalStatus`
2007
+ # @return [Google::Apis::DatamanagerV1::RemoveAudienceMembersStatus]
2008
+ attr_accessor :audience_members_removal_status
2009
+
2010
+ # The Google product you're sending data to. For example, a Google Ads account.
2011
+ # Corresponds to the JSON property `destination`
2012
+ # @return [Google::Apis::DatamanagerV1::Destination]
2013
+ attr_accessor :destination
2014
+
2015
+ # Error counts for each type of error.
2016
+ # Corresponds to the JSON property `errorInfo`
2017
+ # @return [Google::Apis::DatamanagerV1::ErrorInfo]
2018
+ attr_accessor :error_info
2019
+
2020
+ # The status of the events ingestion to the destination.
2021
+ # Corresponds to the JSON property `eventsIngestionStatus`
2022
+ # @return [Google::Apis::DatamanagerV1::IngestEventsStatus]
2023
+ attr_accessor :events_ingestion_status
2024
+
2025
+ # The request status of the destination.
2026
+ # Corresponds to the JSON property `requestStatus`
2027
+ # @return [String]
2028
+ attr_accessor :request_status
2029
+
2030
+ # Warning counts for each type of warning.
2031
+ # Corresponds to the JSON property `warningInfo`
2032
+ # @return [Google::Apis::DatamanagerV1::WarningInfo]
2033
+ attr_accessor :warning_info
2034
+
2035
+ def initialize(**args)
2036
+ update!(**args)
2037
+ end
2038
+
2039
+ # Update properties of this object
2040
+ def update!(**args)
2041
+ @audience_members_ingestion_status = args[:audience_members_ingestion_status] if args.key?(:audience_members_ingestion_status)
2042
+ @audience_members_removal_status = args[:audience_members_removal_status] if args.key?(:audience_members_removal_status)
2043
+ @destination = args[:destination] if args.key?(:destination)
2044
+ @error_info = args[:error_info] if args.key?(:error_info)
2045
+ @events_ingestion_status = args[:events_ingestion_status] if args.key?(:events_ingestion_status)
2046
+ @request_status = args[:request_status] if args.key?(:request_status)
2047
+ @warning_info = args[:warning_info] if args.key?(:warning_info)
2048
+ end
2049
+ end
2050
+
2051
+ # Request message for DM API MarketingDataInsightsService.RetrieveInsights
2052
+ class RetrieveInsightsRequest
2053
+ include Google::Apis::Core::Hashable
2054
+
2055
+ # Baseline criteria against which insights are compared.
2056
+ # Corresponds to the JSON property `baseline`
2057
+ # @return [Google::Apis::DatamanagerV1::Baseline]
2058
+ attr_accessor :baseline
2059
+
2060
+ # Required. The user list ID for which insights are requested.
2061
+ # Corresponds to the JSON property `userListId`
2062
+ # @return [String]
2063
+ attr_accessor :user_list_id
2064
+
2065
+ def initialize(**args)
2066
+ update!(**args)
2067
+ end
2068
+
2069
+ # Update properties of this object
2070
+ def update!(**args)
2071
+ @baseline = args[:baseline] if args.key?(:baseline)
2072
+ @user_list_id = args[:user_list_id] if args.key?(:user_list_id)
2073
+ end
2074
+ end
2075
+
2076
+ # Response message for DM API MarketingDataInsightsService.RetrieveInsights
2077
+ class RetrieveInsightsResponse
2078
+ include Google::Apis::Core::Hashable
2079
+
2080
+ # Contains the insights for the marketing data.
2081
+ # Corresponds to the JSON property `marketingDataInsights`
2082
+ # @return [Array<Google::Apis::DatamanagerV1::MarketingDataInsight>]
2083
+ attr_accessor :marketing_data_insights
2084
+
2085
+ def initialize(**args)
2086
+ update!(**args)
2087
+ end
2088
+
2089
+ # Update properties of this object
2090
+ def update!(**args)
2091
+ @marketing_data_insights = args[:marketing_data_insights] if args.key?(:marketing_data_insights)
2092
+ end
2093
+ end
2094
+
2095
+ # Response from the RetrieveRequestStatusRequest.
2096
+ class RetrieveRequestStatusResponse
2097
+ include Google::Apis::Core::Hashable
2098
+
2099
+ # A list of request statuses per destination. The order of the statuses matches
2100
+ # the order of the destinations in the original request.
2101
+ # Corresponds to the JSON property `requestStatusPerDestination`
2102
+ # @return [Array<Google::Apis::DatamanagerV1::RequestStatusPerDestination>]
2103
+ attr_accessor :request_status_per_destination
2104
+
2105
+ def initialize(**args)
2106
+ update!(**args)
2107
+ end
2108
+
2109
+ # Update properties of this object
2110
+ def update!(**args)
2111
+ @request_status_per_destination = args[:request_status_per_destination] if args.key?(:request_status_per_destination)
2112
+ end
2113
+ end
2114
+
2115
+ # Response from the SearchPartnerLinksRequest.
2116
+ class SearchPartnerLinksResponse
2117
+ include Google::Apis::Core::Hashable
2118
+
2119
+ # A token, which can be sent as `page_token` to retrieve the next page. If this
2120
+ # field is omitted, there are no subsequent pages.
2121
+ # Corresponds to the JSON property `nextPageToken`
2122
+ # @return [String]
2123
+ attr_accessor :next_page_token
2124
+
2125
+ # The partner links for the given account.
2126
+ # Corresponds to the JSON property `partnerLinks`
2127
+ # @return [Array<Google::Apis::DatamanagerV1::PartnerLink>]
2128
+ attr_accessor :partner_links
2129
+
2130
+ def initialize(**args)
2131
+ update!(**args)
2132
+ end
2133
+
2134
+ # Update properties of this object
2135
+ def update!(**args)
2136
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
2137
+ @partner_links = args[:partner_links] if args.key?(:partner_links)
1328
2138
  end
1329
2139
  end
1330
2140
 
1331
- # A request status per destination.
1332
- class RequestStatusPerDestination
2141
+ # Estimated number of members in this user list in different target networks.
2142
+ class SizeInfo
1333
2143
  include Google::Apis::Core::Hashable
1334
2144
 
1335
- # The status of the ingest audience members request.
1336
- # Corresponds to the JSON property `audienceMembersIngestionStatus`
1337
- # @return [Google::Apis::DatamanagerV1::IngestAudienceMembersStatus]
1338
- attr_accessor :audience_members_ingestion_status
2145
+ # Output only. Estimated number of members in this user list, on the Google
2146
+ # Display Network.
2147
+ # Corresponds to the JSON property `displayNetworkMembersCount`
2148
+ # @return [Fixnum]
2149
+ attr_accessor :display_network_members_count
1339
2150
 
1340
- # The status of the remove audience members request.
1341
- # Corresponds to the JSON property `audienceMembersRemovalStatus`
1342
- # @return [Google::Apis::DatamanagerV1::RemoveAudienceMembersStatus]
1343
- attr_accessor :audience_members_removal_status
2151
+ # Output only. Estimated number of members in this user list in the google.com
2152
+ # domain. These are the members available for targeting in Search campaigns.
2153
+ # Corresponds to the JSON property `searchNetworkMembersCount`
2154
+ # @return [Fixnum]
2155
+ attr_accessor :search_network_members_count
1344
2156
 
1345
- # The Google product you're sending data to. For example, a Google Ads account.
1346
- # Corresponds to the JSON property `destination`
1347
- # @return [Google::Apis::DatamanagerV1::Destination]
1348
- attr_accessor :destination
2157
+ def initialize(**args)
2158
+ update!(**args)
2159
+ end
1349
2160
 
1350
- # Error counts for each type of error.
1351
- # Corresponds to the JSON property `errorInfo`
1352
- # @return [Google::Apis::DatamanagerV1::ErrorInfo]
1353
- attr_accessor :error_info
2161
+ # Update properties of this object
2162
+ def update!(**args)
2163
+ @display_network_members_count = args[:display_network_members_count] if args.key?(:display_network_members_count)
2164
+ @search_network_members_count = args[:search_network_members_count] if args.key?(:search_network_members_count)
2165
+ end
2166
+ end
1354
2167
 
1355
- # The status of the events ingestion to the destination.
1356
- # Corresponds to the JSON property `eventsIngestionStatus`
1357
- # @return [Google::Apis::DatamanagerV1::IngestEventsStatus]
1358
- attr_accessor :events_ingestion_status
2168
+ # The `Status` type defines a logical error model that is suitable for different
2169
+ # programming environments, including REST APIs and RPC APIs. It is used by [
2170
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
2171
+ # data: error code, error message, and error details. You can find out more
2172
+ # about this error model and how to work with it in the [API Design Guide](https:
2173
+ # //cloud.google.com/apis/design/errors).
2174
+ class Status
2175
+ include Google::Apis::Core::Hashable
1359
2176
 
1360
- # The request status of the destination.
1361
- # Corresponds to the JSON property `requestStatus`
2177
+ # The status code, which should be an enum value of google.rpc.Code.
2178
+ # Corresponds to the JSON property `code`
2179
+ # @return [Fixnum]
2180
+ attr_accessor :code
2181
+
2182
+ # A list of messages that carry the error details. There is a common set of
2183
+ # message types for APIs to use.
2184
+ # Corresponds to the JSON property `details`
2185
+ # @return [Array<Hash<String,Object>>]
2186
+ attr_accessor :details
2187
+
2188
+ # A developer-facing error message, which should be in English. Any user-facing
2189
+ # error message should be localized and sent in the google.rpc.Status.details
2190
+ # field, or localized by the client.
2191
+ # Corresponds to the JSON property `message`
1362
2192
  # @return [String]
1363
- attr_accessor :request_status
1364
-
1365
- # Warning counts for each type of warning.
1366
- # Corresponds to the JSON property `warningInfo`
1367
- # @return [Google::Apis::DatamanagerV1::WarningInfo]
1368
- attr_accessor :warning_info
2193
+ attr_accessor :message
1369
2194
 
1370
2195
  def initialize(**args)
1371
2196
  update!(**args)
@@ -1373,25 +2198,27 @@ module Google
1373
2198
 
1374
2199
  # Update properties of this object
1375
2200
  def update!(**args)
1376
- @audience_members_ingestion_status = args[:audience_members_ingestion_status] if args.key?(:audience_members_ingestion_status)
1377
- @audience_members_removal_status = args[:audience_members_removal_status] if args.key?(:audience_members_removal_status)
1378
- @destination = args[:destination] if args.key?(:destination)
1379
- @error_info = args[:error_info] if args.key?(:error_info)
1380
- @events_ingestion_status = args[:events_ingestion_status] if args.key?(:events_ingestion_status)
1381
- @request_status = args[:request_status] if args.key?(:request_status)
1382
- @warning_info = args[:warning_info] if args.key?(:warning_info)
2201
+ @code = args[:code] if args.key?(:code)
2202
+ @details = args[:details] if args.key?(:details)
2203
+ @message = args[:message] if args.key?(:message)
1383
2204
  end
1384
2205
  end
1385
2206
 
1386
- # Response from the RetrieveRequestStatusRequest.
1387
- class RetrieveRequestStatusResponse
2207
+ # Eligibility information for different target networks.
2208
+ class TargetNetworkInfo
1388
2209
  include Google::Apis::Core::Hashable
1389
2210
 
1390
- # A list of request statuses per destination. The order of the statuses matches
1391
- # the order of the destinations in the original request.
1392
- # Corresponds to the JSON property `requestStatusPerDestination`
1393
- # @return [Array<Google::Apis::DatamanagerV1::RequestStatusPerDestination>]
1394
- attr_accessor :request_status_per_destination
2211
+ # Output only. Indicates this user list is eligible for Google Display Network.
2212
+ # Corresponds to the JSON property `eligibleForDisplay`
2213
+ # @return [Boolean]
2214
+ attr_accessor :eligible_for_display
2215
+ alias_method :eligible_for_display?, :eligible_for_display
2216
+
2217
+ # Optional. Indicates if this user list is eligible for Google Search Network.
2218
+ # Corresponds to the JSON property `eligibleForSearch`
2219
+ # @return [Boolean]
2220
+ attr_accessor :eligible_for_search
2221
+ alias_method :eligible_for_search?, :eligible_for_search
1395
2222
 
1396
2223
  def initialize(**args)
1397
2224
  update!(**args)
@@ -1399,7 +2226,8 @@ module Google
1399
2226
 
1400
2227
  # Update properties of this object
1401
2228
  def update!(**args)
1402
- @request_status_per_destination = args[:request_status_per_destination] if args.key?(:request_status_per_destination)
2229
+ @eligible_for_display = args[:eligible_for_display] if args.key?(:eligible_for_display)
2230
+ @eligible_for_search = args[:eligible_for_search] if args.key?(:eligible_for_search)
1403
2231
  end
1404
2232
  end
1405
2233
 
@@ -1447,6 +2275,44 @@ module Google
1447
2275
  end
1448
2276
  end
1449
2277
 
2278
+ # User id data holding the user id.
2279
+ class UserIdData
2280
+ include Google::Apis::Core::Hashable
2281
+
2282
+ # Required. A unique identifier for a user, as defined by the advertiser.
2283
+ # Corresponds to the JSON property `userId`
2284
+ # @return [String]
2285
+ attr_accessor :user_id
2286
+
2287
+ def initialize(**args)
2288
+ update!(**args)
2289
+ end
2290
+
2291
+ # Update properties of this object
2292
+ def update!(**args)
2293
+ @user_id = args[:user_id] if args.key?(:user_id)
2294
+ end
2295
+ end
2296
+
2297
+ # Additional information when `USER_ID` is one of the `upload_key_types`.
2298
+ class UserIdInfo
2299
+ include Google::Apis::Core::Hashable
2300
+
2301
+ # Optional. Immutable. Source of the upload data.
2302
+ # Corresponds to the JSON property `dataSourceType`
2303
+ # @return [String]
2304
+ attr_accessor :data_source_type
2305
+
2306
+ def initialize(**args)
2307
+ update!(**args)
2308
+ end
2309
+
2310
+ # Update properties of this object
2311
+ def update!(**args)
2312
+ @data_source_type = args[:data_source_type] if args.key?(:data_source_type)
2313
+ end
2314
+ end
2315
+
1450
2316
  # A single identifier for the user.
1451
2317
  class UserIdentifier
1452
2318
  include Google::Apis::Core::Hashable
@@ -1479,6 +2345,461 @@ module Google
1479
2345
  end
1480
2346
  end
1481
2347
 
2348
+ # A user list resource.
2349
+ class UserList
2350
+ include Google::Apis::Core::Hashable
2351
+
2352
+ # Output only. The reason this account has been granted access to the list.
2353
+ # Corresponds to the JSON property `accessReason`
2354
+ # @return [String]
2355
+ attr_accessor :access_reason
2356
+
2357
+ # Optional. Indicates if this share is still enabled. When a user list is shared
2358
+ # with the account this field is set to `ENABLED`. Later the user list owner can
2359
+ # decide to revoke the share and make it `DISABLED`.
2360
+ # Corresponds to the JSON property `accountAccessStatus`
2361
+ # @return [String]
2362
+ attr_accessor :account_access_status
2363
+
2364
+ # Output only. The reason why this user list membership status is closed.
2365
+ # Corresponds to the JSON property `closingReason`
2366
+ # @return [String]
2367
+ attr_accessor :closing_reason
2368
+
2369
+ # Optional. A description of the user list.
2370
+ # Corresponds to the JSON property `description`
2371
+ # @return [String]
2372
+ attr_accessor :description
2373
+
2374
+ # Required. The display name of the user list.
2375
+ # Corresponds to the JSON property `displayName`
2376
+ # @return [String]
2377
+ attr_accessor :display_name
2378
+
2379
+ # Output only. The unique ID of the user list.
2380
+ # Corresponds to the JSON property `id`
2381
+ # @return [Fixnum]
2382
+ attr_accessor :id
2383
+
2384
+ # Represents a user list that is populated by user provided data.
2385
+ # Corresponds to the JSON property `ingestedUserListInfo`
2386
+ # @return [Google::Apis::DatamanagerV1::IngestedUserListInfo]
2387
+ attr_accessor :ingested_user_list_info
2388
+
2389
+ # Optional. An ID from external system. It is used by user list sellers to
2390
+ # correlate IDs on their systems.
2391
+ # Corresponds to the JSON property `integrationCode`
2392
+ # @return [String]
2393
+ attr_accessor :integration_code
2394
+
2395
+ # Optional. The duration a user remains in the user list. Valid durations are
2396
+ # exact multiples of 24 hours (86400 seconds). Providing a value that is not an
2397
+ # exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
2398
+ # Corresponds to the JSON property `membershipDuration`
2399
+ # @return [String]
2400
+ attr_accessor :membership_duration
2401
+
2402
+ # Optional. Membership status of this user list.
2403
+ # Corresponds to the JSON property `membershipStatus`
2404
+ # @return [String]
2405
+ attr_accessor :membership_status
2406
+
2407
+ # Identifier. The resource name of the user list. Format: accountTypes/`
2408
+ # account_type`/accounts/`account`/userLists/`user_list`
2409
+ # Corresponds to the JSON property `name`
2410
+ # @return [String]
2411
+ attr_accessor :name
2412
+
2413
+ # Output only. An option that indicates if a user may edit a list.
2414
+ # Corresponds to the JSON property `readOnly`
2415
+ # @return [Boolean]
2416
+ attr_accessor :read_only
2417
+ alias_method :read_only?, :read_only
2418
+
2419
+ # Estimated number of members in this user list in different target networks.
2420
+ # Corresponds to the JSON property `sizeInfo`
2421
+ # @return [Google::Apis::DatamanagerV1::SizeInfo]
2422
+ attr_accessor :size_info
2423
+
2424
+ # Eligibility information for different target networks.
2425
+ # Corresponds to the JSON property `targetNetworkInfo`
2426
+ # @return [Google::Apis::DatamanagerV1::TargetNetworkInfo]
2427
+ attr_accessor :target_network_info
2428
+
2429
+ def initialize(**args)
2430
+ update!(**args)
2431
+ end
2432
+
2433
+ # Update properties of this object
2434
+ def update!(**args)
2435
+ @access_reason = args[:access_reason] if args.key?(:access_reason)
2436
+ @account_access_status = args[:account_access_status] if args.key?(:account_access_status)
2437
+ @closing_reason = args[:closing_reason] if args.key?(:closing_reason)
2438
+ @description = args[:description] if args.key?(:description)
2439
+ @display_name = args[:display_name] if args.key?(:display_name)
2440
+ @id = args[:id] if args.key?(:id)
2441
+ @ingested_user_list_info = args[:ingested_user_list_info] if args.key?(:ingested_user_list_info)
2442
+ @integration_code = args[:integration_code] if args.key?(:integration_code)
2443
+ @membership_duration = args[:membership_duration] if args.key?(:membership_duration)
2444
+ @membership_status = args[:membership_status] if args.key?(:membership_status)
2445
+ @name = args[:name] if args.key?(:name)
2446
+ @read_only = args[:read_only] if args.key?(:read_only)
2447
+ @size_info = args[:size_info] if args.key?(:size_info)
2448
+ @target_network_info = args[:target_network_info] if args.key?(:target_network_info)
2449
+ end
2450
+ end
2451
+
2452
+ # A user list direct license. This feature is only available to data partners.
2453
+ class UserListDirectLicense
2454
+ include Google::Apis::Core::Hashable
2455
+
2456
+ # Output only. Name of client customer which the user list is being licensed to.
2457
+ # This field is read-only.
2458
+ # Corresponds to the JSON property `clientAccountDisplayName`
2459
+ # @return [String]
2460
+ attr_accessor :client_account_display_name
2461
+
2462
+ # Immutable. ID of client customer which the user list is being licensed to.
2463
+ # Corresponds to the JSON property `clientAccountId`
2464
+ # @return [Fixnum]
2465
+ attr_accessor :client_account_id
2466
+
2467
+ # Immutable. Account type of client customer which the user list is being
2468
+ # licensed to.
2469
+ # Corresponds to the JSON property `clientAccountType`
2470
+ # @return [String]
2471
+ attr_accessor :client_account_type
2472
+
2473
+ # Output only. Pricing history of this user list license. This field is read-
2474
+ # only.
2475
+ # Corresponds to the JSON property `historicalPricings`
2476
+ # @return [Array<Google::Apis::DatamanagerV1::UserListLicensePricing>]
2477
+ attr_accessor :historical_pricings
2478
+
2479
+ # Metrics related to a user list license.
2480
+ # Corresponds to the JSON property `metrics`
2481
+ # @return [Google::Apis::DatamanagerV1::UserListLicenseMetrics]
2482
+ attr_accessor :metrics
2483
+
2484
+ # Identifier. The resource name of the user list direct license.
2485
+ # Corresponds to the JSON property `name`
2486
+ # @return [String]
2487
+ attr_accessor :name
2488
+
2489
+ # A user list license pricing.
2490
+ # Corresponds to the JSON property `pricing`
2491
+ # @return [Google::Apis::DatamanagerV1::UserListLicensePricing]
2492
+ attr_accessor :pricing
2493
+
2494
+ # Optional. Status of UserListDirectLicense - ENABLED or DISABLED.
2495
+ # Corresponds to the JSON property `status`
2496
+ # @return [String]
2497
+ attr_accessor :status
2498
+
2499
+ # Output only. Name of the user list being licensed. This field is read-only.
2500
+ # Corresponds to the JSON property `userListDisplayName`
2501
+ # @return [String]
2502
+ attr_accessor :user_list_display_name
2503
+
2504
+ # Immutable. ID of the user list being licensed.
2505
+ # Corresponds to the JSON property `userListId`
2506
+ # @return [Fixnum]
2507
+ attr_accessor :user_list_id
2508
+
2509
+ def initialize(**args)
2510
+ update!(**args)
2511
+ end
2512
+
2513
+ # Update properties of this object
2514
+ def update!(**args)
2515
+ @client_account_display_name = args[:client_account_display_name] if args.key?(:client_account_display_name)
2516
+ @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
2517
+ @client_account_type = args[:client_account_type] if args.key?(:client_account_type)
2518
+ @historical_pricings = args[:historical_pricings] if args.key?(:historical_pricings)
2519
+ @metrics = args[:metrics] if args.key?(:metrics)
2520
+ @name = args[:name] if args.key?(:name)
2521
+ @pricing = args[:pricing] if args.key?(:pricing)
2522
+ @status = args[:status] if args.key?(:status)
2523
+ @user_list_display_name = args[:user_list_display_name] if args.key?(:user_list_display_name)
2524
+ @user_list_id = args[:user_list_id] if args.key?(:user_list_id)
2525
+ end
2526
+ end
2527
+
2528
+ # A user list global license. This feature is only available to data partners.
2529
+ class UserListGlobalLicense
2530
+ include Google::Apis::Core::Hashable
2531
+
2532
+ # Output only. Pricing history of this user list license. This field is read-
2533
+ # only.
2534
+ # Corresponds to the JSON property `historicalPricings`
2535
+ # @return [Array<Google::Apis::DatamanagerV1::UserListLicensePricing>]
2536
+ attr_accessor :historical_pricings
2537
+
2538
+ # Immutable. Product type of client customer which the user list is being
2539
+ # licensed to.
2540
+ # Corresponds to the JSON property `licenseType`
2541
+ # @return [String]
2542
+ attr_accessor :license_type
2543
+
2544
+ # Metrics related to a user list license.
2545
+ # Corresponds to the JSON property `metrics`
2546
+ # @return [Google::Apis::DatamanagerV1::UserListLicenseMetrics]
2547
+ attr_accessor :metrics
2548
+
2549
+ # Identifier. The resource name of the user list global license.
2550
+ # Corresponds to the JSON property `name`
2551
+ # @return [String]
2552
+ attr_accessor :name
2553
+
2554
+ # A user list license pricing.
2555
+ # Corresponds to the JSON property `pricing`
2556
+ # @return [Google::Apis::DatamanagerV1::UserListLicensePricing]
2557
+ attr_accessor :pricing
2558
+
2559
+ # Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.
2560
+ # Corresponds to the JSON property `status`
2561
+ # @return [String]
2562
+ attr_accessor :status
2563
+
2564
+ # Output only. Name of the user list being licensed. This field is read-only.
2565
+ # Corresponds to the JSON property `userListDisplayName`
2566
+ # @return [String]
2567
+ attr_accessor :user_list_display_name
2568
+
2569
+ # Immutable. ID of the user list being licensed.
2570
+ # Corresponds to the JSON property `userListId`
2571
+ # @return [Fixnum]
2572
+ attr_accessor :user_list_id
2573
+
2574
+ def initialize(**args)
2575
+ update!(**args)
2576
+ end
2577
+
2578
+ # Update properties of this object
2579
+ def update!(**args)
2580
+ @historical_pricings = args[:historical_pricings] if args.key?(:historical_pricings)
2581
+ @license_type = args[:license_type] if args.key?(:license_type)
2582
+ @metrics = args[:metrics] if args.key?(:metrics)
2583
+ @name = args[:name] if args.key?(:name)
2584
+ @pricing = args[:pricing] if args.key?(:pricing)
2585
+ @status = args[:status] if args.key?(:status)
2586
+ @user_list_display_name = args[:user_list_display_name] if args.key?(:user_list_display_name)
2587
+ @user_list_id = args[:user_list_id] if args.key?(:user_list_id)
2588
+ end
2589
+ end
2590
+
2591
+ # Information about a customer of a user list global license. This will
2592
+ # automatically be created by the system when a customer purchases a global
2593
+ # license.
2594
+ class UserListGlobalLicenseCustomerInfo
2595
+ include Google::Apis::Core::Hashable
2596
+
2597
+ # Output only. Name of client customer which the user list is being licensed to.
2598
+ # Corresponds to the JSON property `clientAccountDisplayName`
2599
+ # @return [String]
2600
+ attr_accessor :client_account_display_name
2601
+
2602
+ # Output only. ID of client customer which the user list is being licensed to.
2603
+ # Corresponds to the JSON property `clientAccountId`
2604
+ # @return [Fixnum]
2605
+ attr_accessor :client_account_id
2606
+
2607
+ # Output only. Product type of client customer which the user list is being
2608
+ # licensed to.
2609
+ # Corresponds to the JSON property `clientAccountType`
2610
+ # @return [String]
2611
+ attr_accessor :client_account_type
2612
+
2613
+ # Output only. Pricing history of this user list license.
2614
+ # Corresponds to the JSON property `historicalPricings`
2615
+ # @return [Array<Google::Apis::DatamanagerV1::UserListLicensePricing>]
2616
+ attr_accessor :historical_pricings
2617
+
2618
+ # Output only. Product type of client customer which the user list is being
2619
+ # licensed to.
2620
+ # Corresponds to the JSON property `licenseType`
2621
+ # @return [String]
2622
+ attr_accessor :license_type
2623
+
2624
+ # Metrics related to a user list license.
2625
+ # Corresponds to the JSON property `metrics`
2626
+ # @return [Google::Apis::DatamanagerV1::UserListLicenseMetrics]
2627
+ attr_accessor :metrics
2628
+
2629
+ # Identifier. The resource name of the user list global license customer.
2630
+ # Corresponds to the JSON property `name`
2631
+ # @return [String]
2632
+ attr_accessor :name
2633
+
2634
+ # A user list license pricing.
2635
+ # Corresponds to the JSON property `pricing`
2636
+ # @return [Google::Apis::DatamanagerV1::UserListLicensePricing]
2637
+ attr_accessor :pricing
2638
+
2639
+ # Output only. Status of UserListDirectLicense - ENABLED or DISABLED.
2640
+ # Corresponds to the JSON property `status`
2641
+ # @return [String]
2642
+ attr_accessor :status
2643
+
2644
+ # Output only. Name of the user list being licensed.
2645
+ # Corresponds to the JSON property `userListDisplayName`
2646
+ # @return [String]
2647
+ attr_accessor :user_list_display_name
2648
+
2649
+ # Output only. ID of the user list being licensed.
2650
+ # Corresponds to the JSON property `userListId`
2651
+ # @return [Fixnum]
2652
+ attr_accessor :user_list_id
2653
+
2654
+ def initialize(**args)
2655
+ update!(**args)
2656
+ end
2657
+
2658
+ # Update properties of this object
2659
+ def update!(**args)
2660
+ @client_account_display_name = args[:client_account_display_name] if args.key?(:client_account_display_name)
2661
+ @client_account_id = args[:client_account_id] if args.key?(:client_account_id)
2662
+ @client_account_type = args[:client_account_type] if args.key?(:client_account_type)
2663
+ @historical_pricings = args[:historical_pricings] if args.key?(:historical_pricings)
2664
+ @license_type = args[:license_type] if args.key?(:license_type)
2665
+ @metrics = args[:metrics] if args.key?(:metrics)
2666
+ @name = args[:name] if args.key?(:name)
2667
+ @pricing = args[:pricing] if args.key?(:pricing)
2668
+ @status = args[:status] if args.key?(:status)
2669
+ @user_list_display_name = args[:user_list_display_name] if args.key?(:user_list_display_name)
2670
+ @user_list_id = args[:user_list_id] if args.key?(:user_list_id)
2671
+ end
2672
+ end
2673
+
2674
+ # Metrics related to a user list license.
2675
+ class UserListLicenseMetrics
2676
+ include Google::Apis::Core::Hashable
2677
+
2678
+ # Output only. The number of clicks for the user list license.
2679
+ # Corresponds to the JSON property `clickCount`
2680
+ # @return [Fixnum]
2681
+ attr_accessor :click_count
2682
+
2683
+ # Output only. The end date (inclusive) of the metrics in the format YYYYMMDD.
2684
+ # For example, 20260102 represents January 2, 2026. If `start_date` is used in
2685
+ # the filter, `end_date` is also required. If neither `start_date` nor `end_date`
2686
+ # are included in the filter, the UserListLicenseMetrics fields will not be
2687
+ # populated in the response.
2688
+ # Corresponds to the JSON property `endDate`
2689
+ # @return [Fixnum]
2690
+ attr_accessor :end_date
2691
+
2692
+ # Output only. The number of impressions for the user list license.
2693
+ # Corresponds to the JSON property `impressionCount`
2694
+ # @return [Fixnum]
2695
+ attr_accessor :impression_count
2696
+
2697
+ # Output only. The revenue for the user list license in USD micros.
2698
+ # Corresponds to the JSON property `revenueUsdMicros`
2699
+ # @return [Fixnum]
2700
+ attr_accessor :revenue_usd_micros
2701
+
2702
+ # Output only. The start date (inclusive) of the metrics in the format YYYYMMDD.
2703
+ # For example, 20260102 represents January 2, 2026. If `end_date` is used in the
2704
+ # filter, `start_date` is also required. If neither `start_date` nor `end_date`
2705
+ # are included in the filter, the UserListLicenseMetrics fields will not be
2706
+ # populated in the response.
2707
+ # Corresponds to the JSON property `startDate`
2708
+ # @return [Fixnum]
2709
+ attr_accessor :start_date
2710
+
2711
+ def initialize(**args)
2712
+ update!(**args)
2713
+ end
2714
+
2715
+ # Update properties of this object
2716
+ def update!(**args)
2717
+ @click_count = args[:click_count] if args.key?(:click_count)
2718
+ @end_date = args[:end_date] if args.key?(:end_date)
2719
+ @impression_count = args[:impression_count] if args.key?(:impression_count)
2720
+ @revenue_usd_micros = args[:revenue_usd_micros] if args.key?(:revenue_usd_micros)
2721
+ @start_date = args[:start_date] if args.key?(:start_date)
2722
+ end
2723
+ end
2724
+
2725
+ # A user list license pricing.
2726
+ class UserListLicensePricing
2727
+ include Google::Apis::Core::Hashable
2728
+
2729
+ # Output only. The buyer approval state of this pricing. This field is read-only.
2730
+ # Corresponds to the JSON property `buyerApprovalState`
2731
+ # @return [String]
2732
+ attr_accessor :buyer_approval_state
2733
+
2734
+ # Optional. The cost associated with the model, in micro units (10^-6), in the
2735
+ # currency specified by the currency_code field. For example, 2000000 means $2
2736
+ # if `currency_code` is `USD`.
2737
+ # Corresponds to the JSON property `costMicros`
2738
+ # @return [Fixnum]
2739
+ attr_accessor :cost_micros
2740
+
2741
+ # Immutable. The cost type of this pricing. Can be set only in the `create`
2742
+ # operation. Can't be updated for an existing license.
2743
+ # Corresponds to the JSON property `costType`
2744
+ # @return [String]
2745
+ attr_accessor :cost_type
2746
+
2747
+ # Optional. The currency in which cost and max_cost is specified. Must be a
2748
+ # three-letter currency code defined in ISO 4217.
2749
+ # Corresponds to the JSON property `currencyCode`
2750
+ # @return [String]
2751
+ attr_accessor :currency_code
2752
+
2753
+ # Optional. End time of the pricing.
2754
+ # Corresponds to the JSON property `endTime`
2755
+ # @return [String]
2756
+ attr_accessor :end_time
2757
+
2758
+ # Optional. The maximum CPM a commerce audience can be charged when the
2759
+ # MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the
2760
+ # currency specified by the currency_code field. For example, 2000000 means $2
2761
+ # if `currency_code` is `USD`. This is only relevant when cost_type is
2762
+ # MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a
2763
+ # MAX_COST_NOT_ALLOWED error will be returned. If not set or set to`0`, there is
2764
+ # no cap.
2765
+ # Corresponds to the JSON property `maxCostMicros`
2766
+ # @return [Fixnum]
2767
+ attr_accessor :max_cost_micros
2768
+
2769
+ # Output only. Whether this pricing is active.
2770
+ # Corresponds to the JSON property `pricingActive`
2771
+ # @return [Boolean]
2772
+ attr_accessor :pricing_active
2773
+ alias_method :pricing_active?, :pricing_active
2774
+
2775
+ # Output only. The ID of this pricing.
2776
+ # Corresponds to the JSON property `pricingId`
2777
+ # @return [Fixnum]
2778
+ attr_accessor :pricing_id
2779
+
2780
+ # Output only. Start time of the pricing.
2781
+ # Corresponds to the JSON property `startTime`
2782
+ # @return [String]
2783
+ attr_accessor :start_time
2784
+
2785
+ def initialize(**args)
2786
+ update!(**args)
2787
+ end
2788
+
2789
+ # Update properties of this object
2790
+ def update!(**args)
2791
+ @buyer_approval_state = args[:buyer_approval_state] if args.key?(:buyer_approval_state)
2792
+ @cost_micros = args[:cost_micros] if args.key?(:cost_micros)
2793
+ @cost_type = args[:cost_type] if args.key?(:cost_type)
2794
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
2795
+ @end_time = args[:end_time] if args.key?(:end_time)
2796
+ @max_cost_micros = args[:max_cost_micros] if args.key?(:max_cost_micros)
2797
+ @pricing_active = args[:pricing_active] if args.key?(:pricing_active)
2798
+ @pricing_id = args[:pricing_id] if args.key?(:pricing_id)
2799
+ @start_time = args[:start_time] if args.key?(:start_time)
2800
+ end
2801
+ end
2802
+
1482
2803
  # Advertiser-assessed information about the user at the time that the event
1483
2804
  # happened. See https://support.google.com/google-ads/answer/14007601 for more
1484
2805
  # details.