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.

JSON representation 
{
  "domain": string,
  "sessionId": string,
  "userId": string,
  "allowMissingIds": boolean,
  "deviceInfo": {
    object (DeviceInfo)
  }
}
Fields
domain

string

Required if allowMissingIds 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.
sessionId

string

Required if allowMissingIds 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.
userId

string

Required if allowMissingIds 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.
allowMissingIds

boolean

Only set when any of domain, sessionId and userId isn't available for some reason. It is highly recommended not to set this field and provide accurate domain, sessionId and userId for the best service experience.
deviceInfo

object (DeviceInfo)

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)

Type of the device.
id

string

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.