Method: subscriptions.list

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

به صورت اختیاری، این روش می‌تواند پاسخ را با یک customerNamePrefix فیلتر کند. برای اطلاعات بیشتر، به مدیریت اشتراک‌ها مراجعه کنید.

درخواست HTTP

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions

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

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

پارامترها
customerAuthToken

string

رشته پرس و جو customerAuthToken هنگام ایجاد یک حساب فروش مجدد که اشتراک مستقیم مشتری را منتقل می کند یا اشتراک مشتری فروشنده دیگری را به مدیریت فروشنده شما منتقل می کند، مورد نیاز است. این یک نشانه احراز هویت هگزادسیمال است که برای تکمیل انتقال اشتراک مورد نیاز است. برای اطلاعات بیشتر، به مرکز راهنمایی سرپرست مراجعه کنید.

customerId

string

این می تواند نام دامنه اصلی مشتری یا شناسه منحصر به فرد مشتری باشد. اگر نام دامنه برای یک مشتری تغییر کند، نام دامنه قدیمی را نمی توان برای دسترسی به مشتری استفاده کرد، اما شناسه منحصر به فرد مشتری (که توسط API برگردانده شده است) همیشه می تواند استفاده شود. توصیه می کنیم شناسه منحصر به فرد را در صورت لزوم در سیستم های خود ذخیره کنید.

customerNamePrefix

string

هنگام بازیابی همه اشتراک های خود و فیلتر کردن برای مشتریان خاص، می توانید یک پیشوند برای نام مشتری وارد کنید. استفاده از یک گروه مشتری نمونه که شامل exam.com ، example20.com و example.com است:

  • exa - همه نام‌های مشتریانی را که با «exa» شروع می‌شوند، برمی‌گرداند که می‌تواند شامل exam.com ، example20.com ، و example.com باشد. پیشوند نام شبیه به استفاده از ستاره یک عبارت منظم، exa* است.
  • example -- example20.com و example.com را برمی گرداند.

maxResults

integer ( uint32 format)

هنگام بازیابی یک لیست بزرگ، maxResults حداکثر تعداد نتایج در هر صفحه است. مقدار nextPageToken شما را به صفحه بعدی می برد. پیش فرض 20 است.

pageToken

string

نشانه برای تعیین صفحه بعدی در لیست

درخواست بدن

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

بدن پاسخگو

یک اشتراک، رابطه طرح پرداخت مشتری Google با SKU محصول، مجوزهای کاربر، وضعیت آزمایشی رایگان 30 روزه و گزینه‌های تمدید را مدیریت می‌کند. نقش اصلی یک فروشنده این است که اشتراک های مشتری Google را مدیریت کند.

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

نمایندگی JSON 
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
فیلدها
kind

string

منبع را به عنوان مجموعه ای از اشتراک ها شناسایی می کند. ارزش: فروشنده #اشتراک

subscriptions[]

object ( Subscription )

اشتراک در این صفحه از نتایج.

nextPageToken

string

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

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/apps.order
  • https://www.googleapis.com/auth/apps.order.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.