AppRequest

AppRequest درخواستی است که توسط Google Assistant به منظور تعامل با یک Action ارسال می‌شود. نسخه API در هدر HTTP مشخص شده است. برای API نسخه 1، هدر حاوی: Google-Assistant-API-Version: v1 . برای API نسخه 2، هدر حاوی: Google-actions-API-Version: 2 . برای مثال‌هایی از نحوه استفاده از آن در اقدامات در Google، به https://developers.google.com/assistant/df-asdk/reference/conversation-webhook-json مراجعه کنید.

نمایندگی JSON 
{
  "user": {
    object (User)
  },
  "device": {
    object (Device)
  },
  "surface": {
    object (Surface)
  },
  "conversation": {
    object (Conversation)
  },
  "inputs": [
    {
      object (Input)
    }
  ],
  "isInSandbox": boolean,
  "availableSurfaces": [
    {
      object (Surface)
    }
  ]
}
فیلدها
user

object ( User )

کاربری که مکالمه را آغاز کرده است.

device

object ( Device )

اطلاعات مربوط به دستگاهی که کاربر برای تعامل با Action از آن استفاده می کند.

surface

object ( Surface )

اطلاعات مربوط به سطحی که کاربر با آن در تعامل است، به عنوان مثال اینکه آیا می تواند صدا را خروجی دهد یا صفحه نمایش دارد.

conversation

object ( Conversation )

داده‌های جلسه مانند شناسه مکالمه و نشانه مکالمه را نگه می‌دارد.

inputs[]

object ( Input )

فهرست ورودی های مربوط به ورودی های مورد انتظار مشخص شده توسط Action. برای شروع مکالمه اولیه، ورودی حاوی اطلاعاتی درباره نحوه راه اندازی مکالمه توسط کاربر است.

isInSandbox

boolean

نشان می دهد که آیا درخواست باید در حالت جعبه ایمنی انجام شود یا خیر.

availableSurfaces[]

object ( Surface )

سطوح موجود برای انتقال سطح متقاطع.

کاربر

نمایندگی JSON 
{
  "idToken": string,
  "profile": {
    object (UserProfile)
  },
  "accessToken": string,
  "permissions": [
    enum (Permission)
  ],
  "locale": string,
  "lastSeen": string,
  "userStorage": string,
  "packageEntitlements": [
    {
      object (PackageEntitlement)
    }
  ],
  "userVerificationStatus": enum (UserVerificationStatus)
}
فیلدها
idToken

string

نشانه ای که هویت کاربر را نشان می دهد. این یک توکن وب Json شامل نمایه کدگذاری شده است. تعریف در https://developers.google.com/identity/protocols/OpenIDConnect#obtainuserinfo است.

profile

object ( UserProfile )

اطلاعات در مورد کاربر نهایی برخی از فیلدها تنها در صورتی در دسترس هستند که کاربر اجازه ارائه این اطلاعات را به Action داده باشد.

accessToken

string

یک توکن OAuth2 که کاربر را در سیستم شما شناسایی می کند. فقط در صورتی در دسترس است که کاربر حساب خود را پیوند دهد.

permissions[]

enum ( Permission )

حاوی مجوزهایی است که کاربر به این اقدام اعطا کرده است.

locale

string

تنظیمات محلی اولیه کاربر درخواست کننده. از کد زبان IETF BCP-47 http://www.rfc-editor.org/rfc/bcp/bcp47.txt پیروی می کند اما، برچسب فرعی اسکریپت گنجانده نشده است.

lastSeen

string ( Timestamp format)

مهر زمانی آخرین تعامل با این کاربر. اگر کاربر قبلا با عامل تعامل نداشته باشد، این قسمت حذف می شود.

یک مهر زمانی در قالب RFC3339 UTC "Zulu"، با دقت نانوثانیه. مثال: "2014-10-02T15:01:23.045123456Z" .

userStorage

string

یک نشانه غیر شفاف ارائه شده توسط برنامه که در سراسر مکالمات برای یک کاربر خاص ادامه دارد. حداکثر اندازه رشته 10 هزار کاراکتر است.

packageEntitlements[]

object ( PackageEntitlement )

فهرست حقوق کاربر برای هر نام بسته فهرست شده در بسته Action، در صورت وجود.

userVerificationStatus

enum ( UserVerificationStatus )

وضعیت تأیید کاربر را نشان می دهد.

نمایه کاربر

حاوی اطلاعات شخصی کاربر است. فیلدها فقط در صورتی پر می شوند که کاربر کاربر مجوز Action را برای یک فیلد خاص اعطا کند.

نمایندگی JSON 
{
  "displayName": string,
  "givenName": string,
  "familyName": string
}
فیلدها
displayName

string

نام کامل کاربر همانطور که در حساب Google او مشخص شده است. به مجوز NAME نیاز دارد.

givenName

string

نام کوچک کاربر همانطور که در حساب Google او مشخص شده است. به مجوز NAME نیاز دارد.

familyName

string

نام خانوادگی کاربر همانطور که در حساب Google آنها مشخص شده است. توجه داشته باشید که این قسمت ممکن است خالی باشد. به مجوز NAME نیاز دارد.

PackageEntitlement

فهرست حقوق مربوط به نام بسته

نمایندگی JSON 
{
  "packageName": string,
  "entitlements": [
    {
      object (Entitlement)
    }
  ]
}
فیلدها
packageName

string

باید با نام بسته در بسته اکشن مطابقت داشته باشد

entitlements[]

object ( Entitlement )

فهرستی از حقوق یک برنامه معین

استحقاق

حق دیجیتالی کاربر را تعریف می کند. انواع حقوق ممکن: برنامه پولی، خریدهای درون برنامه ای، اشتراک درون برنامه ای.

نمایندگی JSON 
{
  "sku": string,
  "skuType": enum (SkuType),
  "inAppDetails": {
    object (SignedData)
  }
}
فیلدها
sku

string

SKU محصول. نام بسته برای برنامه پولی، پسوند Finsky docid برای خرید درون‌برنامه و اشتراک درون‌برنامه. getSku() را در Play InApp Billing API مطابقت دهید.

skuType

enum ( SkuType )

inAppDetails

object ( SignedData )

فقط برای خرید درون‌برنامه و زیرمجموعه‌های درون‌برنامه ارائه می‌شود.

SignedData

نمایندگی JSON 
{
  "inAppPurchaseData": {
    object
  },
  "inAppDataSignature": string
}
فیلدها
inAppPurchaseData

object ( Struct format)

INAPP_PURCHASE_DATA را از روش getPurchases() مطابقت دهید. شامل تمام داده‌های خرید داخل برنامه در قالب JSON است. جزئیات را در جدول 6 https://developer.android.com/google/play/billing/billing_reference.html ببینید.

inAppDataSignature

string

IN_APP_DATA_SIGNATURE از روش getPurchases() در Play InApp Billing API مطابقت دارد.

دستگاه

اطلاعات مربوط به دستگاهی که کاربر برای تعامل با Action از آن استفاده می کند.

نمایندگی JSON 
{
  "location": {
    object (Location)
  }
}
فیلدها
location

object ( Location )

نشان دهنده مکان واقعی دستگاه مانند طول جغرافیایی، طول جغرافیایی و آدرس فرمت شده است. به مجوز DEVICE_COARSE_LOCATION یا DEVICE_PRECISE_LOCATION نیاز دارد.

سطح

اطلاعات ویژه سطح سرویس گیرنده Google Assistant که کاربر با آن در تعامل است. سطح با این واقعیت از دستگاه متمایز می شود که سطوح دستیار متعدد ممکن است روی یک دستگاه زندگی کنند.

نمایندگی JSON 
{
  "capabilities": [
    {
      object (Capability)
    }
  ]
}
فیلدها
capabilities[]

object ( Capability )

فهرستی از قابلیت هایی که سطح در زمان درخواست پشتیبانی می کند، به عنوان مثال actions.capability.AUDIO_OUTPUT

قابلیت

واحدی از عملکرد را نشان می دهد که سطح قادر به پشتیبانی است.

نمایندگی JSON 
{
  "name": string
}
فیلدها
name

string

نام قابلیت، به عنوان مثال actions.capability.AUDIO_OUTPUT

گفتگو

نمایندگی JSON 
{
  "conversationId": string,
  "type": enum (ConversationType),
  "conversationToken": string
}
فیلدها
conversationId

string

شناسه منحصر به فرد برای مکالمه چند نوبتی. برای نوبت اول اختصاص داده شده است. پس از آن برای نوبت های بعدی مکالمه یکسان می ماند تا زمانی که مکالمه خاتمه یابد.

type

enum ( ConversationType )

type وضعیت مکالمه را در چرخه عمر آن نشان می دهد.

conversationToken

string

نشانه مات که توسط Action در آخرین نوبت مکالمه مشخص شده است. این می تواند توسط یک Action برای ردیابی مکالمه یا ذخیره داده های مربوط به مکالمه استفاده شود.

ورودی

نمایندگی JSON 
{
  "rawInputs": [
    {
      object (RawInput)
    }
  ],
  "intent": string,
  "arguments": [
    {
      object (Argument)
    }
  ]
}
فیلدها
rawInputs[]

object ( RawInput )

رونویسی ورودی خام از هر نوبت مکالمه. برای ارائه برخی از انواع ورودی به Action، ممکن است چندین نوبت مکالمه برای کنش‌ها در Google لازم باشد.

intent

string

نیت کاربر را نشان می دهد. برای اولین نوبت مکالمه، intent به قصد شروع کننده برای Action اشاره خواهد کرد. برای نوبت‌های مکالمه بعدی، هدف، یک کنش رایج در هدف Google خواهد بود (با «اقدامات» شروع می‌شود.). به‌عنوان مثال، اگر ورودی مورد انتظار actions.intent.OPTION باشد، در صورتی که «دستیار Google» بتواند این intent را برآورده کند، مقصود مشخص‌شده در اینجا یا actions.intent.OPTION خواهد بود، یا اگر کاربر موارد دیگری ارائه کرده باشد actions.intent.TEXT خواهد بود. اطلاعات به https://developers.google.com/assistant/df-asdk/reference/intents مراجعه کنید.

arguments[]

object ( Argument )

فهرستی از مقادیر آرگومان ارائه شده برای ورودی درخواست شده توسط Action.

RawInput

نمایندگی JSON 
{
  "inputType": enum (InputType),

  // Union field input can be only one of the following:
  "query": string,
  "url": string
  // End of list of possible types for union field input.
}
فیلدها
inputType

enum ( InputType )

نحوه ارائه این ورودی توسط کاربر را نشان می دهد: پاسخ تایپ شده، پاسخ صوتی، نامشخص و غیره.

input فیلد اتحادیه input مقدار واقعی ورودی فقط می تواند یکی از موارد زیر باشد:
query

string

ورودی تایپ شده یا گفتاری از کاربر نهایی.

url

string

URL محرک.