REST Resource: inventorySources

Kaynak: InventorySource

Bir envanter kaynağı.

JSON gösterimi
{
  "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
  ]
}
Alanlar
name

string

Yalnızca çıkış. Envanter kaynağının kaynak adı.

inventorySourceId

string (int64 format)

Yalnızca çıkış. Envanter kaynağının benzersiz kimliği. Sistem tarafından atanır.

displayName

string

Envanter kaynağının görünen adı.

Maksimum 240 bayt boyutunda UTF-8 olarak kodlanmış olmalıdır.

inventorySourceType

enum (InventorySourceType)

Envanter kaynağının türünü gösterir.

inventorySourceProductType

enum (InventorySourceProductType)

Yalnızca çıkış. Envanter kaynağının envanter satma yöntemini belirten ürün türü.

commitment

enum (InventorySourceCommitment)

Envanter kaynağının garantili veya garanti edilmeyen yayınlanmasının olup olmadığı.

deliveryMethod

enum (InventorySourceDeliveryMethod)

Envanter kaynağının yayınlanma yöntemi.

  • Garanti edilmeyen envanter kaynakları için kabul edilen tek değer INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC'dir.
  • Garantili envanter kaynakları için kabul edilebilir değerler INVENTORY_SOURCE_DELIVERY_METHOD_TAG ve INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC'dir.
dealId

string

Exchange alanında envanter kaynağını benzersiz şekilde tanımlayan kimlik.

Her exchange'deki alıcılar arasında benzersiz olmalıdır ancak exchange'ler arasında benzersiz olması gerekmez.

status

object (InventorySourceStatus)

Envanter kaynağının durum ayarları.

exchange

enum (Exchange)

Envanter kaynağının ait olduğu exchange.

updateTime

string (Timestamp format)

Yalnızca çıkış. Envanter kaynağının en son güncellendiği zaman damgası. Sistem tarafından atanır.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

rateDetails

object (RateDetails)

Zorunlu. Envanter kaynağının ücret ayrıntıları.

publisherName

string

Envanter kaynağının yayıncı/satıcı adı.

timeRange

object (TimeRange)

Bu envanter kaynağının yayınlanmaya başladığı ve yayınının durduğu zaman aralığı.

creativeConfigs[]

object (CreativeConfig)

Envanter kaynağının reklam öğesi gereksinimleri.

Açık artırma paketleri için geçerli değildir.

guaranteedOrderId

string

Sabit. Bu envanter kaynağının ait olduğu garantili siparişin kimliği.

Yalnızca commitment, INVENTORY_SOURCE_COMMITMENT_GUARANTEED olduğunda geçerlidir.

readWriteAccessors

object (InventorySourceAccessors)

Envanter kaynağına okuma/yazma erişimi olan iş ortağı veya reklamverenler.

Yalnızca commitment INVENTORY_SOURCE_COMMITMENT_GUARANTEED olduğunda çıkış verir. Bu durumda, okuma/yazma erişimcileri üst garantili sıradan devralınır.

commitment, INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED olduğunda gereklidir.

commitment değeri INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ise ve bu alanda bir iş ortağı ayarlanırsa bu iş ortağı altındaki tüm reklamverenler, otomatik olarak envanter kaynağına salt okuma erişimine sahip olur. Bu reklamverenler readAdvertiserIds reklam grubuna dahil edilmeyecek.

readAdvertiserIds[]

string (int64 format)

Yalnızca çıkış. Envanter kaynağına salt okuma erişimi olan reklamverenlerin kimlikleri.

readPartnerIds[]

string (int64 format)

Yalnızca çıkış. Envanter kaynağına salt okuma erişimi olan iş ortaklarının kimlikleri.

Bu alandaki iş ortaklarının tüm reklamverenleri, envanter kaynağına salt okunur erişimi devralır.

InventorySourceType

Olası envanter kaynağı türleri.

Sıralamalar
INVENTORY_SOURCE_TYPE_UNSPECIFIED Envanter kaynağı türü belirtilmemiş veya bu sürümde bilinmiyor.
INVENTORY_SOURCE_TYPE_PRIVATE Gizli envanter kaynağı.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Açık artırma paketi.

InventorySourceProductType

Bir envanter kaynağının olası ürün türleri.

Sıralamalar
INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED Ürün türü belirtilmemiş veya bu sürümde bilinmiyor. Bu ürün türündeki envanter kaynaklarının değiştirilmesi API üzerinden desteklenmez.
PREFERRED_DEAL Envanter kaynağı, Tercih Edilen Anlaşma aracılığıyla envanter satar.
PRIVATE_AUCTION Envanter kaynağı, Özel Açık Artırma aracılığıyla envanter satar.
PROGRAMMATIC_GUARANTEED Envanter kaynağı, Programatik Garantili üzerinden envanter satar.
TAG_GUARANTEED Envanter kaynağı, Etiket Garantili aracılığıyla envanter satar.
YOUTUBE_RESERVE Envanter kaynağı, YouTube Reserve üzerinden envanter satar.
INSTANT_RESERVE Envanter kaynağı, Anında Rezervasyon üzerinden envanter satar. Bu ürün türündeki envanter kaynaklarının değiştirilmesi API üzerinden desteklenmez.
GUARANTEED_PACKAGE Envanter kaynağı, Garantili Paket aracılığıyla envanter satar. Bu ürün türündeki envanter kaynaklarının değiştirilmesi API üzerinden desteklenmez.
PROGRAMMATIC_TV Envanter kaynağı, Programatik TV üzerinden envanter satar. Bu ürün türündeki envanter kaynaklarının değiştirilmesi API üzerinden desteklenmez.
AUCTION_PACKAGE Envanter kaynağı, Açık Artırma Paketi aracılığıyla envanter satar. Bu ürün türündeki envanter kaynaklarının değiştirilmesi API üzerinden desteklenmez.

InventorySourceCommitment

Envanter kaynağı için olası taahhüt türleri.

Sıralamalar
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED Bu sürümde taahhüt belirtilmemiş veya bilinmiyor.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Taahhüt, kesin bir teslim tarihidir.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Taahhüt, garanti edilmeyen bir yayınlamadır.

InventorySourceDeliveryMethod

Bir envanter kaynağı için olası yayınlanma yöntemleri.

Sıralamalar
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Bu sürümde yayınlanma yöntemi belirtilmemiş veya bilinmiyor.
INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC Yayınlanma yöntemi programatiktir.
INVENTORY_SOURCE_DELIVERY_METHOD_TAG Yayınlanma yöntemi etikettir.

InventorySourceStatus

Envanter kaynağının durumla ilgili ayarları.

JSON gösterimi
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "sellerStatus": enum (EntityStatus),
  "sellerPauseReason": string,
  "configStatus": enum (InventorySourceConfigStatus)
}
Alanlar
entityStatus

enum (EntityStatus)

Envanter kaynağının yayınlanabilir olup olmadığı.

Kabul edilebilir değerler ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED ve ENTITY_STATUS_PAUSED'dir. ENTITY_STATUS_ACTIVE, varsayılan değerdir.

entityPauseReason

string

Bu envanter kaynağının duraklatılması için kullanıcı tarafından sağlanan neden.

100 karakteri aşmamalıdır.

Yalnızca entityStatus, ENTITY_STATUS_PAUSED olarak ayarlandığında geçerlidir.

sellerStatus

enum (EntityStatus)

Yalnızca çıkış. Envanter kaynağı için satıcı tarafından ayarlanan durum.

Yalnızca doğrudan yayıncılardan senkronize edilen envanter kaynakları için geçerlidir. Kabul edilebilir değerler ENTITY_STATUS_ACTIVE ve ENTITY_STATUS_PAUSED'dir.

sellerPauseReason

string

Yalnızca çıkış. Bu envanter kaynağının duraklatılması için satıcı tarafından sağlanan neden.

Yalnızca doğrudan yayıncılardan senkronize edilen envanter kaynakları için ve sellerStatus, ENTITY_STATUS_PAUSED olarak ayarlandığında geçerlidir.

configStatus

enum (InventorySourceConfigStatus)

Yalnızca çıkış. Envanter kaynağının yapılandırma durumu.

Yalnızca garantili envanter kaynakları için geçerlidir. Kabul edilebilir değerler INVENTORY_SOURCE_CONFIG_STATUS_PENDING ve INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED'dir.

Bir envanter kaynağının yayınlanabilmesi için önce yapılandırılması gerekir (zorunlu alanları doldurma, reklam öğeleri ve varsayılan kampanya seçme).

InventorySourceConfigStatus

Garantili envanter kaynağı için olası yapılandırma durumları.

Sıralamalar
INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED Onay durumu belirtilmemiş veya bu sürümde bilinmiyor.
INVENTORY_SOURCE_CONFIG_STATUS_PENDING Garantili bir envanter kaynağının başlangıç durumudur. Bu durumdaki envanter kaynağının yapılandırılması gerekir.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Alıcının garantili envanter kaynağını yapılandırdığı durum.

RateDetails

Envanter kaynağının ücretle ilgili ayarları.

JSON gösterimi
{
  "inventorySourceRateType": enum (InventorySourceRateType),
  "rate": {
    object (Money)
  },
  "unitsPurchased": string,
  "minimumSpend": {
    object (Money)
  }
}
Alanlar
inventorySourceRateType

enum (InventorySourceRateType)

Ücret türü.

Kabul edilebilir değerler INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED, INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR ve INVENTORY_SOURCE_RATE_TYPE_CPD'dir.

rate

object (Money)

Envanter kaynağının ücreti.

unitsPurchased

string (int64 format)

Garantili envanter kaynakları için gereklidir. Satıcı tarafından garanti edilen gösterimlerin sayısı.

minimumSpend

object (Money)

Yalnızca çıkış. Alıcının önceden envanter kaynağı için harcamayı taahhüt ettiği tutardır.

Yalnızca garantili envanter kaynakları için geçerlidir.

InventorySourceRateType

Envanter kaynağı için olası ücret türleri.

Sıralamalar
INVENTORY_SOURCE_RATE_TYPE_UNSPECIFIED Ücret türü belirtilmemiş veya bu sürümde bilinmiyor.
INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED Ücret türü BGBM'dir (Sabit).
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Ücret türü BGBM'dir (Taban).
INVENTORY_SOURCE_RATE_TYPE_CPD Ücret türü, Gün Başına Maliyet'tir.
INVENTORY_SOURCE_RATE_TYPE_FLAT Ücret türü Sabit.

Para

Para birimini, para birimi türüyle birlikte temsil eder.

JSON gösterimi
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
Alanlar
currencyCode

string

ISO 4217'de tanımlanan üç harfli para birimi kodu.

units

string (int64 format)

Tutarın tüm birimleri. Örneğin, currencyCode değeri "USD" ise 1 birim 1 ABD dolarıdır.

nanos

integer

Tutarın nano (10^-9) birimlerinin sayısı. Değer -999.999.999 ile +999.999.999 (her iki değer de dahil) arasında olmalıdır. units pozitifse nanos pozitif veya sıfır olmalıdır. units sıfır ise nanos pozitif, sıfır veya negatif olabilir. units negatifse nanos negatif veya sıfır olmalıdır. Örneğin $-1,75 units=-1 ve nanos=-750.000.000 olarak ifade edilir.

TimeRange

Zaman aralığı.

JSON gösterimi
{
  "startTime": string,
  "endTime": string
}
Alanlar
startTime

string (Timestamp format)

Zorunlu. Bir zaman aralığının alt sınırı (bu değerler dahil).

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Zorunlu. Bir zaman aralığının üst sınırı (bu değerler dahil).

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

CreativeConfig

Envanter kaynağı için reklam öğesi gereksinimleri yapılandırması.

JSON gösterimi
{
  "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.
}
Alanlar
creativeType

enum (CreativeType)

Envanter kaynağına atanabilen reklam öğesinin türü. Yalnızca aşağıdaki türler desteklenir:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Birleştirme alanı creative_config_scheme. creative_type şunlardan biri olduğunda geçerlidir:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Envanter kaynağına atanabilen reklam öğeleri için yapılandırma. creative_config_scheme şunlardan yalnızca biri olabilir:

displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Görüntülü reklam öğelerine ilişkin yapılandırma. creativeType, CREATIVE_TYPE_STANDARD olduğunda geçerlidir.

videoCreativeConfig

object (InventorySourceVideoCreativeConfig)

Video reklam öğelerinin yapılandırması. creativeType, CREATIVE_TYPE_VIDEO olduğunda geçerlidir.

InventorySourceDisplayCreativeConfig

Görüntülü reklam öğelerine ilişkin yapılandırma.

JSON gösterimi
{
  "creativeSize": {
    object (Dimensions)
  }
}
Alanlar
creativeSize

object (Dimensions)

Envanter kaynağına atanabilen görüntülü reklam öğeleri için boyut gereksinimleri.

InventorySourceVideoCreativeConfig

Video reklam öğelerinin yapılandırması.

JSON gösterimi
{
  "duration": string
}
Alanlar
duration

string (Duration format)

Envanter kaynağına atanabilecek video reklam öğeleri için süre gereksinimleri.

"s" ile biten ve en fazla dokuz kesir basamağı olan, saniye cinsinden bir süre. Örnek: "3.5s".

InventorySourceAccessors

Envanter kaynağına erişimi olan iş ortağı veya reklamverenler.

JSON gösterimi
{

  // 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.
}
Alanlar
Birleştirme alanı accessors. Envanter kaynağına erişimi olan iş ortağı veya reklamverenler. accessors şunlardan yalnızca biri olabilir:
partner

object (PartnerAccessor)

Envanter kaynağına erişimi olan iş ortağı.

advertisers

object (AdvertiserAccessors)

Envanter kaynağına erişimi olan reklamverenler. Tüm reklamverenler aynı iş ortağına ait olmalıdır.

PartnerAccessor

Envanter kaynağına erişimi olan iş ortağı.

JSON gösterimi
{
  "partnerId": string
}
Alanlar
partnerId

string (int64 format)

İş ortağının kimliği.

AdvertiserAccessors

Envanter kaynağına erişimi olan reklamverenler.

JSON gösterimi
{
  "advertiserIds": [
    string
  ]
}
Alanlar
advertiserIds[]

string (int64 format)

Reklamverenlerin kimlikleri.

Yöntemler

create

Yeni bir envanter kaynağı oluşturur.

editInventorySourceReadWriteAccessors

Bir envanter kaynağının okuma/yazma erişimcilerini düzenler.

get

Bir envanter kaynağı alır.

list

Geçerli kullanıcı tarafından erişilebilen envanter kaynaklarını listeler.

patch

Mevcut bir envanter kaynağını günceller.