REST Resource: orders

Kaynak: Sipariş

Sipariş, reklamların ne zaman ve nerede gösterileceğini belirten bir Lines koleksiyonudur.

JSON gösterimi
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Alanlar
name

string

Yalnızca çıkış. Siparişin şu biçimdeki kaynak adı: siparisler/{id}`.

externalId

string

İsteğe bağlı. Bu varlığı harici kaynaklarla eşlemek için kullanılan kimlik.

displayName

string

Yalnızca çıkış. Siparişin görünen adı.

Maksimum 240 bayt boyutta UTF-8 olarak kodlanmış olmalıdır.

description

string

Yalnızca çıkış. Siparişi açıklamak için ek serbest biçimli alan.

orderState

enum (OrderState)

Yalnızca çıkış. Satırlarının durumuna göre siparişin hesaplanmış durumunu gösterir.

createTime

string (Timestamp format)

Yalnızca çıkış. Siparişin oluşturulma zaman damgası.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Yalnızca çıkış. Siparişin son güncelleme zaman damgası.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

advertiserInfo

object (AdvertiserInfo)

Yalnızca çıkış. Reklamveren bilgileri.

OrderState

Siparişin durumu.

Sıralamalar
ORDER_STATE_UNSPECIFIED Sipariş durumu belirtilmediğinde veya bu sürümde bilinmiyorsa varsayılan değer.
ORDER_STATE_PENDING_RESERVATION

Sipariş şunları içeriyor:

  • rezervasyon beklemede durumunda bir veya daha fazla satır var.
  • ayrılmış durumda sıfır veya daha fazla satır var.
  • tüm diğer durumlarda sıfır satır olacak.
ORDER_STATE_RESERVED

Sipariş şunları içeriyor:

  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda bir veya daha fazla satır.
  • Satıcı durumu tarafından reddedildi durumunda sıfır veya daha fazla satır.
  • tüm diğer durumlarda sıfır satır olacak.
ORDER_STATE_PENDING_BOOKING

Sipariş şunları içeriyor:

  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda sıfır satır.
  • rezervasyon beklemede durumunda bir veya daha fazla satır var.
  • Satıcı durumu tarafından reddedildi durumunda sıfır veya daha fazla satır.
  • alıcı tarafından iptal edilen sıfır veya daha fazla satır.
  • tüm diğer durumlarda sıfır satır olacak.
ORDER_STATE_BOOKED

Sipariş şunları içeriyor:

  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda sıfır satır.
  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda bir veya daha fazla satır var.
  • Satıcı durumu tarafından reddedildi durumunda sıfır veya daha fazla satır.
  • alıcı tarafından iptal edilen sıfır veya daha fazla satır.
  • tüm diğer durumlarda sıfır satır olacak.
ORDER_STATE_REJECTED_BY_SELLER

Sipariş şunları içeriyor:

  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda sıfır satır.
  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda sıfır satır.
  • satıcı durumu tarafından reddedildi bir veya daha fazla satır.
  • satır sayısı alıcı tarafından iptal edildi.
  • tüm diğer durumlarda sıfır satır olacak.
ORDER_STATE_CANCELLED_BY_BUYER

Sipariş şunları içeriyor:

  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda sıfır satır.
  • bekleyen rezervasyon durumunda sıfır satır.
  • ayrılmış durumda sıfır satır.
  • satır sayısı satıcı durumu tarafından reddedildi.
  • Bir veya daha fazla satırın alıcı tarafından iptal edilmesi.
  • tüm diğer durumlarda sıfır satır olacak.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

Sipariş şunları içeriyor:

  • bekleyen rezervasyondaki bir veya daha fazla satırın süresi doldu.
  • tüm diğer durumlarda sıfır satır olacak.
ORDER_STATE_RESERVED_EXPIRED

Sipariş şunları içeriyor:

  • ayrılmış bir veya daha fazla satırın süresi doldu.
  • tüm diğer durumlarda sıfır satır olacak.

Yöntemler

get

Tek bir siparişi alır.

list

Siparişleri listeler.

patch

Mevcut bir siparişi günceller.