REST Resource: properties.audienceLists

منبع: AudienceList

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

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

string

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

قالب: properties/{property}/audienceLists/{audienceList}

audience

string

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

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

audienceDisplayName

string

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

dimensions[]

object ( AudienceDimension )

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

creationQuotaTokensCharged

integer

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

state

enum ( State )

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

beginCreatingTime

string ( Timestamp format)

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

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

rowCount

integer

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

errorMessage

string

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

percentageCompleted

number

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

recurringAudienceList

string

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

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

webhookNotification

object ( WebhookNotification )

اختیاری. اعلان‌های وب هوک را پیکربندی می‌کند تا از Google Analytics Data API به سرور وب هوک شما ارسال شود. استفاده از وب هوک اختیاری است. در صورت عدم استفاده، باید از این API نظرسنجی کنید تا مشخص کنید چه زمانی فهرست مخاطبان آماده استفاده است. وب هوک ها اجازه می دهند اعلان به سرورهای شما ارسال شود و از نیاز به نظرسنجی جلوگیری شود.

یک یا دو درخواست POST به webhook ارسال می شود. اولین درخواست POST بلافاصله ارسال می شود و لیست مخاطبان ایجاد شده جدید را در حالت CREATING نشان می دهد. دومین درخواست POST پس از تکمیل لیست مخاطبان (حالت ACTIVE یا FAILED) ارسال خواهد شد.

اگر فهرست‌های مخاطبان یکسان به‌سرعت درخواست شوند، فهرست مخاطبان دوم و بعدی را می‌توان از حافظه پنهان ارائه کرد. در این صورت، روش ایجاد لیست مخاطبان می تواند لیست مخاطبان را از قبل فعال کند. در این سناریو، تنها یک درخواست POST به webhook ارسال می شود.

حالت

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

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

مواد و روش ها

create

 فهرست مخاطبان را برای بازیابی بعدی ایجاد می کند.

exportSheet

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

get

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

list

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

query

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