Class: Google::Apis::JobsV2::RequestMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v2/classes.rb,
generated/google/apis/jobs_v2/representations.rb,
generated/google/apis/jobs_v2/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.



3101
3102
3103
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3101

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

Instance Attribute Details

#device_info ⇒ Google::Apis::JobsV2::DeviceInfo

Input only. 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:



3060
3061
3062
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3060

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 is not available for some reason, send "UNKNOWN". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain. Corresponds to the JSON property domain

Returns:

  • (String) 


3075
3076
3077
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3075

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 period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id. Corresponds to the JSON property sessionId

Returns:

  • (String) 


3086
3087
3088
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3086

def session_id
  @session_id
end

#user_id ⇒ String

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

Returns:

  • (String) 


3099
3100
3101
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3099

def user_id
  @user_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3106
3107
3108
3109
3110
3111
 
# File 'generated/google/apis/jobs_v2/classes.rb', line 3106

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