google-ads-data_manager-v1 0.6.0 → 0.8.1
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 +185 -1
- 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 +187 -1
- data/lib/google/ads/data_manager/v1/ingestion_service/rest/service_stub.rb +121 -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 +8 -1
- data/lib/google/ads/data_manager/v1/partner_link_service/rest/client.rb +8 -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 +36 -0
- 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/device_info_pb.rb +2 -1
- data/lib/google/ads/datamanager/v1/encryption_info_pb.rb +2 -1
- data/lib/google/ads/datamanager/v1/error_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/ingestion_service_pb.rb +8 -1
- data/lib/google/ads/datamanager/v1/ingestion_service_services_pb.rb +9 -1
- data/lib/google/ads/datamanager/v1/partner_link_service_pb.rb +4 -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/datamanager/v1/viewability_info_pb.rb +26 -0
- data/lib/google-ads-data_manager-v1.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/ad_event.rb +405 -0
- 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 +2 -2
- data/proto_docs/google/ads/datamanager/v1/device_info.rb +3 -2
- data/proto_docs/google/ads/datamanager/v1/encryption_info.rb +24 -3
- data/proto_docs/google/ads/datamanager/v1/error.rb +11 -1
- data/proto_docs/google/ads/datamanager/v1/event.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/experimental_field.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/ingestion_service.rb +60 -1
- 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 +62 -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/ads/datamanager/v1/viewability_info.rb +91 -0
- 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 +5 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0c4a133ecbaed63fa287267a932ecaf5a759c0c43e9e69f3bef6e5f00d8ec886
|
|
4
|
+
data.tar.gz: 52e36bc99791e5dfa32403ee148b680c946659053753e29b3754594be0ce7cb5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ace93a31945313a7d50ce33f288052e76ef80ef2fef9d4c7b296df873252578506ce184980e0033b46f275d8086a47a722e11d9bd582f67d8f66e3fcabc98b0a
|
|
7
|
+
data.tar.gz: 267d93d142d0326ad88b1089221de0f2106269f53b6fc7036e4931018464bd56c3cdc6f72d463b30f4d159129bed8ca1368f7852219d761e502076b77ab4a028
|
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.
|
|
@@ -380,6 +380,90 @@ module Google
|
|
|
380
380
|
raise ::Google::Cloud::Error.from_error(e)
|
|
381
381
|
end
|
|
382
382
|
|
|
383
|
+
##
|
|
384
|
+
# Removes all audience members from the provided destinations.
|
|
385
|
+
#
|
|
386
|
+
# @overload remove_all_audience_members(request, options = nil)
|
|
387
|
+
# Pass arguments to `remove_all_audience_members` via a request object, either of type
|
|
388
|
+
# {::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest} or an equivalent Hash.
|
|
389
|
+
#
|
|
390
|
+
# @param request [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest, ::Hash]
|
|
391
|
+
# A request object representing the call parameters. Required. To specify no
|
|
392
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
393
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
394
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
395
|
+
#
|
|
396
|
+
# @overload remove_all_audience_members(destinations: nil, remove_as_of_time: nil, validate_only: nil)
|
|
397
|
+
# Pass arguments to `remove_all_audience_members` via keyword arguments. Note that at
|
|
398
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
399
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
400
|
+
#
|
|
401
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
402
|
+
# Required. The list of destinations to remove the users from.
|
|
403
|
+
# @param remove_as_of_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
404
|
+
# Optional. The remove as of time. If set, only audience members last added
|
|
405
|
+
# before this time will be removed. If not set, it defaults to current time.
|
|
406
|
+
# The remove as of time must not be in the future.
|
|
407
|
+
# @param validate_only [::Boolean]
|
|
408
|
+
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
409
|
+
# executed. Only errors are returned, not results.
|
|
410
|
+
#
|
|
411
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
412
|
+
# @yieldparam response [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
413
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
414
|
+
#
|
|
415
|
+
# @return [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
416
|
+
#
|
|
417
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
418
|
+
#
|
|
419
|
+
# @example Basic example
|
|
420
|
+
# require "google/ads/data_manager/v1"
|
|
421
|
+
#
|
|
422
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
423
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Client.new
|
|
424
|
+
#
|
|
425
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
426
|
+
# request = Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest.new
|
|
427
|
+
#
|
|
428
|
+
# # Call the remove_all_audience_members method.
|
|
429
|
+
# result = client.remove_all_audience_members request
|
|
430
|
+
#
|
|
431
|
+
# # The returned object is of type Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse.
|
|
432
|
+
# p result
|
|
433
|
+
#
|
|
434
|
+
def remove_all_audience_members request, options = nil
|
|
435
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
436
|
+
|
|
437
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest
|
|
438
|
+
|
|
439
|
+
# Converts hash and nil to an options object
|
|
440
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
441
|
+
|
|
442
|
+
# Customize the options with defaults
|
|
443
|
+
metadata = @config.rpcs.remove_all_audience_members.metadata.to_h
|
|
444
|
+
|
|
445
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
446
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
447
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
448
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION
|
|
449
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
450
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
451
|
+
|
|
452
|
+
options.apply_defaults timeout: @config.rpcs.remove_all_audience_members.timeout,
|
|
453
|
+
metadata: metadata,
|
|
454
|
+
retry_policy: @config.rpcs.remove_all_audience_members.retry_policy
|
|
455
|
+
|
|
456
|
+
options.apply_defaults timeout: @config.timeout,
|
|
457
|
+
metadata: @config.metadata,
|
|
458
|
+
retry_policy: @config.retry_policy
|
|
459
|
+
|
|
460
|
+
@ingestion_service_stub.call_rpc :remove_all_audience_members, request, options: options do |response, operation|
|
|
461
|
+
yield response, operation if block_given?
|
|
462
|
+
end
|
|
463
|
+
rescue ::GRPC::BadStatus => e
|
|
464
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
465
|
+
end
|
|
466
|
+
|
|
383
467
|
##
|
|
384
468
|
# Uploads a list of
|
|
385
469
|
# {::Google::Ads::DataManager::V1::Event Event} resources from
|
|
@@ -483,6 +567,92 @@ module Google
|
|
|
483
567
|
raise ::Google::Cloud::Error.from_error(e)
|
|
484
568
|
end
|
|
485
569
|
|
|
570
|
+
##
|
|
571
|
+
# Uploads a list of
|
|
572
|
+
# {::Google::Ads::DataManager::V1::AdEvent AdEvent} resources to Google
|
|
573
|
+
# Analytics.
|
|
574
|
+
#
|
|
575
|
+
# This feature is only available to accounts on an allowlist.
|
|
576
|
+
#
|
|
577
|
+
# @overload ingest_ad_events(request, options = nil)
|
|
578
|
+
# Pass arguments to `ingest_ad_events` via a request object, either of type
|
|
579
|
+
# {::Google::Ads::DataManager::V1::IngestAdEventsRequest} or an equivalent Hash.
|
|
580
|
+
#
|
|
581
|
+
# @param request [::Google::Ads::DataManager::V1::IngestAdEventsRequest, ::Hash]
|
|
582
|
+
# A request object representing the call parameters. Required. To specify no
|
|
583
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
584
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
585
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
586
|
+
#
|
|
587
|
+
# @overload ingest_ad_events(ad_events: nil, encryption_info: nil, validate_only: nil)
|
|
588
|
+
# Pass arguments to `ingest_ad_events` via keyword arguments. Note that at
|
|
589
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
590
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
591
|
+
#
|
|
592
|
+
# @param ad_events [::Array<::Google::Ads::DataManager::V1::AdEvent, ::Hash>]
|
|
593
|
+
# Required. Required (at least 1). A list of ad events.
|
|
594
|
+
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
595
|
+
# Required. Information about encryption keys which are used to encrypt the
|
|
596
|
+
# data.
|
|
597
|
+
# @param validate_only [::Boolean]
|
|
598
|
+
# Optional. If true, the request is validated, but not executed.
|
|
599
|
+
#
|
|
600
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
601
|
+
# @yieldparam response [::Google::Ads::DataManager::V1::IngestAdEventsResponse]
|
|
602
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
603
|
+
#
|
|
604
|
+
# @return [::Google::Ads::DataManager::V1::IngestAdEventsResponse]
|
|
605
|
+
#
|
|
606
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
607
|
+
#
|
|
608
|
+
# @example Basic example
|
|
609
|
+
# require "google/ads/data_manager/v1"
|
|
610
|
+
#
|
|
611
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
612
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Client.new
|
|
613
|
+
#
|
|
614
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
615
|
+
# request = Google::Ads::DataManager::V1::IngestAdEventsRequest.new
|
|
616
|
+
#
|
|
617
|
+
# # Call the ingest_ad_events method.
|
|
618
|
+
# result = client.ingest_ad_events request
|
|
619
|
+
#
|
|
620
|
+
# # The returned object is of type Google::Ads::DataManager::V1::IngestAdEventsResponse.
|
|
621
|
+
# p result
|
|
622
|
+
#
|
|
623
|
+
def ingest_ad_events request, options = nil
|
|
624
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
625
|
+
|
|
626
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::IngestAdEventsRequest
|
|
627
|
+
|
|
628
|
+
# Converts hash and nil to an options object
|
|
629
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
630
|
+
|
|
631
|
+
# Customize the options with defaults
|
|
632
|
+
metadata = @config.rpcs.ingest_ad_events.metadata.to_h
|
|
633
|
+
|
|
634
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
635
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
636
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
637
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION
|
|
638
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
639
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
640
|
+
|
|
641
|
+
options.apply_defaults timeout: @config.rpcs.ingest_ad_events.timeout,
|
|
642
|
+
metadata: metadata,
|
|
643
|
+
retry_policy: @config.rpcs.ingest_ad_events.retry_policy
|
|
644
|
+
|
|
645
|
+
options.apply_defaults timeout: @config.timeout,
|
|
646
|
+
metadata: @config.metadata,
|
|
647
|
+
retry_policy: @config.retry_policy
|
|
648
|
+
|
|
649
|
+
@ingestion_service_stub.call_rpc :ingest_ad_events, request, options: options do |response, operation|
|
|
650
|
+
yield response, operation if block_given?
|
|
651
|
+
end
|
|
652
|
+
rescue ::GRPC::BadStatus => e
|
|
653
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
654
|
+
end
|
|
655
|
+
|
|
486
656
|
##
|
|
487
657
|
# Gets the status of a request given request id.
|
|
488
658
|
#
|
|
@@ -756,11 +926,21 @@ module Google
|
|
|
756
926
|
#
|
|
757
927
|
attr_reader :remove_audience_members
|
|
758
928
|
##
|
|
929
|
+
# RPC-specific configuration for `remove_all_audience_members`
|
|
930
|
+
# @return [::Gapic::Config::Method]
|
|
931
|
+
#
|
|
932
|
+
attr_reader :remove_all_audience_members
|
|
933
|
+
##
|
|
759
934
|
# RPC-specific configuration for `ingest_events`
|
|
760
935
|
# @return [::Gapic::Config::Method]
|
|
761
936
|
#
|
|
762
937
|
attr_reader :ingest_events
|
|
763
938
|
##
|
|
939
|
+
# RPC-specific configuration for `ingest_ad_events`
|
|
940
|
+
# @return [::Gapic::Config::Method]
|
|
941
|
+
#
|
|
942
|
+
attr_reader :ingest_ad_events
|
|
943
|
+
##
|
|
764
944
|
# RPC-specific configuration for `retrieve_request_status`
|
|
765
945
|
# @return [::Gapic::Config::Method]
|
|
766
946
|
#
|
|
@@ -772,8 +952,12 @@ module Google
|
|
|
772
952
|
@ingest_audience_members = ::Gapic::Config::Method.new ingest_audience_members_config
|
|
773
953
|
remove_audience_members_config = parent_rpcs.remove_audience_members if parent_rpcs.respond_to? :remove_audience_members
|
|
774
954
|
@remove_audience_members = ::Gapic::Config::Method.new remove_audience_members_config
|
|
955
|
+
remove_all_audience_members_config = parent_rpcs.remove_all_audience_members if parent_rpcs.respond_to? :remove_all_audience_members
|
|
956
|
+
@remove_all_audience_members = ::Gapic::Config::Method.new remove_all_audience_members_config
|
|
775
957
|
ingest_events_config = parent_rpcs.ingest_events if parent_rpcs.respond_to? :ingest_events
|
|
776
958
|
@ingest_events = ::Gapic::Config::Method.new ingest_events_config
|
|
959
|
+
ingest_ad_events_config = parent_rpcs.ingest_ad_events if parent_rpcs.respond_to? :ingest_ad_events
|
|
960
|
+
@ingest_ad_events = ::Gapic::Config::Method.new ingest_ad_events_config
|
|
777
961
|
retrieve_request_status_config = parent_rpcs.retrieve_request_status if parent_rpcs.respond_to? :retrieve_request_status
|
|
778
962
|
@retrieve_request_status = ::Gapic::Config::Method.new retrieve_request_status_config
|
|
779
963
|
|
|
@@ -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.
|
|
@@ -375,6 +375,91 @@ module Google
|
|
|
375
375
|
raise ::Google::Cloud::Error.from_error(e)
|
|
376
376
|
end
|
|
377
377
|
|
|
378
|
+
##
|
|
379
|
+
# Removes all audience members from the provided destinations.
|
|
380
|
+
#
|
|
381
|
+
# @overload remove_all_audience_members(request, options = nil)
|
|
382
|
+
# Pass arguments to `remove_all_audience_members` via a request object, either of type
|
|
383
|
+
# {::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest} or an equivalent Hash.
|
|
384
|
+
#
|
|
385
|
+
# @param request [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest, ::Hash]
|
|
386
|
+
# A request object representing the call parameters. Required. To specify no
|
|
387
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
388
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
389
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
390
|
+
#
|
|
391
|
+
# @overload remove_all_audience_members(destinations: nil, remove_as_of_time: nil, validate_only: nil)
|
|
392
|
+
# Pass arguments to `remove_all_audience_members` via keyword arguments. Note that at
|
|
393
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
394
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
395
|
+
#
|
|
396
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
397
|
+
# Required. The list of destinations to remove the users from.
|
|
398
|
+
# @param remove_as_of_time [::Google::Protobuf::Timestamp, ::Hash]
|
|
399
|
+
# Optional. The remove as of time. If set, only audience members last added
|
|
400
|
+
# before this time will be removed. If not set, it defaults to current time.
|
|
401
|
+
# The remove as of time must not be in the future.
|
|
402
|
+
# @param validate_only [::Boolean]
|
|
403
|
+
# Optional. For testing purposes. If `true`, the request is validated but not
|
|
404
|
+
# executed. Only errors are returned, not results.
|
|
405
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
406
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
407
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
408
|
+
#
|
|
409
|
+
# @return [::Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse]
|
|
410
|
+
#
|
|
411
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
412
|
+
#
|
|
413
|
+
# @example Basic example
|
|
414
|
+
# require "google/ads/data_manager/v1"
|
|
415
|
+
#
|
|
416
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
417
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Rest::Client.new
|
|
418
|
+
#
|
|
419
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
420
|
+
# request = Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest.new
|
|
421
|
+
#
|
|
422
|
+
# # Call the remove_all_audience_members method.
|
|
423
|
+
# result = client.remove_all_audience_members request
|
|
424
|
+
#
|
|
425
|
+
# # The returned object is of type Google::Ads::DataManager::V1::RemoveAllAudienceMembersResponse.
|
|
426
|
+
# p result
|
|
427
|
+
#
|
|
428
|
+
def remove_all_audience_members request, options = nil
|
|
429
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
430
|
+
|
|
431
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::RemoveAllAudienceMembersRequest
|
|
432
|
+
|
|
433
|
+
# Converts hash and nil to an options object
|
|
434
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
435
|
+
|
|
436
|
+
# Customize the options with defaults
|
|
437
|
+
call_metadata = @config.rpcs.remove_all_audience_members.metadata.to_h
|
|
438
|
+
|
|
439
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
440
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
441
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
442
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION,
|
|
443
|
+
transports_version_send: [:rest]
|
|
444
|
+
|
|
445
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
446
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
447
|
+
|
|
448
|
+
options.apply_defaults timeout: @config.rpcs.remove_all_audience_members.timeout,
|
|
449
|
+
metadata: call_metadata,
|
|
450
|
+
retry_policy: @config.rpcs.remove_all_audience_members.retry_policy
|
|
451
|
+
|
|
452
|
+
options.apply_defaults timeout: @config.timeout,
|
|
453
|
+
metadata: @config.metadata,
|
|
454
|
+
retry_policy: @config.retry_policy
|
|
455
|
+
|
|
456
|
+
@ingestion_service_stub.remove_all_audience_members request, options do |result, operation|
|
|
457
|
+
yield result, operation if block_given?
|
|
458
|
+
end
|
|
459
|
+
rescue ::Gapic::Rest::Error => e
|
|
460
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
461
|
+
end
|
|
462
|
+
|
|
378
463
|
##
|
|
379
464
|
# Uploads a list of
|
|
380
465
|
# {::Google::Ads::DataManager::V1::Event Event} resources from
|
|
@@ -479,6 +564,93 @@ module Google
|
|
|
479
564
|
raise ::Google::Cloud::Error.from_error(e)
|
|
480
565
|
end
|
|
481
566
|
|
|
567
|
+
##
|
|
568
|
+
# Uploads a list of
|
|
569
|
+
# {::Google::Ads::DataManager::V1::AdEvent AdEvent} resources to Google
|
|
570
|
+
# Analytics.
|
|
571
|
+
#
|
|
572
|
+
# This feature is only available to accounts on an allowlist.
|
|
573
|
+
#
|
|
574
|
+
# @overload ingest_ad_events(request, options = nil)
|
|
575
|
+
# Pass arguments to `ingest_ad_events` via a request object, either of type
|
|
576
|
+
# {::Google::Ads::DataManager::V1::IngestAdEventsRequest} or an equivalent Hash.
|
|
577
|
+
#
|
|
578
|
+
# @param request [::Google::Ads::DataManager::V1::IngestAdEventsRequest, ::Hash]
|
|
579
|
+
# A request object representing the call parameters. Required. To specify no
|
|
580
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
581
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
582
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
583
|
+
#
|
|
584
|
+
# @overload ingest_ad_events(ad_events: nil, encryption_info: nil, validate_only: nil)
|
|
585
|
+
# Pass arguments to `ingest_ad_events` via keyword arguments. Note that at
|
|
586
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
587
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
588
|
+
#
|
|
589
|
+
# @param ad_events [::Array<::Google::Ads::DataManager::V1::AdEvent, ::Hash>]
|
|
590
|
+
# Required. Required (at least 1). A list of ad events.
|
|
591
|
+
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
592
|
+
# Required. Information about encryption keys which are used to encrypt the
|
|
593
|
+
# data.
|
|
594
|
+
# @param validate_only [::Boolean]
|
|
595
|
+
# Optional. If true, the request is validated, but not executed.
|
|
596
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
597
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::IngestAdEventsResponse]
|
|
598
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
599
|
+
#
|
|
600
|
+
# @return [::Google::Ads::DataManager::V1::IngestAdEventsResponse]
|
|
601
|
+
#
|
|
602
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
603
|
+
#
|
|
604
|
+
# @example Basic example
|
|
605
|
+
# require "google/ads/data_manager/v1"
|
|
606
|
+
#
|
|
607
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
608
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Rest::Client.new
|
|
609
|
+
#
|
|
610
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
611
|
+
# request = Google::Ads::DataManager::V1::IngestAdEventsRequest.new
|
|
612
|
+
#
|
|
613
|
+
# # Call the ingest_ad_events method.
|
|
614
|
+
# result = client.ingest_ad_events request
|
|
615
|
+
#
|
|
616
|
+
# # The returned object is of type Google::Ads::DataManager::V1::IngestAdEventsResponse.
|
|
617
|
+
# p result
|
|
618
|
+
#
|
|
619
|
+
def ingest_ad_events request, options = nil
|
|
620
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
621
|
+
|
|
622
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::IngestAdEventsRequest
|
|
623
|
+
|
|
624
|
+
# Converts hash and nil to an options object
|
|
625
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
626
|
+
|
|
627
|
+
# Customize the options with defaults
|
|
628
|
+
call_metadata = @config.rpcs.ingest_ad_events.metadata.to_h
|
|
629
|
+
|
|
630
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
631
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
632
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
633
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION,
|
|
634
|
+
transports_version_send: [:rest]
|
|
635
|
+
|
|
636
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
637
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
638
|
+
|
|
639
|
+
options.apply_defaults timeout: @config.rpcs.ingest_ad_events.timeout,
|
|
640
|
+
metadata: call_metadata,
|
|
641
|
+
retry_policy: @config.rpcs.ingest_ad_events.retry_policy
|
|
642
|
+
|
|
643
|
+
options.apply_defaults timeout: @config.timeout,
|
|
644
|
+
metadata: @config.metadata,
|
|
645
|
+
retry_policy: @config.retry_policy
|
|
646
|
+
|
|
647
|
+
@ingestion_service_stub.ingest_ad_events request, options do |result, operation|
|
|
648
|
+
yield result, operation if block_given?
|
|
649
|
+
end
|
|
650
|
+
rescue ::Gapic::Rest::Error => e
|
|
651
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
652
|
+
end
|
|
653
|
+
|
|
482
654
|
##
|
|
483
655
|
# Gets the status of a request given request id.
|
|
484
656
|
#
|
|
@@ -716,11 +888,21 @@ module Google
|
|
|
716
888
|
#
|
|
717
889
|
attr_reader :remove_audience_members
|
|
718
890
|
##
|
|
891
|
+
# RPC-specific configuration for `remove_all_audience_members`
|
|
892
|
+
# @return [::Gapic::Config::Method]
|
|
893
|
+
#
|
|
894
|
+
attr_reader :remove_all_audience_members
|
|
895
|
+
##
|
|
719
896
|
# RPC-specific configuration for `ingest_events`
|
|
720
897
|
# @return [::Gapic::Config::Method]
|
|
721
898
|
#
|
|
722
899
|
attr_reader :ingest_events
|
|
723
900
|
##
|
|
901
|
+
# RPC-specific configuration for `ingest_ad_events`
|
|
902
|
+
# @return [::Gapic::Config::Method]
|
|
903
|
+
#
|
|
904
|
+
attr_reader :ingest_ad_events
|
|
905
|
+
##
|
|
724
906
|
# RPC-specific configuration for `retrieve_request_status`
|
|
725
907
|
# @return [::Gapic::Config::Method]
|
|
726
908
|
#
|
|
@@ -732,8 +914,12 @@ module Google
|
|
|
732
914
|
@ingest_audience_members = ::Gapic::Config::Method.new ingest_audience_members_config
|
|
733
915
|
remove_audience_members_config = parent_rpcs.remove_audience_members if parent_rpcs.respond_to? :remove_audience_members
|
|
734
916
|
@remove_audience_members = ::Gapic::Config::Method.new remove_audience_members_config
|
|
917
|
+
remove_all_audience_members_config = parent_rpcs.remove_all_audience_members if parent_rpcs.respond_to? :remove_all_audience_members
|
|
918
|
+
@remove_all_audience_members = ::Gapic::Config::Method.new remove_all_audience_members_config
|
|
735
919
|
ingest_events_config = parent_rpcs.ingest_events if parent_rpcs.respond_to? :ingest_events
|
|
736
920
|
@ingest_events = ::Gapic::Config::Method.new ingest_events_config
|
|
921
|
+
ingest_ad_events_config = parent_rpcs.ingest_ad_events if parent_rpcs.respond_to? :ingest_ad_events
|
|
922
|
+
@ingest_ad_events = ::Gapic::Config::Method.new ingest_ad_events_config
|
|
737
923
|
retrieve_request_status_config = parent_rpcs.retrieve_request_status if parent_rpcs.respond_to? :retrieve_request_status
|
|
738
924
|
@retrieve_request_status = ::Gapic::Config::Method.new retrieve_request_status_config
|
|
739
925
|
|
|
@@ -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
|
#
|
|
@@ -193,6 +233,46 @@ module Google
|
|
|
193
233
|
end
|
|
194
234
|
end
|
|
195
235
|
|
|
236
|
+
##
|
|
237
|
+
# Baseline implementation for the ingest_ad_events REST call
|
|
238
|
+
#
|
|
239
|
+
# @param request_pb [::Google::Ads::DataManager::V1::IngestAdEventsRequest]
|
|
240
|
+
# A request object representing the call parameters. Required.
|
|
241
|
+
# @param options [::Gapic::CallOptions]
|
|
242
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
243
|
+
#
|
|
244
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
245
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::IngestAdEventsResponse]
|
|
246
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
247
|
+
#
|
|
248
|
+
# @return [::Google::Ads::DataManager::V1::IngestAdEventsResponse]
|
|
249
|
+
# A result object deserialized from the server's reply
|
|
250
|
+
def ingest_ad_events request_pb, options = nil
|
|
251
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
|
252
|
+
|
|
253
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_ingest_ad_events_request request_pb
|
|
254
|
+
query_string_params = if query_string_params.any?
|
|
255
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
|
256
|
+
else
|
|
257
|
+
{}
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
response = @client_stub.make_http_request(
|
|
261
|
+
verb,
|
|
262
|
+
uri: uri,
|
|
263
|
+
body: body || "",
|
|
264
|
+
params: query_string_params,
|
|
265
|
+
method_name: "ingest_ad_events",
|
|
266
|
+
options: options
|
|
267
|
+
)
|
|
268
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
|
269
|
+
result = ::Google::Ads::DataManager::V1::IngestAdEventsResponse.decode_json response.body, ignore_unknown_fields: true
|
|
270
|
+
catch :response do
|
|
271
|
+
yield result, operation if block_given?
|
|
272
|
+
result
|
|
273
|
+
end
|
|
274
|
+
end
|
|
275
|
+
|
|
196
276
|
##
|
|
197
277
|
# Baseline implementation for the retrieve_request_status REST call
|
|
198
278
|
#
|
|
@@ -273,6 +353,26 @@ module Google
|
|
|
273
353
|
transcoder.transcode request_pb
|
|
274
354
|
end
|
|
275
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
|
+
|
|
276
376
|
##
|
|
277
377
|
# @private
|
|
278
378
|
#
|
|
@@ -293,6 +393,26 @@ module Google
|
|
|
293
393
|
transcoder.transcode request_pb
|
|
294
394
|
end
|
|
295
395
|
|
|
396
|
+
##
|
|
397
|
+
# @private
|
|
398
|
+
#
|
|
399
|
+
# GRPC transcoding helper method for the ingest_ad_events REST call
|
|
400
|
+
#
|
|
401
|
+
# @param request_pb [::Google::Ads::DataManager::V1::IngestAdEventsRequest]
|
|
402
|
+
# A request object representing the call parameters. Required.
|
|
403
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
|
404
|
+
# Uri, Body, Query string parameters
|
|
405
|
+
def self.transcode_ingest_ad_events_request request_pb
|
|
406
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
|
407
|
+
.with_bindings(
|
|
408
|
+
uri_method: :post,
|
|
409
|
+
uri_template: "/v1/adEvents:ingest",
|
|
410
|
+
body: "*",
|
|
411
|
+
matches: []
|
|
412
|
+
)
|
|
413
|
+
transcoder.transcode request_pb
|
|
414
|
+
end
|
|
415
|
+
|
|
296
416
|
##
|
|
297
417
|
# @private
|
|
298
418
|
#
|