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ı.

UTF-8 kodlu olmalı ve en fazla 240 bayt boyutunda 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ü (envanteri satma yöntemini belirtir).

commitment

enum (InventorySourceCommitment)

Envanter kaynağının garantili veya garanti edilmeyen bir yayı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'tür.
  • Garantili envanter kaynakları için kabul edilebilir değerler INVENTORY_SOURCE_DELIVERY_METHOD_TAG ve INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC'dır.
dealId

string

Exchange alanındaki, 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 olmayabilir.

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.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip 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ınlanmayı durdurduğ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

Değişmez. 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şim araçları, garanti edilen üst düzenden 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ğı ayarlanmışsa bu iş ortağı altındaki tüm reklamverenler otomatik olarak envanter kaynağına salt okuma erişimine sahip olur. Bu reklamverenler readAdvertiserIds'e 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ü belirtilmedi 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ü bu sürümde belirtilmemiş veya bilinmiyor. Bu ürün türünün envanter kaynaklarının API üzerinden değiştirilmesi desteklenmez.
PREFERRED_DEAL Envanter kaynağı, envanteri Tercih Edilen Anlaşma üzerinden satar.
PRIVATE_AUCTION Envanter kaynağı, envanteri Özel Açık Artırma üzerinden satar.
PROGRAMMATIC_GUARANTEED Envanter kaynağı, envanteri Programatik Garantili aracılığıyla satar.
TAG_GUARANTEED Envanter kaynağı, envanter Garantili Etiket aracılığıyla satıyor.
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ın API üzerinden değiştirilmesi desteklenmez.
GUARANTEED_PACKAGE Envanter kaynağı, envanter paketi aracılığıyla envanter satıyor. Bu ürün türündeki envanter kaynaklarının değiştirilmesi API üzerinden desteklenmez.
PROGRAMMATIC_TV Envanter kaynağı, envanteri Programatik TV aracılığıyla satar. Bu ürün türünün envanter kaynaklarının API üzerinden değiştirilmesi 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

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

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

InventorySourceDeliveryMethod

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

Sıralamalar
INVENTORY_SOURCE_DELIVERY_METHOD_UNSPECIFIED Yayınlanma yöntemi belirtilmedi 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 edilen değerler ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED ve ENTITY_STATUS_PAUSED'dir. Varsayılan değer ENTITY_STATUS_ACTIVE'tür.

entityPauseReason

string

Bu envanter kaynağının duraklatılmasıyla ilgili 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ış. Satıcı tarafından envanter kaynağı için 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'dur.

sellerPauseReason

string

Yalnızca çıkış. Bu envanter kaynağını duraklatmanız 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 edilen değerler INVENTORY_SOURCE_CONFIG_STATUS_PENDING ve INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED'dur.

Bir envanter kaynağının yayınlanabilmesi için önce yapılandırılması (gerekli alanları doldurmaları, reklam öğelerini seçmeleri ve varsayılan bir kampanya seçmeleri) 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 bir envanter kaynağının başlangıç durumu. Bu durumdaki envanter kaynağının yapılandırılması gerekir.
INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED Alıcı garantili bir envanter kaynağı yapılandırdıktan sonraki 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.

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österim sayısı.

minimumSpend

object (Money)

Yalnızca çıkış. Alıcının envanter kaynağı için önceden harcama yapmayı 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ün Başına Maliyet'tir.
INVENTORY_SOURCE_RATE_TYPE_FLAT Ücret türü Düz'dür.

Para

Para birimi türüyle birlikte bir para tutarını 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)

Tutardaki tam birimler. Örneğin, currencyCode "USD" ise 1 birim bir ABD doları değerindedir.

nanos

integer

Miktardaki 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ı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 ABD doları units=-1 ve nanos=-750.000.000 olarak temsil edilir.

TimeRange

Bir 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).

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren 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ı (dahil).

Nanosaniye çözünürlüğüne sahip ve en fazla dokuz kesirli basamak içeren 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 öğesi türü. Yalnızca aşağıdaki türler desteklenir:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Birlik alanı creative_config_scheme. creative_type aşağıdakilerden biri olduğunda geçerlidir:

  • CREATIVE_TYPE_STANDARD
  • CREATIVE_TYPE_VIDEO

Envanter kaynağına atanabilen reklam öğelerinin yapılandırması. creative_config_scheme şunlardan yalnızca biri olabilir:

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 öğeleri için yapılandırma. creativeType CREATIVE_TYPE_VIDEO olduğunda geçerlidir.

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 gereksinimleri.

InventorySourceVideoCreativeConfig

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

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

string (Duration format)

Envanter kaynağına atanabilen video reklam öğeleri için süre koşulları.

"s" ile biten, en fazla dokuz kesir basamağı içeren, saniye cinsinden 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 yalnızca aşağıdakilerden 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şim sağlayıcılarını düzenler.

get

Bir envanter kaynağı alır.

list

Geçerli kullanıcının erişebildiği envanter kaynaklarını listeler.

patch

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