Method: properties.audienceLists.query

فهرست مخاطبان کاربران را بازیابی می کند. پس از ایجاد مخاطب، کاربران فوراً برای فهرست کردن در دسترس نیستند. اولاً برای ایجاد لیست مخاطبین از کاربران درخواستی از audienceLists.create ضروری است و سپس از این روش برای بازیابی کاربران در لیست مخاطبان استفاده می شود.

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

مخاطبان در Google Analytics 4 به شما این امکان را می دهند که کاربران خود را به روش هایی که برای کسب و کار شما مهم هستند تقسیم بندی کنید. برای کسب اطلاعات بیشتر، به https://support.google.com/analytics/answer/9267572 مراجعه کنید.

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

درخواست HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

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

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

پارامترها
name

string

مورد نیاز. نام لیست مخاطبان برای بازیابی کاربران. قالب: properties/{property}/audienceLists/{audienceList}

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "offset": string,
  "limit": string
}
فیلدها
offset

string ( int64 format)

اختیاری. تعداد ردیف ردیف شروع. ردیف اول به عنوان ردیف 0 محاسبه می شود.

هنگام صفحه بندی، اولین درخواست افست را مشخص نمی کند. یا به طور معادل، افست را روی 0 تنظیم می کند. اولین درخواست اولین limit ردیف ها را برمی گرداند. درخواست دوم افست را تا limit درخواست اول تنظیم می کند. درخواست دوم limit دوم ردیف ها را برمی گرداند.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید برگردانده شوند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

بدن پاسخگو

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

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

نمایندگی JSON 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
فیلدها
audience Rows[]

object ( AudienceRow )

ردیف‌هایی برای هر کاربر در فهرست مخاطبان. تعداد ردیف‌های این پاسخ کمتر یا مساوی اندازه صفحه درخواست خواهد بود.

audience List

object ( AudienceList )

داده‌های پیکربندی درباره AudienceList در حال پرسش است. برای کمک به تفسیر ردیف‌های مخاطب در این پاسخ، بازگشت. برای مثال، ابعاد در این AudienceList با ستون‌های AudienceRows مطابقت دارد.

row Count

integer

تعداد کل ردیف ها در نتیجه AudienceList. rowCount مستقل از تعداد سطرهای برگردانده شده در پاسخ، پارامتر درخواست limit و پارامتر درخواست offset است. به عنوان مثال اگر یک پرس و جو 175 ردیف را برمی گرداند و شامل limit 50 در درخواست API می شود، پاسخ شامل rowCount 175 اما فقط 50 ردیف خواهد بود.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

محدوده مجوز

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

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

AudienceRow

ویژگی های مقدار ابعاد برای ردیف کاربر مخاطب.

نمایندگی JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
فیلدها
dimension Values[]

object ( AudienceDimensionValue )

هر ویژگی ارزش بعد برای یک کاربر مخاطب. برای هر ستون بعد درخواستی یک مقدار بعد اضافه می شود.

AudienceDimensionValue

ارزش یک بعد

نمایندگی JSON 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
فیلدها
فیلد اتحادیه one_value . یک نوع ارزش ابعادی. one_value تنها می تواند یکی از موارد زیر باشد:
value

string

اگر نوع بعد یک رشته است، مقدار را به عنوان یک رشته تعیین کنید.