Method: brands.agents.list

تمام عوامل مرتبط با یک برند را فهرست می کند.

درخواست HTTP

GET https://businesscommunications.googleapis.com/v1/{parent=brands/*}/agents

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
parent

string

ضروری. شناسه منحصر به فرد برند. اگر شناسه برند "1234" باشد، این پارامتر به "brands/1234" تغییر می کند. شناسه برند باید "-" باشد تا همه عوامل یک حامل RBM را برگرداند.

پارامترهای پرس و جو

مولفه های
pageSize

integer

حداکثر تعداد نتایجی که باید توسط سرور برگردانده شود را مشخص کنید. سرور ممکن است حداکثر تعداد نتایج بازگردانده شده در یک صفحه را بیشتر محدود کند. اگر pageSize 0 باشد، سرور تعداد نتایجی که باید برگردانده شود را تعیین می کند.

pageToken

string

مقدار nextPageToken از یک درخواست لیست قبلی، در صورت وجود، برگردانده شده است.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

لیستی از نمایندگان

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "agents": [
    {
      object (Agent)
    }
  ],
  "nextPageToken": string
}
زمینه های
agents[]

object ( Agent )

لیست اطلاعات نماینده

nextPageToken

string

نشانه صفحه بندی برای بازیابی صفحه بعدی نتایج. اگر مقدار "" باشد، به این معنی است که هیچ نتیجه دیگری برای درخواست وجود ندارد.