Method: accounts.adSources.adapters.list

מפרטים את המתאמים של מקור המודעות.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. האובייקט הראשי שבבעלותו נמצא אוסף המתאמים הזה. פורמט: accounts/{publisherId}/adSources/{adSourceId}

פרמטרים של שאילתה

פרמטרים
pageSize

integer

המספר המקסימלי של מתאמים שיוחזרו. אם לא מציינים ערך או מציינים 0, יוחזרו לכל היותר 10,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.