Method: projects.locations.privateOffers.documents.list

מחזירה רשימה של מסמכי הצעה פרטית להורה שצוין.

בקשת HTTP

GET https://commerceproducer.googleapis.com/v1beta/{parent=projects/*/locations/*/privateOffers/*}/documents

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

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

פרמטרים
parent

string

חובה. ערך האב של ListPrivateOfferDocumentsRequest.

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

פרמטרים
pageSize

integer

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

string

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

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

גוף הבקשה

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

גוף התשובה

הודעה לתגובה ל-PrivateOfferDocuments של כרטיס המוצר

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

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

object (PrivateOfferDocument)

רשימת PrivateOfferDocuments.
nextPageToken

string

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

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • commerceproducer.privateOfferDocuments.list

מידע נוסף מופיע במאמרי העזרה בנושא IAM.