Method: accounts.adSources.adapters.list

แสดงรายการอะแดปเตอร์ของแหล่งที่มาของโฆษณา

คำขอ HTTP

GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters

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

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

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

string

ต้องระบุ หลักที่เป็นเจ้าของคอลเล็กชันของอะแดปเตอร์นี้ รูปแบบ: บัญชี/{publisherId}/adSources/{adSourceId}

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

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

integer

จำนวนอะแดปเตอร์สูงสุดที่จะแสดง หากไม่ระบุหรือ 0 ระบบจะแสดงผลอะแดปเตอร์ไม่เกิน 10,000 รายการ ค่าสูงสุดคือ 20,000 ค่าที่มากกว่า 20,000 จะถูกเปลี่ยนเป็น 20,000

pageToken

string

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

เนื้อหาของคำขอ

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

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

การตอบกลับสำหรับ ListAdaptersRequest

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

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

object (Adapter)

อะแดปเตอร์

nextPageToken

string

ใช้เพื่อตั้งค่า pageToken ใน ListAdapterRequest เพื่อดึงข้อมูลหน้าถัดไป หากเว้นช่องนี้ไว้ จะไม่มีหน้าลำดับต่อมา

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

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0

Adapter

อธิบายอะแดปเตอร์ที่รองรับโดยแหล่งที่มาของโฆษณาสื่อกลางแต่ละแหล่ง

อะแดปเตอร์จะสอดคล้องกับการใช้งาน SDK ที่เฉพาะเจาะจงของแหล่งที่มาของโฆษณา แต่ละรายการเชื่อมโยงกับแพลตฟอร์มเดียวและรายการรูปแบบหน่วยโฆษณาที่รองรับ นอกจากนี้อะแดปเตอร์อาจต้องมีการกำหนดค่าบางอย่างเพื่อดำเนินการส่งคำขอโฆษณา คุณสามารถระบุการกำหนดค่าใน AdUnitMapping ได้โดยการตั้งค่าคู่คีย์/ค่า adUnitConfigurations เช่น adUnitConfigurations สามารถใช้เพื่อส่งต่อรหัสต่างๆ ไปยัง SDK บุคคลที่สามของอะแดปเตอร์ได้

การแสดง JSON
{
  "name": string,
  "adapterId": string,
  "title": string,
  "platform": string,
  "formats": [
    string
  ],
  "adapterConfigMetadata": [
    {
      object (AdapterConfigMetadata)
    }
  ]
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของอะแดปเตอร์ รูปแบบคือ

accounts/{publisherId}/adSources/{adSourceId}/adapters/{adapterId}.

adapterId

string

เอาต์พุตเท่านั้น รหัสของอะแดปเตอร์นี้ โดยใช้เพื่อตั้งค่า adapterId

title

string

เอาต์พุตเท่านั้น ชื่อที่แสดงของอะแดปเตอร์นี้

platform

string

เอาต์พุตเท่านั้น แพลตฟอร์มแอปพลิเคชันบนอุปกรณ์เคลื่อนที่ที่อะแดปเตอร์นี้รองรับ

ค่าที่รองรับ ได้แก่ iOS, ANDROID, WINDOWS_PHONE

formats[]

string

เอาต์พุตเท่านั้น ระบุรูปแบบของหน่วยโฆษณาที่อะแดปเตอร์นี้รองรับ

adapterConfigMetadata[]

object (AdapterConfigMetadata)

เอาต์พุตเท่านั้น ข้อมูลเมตาของการกำหนดค่าที่เชื่อมโยงกับอะแดปเตอร์นี้

AdapterConfigMetadata

ข้อมูลเมตาของการกำหนดค่าที่เชื่อมโยงกับอะแดปเตอร์นี้ โดยจะใช้เพื่อกำหนด adUnitConfigurations ที่เชื่อมโยงกับ AdUnitMappings สำหรับอะแดปเตอร์นี้

การแสดง JSON
{
  "adapterConfigMetadataId": string,
  "adapterConfigMetadataLabel": string,
  "isRequired": boolean
}
ช่อง
adapterConfigMetadataId

string

โดยจะใช้ในการเติมคีย์ของ adUnitConfigurations

adapterConfigMetadataLabel

string

ชื่อของข้อมูลเมตาการกำหนดค่าอะแดปเตอร์

isRequired

boolean

ระบุว่าต้องใช้ข้อมูลเมตานี้สำหรับการกำหนดค่า AdUnitMappings หรือไม่