google-ads-data_manager-v1 0.9.0 → 0.11.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/ingestion_service/client.rb +208 -0
- data/lib/google/ads/data_manager/v1/ingestion_service/rest/client.rb +210 -0
- data/lib/google/ads/data_manager/v1/ingestion_service/rest/service_stub.rb +120 -0
- data/lib/google/ads/data_manager/v1/version.rb +1 -1
- data/lib/google/ads/datamanager/v1/ad_event_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/audience_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/cart_data_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/consent_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/destination_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/device_info_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/encrypted_user_id_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/encryption_info_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/experimental_field_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/ingestion_service_pb.rb +7 -1
- data/lib/google/ads/datamanager/v1/ingestion_service_services_pb.rb +13 -0
- data/lib/google/ads/datamanager/v1/insights_service_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/item_parameter_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/partner_link_service_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/terms_of_service_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_data_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_direct_license_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_direct_license_service_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_global_license_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_global_license_service_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_license_metrics_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_license_pricing_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_list_service_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/user_pb.rb +25 -0
- data/lib/google/ads/datamanager/v1/user_properties_pb.rb +1 -1
- data/lib/google/ads/datamanager/v1/viewability_info_pb.rb +1 -1
- data/proto_docs/google/ads/datamanager/v1/error.rb +13 -0
- data/proto_docs/google/ads/datamanager/v1/ingestion_service.rb +65 -0
- data/proto_docs/google/ads/datamanager/v1/user.rb +40 -0
- metadata +5 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 046d8780ef7a01f1a08c30efe6de712d072997bf5570b33877ad977b84635b64
|
|
4
|
+
data.tar.gz: bcc59ab71c520a6c3d3265e714b246297606392d853745acf2adbbc9084f2447
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 499db806bba87433e7e0db813070b636942883f3ab6cd5a72fa53cbaff97370f1453b9a08d685782dbf714765df1ee3ce2b394176077d3fac3cd4d1140df6f11
|
|
7
|
+
data.tar.gz: 4ba223b7aad1c9b6177e3ea61b7164e0bfa5ea133b227a2e4f3d8fa78ee21a1e19b3d89f515b24c4a8b4cf85179c004d31190c0747bbc87257e179c214972bc5
|
|
@@ -83,6 +83,16 @@ module Google
|
|
|
83
83
|
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
84
84
|
}
|
|
85
85
|
|
|
86
|
+
default_config.rpcs.ingest_users.timeout = 120.0
|
|
87
|
+
default_config.rpcs.ingest_users.retry_policy = {
|
|
88
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
default_config.rpcs.remove_users.timeout = 120.0
|
|
92
|
+
default_config.rpcs.remove_users.retry_policy = {
|
|
93
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
94
|
+
}
|
|
95
|
+
|
|
86
96
|
default_config.rpcs.retrieve_request_status.timeout = 60.0
|
|
87
97
|
default_config.rpcs.retrieve_request_status.retry_policy = {
|
|
88
98
|
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
@@ -589,6 +599,190 @@ module Google
|
|
|
589
599
|
raise ::Google::Cloud::Error.from_error(e)
|
|
590
600
|
end
|
|
591
601
|
|
|
602
|
+
##
|
|
603
|
+
# Uploads a list of users to the provided destinations. Unlike
|
|
604
|
+
# {::Google::Ads::DataManager::V1::IngestionService::Client#ingest_audience_members IngestAudienceMembers}
|
|
605
|
+
# (which adds users to specific advertiser audience lists for targeting),
|
|
606
|
+
# `IngestUsers` ingests account level identity linkage data (for example,
|
|
607
|
+
# user identifiers linked to mobile IDs) independent of specific audience
|
|
608
|
+
# segments.
|
|
609
|
+
#
|
|
610
|
+
# This feature is only available to accounts on an allowlist.
|
|
611
|
+
#
|
|
612
|
+
# @overload ingest_users(request, options = nil)
|
|
613
|
+
# Pass arguments to `ingest_users` via a request object, either of type
|
|
614
|
+
# {::Google::Ads::DataManager::V1::IngestUsersRequest} or an equivalent Hash.
|
|
615
|
+
#
|
|
616
|
+
# @param request [::Google::Ads::DataManager::V1::IngestUsersRequest, ::Hash]
|
|
617
|
+
# A request object representing the call parameters. Required. To specify no
|
|
618
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
619
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
620
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
621
|
+
#
|
|
622
|
+
# @overload ingest_users(destinations: nil, users: nil, encryption_info: nil, validate_only: nil, encoding: nil)
|
|
623
|
+
# Pass arguments to `ingest_users` via keyword arguments. Note that at
|
|
624
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
625
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
626
|
+
#
|
|
627
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
628
|
+
# Required. The list of possible ingestion destinations.
|
|
629
|
+
# @param users [::Array<::Google::Ads::DataManager::V1::User, ::Hash>]
|
|
630
|
+
# Required. The list of users to ingest.
|
|
631
|
+
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
632
|
+
# Optional. Encryption information about encryption keys which are used to
|
|
633
|
+
# encrypt the data.
|
|
634
|
+
# @param validate_only [::Boolean]
|
|
635
|
+
# Optional. If `true`, the request is validated but not executed.
|
|
636
|
+
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
637
|
+
# Required. The encoding type of the user identifiers. For encrypted user
|
|
638
|
+
# identifiers, this only applies to the outer encoding.
|
|
639
|
+
#
|
|
640
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
641
|
+
# @yieldparam response [::Google::Ads::DataManager::V1::IngestUsersResponse]
|
|
642
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
643
|
+
#
|
|
644
|
+
# @return [::Google::Ads::DataManager::V1::IngestUsersResponse]
|
|
645
|
+
#
|
|
646
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
647
|
+
#
|
|
648
|
+
# @example Basic example
|
|
649
|
+
# require "google/ads/data_manager/v1"
|
|
650
|
+
#
|
|
651
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
652
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Client.new
|
|
653
|
+
#
|
|
654
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
655
|
+
# request = Google::Ads::DataManager::V1::IngestUsersRequest.new
|
|
656
|
+
#
|
|
657
|
+
# # Call the ingest_users method.
|
|
658
|
+
# result = client.ingest_users request
|
|
659
|
+
#
|
|
660
|
+
# # The returned object is of type Google::Ads::DataManager::V1::IngestUsersResponse.
|
|
661
|
+
# p result
|
|
662
|
+
#
|
|
663
|
+
def ingest_users request, options = nil
|
|
664
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
665
|
+
|
|
666
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::IngestUsersRequest
|
|
667
|
+
|
|
668
|
+
# Converts hash and nil to an options object
|
|
669
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
670
|
+
|
|
671
|
+
# Customize the options with defaults
|
|
672
|
+
metadata = @config.rpcs.ingest_users.metadata.to_h
|
|
673
|
+
|
|
674
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
675
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
676
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
677
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION
|
|
678
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
679
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
680
|
+
|
|
681
|
+
options.apply_defaults timeout: @config.rpcs.ingest_users.timeout,
|
|
682
|
+
metadata: metadata,
|
|
683
|
+
retry_policy: @config.rpcs.ingest_users.retry_policy
|
|
684
|
+
|
|
685
|
+
options.apply_defaults timeout: @config.timeout,
|
|
686
|
+
metadata: @config.metadata,
|
|
687
|
+
retry_policy: @config.retry_policy
|
|
688
|
+
|
|
689
|
+
@ingestion_service_stub.call_rpc :ingest_users, request, options: options do |response, operation|
|
|
690
|
+
yield response, operation if block_given?
|
|
691
|
+
end
|
|
692
|
+
rescue ::GRPC::BadStatus => e
|
|
693
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
694
|
+
end
|
|
695
|
+
|
|
696
|
+
##
|
|
697
|
+
# Removes a list of users from the provided destinations.
|
|
698
|
+
#
|
|
699
|
+
# This feature is only available to accounts on an allowlist.
|
|
700
|
+
#
|
|
701
|
+
# @overload remove_users(request, options = nil)
|
|
702
|
+
# Pass arguments to `remove_users` via a request object, either of type
|
|
703
|
+
# {::Google::Ads::DataManager::V1::RemoveUsersRequest} or an equivalent Hash.
|
|
704
|
+
#
|
|
705
|
+
# @param request [::Google::Ads::DataManager::V1::RemoveUsersRequest, ::Hash]
|
|
706
|
+
# A request object representing the call parameters. Required. To specify no
|
|
707
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
708
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
709
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
710
|
+
#
|
|
711
|
+
# @overload remove_users(destinations: nil, user_data: nil, encryption_info: nil, validate_only: nil, encoding: nil)
|
|
712
|
+
# Pass arguments to `remove_users` via keyword arguments. Note that at
|
|
713
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
714
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
715
|
+
#
|
|
716
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
717
|
+
# Required. The list of possible ingestion destinations.
|
|
718
|
+
# @param user_data [::Array<::Google::Ads::DataManager::V1::UserData, ::Hash>]
|
|
719
|
+
# Required. The individual bits of UserData that act as keys for the users to
|
|
720
|
+
# remove.
|
|
721
|
+
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
722
|
+
# Optional. Encryption information about encryption keys which are used to
|
|
723
|
+
# encrypt the data.
|
|
724
|
+
# @param validate_only [::Boolean]
|
|
725
|
+
# Optional. If `true`, the request is validated but not executed.
|
|
726
|
+
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
727
|
+
# Required. The encoding type of the user identifiers. For encrypted user
|
|
728
|
+
# identifiers, this only applies to the outer encoding.
|
|
729
|
+
#
|
|
730
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
|
731
|
+
# @yieldparam response [::Google::Ads::DataManager::V1::RemoveUsersResponse]
|
|
732
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
|
733
|
+
#
|
|
734
|
+
# @return [::Google::Ads::DataManager::V1::RemoveUsersResponse]
|
|
735
|
+
#
|
|
736
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
|
737
|
+
#
|
|
738
|
+
# @example Basic example
|
|
739
|
+
# require "google/ads/data_manager/v1"
|
|
740
|
+
#
|
|
741
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
742
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Client.new
|
|
743
|
+
#
|
|
744
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
745
|
+
# request = Google::Ads::DataManager::V1::RemoveUsersRequest.new
|
|
746
|
+
#
|
|
747
|
+
# # Call the remove_users method.
|
|
748
|
+
# result = client.remove_users request
|
|
749
|
+
#
|
|
750
|
+
# # The returned object is of type Google::Ads::DataManager::V1::RemoveUsersResponse.
|
|
751
|
+
# p result
|
|
752
|
+
#
|
|
753
|
+
def remove_users request, options = nil
|
|
754
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
755
|
+
|
|
756
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::RemoveUsersRequest
|
|
757
|
+
|
|
758
|
+
# Converts hash and nil to an options object
|
|
759
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
760
|
+
|
|
761
|
+
# Customize the options with defaults
|
|
762
|
+
metadata = @config.rpcs.remove_users.metadata.to_h
|
|
763
|
+
|
|
764
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
765
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
766
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
767
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION
|
|
768
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
769
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
770
|
+
|
|
771
|
+
options.apply_defaults timeout: @config.rpcs.remove_users.timeout,
|
|
772
|
+
metadata: metadata,
|
|
773
|
+
retry_policy: @config.rpcs.remove_users.retry_policy
|
|
774
|
+
|
|
775
|
+
options.apply_defaults timeout: @config.timeout,
|
|
776
|
+
metadata: @config.metadata,
|
|
777
|
+
retry_policy: @config.retry_policy
|
|
778
|
+
|
|
779
|
+
@ingestion_service_stub.call_rpc :remove_users, request, options: options do |response, operation|
|
|
780
|
+
yield response, operation if block_given?
|
|
781
|
+
end
|
|
782
|
+
rescue ::GRPC::BadStatus => e
|
|
783
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
784
|
+
end
|
|
785
|
+
|
|
592
786
|
##
|
|
593
787
|
# Uploads a list of
|
|
594
788
|
# {::Google::Ads::DataManager::V1::AdEvent AdEvent} resources to Google
|
|
@@ -959,6 +1153,16 @@ module Google
|
|
|
959
1153
|
#
|
|
960
1154
|
attr_reader :ingest_events
|
|
961
1155
|
##
|
|
1156
|
+
# RPC-specific configuration for `ingest_users`
|
|
1157
|
+
# @return [::Gapic::Config::Method]
|
|
1158
|
+
#
|
|
1159
|
+
attr_reader :ingest_users
|
|
1160
|
+
##
|
|
1161
|
+
# RPC-specific configuration for `remove_users`
|
|
1162
|
+
# @return [::Gapic::Config::Method]
|
|
1163
|
+
#
|
|
1164
|
+
attr_reader :remove_users
|
|
1165
|
+
##
|
|
962
1166
|
# RPC-specific configuration for `ingest_ad_events`
|
|
963
1167
|
# @return [::Gapic::Config::Method]
|
|
964
1168
|
#
|
|
@@ -979,6 +1183,10 @@ module Google
|
|
|
979
1183
|
@remove_all_audience_members = ::Gapic::Config::Method.new remove_all_audience_members_config
|
|
980
1184
|
ingest_events_config = parent_rpcs.ingest_events if parent_rpcs.respond_to? :ingest_events
|
|
981
1185
|
@ingest_events = ::Gapic::Config::Method.new ingest_events_config
|
|
1186
|
+
ingest_users_config = parent_rpcs.ingest_users if parent_rpcs.respond_to? :ingest_users
|
|
1187
|
+
@ingest_users = ::Gapic::Config::Method.new ingest_users_config
|
|
1188
|
+
remove_users_config = parent_rpcs.remove_users if parent_rpcs.respond_to? :remove_users
|
|
1189
|
+
@remove_users = ::Gapic::Config::Method.new remove_users_config
|
|
982
1190
|
ingest_ad_events_config = parent_rpcs.ingest_ad_events if parent_rpcs.respond_to? :ingest_ad_events
|
|
983
1191
|
@ingest_ad_events = ::Gapic::Config::Method.new ingest_ad_events_config
|
|
984
1192
|
retrieve_request_status_config = parent_rpcs.retrieve_request_status if parent_rpcs.respond_to? :retrieve_request_status
|
|
@@ -85,6 +85,16 @@ module Google
|
|
|
85
85
|
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
86
86
|
}
|
|
87
87
|
|
|
88
|
+
default_config.rpcs.ingest_users.timeout = 120.0
|
|
89
|
+
default_config.rpcs.ingest_users.retry_policy = {
|
|
90
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
default_config.rpcs.remove_users.timeout = 120.0
|
|
94
|
+
default_config.rpcs.remove_users.retry_policy = {
|
|
95
|
+
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
96
|
+
}
|
|
97
|
+
|
|
88
98
|
default_config.rpcs.retrieve_request_status.timeout = 60.0
|
|
89
99
|
default_config.rpcs.retrieve_request_status.retry_policy = {
|
|
90
100
|
initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
|
|
@@ -586,6 +596,192 @@ module Google
|
|
|
586
596
|
raise ::Google::Cloud::Error.from_error(e)
|
|
587
597
|
end
|
|
588
598
|
|
|
599
|
+
##
|
|
600
|
+
# Uploads a list of users to the provided destinations. Unlike
|
|
601
|
+
# {::Google::Ads::DataManager::V1::IngestionService::Rest::Client#ingest_audience_members IngestAudienceMembers}
|
|
602
|
+
# (which adds users to specific advertiser audience lists for targeting),
|
|
603
|
+
# `IngestUsers` ingests account level identity linkage data (for example,
|
|
604
|
+
# user identifiers linked to mobile IDs) independent of specific audience
|
|
605
|
+
# segments.
|
|
606
|
+
#
|
|
607
|
+
# This feature is only available to accounts on an allowlist.
|
|
608
|
+
#
|
|
609
|
+
# @overload ingest_users(request, options = nil)
|
|
610
|
+
# Pass arguments to `ingest_users` via a request object, either of type
|
|
611
|
+
# {::Google::Ads::DataManager::V1::IngestUsersRequest} or an equivalent Hash.
|
|
612
|
+
#
|
|
613
|
+
# @param request [::Google::Ads::DataManager::V1::IngestUsersRequest, ::Hash]
|
|
614
|
+
# A request object representing the call parameters. Required. To specify no
|
|
615
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
616
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
617
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
618
|
+
#
|
|
619
|
+
# @overload ingest_users(destinations: nil, users: nil, encryption_info: nil, validate_only: nil, encoding: nil)
|
|
620
|
+
# Pass arguments to `ingest_users` via keyword arguments. Note that at
|
|
621
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
622
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
623
|
+
#
|
|
624
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
625
|
+
# Required. The list of possible ingestion destinations.
|
|
626
|
+
# @param users [::Array<::Google::Ads::DataManager::V1::User, ::Hash>]
|
|
627
|
+
# Required. The list of users to ingest.
|
|
628
|
+
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
629
|
+
# Optional. Encryption information about encryption keys which are used to
|
|
630
|
+
# encrypt the data.
|
|
631
|
+
# @param validate_only [::Boolean]
|
|
632
|
+
# Optional. If `true`, the request is validated but not executed.
|
|
633
|
+
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
634
|
+
# Required. The encoding type of the user identifiers. For encrypted user
|
|
635
|
+
# identifiers, this only applies to the outer encoding.
|
|
636
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
637
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::IngestUsersResponse]
|
|
638
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
639
|
+
#
|
|
640
|
+
# @return [::Google::Ads::DataManager::V1::IngestUsersResponse]
|
|
641
|
+
#
|
|
642
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
643
|
+
#
|
|
644
|
+
# @example Basic example
|
|
645
|
+
# require "google/ads/data_manager/v1"
|
|
646
|
+
#
|
|
647
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
648
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Rest::Client.new
|
|
649
|
+
#
|
|
650
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
651
|
+
# request = Google::Ads::DataManager::V1::IngestUsersRequest.new
|
|
652
|
+
#
|
|
653
|
+
# # Call the ingest_users method.
|
|
654
|
+
# result = client.ingest_users request
|
|
655
|
+
#
|
|
656
|
+
# # The returned object is of type Google::Ads::DataManager::V1::IngestUsersResponse.
|
|
657
|
+
# p result
|
|
658
|
+
#
|
|
659
|
+
def ingest_users request, options = nil
|
|
660
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
661
|
+
|
|
662
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::IngestUsersRequest
|
|
663
|
+
|
|
664
|
+
# Converts hash and nil to an options object
|
|
665
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
666
|
+
|
|
667
|
+
# Customize the options with defaults
|
|
668
|
+
call_metadata = @config.rpcs.ingest_users.metadata.to_h
|
|
669
|
+
|
|
670
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
671
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
672
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
673
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION,
|
|
674
|
+
transports_version_send: [:rest]
|
|
675
|
+
|
|
676
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
677
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
678
|
+
|
|
679
|
+
options.apply_defaults timeout: @config.rpcs.ingest_users.timeout,
|
|
680
|
+
metadata: call_metadata,
|
|
681
|
+
retry_policy: @config.rpcs.ingest_users.retry_policy
|
|
682
|
+
|
|
683
|
+
options.apply_defaults timeout: @config.timeout,
|
|
684
|
+
metadata: @config.metadata,
|
|
685
|
+
retry_policy: @config.retry_policy
|
|
686
|
+
|
|
687
|
+
@ingestion_service_stub.ingest_users request, options do |result, operation|
|
|
688
|
+
yield result, operation if block_given?
|
|
689
|
+
end
|
|
690
|
+
rescue ::Gapic::Rest::Error => e
|
|
691
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
692
|
+
end
|
|
693
|
+
|
|
694
|
+
##
|
|
695
|
+
# Removes a list of users from the provided destinations.
|
|
696
|
+
#
|
|
697
|
+
# This feature is only available to accounts on an allowlist.
|
|
698
|
+
#
|
|
699
|
+
# @overload remove_users(request, options = nil)
|
|
700
|
+
# Pass arguments to `remove_users` via a request object, either of type
|
|
701
|
+
# {::Google::Ads::DataManager::V1::RemoveUsersRequest} or an equivalent Hash.
|
|
702
|
+
#
|
|
703
|
+
# @param request [::Google::Ads::DataManager::V1::RemoveUsersRequest, ::Hash]
|
|
704
|
+
# A request object representing the call parameters. Required. To specify no
|
|
705
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
706
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
707
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
708
|
+
#
|
|
709
|
+
# @overload remove_users(destinations: nil, user_data: nil, encryption_info: nil, validate_only: nil, encoding: nil)
|
|
710
|
+
# Pass arguments to `remove_users` via keyword arguments. Note that at
|
|
711
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
712
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
713
|
+
#
|
|
714
|
+
# @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
|
|
715
|
+
# Required. The list of possible ingestion destinations.
|
|
716
|
+
# @param user_data [::Array<::Google::Ads::DataManager::V1::UserData, ::Hash>]
|
|
717
|
+
# Required. The individual bits of UserData that act as keys for the users to
|
|
718
|
+
# remove.
|
|
719
|
+
# @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
|
|
720
|
+
# Optional. Encryption information about encryption keys which are used to
|
|
721
|
+
# encrypt the data.
|
|
722
|
+
# @param validate_only [::Boolean]
|
|
723
|
+
# Optional. If `true`, the request is validated but not executed.
|
|
724
|
+
# @param encoding [::Google::Ads::DataManager::V1::Encoding]
|
|
725
|
+
# Required. The encoding type of the user identifiers. For encrypted user
|
|
726
|
+
# identifiers, this only applies to the outer encoding.
|
|
727
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
728
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::RemoveUsersResponse]
|
|
729
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
730
|
+
#
|
|
731
|
+
# @return [::Google::Ads::DataManager::V1::RemoveUsersResponse]
|
|
732
|
+
#
|
|
733
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
734
|
+
#
|
|
735
|
+
# @example Basic example
|
|
736
|
+
# require "google/ads/data_manager/v1"
|
|
737
|
+
#
|
|
738
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
739
|
+
# client = Google::Ads::DataManager::V1::IngestionService::Rest::Client.new
|
|
740
|
+
#
|
|
741
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
742
|
+
# request = Google::Ads::DataManager::V1::RemoveUsersRequest.new
|
|
743
|
+
#
|
|
744
|
+
# # Call the remove_users method.
|
|
745
|
+
# result = client.remove_users request
|
|
746
|
+
#
|
|
747
|
+
# # The returned object is of type Google::Ads::DataManager::V1::RemoveUsersResponse.
|
|
748
|
+
# p result
|
|
749
|
+
#
|
|
750
|
+
def remove_users request, options = nil
|
|
751
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
752
|
+
|
|
753
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::RemoveUsersRequest
|
|
754
|
+
|
|
755
|
+
# Converts hash and nil to an options object
|
|
756
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
757
|
+
|
|
758
|
+
# Customize the options with defaults
|
|
759
|
+
call_metadata = @config.rpcs.remove_users.metadata.to_h
|
|
760
|
+
|
|
761
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
|
762
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
763
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
764
|
+
gapic_version: ::Google::Ads::DataManager::V1::VERSION,
|
|
765
|
+
transports_version_send: [:rest]
|
|
766
|
+
|
|
767
|
+
call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
|
768
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
769
|
+
|
|
770
|
+
options.apply_defaults timeout: @config.rpcs.remove_users.timeout,
|
|
771
|
+
metadata: call_metadata,
|
|
772
|
+
retry_policy: @config.rpcs.remove_users.retry_policy
|
|
773
|
+
|
|
774
|
+
options.apply_defaults timeout: @config.timeout,
|
|
775
|
+
metadata: @config.metadata,
|
|
776
|
+
retry_policy: @config.retry_policy
|
|
777
|
+
|
|
778
|
+
@ingestion_service_stub.remove_users request, options do |result, operation|
|
|
779
|
+
yield result, operation if block_given?
|
|
780
|
+
end
|
|
781
|
+
rescue ::Gapic::Rest::Error => e
|
|
782
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
783
|
+
end
|
|
784
|
+
|
|
589
785
|
##
|
|
590
786
|
# Uploads a list of
|
|
591
787
|
# {::Google::Ads::DataManager::V1::AdEvent AdEvent} resources to Google
|
|
@@ -921,6 +1117,16 @@ module Google
|
|
|
921
1117
|
#
|
|
922
1118
|
attr_reader :ingest_events
|
|
923
1119
|
##
|
|
1120
|
+
# RPC-specific configuration for `ingest_users`
|
|
1121
|
+
# @return [::Gapic::Config::Method]
|
|
1122
|
+
#
|
|
1123
|
+
attr_reader :ingest_users
|
|
1124
|
+
##
|
|
1125
|
+
# RPC-specific configuration for `remove_users`
|
|
1126
|
+
# @return [::Gapic::Config::Method]
|
|
1127
|
+
#
|
|
1128
|
+
attr_reader :remove_users
|
|
1129
|
+
##
|
|
924
1130
|
# RPC-specific configuration for `ingest_ad_events`
|
|
925
1131
|
# @return [::Gapic::Config::Method]
|
|
926
1132
|
#
|
|
@@ -941,6 +1147,10 @@ module Google
|
|
|
941
1147
|
@remove_all_audience_members = ::Gapic::Config::Method.new remove_all_audience_members_config
|
|
942
1148
|
ingest_events_config = parent_rpcs.ingest_events if parent_rpcs.respond_to? :ingest_events
|
|
943
1149
|
@ingest_events = ::Gapic::Config::Method.new ingest_events_config
|
|
1150
|
+
ingest_users_config = parent_rpcs.ingest_users if parent_rpcs.respond_to? :ingest_users
|
|
1151
|
+
@ingest_users = ::Gapic::Config::Method.new ingest_users_config
|
|
1152
|
+
remove_users_config = parent_rpcs.remove_users if parent_rpcs.respond_to? :remove_users
|
|
1153
|
+
@remove_users = ::Gapic::Config::Method.new remove_users_config
|
|
944
1154
|
ingest_ad_events_config = parent_rpcs.ingest_ad_events if parent_rpcs.respond_to? :ingest_ad_events
|
|
945
1155
|
@ingest_ad_events = ::Gapic::Config::Method.new ingest_ad_events_config
|
|
946
1156
|
retrieve_request_status_config = parent_rpcs.retrieve_request_status if parent_rpcs.respond_to? :retrieve_request_status
|
|
@@ -233,6 +233,86 @@ module Google
|
|
|
233
233
|
end
|
|
234
234
|
end
|
|
235
235
|
|
|
236
|
+
##
|
|
237
|
+
# Baseline implementation for the ingest_users REST call
|
|
238
|
+
#
|
|
239
|
+
# @param request_pb [::Google::Ads::DataManager::V1::IngestUsersRequest]
|
|
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::IngestUsersResponse]
|
|
246
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
247
|
+
#
|
|
248
|
+
# @return [::Google::Ads::DataManager::V1::IngestUsersResponse]
|
|
249
|
+
# A result object deserialized from the server's reply
|
|
250
|
+
def ingest_users 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_users_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_users",
|
|
266
|
+
options: options
|
|
267
|
+
)
|
|
268
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
|
269
|
+
result = ::Google::Ads::DataManager::V1::IngestUsersResponse.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
|
+
|
|
276
|
+
##
|
|
277
|
+
# Baseline implementation for the remove_users REST call
|
|
278
|
+
#
|
|
279
|
+
# @param request_pb [::Google::Ads::DataManager::V1::RemoveUsersRequest]
|
|
280
|
+
# A request object representing the call parameters. Required.
|
|
281
|
+
# @param options [::Gapic::CallOptions]
|
|
282
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
283
|
+
#
|
|
284
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
285
|
+
# @yieldparam result [::Google::Ads::DataManager::V1::RemoveUsersResponse]
|
|
286
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
287
|
+
#
|
|
288
|
+
# @return [::Google::Ads::DataManager::V1::RemoveUsersResponse]
|
|
289
|
+
# A result object deserialized from the server's reply
|
|
290
|
+
def remove_users request_pb, options = nil
|
|
291
|
+
raise ::ArgumentError, "request must be provided" if request_pb.nil?
|
|
292
|
+
|
|
293
|
+
verb, uri, query_string_params, body = ServiceStub.transcode_remove_users_request request_pb
|
|
294
|
+
query_string_params = if query_string_params.any?
|
|
295
|
+
query_string_params.to_h { |p| p.split "=", 2 }
|
|
296
|
+
else
|
|
297
|
+
{}
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
response = @client_stub.make_http_request(
|
|
301
|
+
verb,
|
|
302
|
+
uri: uri,
|
|
303
|
+
body: body || "",
|
|
304
|
+
params: query_string_params,
|
|
305
|
+
method_name: "remove_users",
|
|
306
|
+
options: options
|
|
307
|
+
)
|
|
308
|
+
operation = ::Gapic::Rest::TransportOperation.new response
|
|
309
|
+
result = ::Google::Ads::DataManager::V1::RemoveUsersResponse.decode_json response.body, ignore_unknown_fields: true
|
|
310
|
+
catch :response do
|
|
311
|
+
yield result, operation if block_given?
|
|
312
|
+
result
|
|
313
|
+
end
|
|
314
|
+
end
|
|
315
|
+
|
|
236
316
|
##
|
|
237
317
|
# Baseline implementation for the ingest_ad_events REST call
|
|
238
318
|
#
|
|
@@ -393,6 +473,46 @@ module Google
|
|
|
393
473
|
transcoder.transcode request_pb
|
|
394
474
|
end
|
|
395
475
|
|
|
476
|
+
##
|
|
477
|
+
# @private
|
|
478
|
+
#
|
|
479
|
+
# GRPC transcoding helper method for the ingest_users REST call
|
|
480
|
+
#
|
|
481
|
+
# @param request_pb [::Google::Ads::DataManager::V1::IngestUsersRequest]
|
|
482
|
+
# A request object representing the call parameters. Required.
|
|
483
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
|
484
|
+
# Uri, Body, Query string parameters
|
|
485
|
+
def self.transcode_ingest_users_request request_pb
|
|
486
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
|
487
|
+
.with_bindings(
|
|
488
|
+
uri_method: :post,
|
|
489
|
+
uri_template: "/v1/users:ingest",
|
|
490
|
+
body: "*",
|
|
491
|
+
matches: []
|
|
492
|
+
)
|
|
493
|
+
transcoder.transcode request_pb
|
|
494
|
+
end
|
|
495
|
+
|
|
496
|
+
##
|
|
497
|
+
# @private
|
|
498
|
+
#
|
|
499
|
+
# GRPC transcoding helper method for the remove_users REST call
|
|
500
|
+
#
|
|
501
|
+
# @param request_pb [::Google::Ads::DataManager::V1::RemoveUsersRequest]
|
|
502
|
+
# A request object representing the call parameters. Required.
|
|
503
|
+
# @return [Array(String, [String, nil], Hash{String => String})]
|
|
504
|
+
# Uri, Body, Query string parameters
|
|
505
|
+
def self.transcode_remove_users_request request_pb
|
|
506
|
+
transcoder = Gapic::Rest::GrpcTranscoder.new
|
|
507
|
+
.with_bindings(
|
|
508
|
+
uri_method: :post,
|
|
509
|
+
uri_template: "/v1/users:remove",
|
|
510
|
+
body: "*",
|
|
511
|
+
matches: []
|
|
512
|
+
)
|
|
513
|
+
transcoder.transcode request_pb
|
|
514
|
+
end
|
|
515
|
+
|
|
396
516
|
##
|
|
397
517
|
# @private
|
|
398
518
|
#
|