Method: properties.audienceLists.query

تستردّ هذه الطريقة قائمة مستخدمين. بعد إنشاء شريحة جمهور، لا يكون المستخدمون متاحين على الفور لإدراجهم في القائمة. أولاً، يجب إرسال طلب إلى audienceLists.create لإنشاء قائمة مستخدمين، ثم يتم استخدام هذا الإجراء لاسترداد المستخدمين في قائمة المستخدمين.

راجِع مقالة إنشاء قائمة مستخدمين للحصول على مقدّمة عن قوائم المستخدمين مع أمثلة.

تتيح لك شرائح الجمهور في "إحصاءات Google‏ 4" تقسيم المستخدمين بالطرق التي تمثّل أهمية بالنسبة إلى نشاطك التجاري. لمزيد من المعلومات، يُرجى الاطّلاع على https://support.google.com/analytics/answer/9267572.

تتوفّر هذه الطريقة في إصدار تجريبي ثابت على audienceExports.query. لتقديم ملاحظاتك وآرائك عن واجهة برمجة التطبيقات هذه، يُرجى ملء نموذج ملاحظات وآراء عن Audience Export API في "إحصاءات Google".

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المعلمات
name

string

الحقل مطلوب. اسم قائمة المستخدِمين التي سيتم استرداد المستخدِمين منها. التنسيق: properties/{property}/audienceLists/{audienceList}

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "offset": string,
  "limit": string
}
الحقول
offset

string (int64 format)

اختياريّ. عدد الصفوف في صف البداية. يتم احتساب الصف الأول على أنّه الصف 0.

عند تقسيم النتائج إلى صفحات، لا يحدّد الطلب الأول الإزاحة، أو يضبط الإزاحة على 0، ويعرض الطلب الأول أول limit من الصفوف. يضبط الطلب الثاني الإزاحة على limit من الطلب الأول، ويعرض الطلب الثاني limit الثاني من الصفوف.

لمزيد من المعلومات عن مَعلمة التقسيم على صفحات، اطّلِع على التقسيم على صفحات.
limit

string (int64 format)

اختياريّ. عدد الصفوف المطلوب عرضها. إذا لم يتم تحديدها، سيتم عرض 10,000 صف. تعرض واجهة برمجة التطبيقات 250,000 صف كحدّ أقصى لكل طلب، بغض النظر عن عدد الصفوف التي تطلبها. يجب أن تكون قيمة limit موجبة.

يمكن أن تعرض واجهة برمجة التطبيقات أيضًا عددًا أقل من الصفوف من limit المطلوب، إذا لم تتوفر قيم سمات بعدد limit.

لمزيد من المعلومات عن مَعلمة التقسيم على صفحات، اطّلِع على التقسيم على صفحات.

نص الاستجابة

قائمة بالمستخدمين في قائمة مستخدمين

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
الحقول
audienceRows[]

object (AudienceRow)

صفوف لكل مستخدم في قائمة مستخدمين سيكون عدد الصفوف في هذا الرد أقل من حجم الصفحة في الطلب أو مساويًا له.
audienceList

object (AudienceList)

بيانات الإعداد حول AudienceList التي يتمّ طلب البحث عنها. تم إرجاعها للمساعدة في تفسير صفوف الجمهور في هذه الاستجابة. على سبيل المثال، تتوافق السمات في AudienceList مع الأعمدة في AudienceRows.
rowCount

integer

إجمالي عدد الصفوف في نتيجة AudienceList. إنّ rowCount مستقل عن عدد الصفوف المعروضة في الاستجابة، ومَعلمة الطلب limit، ومَعلمة الطلب offset. على سبيل المثال، إذا عرض طلب بحث 175 صفًا وتضمّن limit من 50 في طلب بيانات من واجهة برمجة التطبيقات، ستحتوي الاستجابة على rowCount من 175 ولكن 50 صفًا فقط.

لمزيد من المعلومات عن مَعلمة التقسيم على صفحات، اطّلِع على التقسيم على صفحات.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

AudienceRow

سمات قيمة السمة لصف مستخدم الجمهور

تمثيل JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
الحقول
dimensionValues[]

object (AudienceDimensionValue)

كل سمة من سمات قيم السمات لمستخدِم شريحة الجمهور. ستتم إضافة قيمة سمة واحدة لكل عمود سمة مطلوب.

AudienceDimensionValue

تمثّل هذه السمة قيمة إحدى السمات.

تمثيل JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
الحقول
نوع واحد من قيم السمات في ما يلي قائمة بالحقول التي يستبعد كلّ منها الآخر. سيتم ضبط حقل واحد على الأكثر في الردّ:
value

string

القيمة كسلسلة إذا كان نوع السمة سلسلة
نهاية الحقول التي يستبعد كلّ منها الآخر