DeliveryRequestHeader

RequestHeader には、すべての Delivery RPC リクエストに共通するフィールドが含まれます。

JSON 表現
{
  "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
}
フィールド
languageCode

string

BCP-47 言語コード(en-US や sr-Latn など)。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier を参照してください。指定しない場合、レスポンスは任意の言語で返されます。名前が存在する場合は、英語が優先されます。フィールド値の例: en-US

regionCode

string

必須。リクエストの発信元の地域の CLDR 地域コード。フィールド値の例: US

sdkVersion

string

呼び出し元の SDK のバージョン(該当する場合)。バージョン形式は「major.minor.patch」です(例: 1.1.2)。

osVersion

string

呼び出し元の SDK が実行されているオペレーティング システムのバージョン。フィールド値の例: 4.4.112.1

deviceModel

string

呼び出し元の SDK が実行されているデバイスのモデル。フィールド値の例: iPhone12,1SM-G920F

sdkType

enum (SdkType)

リクエストを送信する SDK のタイプ。

mapsSdkVersion

string

呼び出し元の SDK が依存する MapSDK のバージョン(該当する場合)。バージョンの形式は「major.minor.patch」です(例: 5.2.1)。

navSdkVersion

string

呼び出し元の SDK が依存する NavSDK のバージョン(該当する場合)。バージョン形式は「major.minor.patch」です(例: 2.1.0)。

platform

enum (Platform)

呼び出し元の SDK のプラットフォーム。

manufacturer

string

呼び出し元の SDK の Android デバイスのメーカー。Android SDK にのみ適用されます。フィールド値の例: Samsung

androidApiLevel

integer

呼び出し元の SDK の Android API レベル。Android SDK にのみ適用されます。フィールド値の例: 23

traceId

string

リクエストを識別するためにロギング目的で指定できる ID(省略可)。

SdkType

SDK の種類の例。

列挙型
SDK_TYPE_UNSPECIFIED デフォルト値。この値は、sdkType が省略されている場合に使用されます。
CONSUMER 呼び出し元の SDK は Consumer です。
DRIVER 呼び出し元の SDK は Driver です。
JAVASCRIPT 呼び出し元の SDK が JavaScript である。

プラットフォーム

呼び出し元の SDK のプラットフォーム。

列挙型
PLATFORM_UNSPECIFIED デフォルト値。この値は、プラットフォームを省略した場合に使用されます。
ANDROID リクエストの送信元が Android である。
IOS リクエストの送信元が iOS である。
WEB リクエストはウェブから送信されます。