REST Resource: inventorySources

{
  "name": string,
  "inventorySourceId": string,
  "displayName": string,
  "inventorySourceType": enum (InventorySourceType),
  "inventorySourceProductType": enum (InventorySourceProductType),
  "commitment": enum (InventorySourceCommitment),
  "deliveryMethod": enum (InventorySourceDeliveryMethod),
  "dealId": string,
  "status": {
    object (InventorySourceStatus)
  },
  "exchange": enum (Exchange),
  "updateTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "publisherName": string,
  "timeRange": {
    object (TimeRange)
  },
  "creativeConfigs": [
    {
      object (CreativeConfig)
    }
  ],
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}

string

出力専用。広告枠ソースのリソース名。

string (int64 format)

出力専用。広告枠ソースの一意の ID。システムによって割り当てられます。

string

広告枠ソースの表示名。

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

enum (InventorySourceType)

広告枠ソースのタイプを示します。

enum (InventorySourceProductType)

出力専用。広告枠ソースの商品タイプ。広告枠の販売方法を示します。

enum (InventorySourceCommitment)

広告枠ソースでの配信が保証型か非保証型かを示します。

enum (InventorySourceDeliveryMethod)

広告枠ソースの配信方法。

• 非保証型の広告枠ソースに指定できる値は INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC のみです。
• 保証付き広告枠ソースの場合、指定できる値は INVENTORY_SOURCE_DELIVERY_METHOD_TAG と INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC です。

string

広告枠ソースを一意に識別するエクスチェンジ空間内の ID。

各エクスチェンジ内の購入者間で一意にする必要がありますが、エクスチェンジ間で一意である必要はありません。

object (InventorySourceStatus)

広告在庫ソースのステータス設定。

enum (Exchange)

広告在庫ソースが属するエクスチェンジ。

string (Timestamp format)

出力専用。在庫ソースが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。

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

object (RateDetails)

必須。広告枠ソースのレートの詳細。

string

広告枠ソースのパブリッシャー / 販売者名。

object (TimeRange)

この広告枠ソースの配信を開始および停止する期間。

object (CreativeConfig)

広告枠ソースのクリエイティブの要件。

オークション パッケージには適用されません。

string

変更不可。この広告枠ソースが属する保証付き注文の ID。

commitment が INVENTORY_SOURCE_COMMITMENT_GUARANTEED の場合にのみ適用されます。

object (InventorySourceAccessors)

広告枠ソースに対する読み取り/書き込みアクセス権を持つパートナーまたは広告主。

commitment が INVENTORY_SOURCE_COMMITMENT_GUARANTEED の場合のみ出力します。この場合、読み取り / 書き込みアクセサは親の保証付きオーダーから継承されます。

commitment が INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED の場合は必須です。

commitment が INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED で、このフィールドにパートナーが設定されている場合、このパートナーのすべての広告主は、広告枠ソースへの読み取り専用アクセス権を自動的に付与されます。これらの広告主は readAdvertiserIds に含まれません。

string (int64 format)

出力専用。広告枠ソースに対する読み取り専用アクセス権を持つ広告主の ID。

string (int64 format)

出力専用。広告枠ソースに対する読み取り専用権限を持つパートナーの ID。

このフィールド内のパートナーのすべての広告主は、広告枠ソースに対する読み取り専用権限を継承します。

{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}

enum (EntityStatus)

広告枠ソースが配信可能かどうか。

有効な値は ENTITY_STATUS_ACTIVE、ENTITY_STATUS_ARCHIVED、ENTITY_STATUS_PAUSED です。デフォルト値は ENTITY_STATUS_ACTIVE です。

string

この広告枠ソースを一時停止する理由（ユーザー提供）。

100 文字以内にしてください。

entityStatus が ENTITY_STATUS_PAUSED に設定されている場合にのみ有効です。

enum (EntityStatus)

出力専用。広告枠ソースに対して販売者が設定したステータス。

パブリッシャーから直接同期された広告枠ソースにのみ適用されます。指定できる値は ENTITY_STATUS_ACTIVE と ENTITY_STATUS_PAUSED です。

string

出力専用。この広告枠ソースを一時停止する理由（販売者提供）。

パブリッシャーから直接同期され、sellerStatus が ENTITY_STATUS_PAUSED に設定されている広告在庫ソースにのみ適用されます。

enum (InventorySourceConfigStatus)

出力専用。インベントリ ソースの設定ステータス。

保証型広告枠ソースにのみ適用されます。有効な値は INVENTORY_SOURCE_CONFIG_STATUS_PENDING と INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED です。

広告枠ソースを配信するには、必須項目の入力、クリエイティブの選択、デフォルト キャンペーンの選択など、広告枠ソースを構成する必要があります。

{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}

enum (InventorySourceRateType)

レート タイプ。

有効な値は INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED、INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR、INVENTORY_SOURCE_RATE_TYPE_CPD、です。

object (Money)

広告枠ソースのレート。

string (int64 format)

保証型の広告枠ソースの場合は必須です。販売者が保証するインプレッション数。

object (Money)

出力専用。購入者が広告枠ソースに事前に支払うことを約束した金額。

保証型広告枠ソースにのみ適用されます。

{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}

string

ISO 4217 で定義されている 3 文字の通貨コード。

string (int64 format)

金額の整数部分。たとえば、currencyCode が "USD" の場合、1 単位は 1 米ドルです。

integer

金額の小数部分をナノ（10^-9）単位で表した数。値は -999,999,999 以上 +999,999,999 以下でなければなりません。units が正の場合、nanos には正数または 0 を指定します。units がゼロの場合、nanos には正数、0、または負数を指定できます。units が負の場合、nanos は負数または 0 を指定します。たとえば、$-1.75 は units = -1、nanos = -750,000,000 と表されます。

{
  "startTime": string,
  "endTime": string
}

string (Timestamp format)

必須。期間の下限（開始日時を含む）。

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

string (Timestamp format)

必須。期間の上限（終了日時を含む）。

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

{
  "creativeType": enum (CreativeType),

  // Union field creative_config_scheme can be only one of the following:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of list of possible types for union field creative_config_scheme.
}

enum (CreativeType)

広告枠ソースに割り当てることができるクリエイティブのタイプ。次のタイプのみがサポートされています。

• CREATIVE_TYPE_STANDARD
• CREATIVE_TYPE_VIDEO

object (InventorySourceDisplayCreativeConfig)

ディスプレイ クリエイティブの設定。creativeType が CREATIVE_TYPE_STANDARD の場合に有効です。

object (InventorySourceVideoCreativeConfig)

動画クリエイティブの設定。creativeType が CREATIVE_TYPE_VIDEO の場合に適用されます。

{
  "creativeSize": {
    object (Dimensions)
  }
}

object (Dimensions)

広告枠ソースに割り当てることができるディスプレイ クリエイティブのサイズ要件。

{
  "duration": string
}

string (Duration format)

広告枠ソースに割り当てることができる動画クリエイティブの再生時間に関する要件。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。

{

  // Union field accessors can be only one of the following:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of list of possible types for union field accessors.
}

object (PartnerAccessor)

広告枠ソースにアクセスできるパートナー。

object (AdvertiserAccessors)

広告枠ソースにアクセスできる広告主。すべての広告主は、同じパートナーに属している必要があります。

{
  "partnerId": string
}

string (int64 format)

パートナーの ID。

{
  "advertiserIds": [
    string
  ]
}

string (int64 format)

広告主の ID。