RequestMetadata

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.

JSON representation 
{
  "domain": string,
  "sessionId": string,
  "userId": string,
  "deviceInfo": {
    object (DeviceInfo)
  }
}
Fields
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.
sessionId

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 sessionId.

The maximum number of allowed characters is 255.
userId

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 userId.

The maximum number of allowed characters is 255.
deviceInfo

object (DeviceInfo)

Optional. The type of device used by the job seeker at the time of the call to the service.

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.

JSON representation 
{
  "deviceType": enum (DeviceType),
  "id": string
}
Fields
deviceType

enum (DeviceType)

Optional. Type of the device.
id

string

Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.

DeviceType

An enumeration describing an API access portal and exposure mechanism.

Enums
DEVICE_TYPE_UNSPECIFIED The device type isn't specified.
WEB A desktop web browser, such as, Chrome, Firefox, Safari, or Internet Explorer)
MOBILE_WEB A mobile device web browser, such as a phone or tablet with a Chrome browser.
ANDROID An Android device native application.
IOS An iOS device native application.
BOT A bot, as opposed to a device operated by human beings, such as a web crawler.
OTHER Other devices types.