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 kodlu olmalıdır.

inventorySourceType

enum (InventorySourceType)

Envanter kaynağının türünü belirtir.

inventorySourceProductType

enum (InventorySourceProductType)

Yalnızca çıkış. Envanter kaynağının ürün türü, envanterin satılma şeklini gösterir.

commitment

enum (InventorySourceCommitment)

Envanter kaynağının garantili veya garanti edilmeyen yayın sunup sunmadığı.

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'dır.
  • 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 borsadaki alıcılar arasında benzersiz olmalıdır ancak borsalar arasında benzersiz olması gerekmez.

status

object (InventorySourceStatus)

Envanter kaynağının durum ayarları.

exchange

enum (Exchange)

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

updateTime

string (Timestamp format)

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

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

rateDetails

object (RateDetails)

Zorunlu. Envanter kaynağının oran 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 durduğu zaman aralığı.

creativeConfigs[]

object (CreativeConfig)

Envanter kaynağının reklam öğesi koşulları

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

guaranteedOrderId

string

Değiştirilemez. 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 değeri INVENTORY_SOURCE_COMMITMENT_GUARANTEED olduğunda çıkış yapılır. Bu durumda okuma/yazma erişimcileri, üst öğeden devralınan garantili sıraya göre belirlenir.

commitment, INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ise zorunludur.

commitment INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED ise ve bu alanda bir iş ortağı ayarlanmışsa bu iş ortağının altındaki tüm reklamverenler, envanter kaynağına otomatik olarak salt okuma erişimine sahip olur. Bu reklamverenler readAdvertiserIds'ya dahil edilmez.

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 okuma erişimini 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 Özel envanter kaynağı.
INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE Açık artırma paketi.

InventorySourceProductType

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ünün envanter kaynaklarını API üzerinden değiştirme işlemi desteklenmez.
PREFERRED_DEAL Envanter kaynağı, envanteri Tercih Edilen Anlaşma aracılığıyla satar.
PRIVATE_AUCTION Envanter kaynağı, envanteri Özel Açık Artırma aracılığıyla satar.
PROGRAMMATIC_GUARANTEED Envanter kaynağı, envanteri Programatik Garantili aracılığıyla satar.
TAG_GUARANTEED Envanter kaynağı, Tag Guaranteed aracılığıyla envanter satar.
YOUTUBE_RESERVE Envanter kaynağı, YouTube Reserve üzerinden envanter satar.
INSTANT_RESERVE Envanter kaynağı, envanteri Anında Rezervasyon aracılığıyla satar. Bu ürün türünün envanter kaynaklarını API üzerinden değiştirme işlemi desteklenmez.
GUARANTEED_PACKAGE Envanter kaynağı, envanteri garantili paket aracılığıyla satar. Bu ürün türünün envanter kaynaklarını API üzerinden değiştirme işlemi desteklenmez.
PROGRAMMATIC_TV Envanter kaynağı, envanteri Programatik TV aracılığıyla satar. Bu ürün türünün envanter kaynaklarını API üzerinden değiştirme işlemi desteklenmez.
AUCTION_PACKAGE Envanter kaynağı, envanteri açık artırma paketi aracılığıyla satar. Bu ürün türünün envanter kaynaklarını API üzerinden değiştirme işlemi desteklenmez.

InventorySourceCommitment

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

Sıralamalar
INVENTORY_SOURCE_COMMITMENT_UNSPECIFIED Taahhüt belirtilmemiş veya bu sürümde bilinmiyor.
INVENTORY_SOURCE_COMMITMENT_GUARANTEED Taahhüt, garantili yayınlamadır.
INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED Taahhüt, garanti edilmeyen yayınlamadır.

InventorySourceDeliveryMethod

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

Sıralamalar
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Yayınlanma yöntemi belirtilmemiş veya bu sürümde 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. Varsayılan değer ENTITY_STATUS_ACTIVE'dır.

entityPauseReason

string

Bu envanter kaynağının duraklatılması için kullanıcının sağladığı 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 edilen 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 ayarı ENTITY_STATUS_PAUSED olarak belirlendiğinde 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 edilen değerler INVENTORY_SOURCE_CONFIG_STATUS_PENDING ve INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED'dir.

Bir envanter kaynağının yayınlanabilmesi için yapılandırılması (gerekli alanların doldurulması, reklam öğelerinin seçilmesi ve varsayılan bir kampanyanın belirlenmesi) gerekir.

InventorySourceConfigStatus

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

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

RateDetails

Envanter kaynağının oranla 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 oranı.

unitsPurchased

string (int64 format)

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

minimumSpend

object (Money)

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

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

InventorySourceRateType

Bir 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 (Sabit) olmalıdır.
INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR Ücret türü BGBM (taban) olmalıdır.
INVENTORY_SOURCE_RATE_TYPE_CPD Ücret türü, günlük maliyettir.
INVENTORY_SOURCE_RATE_TYPE_CPH Ücret türü, saat başına maliyettir.
INVENTORY_SOURCE_RATE_TYPE_FLAT Ücret türü sabittir.

Para

Para birimi türüyle birlikte bir para tutarını gösterir.

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 tam birimleri. Örneğin, currencyCode "USD" ise 1 birim, 1 ABD dolarıdır.

nanos

integer

Tutarın nano (10^-9) birim sayısı. Değer, -999.999.999 ile +999.999.999 arasında (değerler dahil) olmalıdır. units pozitifse nanos pozitif veya sıfır olmalıdır. units sıfırsa 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 gösterilir.

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ı (dahil).

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

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

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

CreativeConfig

Envanter kaynağı için reklam öğesi koşulları yapılandırması.

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

enum (CreativeType)

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

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

creative_type aşağıdakilerden biri olduğunda geçerlidir:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Envanter kaynağına atanabilecek reklam öğelerinin yapılandırması. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:

displayCreativeConfig

object (InventorySourceDisplayCreativeConfig)

Görüntülü reklam öğelerinin yapılandırması. 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.

Birbirini dışlayan alanların sonu.

InventorySourceDisplayCreativeConfig

Görüntülü reklam öğelerinin yapılandırması.

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

object (Dimensions)

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

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 koşulları.

En fazla dokuz kesirli basamak içeren ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

InventorySourceAccessors

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

JSON gösterimi
{

  // 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.
}
Alanlar
Envanter kaynağına erişimi olan iş ortağı veya reklamverenler. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt olarak en fazla bir alan ayarlanır:
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.

Birbirini dışlayan alanların sonu.

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

Mevcut kullanıcının erişebildiği envanter kaynaklarını listeler.

patch

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