רשימת כל הנציגים שמשויכים למותג מסוים.
בקשת HTTP
GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. המזהה הייחודי של המותג. אם מזהה המותג הוא 1234, הפרמטר הזה מקבל את הערך 'brands/1234'. מזהה המותג חייב להיות "-" כדי להחזיר את כל הנציגים של ספק RBM. |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
מציינים את המספר המקסימלי של תוצאות שהשרת יחזיר. השרת עשוי להגביל עוד יותר את המספר המרבי של תוצאות שהוחזרו בדף יחיד. אם pageSize הוא 0, השרת יקבע את מספר התוצאות שיוחזרו. |
pageToken |
הערך nextPageToken שהוחזר מבקשת רשימה קודמת, אם הייתה כזו. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
רשימה של נציגים.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"agents": [
{
object ( |
שדות | |
---|---|
agents[] |
רשימת פרטי הנציג. |
nextPageToken |
אסימון העימוד שנועד לאחזר את דף התוצאות הבא. אם הערך הוא '', המשמעות היא שאין תוצאות נוספות לבקשה. |