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,

  // 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.
}
フィールド
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 です。readWriteAdvertiserId が設定されていない場合は、readAdvertiserIds にリストされている最初の広告主がデフォルトの広告主になります。指定されていない場合は、デフォルトの広告主はありません。
defaultCampaignId

string (int64 format)

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

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

共用体フィールド read_write_accessor。必須。

保証付きオーダーに対する読み取り/書き込み権限を持つパートナーまたは広告主。read_write_accessor は次のいずれかになります。
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

この保証付き注文を一時停止する理由をお客様が入力した内容。

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

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

enum (GuaranteedOrderConfigStatus)

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

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

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

GuaranteedOrderConfigStatus

保証付き注文の構成状態。

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

メソッド

create

 新しい予約型配信オーダーを作成します。

editGuaranteedOrderReadAccessors

 予約型配信オーダーの読み取り広告主を編集します。

get

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

list

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

patch

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