REST Resource: guaranteedOrders

リソース: GuaranteedOrder

保証型注文。

保証型オーダーは、保証型広告枠ソースの親エンティティです。保証型広告在庫ソースを作成する際は、保証型オーダー ID を広告在庫ソースに割り当てる必要があります。

JSON 表現 
{
  "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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
フィールド
name

string

出力専用。保証型注文のリソース名。
legacyGuaranteedOrderId

string

出力専用。保証型オーダーの以前の ID。元の交換で割り当てられます。以前の ID は 1 つのエクスチェンジ内では一意ですが、すべての保証型注文で一意であるとは限りません。この ID は SDF と UI で使用されます。
exchange

enum (Exchange)

必須。変更不可。保証型注文の発生元となる取引所。
guaranteedOrderId

string

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

string

必須。保証型注文の表示名。

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

object (GuaranteedOrderStatus)

保証型注文のステータス設定。
updateTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
publisherName

string

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

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

boolean

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

string (int64 format)

保証型オーダーへの読み取りアクセス権を持つ広告主の ID。

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

string (int64 format)

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

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

string (int64 format)

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

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

必須。

保証型広告掲載オーダーに対する読み取り/書き込みアクセス権を持つパートナーまたは広告主。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
readWritePartnerId

string (int64 format)

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

string (int64 format)

保証型注文に対する読み取り/書き込みアクセス権を持つ広告主。これは保証型オーダーのデフォルトの広告主でもあります。
相互に排他的なフィールドの終わり。

GuaranteedOrderStatus

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

JSON 表現 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
フィールド
entityStatus

enum (EntityStatus)

保証付き注文が配信可能かどうか。

指定できる値は ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED、ENTITY_STATUS_PAUSED です。デフォルト値は ENTITY_STATUS_ACTIVE です。
entityPauseReason

string

この保証型注文を一時停止する理由としてユーザーが指定した内容。

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

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

enum (GuaranteedOrderConfigStatus)

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

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

保証型広告掲載オーダーは、配信を開始する前に設定する必要があります（必須項目への入力、クリエイティブの選択、デフォルトのキャンペーンの選択）。現在、構成アクションは UI からのみ実行できます。

GuaranteedOrderConfigStatus

保証型注文の構成状態。

列挙型
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED このバージョンでは、承認状況が指定されていないか、不明です。
PENDING 保証付き注文の開始状態。この状態の保証型注文は、配信前に構成する必要があります。
COMPLETED 購入者が保証型注文を設定した後の状態。

メソッド

create

 新しい保証型注文を作成します。

editGuaranteedOrderReadAccessors

 保証型注文の広告主の読み取りを編集します。

get

 保証付きの注文を取得します。

list

 現在のユーザーがアクセスできる保証型注文を一覧表示します。

patch

 既存の保証型注文を更新します。