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

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

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

string

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

object (AudienceDimension)

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

integer

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

enum (State)

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

string (Timestamp format)

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

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقة تصل إلى نانوثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "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 إلى خادم طلبات الويب. إنّ استخدام وحدات الربط بالويب اختياري. إذا لم يتم استخدامها، عليك إجراء طلب بحث في واجهة برمجة التطبيقات هذه لتحديد وقت استعداد قائمة الجمهور للاستخدام. تسمح وحدات الويب Hooks بإرسال إشعار إلى خوادمك وتجنُّب الحاجة إلى الاستطلاع.

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

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

الحالة

تتوفّر AudienceList حاليًا في هذه الحالة.

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

الطُرق

create

 لإنشاء قائمة مستخدمين لاستردادها لاحقًا

exportSheet

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

get

 تحصل على بيانات وصفية للإعدادات حول قائمة جمهور معيّنة.

list

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

query

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