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.