REST Resource: guaranteedOrders

{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}

string

出力専用。保証型オーダーのリソース名。

string

出力専用。保証付き注文の従来の ID。元の取引所によって割り当てられます。従来の ID は 1 つのエクスチェンジ内で一意ですが、すべての保証注文で一意であるとは限りません。この ID は SDF と UI で使用されます。

enum (Exchange)

必須。変更不可。保証注文が発生したエクスチェンジ。

string

出力専用。保証型注文の一意の識別子。保証付きオーダー ID の形式は {exchange}-{legacyGuaranteedOrderId} です。

string

必須。保証型オーダーの表示名。

UTF-8 でエンコードし、最大サイズを 240 バイトにする必要があります。

object (GuaranteedOrderStatus)

保証付き注文のステータス設定。

string (Timestamp format)

出力専用。保証型注文が最後に更新されたときのタイムスタンプ。システムによって割り当てられます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

string

必須。保証型オーダーのパブリッシャー名。

UTF-8 でエンコードし、最大サイズは 240 バイトにする必要があります。

boolean

readWritePartnerId のすべての広告主が、保証型オーダーへの読み取りアクセス権を持っているかどうか。readWritePartnerId が設定されている場合にのみ適用されます。true の場合、readAdvertiserIds をオーバーライドします。

string (int64 format)

保証オーダーに対する読み取り権限を持つ広告主の ID。

設定されている場合、readWriteAdvertiserId に割り当てられている広告主をこのフィールドに含めることはできません。このフィールドの広告主はすべて、readWritePartnerId または readWriteAdvertiserId と同じパートナーに属している必要があります。

string (int64 format)

出力専用。保証型オーダーのデフォルトの広告主の ID。

デフォルトの広告主は readWriteAdvertiserId です。readWriteAdvertiserId が設定されていない場合は、readAdvertiserIds にリストされている最初の広告主になります。それ以外の場合、デフォルトの広告主は存在しません。

string (int64 format)

保証付きオーダーに割り当てられたデフォルト キャンペーンの ID。

デフォルト キャンペーンは、デフォルトの広告主に属している必要があります。

string (int64 format)

保証付き注文に対する読み取り / 書き込みアクセス権を持つパートナー。

string (int64 format)

保証型オーダーに対する読み取り/書き込みアクセス権を持つ広告主。これは保証型オーダーのデフォルトの広告主でもあります。

{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}

enum (EntityStatus)

保証付き注文が提供可能かどうか。

有効な値は ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED、ENTITY_STATUS_PAUSED です。デフォルト値は ENTITY_STATUS_ACTIVE です。

string

ユーザーが指定した、この保証型注文を一時停止した理由。

UTF-8 でエンコードし、最大長は 100 バイトにする必要があります。

entityStatus が ENTITY_STATUS_PAUSED に設定されている場合にのみ適用されます。

enum (GuaranteedOrderConfigStatus)

出力専用。保証付き注文の構成ステータス。

指定できる値は PENDING と COMPLETED です。

保証オーダーを配信するには、必須項目の入力、クリエイティブの選択、デフォルト キャンペーンの選択など、オーダーの設定を行う必要があります。現在、構成アクションは UI でのみ実行できます。