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" و"إدارة إحصاءات 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.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
rowCount

integer

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

string

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

number

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

string

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

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

object (WebhookNotification)

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

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

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

ولاية

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

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

الطُرق

create

 تنشئ هذه الطريقة قائمة مستخدمين لاسترجاعها لاحقًا.

get

 تعرض هذه الطريقة بيانات وصفية حول إعدادات قائمة مستخدمين محدّدة.

list

 تعرض هذه الطريقة جميع قوائم المستخدِمين لموقع معيّن.

query

 تستردّ هذه الطريقة قائمة مستخدمين.