REST Resource: adUnits

แหล่งข้อมูล: หน่วยโฆษณา

หน่วยโฆษณาเดียว

การแสดง 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
  ]
}
ช่อง
name

string

ชื่อทรัพยากรของหน่วยโฆษณาในรูปแบบ: adUnits/{id} เช่น adUnits/adUnit123
externalId

string

ไม่บังคับ รหัสที่จัดการโดยผู้ขายน่าจะอยู่ในระบบของตน เมื่อตั้งค่าแล้วไม่น่าจะเปลี่ยนแปลง ซึ่งไม่ควรใช้เป็นการภายในและไม่บังคับใช้ข้อจำกัด
displayName

string

ต้องระบุ ชื่อที่แสดงของหน่วยโฆษณา

ต้องเป็น UTF-8 ที่เข้ารหัสขนาดไม่เกิน 240 ไบต์
description

string

ไม่บังคับ ช่องรูปแบบอิสระเพิ่มเติมสำหรับอธิบายหน่วยโฆษณา
labels

map (key: string, value: string)

ไม่บังคับ ชุดป้ายกำกับรูปแบบอิสระเพื่ออธิบายหน่วยโฆษณานี้

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่างเช่น { "name": "wrench", "mass": "1.3kg", "count": "3" }
attributes[]

enum (AdUnitAttribute)

ไม่บังคับ แอตทริบิวต์เพื่อกำหนดหน่วยโฆษณานี้เพิ่มเติม
creatives[]

object (CreativeSpecification)

ไม่บังคับ รายการครีเอทีฟโฆษณาที่อนุญาตซึ่งแสดงสำหรับหน่วยโฆษณานี้ได้ ซึ่งอาจกำหนดไว้ที่ระดับผลิตภัณฑ์
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาการสร้างสำหรับหน่วยโฆษณา

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่อัปเดตล่าสุดสำหรับหน่วยโฆษณา

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
state

enum (AdUnitState)

เอาต์พุตเท่านั้น สถานะของหน่วยโฆษณา หาก AD_UNIT_STATE_REJECTED เหตุผลที่ปฏิเสธจะมีเหตุผลอยู่
rejectedReason

string

เอาต์พุตเท่านั้น หากสถานะการอนุมัติเป็น AD_UNIT_APPROVAL_STATUS_REJECTED ช่องนี้จะมีเหตุผล
location

object (LatLng)

ต้องระบุ เปลี่ยนแปลงไม่ได้ ละติจูดและลองจิจูดของหน่วยโฆษณาในรูปแบบองศาแบบมีเครื่องหมาย
directionSet

boolean

ต้องระบุ เป็นจริงหากตั้งค่าทิศทางไว้
direction

integer

ไม่บังคับ เปลี่ยนแปลงไม่ได้ ทิศทางหลักเป็นองศาโดยทิศเหนือมีค่าเป็น 0 [0-360)
elevationMetersSet

boolean

ต้องระบุ เป็นจริงหากตั้งค่าระดับความสูงไว้
elevationMeters

number

ไม่บังคับ เปลี่ยนแปลงไม่ได้ ระยะทางจากด้านล่างของหน่วยโฆษณาถึงพื้นในหน่วยเมตร
physicalWidthMetersSet

boolean

ต้องระบุ เป็นจริงหากตั้งค่าPhysicalWidthMeters ไว้
physicalWidthMeters

number

ไม่บังคับ เปลี่ยนแปลงไม่ได้ ความกว้างทางกายภาพของหน่วยโฆษณาในหน่วยเมตร
physicalHeightMetersSet

boolean

ต้องระบุ เป็นจริงหากตั้งค่าPhysicalHeightMeters ไว้
physicalHeightMeters

number

ไม่บังคับ เปลี่ยนแปลงไม่ได้ ความสูงทางกายภาพของหน่วยโฆษณาในหน่วยเมตร
venue

enum (OutOfHomeVenue)

ไม่บังคับ ประเภทสถานที่นอกบ้านตามมาตรฐาน DPAA นี่คือฟิลด์ข้อมูลที่สามารถนำเสนอต่อผู้ลงโฆษณาและสามารถใช้เพื่อกรองหน่วยโฆษณาได้
fixedLocation

boolean

ไม่บังคับ โฆษณานั้นอยู่ในตำแหน่งที่คงที่ (บิลบอร์ด) หรือกำลังเคลื่อนที่ (รถแท็กซี่)
indoors

boolean

ต้องระบุ ระบุว่าหน่วยโฆษณาอยู่ภายในอาคารหรือไม่
impressionDataRanges[]

object (ImpressionDataRange)

ต้องระบุ ช่วงข้อมูลการแสดงผลที่เชื่อมโยงกับหน่วยโฆษณานี้ ช่วงวันที่ไม่ควรซ้อนทับกัน หน่วยโฆษณาต้องมีข้อมูลการแสดงผลจึงจะมีสิทธิ์ซื้อ
photoUrls[]

string

ไม่บังคับ URL รูปภาพของหน่วยโฆษณา
products[]

string

ต้องระบุ ชื่อทรัพยากรของผลิตภัณฑ์ที่เชื่อมโยงกับหน่วยโฆษณานี้ซึ่งอยู่ในรูปแบบ products/{id} เช่น products/product123

AdUnitAttribute

แอตทริบิวต์ที่เป็นไปได้ซึ่งใช้เพื่อกำหนดหน่วยโฆษณาเพิ่มเติม

Enum
AD_UNIT_ATTRIBUTE_UNSPECIFIED ค่าเริ่มต้นเมื่อไม่ได้ระบุแอตทริบิวต์หน่วยโฆษณาหรือไม่รู้จักในเวอร์ชันนี้
AD_UNIT_ATTRIBUTE_ILLUMINATED หน่วยโฆษณามองเห็นได้ในที่มืดหรือไม่หากอยู่ในโลกแห่งความเป็นจริง
AD_UNIT_ATTRIBUTE_DIGITAL โดยบอกเป็นนัยถึงหน่วยโฆษณาดิจิทัล (หากไม่ได้ใส่ไว้)
AD_UNIT_ATTRIBUTE_PHYSICAL หน่วยโฆษณาเป็นเหมือนวัตถุในโลกจริง

AdUnitState

สถานะของหน่วยโฆษณาจากมุมมองของผู้ขาย

Enum
AD_UNIT_STATE_UNSPECIFIED ค่าเริ่มต้นเมื่อไม่ได้ระบุสถานะหน่วยโฆษณาหรือไม่รู้จักในเวอร์ชันนี้
AD_UNIT_STATE_PENDING หน่วยโฆษณากำลังรอการอนุมัติ
AD_UNIT_STATE_APPROVED หน่วยโฆษณาได้รับอนุมัติ
AD_UNIT_STATE_REJECTED หน่วยโฆษณาถูกปฏิเสธ
AD_UNIT_STATE_DELETED ลบหน่วยโฆษณาแล้ว

OutOfHomeVenue

รายการประเภทสถานที่นอกบ้านตามมาตรฐาน DPAA

Enum
OOH_VENUE_UNSPECIFIED ค่าเริ่มต้นเมื่อไม่ได้ระบุ OOH Venue หรือไม่รู้จักในเวอร์ชันนี้
OOH_VENUE_AIRBORNE สถานที่นอกบ้านจัดอยู่ในหมวดหมู่ทางอากาศ
OOH_VENUE_AIRPORTS_GENERAL สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่สนามบินทั่วไป
OOH_VENUE_AIRPORTS_BAGGAGE_CLAIM สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่จุดรับสัมภาระที่สนามบิน
OOH_VENUE_AIRPORTS_TERMINAL สถานที่อยู่นอกบ้านที่จัดอยู่ในหมวดหมู่อาคารผู้โดยสารของสนามบิน
OOH_VENUE_AIRPORTS_LOUNGES สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่เลานจ์ในสนามบิน
OOH_VENUE_ATMS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่ตู้เอทีเอ็ม
OOH_VENUE_BACKLIGHTS สถานที่นอกบ้านจัดอยู่ในหมวดหมู่แบ็กไลต์
OOH_VENUE_BARS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่บาร์
OOH_VENUE_BENCHES ที่นั่งนอกบ้านที่จัดอยู่ในหมวดหมู่ม้านั่ง
OOH_VENUE_BIKE_RACKS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่แร็คจักรยาน
OOH_VENUE_BULLETINS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่กระดานข่าวสาร
OOH_VENUE_BUSES สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่รถประจำทาง
OOH_VENUE_CAFES ประกาศนอกบ้านที่จัดอยู่ในหมวดหมู่คาเฟ่
OOH_VENUE_CASUAL_DINING_RESTAURANTS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่ร้านอาหารบรรยากาศสบายๆ
OOH_VENUE_CHILD_CARE สถานรับเลี้ยงเด็กนอกบ้านที่จัดอยู่ในหมวดหมู่การดูแลเด็ก
OOH_VENUE_CINEMA สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่โรงภาพยนตร์
OOH_VENUE_CITY_INFORMATION_PANELS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่แผงข้อมูลของเมือง
OOH_VENUE_CONVENIENCE_STORES ประกาศนอกบ้านที่จัดอยู่ในหมวดหมู่ร้านสะดวกซื้อ
OOH_VENUE_DEDICATED_WILD_POSTING สนามนอกบ้านที่จัดอยู่ในหมวดหมู่การประกาศป่าสงวน
OOH_VENUE_DOCTORS_OFFICES_GENERAL สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่สำนักงานแพทย์ทั่วไป
OOH_VENUE_DOCTORS_OFFICES_OBSTETRICS สถานพยาบาลนอกบ้านที่จัดอยู่ในหมวดหมู่คลินิกสูติศาสตร์ของแพทย์
OOH_VENUE_DOCTORS_OFFICES_PEDIATRICS สถานพยาบาลนอกบ้านที่จัดอยู่ในหมวดหมู่สำนักงานแพทย์กุมารเวชศาสตร์
OOH_VENUE_FAMILY_ENTERTAINMENT สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่ความบันเทิงสำหรับครอบครัว
OOH_VENUE_FERRIES ประกาศนอกบ้านที่จัดอยู่ในหมวดหมู่เรือข้ามฟาก
OOH_VENUE_FINANCIAL_SERVICES สถานประกอบการนอกบ้านที่จัดอยู่ในหมวดหมู่บริการทางการเงิน
OOH_VENUE_GAS_STATIONS ประกาศนอกบ้านที่จัดอยู่ในหมวดหมู่ปั๊มน้ำมัน
OOH_VENUE_GOLF_COURSES สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่สนามกอล์ฟ
OOH_VENUE_GYMS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่ฟิตเนส
OOH_VENUE_HOSPITALS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่โรงพยาบาล
OOH_VENUE_HOTELS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่โรงแรม
OOH_VENUE_JUNIOR_POSTERS โฆษณานอกบ้านที่จัดอยู่ในหมวดหมู่โปสเตอร์สำหรับรุ่นจูเนียร์
OOH_VENUE_KIOSKS โฆษณานอกบ้านที่จัดอยู่ในหมวดหมู่คีออสก์
OOH_VENUE_MALLS_GENERAL สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่ศูนย์การค้าทั่วไป
OOH_VENUE_MALLS_FOOD_COURTS สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่ศูนย์อาหารของห้างสรรพสินค้า
OOH_VENUE_MARINE สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่ทะเล
OOH_VENUE_MOBILE_BILLBOARDS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่บิลบอร์ดบนอุปกรณ์เคลื่อนที่
OOH_VENUE_MOVIE_THEATER_LOBBIES สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่ล็อบบี้ของโรงภาพยนตร์
OOH_VENUE_NEWSSTANDS สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่แผงข่าว
OOH_VENUE_OFFICE_BUILDINGS ประกาศนอกบ้านที่จัดอยู่ในหมวดหมู่อาคารสำนักงาน
OOH_VENUE_PHONE_KIOSKS นอกบ้านที่จัดอยู่ในหมวดหมู่ตู้โทรศัพท์
OOH_VENUE_POSTERS โฆษณานอกบ้านที่จัดอยู่ในหมวดหมู่โปสเตอร์
OOH_VENUE_QSR สถานที่นอกบ้านจัดอยู่ในหมวดหมู่ QSr
OOH_VENUE_RAIL ประกาศนอกบ้านที่จัดอยู่ในหมวดหมู่รถไฟ
OOH_VENUE_RECEPTACLES ไม่ได้อยู่ในสถานที่ในบ้านที่จัดอยู่ในหมวดหมู่อ่างล้างจาน
OOH_VENUE_RESORTS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่รีสอร์ต
OOH_VENUE_RETAIL ประกาศขายนอกบ้านที่จัดอยู่ในหมวดหมู่ค้าปลีก
OOH_VENUE_SALONS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่ร้านเสริมสวย
OOH_VENUE_SHELTERS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่ที่พักพิง
OOH_VENUE_SPORTS_ARENAS สถานที่กลางแจ้งที่จัดอยู่ในหมวดหมู่สนามกีฬา
OOH_VENUE_SUBWAY สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่รถไฟใต้ดิน
OOH_VENUE_TAXIS ประกาศนอกบ้านที่จัดอยู่ในหมวดหมู่แท็กซี่
OOH_VENUE_TRUCKSIDE อยู่นอกบ้านที่จัดอยู่ในหมวดรถบรรทุก
OOH_VENUE_UNIVERSITIES สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่มหาวิทยาลัย
OOH_VENUE_URBAN_PANELS สถานที่นอกบ้านที่จัดอยู่ในหมวดหมู่แผงในเมือง
OOH_VENUE_VETERINARIAN_OFFICES สถานประกอบการนอกบ้านที่จัดอยู่ในหมวดหมู่สำนักงานสัตวแพทย์
OOH_VENUE_WALLS ไม่ได้อยู่ในสถานที่ในบ้านที่จัดอยู่ในหมวดหมู่กำแพง
OOH_VENUE_OTHER สถานที่นอกบ้านจัดอยู่ในหมวดหมู่อื่นๆ

ImpressionDataRange

ข้อมูลการแสดงผลสำหรับช่วงวันที่

การแสดง JSON 
{
  "impressionDataStartTime": string,
  "impressionDataEndTime": string,
  "impressionDataUnits": [
    {
      object (ImpressionDataUnit)
    }
  ]
}
ช่อง
impressionDataStartTime

string (Timestamp format)

ต้องระบุ จุดเริ่มต้นของช่วงเวลาที่ข้อมูลการแสดงผลถูกต้อง (รวม)

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
impressionDataEndTime

string (Timestamp format)

ต้องระบุ จุดสิ้นสุดของช่วงเวลาที่ข้อมูลการแสดงผลถูกต้อง (ไม่รวม)

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
impressionDataUnits[]

object (ImpressionDataUnit)

ต้องระบุ ข้อมูลการแสดงผลสำหรับช่วงวันที่ที่ระบุ

ImpressionDataUnit

ข้อมูลการแสดงผลสำหรับวันของสัปดาห์และชั่วโมงของวัน

การแสดง JSON 
{
  "dayOfWeek": enum (DayOfWeek),
  "hourOfDay": integer,
  "impressions": string
}
ช่อง
dayOfWeek

enum (DayOfWeek)

ต้องระบุ วันในสัปดาห์ที่แสดงข้อมูลการแสดงผล
hourOfDay

integer

ต้องระบุ จำนวนชั่วโมงของวันที่ข้อมูลการแสดงผลจะแสดงในรูปแบบ 24 ชั่วโมง ควรอยู่ในช่วง 0 ถึง 23
impressions

string (int64 format)

ต้องระบุ จำนวนการแสดงผลในวันของสัปดาห์ ณ เวลาที่ระบุของวัน

เมธอด

create

 สร้างหน่วยโฆษณาใหม่

delete

 ลบหน่วยโฆษณาที่มีอยู่

get

 ดึงข้อมูลหน่วยโฆษณาเดี่ยว

list

 แสดงรายการหน่วยโฆษณา

patch

 อัปเดตหน่วยโฆษณาที่มีอยู่