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 の形式は {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

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

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

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

enum (GuaranteedOrderConfigStatus)

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

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

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

GuaranteedOrderConfigStatus

保証型の注文に設定可能なステータス。

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

Methods

create

 新しい保証型オーダーを作成します。

editGuaranteedOrderReadAccessors

 保証型オーダーの広告主に対する編集を行います。

get

 保証された注文が保証されます。

list

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

patch

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