- リソース: InventorySource
- InventorySourceType
- InventorySourceProductType
- InventorySourceCommitment
- InventorySourceDeliveryMethod
- InventorySourceStatus
- InventorySourceConfigStatus
- RateDetails
- InventorySourceRateType
- 金額
- TimeRange
- CreativeConfig
- InventorySourceDisplayCreativeConfig
- InventorySourceVideoCreativeConfig
- InventorySourceAccessors
- PartnerAccessor
- AdvertiserAccessors
- メソッド
リソース: InventorySource
広告枠ソース
JSON 表現 |
---|
{ "name": string, "inventorySourceId": string, "displayName": string, "inventorySourceType": enum ( |
フィールド | |
---|---|
name |
出力のみ。広告枠ソースのリソース名。 |
inventorySourceId |
出力のみ。広告枠ソースの一意の ID。システムによって割り当てられます。 |
displayName |
広告枠ソースの表示名。 UTF-8 でエンコードし、最大サイズが 240 バイトである必要があります。 |
inventorySourceType |
広告枠ソースのタイプを表します。 |
inventorySourceProductType |
出力のみ。広告枠ソースの商品タイプ。広告枠の販売方法を表します。 |
commitment |
広告枠ソースの配信が保証型か非保証型か。 |
deliveryMethod |
広告枠ソースの配信方法。
|
dealId |
広告枠ソースを一意に識別するエクスチェンジ スペース内の ID。 各エクスチェンジ内の購入者間で一意である必要がありますが、エクスチェンジ間で一意である必要はありません。 |
status |
広告枠ソースのステータス設定。 |
exchange |
広告枠ソースが属するエクスチェンジ。 |
updateTime |
出力のみ。広告枠ソースが最後に更新されたときのタイムスタンプ。システムによって割り当てられます。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
rateDetails |
必須。広告枠ソースのレートの詳細。 |
publisherName |
広告枠ソースのパブリッシャー/販売者の名前。 |
timeRange |
この広告枠ソースの配信の開始と停止の期間。 |
creativeConfigs[] |
広告枠ソースのクリエイティブの要件。 オークション パッケージには適用されません。 |
guaranteedOrderId |
変更不可。この広告枠ソースが属する保証型オーダーの ID。
|
readWriteAccessors |
広告枠ソースに対する読み取り/書き込みアクセス権を持つパートナーまたは広告主。
|
readAdvertiserIds[] |
出力のみ。広告枠ソースに対する読み取り専用権限を持つ広告主の ID。 |
readPartnerIds[] |
出力のみ。広告枠ソースに対する読み取り専用権限を持つパートナーの 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 |
この広告枠ソースを一時停止するユーザー指定の理由。 100 文字以内にしてください。
|
sellerStatus |
出力のみ。販売者が広告枠ソースに対して設定したステータス。 パブリッシャーから直接同期される広告枠ソースにのみ適用されます。有効な値は |
sellerPauseReason |
出力のみ。この広告枠ソースを一時停止する理由。販売者から提供されます。 パブリッシャーから直接同期され、 |
configStatus |
出力のみ。インベントリ ソースの設定ステータス。 保証型の広告枠ソースにのみ適用されます。有効な値は 広告枠ソースを配信するには、事前に設定(必須項目への入力、クリエイティブの選択、デフォルトのキャンペーンの選択)が必要です。 |
InventorySourceConfigStatus
保証型の広告枠ソースに設定可能なステータス。
列挙型 | |
---|---|
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED |
このバージョンでは承認状況が指定されていないか、不明です。 |
INVENTORY_SOURCE_CONFIG_STATUS_PENDING |
保証型の広告枠ソースの初期状態。この状態の広告枠ソースを設定する必要があります。 |
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED |
購入者が保証型の広告枠ソースを設定した後のステータス。 |
RateDetails
広告枠ソースのレート関連の設定。
JSON 表現 |
---|
{ "inventorySourceRateType": enum ( |
フィールド | |
---|---|
inventorySourceRateType |
料金タイプ。 有効な値は |
rate |
広告枠ソースのレート。 |
unitsPurchased |
保証型の広告枠ソースに必須です。販売者が保証しているインプレッション数。 |
minimumSpend |
出力のみ。購入者が広告枠ソースで事前に支出を確約した金額。 保証型の広告枠ソースにのみ適用されます。 |
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 |
ISO 4217 で定義されている 3 文字の通貨コード。 |
units |
金額の単位。たとえば、 |
nanos |
金額のナノ(10^-9)単位の数。値は -999,999,999~+999,999,999 の範囲(両端を含む)で指定する必要があります。 |
TimeRange
期間。
JSON 表現 |
---|
{ "startTime": string, "endTime": string } |
フィールド | |
---|---|
startTime |
必須。期間の下限(指定した値を含む)。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
endTime |
必須。期間の上限(指定した値を含む)。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
CreativeConfig
広告枠ソースのクリエイティブの要件の設定。
JSON 表現 |
---|
{ "creativeType": enum ( |
フィールド | |
---|---|
creativeType |
広告枠ソースに割り当てることができるクリエイティブのタイプ。次のタイプのみがサポートされています。
|
共用体フィールド
広告枠ソースに割り当てることができるクリエイティブの設定。 |
|
displayCreativeConfig |
ディスプレイ クリエイティブの設定。 |
videoCreativeConfig |
動画クリエイティブの設定。 |
InventorySourceDisplayCreativeConfig
ディスプレイ クリエイティブの設定。
JSON 表現 |
---|
{
"creativeSize": {
object ( |
フィールド | |
---|---|
creativeSize |
広告枠ソースに割り当てることができるディスプレイ クリエイティブのサイズ要件。 |
InventorySourceVideoCreativeConfig
動画クリエイティブの設定。
JSON 表現 |
---|
{ "duration": string } |
フィールド | |
---|---|
duration |
広告枠ソースに割り当てることができる動画クリエイティブの再生時間の要件です。 「 |
InventorySourceAccessors
広告枠ソースにアクセスできるパートナー(1 つまたは複数)。
JSON 表現 |
---|
{ // Union field |
フィールド | |
---|---|
共用体フィールド accessors 。広告枠ソースにアクセスできるパートナー(1 つまたは複数)。accessors は次のいずれかになります。 |
|
partner |
広告枠ソースにアクセスできるパートナー。 |
advertisers |
広告枠ソースにアクセスできる広告主。すべての広告主が同じパートナーに属している必要があります。 |
PartnerAccessor
広告枠ソースにアクセスできるパートナー。
JSON 表現 |
---|
{ "partnerId": string } |
フィールド | |
---|---|
partnerId |
パートナーの ID。 |
AdvertiserAccessors
広告枠ソースにアクセスできる広告主。
JSON 表現 |
---|
{ "advertiserIds": [ string ] } |
フィールド | |
---|---|
advertiserIds[] |
広告主の ID。 |
Methods |
|
---|---|
|
新しい広告枠ソースを作成します。 |
|
広告枠ソースの読み取り/書き込みアクセス者を編集します。 |
|
広告枠ソースを取得します。 |
|
現在のユーザーがアクセスできる広告枠ソースを一覧表示します。 |
|
既存の広告枠ソースを更新します。 |