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

この保証型の注文を一時停止する理由（ユーザーが指定）。

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

 既存の保証型取引を更新します。