Show / Hide Table of Contents

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.

Inheritance
object
RequestMetadata
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudTalentSolution.v4.Data
Assembly: Google.Apis.CloudTalentSolution.v4.dll
Syntax
public class RequestMetadata : IDirectResponseSchema

Properties

AllowMissingIds

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.

Declaration
[JsonProperty("allowMissingIds")]
public virtual bool? AllowMissingIds { get; set; }
Property Value
Type Description
bool?

DeviceInfo

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

Declaration
[JsonProperty("deviceInfo")]
public virtual DeviceInfo DeviceInfo { get; set; }
Property Value
Type Description
DeviceInfo

Domain

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.

Declaration
[JsonProperty("domain")]
public virtual string Domain { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

SessionId

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.

Declaration
[JsonProperty("sessionId")]
public virtual string SessionId { get; set; }
Property Value
Type Description
string

UserId

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.

Declaration
[JsonProperty("userId")]
public virtual string UserId { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX