DeliveryRequestHeader
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-27 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eDeliveryRequestHeader\u003c/code\u003e object contains data about the request, such as language, region, SDK, operating system, and device details.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eDeliveryRequestHeader\u003c/code\u003e includes fields identifying the calling SDK, like type (\u003ccode\u003eSdkType\u003c/code\u003e), version, and platform (\u003ccode\u003ePlatform\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eSdkType\u003c/code\u003e identifies the type of SDK (e.g., Consumer, Driver, JavaScript) while \u003ccode\u003ePlatform\u003c/code\u003e indicates the operating system (Android, iOS, or Web).\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can optionally provide a \u003ccode\u003etraceId\u003c/code\u003e within the \u003ccode\u003eDeliveryRequestHeader\u003c/code\u003e for logging and request identification purposes.\u003c/p\u003e\n"]]],[],null,["# DeliveryRequestHeader\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [SdkType](#SdkType)\n- [Platform](#Platform)\n\nA RequestHeader contains fields common to all Delivery RPC requests.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"languageCode\": string, \"regionCode\": string, \"sdkVersion\": string, \"osVersion\": string, \"deviceModel\": string, \"sdkType\": enum (/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader#SdkType), \"mapsSdkVersion\": string, \"navSdkVersion\": string, \"platform\": enum (/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader#Platform), \"manufacturer\": string, \"androidApiLevel\": integer, \"traceId\": string } ``` |\n\n| Fields ||\n|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `languageCode` | `string` The BCP-47 language code, such as en-US or sr-Latn. For more information, see \u003chttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier\u003e. 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`. |\n| `regionCode` | `string` Required. CLDR region code of the region where the request originates. Field value example: `US`. |\n| `sdkVersion` | `string` Version of the calling SDK, if applicable. The version format is \"major.minor.patch\", example: `1.1.2`. |\n| `osVersion` | `string` Version of the operating system on which the calling SDK is running. Field value examples: `4.4.1`, `12.1`. |\n| `deviceModel` | `string` Model of the device on which the calling SDK is running. Field value examples: `iPhone12,1`, `SM-G920F`. |\n| `sdkType` | `enum (`[SdkType](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader#SdkType)`)` The type of SDK sending the request. |\n| `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`. |\n| `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`. |\n| `platform` | `enum (`[Platform](/maps/documentation/mobility/fleet-engine/reference/tasks/rest/v1/DeliveryRequestHeader#Platform)`)` Platform of the calling SDK. |\n| `manufacturer` | `string` Manufacturer of the Android device from the calling SDK, only applicable for the Android SDKs. Field value example: `Samsung`. |\n| `androidApiLevel` | `integer` Android API level of the calling SDK, only applicable for the Android SDKs. Field value example: `23`. |\n| `traceId` | `string` Optional ID that can be provided for logging purposes in order to identify the request. |\n\nSdkType\n-------\n\nPossible types of SDK.\n\n| Enums ||\n|------------------------|--------------------------------------------------------------------|\n| `SDK_TYPE_UNSPECIFIED` | The default value. This value is used if the `sdkType` is omitted. |\n| `CONSUMER` | The calling SDK is Consumer. |\n| `DRIVER` | The calling SDK is Driver. |\n| `JAVASCRIPT` | The calling SDK is JavaScript. |\n\nPlatform\n--------\n\nThe platform of the calling SDK.\n\n| Enums ||\n|------------------------|-------------------------------------------------------------------|\n| `PLATFORM_UNSPECIFIED` | The default value. This value is used if the platform is omitted. |\n| `ANDROID` | The request is coming from Android. |\n| `IOS` | The request is coming from iOS. |\n| `WEB` | The request is coming from the web. |"]]
