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