- طلب 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 |
القيمة كسلسلة إذا كان نوع السمة عبارة عن سلسلة. |