Method: properties.audienceLists.exportSheet

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

راجِع إنشاء قائمة مستخدمين للحصول على مقدمة عن قوائم المستخدمين مع أمثلة.

تسمح لك شرائح الجمهور في "إحصاءات Google 4" بتقسيم المستخدِمين بالطرق المهمة لنشاطك التجاري. لمعرفة المزيد من المعلومات، يُرجى الاطّلاع على https://support.google.com/analytics/answer/9267572.

تم طرح هذه الطريقة في إصدار أوليّ مستقر بهدف جمع ملاحظات وآراء حول البنية والإمكانات قبل الدخول في إصدار تجريبي. لتقديم ملاحظاتك حول واجهة برمجة التطبيقات هذه، يُرجى إكمال نموذج ملاحظات حول Audience Export API في "إحصاءات Google".

طلب HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:exportSheet

يستخدم عنوان URL بنية تحويل الترميز gRPC.

معلمات المسار

المَعلمات
name

string

مطلوبة. اسم قائمة المستخدمين المطلوب استرداد المستخدمين منها. تنسيق الملف: properties/{property}/audienceLists/{audienceList}

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON 
{
  "offset": string,
  "limit": string
}
الحقول
offset

string (int64 format)

اختياريّ. عدد الصفوف في صف البداية. يتم احتساب الصف الأول على أنه الصف 0.

عند إجراء التقسيم على صفحات، لا يحدد الطلب الأول الإزاحة، أو ما يعادله، يعمل على ضبط الإزاحة على 0، يعرض الطلب الأول أول limit من الصفوف. يحدد الطلب الثاني إزاحة إلى limit للطلب الأول، ويعرض الطلب الثاني limit الثاني من الصفوف.

لمزيد من المعلومات عن مَعلمة التقسيم على صفحات هذه، اطّلِع على تقسيم النتائج على عدّة صفحات.
limit

string (int64 format)

اختياريّ. عدد الصفوف المطلوب عرضها. وفي حال عدم تحديد قيمة، يتم عرض 10,000 صف. تعرض واجهة برمجة التطبيقات 250,000 صف كحد أقصى لكل طلب، بغض النظر عن العدد الذي تطلبه. يجب أن تكون قيمة الحقل "limit" موجبة.

ويمكن أن تعرِض واجهة برمجة التطبيقات أيضًا صفوفًا أقل من قيمة limit المطلوبة، إذا لم تكن هناك قيم سمات كثيرة مثل limit.

لمزيد من المعلومات عن مَعلمة التقسيم على صفحات هذه، اطّلِع على تقسيم النتائج على عدّة صفحات.

نص الاستجابة

جدول بيانات Google الذي تم إنشاؤه ويتضمّن قائمة المستخدمين في قائمة مستخدمين

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
الحقول
spreadsheetUri

string

معرّف موارد منتظم (URI) يمكنك الانتقال إليه في المتصفّح لعرض "جدول بيانات Google".
spreadsheetId

string

معرّف يحدّد مورد "جدول بيانات Google" الذي تم إنشاؤه.
rowCount

integer

إجمالي عدد الصفوف في نتيجة AudienceList. وتكون rowCount مستقلة عن عدد الصفوف التي يتم عرضها في الاستجابة ومَعلمة الطلب limit ومَعلمة الطلب offset. على سبيل المثال، إذا عرض طلب بحث 175 صفًا ويتضمّن limit من 50 صفًا في طلب البيانات من واجهة برمجة التطبيقات، ستحتوي الاستجابة على rowCount من 175 صفًا ولكنّها 50 صفًا فقط.

لمزيد من المعلومات عن مَعلمة التقسيم على صفحات هذه، اطّلِع على تقسيم النتائج على عدّة صفحات.
audienceList

object (AudienceList)

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

على سبيل المثال، قد يحتوي AudienceList على صفوف أكثر من تلك المتوفّرة في "جدول بيانات Google". وفي هذه الحالة، قد تحتاج إلى إرسال طلب تصدير ورقة بيانات إضافي بقيمة offset مختلفة لاسترداد الصفحة التالية من الصفوف في "جدول بيانات Google" إضافي.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets