google-ads-data_manager-v1 0.2.0 → 0.4.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.
- checksums.yaml +4 -4
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/client.rb +494 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest/client.rb +444 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest/service_stub.rb +143 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service/rest.rb +53 -0
- data/lib/google/ads/data_manager/v1/marketing_data_insights_service.rb +56 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/client.rb +739 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/credentials.rb +48 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/rest/client.rb +675 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/rest/service_stub.rb +265 -0
- data/lib/google/ads/data_manager/v1/partner_link_service/rest.rb +52 -0
- data/lib/google/ads/data_manager/v1/partner_link_service.rb +55 -0
- data/lib/google/ads/data_manager/v1/rest.rb +5 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/client.rb +813 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest/client.rb +742 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest/service_stub.rb +327 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest.rb +56 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service.rb +59 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/client.rb +955 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest/client.rb +877 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest/service_stub.rb +388 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest.rb +56 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service.rb +59 -0
- data/lib/google/ads/data_manager/v1/user_list_service/client.rb +972 -0
- data/lib/google/ads/data_manager/v1/user_list_service/credentials.rb +47 -0
- data/lib/google/ads/data_manager/v1/user_list_service/paths.rb +69 -0
- data/lib/google/ads/data_manager/v1/user_list_service/rest/client.rb +894 -0
- data/lib/google/ads/data_manager/v1/user_list_service/rest/service_stub.rb +388 -0
- data/lib/google/ads/data_manager/v1/user_list_service/rest.rb +52 -0
- data/lib/google/ads/data_manager/v1/user_list_service.rb +55 -0
- data/lib/google/ads/data_manager/v1/version.rb +1 -1
- data/lib/google/ads/data_manager/v1.rb +5 -0
- data/lib/google/ads/datamanager/v1/age_range_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/audience_pb.rb +5 -26
- data/lib/google/ads/datamanager/v1/cart_data_pb.rb +4 -25
- data/lib/google/ads/datamanager/v1/consent_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/destination_pb.rb +4 -24
- data/lib/google/ads/datamanager/v1/device_info_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/encryption_info_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/error_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/event_pb.rb +4 -31
- data/lib/google/ads/datamanager/v1/experimental_field_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/gender_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/ingestion_service_pb.rb +3 -31
- data/lib/google/ads/datamanager/v1/insights_service_pb.rb +33 -0
- data/lib/google/ads/datamanager/v1/insights_service_services_pb.rb +62 -0
- data/lib/google/ads/datamanager/v1/item_parameter_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/match_rate_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/partner_link_service_pb.rb +32 -0
- data/lib/google/ads/datamanager/v1/partner_link_service_services_pb.rb +79 -0
- data/lib/google/ads/datamanager/v1/processing_errors_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/request_status_per_destination_pb.rb +7 -26
- data/lib/google/ads/datamanager/v1/terms_of_service_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/user_data_pb.rb +3 -24
- data/lib/google/ads/datamanager/v1/user_list_direct_license_pb.rb +28 -0
- data/lib/google/ads/datamanager/v1/user_list_direct_license_service_pb.rb +32 -0
- data/lib/google/ads/datamanager/v1/user_list_direct_license_service_services_pb.rb +63 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_pb.rb +30 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_service_pb.rb +34 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_service_services_pb.rb +67 -0
- data/lib/google/ads/datamanager/v1/user_list_global_license_type_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/user_list_license_client_account_type_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/user_list_license_metrics_pb.rb +23 -0
- data/lib/google/ads/datamanager/v1/user_list_license_pricing_pb.rb +26 -0
- data/lib/google/ads/datamanager/v1/user_list_license_status_pb.rb +21 -0
- data/lib/google/ads/datamanager/v1/user_list_pb.rb +43 -0
- data/lib/google/ads/datamanager/v1/user_list_service_pb.rb +34 -0
- data/lib/google/ads/datamanager/v1/user_list_service_services_pb.rb +118 -0
- data/lib/google/ads/datamanager/v1/user_properties_pb.rb +3 -24
- data/proto_docs/google/ads/datamanager/v1/age_range.rb +53 -0
- data/proto_docs/google/ads/datamanager/v1/audience.rb +42 -3
- data/proto_docs/google/ads/datamanager/v1/cart_data.rb +52 -0
- data/proto_docs/google/ads/datamanager/v1/destination.rb +3 -0
- data/proto_docs/google/ads/datamanager/v1/device_info.rb +31 -0
- data/proto_docs/google/ads/datamanager/v1/encryption_info.rb +6 -3
- data/proto_docs/google/ads/datamanager/v1/error.rb +212 -1
- data/proto_docs/google/ads/datamanager/v1/event.rb +47 -2
- data/proto_docs/google/ads/datamanager/v1/gender.rb +41 -0
- data/proto_docs/google/ads/datamanager/v1/insights_service.rb +133 -0
- data/proto_docs/google/ads/datamanager/v1/partner_link_service.rb +141 -0
- data/proto_docs/google/ads/datamanager/v1/processing_errors.rb +4 -1
- data/proto_docs/google/ads/datamanager/v1/request_status_per_destination.rb +121 -11
- data/proto_docs/google/ads/datamanager/v1/user_list.rb +403 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_direct_license.rb +75 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_direct_license_service.rb +134 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_global_license.rb +114 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_global_license_service.rb +204 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_global_license_type.rb +41 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_client_account_type.rb +44 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_metrics.rb +55 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_pricing.rb +108 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_license_status.rb +38 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_service.rb +151 -0
- data/proto_docs/google/api/client.rb +149 -29
- data/proto_docs/google/protobuf/empty.rb +34 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- metadata +73 -2
|
@@ -22,6 +22,7 @@ module Google
|
|
|
22
22
|
module DataManager
|
|
23
23
|
module V1
|
|
24
24
|
# Error reasons for Data Manager API.
|
|
25
|
+
# NOTE: This enum is not frozen and new values may be added in the future.
|
|
25
26
|
module ErrorReason
|
|
26
27
|
# Do not use this default value.
|
|
27
28
|
ERROR_REASON_UNSPECIFIED = 0
|
|
@@ -62,7 +63,7 @@ module Google
|
|
|
62
63
|
# Postal code is not valid.
|
|
63
64
|
INVALID_POSTAL_CODE = 12
|
|
64
65
|
|
|
65
|
-
#
|
|
66
|
+
# Deprecated: Enum is unused in the Data Manager API.
|
|
66
67
|
INVALID_COUNTRY_CODE = 13
|
|
67
68
|
|
|
68
69
|
# Enum value cannot be used.
|
|
@@ -185,6 +186,216 @@ module Google
|
|
|
185
186
|
|
|
186
187
|
# Too many elements in a list in the request.
|
|
187
188
|
TOO_MANY_ELEMENTS = 51
|
|
189
|
+
|
|
190
|
+
# The resource already exists.
|
|
191
|
+
ALREADY_EXISTS = 52
|
|
192
|
+
|
|
193
|
+
# Attempted to set an immutable field for an update request.
|
|
194
|
+
IMMUTABLE_FIELD_FOR_UPDATE = 53
|
|
195
|
+
|
|
196
|
+
# The resource name is invalid.
|
|
197
|
+
INVALID_RESOURCE_NAME = 54
|
|
198
|
+
|
|
199
|
+
# The query filter is invalid.
|
|
200
|
+
INVALID_FILTER = 55
|
|
201
|
+
|
|
202
|
+
# The update mask is invalid.
|
|
203
|
+
INVALID_UPDATE_MASK = 56
|
|
204
|
+
|
|
205
|
+
# The page token is invalid.
|
|
206
|
+
INVALID_PAGE_TOKEN = 57
|
|
207
|
+
|
|
208
|
+
# Cannot update a license that has been disabled.
|
|
209
|
+
CANNOT_UPDATE_DISABLED_LICENSE = 58
|
|
210
|
+
|
|
211
|
+
# Sensitive user lists cannot be licensed to this client.
|
|
212
|
+
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST = 59
|
|
213
|
+
|
|
214
|
+
# Cost too low for this license.
|
|
215
|
+
INSUFFICIENT_COST = 60
|
|
216
|
+
|
|
217
|
+
# Reseller license cannot be disabled since it is in use.
|
|
218
|
+
CANNOT_DISABLE_LICENSE = 61
|
|
219
|
+
|
|
220
|
+
# Invalid client account id.
|
|
221
|
+
INVALID_CLIENT_ACCOUNT_ID = 62
|
|
222
|
+
|
|
223
|
+
# Non-zero cost not allowed for this client account.
|
|
224
|
+
PRICING_ONLY_ZERO_COST_ALLOWED = 63
|
|
225
|
+
|
|
226
|
+
# Cost too high for this license.
|
|
227
|
+
PRICE_TOO_HIGH = 64
|
|
228
|
+
|
|
229
|
+
# Customer not allowed to create license.
|
|
230
|
+
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE = 65
|
|
231
|
+
|
|
232
|
+
# Pricing end date is invalid for this license.
|
|
233
|
+
INVALID_PRICING_END_DATE = 66
|
|
234
|
+
|
|
235
|
+
# Logical user list with shared or licensed segment cannot be licensed.
|
|
236
|
+
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT = 67
|
|
237
|
+
|
|
238
|
+
# Client customer's account type in the request does not match the customer's
|
|
239
|
+
# actual account type.
|
|
240
|
+
MISMATCHED_ACCOUNT_TYPE = 68
|
|
241
|
+
|
|
242
|
+
# License type does not support media share cost.
|
|
243
|
+
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE = 69
|
|
244
|
+
|
|
245
|
+
# Client customer type does not support media share cost.
|
|
246
|
+
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER = 70
|
|
247
|
+
|
|
248
|
+
# Invalid media share cost.
|
|
249
|
+
INVALID_MEDIA_SHARE_COST = 71
|
|
250
|
+
|
|
251
|
+
# Invalid cost type.
|
|
252
|
+
INVALID_COST_TYPE = 72
|
|
253
|
+
|
|
254
|
+
# UserList type does not support media share cost.
|
|
255
|
+
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST = 73
|
|
256
|
+
|
|
257
|
+
# Max cost is only allowed for cost_type MEDIA_SHARE.
|
|
258
|
+
MAX_COST_NOT_ALLOWED = 74
|
|
259
|
+
|
|
260
|
+
# Commerce audience can only be directly licensed.
|
|
261
|
+
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED = 75
|
|
262
|
+
|
|
263
|
+
# The description is not valid.
|
|
264
|
+
INVALID_DESCRIPTION = 76
|
|
265
|
+
|
|
266
|
+
# The display name is not valid.
|
|
267
|
+
INVALID_DISPLAY_NAME = 77
|
|
268
|
+
|
|
269
|
+
# The display name is already being used for another user list for the
|
|
270
|
+
# account.
|
|
271
|
+
DISPLAY_NAME_ALREADY_USED = 78
|
|
272
|
+
|
|
273
|
+
# Ownership is required to modify the user list.
|
|
274
|
+
OWNERSHIP_REQUIRED_FOR_UPDATE = 79
|
|
275
|
+
|
|
276
|
+
# The user list type is read-only and does not support mutation.
|
|
277
|
+
USER_LIST_MUTATION_NOT_SUPPORTED = 80
|
|
278
|
+
|
|
279
|
+
# A user list which is privacy sensitive or legal rejected cannot be mutated
|
|
280
|
+
# by external users.
|
|
281
|
+
SENSITIVE_USER_LIST_IMMUTABLE = 81
|
|
282
|
+
|
|
283
|
+
# The remarketing user list's billable record field cannot be modified once
|
|
284
|
+
# it is set.
|
|
285
|
+
BILLABLE_RECORD_COUNT_IMMUTABLE = 82
|
|
286
|
+
|
|
287
|
+
# The user list name is reserved for system lists.
|
|
288
|
+
USER_LIST_NAME_RESERVED = 83
|
|
289
|
+
|
|
290
|
+
# The advertiser needs to be allowlisted to use remarketing lists created
|
|
291
|
+
# from advertiser uploaded data.
|
|
292
|
+
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA = 84
|
|
293
|
+
|
|
294
|
+
# The partner audience source is not supported for the user list type.
|
|
295
|
+
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE = 85
|
|
296
|
+
|
|
297
|
+
# Setting the `commerce_partner` field is only supported if the
|
|
298
|
+
# `partner_audience_source` is `COMMERCE_AUDIENCE`.
|
|
299
|
+
COMMERCE_PARTNER_NOT_ALLOWED = 86
|
|
300
|
+
|
|
301
|
+
# The `partner_audience_info` field is not supported for the user list type.
|
|
302
|
+
UNSUPPORTED_PARTNER_AUDIENCE_INFO = 87
|
|
303
|
+
|
|
304
|
+
# Partner Match user lists cannot be created by manager accounts.
|
|
305
|
+
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED = 88
|
|
306
|
+
|
|
307
|
+
# The data partner is not allowlisted for THIRD_PARTY_PARTNER_DATA.
|
|
308
|
+
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA = 89
|
|
309
|
+
|
|
310
|
+
# The advertiser has not accepted the partner's terms of service.
|
|
311
|
+
ADVERTISER_TOS_NOT_ACCEPTED = 90
|
|
312
|
+
|
|
313
|
+
# The advertiser is not allowlisted for THIRD_PARTY_PARTNER_DATA.
|
|
314
|
+
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA = 91
|
|
315
|
+
|
|
316
|
+
# This user list type is not supported for this account.
|
|
317
|
+
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT = 92
|
|
318
|
+
|
|
319
|
+
# The `commerce_partner` field is invalid.
|
|
320
|
+
INVALID_COMMERCE_PARTNER = 93
|
|
321
|
+
|
|
322
|
+
# The data provider is not allowlisted to create commerce audiences.
|
|
323
|
+
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE = 94
|
|
324
|
+
|
|
325
|
+
# The user list upload key types are not supported.
|
|
326
|
+
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES = 95
|
|
327
|
+
|
|
328
|
+
# The ingested user list info config is not supported.
|
|
329
|
+
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG = 96
|
|
330
|
+
|
|
331
|
+
# The account types are not supported for the user list type.
|
|
332
|
+
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE = 97
|
|
333
|
+
|
|
334
|
+
# The account types are not supported for the partner link.
|
|
335
|
+
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK = 98
|
|
336
|
+
|
|
337
|
+
# The user list membership duration is too long.
|
|
338
|
+
MEMBERSHIP_DURATION_TOO_LONG = 99
|
|
339
|
+
|
|
340
|
+
# The `merchant_id` field is not valid.
|
|
341
|
+
INVALID_MERCHANT_ID = 100
|
|
342
|
+
|
|
343
|
+
# The customer contains non-exempt campaigns without the EU political
|
|
344
|
+
# advertising declaration.
|
|
345
|
+
EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED = 101
|
|
346
|
+
|
|
347
|
+
# Account is not eligible for Store Sales.
|
|
348
|
+
ACCOUNT_INELIGIBLE_FOR_STORE_SALES = 102
|
|
349
|
+
|
|
350
|
+
# The merchant feed language code is not valid.
|
|
351
|
+
INVALID_MERCHANT_FEED_LANGUAGE_CODE = 103
|
|
352
|
+
|
|
353
|
+
# The region code is not valid.
|
|
354
|
+
INVALID_REGION_CODE = 104
|
|
355
|
+
|
|
356
|
+
# The subdivision code is not valid.
|
|
357
|
+
INVALID_SUBDIVISION_CODE = 107
|
|
358
|
+
|
|
359
|
+
# The subcontinent code is not valid.
|
|
360
|
+
INVALID_SUBCONTINENT_CODE = 108
|
|
361
|
+
|
|
362
|
+
# The continent code is not valid.
|
|
363
|
+
INVALID_CONTINENT_CODE = 109
|
|
364
|
+
|
|
365
|
+
# The device category is not valid.
|
|
366
|
+
INVALID_DEVICE_CATEGORY = 110
|
|
367
|
+
|
|
368
|
+
# Both app_instance_id and client_id are set.
|
|
369
|
+
BOTH_CLIENT_ID_AND_APP_INSTANCE_ID_NOT_ALLOWED = 111
|
|
370
|
+
|
|
371
|
+
# The Google Analytics property is a subproperty or rollup property.
|
|
372
|
+
GOOGLE_ANALYTICS_SUBPROPERTY_OR_ROLLUP_PROPERTY_NOT_ALLOWED = 112
|
|
373
|
+
|
|
374
|
+
# Third party user data can only be set by data partners.
|
|
375
|
+
THIRD_PARTY_USER_DATA_NOT_ALLOWED = 113
|
|
376
|
+
|
|
377
|
+
# The coupon code is not valid.
|
|
378
|
+
INVALID_COUPON_CODE = 114
|
|
379
|
+
|
|
380
|
+
# The event source type does not match the destination type.
|
|
381
|
+
EVENT_SOURCE_AND_DESTINATION_MISMATCH = 115
|
|
382
|
+
|
|
383
|
+
# The destination account type does not match the specified account id.
|
|
384
|
+
DESTINATION_ACCOUNT_TYPE_MISMATCH = 116
|
|
385
|
+
|
|
386
|
+
# The custom variable value contains personally identifiable information
|
|
387
|
+
# (PII).
|
|
388
|
+
CUSTOM_VARIABLE_VALUE_CONTAINS_PII = 117
|
|
389
|
+
|
|
390
|
+
# The custom variable is not enabled.
|
|
391
|
+
CUSTOM_VARIABLE_NOT_ENABLED = 118
|
|
392
|
+
|
|
393
|
+
# The custom variable's value is invalid.
|
|
394
|
+
INVALID_CUSTOM_VARIABLE_VALUE = 119
|
|
395
|
+
|
|
396
|
+
# The destination does not have a custom variable with a name that matches
|
|
397
|
+
# the specified `variable`.
|
|
398
|
+
CUSTOM_VARIABLE_NOT_FOUND = 120
|
|
188
399
|
end
|
|
189
400
|
end
|
|
190
401
|
end
|
|
@@ -30,8 +30,8 @@ module Google
|
|
|
30
30
|
# in the request.
|
|
31
31
|
# @!attribute [rw] transaction_id
|
|
32
32
|
# @return [::String]
|
|
33
|
-
# Optional. The unique identifier for this event. Required for
|
|
34
|
-
#
|
|
33
|
+
# Optional. The unique identifier for this event. Required for events sent as
|
|
34
|
+
# an additional data source for tag conversions.
|
|
35
35
|
# @!attribute [rw] event_timestamp
|
|
36
36
|
# @return [::Google::Protobuf::Timestamp]
|
|
37
37
|
# Required. The time the event occurred.
|
|
@@ -97,6 +97,19 @@ module Google
|
|
|
97
97
|
# parameters](https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events)
|
|
98
98
|
# to be included within the event that were not already specified using other
|
|
99
99
|
# structured fields.
|
|
100
|
+
# @!attribute [rw] third_party_user_data
|
|
101
|
+
# @return [::Google::Ads::DataManager::V1::UserData]
|
|
102
|
+
# Optional. The same type of data provided in user_data, but explicitly
|
|
103
|
+
# flagged as being provided as owned by a third-party and not first-party
|
|
104
|
+
# advertiser data.
|
|
105
|
+
# @!attribute [rw] event_location
|
|
106
|
+
# @return [::Google::Ads::DataManager::V1::EventLocation]
|
|
107
|
+
# Optional. Information gathered about the location of the user when this
|
|
108
|
+
# event occurred.
|
|
109
|
+
# @!attribute [rw] app_instance_id
|
|
110
|
+
# @return [::String]
|
|
111
|
+
# Optional. A unique identifier for the user instance of an app client for
|
|
112
|
+
# this GA4 app stream.
|
|
100
113
|
class Event
|
|
101
114
|
include ::Google::Protobuf::MessageExts
|
|
102
115
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -122,6 +135,10 @@ module Google
|
|
|
122
135
|
# @return [::Google::Ads::DataManager::V1::DeviceInfo]
|
|
123
136
|
# Optional. Information gathered about the device being used (if any) at the
|
|
124
137
|
# time of landing onto the advertiser’s site after interacting with the ad.
|
|
138
|
+
# @!attribute [rw] mobile_device_id
|
|
139
|
+
# @return [::String]
|
|
140
|
+
# Optional. The mobile identifier for advertisers. This would be IDFA on iOS,
|
|
141
|
+
# AdID on Android, or other platforms’ identifiers for advertisers.
|
|
125
142
|
class AdIdentifiers
|
|
126
143
|
include ::Google::Protobuf::MessageExts
|
|
127
144
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -159,6 +176,31 @@ module Google
|
|
|
159
176
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
160
177
|
end
|
|
161
178
|
|
|
179
|
+
# The location where the event occurred.
|
|
180
|
+
# @!attribute [rw] store_id
|
|
181
|
+
# @return [::String]
|
|
182
|
+
# Optional. Required for Store Sales. The identifier to represent a physical
|
|
183
|
+
# store where the event happened.
|
|
184
|
+
# @!attribute [rw] city
|
|
185
|
+
# @return [::String]
|
|
186
|
+
# Optional. The name of the city where the event occurred.
|
|
187
|
+
# @!attribute [rw] subdivision_code
|
|
188
|
+
# @return [::String]
|
|
189
|
+
# Optional. The ISO 3166-2 subdivision code where the event occurred.
|
|
190
|
+
# @!attribute [rw] region_code
|
|
191
|
+
# @return [::String]
|
|
192
|
+
# Optional. The 2-letter CLDR region code of the user's address.
|
|
193
|
+
# @!attribute [rw] subcontinent_code
|
|
194
|
+
# @return [::String]
|
|
195
|
+
# Optional. The subcontinent code in UN M49 format where the event occurred.
|
|
196
|
+
# @!attribute [rw] continent_code
|
|
197
|
+
# @return [::String]
|
|
198
|
+
# Optional. The continent code in UN M49 format where the event occurred.
|
|
199
|
+
class EventLocation
|
|
200
|
+
include ::Google::Protobuf::MessageExts
|
|
201
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
202
|
+
end
|
|
203
|
+
|
|
162
204
|
# The source of the event.
|
|
163
205
|
module EventSource
|
|
164
206
|
# Unspecified EventSource. Should never be used.
|
|
@@ -176,6 +218,9 @@ module Google
|
|
|
176
218
|
# The event was generated from a phone call.
|
|
177
219
|
PHONE = 4
|
|
178
220
|
|
|
221
|
+
# The event was generated from a message.
|
|
222
|
+
MESSAGE = 6
|
|
223
|
+
|
|
179
224
|
# The event was generated from other sources.
|
|
180
225
|
OTHER = 5
|
|
181
226
|
end
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# The type of demographic genders (for example, female).
|
|
25
|
+
module Gender
|
|
26
|
+
# Not specified.
|
|
27
|
+
GENDER_UNSPECIFIED = 0
|
|
28
|
+
|
|
29
|
+
# Unknown.
|
|
30
|
+
GENDER_UNKNOWN = 1
|
|
31
|
+
|
|
32
|
+
# Male.
|
|
33
|
+
GENDER_MALE = 2
|
|
34
|
+
|
|
35
|
+
# Female.
|
|
36
|
+
GENDER_FEMALE = 3
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# Request message for DM API MarketingDataInsightsService.RetrieveInsights
|
|
25
|
+
# @!attribute [rw] parent
|
|
26
|
+
# @return [::String]
|
|
27
|
+
# Required. The parent account that owns the user list.
|
|
28
|
+
# Format: `accountTypes/{account_type}/accounts/{account}`
|
|
29
|
+
# @!attribute [rw] baseline
|
|
30
|
+
# @return [::Google::Ads::DataManager::V1::Baseline]
|
|
31
|
+
# Required. Baseline for the insights requested.
|
|
32
|
+
# @!attribute [rw] user_list_id
|
|
33
|
+
# @return [::String]
|
|
34
|
+
# Required. The user list ID for which insights are requested.
|
|
35
|
+
class RetrieveInsightsRequest
|
|
36
|
+
include ::Google::Protobuf::MessageExts
|
|
37
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
# Baseline criteria against which insights are compared.
|
|
41
|
+
# @!attribute [rw] baseline_location
|
|
42
|
+
# @return [::Google::Ads::DataManager::V1::Baseline::Location]
|
|
43
|
+
# The baseline location of the request. Baseline location is an OR-list
|
|
44
|
+
# of the requested regions.
|
|
45
|
+
#
|
|
46
|
+
# Note: The following fields are mutually exclusive: `baseline_location`, `location_auto_detection_enabled`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
47
|
+
# @!attribute [rw] location_auto_detection_enabled
|
|
48
|
+
# @return [::Boolean]
|
|
49
|
+
# If set to true, the service will try to automatically detect the
|
|
50
|
+
# baseline location for insights.
|
|
51
|
+
#
|
|
52
|
+
# Note: The following fields are mutually exclusive: `location_auto_detection_enabled`, `baseline_location`. If a field in that set is populated, all other fields in the set will automatically be cleared.
|
|
53
|
+
class Baseline
|
|
54
|
+
include ::Google::Protobuf::MessageExts
|
|
55
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
56
|
+
|
|
57
|
+
# The baseline location of the request. Baseline location is on OR-list of
|
|
58
|
+
# ISO 3166-1 alpha-2 region codes of the requested regions.
|
|
59
|
+
# @!attribute [rw] region_codes
|
|
60
|
+
# @return [::Array<::String>]
|
|
61
|
+
# List of ISO 3166-1 alpha-2 region codes.
|
|
62
|
+
class Location
|
|
63
|
+
include ::Google::Protobuf::MessageExts
|
|
64
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
# Response message for DM API MarketingDataInsightsService.RetrieveInsights
|
|
69
|
+
# @!attribute [rw] marketing_data_insights
|
|
70
|
+
# @return [::Array<::Google::Ads::DataManager::V1::RetrieveInsightsResponse::MarketingDataInsight>]
|
|
71
|
+
# Contains the insights for the marketing data.
|
|
72
|
+
class RetrieveInsightsResponse
|
|
73
|
+
include ::Google::Protobuf::MessageExts
|
|
74
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
75
|
+
|
|
76
|
+
# Insights for marketing data.
|
|
77
|
+
#
|
|
78
|
+
# This feature is only available to data partners.
|
|
79
|
+
# @!attribute [rw] dimension
|
|
80
|
+
# @return [::Google::Ads::DataManager::V1::RetrieveInsightsResponse::MarketingDataInsight::AudienceInsightsDimension]
|
|
81
|
+
# The dimension to which the insight belongs.
|
|
82
|
+
# @!attribute [rw] attributes
|
|
83
|
+
# @return [::Array<::Google::Ads::DataManager::V1::RetrieveInsightsResponse::MarketingDataInsight::MarketingDataInsightsAttribute>]
|
|
84
|
+
# Insights for values of a given dimension.
|
|
85
|
+
class MarketingDataInsight
|
|
86
|
+
include ::Google::Protobuf::MessageExts
|
|
87
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
88
|
+
|
|
89
|
+
# Insights for a collection of related attributes of the same dimension.
|
|
90
|
+
# @!attribute [rw] user_interest_id
|
|
91
|
+
# @return [::Integer]
|
|
92
|
+
# The user interest ID.
|
|
93
|
+
# @!attribute [rw] lift
|
|
94
|
+
# @return [::Float]
|
|
95
|
+
# Measure of lift that the audience has for the attribute value as
|
|
96
|
+
# compared to the baseline. Range [0-1].
|
|
97
|
+
# @!attribute [rw] age_range
|
|
98
|
+
# @return [::Google::Ads::DataManager::V1::AgeRange]
|
|
99
|
+
# Age range of the audience for which the lift is provided.
|
|
100
|
+
# @!attribute [rw] gender
|
|
101
|
+
# @return [::Google::Ads::DataManager::V1::Gender]
|
|
102
|
+
# Gender of the audience for which the lift is provided.
|
|
103
|
+
class MarketingDataInsightsAttribute
|
|
104
|
+
include ::Google::Protobuf::MessageExts
|
|
105
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Possible dimensions for use in generating insights.
|
|
109
|
+
module AudienceInsightsDimension
|
|
110
|
+
# Not specified.
|
|
111
|
+
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED = 0
|
|
112
|
+
|
|
113
|
+
# The value is unknown in this version.
|
|
114
|
+
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN = 1
|
|
115
|
+
|
|
116
|
+
# An Affinity UserInterest.
|
|
117
|
+
AFFINITY_USER_INTEREST = 2
|
|
118
|
+
|
|
119
|
+
# An In-Market UserInterest.
|
|
120
|
+
IN_MARKET_USER_INTEREST = 3
|
|
121
|
+
|
|
122
|
+
# An age range.
|
|
123
|
+
AGE_RANGE = 4
|
|
124
|
+
|
|
125
|
+
# A gender.
|
|
126
|
+
GENDER = 5
|
|
127
|
+
end
|
|
128
|
+
end
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
end
|
|
133
|
+
end
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
|
+
#
|
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
# you may not use this file except in compliance with the License.
|
|
7
|
+
# You may obtain a copy of the License at
|
|
8
|
+
#
|
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
|
10
|
+
#
|
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
# See the License for the specific language governing permissions and
|
|
15
|
+
# limitations under the License.
|
|
16
|
+
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
module Google
|
|
21
|
+
module Ads
|
|
22
|
+
module DataManager
|
|
23
|
+
module V1
|
|
24
|
+
# Request to create a {::Google::Ads::DataManager::V1::PartnerLink PartnerLink}
|
|
25
|
+
# resource. Returns a
|
|
26
|
+
# {::Google::Ads::DataManager::V1::PartnerLink PartnerLink}.
|
|
27
|
+
# @!attribute [rw] parent
|
|
28
|
+
# @return [::String]
|
|
29
|
+
# Required. The parent, which owns this collection of partner links.
|
|
30
|
+
# Format: accountTypes/\\{account_type}/accounts/\\{account}
|
|
31
|
+
# @!attribute [rw] partner_link
|
|
32
|
+
# @return [::Google::Ads::DataManager::V1::PartnerLink]
|
|
33
|
+
# Required. The partner link to create.
|
|
34
|
+
class CreatePartnerLinkRequest
|
|
35
|
+
include ::Google::Protobuf::MessageExts
|
|
36
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Request to delete a {::Google::Ads::DataManager::V1::PartnerLink PartnerLink}
|
|
40
|
+
# resource. Returns a {::Google::Protobuf::Empty google.protobuf.Empty}.
|
|
41
|
+
# @!attribute [rw] name
|
|
42
|
+
# @return [::String]
|
|
43
|
+
# Required. The resource name of the partner link to delete.
|
|
44
|
+
# Format:
|
|
45
|
+
# accountTypes/\\{account_type}/accounts/\\{account}/partnerLinks/\\{partner_link}
|
|
46
|
+
class DeletePartnerLinkRequest
|
|
47
|
+
include ::Google::Protobuf::MessageExts
|
|
48
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Request to search for {::Google::Ads::DataManager::V1::PartnerLink PartnerLink}
|
|
52
|
+
# resources. Returns a
|
|
53
|
+
# {::Google::Ads::DataManager::V1::SearchPartnerLinksResponse SearchPartnerLinksResponse}.
|
|
54
|
+
# @!attribute [rw] parent
|
|
55
|
+
# @return [::String]
|
|
56
|
+
# Required. Account to search for partner links. If no `filter` is specified,
|
|
57
|
+
# all partner links where this account is either the `owning_account` or
|
|
58
|
+
# `partner_account` are returned.
|
|
59
|
+
#
|
|
60
|
+
# Format: `accountTypes/{account_type}/accounts/{account}`
|
|
61
|
+
# @!attribute [rw] page_size
|
|
62
|
+
# @return [::Integer]
|
|
63
|
+
# The maximum number of partner links to return. The service may return
|
|
64
|
+
# fewer than this value.
|
|
65
|
+
# If unspecified, at most 10 partner links will be returned.
|
|
66
|
+
# The maximum value is 100; values above 100 will be coerced to 100.
|
|
67
|
+
# @!attribute [rw] page_token
|
|
68
|
+
# @return [::String]
|
|
69
|
+
# A page token, received from a previous `SearchPartnerLinks` call.
|
|
70
|
+
# Provide this to retrieve the subsequent page.
|
|
71
|
+
#
|
|
72
|
+
# When paginating, all other parameters provided to `SearchPartnerLinks`
|
|
73
|
+
# must match the call that provided the page token.
|
|
74
|
+
# @!attribute [rw] filter
|
|
75
|
+
# @return [::String]
|
|
76
|
+
# Optional. A [filter string](https://google.aip.dev/160). All fields need to
|
|
77
|
+
# be on the left hand side of each condition (for example: `partner_link_id =
|
|
78
|
+
# 123456789`). Fields must be specified using either all [camel
|
|
79
|
+
# case](https://en.wikipedia.org/wiki/Camel_case) or all [snake
|
|
80
|
+
# case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of
|
|
81
|
+
# camel case and snake case.
|
|
82
|
+
#
|
|
83
|
+
# Supported operations:
|
|
84
|
+
#
|
|
85
|
+
# - `AND`
|
|
86
|
+
# - `=`
|
|
87
|
+
# - `!=`
|
|
88
|
+
#
|
|
89
|
+
# Supported fields:
|
|
90
|
+
#
|
|
91
|
+
# - `partner_link_id`
|
|
92
|
+
# - `owning_account.account_type`
|
|
93
|
+
# - `owning_account.account_id`
|
|
94
|
+
# - `partner_account.account_type`
|
|
95
|
+
# - `partner_account.account_id`
|
|
96
|
+
#
|
|
97
|
+
# Example:
|
|
98
|
+
# `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id
|
|
99
|
+
# = 987654321`
|
|
100
|
+
class SearchPartnerLinksRequest
|
|
101
|
+
include ::Google::Protobuf::MessageExts
|
|
102
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
# Response from the
|
|
106
|
+
# {::Google::Ads::DataManager::V1::SearchPartnerLinksRequest SearchPartnerLinksRequest}.
|
|
107
|
+
# @!attribute [rw] partner_links
|
|
108
|
+
# @return [::Array<::Google::Ads::DataManager::V1::PartnerLink>]
|
|
109
|
+
# The partner links for the given account.
|
|
110
|
+
# @!attribute [rw] next_page_token
|
|
111
|
+
# @return [::String]
|
|
112
|
+
# A token, which can be sent as `page_token` to retrieve the next page.
|
|
113
|
+
# If this field is omitted, there are no subsequent pages.
|
|
114
|
+
class SearchPartnerLinksResponse
|
|
115
|
+
include ::Google::Protobuf::MessageExts
|
|
116
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# A partner link between an owning account and a partner account.
|
|
120
|
+
# @!attribute [rw] name
|
|
121
|
+
# @return [::String]
|
|
122
|
+
# Identifier. The name of the partner link.
|
|
123
|
+
# Format:
|
|
124
|
+
# accountTypes/\\{account_type}/accounts/\\{account}/partnerLinks/\\{partner_link}
|
|
125
|
+
# @!attribute [r] partner_link_id
|
|
126
|
+
# @return [::String]
|
|
127
|
+
# Output only. The partner link ID.
|
|
128
|
+
# @!attribute [rw] owning_account
|
|
129
|
+
# @return [::Google::Ads::DataManager::V1::ProductAccount]
|
|
130
|
+
# Required. The owning account granting access to the partner account.
|
|
131
|
+
# @!attribute [rw] partner_account
|
|
132
|
+
# @return [::Google::Ads::DataManager::V1::ProductAccount]
|
|
133
|
+
# Required. The partner account granted access by the owning account.
|
|
134
|
+
class PartnerLink
|
|
135
|
+
include ::Google::Protobuf::MessageExts
|
|
136
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
137
|
+
end
|
|
138
|
+
end
|
|
139
|
+
end
|
|
140
|
+
end
|
|
141
|
+
end
|
|
@@ -158,6 +158,9 @@ module Google
|
|
|
158
158
|
# The user attempted to ingest events with an ad identifier that isn't
|
|
159
159
|
# from the operating account's ads.
|
|
160
160
|
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER = 26
|
|
161
|
+
|
|
162
|
+
# One-per-click conversion actions cannot be used with BRAIDs.
|
|
163
|
+
PROCESSING_ERROR_REASON_ONE_PER_CLICK_CONVERSION_ACTION_NOT_PERMITTED_WITH_BRAID = 28
|
|
161
164
|
end
|
|
162
165
|
|
|
163
166
|
# The processing warning reason.
|
|
@@ -185,7 +188,7 @@ module Google
|
|
|
185
188
|
# exist.
|
|
186
189
|
PROCESSING_WARNING_REASON_INVALID_KEK = 6
|
|
187
190
|
|
|
188
|
-
# Failed to decrypt
|
|
191
|
+
# Failed to decrypt the
|
|
189
192
|
# {::Google::Ads::DataManager::V1::UserIdentifier UserIdentifier} data using the
|
|
190
193
|
# DEK.
|
|
191
194
|
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR = 7
|