REST Resource: properties.audienceLists

المرجع: AudienceList

قائمة المستخدمين هي قائمة بالمستخدِمين في شريحة جمهور معيّنة وقت إنشاء القائمة. قد يكون لدى شريحة جمهور واحدة قوائم مستخدمين متعددة تم إنشاؤها لأيام مختلفة.

تمثيل JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
الحقول
name

string

النتائج فقط. المُعرّف. اسم مورد قائمة المستخدمين الذي تم تحديده أثناء الإنشاء. يحدّد اسم المورد هذا AudienceList.

تنسيق الملف: properties/{property}/audienceLists/{audienceList}
audience

string

مطلوب. اسم مورد الجمهور. يُحدِّد اسم المورد هذا الجمهور المُدرج والذي تتم مشاركته بين بيانات "إحصاءات Google" واجهات برمجة تطبيقات المشرف.

تنسيق الملف: properties/{property}/audiences/{audience}
audienceDisplayName

string

النتائج فقط. الاسم المعروض الوصفي لهذا الجمهور. على سبيل المثال، "المشترون".
dimensions[]

object (AudienceDimension)

مطلوب. السمات المطلوبة وعرضها في الردّ على طلب البحث
creationQuotaTokensCharged

integer

النتائج فقط. إجمالي رموز الحصة المميّزة التي تم تحصيلها أثناء إنشاء AudienceList. بما أنّ عدد الرموز المميّزة هذا يستند إلى النشاط في حالة CREATING، سيتم إصلاح الرموز المميّزة التي يتم تحصيل رسومها بعد إدخال AudienceList للحالة ACTIVE أو FAILED.
state

enum (State)

النتائج فقط. الحالة الحالية لقائمة AudienceList هذه.
beginCreatingTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه استدعاء audienceLists.create وبدأت AudienceList في حالة CREATING.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
rowCount

integer

النتائج فقط. إجمالي عدد الصفوف في نتيجة AudienceList.
errorMessage

string

النتائج فقط. تتم تعبئة رسالة الخطأ عند تعذُّر إنشاء قائمة مستخدمين أثناء الإنشاء. ومن الأسباب الشائعة لهذا الإخفاق هو استنفاد الحصة.
percentageCompleted

number

النتائج فقط. النسبة المئوية المكتملة لعملية تصدير شرائح الجمهور هذه التي تتراوح بين 0 و100.
recurringAudienceList

string

النتائج فقط. قائمة المستخدمين المتكرّرة التي أنشأت قائمة المستخدمين هذه. تنشئ قوائم المستخدمين المتكرّرة قوائم المستخدمين يوميًا.

في حال إنشاء قوائم المستخدمين مباشرةً، لن يكون لها أي قائمة مستخدمين متكرّرة مرتبطة بها، وسيكون هذا الحقل فارغًا.
webhookNotification

object (WebhookNotification)

اختياريّ. تضبط إشعارات الردّ التلقائي على الويب ليتم إرسالها من Google Analytics Data API إلى خادم الرد التلقائي على الويب. تجدر الإشارة إلى أنّ استخدام الردود التلقائية على الويب هو إجراء اختياري. وفي حال عدم استخدامها، ستحتاج إلى استطلاع واجهة برمجة التطبيقات هذه لتحديد متى تكون قائمة المستخدمين جاهزة للاستخدام. تسمح الردود التلقائية على الويب بإرسال إشعار إلى خوادمك لتجنب الحاجة إلى إجراء استطلاعات

سيتم إرسال طلب أو طلبَين من طلبات POST إلى الردّ التلقائي على الويب. سيتم إرسال طلب POST الأول على الفور مع إظهار قائمة المستخدمين التي تم إنشاؤها حديثًا في حالتها المنشئة. سيتم إرسال طلب POST الثاني بعد اكتمال إنشاء قائمة المستخدمين (إما الحالة "نشط" أو "تعذّر الإجراء").

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

الحالة

قائمة AudienceList موجودة حاليًا في هذه الحالة.

عمليات التعداد
STATE_UNSPECIFIED ولن يتم مطلقًا استخدام الحالة غير المحدّدة.
CREATING جارٍ إنشاء قائمة الجمهور حاليًا وستكون متاحة في المستقبل. يتم الإنشاء مباشرةً بعد استدعاء audienceLists.create.
ACTIVE تم إنشاء قائمة AudienceList بالكامل وهي جاهزة لطلبات البحث. يتم تعديل قائمة AudienceList إلى نشاط غير متزامن من الطلب. يستغرق ذلك بعض الوقت (مثلاً 15 دقيقة) بعد إنشاء طلب الإنشاء.
FAILED تعذّر إنشاء قائمة الجمهور. من الممكن أن تنجح إعادة طلب قائمة المستخدمين هذه.

الطُرق

create

 ينشئ قائمة مستخدمين لاستردادها في وقت لاحق.

exportSheet

 يصدِّر قائمة مستخدمين إلى جدول بيانات Google.

get

 الحصول على بيانات وصفية حول قائمة مستخدمين معيّنة

list

 يسرد جميع قوائم المستخدمين لأحد المواقع.

query

 يسترد قائمة المستخدمين.