דף זה תורגם על ידי Cloud Translation API.

DeliveryRequestHeader

ייצוג ב-JSON
SdkType
פלטפורמה

RequestHeader מכיל שדות שקיימים בכל בקשות ה-RPC של העברת הודעות.

ייצוג JSON

ייצוג 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,
  "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.1`,‏ `12.1`.
`deviceModel`	`string` הדגם של המכשיר שבו פועלת ערכת ה-SDK של מבצע הקריאה. דוגמאות לערכי שדות: `iPhone12,1`,‏ `SM-G920F`.
`sdkType`	`enum (SdkType)` סוג ה-SDK ששולח את הבקשה.
`mapsSdkVersion`	`string` גרסת MapSDK שעליה ה-SDK הקורא תלוי, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: `5.2.1`.
`navSdkVersion`	`string` גרסת NavSDK שעל אחת מהן מבוססת ערכת ה-SDK הקריאה, אם רלוונטי. פורמט הגרסה הוא 'major.minor.patch', לדוגמה: `2.1.0`.
`platform`	`enum (Platform)` הפלטפורמה של ה-SDK לשיחות.
`manufacturer`	`string` היצרן של מכשיר Android מערכת ה-SDK שבה מתבצעת הקריאה, רלוונטי רק לערכות ה-SDK של Android. דוגמה לערך בשדה: `Samsung`.
`androidApiLevel`	`integer` רמת ה-API של Android של ה-SDK לשיחות, רלוונטית רק לערכות ה-SDK ל-Android. דוגמה לערך שדה: `23`.
`traceId`	`string` מזהה אופציונלי שאפשר לספק למטרות רישום ביומן לצורך זיהוי הבקשה.

SdkType

סוגים אפשריים של SDK.

טיפוסים בני מנייה (enum)
`SDK_TYPE_UNSPECIFIED`	ערך ברירת המחדל. המערכת משתמשת בערך הזה אם השדה `sdkType` מושמט.
`CONSUMER`	ה-SDK של הקריאה הוא צרכן.
`DRIVER`	ה-SDK לשיחות הוא של מנהל התקן.
`JAVASCRIPT`	ה-SDK הקורא הוא JavaScript.

פלטפורמה

הפלטפורמה של ערכת ה-SDK שקוראת ל-API.

טיפוסים בני מנייה (enum)
`PLATFORM_UNSPECIFIED`	ערך ברירת המחדל. המערכת משתמשת בערך הזה אם לא מציינים את הפלטפורמה.
`ANDROID`	הבקשה מגיעה מ-Android.
`IOS`	הבקשה מגיעה מ-iOS.
`WEB`	הבקשה מגיעה מהאינטרנט.