Method: properties.audienceLists.list

تمام لیست های مخاطبان یک ملک را فهرست می کند. از این روش می توان برای یافتن و استفاده مجدد از لیست های مخاطبان موجود به جای ایجاد لیست های غیر ضروری مخاطبان جدید استفاده کرد. یک مخاطب می‌تواند چندین فهرست مخاطب داشته باشد که نشان‌دهنده فهرست کاربرانی است که در روزهای مختلف در یک مخاطب بوده‌اند.

برای آشنایی با فهرست مخاطبان همراه با مثال، به ایجاد فهرست مخاطبان مراجعه کنید.

این روش در ثبات بتا در audienceExports.list موجود است. برای ارائه بازخورد خود در مورد این API، فرم بازخورد Google Analytics Audience Export API را تکمیل کنید.

درخواست HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{parent=properties/*}/audienceLists

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

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

پارامترها
parent

string

مورد نیاز. تمام لیست های مخاطبین این ویژگی در پاسخ ذکر می شود. فرمت: properties/{property}

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

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد فهرست مخاطبان برای بازگشت. ممکن است سرویس کمتر از این مقدار برگرداند. اگر نامشخص باشد، حداکثر 200 لیست مخاطب برگردانده می شود. حداکثر مقدار 1000 است (مقادیر بالاتر به حداکثر اعمال می شود).

pageToken

string

اختیاری. یک نشانه صفحه، دریافت شده از تماس قبلی audienceLists.list . این را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده به audienceLists.list باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد.

درخواست بدن

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

بدن پاسخگو

فهرستی از تمام لیست های مخاطبان برای یک ملک.

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

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

object ( AudienceList )

فهرست هر مخاطب برای یک ملک.

nextPageToken

string

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

محدوده مجوز

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

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics