REST Resource: products

منبع: محصول

یک محصول واحد

نمایندگی JSON
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "creativeSpecifications": [
    {
      object (CreativeSpecification)
    }
  ],
  "bookingLeadTime": string,
  "assignmentLeadTime": string,
  "minFlightDuration": string,
  "maxFlightDuration": string,
  "slotDuration": string,
  "createTime": string,
  "updateTime": string,
  "currencyCode": string
}
فیلدها
name

string

نام منبع محصول در قالب: products/{id} . به عنوان مثال products/product123 .

externalId

string

اختیاری. شناسه ای که برای نگاشت این موجودیت به منابع خارجی استفاده می شود.

displayName

string

مورد نیاز. نام نمایشی محصول

باید UTF-8 با حداکثر اندازه 240 بایت کدگذاری شود.

description

string

اختیاری. فیلد آزاد اضافی برای توصیف محصول.

labels

map (key: string, value: string)

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

یک شی حاوی لیستی از "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

creativeSpecifications[]

object ( CreativeSpecification )

مورد نیاز. لیست خلاقیت های مجاز قابل ارائه برای این محصول.

bookingLeadTime

string ( Duration format)

مورد نیاز. زمان لازم برای رزرو محصول Now + bookingLeadTime باید بعد از شروع پرواز باشد.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

assignmentLeadTime

string ( Duration format)

مورد نیاز. زمان لازم برای اختصاص خلاقیت ها.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

minFlightDuration

string ( Duration format)

اختیاری. حداقل مدت زمان پرواز برای این محصول.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

maxFlightDuration

string ( Duration format)

مورد نیاز. حداکثر مدت زمان پرواز برای این محصول.

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

slotDuration

string ( Duration format)

مورد نیاز. مدت زمان اسلات برای این محصول

مدت زمان در ثانیه با حداکثر نه رقم کسری که با ' s ' خاتمه می یابد. مثال: "3.5s" .

createTime

string ( Timestamp format)

فقط خروجی مهر زمانی ایجاد محصول

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

updateTime

string ( Timestamp format)

فقط خروجی آخرین مهر زمانی به روز شده برای محصول.

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

currencyCode

string

کد ارز 3 حرفی بزرگ تعریف شده در ISO 4217.

روش ها

create

یک محصول جدید ایجاد می کند.

get

یک محصول جداگانه را بازیابی می کند.

list

محصولات را لیست می کند.

patch

یک محصول موجود را به روز می کند.