google-ads-data_manager-v1 0.7.0 → 0.9.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/README.md +0 -1
- data/lib/google/ads/data_manager/v1/ingestion_service/client.rb +134 -20
- data/lib/google/ads/data_manager/v1/ingestion_service/credentials.rb +1 -1
- data/lib/google/ads/data_manager/v1/ingestion_service/rest/client.rb +135 -20
- data/lib/google/ads/data_manager/v1/ingestion_service/rest/service_stub.rb +61 -1
- data/lib/google/ads/data_manager/v1/ingestion_service/rest.rb +1 -1
- data/lib/google/ads/data_manager/v1/ingestion_service.rb +1 -1
- data/lib/google/ads/data_manager/v1/partner_link_service/client.rb +9 -1
- data/lib/google/ads/data_manager/v1/partner_link_service/rest/client.rb +9 -1
- data/lib/google/ads/data_manager/v1/rest.rb +1 -1
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/client.rb +4 -0
- data/lib/google/ads/data_manager/v1/user_list_direct_license_service/rest/client.rb +4 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/client.rb +8 -0
- data/lib/google/ads/data_manager/v1/user_list_global_license_service/rest/client.rb +8 -0
- data/lib/google/ads/data_manager/v1/user_list_service/client.rb +4 -0
- data/lib/google/ads/data_manager/v1/user_list_service/rest/client.rb +4 -0
- data/lib/google/ads/data_manager/v1/version.rb +1 -1
- data/lib/google/ads/data_manager/v1.rb +1 -1
- data/lib/google/ads/datamanager/v1/ad_event_pb.rb +2 -1
- data/lib/google/ads/datamanager/v1/audience_pb.rb +3 -1
- data/lib/google/ads/datamanager/v1/destination_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/error_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/event_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/ingestion_service_pb.rb +5 -1
- data/lib/google/ads/datamanager/v1/ingestion_service_services_pb.rb +3 -1
- data/lib/google/ads/datamanager/v1/processing_errors_pb.rb +3 -1
- data/lib/google/ads/datamanager/v1/request_status_per_destination_pb.rb +6 -1
- data/lib/google/ads/datamanager/v1/user_data_pb.rb +1 -1
- data/lib/google-ads-data_manager-v1.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/ad_event.rb +7 -2
- data/proto_docs/google/ads/datamanager/v1/audience.rb +41 -9
- data/proto_docs/google/ads/datamanager/v1/cart_data.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/consent.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/destination.rb +8 -2
- data/proto_docs/google/ads/datamanager/v1/device_info.rb +3 -12
- data/proto_docs/google/ads/datamanager/v1/encryption_info.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/error.rb +16 -1
- data/proto_docs/google/ads/datamanager/v1/event.rb +9 -1
- data/proto_docs/google/ads/datamanager/v1/experimental_field.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/ingestion_service.rb +60 -20
- data/proto_docs/google/ads/datamanager/v1/item_parameter.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/match_rate.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/partner_link_service.rb +9 -1
- data/proto_docs/google/ads/datamanager/v1/processing_errors.rb +92 -1
- data/proto_docs/google/ads/datamanager/v1/request_status_per_destination.rb +115 -16
- data/proto_docs/google/ads/datamanager/v1/terms_of_service.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/user_data.rb +30 -1
- data/proto_docs/google/ads/datamanager/v1/user_list.rb +2 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_direct_license_service.rb +4 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_global_license_service.rb +8 -0
- data/proto_docs/google/ads/datamanager/v1/user_list_service.rb +4 -0
- data/proto_docs/google/ads/datamanager/v1/user_properties.rb +1 -1
- data/proto_docs/google/api/client.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +1 -1
- data/proto_docs/google/api/launch_stage.rb +1 -1
- data/proto_docs/google/api/resource.rb +1 -1
- data/proto_docs/google/protobuf/duration.rb +1 -1
- data/proto_docs/google/protobuf/timestamp.rb +8 -7
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 5ba42814ae4a588433714e117d40453df3f9a670090b0bb1f1620cd2b495d550
|
|
4
|
+
data.tar.gz: de1eff386bd10693f20cd8612e7db1d806eaad3b86550a44c2c8c7037c21ec3e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2dbb88078f9c90d22dafa88998e35a9ed30e3b7a5d0393093d5d31744c9facb2559d08b30ee6d6e81e88785c43d4bb27ce9a8af3e39a6f64fba8ab8aebeb6511
|
|
7
|
+
data.tar.gz: 8a4e3dfcd600a9b4059ddd98beacedd08b61a7ea89ecbc83737788fb10b47a02a74473752526ae42ba6d8b05c13bd795fea7757e94467fe9fa416189bf1a591b
|
data/README.md
CHANGED
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
A unified ingestion API for data partners, agencies and advertisers to connect first-party data across Google advertising products.
|
|
4
4
|
|
|
5
|
-
A unified ingestion API for data partners, agencies and advertisers to connect first-party data across Google advertising products.
|
|
6
5
|
|
|
7
6
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
7
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -68,6 +68,26 @@ module Google
|
|
|
68
68
|
end
|
|
69
69
|
default_config = Client::Configuration.new parent_config
|
|
70
70
|
|
|
71
|
+
default_config.rpcs.ingest_audience_members.timeout = 120.0
|
|
72
|
+
default_config.rpcs.ingest_audience_members.retry_policy = {
|
|
73
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
default_config.rpcs.remove_audience_members.timeout = 120.0
|
|
77
|
+
default_config.rpcs.remove_audience_members.retry_policy = {
|
|
78
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
default_config.rpcs.ingest_events.timeout = 120.0
|
|
82
|
+
default_config.rpcs.ingest_events.retry_policy = {
|
|
83
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
default_config.rpcs.retrieve_request_status.timeout = 60.0
|
|
87
|
+
default_config.rpcs.retrieve_request_status.retry_policy = {
|
|
88
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
89
|
+
}
|
|
90
|
+
|
|
71
91
|
default_config
|
|
72
92
|
end
|
|
73
93
|
yield @configure if block_given?
|
|
@@ -215,13 +235,14 @@ module Google
|
|
|
215
235
|
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
216
236
|
# executed. Only errors are returned, not results.
|
|
217
237
|
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
218
|
-
# Optional.
|
|
219
|
-
# uploads. The encoding type
|
|
220
|
-
#
|
|
221
|
-
#
|
|
222
|
-
#
|
|
223
|
-
# hashed string could be encoded in a
|
|
224
|
-
# string. For non `UserData` uploads,
|
|
238
|
+
# Optional. Must be provided for
|
|
239
|
+
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
|
|
240
|
+
# of the user identifiers. For hashed user identifiers, this is the encoding
|
|
241
|
+
# type of the hashed string. For encrypted hashed user identifiers, this is
|
|
242
|
+
# the encoding type of the outer encrypted string, but not necessarily the
|
|
243
|
+
# inner hashed string, meaning the inner hashed string could be encoded in a
|
|
244
|
+
# different way than the outer encrypted string. For non `UserData` uploads,
|
|
245
|
+
# this field is ignored.
|
|
225
246
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
226
247
|
# Optional. Encryption information for
|
|
227
248
|
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
|
|
@@ -314,10 +335,10 @@ module Google
|
|
|
314
335
|
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
315
336
|
# executed. Only errors are returned, not results.
|
|
316
337
|
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
317
|
-
# Optional.
|
|
318
|
-
# uploads. The encoding type
|
|
319
|
-
#
|
|
320
|
-
# this field is ignored.
|
|
338
|
+
# Optional. Must be provided for
|
|
339
|
+
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
|
|
340
|
+
# of the user identifiers. Applies to only the outer encoding for encrypted
|
|
341
|
+
# user identifiers. For non `UserData` uploads, this field is ignored.
|
|
321
342
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
322
343
|
# Optional. Encryption information for
|
|
323
344
|
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
|
|
@@ -380,6 +401,90 @@ module Google
|
|
|
380
401
|
raise ::Google::Cloud::Error.from_error(e)
|
|
381
402
|
end
|
|
382
403
|
|
|
404
|
+
##
|
|
405
|
+
# Removes all audience members from the provided destinations.
|
|
406
|
+
#
|
|
407
|
+
# @overload remove_all_audience_members(request, options = nil)
|
|
408
|
+
# Pass arguments to `remove_all_audience_members` via a request object, either of type
|
|
409
|
+
# {::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest} or an equivalent Hash.
|
|
410
|
+
#
|
|
411
|
+
# @param request [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest, ::Hash]
|
|
412
|
+
# A request object representing the call parameters. Required. To specify no
|
|
413
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
414
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
415
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
416
|
+
#
|
|
417
|
+
# @overload remove_all_audience_members(destinations: nil, remove_as_of_time: nil, validate_only: nil)
|
|
418
|
+
# Pass arguments to `remove_all_audience_members` via keyword arguments. Note that at
|
|
419
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
420
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
421
|
+
#
|
|
422
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
423
|
+
# Required. The list of destinations to remove the users from.
|
|
424
|
+
# @param remove_as_of_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
425
|
+
# Optional. The remove as of time. If set, only audience members last added
|
|
426
|
+
# before this time will be removed. If not set, it defaults to current time.
|
|
427
|
+
# The remove as of time must not be in the future.
|
|
428
|
+
# @param validate_only [::Boolean]
|
|
429
|
+
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
430
|
+
# executed. Only errors are returned, not results.
|
|
431
|
+
#
|
|
432
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
433
|
+
# @yieldparam response [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
434
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
435
|
+
#
|
|
436
|
+
# @return [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
437
|
+
#
|
|
438
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
439
|
+
#
|
|
440
|
+
# @example Basic example
|
|
441
|
+
# require "google/ads/data_manager/v1"
|
|
442
|
+
#
|
|
443
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
444
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Client.new
|
|
445
|
+
#
|
|
446
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
447
|
+
# request = Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest.new
|
|
448
|
+
#
|
|
449
|
+
# # Call the remove_all_audience_members method.
|
|
450
|
+
# result = client.remove_all_audience_members request
|
|
451
|
+
#
|
|
452
|
+
# # The returned object is of type Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse.
|
|
453
|
+
# p result
|
|
454
|
+
#
|
|
455
|
+
def remove_all_audience_members request, options = nil
|
|
456
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
457
|
+
|
|
458
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest
|
|
459
|
+
|
|
460
|
+
# Converts hash and nil to an options object
|
|
461
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
462
|
+
|
|
463
|
+
# Customize the options with defaults
|
|
464
|
+
metadata = @config.rpcs.remove_all_audience_members.metadata.to_h
|
|
465
|
+
|
|
466
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
467
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
468
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
469
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION
|
|
470
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
471
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
472
|
+
|
|
473
|
+
options.apply_defaults timeout: @config.rpcs.remove_all_audience_members.timeout,
|
|
474
|
+
metadata: metadata,
|
|
475
|
+
retry_policy: @config.rpcs.remove_all_audience_members.retry_policy
|
|
476
|
+
|
|
477
|
+
options.apply_defaults timeout: @config.timeout,
|
|
478
|
+
metadata: @config.metadata,
|
|
479
|
+
retry_policy: @config.retry_policy
|
|
480
|
+
|
|
481
|
+
@ingestion_service_stub.call_rpc :remove_all_audience_members, request, options: options do |response, operation|
|
|
482
|
+
yield response, operation if block_given?
|
|
483
|
+
end
|
|
484
|
+
rescue ::GRPC::BadStatus => e
|
|
485
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
486
|
+
end
|
|
487
|
+
|
|
383
488
|
##
|
|
384
489
|
# Uploads a list of
|
|
385
490
|
# {::Google::Ads::DataManager::V1::Event Event} resources from
|
|
@@ -414,13 +519,14 @@ module Google
|
|
|
414
519
|
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
415
520
|
# executed. Only errors are returned, not results.
|
|
416
521
|
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
417
|
-
# Optional.
|
|
418
|
-
# uploads. The encoding type
|
|
419
|
-
#
|
|
420
|
-
#
|
|
421
|
-
#
|
|
422
|
-
# hashed string could be encoded in a
|
|
423
|
-
# string. For non `UserData` uploads,
|
|
522
|
+
# Optional. Must be provided for
|
|
523
|
+
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
|
|
524
|
+
# of the user identifiers. For hashed user identifiers, this is the encoding
|
|
525
|
+
# type of the hashed string. For encrypted hashed user identifiers, this is
|
|
526
|
+
# the encoding type of the outer encrypted string, but not necessarily the
|
|
527
|
+
# inner hashed string, meaning the inner hashed string could be encoded in a
|
|
528
|
+
# different way than the outer encrypted string. For non `UserData` uploads,
|
|
529
|
+
# this field is ignored.
|
|
424
530
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
425
531
|
# Optional. Encryption information for
|
|
426
532
|
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
|
|
@@ -509,7 +615,8 @@ module Google
|
|
|
509
615
|
# Required. Required (at least 1). A list of ad events.
|
|
510
616
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
511
617
|
# Optional. Information about encryption keys which are used to encrypt the
|
|
512
|
-
# data.
|
|
618
|
+
# data. This field must be provided when ad events contain
|
|
619
|
+
# {::Google::Ads::DataManager::V1::UserData UserData}.
|
|
513
620
|
# @param validate_only [::Boolean]
|
|
514
621
|
# Optional. If true, the request is validated, but not executed.
|
|
515
622
|
#
|
|
@@ -842,6 +949,11 @@ module Google
|
|
|
842
949
|
#
|
|
843
950
|
attr_reader :remove_audience_members
|
|
844
951
|
##
|
|
952
|
+
# RPC-specific configuration for `remove_all_audience_members`
|
|
953
|
+
# @return [::Gapic::Config::Method]
|
|
954
|
+
#
|
|
955
|
+
attr_reader :remove_all_audience_members
|
|
956
|
+
##
|
|
845
957
|
# RPC-specific configuration for `ingest_events`
|
|
846
958
|
# @return [::Gapic::Config::Method]
|
|
847
959
|
#
|
|
@@ -863,6 +975,8 @@ module Google
|
|
|
863
975
|
@ingest_audience_members = ::Gapic::Config::Method.new ingest_audience_members_config
|
|
864
976
|
remove_audience_members_config = parent_rpcs.remove_audience_members if parent_rpcs.respond_to? :remove_audience_members
|
|
865
977
|
@remove_audience_members = ::Gapic::Config::Method.new remove_audience_members_config
|
|
978
|
+
remove_all_audience_members_config = parent_rpcs.remove_all_audience_members if parent_rpcs.respond_to? :remove_all_audience_members
|
|
979
|
+
@remove_all_audience_members = ::Gapic::Config::Method.new remove_all_audience_members_config
|
|
866
980
|
ingest_events_config = parent_rpcs.ingest_events if parent_rpcs.respond_to? :ingest_events
|
|
867
981
|
@ingest_events = ::Gapic::Config::Method.new ingest_events_config
|
|
868
982
|
ingest_ad_events_config = parent_rpcs.ingest_ad_events if parent_rpcs.respond_to? :ingest_ad_events
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -70,6 +70,26 @@ module Google
|
|
|
70
70
|
end
|
|
71
71
|
default_config = Client::Configuration.new parent_config
|
|
72
72
|
|
|
73
|
+
default_config.rpcs.ingest_audience_members.timeout = 120.0
|
|
74
|
+
default_config.rpcs.ingest_audience_members.retry_policy = {
|
|
75
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
default_config.rpcs.remove_audience_members.timeout = 120.0
|
|
79
|
+
default_config.rpcs.remove_audience_members.retry_policy = {
|
|
80
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
default_config.rpcs.ingest_events.timeout = 120.0
|
|
84
|
+
default_config.rpcs.ingest_events.retry_policy = {
|
|
85
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
default_config.rpcs.retrieve_request_status.timeout = 60.0
|
|
89
|
+
default_config.rpcs.retrieve_request_status.retry_policy = {
|
|
90
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
91
|
+
}
|
|
92
|
+
|
|
73
93
|
default_config
|
|
74
94
|
end
|
|
75
95
|
yield @configure if block_given?
|
|
@@ -208,13 +228,14 @@ module Google
|
|
|
208
228
|
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
209
229
|
# executed. Only errors are returned, not results.
|
|
210
230
|
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
211
|
-
# Optional.
|
|
212
|
-
# uploads. The encoding type
|
|
213
|
-
#
|
|
214
|
-
#
|
|
215
|
-
#
|
|
216
|
-
# hashed string could be encoded in a
|
|
217
|
-
# string. For non `UserData` uploads,
|
|
231
|
+
# Optional. Must be provided for
|
|
232
|
+
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
|
|
233
|
+
# of the user identifiers. For hashed user identifiers, this is the encoding
|
|
234
|
+
# type of the hashed string. For encrypted hashed user identifiers, this is
|
|
235
|
+
# the encoding type of the outer encrypted string, but not necessarily the
|
|
236
|
+
# inner hashed string, meaning the inner hashed string could be encoded in a
|
|
237
|
+
# different way than the outer encrypted string. For non `UserData` uploads,
|
|
238
|
+
# this field is ignored.
|
|
218
239
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
219
240
|
# Optional. Encryption information for
|
|
220
241
|
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
|
|
@@ -308,10 +329,10 @@ module Google
|
|
|
308
329
|
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
309
330
|
# executed. Only errors are returned, not results.
|
|
310
331
|
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
311
|
-
# Optional.
|
|
312
|
-
# uploads. The encoding type
|
|
313
|
-
#
|
|
314
|
-
# this field is ignored.
|
|
332
|
+
# Optional. Must be provided for
|
|
333
|
+
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
|
|
334
|
+
# of the user identifiers. Applies to only the outer encoding for encrypted
|
|
335
|
+
# user identifiers. For non `UserData` uploads, this field is ignored.
|
|
315
336
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
316
337
|
# Optional. Encryption information for
|
|
317
338
|
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
|
|
@@ -375,6 +396,91 @@ module Google
|
|
|
375
396
|
raise ::Google::Cloud::Error.from_error(e)
|
|
376
397
|
end
|
|
377
398
|
|
|
399
|
+
##
|
|
400
|
+
# Removes all audience members from the provided destinations.
|
|
401
|
+
#
|
|
402
|
+
# @overload remove_all_audience_members(request, options = nil)
|
|
403
|
+
# Pass arguments to `remove_all_audience_members` via a request object, either of type
|
|
404
|
+
# {::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest} or an equivalent Hash.
|
|
405
|
+
#
|
|
406
|
+
# @param request [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest, ::Hash]
|
|
407
|
+
# A request object representing the call parameters. Required. To specify no
|
|
408
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
409
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
410
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
411
|
+
#
|
|
412
|
+
# @overload remove_all_audience_members(destinations: nil, remove_as_of_time: nil, validate_only: nil)
|
|
413
|
+
# Pass arguments to `remove_all_audience_members` via keyword arguments. Note that at
|
|
414
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
415
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
416
|
+
#
|
|
417
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
418
|
+
# Required. The list of destinations to remove the users from.
|
|
419
|
+
# @param remove_as_of_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
420
|
+
# Optional. The remove as of time. If set, only audience members last added
|
|
421
|
+
# before this time will be removed. If not set, it defaults to current time.
|
|
422
|
+
# The remove as of time must not be in the future.
|
|
423
|
+
# @param validate_only [::Boolean]
|
|
424
|
+
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
425
|
+
# executed. Only errors are returned, not results.
|
|
426
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
427
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
428
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
429
|
+
#
|
|
430
|
+
# @return [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
431
|
+
#
|
|
432
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
433
|
+
#
|
|
434
|
+
# @example Basic example
|
|
435
|
+
# require "google/ads/data_manager/v1"
|
|
436
|
+
#
|
|
437
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
438
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Rest::Client.new
|
|
439
|
+
#
|
|
440
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
441
|
+
# request = Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest.new
|
|
442
|
+
#
|
|
443
|
+
# # Call the remove_all_audience_members method.
|
|
444
|
+
# result = client.remove_all_audience_members request
|
|
445
|
+
#
|
|
446
|
+
# # The returned object is of type Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse.
|
|
447
|
+
# p result
|
|
448
|
+
#
|
|
449
|
+
def remove_all_audience_members request, options = nil
|
|
450
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
451
|
+
|
|
452
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest
|
|
453
|
+
|
|
454
|
+
# Converts hash and nil to an options object
|
|
455
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
456
|
+
|
|
457
|
+
# Customize the options with defaults
|
|
458
|
+
call_metadata = @config.rpcs.remove_all_audience_members.metadata.to_h
|
|
459
|
+
|
|
460
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
461
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
462
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
463
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION,
|
|
464
|
+
transports_version_send: [:rest]
|
|
465
|
+
|
|
466
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
467
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
468
|
+
|
|
469
|
+
options.apply_defaults timeout: @config.rpcs.remove_all_audience_members.timeout,
|
|
470
|
+
metadata: call_metadata,
|
|
471
|
+
retry_policy: @config.rpcs.remove_all_audience_members.retry_policy
|
|
472
|
+
|
|
473
|
+
options.apply_defaults timeout: @config.timeout,
|
|
474
|
+
metadata: @config.metadata,
|
|
475
|
+
retry_policy: @config.retry_policy
|
|
476
|
+
|
|
477
|
+
@ingestion_service_stub.remove_all_audience_members request, options do |result, operation|
|
|
478
|
+
yield result, operation if block_given?
|
|
479
|
+
end
|
|
480
|
+
rescue ::Gapic::Rest::Error => e
|
|
481
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
482
|
+
end
|
|
483
|
+
|
|
378
484
|
##
|
|
379
485
|
# Uploads a list of
|
|
380
486
|
# {::Google::Ads::DataManager::V1::Event Event} resources from
|
|
@@ -409,13 +515,14 @@ module Google
|
|
|
409
515
|
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
410
516
|
# executed. Only errors are returned, not results.
|
|
411
517
|
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
412
|
-
# Optional.
|
|
413
|
-
# uploads. The encoding type
|
|
414
|
-
#
|
|
415
|
-
#
|
|
416
|
-
#
|
|
417
|
-
# hashed string could be encoded in a
|
|
418
|
-
# string. For non `UserData` uploads,
|
|
518
|
+
# Optional. Must be provided for
|
|
519
|
+
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
|
|
520
|
+
# of the user identifiers. For hashed user identifiers, this is the encoding
|
|
521
|
+
# type of the hashed string. For encrypted hashed user identifiers, this is
|
|
522
|
+
# the encoding type of the outer encrypted string, but not necessarily the
|
|
523
|
+
# inner hashed string, meaning the inner hashed string could be encoded in a
|
|
524
|
+
# different way than the outer encrypted string. For non `UserData` uploads,
|
|
525
|
+
# this field is ignored.
|
|
419
526
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
420
527
|
# Optional. Encryption information for
|
|
421
528
|
# {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
|
|
@@ -505,7 +612,8 @@ module Google
|
|
|
505
612
|
# Required. Required (at least 1). A list of ad events.
|
|
506
613
|
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
507
614
|
# Optional. Information about encryption keys which are used to encrypt the
|
|
508
|
-
# data.
|
|
615
|
+
# data. This field must be provided when ad events contain
|
|
616
|
+
# {::Google::Ads::DataManager::V1::UserData UserData}.
|
|
509
617
|
# @param validate_only [::Boolean]
|
|
510
618
|
# Optional. If true, the request is validated, but not executed.
|
|
511
619
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
@@ -803,6 +911,11 @@ module Google
|
|
|
803
911
|
#
|
|
804
912
|
attr_reader :remove_audience_members
|
|
805
913
|
##
|
|
914
|
+
# RPC-specific configuration for `remove_all_audience_members`
|
|
915
|
+
# @return [::Gapic::Config::Method]
|
|
916
|
+
#
|
|
917
|
+
attr_reader :remove_all_audience_members
|
|
918
|
+
##
|
|
806
919
|
# RPC-specific configuration for `ingest_events`
|
|
807
920
|
# @return [::Gapic::Config::Method]
|
|
808
921
|
#
|
|
@@ -824,6 +937,8 @@ module Google
|
|
|
824
937
|
@ingest_audience_members = ::Gapic::Config::Method.new ingest_audience_members_config
|
|
825
938
|
remove_audience_members_config = parent_rpcs.remove_audience_members if parent_rpcs.respond_to? :remove_audience_members
|
|
826
939
|
@remove_audience_members = ::Gapic::Config::Method.new remove_audience_members_config
|
|
940
|
+
remove_all_audience_members_config = parent_rpcs.remove_all_audience_members if parent_rpcs.respond_to? :remove_all_audience_members
|
|
941
|
+
@remove_all_audience_members = ::Gapic::Config::Method.new remove_all_audience_members_config
|
|
827
942
|
ingest_events_config = parent_rpcs.ingest_events if parent_rpcs.respond_to? :ingest_events
|
|
828
943
|
@ingest_events = ::Gapic::Config::Method.new ingest_events_config
|
|
829
944
|
ingest_ad_events_config = parent_rpcs.ingest_ad_events if parent_rpcs.respond_to? :ingest_ad_events
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
# Copyright
|
|
3
|
+
# Copyright 2026 Google LLC
|
|
4
4
|
#
|
|
5
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
# you may not use this file except in compliance with the License.
|
|
@@ -153,6 +153,46 @@ module Google
|
|
|
153
153
|
end
|
|
154
154
|
end
|
|
155
155
|
|
|
156
|
+
##
|
|
157
|
+
# Baseline implementation for the remove_all_audience_members REST call
|
|
158
|
+
#
|
|
159
|
+
# @param request_pb [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest]
|
|
160
|
+
# A request object representing the call parameters. Required.
|
|
161
|
+
# @param options [::Gapic::CallOptions]
|
|
162
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
163
|
+
#
|
|
164
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
165
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
166
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
167
|
+
#
|
|
168
|
+
# @return [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
169
|
+
# A result object deserialized from the server's reply
|
|
170
|
+
def remove_all_audience_members request_pb, options = nil
|
|
171
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
|
172
|
+
|
|
173
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_remove_all_audience_members_request request_pb
|
|
174
|
+
query_string_params = if query_string_params.any?
|
|
175
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
|
176
|
+
else
|
|
177
|
+
{}
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
response = @client_stub.make_http_request(
|
|
181
|
+
verb,
|
|
182
|
+
uri: uri,
|
|
183
|
+
body: body || "",
|
|
184
|
+
params: query_string_params,
|
|
185
|
+
method_name: "remove_all_audience_members",
|
|
186
|
+
options: options
|
|
187
|
+
)
|
|
188
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
|
189
|
+
result = ::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse.decode_json response.body, ignore_unknown_fields: true
|
|
190
|
+
catch :response do
|
|
191
|
+
yield result, operation if block_given?
|
|
192
|
+
result
|
|
193
|
+
end
|
|
194
|
+
end
|
|
195
|
+
|
|
156
196
|
##
|
|
157
197
|
# Baseline implementation for the ingest_events REST call
|
|
158
198
|
#
|
|
@@ -313,6 +353,26 @@ module Google
|
|
|
313
353
|
transcoder.transcode request_pb
|
|
314
354
|
end
|
|
315
355
|
|
|
356
|
+
##
|
|
357
|
+
# @private
|
|
358
|
+
#
|
|
359
|
+
# GRPC transcoding helper method for the remove_all_audience_members REST call
|
|
360
|
+
#
|
|
361
|
+
# @param request_pb [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest]
|
|
362
|
+
# A request object representing the call parameters. Required.
|
|
363
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
|
364
|
+
# Uri, Body, Query string parameters
|
|
365
|
+
def self.transcode_remove_all_audience_members_request request_pb
|
|
366
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
|
367
|
+
.with_bindings(
|
|
368
|
+
uri_method: :post,
|
|
369
|
+
uri_template: "/v1/audienceMembers:removeAll",
|
|
370
|
+
body: "*",
|
|
371
|
+
matches: []
|
|
372
|
+
)
|
|
373
|
+
transcoder.transcode request_pb
|
|
374
|
+
end
|
|
375
|
+
|
|
316
376
|
##
|
|
317
377
|
# @private
|
|
318
378
|
#
|
|
@@ -415,7 +415,7 @@ module Google
|
|
|
415
415
|
# @param page_size [::Integer]
|
|
416
416
|
# The maximum number of partner links to return. The service may return
|
|
417
417
|
# fewer than this value.
|
|
418
|
-
# If unspecified, at most
|
|
418
|
+
# If unspecified, at most 50 partner links will be returned.
|
|
419
419
|
# The maximum value is 100; values above 100 will be coerced to 100.
|
|
420
420
|
# @param page_token [::String]
|
|
421
421
|
# A page token, received from a previous `SearchPartnerLinks` call.
|
|
@@ -444,6 +444,14 @@ module Google
|
|
|
444
444
|
# - `owning_account.account_id`
|
|
445
445
|
# - `partner_account.account_type`
|
|
446
446
|
# - `partner_account.account_id`
|
|
447
|
+
# - `feature_set`
|
|
448
|
+
#
|
|
449
|
+
# For partner links with the
|
|
450
|
+
# {::Google::Ads::DataManager::V1::FeatureSet::FEATURE_SET_AD_EVENT_MANAGEMENT FEATURE_SET_AD_EVENT_MANAGEMENT}
|
|
451
|
+
# feature set, the following fields are also supported:
|
|
452
|
+
#
|
|
453
|
+
# - `partner_customer_account.account_id`
|
|
454
|
+
# - `partner_link_metadata.implicit_accounts.account_id`
|
|
447
455
|
#
|
|
448
456
|
# Example:
|
|
449
457
|
# `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id
|
|
@@ -394,7 +394,7 @@ module Google
|
|
|
394
394
|
# @param page_size [::Integer]
|
|
395
395
|
# The maximum number of partner links to return. The service may return
|
|
396
396
|
# fewer than this value.
|
|
397
|
-
# If unspecified, at most
|
|
397
|
+
# If unspecified, at most 50 partner links will be returned.
|
|
398
398
|
# The maximum value is 100; values above 100 will be coerced to 100.
|
|
399
399
|
# @param page_token [::String]
|
|
400
400
|
# A page token, received from a previous `SearchPartnerLinks` call.
|
|
@@ -423,6 +423,14 @@ module Google
|
|
|
423
423
|
# - `owning_account.account_id`
|
|
424
424
|
# - `partner_account.account_type`
|
|
425
425
|
# - `partner_account.account_id`
|
|
426
|
+
# - `feature_set`
|
|
427
|
+
#
|
|
428
|
+
# For partner links with the
|
|
429
|
+
# {::Google::Ads::DataManager::V1::FeatureSet::FEATURE_SET_AD_EVENT_MANAGEMENT FEATURE_SET_AD_EVENT_MANAGEMENT}
|
|
430
|
+
# feature set, the following fields are also supported:
|
|
431
|
+
#
|
|
432
|
+
# - `partner_customer_account.account_id`
|
|
433
|
+
# - `partner_link_metadata.implicit_accounts.account_id`
|
|
426
434
|
#
|
|
427
435
|
# Example:
|
|
428
436
|
# `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id
|
|
@@ -496,6 +496,10 @@ module Google
|
|
|
496
496
|
# - `<`
|
|
497
497
|
# - `<=`
|
|
498
498
|
#
|
|
499
|
+
# **Supported Functions:**
|
|
500
|
+
# - `IN(field, value1, value2, ...)`: returns true if the field matches any
|
|
501
|
+
# of the values. Example: `IN(user_list_id, 123, 456)`
|
|
502
|
+
#
|
|
499
503
|
# **Unsupported Fields:**
|
|
500
504
|
#
|
|
501
505
|
# - `name` (use get method instead)
|
|
@@ -468,6 +468,10 @@ module Google
|
|
|
468
468
|
# - `<`
|
|
469
469
|
# - `<=`
|
|
470
470
|
#
|
|
471
|
+
# **Supported Functions:**
|
|
472
|
+
# - `IN(field, value1, value2, ...)`: returns true if the field matches any
|
|
473
|
+
# of the values. Example: `IN(user_list_id, 123, 456)`
|
|
474
|
+
#
|
|
471
475
|
# **Unsupported Fields:**
|
|
472
476
|
#
|
|
473
477
|
# - `name` (use get method instead)
|