Method: orders.patch

سفارش را از 3p به AOG به روز کنید. اگر شناسه سفارش خالی باشد یا با سفارش موجود برابر نباشد، INVALID_ARGUMENT را برمی‌گرداند.

درخواست HTTP

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
orderUpdate.order.merchantOrderId

string

مورد نیاز: شناسه سفارش داخلی به تاجر اختصاص داده شده است. این شناسه باید منحصر به فرد باشد و برای عملیات به روز رسانی بعدی سفارش لازم است. این شناسه ممکن است روی googleOrderId ارائه شده یا هر مقدار منحصر به فرد دیگری تنظیم شود. توجه داشته باشید که شناسه ارائه شده به کاربران userVisibleOrderId است که ممکن است مقداری متفاوت و کاربرپسندتر باشد. حداکثر طول مجاز 64 کاراکتر است.

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
فیلدها
header

object ( OrderRequestHeader )

سربرگ درخواست سفارش به روز رسانی.

orderUpdate.type
(deprecated)

enum ( Type )

منسوخ شده: به جای آن از OrderUpdate.update_mask استفاده کنید. اگر نوع = SNAPSHOT، OrderUpdate.order باید کل سفارش باشد. اگر نوع = ORDER_STATUS، این تغییر وضعیت سطح سفارش است. فقط order.last_update_time و این وضعیت عمودی انتخاب می شوند. توجه: type.ORDER_STATUS فقط از به‌روزرسانی‌های وضعیت PurcahaseOrderExtension پشتیبانی می‌کند و برنامه‌ای برای گسترش این پشتیبانی وجود ندارد. در عوض، توصیه می‌کنیم از updateMask استفاده کنید، زیرا عمومی‌تر، قابل توسعه‌تر است و می‌تواند برای همه عمودی‌ها استفاده شود.

orderUpdate.order.googleOrderId

string

Google شناسه سفارش را اختصاص داد.

orderUpdate.order.userVisibleOrderId

string

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

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

منسوخ شده: به جای آن از وضعیت OrderExtensions استفاده کنید. برچسب قابل مشاهده توسط کاربر برای وضعیت این سفارش.

orderUpdate.order.buyerInfo

object ( UserInfo )

اطلاعات در مورد خریدار

orderUpdate.order.image

object ( Image )

تصویر مرتبط با سفارش

orderUpdate.order.createTime

string ( Timestamp format)

مورد نیاز: تاریخ و زمان ایجاد سفارش.

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

orderUpdate.order.lastUpdateTime

string ( Timestamp format)

تاریخ و زمان آخرین به روز رسانی سفارش برای به روز رسانی سفارش مورد نیاز است.

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

orderUpdate.order.transactionMerchant

object ( Merchant )

تاجری که تسویه حساب را تسهیل کرد. این می‌تواند با ارائه‌دهنده سطح مورد خطی متفاوت باشد. مثال: سفارش Expedia با مورد خط از ANA.

orderUpdate.order.contents

object ( Contents )

مورد نیاز: محتویات را سفارش دهید که گروهی از موارد خطی است.

orderUpdate.order.priceAttributes[]

object ( PriceAttribute )

قیمت، تخفیف، مالیات و غیره.

orderUpdate.order.followUpActions[]

object ( Action )

پیگیری اقدامات در سطح سفارش

orderUpdate.order.paymentData

object ( PaymentData )

داده های مربوط به پرداخت برای سفارش

orderUpdate.order.termsOfServiceUrl

string

پیوندی به شرایط خدمات مربوط به سفارش/سفارش پیشنهادی.

orderUpdate.order.note

string

یادداشت های پیوست شده به سفارش

orderUpdate.order.promotions[]

object ( Promotion )

همه تبلیغاتی که با این سفارش مرتبط هستند.

orderUpdate.order.disclosures[]

object ( Disclosure )

افشاهای مرتبط با این سفارش.

orderUpdate.order.vertical
(deprecated)

object

منسوخ شده: به جای آن از عمودی استفاده کنید. این ویژگی ها برای همه موارد خط اعمال می شود، مگر اینکه در برخی از موارد خطی لغو شوند. این عمودی باید با نوع عمودی سطح مورد خط مطابقت داشته باشد. مقادیر ممکن: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .

orderUpdate.updateMask

string ( FieldMask format)

توجه: توجه/توصیه های زیر برای فیلدهای ویژه زیر وجود دارد: 1. order.last_update_time همیشه به عنوان بخشی از درخواست به روز رسانی به روز می شود. 2. order.create_time، order.google_order_id و order.merchant_order_id در صورت ارائه به عنوان بخشی از updateMask نادیده گرفته خواهند شد.

فهرستی از نام‌های فیلدهای کاملاً واجد شرایط جدا شده با کاما. مثال: "user.displayName,photo" .

orderUpdate.userNotification

object ( UserNotification )

در صورت مشخص شدن، یک اعلان با عنوان و متن مشخص شده به کاربر نمایش می دهد. تعیین یک اعلان یک پیشنهاد برای اطلاع رسانی است و تضمین نمی شود که منجر به اعلان شود.

orderUpdate.reason

string

دلیل تغییر/به روز رسانی

verticals میدان اتحادیه این ویژگی ها برای همه موارد خط اعمال می شود، مگر اینکه در برخی از موارد خطی لغو شوند. این عمودی باید با نوع عمودی سطح مورد خط مطابقت داشته باشد. verticals فقط می توانند یکی از موارد زیر باشند:
orderUpdate.order.purchase

object ( PurchaseOrderExtension )

سفارش خرید

orderUpdate.order.ticket

object ( TicketOrderExtension )

سفارش بلیط

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از Order است.

سفارش به روز رسانی

به روز رسانی به یک سفارش.

نمایندگی JSON 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
فیلدها
type
(deprecated)

enum ( Type )

منسوخ شده: به جای آن از OrderUpdate.update_mask استفاده کنید. اگر نوع = SNAPSHOT، OrderUpdate.order باید کل سفارش باشد. اگر نوع = ORDER_STATUS، این تغییر وضعیت سطح سفارش است. فقط order.last_update_time و این وضعیت عمودی انتخاب می شوند. توجه: type.ORDER_STATUS فقط از به‌روزرسانی‌های وضعیت PurcahaseOrderExtension پشتیبانی می‌کند و برنامه‌ای برای گسترش این پشتیبانی وجود ندارد. در عوض، توصیه می‌کنیم از updateMask استفاده کنید، زیرا عمومی‌تر، قابل توسعه‌تر است و می‌تواند برای همه عمودی‌ها استفاده شود.

order

object ( Order )

updateMask

string ( FieldMask format)

توجه: توجه/توصیه های زیر برای فیلدهای ویژه زیر وجود دارد: 1. order.last_update_time همیشه به عنوان بخشی از درخواست به روز رسانی به روز می شود. 2. order.create_time، order.google_order_id و order.merchant_order_id در صورت ارائه به عنوان بخشی از updateMask نادیده گرفته خواهند شد.

فهرستی از نام‌های فیلدهای کاملاً واجد شرایط جدا شده با کاما. مثال: "user.displayName,photo" .

userNotification

object ( UserNotification )

در صورت مشخص شدن، یک اعلان با عنوان و متن مشخص شده به کاربر نمایش می دهد. تعیین یک اعلان یک پیشنهاد برای اطلاع رسانی است و تضمین نمی شود که منجر به اعلان شود.

reason

string

دلیل تغییر/به روز رسانی

تایپ کنید

منسوخ شده: به جای آن از OrderUpdate.update_mask استفاده کنید. به‌روزرسانی‌های مجاز برای یک سفارش

Enums
TYPE_UNSPECIFIED نوع نامشخص، نباید این را به صراحت تنظیم کنید.
ORDER_STATUS فقط وضعیت سفارش را به روز کنید.
SNAPSHOT به روز رسانی عکس فوری سفارش

User Notification

اعلان اختیاری کاربر برای نمایش به عنوان بخشی از به‌روزرسانی سفارش.

نمایندگی JSON 
{
  "title": string,
  "text": string
}
فیلدها
title

string

عنوان اعلان کاربر. حداکثر طول مجاز 30 کاراکتر است.

text

string

محتویات اطلاعیه. حداکثر طول مجاز 100 کاراکتر است.