REST Resource: adUnits

Resource: AdUnit

Satu unit iklan.

Representasi JSON
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "attributes": [
    enum (AdUnitAttribute)
  ],
  "creatives": [
    {
      object (CreativeSpecification)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (AdUnitState),
  "rejectedReason": string,
  "location": {
    object (LatLng)
  },
  "directionSet": boolean,
  "direction": integer,
  "elevationMetersSet": boolean,
  "elevationMeters": number,
  "physicalWidthMetersSet": boolean,
  "physicalWidthMeters": number,
  "physicalHeightMetersSet": boolean,
  "physicalHeightMeters": number,
  "venue": enum (OutOfHomeVenue),
  "fixedLocation": boolean,
  "indoors": boolean,
  "impressionDataRanges": [
    {
      object (ImpressionDataRange)
    }
  ],
  "photoUrls": [
    string
  ],
  "products": [
    string
  ]
}
Kolom
name

string

Nama resource unit iklan dalam format: adUnits/{id}. Misalnya, adUnits/adUnit123.

externalId

string

Opsional. ID yang dikelola penjual mungkin dalam sistem mereka sendiri. Setelah disetel, kemungkinan tidak akan berubah. Ini tidak boleh digunakan secara internal dan batasan tidak diterapkan.

displayName

string

Wajib diisi. Nama tampilan unit iklan.

Harus berenkode UTF-8 dengan ukuran maksimum 240 byte.

description

string

Opsional. Kolom bentuk bebas tambahan untuk mendeskripsikan unit iklan.

labels

map (key: string, value: string)

Opsional. Kumpulan label bentuk bebas untuk mendeskripsikan unit iklan ini.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

attributes[]

enum (AdUnitAttribute)

Opsional. Atribut untuk menentukan unit iklan ini lebih lanjut.

creatives[]

object (CreativeSpecification)

Opsional. Daftar materi iklan yang diizinkan dan dapat ditayangkan untuk unit iklan ini. Hal ini juga dapat ditentukan di tingkat Produk.

createTime

string (Timestamp format)

Hanya output. Stempel waktu pembuatan unit iklan.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Hanya output. Stempel waktu terakhir diperbarui untuk unit iklan.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

state

enum (AdUnitState)

Hanya output. Status unit iklan. Jika AD_UNIT_state_ ditolak, alasan yang ditolak akan berisi alasan.

rejectedReason

string

Hanya output. Jika consent_status ditetapkan menjadi AD_UNIT_APPROVAL_STATUS_ tumpang-tindih, kolom ini akan berisi alasannya.

location

object (LatLng)

Wajib diisi. Tidak dapat diubah. Lintang dan bujur unit iklan dalam format derajat yang ditandatangani.

directionSet

boolean

Wajib diisi. True jika arah ditetapkan.

direction

integer

Opsional. Tidak dapat diubah. Arah mata angin dalam derajat dengan utara mewakili 0. [0-360).

elevationMetersSet

boolean

Wajib diisi. True jika ElevationMeters disetel.

elevationMeters

number

Opsional. Tidak dapat diubah. Jarak dari bagian bawah unit iklan ke tanah dalam meter.

physicalWidthMetersSet

boolean

Wajib diisi. True jika physicalWidthMeters ditetapkan.

physicalWidthMeters

number

Opsional. Tidak dapat diubah. Lebar fisik unit iklan dalam meter.

physicalHeightMetersSet

boolean

Wajib diisi. True jika physicalHeightMeters disetel.

physicalHeightMeters

number

Opsional. Tidak dapat diubah. Tinggi fisik unit iklan dalam meter.

venue

enum (OutOfHomeVenue)

Opsional. Jenis tempat luar rumah berdasarkan standar DPAA. Ini adalah kolom informasi yang dapat ditampilkan kepada pengiklan dan juga dapat digunakan untuk memfilter unit iklan.

fixedLocation

boolean

Opsional. Apakah iklan berada di lokasi tetap (baliho) atau bergerak (taksi).

indoors

boolean

Wajib diisi. Apakah unit iklan berada di dalam ruangan.

impressionDataRanges[]

object (ImpressionDataRange)

Wajib diisi. Rentang data tayangan yang dikaitkan dengan unit iklan ini. Rentang tanggal diperkirakan tidak akan tumpang-tindih. Data tayangan diperlukan agar unit iklan memenuhi syarat untuk dibeli.

photoUrls[]

string

Opsional. URL foto unit iklan.

products[]

string

Wajib diisi. Nama resource produk yang terkait dengan unit iklan ini dalam format: products/{id}. Misalnya, products/product123.

AdUnitAttribute

Atribut yang mungkin digunakan untuk menentukan unit iklan lebih lanjut.

Enum
AD_UNIT_ATTRIBUTE_UNSPECIFIED Nilai default jika Atribut Unit Iklan tidak ditentukan atau tidak diketahui dalam versi ini.
AD_UNIT_ATTRIBUTE_ILLUMINATED Apakah unit iklan terlihat dalam gelap jika berada di dunia nyata?
AD_UNIT_ATTRIBUTE_DIGITAL Unit iklan digital, jika tidak menyertakan fisik klasik, tersirat.
AD_UNIT_ATTRIBUTE_PHYSICAL Unit iklan ada sebagai objek di dunia nyata.

AdUnitState

Status unit iklan dari perspektif penjual.

Enum
AD_UNIT_STATE_UNSPECIFIED Nilai default jika Status Unit Iklan tidak ditentukan atau tidak diketahui dalam versi ini.
AD_UNIT_STATE_PENDING Unit iklan sedang menunggu persetujuan.
AD_UNIT_STATE_APPROVED Unit iklan disetujui.
AD_UNIT_STATE_REJECTED Unit iklan ditolak.
AD_UNIT_STATE_DELETED Unit iklan dihapus.

OutOfHomeVenue

Daftar jenis tempat di luar rumah berdasarkan Standar DPAA.

Enum
OOH_VENUE_UNSPECIFIED Nilai default saat OOH Venue tidak ditentukan atau tidak diketahui dalam versi ini.
OOH_VENUE_AIRBORNE Area luar rumah yang dikategorikan sebagai udara.
OOH_VENUE_AIRPORTS_GENERAL Area luar rumah yang dikategorikan sebagai bandara umum.
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM Tempat luar rumah yang dikategorikan sebagai tempat pengambilan bagasi bandara.
OOH_VENUE_AIRPORTS_TERMINAL Area luar rumah yang dikategorikan sebagai terminal bandara.
OOH_VENUE_AIRPORTS_LOUNGES Ruang luar rumah yang dikategorikan sebagai lounge bandara.
OOH_VENUE_ATMS Area luar rumah yang dikategorikan sebagai ATM.
OOH_VENUE_BACKLIGHTS Area luar rumah yang dikategorikan sebagai lampu latar.
OOH_VENUE_BARS Area luar rumah yang dikategorikan sebagai bar.
OOH_VENUE_BENCHES Arena luar rumah yang dikategorikan sebagai bangku.
OOH_VENUE_BIKE_RACKS Area luar rumah yang dikategorikan sebagai rak sepeda.
OOH_VENUE_BULLETINS Tempat luar rumah yang dikategorikan sebagai buletin.
OOH_VENUE_BUSES Area luar rumah yang dikategorikan sebagai bus.
OOH_VENUE_CAFES Area luar rumah yang dikategorikan sebagai kafe.
OOH_VENUE_CASUAL_DINING_RESTAURANTS Restoran luar rumah yang dikategorikan sebagai restoran kasual.
OOH_VENUE_CHILD_CARE Tempat luar rumah yang dikategorikan sebagai penitipan anak.
OOH_VENUE_CINEMA Area luar rumah yang dikategorikan sebagai bioskop.
OOH_VENUE_CITY_INFORMATION_PANELS Area luar rumah yang dikategorikan sebagai panel informasi kota.
OOH_VENUE_CONVENIENCE_STORES Area luar rumah yang dikategorikan sebagai minimarket.
OOH_VENUE_DEDICATED_WILD_POSTING Tempat luar rumah yang dikategorikan sebagai postingan khusus liar.
OOH_VENUE_DOCTORS_OFFICES_GENERAL Tempat luar rumah yang dikategorikan sebagai klinik dokter umum.
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS Tempat luar rumah yang dikategorikan sebagai klinik obstetri dokter.
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS Tempat luar rumah yang dikategorikan sebagai klinik dokter anak.
OOH_VENUE_FAMILY_ENTERTAINMENT Area luar rumah yang dikategorikan sebagai hiburan keluarga.
OOH_VENUE_FERRIES Area luar rumah yang dikategorikan sebagai kapal feri.
OOH_VENUE_FINANCIAL_SERVICES Tempat luar rumah yang dikategorikan sebagai jasa keuangan.
OOH_VENUE_GAS_STATIONS Area luar rumah yang dikategorikan sebagai SPBU.
OOH_VENUE_GOLF_COURSES Arena luar rumah yang dikategorikan sebagai lapangan golf.
OOH_VENUE_GYMS Area luar rumah yang dikategorikan sebagai gym.
OOH_VENUE_HOSPITALS Ruang luar rumah yang dikategorikan sebagai rumah sakit.
OOH_VENUE_HOTELS Area luar rumah yang dikategorikan sebagai hotel.
OOH_VENUE_JUNIOR_POSTERS Area luar rumah dikategorikan sebagai poster junior.
OOH_VENUE_KIOSKS Tempat luar rumah yang dikategorikan sebagai kios.
OOH_VENUE_MALLS_GENERAL Area luar rumah yang dikategorikan sebagai mal umum.
OOH_VENUE_MALLS_FOOD_COURTS Area luar rumah yang dikategorikan sebagai pujasera di mal.
OOH_VENUE_MARINE Area luar rumah yang dikategorikan sebagai laut.
OOH_VENUE_MOBILE_BILLBOARDS Tempat luar rumah yang dikategorikan sebagai baliho seluler.
OOH_VENUE_MOVIE_THEATER_LOBBIES Ruang luar rumah yang dikategorikan sebagai lobi bioskop.
OOH_VENUE_NEWSSTANDS Tempat luar rumah yang dikategorikan sebagai kios.
OOH_VENUE_OFFICE_BUILDINGS Area luar rumah yang dikategorikan sebagai gedung kantor.
OOH_VENUE_PHONE_KIOSKS Tempat luar rumah yang dikategorikan sebagai kios telepon.
OOH_VENUE_POSTERS Area luar rumah dikategorikan sebagai poster.
OOH_VENUE_QSR Tempat luar rumah dikategorikan sebagai qsr.
OOH_VENUE_RAIL Area luar rumah yang dikategorikan sebagai kereta.
OOH_VENUE_RECEPTACLES Area luar rumah yang dikategorikan sebagai wadah.
OOH_VENUE_RESORTS Area luar rumah yang dikategorikan sebagai resor.
OOH_VENUE_RETAIL Tempat luar rumah yang dikategorikan sebagai retail.
OOH_VENUE_SALONS Ruang luar rumah yang dikategorikan sebagai salon.
OOH_VENUE_SHELTERS Area luar rumah yang dikategorikan sebagai tempat penampungan.
OOH_VENUE_SPORTS_ARENAS Arena luar rumah yang dikategorikan sebagai arena olahraga.
OOH_VENUE_SUBWAY Area luar rumah yang dikategorikan sebagai kereta bawah tanah.
OOH_VENUE_TAXIS Area luar rumah yang dikategorikan sebagai taksi.
OOH_VENUE_TRUCKSIDE Area luar rumah yang dikategorikan sebagai jalur truk.
OOH_VENUE_UNIVERSITIES Lokasi luar rumah yang dikategorikan sebagai universitas.
OOH_VENUE_URBAN_PANELS Area luar rumah yang dikategorikan sebagai panel perkotaan.
OOH_VENUE_VETERINARIAN_OFFICES Gedung luar rumah yang dikategorikan sebagai klinik dokter hewan.
OOH_VENUE_WALLS Area luar rumah dikategorikan sebagai dinding.
OOH_VENUE_OTHER Lokasi luar rumah dikategorikan sebagai lainnya.

ImpressionDataRange

Data tayangan untuk rentang tanggal.

Representasi JSON
{
  "impressionDataStartTime": string,
  "impressionDataEndTime": string,
  "impressionDataUnits": [
    {
      object (ImpressionDataUnit)
    }
  ]
}
Kolom
impressionDataStartTime

string (Timestamp format)

Wajib diisi. Awal interval saat data tayangan valid (inklusif).

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

impressionDataEndTime

string (Timestamp format)

Wajib diisi. Akhir interval saat data tayangan valid (eksklusif).

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

impressionDataUnits[]

object (ImpressionDataUnit)

Wajib diisi. Data tayangan untuk rentang tanggal yang ditentukan.

ImpressionDataUnit

Data tayangan untuk hari dan jam tertentu.

Representasi JSON
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
Kolom
dayOfWeek

enum (DayOfWeek)

Wajib diisi. Hari yang diwakili oleh data tayangan.

hourOfDay

integer

Wajib diisi. Jam yang diwakili oleh data tayangan dalam format 24 jam. Harus dari 0 hingga 23.

impressions

string (int64 format)

Wajib diisi. Jumlah tayangan pada hari tertentu pada jam tertentu.

Metode

create

Membuat unit iklan baru.

delete

Menghapus unit iklan yang sudah ada.

get

Mengambil unit iklan individual.

list

Mencantumkan unit iklan.

patch

Memperbarui unit iklan yang ada.