Method: orders.patch

تعديل الطلب من 3p إلى AOG تعرِض القيمة INVALID_ARGUMENT إذا كان معرّف الطلب فارغًا أو لا يساوي طلبًا حاليًا.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
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 إلا مع تحديثات حالة PercahaseOrderExtension، ولا توجد خطة لتوسيع هذا الدعم. بدلاً من ذلك، ننصح باستخدام updateMask لأنّه أكثر عمومية وقابلية للتوسع ويمكن استخدامه لجميع المجالات.

orderUpdate.order.googleOrderId

string

مُعرّف الطلب الذي قدمته Google.

orderUpdate.order.userVisibleOrderId

string

رقم التعريف الموجَّه للمستخدم الذي يشير إلى الطلب الحالي يجب أن يكون هذا المعرّف متوافقًا مع المعرّف المعروض لهذا الطلب في السياقات الأخرى، بما في ذلك المواقع الإلكترونية والتطبيقات والبريد الإلكتروني.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

متوقّفة نهائيًا: استخدِم حالة إضافات الطلب بدلاً منها. تصنيف يظهر للمستخدمين يشير إلى حالة هذا الطلب

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)

تاريخ ووقت آخر تعديل للطلب مطلوب لتحديث OrderUpdate.

يجب أن يكون طابعًا زمنيًا بالتنسيق 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" الإضافي على معرّف موارد منتظم يحدّد النوع. مثال: { "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.

OrderUpdate

تعديل طلب

تمثيل JSON
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
الحقول
type
(deprecated)

enum (Type)

تم إيقافه نهائيًا: استخدِم OrderUpdate.update_mask بدلاً من ذلك. إذا كان النوع = SNAPSHOT، يجب أن يكون OrderUpdate.order هو الطلب بالكامل. إذا كان type = ORDER_STATUS، هذا يعني أنّه تم تغيير الحالة على مستوى الطلب. يتم فقط اختيار Order.last_update_time وهذه الحالة العمودية. ملاحظة: لا يتوافق type.ORDER_STATUS إلا مع تحديثات حالة PercahaseOrderExtension، ولا توجد خطة لتوسيع هذا الدعم. بدلاً من ذلك، ننصح باستخدام 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 بدلاً من ذلك. تم السماح بالتعديلات على الطلب.

عمليات التعداد
TYPE_UNSPECIFIED النوع غير محدّد، يجب عدم ضبطه بشكل صريح.
ORDER_STATUS يجب تعديل حالة الطلب فقط.
SNAPSHOT تعديل لقطة الطلب

UserNotification

إشعار اختياري للمستخدم يتم عرضه كجزء من تعديل الطلب.

تمثيل JSON
{
  "title": string,
  "text": string
}
الحقول
title

string

تمثّل هذه السمة عنوان إشعار المستخدم. الحد الأقصى المسموح به للطول هو 30 حرفًا.

text

string

محتوى الإشعار. الحد الأقصى المسموح به هو 100 حرف.