REST Resource: customers.userLists

منبع: UserList

لیست کاربران مدیریت شده توسط Ads Data Hub را تعریف می کند.

نمایندگی JSON
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
زمینه های
name

string

فقط خروجی نامی که به طور منحصر به فرد لیست کاربران Ads Data Hub را مشخص می کند. دارای فرم مشتریان/[customerId]/userLists/[userListId]

userListId

string ( int64 format)

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

adsDataCustomerId

string ( int64 format)

تغییرناپذیر. شناسه مشتری Ads Data Hub مرتبط با این لیست کاربر. هنگام اجرای کارهای UserListQuery با استفاده از این لیست کاربر، این شناسه باید به عنوان adsDataCustomerId مشخص شود. در صورت عدم وجود، از مشتری مادر استفاده خواهد شد. پس از ایجاد لیست نمی توان این را تغییر داد.

title

string

ضروری. عنوان لیست کاربر، که برای adsDataCustomerId مشخص شده منحصر به فرد است.

description

string

ضروری. توضیحات لیست کاربران

type

enum ( UserListType )

فقط خروجی مقادیر نوع UserList باید با userList سازگار باشد. این مقدار فقط خواندنی است و در درخواست‌های دریافت/لیست قابل دسترسی است.

createEmail

string

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

listSize

string ( int64 format)

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

populateTime

string ( Timestamp format)

فقط خروجی زمان آخرین پر شدن لیست

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

state

enum ( State )

فقط خروجی وضعیت لیست کاربران (فعال/حذف شده). این مقدار فقط خواندنی است و در درخواست‌های دریافت/لیست قابل دسترسی است.

user_list فیلد اتحادیه . پیکربندی بیشتر بسته به نوع لیست کاربر.

دقیقاً یکی باید تنظیم شود. user_list تنها می تواند یکی از موارد زیر باشد:

frequencyList

object ( FrequencyBasedListInfo )

لیست کاربر برای محدودیت فرکانس.

remarketingList

object ( RemarketingListInfo )

لیست بازاریابی مجدد

UserListType

نوع لیست کاربر. ساخت لیست کاربر و استفاده در زمان هدف گذاری به این تعداد بستگی دارد. پس از ایجاد لیست نمی توان نوع آن را تغییر داد.

Enums
USER_LIST_TYPE_UNSPECIFIED مقدار پیش فرض: نباید استفاده شود.
REMARKETING مخاطبان بازاریابی مجدد که با پرس و جوهای SQL در ADH ایجاد شده اند. از لیست بازاریابی مجدد می توان برای هدف گذاری مثبت و منفی استفاده کرد.
FREQUENCY_BASED تعداد مخاطبان محدود است. مخاطبان از این نوع محدود به هدف گیری منفی هستند.

FrequencyBasedListInfo

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

نمایندگی JSON
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
زمینه های
dv360LineitemIds[]
(deprecated)

string ( int64 format)

شناسه‌های موارد خط DV360 که به فرکانس کمک می‌کنند.

cmCampaignIds[]
(deprecated)

string ( int64 format)

شناسه‌های کمپین‌های CM که به فراوانی کمک می‌کنند.

googleAdsCampaignIds[]
(deprecated)

string ( int64 format)

شناسه‌های کمپین‌های Google Ads که به فراوانی کمک می‌کنند.

eventMatchers[]

object ( EventMatcher )

کدام رویدادها به فرکانس کمک می کنند. هنگام ایجاد لیست های کاربر مبتنی بر فرکانس، eventMatchers برای مشخص کردن رویدادهایی که در فرکانس نقش دارند ترجیح داده می شود. اگر eventMatchers خالی باشد از dv360LineitemIds، cmCampaignIds و googleAdsCampaignIds استفاده می شود.

frequencyConstraint

object ( FrequencyConstraint )

زمانی که کاربر به لیست اضافه می شود، توضیح می دهد.

slidingWindowDays

integer

ضروری. اندازه پنجره زمانی که برای محاسبه فراوانی هر رویداد استفاده می شود. این اندازه گیری در روز است

EventMatcher

رویداد عمومی که به فرکانس کمک می کند.

نمایندگی JSON
{
  "matchType": enum (MatchType),
  "value": string
}
زمینه های
matchType

enum ( MatchType )

نوع محدودیتی که در شمارش فرکانس گنجانده می شود.

value

string

مقدار محدودیت برای مثال، برای تعیین شناسه کمپین Google Ads = 1234، matchType GOOGLE_ADS_CAMPAIGN_ID و مقدار آن «1234» خواهد بود. رویدادهایی که این مقدار را برای MatchType مربوطه دارند، در شمارش فرکانس لحاظ خواهند شد.

MatchType

انواع محدودیت های پشتیبانی شده برای شمارش فرکانس. ممکن است در آینده انواع بیشتری برای پشتیبانی از محدودیت‌های اضافی به این فهرست اضافه شود. می‌توانید فیلتری را روی MatchType در DescribeValidFrequencyLimitingEventMatchersRequest تعیین کنید تا تطبیق‌دهنده‌های رویدادی را که در نتایج بازگردانده شده‌اند فقط به مواردی که توسط API شما پشتیبانی می‌شوند محدود کند. برای مثال، تنظیم فیلتر به‌عنوان «eventMatcher.match_type= CM_CAMPAIGN_ID یا eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID»، EventMatchers را فقط از این دو نوع برمی‌گرداند.

Enums
MATCH_TYPE_UNSPECIFIED مقدار پیش فرض. این مقدار استفاده نشده است.
CM_CAMPAIGN_ID نوع محدودیت نشان دهنده شناسه کمپین مدیریت کمپین.
DV360_INSERTION_ORDER_ID نوع محدودیت نشان دهنده شناسه سفارش درج DV360.
DV360_LINE_ITEM_ID نوع محدودیت نشان دهنده شناسه مورد خط DV360.
GOOGLE_ADS_CAMPAIGN_ID نوع محدودیت نشان دهنده شناسه کمپین تبلیغات گوگل.

محدودیت فرکانس

حداقل تعداد رویدادها را برای درپوش مشخص کنید.

نمایندگی JSON
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
زمینه های
eventType

enum ( EventType )

تغییرناپذیر. نوع رویدادی که در برابر thresholdEventCount شمارش می‌شود. در حال حاضر ما به صراحت محدودیت های مقایسه را با فرض اینکه همه GREATER_OR_EQUAL هستند نشان نمی دهیم.

thresholdEventCount

string ( int64 format)

ضروری. هر کاربر باید حداقل در K رویداد ظاهر شود.

نوع رویداد

انواع رویدادهایی که می توان از آنها برای شمارش فرکانس استفاده کرد.

Enums
EVENT_TYPE_UNSPECIFIED مقدار پیش فرض: نباید استفاده شود.
IMPRESSIONS همه برداشت ها را بشمارید

RemarketingListInfo

فراداده برای لیست های بازاریابی مجدد.

نمایندگی JSON
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
زمینه های
userListQuery

string

تغییرناپذیر. منبع جستجوی فهرست کاربران Ads Data Hub که نحوه اضافه شدن کاربران به این مخاطب را مشخص می کند. دارای شکل: customers/[customerId]/userListQueries/[query_resource_id]

populatingUserListQueries[]

string

فقط خروجی فهرست کاربران Ads Data Hub منابع پرس و جو که این مخاطبان را پر کرده است. این به‌عنوان یک فیلد قدیمی برای پشتیبانی از فهرست‌های کاربری در نظر گرفته شده است که قبل از اعمال محدودیت‌های 1:1 userlist:query توسط چندین عبارت پر شده بودند. دارای شکل: customers/[customerId]/userListQueries/[query_resource_id]

دولت

وضعیت لیست کاربران

Enums
STATE_UNSPECIFIED مقدار پیش فرض / تنظیم نشده.
STATE_ACTIVE لیست کاربران همچنان باز و فعال است.
STATE_DELETED لیست کاربران به عنوان حذف شده علامت گذاری شده است و دیگر نباید برای هدف گیری استفاده شود

مواد و روش ها

addEventMatchers

 تطبیق رویدادها را به لیست کاربران مبتنی بر فرکانس اضافه می کند.

addRecipients

 موجودیت ها را به گیرندگان لیست کاربران مدیریت شده توسط Ads Data Hub اضافه کنید.

create

 یک لیست کاربران مدیریت شده توسط Ads Data Hub ایجاد می کند.

delete

 لیست کاربران مدیریت شده Ads Data Hub درخواستی را حذف کنید.

generateFrequencyListMemberships

 ایجاد عضویت برای UserList.

get

 لیست کاربران مدیریت شده توسط Ads Data Hub درخواستی را بازیابی می کند.

list

 فهرست‌های کاربرانی را که توسط مشتری Ads Data Hub مدیریت می‌شوند، فهرست می‌کند.

patch

 لیست کاربران مدیریت شده توسط Ads Data Hub درخواستی را به روز می کند.

removeRecipients

 موجودیت ها را از گیرندگان لیست کاربران مدیریت شده توسط Ads Data Hub حذف می کند.