REST Resource: inventorySources

リソース: InventorySource

広告枠ソース

JSON 表現 
{
  "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)
    }
  ],
  "subSitePropertyId": string,
  "guaranteedOrderId": string,
  "readWriteAccessors": {
    object (InventorySourceAccessors)
  },
  "readAdvertiserIds": [
    string
  ],
  "readPartnerIds": [
    string
  ]
}
フィールド
name

string

出力のみ。広告枠ソースのリソース名。
inventorySourceId

string (int64 format)

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

string

広告枠ソースの表示名。

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

enum (InventorySourceType)

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

enum (InventorySourceProductType)

出力のみ。広告枠ソースの商品タイプ。広告枠の販売方法を表します。
commitment

enum (InventorySourceCommitment)

広告枠ソースの配信が保証型か非保証型か。
deliveryMethod

enum (InventorySourceDeliveryMethod)

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

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

string

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

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

object (InventorySourceStatus)

広告枠ソースのステータス設定。
exchange

enum (Exchange)

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

string (Timestamp format)

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

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

object (RateDetails)

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

string

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

object (TimeRange)

この広告枠ソースの配信の開始と停止の期間。
creativeConfigs[]

object (CreativeConfig)

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

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

string

変更不可。この広告枠ソースが属する保証型オーダーの ID。

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

object (InventorySourceAccessors)

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

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

commitment が INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED の場合は必須。

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

string (int64 format)

出力のみ。広告枠ソースに対する読み取り専用権限を持つ広告主の ID。
readPartnerIds[]

string (int64 format)

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

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

InventorySourceType

利用可能な広告在庫ソースのタイプ。

列挙型
INVENTORY_SOURCE_TYPE_UNSPECIFIED このバージョンでは広告枠ソースのタイプが指定されていないか、不明です。
INVENTORY_SOURCE_TYPE_PRIVATE 非公開広告枠ソース
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE オークション パッケージ。

InventorySourceProductType

広告枠ソースに指定可能な商品タイプ。

列挙型
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED このバージョンではプロダクト タイプが指定されていないか、不明です。API 経由でこの商品カテゴリの広告枠ソースを変更することはできません。
PREFERRED_DEAL 広告枠ソースが優先取引を通じて広告枠を販売している。
PRIVATE_AUCTION 広告枠ソースは、プライベート オークションを通じて広告枠を販売します。
PROGRAMMATIC_GUARANTEED 広告枠ソースがプログラマティック保証型取引を介して広告枠を販売している。
TAG_GUARANTEED 広告枠ソースがタグ形式予約型配信を通じて広告枠を販売している。
YOUTUBE_RESERVE 広告在庫ソースは、YouTube Reserve 経由で広告枠を販売します。
INSTANT_RESERVE 広告在庫ソースは、事前購入を通じて広告枠を販売します。API 経由でこの商品カテゴリの広告枠ソースを変更することはできません。
GUARANTEED_PACKAGE 広告枠ソースが保証型パッケージを通じて広告枠を販売したとします。API 経由でこの商品カテゴリの広告枠ソースを変更することはできません。
PROGRAMMATIC_TV 広告在庫ソースは、プログラマティック テレビを通じて広告枠を販売します。API 経由でこの商品カテゴリの広告枠ソースを変更することはできません。
AUCTION_PACKAGE 広告在庫ソースは、オークション パッケージを通じて広告枠を販売します。API 経由でこの商品カテゴリの広告枠ソースを変更することはできません。

InventorySourceCommitment

広告枠ソースに使用可能なコミットメント タイプ。

列挙型
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED このバージョンではコミットメントが指定されていないか、不明です。
INVENTORY_SOURCE_COMMITMENT_GUARANTEED 確約配信は保証型です。
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED コミットメントは非保証型です。

InventorySourceDeliveryMethod

広告枠ソースに指定できる配信方法。

列挙型
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED このバージョンでは配信方法が指定されていないか、不明です。
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC 配信方法はプログラマティックである。
INVENTORY_SOURCE_DELIVERY_METHOD_TAG 配信方法はタグです。

InventorySourceStatus

広告枠ソースのステータス関連の設定。

JSON 表現 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
フィールド
entityStatus

enum (EntityStatus)

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

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

string

この広告枠ソースを一時停止するユーザー指定の理由。

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

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

enum (EntityStatus)

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

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

string

出力のみ。この広告枠ソースを一時停止する理由。販売者から提供されます。

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

enum (InventorySourceConfigStatus)

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

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

広告枠ソースを配信するには、事前に設定（必須項目への入力、クリエイティブの選択、デフォルトのキャンペーンの選択）が必要です。

InventorySourceConfigStatus

保証型の広告枠ソースに設定可能なステータス。

列挙型
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED このバージョンでは承認状況が指定されていないか、不明です。
INVENTORY_SOURCE_CONFIG_STATUS_PENDING 保証型の広告枠ソースの初期状態。この状態の広告枠ソースを設定する必要があります。
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED 購入者が保証型の広告枠ソースを設定した後のステータス。

RateDetails

広告枠ソースのレート関連の設定。

JSON 表現 
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
フィールド
inventorySourceRateType

enum (InventorySourceRateType)

料金タイプ。

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

object (Money)

広告枠ソースのレート。
unitsPurchased

string (int64 format)

保証型の広告枠ソースに必須です。販売者が保証しているインプレッション数。
minimumSpend

object (Money)

出力のみ。購入者が広告枠ソースで事前に支出を確約した金額。

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

InventorySourceRateType

広告枠ソースで使用可能なレートタイプ。

列挙型
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED このバージョンではレートタイプが指定されていないか、不明です。
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED レートタイプは CPM（固定）です。
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR レートタイプは CPM（Floor）です。
INVENTORY_SOURCE_RATE_TYPE_CPD レートタイプは 1 日の費用です。
INVENTORY_SOURCE_RATE_TYPE_FLAT レートタイプはフラットです。

通貨

金額をその通貨タイプで表します。

JSON 表現 
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
フィールド
currencyCode

string

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

string (int64 format)

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

integer

金額のナノ（10^-9）単位の数。値は -999,999,999～+999,999,999 の範囲（両端を含む）で指定する必要があります。units が正の場合、nanos は正またはゼロでなければなりません。units がゼロの場合、nanos には正、ゼロ、または負の値を指定できます。units が負の場合、nanos は負の値または 0 でなければなりません。たとえば $-1.75 は units=-1、nanos=-750,000,000 と表されます。

TimeRange

期間。

JSON 表現 
{
  "startTime": string,
  "endTime": string
}
フィールド
startTime

string (Timestamp format)

必須。期間の下限（指定した値を含む）。

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

string (Timestamp format)

必須。期間の上限（指定した値を含む）。

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

CreativeConfig

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

JSON 表現 
{
  "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.
}
フィールド
creativeType

enum (CreativeType)

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

共用体フィールド creative_config_scheme。creative_type が次のいずれかの場合に適用されます。

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

広告枠ソースに割り当てることができるクリエイティブの設定。creative_config_scheme は次のいずれかになります。
displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

ディスプレイ クリエイティブの設定。creativeType が CREATIVE_TYPE_STANDARD の場合に適用されます。
videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

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

InventorySourceDisplayCreativeConfig

ディスプレイ クリエイティブの設定。

JSON 表現 
{
  "creativeSize": {
    object (Dimensions)
  }
}
フィールド
creativeSize

object (Dimensions)

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

InventorySourceVideoCreativeConfig

動画クリエイティブの設定。

JSON 表現 
{
  "duration": string
}
フィールド
duration

string (Duration format)

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

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

InventorySourceAccessors

広告枠ソースにアクセスできるパートナー（1 つまたは複数）。

JSON 表現 
{

  // 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.
}
フィールド
共用体フィールド accessors。広告枠ソースにアクセスできるパートナー（1 つまたは複数）。accessors は次のいずれかになります。
partner

object (PartnerAccessor)

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

object (AdvertiserAccessors)

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

PartnerAccessor

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

JSON 表現 
{
  "partnerId": string
}
フィールド
partnerId

string (int64 format)

パートナーの ID。

AdvertiserAccessors

広告枠ソースにアクセスできる広告主。

JSON 表現 
{
  "advertiserIds": [
    string
  ]
}
フィールド
advertiserIds[]

string (int64 format)

広告主の ID。

Methods

create

 新しい広告枠ソースを作成します。

editInventorySourceReadWriteAccessors

 広告枠ソースの読み取り/書き込みアクセス者を編集します。

get

 広告枠ソースを取得します。

list

 現在のユーザーがアクセスできる広告枠ソースを一覧表示します。

patch

 既存の広告枠ソースを更新します。