Method: domains.list

אחזור רשימה של כל הדומיינים שרשמתם, יחד עם המטא-נתונים התואמים שלהם. סדר הדומיינים בתשובה לא מוגדר ולא ניתן לקבוע אותו. דומיינים שנרשמו לאחרונה לא בהכרח יתווספו לסוף הרשימה הזו.

בקשת HTTP

GET https://gmailpostmastertools.googleapis.com/v2beta/domains

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

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

פרמטרים
pageSize

integer

אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות דומיינים מהמספר שצוין בבקשה. אם לא מציינים ערך, ברירת המחדל של השדה הזה היא 10. הערך המקסימלי בשדה הזה הוא 200.

pageToken

string

אופציונלי. הערך של nextPageToken שמוחזר מבקשת List קודמת, אם יש כזה.

גוף הבקשה

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

גוף התשובה

הודעת תגובה ל-domains.list.

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

ייצוג ב-JSON
{
  "domains": [
    {
      object (Domain)
    }
  ],
  "nextPageToken": string
}
שדות
domains[]

object (Domain)

הדומיינים שהמשתמש רשם.

nextPageToken

string

אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין עוד תוצאות ברשימה.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.domain

מידע נוסף זמין במדריך ההרשאות.