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 รองรับเฉพาะการอัปเดตสถานะ PurcahaseOrderExtension และไม่มีแผนที่จะขยายการสนับสนุนนี้ แต่เราขอแนะนำให้ใช้ updateMask แทน เนื่องจากมีความแพร่หลาย ขยายการใช้งานได้ และใช้ได้กับธุรกิจทุกประเภท

orderUpdate.order.googleOrderId

string

รหัสคำสั่งซื้อที่ Google กำหนด

orderUpdate.order.userVisibleOrderId

string

รหัสที่แสดงต่อผู้ใช้ซึ่งอ้างอิงถึงคำสั่งซื้อปัจจุบัน รหัสนี้ควรสอดคล้องกับรหัสที่แสดงสำหรับคำสั่งซื้อนี้ในบริบทอื่นๆ รวมถึงเว็บไซต์ แอป และอีเมล

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

เลิกใช้งานแล้ว: ใช้สถานะ Orderชิ้นงานแทน ป้ายกำกับที่ปรากฏต่อผู้ใช้สำหรับสถานะของคำสั่งซื้อนี้

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

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 ควรเป็นคำสั่งซื้อทั้งหมด หากประเภท = 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 แทน อนุญาตให้อัปเดตคำสั่งซื้อ

Enum
TYPE_UNSPECIFIED ยังไม่ระบุประเภท ไม่ควรตั้งค่าอย่างชัดแจ้ง
ORDER_STATUS อัปเดตสถานะของคำสั่งซื้อเท่านั้น
SNAPSHOT อัปเดตภาพรวมคำสั่งซื้อ

UserNotification

การแจ้งเตือนผู้ใช้ที่ไม่บังคับที่จะแสดงเป็นส่วนหนึ่งของการอัปเดตคำสั่งซื้อ

การแสดง JSON 
{
  "title": string,
  "text": string
}
ช่อง
title

string

ชื่อการแจ้งเตือนผู้ใช้ ความยาวสูงสุดคือ 30 อักขระ

text

string

เนื้อหาของการแจ้งเตือน ความยาวสูงสุดคือ 100 อักขระ