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)

الناتج فقط. رقم تعريف قائمة المستخدمين. يتم إنشاء هذا الحقل من خلال الخدمة ويستخدم على تعبئة قائمة المستخدمين.
adsDataCustomerId

string (int64 format)

غير قابل للتغيير. الرقم التعريفي لعميل Ads Data Hub المرتبط بقائمة المستخدمين هذه. يجب تحديد هذا المعرّف باعتباره adsDataCustomerId عند تشغيل مهام UserListQuery باستخدام قائمة المستخدمين هذه. في حال عدم توفّرها، سيتم استخدام العميل الرئيسي. ولا يمكن تغيير هذا الإعداد بعد إنشاء القائمة.
title

string

مطلوبة. عنوان قائمة المستخدمين، وهو فريد للسمة adsDataCustomerId المحدّدة.
description

string

مطلوبة. هذا وصف قائمة المستخدمين.
type

enum (UserListType)

الناتج فقط. يجب أن تكون قيم نوع 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)

قائمة تجديد النشاط التسويقي.

نوع قائمة المستخدمين

نوع قائمة المستخدمين. يعتمد إنشاء قائمة المستخدمين واستخدامها في وقت الاستهداف على هذا التعداد. لا يمكن تبديل نوع القائمة بعد الإنشاء.

عمليات التعداد
USER_LIST_TYPE_UNSPECIFIED القيمة التلقائية: يجب عدم استخدامها.
REMARKETING شرائح جمهور تجديد النشاط التسويقي التي تم إنشاؤها باستخدام طلبات SQL في Ads Data Hub يمكن استخدام قائمة تجديد النشاط التسويقي للاستهداف الإيجابي والسلبي.
FREQUENCY_BASED التردد المحدود للجمهور. تقتصر الجماهير من هذا النوع على الاستهداف السلبي.

معلومات القائمة على التكرار

البيانات الوصفية لقائمة المستخدمين المستندة إلى معدّل التكرار

تمثيل JSON 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
الحقول
dv360LineitemIds[]
(deprecated)

string (int64 format)

أرقام تعريف العناصر في "مساحة العرض والفيديو 360" التي تساهم في معدل التكرار
cmCampaignIds[]
(deprecated)

string (int64 format)

أرقام تعريف الحملات في "مدير الحملة" التي تساهم في عدد مرات الظهور
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

أرقام تعريف حملات "إعلانات Google" التي تساهم في معدل التكرار.
eventMatchers[]

object (EventMatcher)

الأحداث التي تساهم في معدّل التكرار عند إنشاء قوائم مستخدمين تستند إلى التكرار، يتم تفضيل eventMatchers لتحديد الأحداث التي تساهم في معدّل التكرار. يتم استخدام dv360LineitemIds وcmCampaignIds وgoogleAdsCampaignIds إذا كانت eventEventers فارغة.
frequencyConstraint

object (FrequencyConstraint)

تصف هذه الخاصية وقت إضافة المستخدم إلى القائمة.
slidingWindowDays

integer

مطلوبة. حجم الفترة الزمنية المُستخدَمة عند احتساب معدل تكرار كل حدث هذا المقياس حسب الأيام

مُطابِق الحدث

حدث عام يساهم في فترة التكرار

تمثيل JSON 
{
  "matchType": enum (MatchType),
  "value": string
}
الحقول
matchType

enum (MatchType)

نوع القيد الذي سيتم تضمينه في عدد مرات الظهور.
value

string

قيمة القيد. على سبيل المثال، لتحديد رقم تعريف حملة على "إعلانات Google" = 1234، ستكون مطابقة typeType هو GOOGLE_ADS_CAMPAIGN_ID وستكون القيمة '1234&#39؛ سيتم تضمين الأحداث التي تحتوي على هذه القيمة لنوع التطابق ذي الصلة في عدد مرات الظهور.

نوع المطابقة

أنواع القيود المتاحة لعدد مرات الظهور. قد تتم إضافة المزيد من الأنواع إلى هذا التعداد في المستقبل لإتاحة المزيد من القيود. يمكنك تحديد فلتر على TypeType في الوصف (DescriptionDescription للنطاقLimitingEventMatchersRequest) لقصر أدوات مطابقة الأحداث التي يتم عرضها في النتائج على النتائج المتوافقة مع واجهة برمجة التطبيقات فقط. على سبيل المثال، سيؤدي ضبط الفلتر على &"eventMatcher.match_type= CM_CAMPAIGN_ID أو eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID" إلى عرض EventMatchers فقط من هذين النوعين.

عمليات التعداد
MATCH_TYPE_UNSPECIFIED القيمة التلقائية هذه القيمة غير مستخدَمة.
CM_CAMPAIGN_ID نوع مقيّد يمثّل رقم تعريف الحملة على "مدير الحملة".
DV360_INSERTION_ORDER_ID نوع القيد الذي يمثّل "معرّف طلب الإدراج" في "مساحة العرض والفيديو 360".
DV360_LINE_ITEM_ID نوع القيد الذي يمثّل رقم تعريف العنصر في "مساحة العرض والفيديو 360".
GOOGLE_ADS_CAMPAIGN_ID نوع القيد الذي يمثّل رقم تعريف الحملة على "إعلانات Google".

تحديد التردد

اضبط الحد الأدنى لعدد أحداث الحد الأقصى.

تمثيل JSON 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
الحقول
eventType

enum (EventType)

غير قابل للتغيير. نوع الحدث الذي سيتم احتسابه ضمنَ EventEventCount. في الوقت الحالي، لا نمثل بشكل واضح قيود المقارنة بافتراض أنّ جميع تلك القيود هي GREATER_OR_EQUAL.
thresholdEventCount

string (int64 format)

مطلوبة. يجب أن يظهر كل مستخدم في أحداث K على الأقل.

نوع الحدث

أنواع الأحداث التي يمكن استخدامها لاحتساب معدّل التكرار

عمليات التعداد
EVENT_TYPE_UNSPECIFIED القيمة التلقائية: يجب عدم استخدامها.
IMPRESSIONS احتساب جميع مرات الظهور.

معلومات تجديد النشاط التسويقي

البيانات الوصفية لقوائم تجديد النشاط التسويقي

تمثيل JSON 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
الحقول
userListQuery

string

غير قابل للتغيير. مورد طلب البحث في قائمة مستخدمي Ads Data Hub الذي يحدد كيفية إضافة المستخدمين إلى هذا الجمهور. على شكل: customer/[customerId]/userListQuries/[query_resource_id]
populatingUserListQueries[]

string

الناتج فقط. ويسرد قائمة مستخدمي Ads Data Hub طلب البحث الذي تمت تعبئة هذا الجمهور. ويُعدّ هذا الحقل حقلاً قديمًا لدعم قوائم المستخدمين التي تمت تعبئتها بواسطة طلبات بحث متعددة قبل أن يتم تطبيق قيود 1:1 userlist:query. على شكل: customer/[customerId]/userListQuries/[query_resource_id]

الولاية

حالة قائمة المستخدمين.

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية / بدون ضبط.
STATE_ACTIVE لا تزال قائمة المستخدمين مفتوحة ونشطة.
STATE_DELETED تم وضع علامة على قائمة المستخدمين كمحذوفة ويجب عدم استخدامها لاستهداف أي قائمة أخرى

الطُرق

addEventMatchers

 لإضافة تطابقات الأحداث إلى قائمة مستخدمين تستند إلى معدل التكرار.

addRecipients

 أضِف كيانات إلى مستلِمي قائمة المستخدمين المُدارة من خلال Ads Data Hub.

create

 يُنشئ قائمة مستخدمين يديرها Ads Data Hub.

delete

 احذف قائمة المستخدمين المطلوبة المُدارة من خلال Ads Data Hub.

generateFrequencyListMemberships

 إنشاء عضويات لقائمة المستخدمين.

get

 لاسترداد قائمة المستخدمين المطلوبة التي يديرها Ads Data Hub.

list

 يسرد قوائم المستخدمين التي يديرها عميل Ads Data Hub المحدّد.

patch

 يتم تعديل قائمة المستخدمين المُدارة من Ads Data Hub.

removeRecipients

 إزالة الكيانات من مستلمي قائمة المستخدمين المُدارة في Ads Data Hub.