REST Resource: properties.audienceExports

منبع: AudienceExport

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

نمایش JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number
}
فیلدها
name

string

فقط خروجی. شناسه. نام منبع خروجی مخاطب که هنگام ایجاد اختصاص داده شده است. این نام منبع، AudienceExport را مشخص می‌کند.

قالب: properties/{property}/audienceExports/{audienceExport}

audience

string

الزامی. نام منبع مخاطب. این نام منبع، مخاطبی را که فهرست شده است مشخص می‌کند و بین APIهای Analytics Data و Admin به اشتراک گذاشته می‌شود.

قالب: properties/{property}/audiences/{audience}

audienceDisplayName

string

فقط خروجی. نام نمایشی توصیفی برای این مخاطب. به عنوان مثال، "خریداران".

dimensions[]

object ( AudienceDimension )

الزامی. ابعاد درخواست شده و نمایش داده شده در پاسخ پرس و جو.

creationQuotaTokensCharged

integer

فقط خروجی. کل توکن‌های سهمیه‌ای که هنگام ایجاد AudienceExport شارژ شده‌اند. از آنجا که این تعداد توکن بر اساس فعالیت از حالت CREATING محاسبه می‌شود، این توکن‌های شارژ شده پس از ورود AudienceExport به حالت‌های ACTIVE یا FAILED ثابت خواهند شد.

state

enum ( State )

فقط خروجی. وضعیت فعلی برای این AudienceExport.

beginCreatingTime

string ( Timestamp format)

فقط خروجی. زمانی که audienceExports.create فراخوانی شده و AudienceExport حالت CREATING را آغاز کرده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

rowCount

integer

فقط خروجی. تعداد کل ردیف‌ها در نتیجه‌ی AudienceExport.

errorMessage

string

فقط خروجی. پیام خطا زمانی نمایش داده می‌شود که خروجی مخاطب در حین ایجاد با شکست مواجه شود. یکی از دلایل رایج چنین شکستی، اتمام سهمیه است.

percentageCompleted

number

فقط خروجی. درصد تکمیل‌شده برای این خروجی مخاطب بین ۰ تا ۱۰۰ است.

ابعاد مخاطب

بُعد مخاطب، یک ویژگی کاربر است. ویژگی‌های خاص کاربر درخواست شده و سپس در QueryAudienceExportResponse بازگردانده می‌شوند.

نمایش JSON 
{
  "dimensionName": string
}
فیلدها
dimensionName

string

اختیاری. نام API بُعد. برای فهرست نام‌های بُعد، به API Dimensions مراجعه کنید.

ایالت

AudienceExport در حال حاضر در این وضعیت وجود دارد.

انوم‌ها
STATE_UNSPECIFIED حالت نامشخص هرگز استفاده نخواهد شد.
CREATING AudienceExport در حال حاضر در حال ایجاد است و در آینده در دسترس خواهد بود. ایجاد بلافاصله پس از فراخوانی audienceExports.create رخ می‌دهد.
ACTIVE AudienceExport به طور کامل ایجاد شده و آماده‌ی پرس‌وجو است. AudienceExport به صورت ناهمگام از یک درخواست به حالت فعال به‌روزرسانی می‌شود؛ این اتفاق مدتی (برای مثال ۱۵ دقیقه) پس از فراخوانی اولیه‌ی create رخ می‌دهد.
FAILED ایجاد AudienceExport ناموفق بود. ممکن است درخواست مجدد برای خروجی گرفتن از این مخاطب موفقیت‌آمیز باشد.

روش‌ها

create

 یک خروجی از مخاطبان برای بازیابی بعدی ایجاد می‌کند.

get

 فراداده‌های پیکربندی مربوط به یک خروجی مخاطب خاص را دریافت می‌کند.

list

 تمام خروجی‌های مخاطبان یک ویژگی را فهرست می‌کند.

query

 خروجی مخاطبان کاربران را بازیابی می‌کند.