REST Resource: guaranteedOrders

リソース: 保証型オーダー

注文が保証される。

保証型オーダーは、保証型の広告枠ソースの親エンティティです。保証型の広告枠ソースを作成する場合、保証型のオーダー 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 と管理画面で使用されます。
exchange

enum (Exchange)

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

string

出力のみ。保証型の注文を一意に識別する ID。保証型オーダー ID の形式は {exchange}-{legacyGuaranteedOrderId} です。
displayName

string

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

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

object (GuaranteedOrderStatus)

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

string (Timestamp format)

出力のみ。価格保証対象の注文が最後に更新された時点のタイムスタンプです。システムによって割り当てられます。

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

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

共用体フィールド 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

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

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

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

enum (GuaranteedOrderConfigStatus)

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

有効な値は PENDING と COMPLETED です。

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

GuaranteedOrderConfigStatus

注文が保証される設定ステータス。

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

Methods

create

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

editGuaranteedOrderReadAccessors

 編集を行うと、保証型オーダーの広告主が読み込まれます。

get

 注文を保証します。

list

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

patch

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