google-ads-data_manager-v1 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c4a133ecbaed63fa287267a932ecaf5a759c0c43e9e69f3bef6e5f00d8ec886
-  data.tar.gz: 52e36bc99791e5dfa32403ee148b680c946659053753e29b3754594be0ce7cb5
+  metadata.gz: 6a5e1aae8dd667b2fbd959b7076cbdcf54b95fc1e20a670f7bf63a2ebdbc696c
+  data.tar.gz: e1fbb07ec8293ee8e1cf754e0c431b028339d852706713a9d1169d3361d6c234
 SHA512:
-  metadata.gz: ace93a31945313a7d50ce33f288052e76ef80ef2fef9d4c7b296df873252578506ce184980e0033b46f275d8086a47a722e11d9bd582f67d8f66e3fcabc98b0a
-  data.tar.gz: 267d93d142d0326ad88b1089221de0f2106269f53b6fc7036e4931018464bd56c3cdc6f72d463b30f4d159129bed8ca1368f7852219d761e502076b77ab4a028
+  metadata.gz: 03bb3e17e1ab57f19057865ea311eb750227b58d7ea32d98d41838a9f4861113a2957da10c1adaa33f24be8cd4813308e160adf6e60f2e5e95f0ceff9eee4daf
+  data.tar.gz: efb706fdb752f3b7ae5c4137ea58b4eb366baeb03209e3e527405458ba44f1208d3b52a557112cb6cd160845f6afb8a0e7bf0784f8bc651128fcd8fd7f16ebba

data/lib/google/ads/data_manager/v1/ingestion_service/client.rb

@@ -68,6 +68,36 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
 
+                default_config.rpcs.ingest_audience_members.timeout = 120.0
+                default_config.rpcs.ingest_audience_members.retry_policy = {
+                  initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.remove_audience_members.timeout = 120.0
+                default_config.rpcs.remove_audience_members.retry_policy = {
+                  initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.ingest_events.timeout = 120.0
+                default_config.rpcs.ingest_events.retry_policy = {
+                  initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.ingest_users.timeout = 120.0
+                default_config.rpcs.ingest_users.retry_policy = {
+                  initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.remove_users.timeout = 120.0
+                default_config.rpcs.remove_users.retry_policy = {
+                  initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.retrieve_request_status.timeout = 60.0
+                default_config.rpcs.retrieve_request_status.retry_policy = {
+                  initial_delay: 5.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
                 default_config
               end
               yield @configure if block_given?
@@ -215,13 +245,14 @@ module Google
             #     Optional. For testing purposes. If `true`, the request is validated but not
             #     executed. Only errors are returned, not results.
             #   @param encoding [::Google::Ads::DataManager::V1::Encoding]
-            #     Optional. Required for {::Google::Ads::DataManager::V1::UserData UserData}
-            #     uploads. The encoding type of the user identifiers. For hashed user
-            #     identifiers, this is the encoding type of the hashed string. For encrypted
-            #     hashed user identifiers, this is the encoding type of the outer encrypted
-            #     string, but not necessarily the inner hashed string, meaning the inner
-            #     hashed string could be encoded in a different way than the outer encrypted
-            #     string. For non `UserData` uploads, this field is ignored.
+            #     Optional. Must be provided for
+            #     {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
+            #     of the user identifiers. For hashed user identifiers, this is the encoding
+            #     type of the hashed string. For encrypted hashed user identifiers, this is
+            #     the encoding type of the outer encrypted string, but not necessarily the
+            #     inner hashed string, meaning the inner hashed string could be encoded in a
+            #     different way than the outer encrypted string. For non `UserData` uploads,
+            #     this field is ignored.
             #   @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
             #     Optional. Encryption information for
             #     {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
@@ -314,10 +345,10 @@ module Google
             #     Optional. For testing purposes. If `true`, the request is validated but not
             #     executed. Only errors are returned, not results.
             #   @param encoding [::Google::Ads::DataManager::V1::Encoding]
-            #     Optional. Required for {::Google::Ads::DataManager::V1::UserData UserData}
-            #     uploads. The encoding type of the user identifiers. Applies to only the
-            #     outer encoding for encrypted user identifiers. For non `UserData` uploads,
-            #     this field is ignored.
+            #     Optional. Must be provided for
+            #     {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
+            #     of the user identifiers. Applies to only the outer encoding for encrypted
+            #     user identifiers. For non `UserData` uploads, this field is ignored.
             #   @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
             #     Optional. Encryption information for
             #     {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
@@ -498,13 +529,14 @@ module Google
             #     Optional. For testing purposes. If `true`, the request is validated but not
             #     executed. Only errors are returned, not results.
             #   @param encoding [::Google::Ads::DataManager::V1::Encoding]
-            #     Optional. Required for {::Google::Ads::DataManager::V1::UserData UserData}
-            #     uploads. The encoding type of the user identifiers. For hashed user
-            #     identifiers, this is the encoding type of the hashed string. For encrypted
-            #     hashed user identifiers, this is the encoding type of the outer encrypted
-            #     string, but not necessarily the inner hashed string, meaning the inner
-            #     hashed string could be encoded in a different way than the outer encrypted
-            #     string. For non `UserData` uploads, this field is ignored.
+            #     Optional. Must be provided for
+            #     {::Google::Ads::DataManager::V1::UserData UserData} uploads. The encoding type
+            #     of the user identifiers. For hashed user identifiers, this is the encoding
+            #     type of the hashed string. For encrypted hashed user identifiers, this is
+            #     the encoding type of the outer encrypted string, but not necessarily the
+            #     inner hashed string, meaning the inner hashed string could be encoded in a
+            #     different way than the outer encrypted string. For non `UserData` uploads,
+            #     this field is ignored.
             #   @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
             #     Optional. Encryption information for
             #     {::Google::Ads::DataManager::V1::UserData UserData} uploads. If not set, it's
@@ -567,6 +599,190 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Uploads a list of users to the provided destinations. Unlike
+            # {::Google::Ads::DataManager::V1::IngestionService::Client#ingest_audience_members IngestAudienceMembers}
+            # (which adds users to specific advertiser audience lists for targeting),
+            # `IngestUsers` ingests account level identity linkage data (for example,
+            # user identifiers linked to mobile IDs) independent of specific audience
+            # segments.
+            #
+            # This feature is only available to accounts on an allowlist.
+            #
+            # @overload ingest_users(request, options = nil)
+            #   Pass arguments to `ingest_users` via a request object, either of type
+            #   {::Google::Ads::DataManager::V1::IngestUsersRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Ads::DataManager::V1::IngestUsersRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload ingest_users(destinations: nil, users: nil, encryption_info: nil, validate_only: nil, encoding: nil)
+            #   Pass arguments to `ingest_users` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
+            #     Required. The list of possible ingestion destinations.
+            #   @param users [::Array<::Google::Ads::DataManager::V1::User, ::Hash>]
+            #     Required. The list of users to ingest.
+            #   @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
+            #     Optional. Encryption information about encryption keys which are used to
+            #     encrypt the data.
+            #   @param validate_only [::Boolean]
+            #     Optional. If `true`, the request is validated but not executed.
+            #   @param encoding [::Google::Ads::DataManager::V1::Encoding]
+            #     Required. The encoding type of the user identifiers. For encrypted user
+            #     identifiers, this only applies to the outer encoding.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Ads::DataManager::V1::IngestUsersResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Ads::DataManager::V1::IngestUsersResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/ads/data_manager/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Ads::DataManager::V1::IngestionService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Ads::DataManager::V1::IngestUsersRequest.new
+            #
+            #   # Call the ingest_users method.
+            #   result = client.ingest_users request
+            #
+            #   # The returned object is of type Google::Ads::DataManager::V1::IngestUsersResponse.
+            #   p result
+            #
+            def ingest_users request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::IngestUsersRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.ingest_users.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Ads::DataManager::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.ingest_users.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.ingest_users.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @ingestion_service_stub.call_rpc :ingest_users, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Removes a list of users from the provided destinations.
+            #
+            # This feature is only available to accounts on an allowlist.
+            #
+            # @overload remove_users(request, options = nil)
+            #   Pass arguments to `remove_users` via a request object, either of type
+            #   {::Google::Ads::DataManager::V1::RemoveUsersRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Ads::DataManager::V1::RemoveUsersRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload remove_users(destinations: nil, user_data: nil, encryption_info: nil, validate_only: nil, encoding: nil)
+            #   Pass arguments to `remove_users` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param destinations [::Array<::Google::Ads::DataManager::V1::Destination, ::Hash>]
+            #     Required. The list of possible ingestion destinations.
+            #   @param user_data [::Array<::Google::Ads::DataManager::V1::UserData, ::Hash>]
+            #     Required. The individual bits of UserData that act as keys for the users to
+            #     remove.
+            #   @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
+            #     Optional. Encryption information about encryption keys which are used to
+            #     encrypt the data.
+            #   @param validate_only [::Boolean]
+            #     Optional. If `true`, the request is validated but not executed.
+            #   @param encoding [::Google::Ads::DataManager::V1::Encoding]
+            #     Required. The encoding type of the user identifiers. For encrypted user
+            #     identifiers, this only applies to the outer encoding.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Ads::DataManager::V1::RemoveUsersResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Ads::DataManager::V1::RemoveUsersResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/ads/data_manager/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Ads::DataManager::V1::IngestionService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Ads::DataManager::V1::RemoveUsersRequest.new
+            #
+            #   # Call the remove_users method.
+            #   result = client.remove_users request
+            #
+            #   # The returned object is of type Google::Ads::DataManager::V1::RemoveUsersResponse.
+            #   p result
+            #
+            def remove_users request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Ads::DataManager::V1::RemoveUsersRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.remove_users.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Ads::DataManager::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.remove_users.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.remove_users.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @ingestion_service_stub.call_rpc :remove_users, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Uploads a list of
             # {::Google::Ads::DataManager::V1::AdEvent AdEvent} resources to Google
@@ -592,8 +808,9 @@ module Google
             #   @param ad_events [::Array<::Google::Ads::DataManager::V1::AdEvent, ::Hash>]
             #     Required. Required (at least 1). A list of ad events.
             #   @param encryption_info [::Google::Ads::DataManager::V1::EncryptionInfo, ::Hash]
-            #     Required. Information about encryption keys which are used to encrypt the
-            #     data.
+            #     Optional. Information about encryption keys which are used to encrypt the
+            #     data. This field must be provided when ad events contain
+            #     {::Google::Ads::DataManager::V1::UserData UserData}.
             #   @param validate_only [::Boolean]
             #     Optional. If true, the request is validated, but not executed.
             #
@@ -936,6 +1153,16 @@ module Google
                 #
                 attr_reader :ingest_events
                 ##
+                # RPC-specific configuration for `ingest_users`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :ingest_users
+                ##
+                # RPC-specific configuration for `remove_users`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :remove_users
+                ##
                 # RPC-specific configuration for `ingest_ad_events`
                 # @return [::Gapic::Config::Method]
                 #
@@ -956,6 +1183,10 @@ module Google
                   @remove_all_audience_members = ::Gapic::Config::Method.new remove_all_audience_members_config
                   ingest_events_config = parent_rpcs.ingest_events if parent_rpcs.respond_to? :ingest_events
                   @ingest_events = ::Gapic::Config::Method.new ingest_events_config
+                  ingest_users_config = parent_rpcs.ingest_users if parent_rpcs.respond_to? :ingest_users
+                  @ingest_users = ::Gapic::Config::Method.new ingest_users_config
+                  remove_users_config = parent_rpcs.remove_users if parent_rpcs.respond_to? :remove_users
+                  @remove_users = ::Gapic::Config::Method.new remove_users_config
                   ingest_ad_events_config = parent_rpcs.ingest_ad_events if parent_rpcs.respond_to? :ingest_ad_events
                   @ingest_ad_events = ::Gapic::Config::Method.new ingest_ad_events_config
                   retrieve_request_status_config = parent_rpcs.retrieve_request_status if parent_rpcs.respond_to? :retrieve_request_status