Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.
Client for the UserEventService service.
Service for ingesting end user actions on a website to Discovery Engine API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the UserEventService Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all UserEventService clients ::Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.configure do |config| config.timeout = 10.0 end
#collect_user_event
def collect_user_event(request, options = nil) -> ::Google::Api::HttpBody
def collect_user_event(parent: nil, user_event: nil, uri: nil, ets: nil) -> ::Google::Api::HttpBody
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain.
This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
def collect_user_event(request, options = nil) -> ::Google::Api::HttpBody
collect_user_event
via a request object, either of type
CollectUserEventRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::CollectUserEventRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def collect_user_event(parent: nil, user_event: nil, uri: nil, ets: nil) -> ::Google::Api::HttpBody
collect_user_event
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).
-
parent (::String) — Required. The parent DataStore resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
. - user_event (::String) — Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
- uri (::String) — The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.
- ets (::Integer) — The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Api::HttpBody)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::CollectUserEventRequest.new # Call the collect_user_event method. result = client.collect_user_event request # The returned object is of type Google::Api::HttpBody. p result
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the UserEventService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#import_user_events
def import_user_events(request, options = nil) -> ::Gapic::Operation
def import_user_events(inline_source: nil, gcs_source: nil, bigquery_source: nil, parent: nil, error_config: nil) -> ::Gapic::Operation
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
def import_user_events(request, options = nil) -> ::Gapic::Operation
import_user_events
via a request object, either of type
ImportUserEventsRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::ImportUserEventsRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def import_user_events(inline_source: nil, gcs_source: nil, bigquery_source: nil, parent: nil, error_config: nil) -> ::Gapic::Operation
import_user_events
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).
- inline_source (::Google::Cloud::DiscoveryEngine::V1::ImportUserEventsRequest::InlineSource, ::Hash) — Required. The Inline source for the input content for UserEvents.
- gcs_source (::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash) — Required. Cloud Storage location for the input content.
- bigquery_source (::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash) — Required. BigQuery input source.
-
parent (::String) — Required. Parent DataStore resource name, of the form
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
- error_config (::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig, ::Hash) — The desired location of errors incurred during the Import. Cannot be set for inline user event imports.
- (response, operation) — Access the result along with the RPC operation
- response (::Gapic::Operation)
- operation (::GRPC::ActiveCall::Operation)
- (::Gapic::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::ImportUserEventsRequest.new # Call the import_user_events method. result = client.import_user_events request # The returned object is of type Gapic::Operation. You can use it to # check the status of an operation, cancel it, or wait for results. # Here is how to wait for a response. result.wait_until_done! timeout: 60 if result.response? p result.response else puts "No response received." end
#initialize
def initialize() { |config| ... } -> Client
Create a new UserEventService client object.
- (config) — Configure the UserEventService client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new do |config| config.timeout = 10.0 end
#operations_client
def operations_client() -> ::Google::Cloud::DiscoveryEngine::V1::UserEventService::Operations
Get the associated client for long-running operations.
#write_user_event
def write_user_event(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::UserEvent
def write_user_event(parent: nil, user_event: nil) -> ::Google::Cloud::DiscoveryEngine::V1::UserEvent
Writes a single user event.
def write_user_event(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::UserEvent
write_user_event
via a request object, either of type
WriteUserEventRequest or an equivalent Hash.
- request (::Google::Cloud::DiscoveryEngine::V1::WriteUserEventRequest, ::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.
- options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def write_user_event(parent: nil, user_event: nil) -> ::Google::Cloud::DiscoveryEngine::V1::UserEvent
write_user_event
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).
-
parent (::String) — Required. The parent DataStore resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
. - user_event (::Google::Cloud::DiscoveryEngine::V1::UserEvent, ::Hash) — Required. User event to write.
- (response, operation) — Access the result along with the RPC operation
- response (::Google::Cloud::DiscoveryEngine::V1::UserEvent)
- operation (::GRPC::ActiveCall::Operation)
- (::Google::Cloud::Error) — if the RPC is aborted.
Basic example
require "google/cloud/discovery_engine/v1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new # Create a request. To set request fields, pass in keyword arguments. request = Google::Cloud::DiscoveryEngine::V1::WriteUserEventRequest.new # Call the write_user_event method. result = client.write_user_event request # The returned object is of type Google::Cloud::DiscoveryEngine::V1::UserEvent. p result