Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class 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.
Generated from protobuf message google.cloud.talent.v4.RequestMetadata
Namespace
Google \ Cloud \ Talent \ V4
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ domain
string
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.
↳ session_id
string
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.
↳ user_id
string
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.
↳ allow_missing_ids
bool
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.
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.
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.
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.
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.
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.
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAllowMissingIds
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.
Returns
Type
Description
bool
setAllowMissingIds
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.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getDeviceInfo
The type of device used by the job seeker at the time of the call to the
service.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Talent Solution V4 Client - Class RequestMetadata (2.1.3)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.3 (latest)](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata)\n- [2.1.2](/php/docs/reference/cloud-talent/2.1.2/V4.RequestMetadata)\n- [2.0.2](/php/docs/reference/cloud-talent/2.0.2/V4.RequestMetadata)\n- [1.3.5](/php/docs/reference/cloud-talent/1.3.5/V4.RequestMetadata)\n- [1.2.2](/php/docs/reference/cloud-talent/1.2.2/V4.RequestMetadata)\n- [1.1.1](/php/docs/reference/cloud-talent/1.1.1/V4.RequestMetadata)\n- [1.0.5](/php/docs/reference/cloud-talent/1.0.5/V4.RequestMetadata) \nReference documentation and code samples for the Google Cloud Talent Solution V4 Client class RequestMetadata.\n\nMeta information related to the job searcher or entity\nconducting the job search. This information is used to improve the\nperformance of the service.\n\nGenerated from protobuf message `google.cloud.talent.v4.RequestMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Talent \\\\ V4\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDomain\n\nRequired if\n[allow_missing_ids](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)\nis unset or `false`.\n\nThe client-defined scope or source of the service call, which typically\nis the domain on\nwhich the service has been implemented and is currently being run.\nFor example, if the service is being run by client *Foo, Inc.*, on\njob board www.foo.com and career site www.bar.com, then this field is\nset to \"foo.com\" for use on the job board, and \"bar.com\" for use on the\ncareer site.\nNote that any improvements to the model for a particular tenant site rely\non this field being set correctly to a unique domain.\nThe maximum number of allowed characters is 255.\n\n### setDomain\n\nRequired if\n[allow_missing_ids](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)\nis unset or `false`.\n\nThe client-defined scope or source of the service call, which typically\nis the domain on\nwhich the service has been implemented and is currently being run.\nFor example, if the service is being run by client *Foo, Inc.*, on\njob board www.foo.com and career site www.bar.com, then this field is\nset to \"foo.com\" for use on the job board, and \"bar.com\" for use on the\ncareer site.\nNote that any improvements to the model for a particular tenant site rely\non this field being set correctly to a unique domain.\nThe maximum number of allowed characters is 255.\n\n### getSessionId\n\nRequired if\n[allow_missing_ids](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)\nis unset or `false`.\n\nA unique session identification string. A session is defined as the\nduration of an end user's interaction with the service over a certain\nperiod.\nObfuscate this field for privacy concerns before\nproviding it to the service.\nNote that any improvements to the model for a particular tenant site rely\non this field being set correctly to a unique session ID.\nThe maximum number of allowed characters is 255.\n\n### setSessionId\n\nRequired if\n[allow_missing_ids](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)\nis unset or `false`.\n\nA unique session identification string. A session is defined as the\nduration of an end user's interaction with the service over a certain\nperiod.\nObfuscate this field for privacy concerns before\nproviding it to the service.\nNote that any improvements to the model for a particular tenant site rely\non this field being set correctly to a unique session ID.\nThe maximum number of allowed characters is 255.\n\n### getUserId\n\nRequired if\n[allow_missing_ids](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)\nis unset or `false`.\n\nA unique user identification string, as determined by the client.\nTo have the strongest positive impact on search quality\nmake sure the client-level is unique.\nObfuscate this field for privacy concerns before\nproviding it to the service.\nNote that any improvements to the model for a particular tenant site rely\non this field being set correctly to a unique user ID.\nThe maximum number of allowed characters is 255.\n\n### setUserId\n\nRequired if\n[allow_missing_ids](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getAllowMissingIds__)\nis unset or `false`.\n\nA unique user identification string, as determined by the client.\nTo have the strongest positive impact on search quality\nmake sure the client-level is unique.\nObfuscate this field for privacy concerns before\nproviding it to the service.\nNote that any improvements to the model for a particular tenant site rely\non this field being set correctly to a unique user ID.\nThe maximum number of allowed characters is 255.\n\n### getAllowMissingIds\n\nOnly set when any of\n[domain](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),\n[session_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and\n[user_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) isn't available\nfor some reason. It is highly recommended not to set this field and provide\naccurate [domain](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),\n[session_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and\n[user_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) for the best\nservice experience.\n\n### setAllowMissingIds\n\nOnly set when any of\n[domain](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),\n[session_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and\n[user_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) isn't available\nfor some reason. It is highly recommended not to set this field and provide\naccurate [domain](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getDomain__),\n[session_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getSessionId__) and\n[user_id](/php/docs/reference/cloud-talent/latest/V4.RequestMetadata#_Google_Cloud_Talent_V4_RequestMetadata__getUserId__) for the best\nservice experience.\n\n### getDeviceInfo\n\nThe type of device used by the job seeker at the time of the call to the\nservice.\n\n### hasDeviceInfo\n\n### clearDeviceInfo\n\n### setDeviceInfo\n\nThe type of device used by the job seeker at the time of the call to the\nservice."]]
