リソース: 保証型オーダー
注文が保証される。
保証型オーダーは、保証型の広告枠ソースの親エンティティです。保証型の広告枠ソースを作成する場合、保証型のオーダー ID を広告枠ソースに割り当てる必要があります。
JSON 表現 |
---|
{ "name": string, "legacyGuaranteedOrderId": string, "exchange": enum ( |
フィールド | |
---|---|
name |
出力のみ。保証型の注文のリソース名。 |
legacyGuaranteedOrderId |
出力のみ。保証型オーダーの以前の ID。元のエクスチェンジによって割り当てられます。以前の ID は 1 つのエクスチェンジ内で一意ですが、保証型の注文全体で一意になるとは限りません。この ID は SDF と管理画面で使用されます。 |
exchange |
必須。変更不可。保証型の注文が発生したエクスチェンジ。 |
guaranteedOrderId |
出力のみ。保証型の注文を一意に識別する ID。保証型オーダー ID の形式は |
displayName |
必須。保証型の注文の表示名。 UTF-8 でエンコードし、最大サイズが 240 バイトである必要があります。 |
status |
保証型の注文のステータス設定。 |
updateTime |
出力のみ。価格保証対象の注文が最後に更新された時点のタイムスタンプです。システムによって割り当てられます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
publisherName |
必須。保証型オーダーのパブリッシャー名。 UTF-8 でエンコードし、最大サイズが 240 バイトである必要があります。 |
readAccessInherited |
|
readAdvertiserIds[] |
保証型オーダーに対する読み取りアクセス権を持つ広告主の ID。
|
defaultAdvertiserId |
出力のみ。保証型オーダーのデフォルト広告主の ID です。 デフォルトの広告主は |
defaultCampaignId |
保証型オーダーに割り当てられているデフォルト キャンペーンの ID。 デフォルト キャンペーンはデフォルトの広告主に属している必要があります。 |
共用体フィールド 保証型オーダーに対する読み取り/書き込みアクセス権を持つパートナーまたは広告主。 |
|
readWritePartnerId |
保証型の注文に対する読み取り/書き込みアクセス権を持つパートナー。 |
readWriteAdvertiserId |
保証型のオーダーに対する読み取り/書き込みアクセス権を持つ広告主。これは、保証型オーダーのデフォルトの広告主でもあります。 |
GuaranteedOrderStatus
保証型の注文のステータス設定。
JSON 表現 |
---|
{ "entityStatus": enum ( |
フィールド | |
---|---|
entityStatus |
保証型の注文が配信可能かどうか。 有効な値は |
entityPauseReason |
この保証型の注文を一時停止するユーザー指定の理由。 最大 100 バイトまでの UTF-8 でエンコードする必要があります。
|
configStatus |
出力のみ。保証型の注文の設定ステータス。 有効な値は 保証型の配信を行うには、事前に設定(必須項目に入力し、クリエイティブを選択し、デフォルト キャンペーンを選択)する必要があります。現在、構成アクションは UI からのみ実行できます。 |
GuaranteedOrderConfigStatus
注文が保証される設定ステータス。
列挙型 | |
---|---|
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED |
このバージョンでは承認状況が指定されていないか、不明です。 |
PENDING |
保証型の注文の開始状態です。このステータスでの保証型の配信は、配信前に設定する必要があります。 |
COMPLETED |
購入者が保証型の注文を設定した後のステータス。 |
Methods |
|
---|---|
|
保証型の注文を新規作成します。 |
|
編集を行うと、保証型オーダーの広告主が読み込まれます。 |
|
注文を保証します。 |
|
現在のユーザーがアクセスできる保証型の注文を一覧表示します。 |
|
既存の保証型の注文を更新します。 |