- طلب HTTP
- مَعلمات المسار
- نص الطلب
- نص الاستجابة
- نطاقات التفويض
- AudienceRow
- AudienceDimensionValue
- جرِّبه الآن
يسترد قائمة المستخدمين. بعد إنشاء شريحة جمهور، لن يكون المستخدمون متاحين على الفور لعرض بيانات المتجر. أولاً، من الضروري إرسال طلب إلى audienceLists.create
لإنشاء قائمة مستخدمين، ثم ثانيًا، يتم استخدام هذه الطريقة لاسترداد بيانات المستخدِمين المُدرَجين في قائمة المستخدِمين.
اطّلع على إنشاء قائمة مستخدمين للحصول على مقدمة عن قوائم المستخدمين مع أمثلة.
تتيح لك شرائح الجمهور في "إحصاءات Google 4" تقسيم المستخدِمين بالطرق التي تمثل أهمّية بالنسبة إلى نشاطك التجاري. لمعرفة المزيد، راجع https://support.google.com/analytics/answer/9267572.
تتوفّر هذه الطريقة عند تثبيت الإصدار التجريبي من خلال الرابط audienceExports.query. لإرسال ملاحظاتك حول واجهة برمجة التطبيقات هذه، يُرجى ملء نموذج ملاحظات وآراء بشأن Audience Export API في "إحصاءات Google".
طلب HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
name |
مطلوب. اسم قائمة المستخدمين المطلوب استرداد المستخدِمين منها. تنسيق الملف: |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "offset": string, "limit": string } |
الحقول | |
---|---|
offset |
اختياريّ. عدد صفوف صف البداية. يتم احتساب الصف الأول على أنه الصف 0. عند الترحيل، لا يحدد الطلب الأول الإزاحة؛ أو ما يعادل ذلك، يتم تعيينها على 0؛ يعرض الطلب الأول أول لمزيد من المعلومات عن مَعلمة تقسيم النتائج على صفحات، يمكنك الاطّلاع على مقالة التقسيم على صفحات. |
limit |
اختياريّ. عدد الصفوف المطلوب عرضها. في حال عدم تحديد قيمة الحقل، سيتم عرض 10,000 صف. تعرض واجهة برمجة التطبيقات 250,000 صف كحدٍ أقصى لكل طلب، بغض النظر عن عدد الصفوف التي تطلبها. يجب أن تكون قيمة ويمكن أن تعرض واجهة برمجة التطبيقات أيضًا صفوفًا أقل من قيمة لمزيد من المعلومات عن مَعلمة تقسيم النتائج على صفحات، يمكنك الاطّلاع على مقالة التقسيم على صفحات. |
نص الاستجابة
قائمة بالمستخدمين في قائمة مستخدمين.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "audienceRows": [ { object ( |
الحقول | |
---|---|
audienceRows[] |
صفوف لكل مستخدم في قائمة مستخدمين. سيكون عدد الصفوف في هذه الاستجابة أقل من حجم صفحة الطلب أو مساويًا له. |
audienceList |
بيانات الإعدادات التي يتم الاستعلام عنها بشأن AudienceList تم الرجوع للمساعدة في تفسير صفوف الجمهور في هذه الاستجابة. على سبيل المثال، تتطابق السمات في AudienceList هذه مع الأعمدة في AudienceRows. |
rowCount |
إجمالي عدد الصفوف في نتيجة AudienceList. لمزيد من المعلومات عن مَعلمة تقسيم النتائج على صفحات، يمكنك الاطّلاع على مقالة التقسيم على صفحات. |
نطاقات الأذونات
يتطلب هذا الإعداد أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
سمات قيم البُعد لصف مستخدِم الجمهور
تمثيل JSON |
---|
{
"dimensionValues": [
{
object ( |
الحقول | |
---|---|
dimensionValues[] |
كل سمة من سمات قيمة السمة لمستخدم شريحة جمهور. ستتم إضافة قيمة سمة واحدة لكل عمود سمة مطلوب. |
AudienceDimensionValue
قيمة السمة.
تمثيل JSON |
---|
{ // Union field |
الحقول | |
---|---|
حقل الاتحاد one_value . نوع واحد من قيمة البُعد. يمكن أن يكون one_value واحدًا فقط مما يلي: |
|
value |
القيمة كسلسلة إذا كان نوع السمة سلسلة. |