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}

audience Display Name

string

فقط خروجی نام نمایشی توصیفی برای این مخاطب. مثلاً «خریداران».

dimensions[]

object ( AudienceDimension )

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

creation Quota Tokens Charged

integer

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

state

enum ( State )

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

begin Creating Time

string ( Timestamp format)

فقط خروجی زمانی که AudienceExports.create فراخوانی شد و AudienceExport حالت CREATING را شروع کرد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

row Count

integer

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

error Message

string

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

percentage Completed

number

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

ابعاد مخاطب

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

نمایندگی JSON 
{
  "dimensionName": string
}
فیلدها
dimension Name

string

اختیاری. نام API بعد. برای لیست نام ابعاد به ابعاد API مراجعه کنید.

ایالت

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

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

روش ها

create

 صادرات مخاطب را برای بازیابی بعدی ایجاد می کند.

get

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

list

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

query

 صادرات مخاطب از کاربران را بازیابی می کند.