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

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

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

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

string

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

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