Method: properties.audienceLists.exportSheet

فهرست مخاطبان کاربران را به Google Sheet صادر می کند. پس از ایجاد مخاطب، کاربران فوراً برای فهرست کردن در دسترس نیستند. اولاً، برای ایجاد فهرست مخاطبان از کاربران، درخواستی از audienceLists.create ایجاد شده ضروری است، و سپس، از این روش برای صادر کردن آن کاربران در فهرست مخاطبان به صفحه Google استفاده می‌شود.

برای آشنایی با فهرست مخاطبان همراه با مثال، به ایجاد فهرست مخاطبان مراجعه کنید.

مخاطبان در Google Analytics 4 به شما این امکان را می دهند که کاربران خود را به روش هایی که برای کسب و کار شما مهم هستند تقسیم بندی کنید. برای کسب اطلاعات بیشتر، به https://support.google.com/analytics/answer/9267572 مراجعه کنید.

این روش در ثبات آلفا با هدف جمع‌آوری بازخورد در نحو و قابلیت‌ها قبل از ورود به بتا معرفی شده است. برای ارائه بازخورد خود در مورد این API، فرم بازخورد Google Analytics Audience Export API را تکمیل کنید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
name

string

ضروری. نام لیست مخاطبان برای بازیابی کاربران. قالب: properties/{property}/audienceLists/{audienceList}

درخواست بدن

بدنه درخواست حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "offset": string,
  "limit": string
}
زمینه های
offset

string ( int64 format)

اختیاری. تعداد ردیف ردیف شروع. ردیف اول به عنوان ردیف 0 محاسبه می شود.

هنگام صفحه بندی، اولین درخواست افست را مشخص نمی کند. یا به طور معادل، افست را روی 0 تنظیم می کند. اولین درخواست اولین limit ردیف ها را برمی گرداند. درخواست دوم افست را تا limit درخواست اول تنظیم می کند. درخواست دوم limit دوم ردیف ها را برمی گرداند.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

limit

string ( int64 format)

اختیاری. تعداد ردیف هایی که باید برگردانده شوند. اگر مشخص نشده باشد، 10000 ردیف برگردانده می شود. API حداکثر 250000 سطر را در هر درخواست برمی گرداند، مهم نیست که چقدر درخواست کنید. limit باید مثبت باشد

API همچنین می‌تواند ردیف‌های کمتری را نسبت به limit درخواستی برگرداند، اگر مقادیر ابعاد به اندازه limit وجود نداشته باشد.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

بدن پاسخگو

صفحه Google ایجاد شده با لیست کاربران در فهرست مخاطبان.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
زمینه های
spreadsheetUri

string

uri برای شما که باید در مرورگر خود برای مشاهده برگه Google مراجعه کنید.

spreadsheetId

string

شناسه ای که منبع Google Sheet ایجاد شده را مشخص می کند.

rowCount

integer

تعداد کل ردیف ها در نتیجه AudienceList. rowCount مستقل از تعداد سطرهای برگردانده شده در پاسخ، پارامتر درخواست limit و پارامتر درخواست offset است. به عنوان مثال اگر یک پرس و جو 175 ردیف را برمی گرداند و شامل limit 50 در درخواست API می شود، پاسخ شامل rowCount 175 اما فقط 50 ردیف خواهد بود.

برای اطلاعات بیشتر در مورد این پارامتر صفحه بندی، صفحه بندی را ببینید.

audienceList

object ( AudienceList )

داده های پیکربندی درباره AudienceList صادر می شود. برای کمک به تفسیر AudienceList در برگه Google این پاسخ، بازگشت.

برای مثال، AudienceList ممکن است تعداد ردیف‌هایی بیشتر از آنچه در Google Sheet وجود دارد داشته باشد، و در این صورت، ممکن است بخواهید یک درخواست صادرات برگه اضافی با مقدار offset متفاوت برای بازیابی صفحه بعدی ردیف‌ها در یک Google Sheet اضافی ارسال کنید.

محدوده مجوز

به یکی از حوزه های 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