Method: accounts.adUnits.list

แสดงรายการหน่วยโฆษณาภายใต้บัญชี AdMob ที่ระบุ

คำขอ HTTP

GET https://admob.googleapis.com/v1/{parent=accounts/*}/adUnits

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ต้องระบุ ชื่อทรัพยากรของบัญชีที่จะแสดงหน่วยโฆษณา ตัวอย่าง: accounts/pub-9876543210987654

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

จำนวนหน่วยโฆษณาสูงสุดที่จะแสดงผล หากไม่ได้ระบุหรือเป็น 0 ระบบจะแสดงผลหน่วยโฆษณาอย่างน้อย 10,000 รายการ ค่าสูงสุดคือ 20,000 ค่าที่สูงกว่า 20,000 จะถูกบังคับให้เป็น 20,000

pageToken

string

ค่าที่ส่งคืนโดย ListAdUnitsResponse ตัวสุดท้ายระบุว่านี่เป็นการเรียก adUnits.list ต่อเนื่องจากก่อนหน้า และระบบควรส่งคืนข้อมูลหน้าถัดไป

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

การตอบกลับสำหรับคำขอรายการหน่วยโฆษณา

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

การแสดง JSON
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
ช่อง
adUnits[]

object (AdUnit)

หน่วยโฆษณาที่ได้สำหรับบัญชีที่ขอ

nextPageToken

string

หากไม่ว่างเปล่า แสดงว่าคำขออาจมีหน่วยโฆษณาเพิ่มเติม คุณควรส่งค่านี้ใน ListAdUnitsRequest ใหม่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/admob.readonly

ดูข้อมูลเพิ่มเติมได้ที่ OAuth 2.0 Overview

AdUnit

อธิบายหน่วยโฆษณา AdMob

การแสดง JSON
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
ช่อง
name

string

ชื่อทรัพยากรของหน่วยโฆษณานี้ รูปแบบคือ accounts/{publisherId}/adUnits/{ad_unit_id_fragment} ตัวอย่าง: accounts/pub-9876543210987654/adUnits/0123456789

adUnitId

string

รหัสที่มองเห็นได้ภายนอกของหน่วยโฆษณาซึ่งใช้ผสานรวมกับ AdMob SDK ได้ พร็อพเพอร์ตี้นี้เป็นแบบอ่านอย่างเดียว ตัวอย่าง: ca-app-pub-9876543210987654/0123456789

appId

string

รหัสที่มองเห็นได้ภายนอกของแอปที่หน่วยโฆษณานี้เชื่อมโยงอยู่ ตัวอย่าง: ca-app-pub-9876543210987654~0123456789

displayName

string

ชื่อที่แสดงของหน่วยโฆษณาตามที่แสดงใน UI ของ AdMob ซึ่งผู้ใช้เป็นผู้ระบุ ความยาวสูงสุดที่อนุญาตคือ 80 อักขระ

adFormat

string

AdFormat ของหน่วยโฆษณา ค่าที่เป็นไปได้มีดังนี้

"APP_OPEN" - รูปแบบโฆษณาเปิดแอป "BANNER" - รูปแบบโฆษณาแบนเนอร์ "BANNER_INTERSTITIAL" - รูปแบบเดิมที่ใช้เป็นแบนเนอร์หรือโฆษณาคั่นระหว่างหน้าได้ คุณไม่สามารถสร้างรูปแบบนี้ได้อีกต่อไป แต่กำหนดเป้าหมายได้โดยกลุ่มสื่อกลาง "คั่นระหว่างหน้า" - โฆษณาแบบเต็มหน้าจอ ประเภทโฆษณาที่รองรับคือ "RICH_MEDIA" และ "VIDEO" "NATIVE" - รูปแบบโฆษณาเนทีฟ "REWARDED" - โฆษณาที่เมื่อดูแล้วจะได้รับการเรียกกลับเพื่อยืนยันการดูเพื่อให้ระบบให้รางวัลแก่ผู้ใช้ได้ ประเภทโฆษณาที่รองรับคือ "RICH_MEDIA" (โฆษณาแบบอินเทอร์แอกทีฟ) และวิดีโอที่ยกเว้นวิดีโอไม่ได้ "REWARDED_INTERSTITIAL" - รูปแบบโฆษณาคั่นระหว่างหน้าที่มีการให้รางวัล รองรับเฉพาะประเภทโฆษณาวิดีโอ ดู https://support.google.com/admob/answer/9884467

adTypes[]

string

ประเภทสื่อโฆษณาที่หน่วยโฆษณานี้รองรับ ค่าที่เป็นไปได้มีดังนี้

"RICH_MEDIA" - ข้อความ รูปภาพ และสื่ออื่นๆ ที่ไม่ใช่แบบวิดีโอ "วิดีโอ" - สื่อวิดีโอ