Method: accounts.adSources.adapters.list

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

คำขอ HTTP

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

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

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

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

string

ต้องระบุ ระดับบนสุดที่เป็นเจ้าของคอลเล็กชันของอะแดปเตอร์นี้ รูปแบบ: accounts/{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 ไหม