Method: mediaPlanners.list

רשימה של כל החשבונות בכלי לתכנון מדיה שלמבצע הקריאה החוזרת (caller) יש גישה אליהם.

למנהלי אוספים, הפעולה הזו תחזיר את כל מתכנני המדיה שאישרו את התנאים של מנהלי האוספים.

בחשבונות אחרים, ניסיון להציג את מתכנני המדיה יחזיר שגיאה.

בקשת HTTP

GET https://curationpartners.googleapis.com/v1/mediaPlanners

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

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

פרמטרים
pageSize

integer

מספר מתכנני המדיה המקסימלי שיוחזרו. אם לא מציינים ערך, יוחזרו לכל היותר 100 כלי מדיה לתכנון. הערך המקסימלי הוא 500. ערכים גבוהים יותר יומרו ל-500.
pageToken

string

אופציונלי. אסימון שמזהה דף תוצאות שהשרת צריך להחזיר.הערך הזה מתקבל מקריאה קודמת של mediaPlanners.list ב-ListMediaPlannersResponse.nextPageToken.
filter

string

מחרוזת שאילתה אופציונלית באמצעות תחביר הסינון של רשימת Cloud API. העמודות הנתמכות לסינון הן:

  • name
  • displayName
  • ancestorNames

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תשובה שמכילה פרטים על החשבון בכלי לתכנון מדיה.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "mediaPlanners": [
    {
      object (MediaPlanner)
    }
  ],
  "nextPageToken": string
}
שדות
mediaPlanners[]

object (MediaPlanner)

רשימה של מתכנני מדיה.
nextPageToken

string

אסימון שאפשר להעביר לקריאה הבאה של השיטה mediaPlanners.list כדי לאחזר את דף התוצאות הבא ב-ListMediaPlannersRequest.page_token.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/curation-partners

MediaPlanner

מייצג חשבון של הכלי לתכנון מדיה.

ייצוג JSON 
{
  "accountId": string,
  "name": string,
  "displayName": string,
  "ancestorNames": [
    string
  ]
}
שדות
accountId
(deprecated)

string

פלט בלבד. מספר החשבון של כלי תכנון המדיה.
name

string

מזהה. שם המשאב הייחודי של כלי התכנון של המדיה. פורמט: mediaPlanners/{mediaPlannerAccountId} אפשר להשתמש בפרמטר הזה כדי לסנן את התשובה של mediaPlanners.list method.
displayName

string

פלט בלבד. השם המוצג של מתכנן המדיה. אפשר להשתמש בו כדי לסנן את התגובה של השיטה [mediaPlanners.list][google.ads.authorizedbuyers.marketplace.v1main.MediaPlanners.ListMediaPlanners].
ancestorNames[]

string

פלט בלבד. השמות של תוכנית המדיה ברמת האב. פורמט: mediaPlanners/{mediaPlannerAccountId} אפשר להשתמש בפרמטר הזה כדי לסנן את התשובה של mediaPlanners.list method.