المرجع: AudienceList
قائمة المستخدمين هي قائمة بالمستخدمين في شريحة جمهور معيّنة في وقت إنشاء القائمة. قد يكون لشريحة جمهور واحدة قوائم مستخدمين متعددة تم إنشاؤها لأيام مختلفة.
تمثيل JSON |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
الحقول | |
---|---|
name |
النتائج فقط. المُعرّف. اسم مورد قائمة المستخدمين الذي تم تعيينه أثناء الإنشاء. يحدد اسم المورد هذا تنسيق الملف: |
audience |
مطلوبة. اسم مورد الجمهور. يحدِّد اسم المورد هذا الجمهور الذي يتم إدراجه وتتم مشاركته بين "إحصاءات Google" Data وAdmin API. تنسيق الملف: |
audienceDisplayName |
النتائج فقط. الاسم المعروض الوصفي لهذا الجمهور. على سبيل المثال، "المشترون". |
dimensions[] |
مطلوبة. السمات التي تم طلبها وعرضها في ردّ طلب البحث. |
creationQuotaTokensCharged |
النتائج فقط. الرموز المميّزة لإجمالي الحصة التي تم تحصيلها أثناء إنشاء AudienceList بما أنّ عدد الرموز المميّزة هذا يعتمد على النشاط في حالة |
state |
النتائج فقط. الحالة الحالية لقائمة AudienceList هذه. |
beginCreatingTime |
النتائج فقط. الوقت الذي تم فيه استدعاء userLists.create وبدأت AudienceList حالة طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: |
rowCount |
النتائج فقط. إجمالي عدد الصفوف في نتيجة AudienceList. |
errorMessage |
النتائج فقط. تتم تعبئة رسالة الخطأ عند تعذُّر إنشاء قائمة مستخدمين أثناء إنشائها. والسبب الشائع لمثل هذا الإخفاق هو استنفاد الحصص. |
percentageCompleted |
النتائج فقط. النسبة المئوية المكتملة لتصدير شريحة الجمهور هذه تتراوح بين 0 و100. |
recurringAudienceList |
النتائج فقط. قائمة المستخدمين المتكرّرة التي أنشأت قائمة المستخدمين هذه. تُنشئ قوائم المستخدِمين المتكرّرة قوائم مستخدِمين يوميًا. إذا تم إنشاء قوائم المستخدمين مباشرةً، لن يتم ربطها بأي قائمة مستخدمين متكرّرة، وسيكون هذا الحقل فارغًا. |
webhookNotification |
اختياريّ. تعمل هذه السياسة على ضبط إشعارات الردّ التلقائي على الويب التي سيتم إرسالها من Google Analytics Data API إلى خادم الردّ التلقائي على الويب. إنّ استخدام الردود التلقائية على الويب أمر اختياري. وفي حال عدم استخدامها، ستحتاج إلى إجراء استطلاع رأي لواجهة برمجة التطبيقات هذه لتحديد الوقت الذي تصبح فيه قائمة المستخدمين جاهزة للاستخدام. تسمح الردود التلقائية على الويب بإرسال إشعار إلى خوادمك وتجنُّب الحاجة إلى الاستطلاع. سيتم إرسال طلب واحد أو طلبَين من طلبات POST إلى الرد التلقائي على الويب. سيتم إرسال طلب POST الأول على الفور مع عرض قائمة المستخدمين التي تم إنشاؤها حديثًا في حالة الإنشاء. سيتم إرسال طلب POST الثاني بعد اكتمال عملية إنشاء قائمة المستخدمين (إما الحالة "نشط" أو الحالة "تعذّر"). إذا تم طلب قوائم مستخدمين متطابقة في تتابع سريع، يمكن عرض قوائم المستخدمين الثانية واللاحقة من ذاكرة التخزين المؤقت. في هذه الحالة، يمكن أن تؤدي طريقة إنشاء قائمة المستخدمين إلى أن تكون قائمة المستخدمين "نشطة". في هذا السيناريو، سيتم إرسال طلب POST واحد فقط إلى الرد التلقائي على الويب. |
الحالة
تتوفّر قائمة الجمهور حاليًا بهذه الحالة.
عمليات التعداد | |
---|---|
STATE_UNSPECIFIED |
لن يتم استخدام الحالة غير المحدّدة أبدًا. |
CREATING |
يتم حاليًا إنشاء AudienceList وستكون متاحة في المستقبل. يحدث الإنشاء فورًا بعد مكالمة AudienceLists.create. |
ACTIVE |
تمّ إنشاء AudienceList بالكامل وهي جاهزة لطلبات البحث. يتم تعديل AudienceList لتصبح نشطة بشكل غير متزامن من طلب معيّن، ويحدث ذلك في بعض الوقت (على سبيل المثال، 15 دقيقة) بعد مكالمة الإنشاء الأولية. |
FAILED |
تعذّر إنشاء AudienceList. ومن الممكن أن تنجح إعادة طلب قائمة المستخدمين هذه. |
الطُرق |
|
---|---|
|
تنشئ قائمة مستخدمين لاستردادها لاحقًا. |
|
تصدِّر قائمة مستخدمين تضم مستخدمين إلى جدول بيانات Google. |
|
للحصول على بيانات وصفية حول قائمة مستخدمين معيّنة. |
|
يسرد جميع قوائم المستخدمين لأحد المواقع. |
|
لاسترداد قائمة مستخدمين. |