REST Resource: advertisers.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)
    }
  ],
  "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)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
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（最小）です。
INVENTORY_SOURCE_RATE_TYPE_CPD レートタイプは日別単価です。
INVENTORY_SOURCE_RATE_TYPE_CPH レートタイプは 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 には正数または 0 を指定します。units がゼロの場合、nanos には正数、0、または負数を指定できます。units が負の場合、nanos は負数または 0 を指定します。たとえば、$-1.75 は units = -1、nanos = -750,000,000 と表されます。

TimeRange

期間。

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

string (Timestamp format)

必須。期間の下限（この値を含む）。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

CreativeConfig

広告在庫ソースのクリエイティブ要件の構成。

JSON 表現 
{
  "creativeType": enum (CreativeType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "displayCreativeConfig": {
    object (InventorySourceDisplayCreativeConfig)
  },
  "videoCreativeConfig": {
    object (InventorySourceVideoCreativeConfig)
  }
  // End of mutually exclusive fields.
}
フィールド
creativeType

enum (CreativeType)

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

creative_type が次のいずれかの場合に適用されます。

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

広告在庫ソースに割り当てることができるクリエイティブの設定。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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

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

JSON 表現 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partner": {
    object (PartnerAccessor)
  },
  "advertisers": {
    object (AdvertiserAccessors)
  }
  // End of mutually exclusive fields.
}
フィールド
広告枠ソースにアクセスできるパートナーまたは広告主。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
partner

object (PartnerAccessor)

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

object (AdvertiserAccessors)

広告枠ソースにアクセスできる広告主。すべての広告主が同じパートナーに属している必要があります。
相互に排他的なフィールドの終了。

PartnerAccessor

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

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

string (int64 format)

パートナーの ID。

AdvertiserAccessors

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

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

string (int64 format)

広告主の ID。

メソッド

get

 広告在庫ソースの取引を取得します。

list

 広告在庫ソースの取引を一覧表示します。