DeliveryRequestHeader

  • The DeliveryRequestHeader object contains data about the request, such as language, region, SDK, operating system, and device details.

  • DeliveryRequestHeader includes fields identifying the calling SDK, like type (SdkType), version, and platform (Platform).

  • SdkType identifies the type of SDK (e.g., Consumer, Driver, JavaScript) while Platform indicates the operating system (Android, iOS, or Web).

  • Developers can optionally provide a traceId within the DeliveryRequestHeader for logging and request identification purposes.

A RequestHeader contains fields common to all Delivery RPC requests.

JSON representation 
{
  "languageCode": string,
  "regionCode": string,
  "sdkVersion": string,
  "osVersion": string,
  "deviceModel": string,
  "sdkType": enum (SdkType),
  "mapsSdkVersion": string,
  "navSdkVersion": string,
  "platform": enum (Platform),
  "manufacturer": string,
  "androidApiLevel": integer,
  "traceId": string
}
Fields
languageCode

string

The BCP-47 language code, such as en-US or sr-Latn. For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. If none is specified, the response may be in any language, with a preference for English if such a name exists. Field value example: en-US.
regionCode

string

Required. CLDR region code of the region where the request originates. Field value example: US.
sdkVersion

string

Version of the calling SDK, if applicable. The version format is "major.minor.patch", example: 1.1.2.
osVersion

string

Version of the operating system on which the calling SDK is running. Field value examples: 4.4.1, 12.1.
deviceModel

string

Model of the device on which the calling SDK is running. Field value examples: iPhone12,1, SM-G920F.
sdkType

enum (SdkType)

The type of SDK sending the request.
mapsSdkVersion

string

Version of the MapSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 5.2.1.
navSdkVersion

string

Version of the NavSDK which the calling SDK depends on, if applicable. The version format is "major.minor.patch", example: 2.1.0.
platform

enum (Platform)

Platform of the calling SDK.
manufacturer

string

Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs. Field value example: Samsung.
androidApiLevel

integer

Android API level of the calling SDK, only applicable for the Android SDKs. Field value example: 23.
traceId

string

Optional ID that can be provided for logging purposes in order to identify the request.

SdkType

Possible types of SDK.

Enums
SDK_TYPE_UNSPECIFIED The default value. This value is used if the sdkType is omitted.
CONSUMER The calling SDK is Consumer.
DRIVER The calling SDK is Driver.
JAVASCRIPT The calling SDK is JavaScript.

Platform

The platform of the calling SDK.

Enums
PLATFORM_UNSPECIFIED The default value. This value is used if the platform is omitted.
ANDROID The request is coming from Android.
IOS The request is coming from iOS.
WEB The request is coming from the web.