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 Overview

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 หรือไม่