class Google::Apis::JobsV4::RequestMetadata

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

Attributes

allow_missing_ids[RW]

Only set when any of domain, session_id and user_id isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, session_id and user_id for the best service experience. Corresponds to the JSON property `allowMissingIds` @return [Boolean]

allow_missing_ids?[RW]

Only set when any of domain, session_id and user_id isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, session_id and user_id for the best service experience. Corresponds to the JSON property `allowMissingIds` @return [Boolean]

device_info[RW]

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` @return [Google::Apis::JobsV4::DeviceInfo]

domain[RW]

Required if allow_missing_ids is unset or `false`. 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. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique domain. The maximum number of allowed characters is 255. Corresponds to the JSON property `domain` @return [String]

session_id[RW]

Required if allow_missing_ids is unset or `false`. 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. Note that any improvements to the model for a particular tenant site rely on this field being set correctly to a unique session ID. The maximum number of allowed characters is 255. Corresponds to the JSON property `sessionId` @return [String]

user_id[RW]

Required if allow_missing_ids is unset or `false`. 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. 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` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/jobs_v4/classes.rb, line 2224
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/jobs_v4/classes.rb, line 2229
def update!(**args)
  @allow_missing_ids = args[:allow_missing_ids] if args.key?(:allow_missing_ids)
  @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