Class: Google::Apis::JobsV3p1beta1::RequestMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3p1beta1/classes.rb,
generated/google/apis/jobs_v3p1beta1/representations.rb,
generated/google/apis/jobs_v3p1beta1/representations.rb

Overview

Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ RequestMetadata

Returns a new instance of RequestMetadata



2549
2550
2551
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2549

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#device_info ⇒ Google::Apis::JobsV3p1beta1::DeviceInfo

Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices. Corresponds to the JSON property deviceInfo

Returns:



2503
2504
2505
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2503

def device_info
  @device_info
end

#domain ⇒ String

Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client Foo, Inc., on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field isn't available for some reason, send "UNKNOWN". Any improvements to the model for a particular tenant site rely on this field being set correctly to a domain. The maximum number of allowed characters is 255. Corresponds to the JSON property domain

Returns:

  • (String) 


2519
2520
2521
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2519

def domain
  @domain
end

#session_id ⇒ String

Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a certain period. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to some unique session_id. The maximum number of allowed characters is 255. Corresponds to the JSON property sessionId

Returns:

  • (String) 


2533
2534
2535
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2533

def session_id
  @session_id
end

#user_id ⇒ String

Required. A unique user identification string, as determined by the client. To have the strongest positive impact on search quality make sure the client-level is unique. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the model for a particular tenant site, rely on this field being set correctly to a unique user_id. The maximum number of allowed characters is 255. Corresponds to the JSON property userId

Returns:

  • (String) 


2547
2548
2549
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2547

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2554
2555
2556
2557
2558
2559
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 2554

def update!(**args)
  @device_info = args[:device_info] if args.key?(:device_info)
  @domain = args[:domain] if args.key?(:domain)
  @session_id = args[:session_id] if args.key?(:session_id)
  @user_id = args[:user_id] if args.key?(:user_id)
end