REST Resource: accountTypes.accounts.userLists

المورد: UserList

أحد موارد قوائم المستخدمين.

تمثيل JSON 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
الحقول
name

string

المعرّف. اسم المورد لقائمة المستخدِمين. التنسيق: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

النتائج فقط. المعرّف الفريد لقائمة المستخدِمين.
readOnly

boolean

النتائج فقط. خيار يشير إلى ما إذا كان بإمكان المستخدم تعديل قائمة.
membershipDuration

string (Duration format)

اختياريّ. هي المدة التي يبقى فيها المستخدم في قائمة المستخدمين. المدد الصالحة هي مضاعفات دقيقة لـ 24 ساعة (86400 ثانية). سيؤدي تقديم قيمة ليست مضاعفًا دقيقًا لـ 24 ساعة إلى حدوث خطأ INVALID_ARGUMENT.

مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s"
accessReason

enum (AccessReason)

النتائج فقط. سبب منح هذا الحساب إذن الوصول إلى القائمة
sizeInfo

object (SizeInfo)

النتائج فقط. عدد الأعضاء المقدَّر في قائمة المستخدمين هذه على الشبكات المستهدَفة المختلفة
targetNetworkInfo

object (TargetNetworkInfo)

اختياريّ. معلومات الأهلية للشبكات المستهدَفة المختلفة
displayName

string

الحقل مطلوب. الاسم المعروض لقائمة المستخدمين.
description

string

اختياريّ. تمثّل هذه السمة وصفًا لقائمة المستخدمين.
membershipStatus

enum (MembershipStatus)

اختياريّ. حالة العضوية في قائمة المستخدمين هذه.
integrationCode

string

اختياريّ. معرّف من نظام خارجي يستخدمها بائعو قوائم المستخدمين لربط أرقام التعريف في أنظمتهم.
closingReason

enum (ClosingReason)

النتائج فقط. سبب إغلاق حالة عضوية قائمة المستخدمين هذه.
accountAccessStatus

enum (AccessStatus)

اختياريّ. تشير إلى ما إذا كان هذا الخيار لا يزال مفعّلاً. عند مشاركة قائمة مستخدمين مع الحساب، يتم ضبط هذا الحقل على ENABLED. يمكن لمالك قائمة المستخدمين في وقت لاحق أن يقرّر إلغاء المشاركة وجعلها DISABLED.
حقل الربط user_list_info معلومات إضافية عن قائمة المستخدِمين يمكن أن يكون التعليق user_list_info إحدى القيم التالية فقط:
ingestedUserListInfo

object (IngestedUserListInfo)

اختياريّ. تمثّل هذه السمة قائمة مستخدمين تتم تعبئتها ببيانات من مصادر خارجية.

MembershipStatus

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

عمليات التعداد
MEMBERSHIP_STATUS_UNSPECIFIED لم يتم تحديد أي قيمة.
OPEN الحالة "مفتوحة": يتم تجميع أعضاء في قائمة المستخدمين ويمكن استهدافها.
CLOSED الحالة "مغلقة" - لا تتم إضافة أي أعضاء جدد.

ClosingReason

تشير إلى سبب إغلاق قائمة المستخدمين. لا يتم استخدام هذه القائمة إلا عندما يغلقها النظام تلقائيًا.

عمليات التعداد
CLOSING_REASON_UNSPECIFIED لم يتم تحديد أي قيمة.
UNUSED تم إغلاق قائمة المستخدمين لأنّها لم تُستخدَم في الاستهداف مؤخرًا. يمكنك الاطّلاع على https://support.google.com/google-ads/answer/2472738 للحصول على التفاصيل.

AccessReason

تعداد يصف أسباب الوصول المحتملة.

عمليات التعداد
ACCESS_REASON_UNSPECIFIED لم يتم تحديد أي قيمة.
OWNED يمتلك المستخدم المرجع.
SHARED تتم مشاركة المرجع مع المستخدم.
LICENSED تم ترخيص المورد للمستخدم.
SUBSCRIBED اشترك المستخدم في المرجع.
AFFILIATED يمكن للمستخدم الوصول إلى المرجع.

AccessStatus

تشير إلى ما إذا كان هذا العميل لا يزال بإمكانه الوصول إلى القائمة.

عمليات التعداد
ACCESS_STATUS_UNSPECIFIED لم يتم تحديد أي قيمة.
ENABLED تم تفعيل إمكانية الوصول.
DISABLED تم إيقاف إذن الوصول.

SizeInfo

عدد الأعضاء المقدَّر في قائمة المستخدمين هذه على الشبكات المستهدَفة المختلفة

تمثيل JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
الحقول
displayNetworkMembersCount

string (int64 format)

النتائج فقط. العدد المقدَّر للأعضاء في قائمة المستخدمين هذه على "شبكة Google الإعلانية"
searchNetworkMembersCount

string (int64 format)

النتائج فقط. العدد المقدَّر للأعضاء في قائمة المستخدمين هذه ضمن النطاق google.com هؤلاء هم الأعضاء المتاحون للاستهداف في "الحملات على شبكة البحث".
youtubeMembersCount

string (int64 format)

النتائج فقط. العدد المقدَّر للأعضاء في قائمة المستخدمين هذه على YouTube
gmailMembersCount

string (int64 format)

النتائج فقط. عدد الأعضاء المقدَّر في قائمة المستخدمين هذه على Gmail

TargetNetworkInfo

معلومات الأهلية للشبكات المستهدَفة المختلفة

تمثيل JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
الحقول
eligibleForDisplay

boolean

النتائج فقط. تشير إلى أنّ قائمة المستخدمين هذه مؤهَّلة لـ "شبكة Google الإعلانية".

IngestedUserListInfo

تمثّل هذه السمة قائمة مستخدمين تتم تعبئتها بالبيانات التي يقدّمها المستخدم.

تمثيل JSON 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
الحقول
uploadKeyTypes[]

enum (UploadKeyType)

الحقل مطلوب. غير قابل للتغيير أنواع مفاتيح التحميل لقائمة المستخدمين هذه
contactIdInfo

object (ContactIdInfo)

اختياريّ. معلومات إضافية عندما يكون CONTACT_ID أحد uploadKeyTypes
mobileIdInfo

object (MobileIdInfo)

اختياريّ. معلومات إضافية عندما يكون MOBILE_ID أحد uploadKeyTypes
userIdInfo

object (UserIdInfo)

اختياريّ. معلومات إضافية عندما يكون USER_ID أحد uploadKeyTypes
pairIdInfo

object (PairIdInfo)

اختياريّ. معلومات إضافية عندما يكون PAIR_ID أحد uploadKeyTypes

لا تتوفّر هذه الميزة إلا لشركاء البيانات.
pseudonymousIdInfo

object (PseudonymousIdInfo)

اختياريّ. المعلومات الإضافية الخاصة بـ PSEUDONYMOUS_ID هي إحدى uploadKeyTypes.
partnerAudienceInfo

object (PartnerAudienceInfo)

اختياريّ. معلومات إضافية عن شرائح جمهور الشركاء

لا تتوفّر هذه الميزة إلا لشركاء البيانات.

UploadKeyType

تعداد يحتوي على أنواع مفاتيح التحميل المحتملة لقائمة مستخدمين.

عمليات التعداد
UPLOAD_KEY_TYPE_UNSPECIFIED لم يتم تحديد أي قيمة.
CONTACT_ID معلومات العملاء، مثل عنوان البريد الإلكتروني أو رقم الهاتف أو العنوان الجغرافي
MOBILE_ID معرّفات الإعلانات على الأجهزة الجوّالة
USER_ID معرّفات المستخدمين المقدَّمة من جهات خارجية
PAIR_ID معرّفات مطابقة هوية المعلِن لدى الناشر
PSEUDONYMOUS_ID معرّفات منصة إدارة البيانات: - معرّف مستخدم Google - معرّف يقدّمه الشريك - معرّف يقدّمه الناشر - معرّف المعلِنين على iOS - المعرّف الإعلاني على Android - معرّف Roku - معرّف Amazon Fire TV - معرّف Xbox أو Microsoft

ContactIdInfo

معلومات إضافية عندما يكون CONTACT_ID أحد uploadKeyTypes

تمثيل JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
الحقول
matchRatePercentage

integer

النتائج فقط. نسبة المطابقة لقوائم مستخدمي ميزة "مطابقة العملاء"
dataSourceType

enum (DataSourceType)

اختياريّ. غير قابل للتغيير مصدر بيانات التحميل

DataSourceType

تشير هذه السمة إلى مصدر بيانات التحميل.

عمليات التعداد
DATA_SOURCE_TYPE_UNSPECIFIED لم يتم تحديد أي قيمة.
DATA_SOURCE_TYPE_FIRST_PARTY البيانات التي تم تحميلها هي بيانات الطرف الأول.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU البيانات التي تم تحميلها مأخوذة من مكتب ائتمان تابع لجهة خارجية.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE البيانات المحمَّلة مأخوذة من ملف ناخبين تابع لجهة خارجية.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA البيانات التي تم تحميلها هي بيانات شركاء خارجيين.

MobileIdInfo

معلومات إضافية عندما يكون MOBILE_ID أحد uploadKeyTypes

تمثيل JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
الحقول
dataSourceType

enum (DataSourceType)

اختياريّ. غير قابل للتغيير مصدر بيانات التحميل.
keySpace

enum (KeySpace)

الحقل مطلوب. غير قابل للتغيير مساحة المفاتيح لمعرّفات الأجهزة الجوّالة
appId

string

الحقل مطلوب. غير قابل للتغيير سلسلة تحدّد بشكلٍ فريد تطبيقًا على الأجهزة الجوّالة تم جمع البيانات منه.

KeySpace

مساحة المفتاح لبطاقة التعريف الرقمية على الأجهزة الجوّالة

عمليات التعداد
KEY_SPACE_UNSPECIFIED لم يتم تحديد أي قيمة.
IOS مساحة مفاتيح iOS
ANDROID مساحة مفاتيح Android

UserIdInfo

معلومات إضافية عندما يكون USER_ID أحد uploadKeyTypes

تمثيل JSON 
{
  "dataSourceType": enum (DataSourceType)
}
الحقول
dataSourceType

enum (DataSourceType)

اختياريّ. غير قابل للتغيير مصدر بيانات التحميل.

PairIdInfo

معلومات إضافية عندما يكون PAIR_ID أحد uploadKeyTypes

لا تتوفّر هذه الميزة إلا لشركاء البيانات.

تمثيل JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
الحقول
publisherId

string (int64 format)

الحقل مطلوب. غير قابل للتغيير تحدّد هذه السمة الناشر الذي تتم مطابقة قائمة المستخدمين الخاصة به مع قائمة المستخدمين الخاصة بميزة "مطابقة هوية المعلِن والناشر". يتم توفير هذا الحقل من قِبل مقدّم خدمة المساحة الآمنة، وهو فريد فقط في نطاق تلك المساحة. لا يمكن استخدام هذا المعرّف كمعرّف عام على مستوى مساحات عرض إعلانات متعدّدة.
publisherName

string

الحقل مطلوب. اسم وصفي للناشر سيتم عرضه في واجهة المستخدم لتوفير تجربة استهداف أفضل.
matchRatePercentage

integer

الحقل مطلوب. يشير هذا الحقل إلى النسبة المئوية لمطابقة العضوية في قائمة المستخدمين هذه مع بيانات الطرف الأول الخاصة بالناشر المعنيّ. يجب أن تتراوح القيمة بين 0 و100، بما في ذلك الرقمان.
advertiserIdentifierCount

string (int64 format)

اختياريّ. عدد سجلّات بيانات الطرف الأوّل للمعلِن التي تم تحميلها إلى مقدّم خدمة تقنية clean room. لا يشير ذلك إلى حجم قائمة مستخدمي PAIR.
cleanRoomIdentifier

string

الحقل مطلوب. غير قابل للتغيير تحدّد هذه السمة علاقة فريدة بين المعلِن والناشر مع مقدّم خدمة واحد لتقنية clean room أو مع عدّة مقدّمي خدمة لتقنية clean room.

PseudonymousIdInfo

معلومات إضافية عندما يكون PSEUDONYMOUS_ID أحد uploadKeyTypes

تمثيل JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
الحقول
syncStatus

enum (SyncStatus)

النتائج فقط. حالة مزامنة قائمة المستخدمين
billableRecordCount

string (int64 format)

اختياريّ. غير قابل للتغيير عدد السجلات القابلة للفوترة (مثل السجلات التي تم تحميلها أو مطابقتها)

SyncStatus

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

عمليات التعداد
SYNC_STATUS_UNSPECIFIED لم يتم تحديد أي قيمة.
CREATED تم إنشاء قائمة المستخدمين كعنصر نائب. لا يزال يتمّ مزامنة محتوى القائمة و/أو بياناتها الوصفية. قائمة المستخدمين غير جاهزة للاستخدام.
READY_FOR_USE قائمة المستخدمين جاهزة للاستخدام. تمت مزامنة المحتوى وملفات تعريف الارتباط بشكل صحيح.
FAILED حدث خطأ أثناء مزامنة محتوى و/أو بيانات قائمة المستخدمين. لا يمكن استخدام قائمة المستخدمين.

PartnerAudienceInfo

معلومات إضافية عن شرائح جمهور الشركاء

لا تتوفّر هذه الميزة إلا لشركاء البيانات.

تمثيل JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
الحقول
partnerAudienceSource

enum (PartnerAudienceSource)

الحقل مطلوب. غير قابل للتغيير مصدر شرائح جمهور الشريك
commercePartner

string

اختياريّ. اسم شريك التجارة يُسمح بذلك فقط إذا كانت قيمة partnerAudienceSource هي COMMERCE_AUDIENCE.

PartnerAudienceSource

مصدر بيانات عن الجمهور الخاص بالشريك

عمليات التعداد
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED لم يتم تحديد أي قيمة.
COMMERCE_AUDIENCE مصدر بيانات عن الجمهور الخاص بالشريك هو جمهور التجارة.
LINEAR_TV_AUDIENCE مصدر بيانات عن الجمهور الشريك هو برامج تلفزيونية مُجدوَلة.
AGENCY_PROVIDER_AUDIENCE مصدر بيانات الجمهور الخاص بالشركاء هو جمهور الوكالة/المزوّد.

الطُرق

create

 تُنشئ هذه الطريقة قائمة مستخدمين.

delete

 تحذف هذه الطريقة UserList.

get

 تعرض هذه الطريقة UserList.

list

 تعرض هذه الطريقة قوائم المستخدمين.

patch

 تعدِّل هذه الطريقة UserList.