REST Resource: properties.audienceExports

المورد: AudienceExport

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

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

string

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

التنسيق: properties/{property}/audienceExports/{audienceExport}

audience

string

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

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

audienceDisplayName

string

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

dimensions[]

object (AudienceDimension)

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

creationQuotaTokensCharged

integer

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

state

enum (State)

النتائج فقط. الحالة الحالية لعملية تصدير شرائح الجمهور هذه.

beginCreatingTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه استدعاء audienceExports.create وبدأت فيه عملية تصدير شرائح الجمهور الحالة 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

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

errorMessage

string

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

percentageCompleted

number

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

AudienceDimension

سمة الجمهور هي سمة مستخدم. يتم طلب سمات مستخدم محدّدة ثم يتم إرجاعها لاحقًا في QueryAudienceExportResponse.

تمثيل JSON
{
  "dimensionName": string
}
الحقول
dimensionName

string

اختياريّ. اسم السمة في واجهة برمجة التطبيقات اطّلِع على سمات واجهة برمجة التطبيقات للاطّلاع على قائمة بأسماء السمات.

ولاية

تكون السمة AudienceExport في هذه الحالة حاليًا.

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

الطُرق

create

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

get

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

list

تعرض هذه السمة جميع عمليات تصدير شرائح الجمهور لموقع معيّن.

query

يستردّ عملية تصدير جمهور من المستخدمين.