REST Resource: accountTypes.accounts.userLists

منبع: فهرست کاربران

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

نمایش 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)

اختیاری. مدت زمانی که یک کاربر در لیست کاربران باقی می‌ماند. مدت زمان‌های معتبر، مضرب دقیقی از ۲۴ ساعت (۸۶۴۰۰ ثانیه) هستند. ارائه مقداری که مضرب دقیقی از ۲۴ ساعت نباشد، منجر به خطای 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 از نوع Union. اطلاعات تکمیلی در مورد لیست کاربران. user_list_info فقط می‌تواند یکی از موارد زیر باشد:
ingestedUserListInfo

object ( IngestedUserListInfo )

اختیاری. نشان‌دهنده‌ی فهرستی از کاربران است که توسط داده‌های دریافتی کاربر پر شده است.

وضعیت عضویت

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

انوم‌ها
MEMBERSHIP_STATUS_UNSPECIFIED مشخص نشده است.
OPEN وضعیت باز - فهرست کاربران در حال افزایش اعضا است و می‌توان آنها را هدف قرار داد.
CLOSED وضعیت بسته - هیچ عضو جدیدی اضافه نمی‌شود.

دلیل بسته شدن

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

انوم‌ها
CLOSING_REASON_UNSPECIFIED مشخص نشده است.
UNUSED فهرست کاربران بسته شد زیرا اخیراً در هدف‌گیری استفاده نشده است. برای جزئیات بیشتر به https://support.google.com/google-ads/answer/2472738 مراجعه کنید.

دلیل دسترسی

Enum دلایل دسترسی ممکن را توصیف می‌کند.

انوم‌ها
ACCESS_REASON_UNSPECIFIED مشخص نشده است.
OWNED منبع متعلق به کاربر است.
SHARED منبع برای کاربر به اشتراک گذاشته می‌شود.
LICENSED مجوز استفاده از منبع به کاربر داده شده است.
SUBSCRIBED کاربر در منبع مشترک شد.
AFFILIATED منبع برای کاربر قابل دسترسی است.

وضعیت دسترسی

نشان می‌دهد که آیا این کلاینت هنوز به لیست دسترسی دارد یا خیر.

انوم‌ها
ACCESS_STATUS_UNSPECIFIED مشخص نشده است.
ENABLED دسترسی فعال شد.
DISABLED دسترسی غیرفعال است.

اطلاعات اندازه

تعداد تخمینی اعضای این فهرست کاربران در شبکه‌های هدف مختلف.

نمایش JSON 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
فیلدها
displayNetworkMembersCount

string ( int64 format)

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

searchNetworkMembersCount

string ( int64 format)

فقط خروجی. تعداد تخمینی اعضای این فهرست کاربران در دامنه google.com. اینها اعضایی هستند که برای هدف‌گیری در کمپین‌های جستجو در دسترس هستند.

youtubeMembersCount

string ( int64 format)

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

gmailMembersCount

string ( int64 format)

فقط خروجی. تعداد تخمینی اعضای این فهرست کاربری در Gmail.

اطلاعات شبکه هدف

اطلاعات واجد شرایط بودن برای شبکه‌های هدف مختلف.

نمایش JSON 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
فیلدها
eligibleForDisplay

boolean

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

اطلاعات کاربر مصرف‌شده

نشان دهنده یک لیست کاربر است که توسط داده های ارائه شده توسط کاربر پر شده است.

نمایش 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 )

اختیاری. اطلاعات تکمیلی برای مخاطبان همکار.

این ویژگی فقط برای شرکای داده در دسترس است.

نوع کلید آپلود

Enum شامل انواع کلید آپلود ممکن از لیست کاربران.

انوم‌ها
UPLOAD_KEY_TYPE_UNSPECIFIED مشخص نشده است.
CONTACT_ID اطلاعات مشتری مانند آدرس ایمیل، شماره تلفن یا آدرس فیزیکی.
MOBILE_ID شناسه‌های تبلیغات موبایلی
USER_ID شناسه‌های کاربری ارائه شده توسط شخص ثالث.
PAIR_ID شناسه‌های تطبیق هویت ناشر، تبلیغ‌کننده.
PSEUDONYMOUS_ID شناسه‌های پلتفرم مدیریت داده‌ها: - شناسه کاربری گوگل - شناسه ارائه شده توسط شریک - شناسه ارائه شده توسط ناشر - شناسه شناسایی هویت iOS - شناسه تبلیغات اندروید - شناسه Roku - شناسه Amazon Fire TV - شناسه Xbox یا Microsoft

اطلاعات تماس

اطلاعات تکمیلی زمانی که CONTACT_ID یکی از uploadKeyTypes باشد.

نمایش JSON 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
فیلدها
matchRatePercentage

integer

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

dataSourceType

enum ( 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 داده‌های آپلود شده، داده‌های شریک شخص ثالث هستند.

اطلاعات موبایل

اطلاعات تکمیلی زمانی که MOBILE_ID یکی از uploadKeyTypes باشد.

نمایش JSON 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
فیلدها
dataSourceType

enum ( DataSourceType )

اختیاری. تغییرناپذیر. منبع داده‌های آپلود.

keySpace

enum ( KeySpace )

الزامی. تغییرناپذیر. فضای کلیدی شناسه‌های موبایل.

appId

string

الزامی. تغییرناپذیر. رشته‌ای که به طور منحصر به فرد، برنامه‌ی موبایلی را که داده‌ها از آن جمع‌آوری شده است، مشخص می‌کند.

فضای کلید

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

انوم‌ها
KEY_SPACE_UNSPECIFIED مشخص نشده است.
IOS فضای کلید iOS.
ANDROID فضای کلید اندروید.

اطلاعات شناسه کاربری

اطلاعات تکمیلی زمانی که USER_ID یکی از uploadKeyTypes باشد.

نمایش JSON 
{
  "dataSourceType": enum (DataSourceType)
}
فیلدها
dataSourceType

enum ( DataSourceType )

اختیاری. تغییرناپذیر. منبع داده‌های آپلود.

اطلاعات جفت

اطلاعات تکمیلی زمانی که PAIR_ID یکی از uploadKeyTypes باشد.

این ویژگی فقط برای شرکای داده در دسترس است.

نمایش JSON 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
فیلدها
publisherId

string ( int64 format)

الزامی. تغییرناپذیر. ناشری را که فهرست کاربران تطبیق هویت ناشر-تبلیغ‌کننده با آن تطبیق داده شده است، شناسایی می‌کند. این فیلد توسط ارائه‌دهنده‌ی اتاق تمیز ارائه می‌شود و فقط در محدوده‌ی آن اتاق تمیز منحصر به فرد است. این را نمی‌توان به عنوان یک شناسه‌ی سراسری در چندین اتاق تمیز استفاده کرد.

publisherName

string

الزامی. نام توصیفی ناشر که برای تجربه بهتر هدف‌گیری در رابط کاربری نمایش داده می‌شود.

matchRatePercentage

integer

الزامی. این فیلد درصد تطابق عضویت این فهرست کاربر با داده‌های شخص اول ناشر مربوطه را نشان می‌دهد. باید بین ۰ تا ۱۰۰ باشد.

advertiserIdentifierCount

string ( int64 format)

اختیاری. تعداد رکوردهای داده شخص اول تبلیغ‌کننده که در یک ارائه‌دهنده اتاق تمیز آپلود شده‌اند. این نشان‌دهنده اندازه لیست کاربران PAIR نیست.

cleanRoomIdentifier

string

الزامی. تغییرناپذیر. رابطه‌ی منحصر به فرد تبلیغ‌کننده با ناشر را با یک ارائه‌دهنده‌ی اتاق تمیز یا بین چندین ارائه‌دهنده‌ی اتاق تمیز مشخص می‌کند.

اطلاعات شناسه مستعار

اطلاعات بیشتر زمانی که PSEUDONYMOUS_ID یکی از uploadKeyTypes باشد.

نمایش JSON 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
فیلدها
syncStatus

enum ( SyncStatus )

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

billableRecordCount

string ( int64 format)

اختیاری. تغییرناپذیر. تعداد رکوردهای قابل پرداخت (مثلاً آپلود شده یا تطبیق داده شده).

همگام‌سازی وضعیت

وضعیت همگام‌سازی فهرست کاربران.

انوم‌ها
SYNC_STATUS_UNSPECIFIED مشخص نشده است.
CREATED فهرست کاربران به عنوان یک متغیر ایجاد شده است. محتوای فهرست و/یا فراداده‌ها هنوز در حال همگام‌سازی هستند. فهرست کاربران آماده استفاده نیست.
READY_FOR_USE فهرست کاربران آماده استفاده است. محتوا و کوکی‌ها به درستی همگام‌سازی شده‌اند.
FAILED خطایی در همگام‌سازی محتوای فهرست کاربران و/یا فراداده‌ها رخ داده است. فهرست کاربران قابل استفاده نیست.

اطلاعات مخاطب شریک

اطلاعات تکمیلی برای مخاطبان همکار.

این ویژگی فقط برای شرکای داده در دسترس است.

نمایش JSON 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
فیلدها
partnerAudienceSource

enum ( PartnerAudienceSource )

الزامی. تغییرناپذیر. منبع مخاطبان شریک.

commercePartner

string

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

منبع همکارمخاطبان

منبع مخاطبان شریک.

انوم‌ها
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED مشخص نشده است.
COMMERCE_AUDIENCE منبع مخاطب شریک، مخاطبان بخش تجارت هستند.
LINEAR_TV_AUDIENCE منبع مخاطب شریک، مخاطبان تلویزیون خطی هستند.
AGENCY_PROVIDER_AUDIENCE منبع مخاطب شریک، مخاطب آژانس/ارائه‌دهنده است.

روش‌ها

create

 یک لیست کاربری ایجاد می‌کند.

delete

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

get

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

list

 فهرست‌ها فهرست‌های کاربران.

patch

 یک لیست کاربری را به‌روزرسانی می‌کند.