Package google.ads.datamanager.v1

فهرست

• IngestionService (رابط)
• MarketingDataInsightsService (رابط کاربری)
• PartnerLinkService (رابط کاربری)
• UserListDirectLicenseService (رابط)
• UserListGlobalLicenseService (رابط)
• UserListService (رابط کاربری)
• AdIdentifiers (پیام)
• AddressInfo (پیام)
• AgeRange (شمارشی)
• AudienceMember (پیام)
• AwsWrappedKeyInfo (پیام)
• نوع کلید (شمارشی) AwsWrappedKeyInfo.KeyType
• Baseline (پیام)
• Baseline.Location (پیام)
• CartData (پیام)
• Consent (پیام)
• ConsentStatus (شمارشی)
• ContactIdInfo (پیام)
• CreatePartnerLinkRequest (پیام)
• CreateUserListDirectLicenseRequest (پیام)
• CreateUserListGlobalLicenseRequest (پیام)
• CreateUserListRequest (پیام)
• CustomVariable (پیام)
• CustomerType (شمارشی)
• CustomerValueBucket (شمارشی)
• DataSourceType (شمارشی)
• DeletePartnerLinkRequest (پیام)
• DeleteUserListRequest (پیام)
• Destination (پیام)
• DeviceInfo (پیام)
• Encoding (enum)
• EncryptionInfo (پیام)
• ErrorCount (پیام)
• ErrorInfo (پیام)
• ErrorReason (enum)
• Event (پیام)
• EventParameter (پیام)
• EventSource (شمارشی)
• ExperimentalField (پیام)
• GcpWrappedKeyInfo (پیام)
• نوع کلید (شمارشی) GcpWrappedKeyInfo.KeyType
• Gender (شمارشی)
• GetUserListDirectLicenseRequest (پیام)
• GetUserListGlobalLicenseRequest (پیام)
• GetUserListRequest (پیام)
• IngestAudienceMembersRequest (پیام)
• IngestAudienceMembersResponse (پیام)
• IngestEventsRequest (پیام)
• IngestEventsResponse (پیام)
• IngestedUserListInfo (پیام)
• نوع کلید بارگذاری شده (enum) در لیست کاربران مصرف شده ( IngestedUserListInfo.UploadKeyType )
• Item (پیام)
• ItemParameter (پیام)
• ListUserListDirectLicensesRequest (پیام)
• ListUserListDirectLicensesResponse (پیام)
• ListUserListGlobalLicenseCustomerInfosRequest (پیام)
• ListUserListGlobalLicenseCustomerInfosResponse (پیام)
• ListUserListGlobalLicensesRequest (پیام)
• ListUserListGlobalLicensesResponse (پیام)
• ListUserListsRequest (پیام)
• پاسخ (پیام) ListUserListsResponse
• MatchRateRange (شمارشی)
• MobileData (پیام)
• MobileIdInfo (پیام)
• MobileIdInfo.KeySpace (شمارشی)
• PairData (پیام)
• PairIdInfo (پیام)
• PartnerAudienceInfo (پیام)
• PartnerAudienceInfo.PartnerAudienceSource (شمارشی)
• PartnerLink (پیام)
• PpidData (پیام)
• ProcessingErrorReason (enum)
• ProcessingWarningReason (enum)
• Product (enum) (منسوخ شده)
• ProductAccount (پیام)
• ProductAccount.AccountType حساب (شمارشی)
• PseudonymousIdInfo (پیام)
• PseudonymousIdInfo.SyncStatus (شمارشی)
• RemoveAudienceMembersRequest (پیام)
• RemoveAudienceMembersResponse (پیام)
• RequestStatusPerDestination (پیام)
• RequestStatusPerDestination.IngestAudienceMembersStatus مخاطب (پیام)
• RequestStatusPerDestination.IngestEventsStatus (پیام)
• RequestStatusPerDestination.IngestMobileDataStatus (پیام)
• RequestStatusPerDestination.IngestPairDataStatus (پیام)
• RequestStatusPerDestination.IngestPpidDataStatus (پیام)
• RequestStatusPerDestination.IngestUserDataStatus (پیام)
• RequestStatusPerDestination.IngestUserIdDataStatus (پیام)
• RequestStatusPerDestination.RemoveAudienceMembersStatus (پیام)
• RequestStatusPerDestination.RemoveMobileDataStatus (پیام)
• RequestStatusPerDestination.RemovePairDataStatus (پیام)
• RequestStatusPerDestination.RemovePpidDataStatus (پیام)
• RequestStatusPerDestination.RemoveUserDataStatus (پیام)
• RequestStatusPerDestination.RemoveUserIdDataStatus (پیام)
• RequestStatusPerDestination.RequestStatus (تعدادی)
• RetrieveInsightsRequest (پیام)
• RetrieveInsightsResponse (پیام)
• RetrieveInsightsResponse.MarketingDataInsight داده‌های بازاریابی (پیام)
• RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension داده‌های بازاریابی، بینش‌ها، مخاطبان، بینش‌ها، ابعاد (شمارشی)
• RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute داده‌های بازاریابی، بینش‌ها، ویژگی بینش‌های داده‌های بازاریابی (پیام)
• RetrieveRequestStatusRequest (پیام)
• RetrieveRequestStatusResponse (پیام)
• SearchPartnerLinksRequest (پیام)
• SearchPartnerLinksResponse (پیام)
• SizeInfo (پیام)
• TargetNetworkInfo (پیام)
• TermsOfService (پیام)
• TermsOfServiceStatus (enum)
• UpdateUserListDirectLicenseRequest (پیام)
• UpdateUserListGlobalLicenseRequest (پیام)
• UpdateUserListRequest (پیام)
• UserData (پیام)
• UserIdData (پیام)
• UserIdInfo (پیام)
• UserIdentifier (پیام)
• UserList (پیام)
• UserList.AccessReason (شمارشی)
• UserList.AccessStatus (شمارشی)
• دلیل UserList.ClosingReason (شمارشی)
• UserList.MembershipStatus (شمارشی)
• UserListDirectLicense (پیام)
• UserListGlobalLicense (پیام)
• UserListGlobalLicenseCustomerInfo (پیام)
• UserListGlobalLicenseType (enum)
• UserListLicenseClientAccountType (شمارشی)
• UserListLicenseMetrics (پیام)
• UserListLicensePricing (پیام)
• UserListLicensePricing.UserListPricingBuyerApprovalState وضعیت تأیید خریدار (شمارشی)
• UserListLicensePricing.UserListPricingCostType (شمارشی)
• UserListLicenseStatus (شمارشی)
• UserProperties (پیام)
• UserProperty (پیام)
• WarningCount (پیام)
• WarningInfo (پیام)

خدمات بلع

سرویسی برای ارسال داده‌های مخاطبان به مقاصد پشتیبانی‌شده.

اعضای IngestAudience
rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse ) فهرستی از منابع AudienceMember را در Destination ارائه شده آپلود می‌کند. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

رویدادهای Ingest
rpc IngestEvents( IngestEventsRequest ) returns ( IngestEventsResponse ) فهرستی از منابع Event را از Destination ارائه شده بارگذاری می‌کند. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

حذف اعضای مخاطب
rpc RemoveAudienceMembers( RemoveAudienceMembersRequest ) returns ( RemoveAudienceMembersResponse ) لیستی از منابع AudienceMember را از Destination ارائه شده حذف می‌کند. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

بازیابی وضعیت درخواست
rpc RetrieveRequestStatus( RetrieveRequestStatusRequest ) returns ( RetrieveRequestStatusResponse ) وضعیت یک درخواست را با دادن شناسه درخواست (request id) دریافت می‌کند. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

سرویس بینش داده‌های بازاریابی

سرویسی برای ارائه بینش در مورد داده‌های بازاریابی.

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

بازیابی بینش‌ها

rpc RetrieveInsights( RetrieveInsightsRequest ) returns ( RetrieveInsightsResponse ) بینش داده‌های بازاریابی را برای یک لیست کاربر مشخص بازیابی می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (اختیاری) نام منبع حساب کاربری که محصول آن به login-account لینک شده است. فرمت: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

خدمات لینک شریک

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

ایجاد لینک همکار

rpc CreatePartnerLink( CreatePartnerLinkRequest ) returns ( PartnerLink ) یک لینک همکار برای حساب داده شده ایجاد می‌کند. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

حذف لینک همکار

rpc DeletePartnerLink( DeletePartnerLinkRequest ) returns ( Empty ) لینک همکاری را برای حساب داده شده حذف می‌کند. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

جستجوی لینک‌های همکار

rpc SearchPartnerLinks( SearchPartnerLinksRequest ) returns ( SearchPartnerLinksResponse ) تمام لینک‌های همکار به و از یک حساب کاربری مشخص را جستجو می‌کند. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

سرویس مجوز مستقیم لیست کاربر

سرویسی برای مدیریت مجوزهای مستقیم لیست کاربران. حذف یک عملیات پشتیبانی شده برای UserListDirectLicenses نیست. تماس‌گیرندگان باید وضعیت مجوز را به DISABLED به‌روزرسانی کنند تا بتوانند مجوز را غیرفعال کنند.

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

مجوز مستقیم CreateUserList
rpc CreateUserListDirectLicense( CreateUserListDirectLicenseRequest ) returns ( UserListDirectLicense ) یک مجوز مستقیم برای فهرست کاربران ایجاد می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

GetUserListDirectLicense
rpc GetUserListDirectLicense( GetUserListDirectLicenseRequest ) returns ( UserListDirectLicense ) مجوز مستقیم فهرست کاربران را بازیابی می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

مجوزها ListUserListDirect
rpc ListUserListDirectLicenses( ListUserListDirectLicensesRequest ) returns ( ListUserListDirectLicensesResponse ) تمام مجوزهای مستقیم لیست کاربران متعلق به حساب والد را فهرست می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

به‌روزرسانیمجوز مستقیملیست‌کاربر
rpc UpdateUserListDirectLicense( UpdateUserListDirectLicenseRequest ) returns ( UserListDirectLicense ) مجوز مستقیم فهرست کاربران را به‌روزرسانی می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

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

سرویسی برای مدیریت مجوزهای سراسری فهرست کاربران. حذف، عملیاتی پشتیبانی‌شده برای UserListGlobalLicenses نیست. فراخوانی‌کنندگان باید وضعیت مجوز را به DISABLED به‌روزرسانی کنند تا بتوانند مجوز را غیرفعال کنند.

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

ایجادلیست کاربرGlobalLicense
rpc CreateUserListGlobalLicense( CreateUserListGlobalLicenseRequest ) returns ( UserListGlobalLicense ) یک فهرست کاربر با مجوز سراسری ایجاد می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

GetUserListGlobalLicense
rpc GetUserListGlobalLicense( GetUserListGlobalLicenseRequest ) returns ( UserListGlobalLicense ) مجوز سراسری فهرست کاربران را بازیابی می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

اطلاعات مشتری ListUserListGlobalLicense
rpc ListUserListGlobalLicenseCustomerInfos( ListUserListGlobalLicenseCustomerInfosRequest ) returns ( ListUserListGlobalLicenseCustomerInfosResponse ) تمام اطلاعات مشتری را برای یک مجوز جهانی فهرست کاربر فهرست می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

لیستکاربرلیستمجوزهای جهانی
rpc ListUserListGlobalLicenses( ListUserListGlobalLicensesRequest ) returns ( ListUserListGlobalLicensesResponse ) تمام مجوزهای سراسری متعلق به حساب کاربری والد را فهرست می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

به‌روزرسانی فهرست کاربران، مجوز جهانی
rpc UpdateUserListGlobalLicense( UpdateUserListGlobalLicenseRequest ) returns ( UserListGlobalLicense ) فهرست کاربران با مجوز جهانی را به‌روزرسانی می‌کند. این ویژگی فقط برای شرکای داده در دسترس است. دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

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

سرویسی برای مدیریت منابع UserList.

ایجاد لیست کاربران

rpc CreateUserList( CreateUserListRequest ) returns ( UserList ) یک لیست کاربری ایجاد می‌کند. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (اختیاری) نام منبع حساب کاربری که محصول آن به login-account لینک شده است. فرمت: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

حذف لیست کاربران

rpc DeleteUserList( DeleteUserListRequest ) returns ( Empty ) یک لیست کاربری را حذف می‌کند. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (اختیاری) نام منبع حساب کاربری که محصول آن به login-account لینک شده است. فرمت: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

دریافت لیست کاربران

rpc GetUserList( GetUserListRequest ) returns ( UserList ) یک لیست کاربر دریافت می‌کند. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (اختیاری) نام منبع حساب کاربری که محصول آن به login-account لینک شده است. فرمت: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

لیست‌ها

rpc ListUserLists( ListUserListsRequest ) returns ( ListUserListsResponse ) فهرست‌ها فهرست‌های کاربران. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (اختیاری) نام منبع حساب کاربری که محصول آن به login-account لینک شده است. فرمت: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

به‌روزرسانی فهرست کاربران

rpc UpdateUserList( UpdateUserListRequest ) returns ( UserList ) یک لیست کاربری را به‌روزرسانی می‌کند. سربرگ‌های مجوز: این متد از هدرهای اختیاری زیر برای تعریف نحوه‌ی مجوزدهی دسترسی برای درخواست توسط API پشتیبانی می‌کند: login-account : (اختیاری) نام منبع حسابی که حساب گوگلِ اعتبارنامه‌ها در آن یک کاربر است. اگر تنظیم نشده باشد، به طور پیش‌فرض حساب درخواست را در نظر می‌گیرد. قالب: accountTypes/{loginAccountType}/accounts/{loginAccountId} linked-account : (اختیاری) نام منبع حساب کاربری که محصول آن به login-account لینک شده است. فرمت: accountTypes/{linkedAccountType}/accounts/{linkedAccountId} دامنه‌های مجوز به محدوده OAuth زیر نیاز دارد: https://www.googleapis.com/auth/datamanager

شناسه‌های تبلیغاتی

شناسه‌ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت‌های آنلاین (مانند کلیک‌های تبلیغاتی).

فیلدها
session_attributes	string اختیاری. ویژگی‌های جلسه برای انتساب و مدل‌سازی رویداد.
gclid	string اختیاری. شناسه کلیک گوگل (gclid) مرتبط با این رویداد.
gbraid	string اختیاری. شناسه کلیک برای کلیک‌های مرتبط با رویدادهای برنامه و منشأ گرفته از دستگاه‌های iOS با شروع iOS14.
wbraid	string اختیاری. شناسه کلیک برای کلیک‌های مرتبط با رویدادهای وب و منشأ گرفته از دستگاه‌های iOS از iOS14 به بعد.
landing_page_device_info	DeviceInfo اختیاری. اطلاعات جمع‌آوری‌شده در مورد دستگاه مورد استفاده (در صورت وجود) در زمان ورود به سایت تبلیغ‌کننده پس از تعامل با تبلیغ.

اطلاعات آدرس

اطلاعات آدرس برای کاربر.

فیلدها
given_name	string الزامی. نام (کوچک) کاربر، تماماً با حروف کوچک، بدون نقطه‌گذاری، بدون فاصله‌ی خالی در ابتدا یا انتهای کلمه، و به صورت SHA-256 هش شده.
family_name	string الزامی. نام خانوادگی (فامیلی) کاربر، تماماً با حروف کوچک، بدون نقطه‌گذاری، بدون فاصله‌ی خالی در ابتدا یا انتهای کلمه، و به صورت SHA-256 هش شده.
region_code	string الزامی. کد منطقه دو حرفی در استاندارد ISO-3166-1 alpha-2 مربوط به آدرس کاربر.
postal_code	string الزامی. کد پستی آدرس کاربر.

محدوده سنی

بازه‌های سنی جمعیتی

انوم‌ها
AGE_RANGE_UNSPECIFIED	مشخص نشده است.
AGE_RANGE_UNKNOWN	ناشناخته.
AGE_RANGE_18_24	بین ۱۸ تا ۲۴ سال سن.
AGE_RANGE_25_34	بین ۲۵ تا ۳۴ سال سن داشته باشد.
AGE_RANGE_35_44	بین ۳۵ تا ۴۴ سال سن داشته باشد.
AGE_RANGE_45_54	بین ۴۵ تا ۵۴ سال سن دارند.
AGE_RANGE_55_64	بین ۵۵ تا ۶۴ سال سن دارند.
AGE_RANGE_65_UP	۶۵ سال به بالا.

عضو مخاطب

مخاطبی که قرار است تحت عمل جراحی قرار گیرد.

فیلدها
destination_references[]	string اختیاری. مشخص می‌کند که مخاطب به کدام Destination ارسال شود.
consent	Consent اختیاری. تنظیم رضایت برای کاربر.
data فیلد یونیون. نوع داده‌های شناسایی که قرار است روی آنها عملیات انجام شود. data می‌توانند فقط یکی از موارد زیر باشند:
user_data	UserData داده‌های ارائه شده توسط کاربر که کاربر را شناسایی می‌کند.
pair_data	PairData شناسه‌های تطبیق هویت ناشر و تبلیغ‌کننده (PAIR) . این ویژگی فقط برای شرکای داده در دسترس است.
mobile_data	MobileData داده‌هایی که دستگاه‌های تلفن همراه کاربر را شناسایی می‌کنند.
user_id_data	UserIdData داده‌های مربوط به شناسه‌های منحصر به فرد برای یک کاربر، همانطور که توسط تبلیغ‌کننده تعریف شده است.
ppid_data	PpidData داده‌های مربوط به شناسه‌های ارائه شده توسط ناشر. این ویژگی فقط برای شرکای داده در دسترس است.

اطلاعات کلید AwsWrappedKey

یک کلید رمزگذاری داده که توسط یک کلید AWS KMS پیچیده شده است.

فیلدها
key_type	KeyType الزامی. نوع الگوریتم مورد استفاده برای رمزگذاری داده‌ها.
role_arn	string الزامی. نام منبع آمازون مربوط به نقش IAM که برای دسترسی به رمزگشایی KMS در نظر گرفته شده است. باید به فرمت arn:{partition}:iam::{account_id}:role/{role_name} باشد.
kek_uri	string الزامی. آدرس اینترنتی (URI) کلید AWS KMS که برای رمزگشایی DEK استفاده می‌شود. باید به فرمت arn:{partition}:kms:{region}:{account_id}:key/{key_id} یا aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}
encrypted_dek	string الزامی. کلید رمزگذاری داده‌های رمزگذاری شده با کد base64.

نوع کلید

نوع الگوریتمی که برای رمزگذاری داده‌ها استفاده می‌شود.

انوم‌ها
KEY_TYPE_UNSPECIFIED	نوع کلید نامشخص. هرگز نباید استفاده شود.
XCHACHA20_POLY1305	الگوریتم XChaCha20-Poly1305

خط پایه

معیارهای پایه که بینش‌ها با آنها مقایسه می‌شوند.

فیلدها
baseline میدان اتحادیه. موقعیت خط مبنایی که بینش‌ها با آن مقایسه می‌شوند. baseline فقط می‌تواند یکی از موارد زیر باشد:
baseline_location	Location مکان پایه درخواست. مکان پایه یک لیست OR از مناطق درخواستی است.
location_auto_detection_enabled	bool اگر روی درست تنظیم شود، سرویس سعی می‌کند به‌طور خودکار موقعیت پایه را برای دریافت اطلاعات شناسایی کند.

مکان

مکان پایه درخواست. مکان پایه در فهرست OR کدهای منطقه ISO 3166-1 alpha-2 مناطق درخواستی قرار دارد.

فیلدها
region_codes[]	string فهرست کدهای منطقه‌ای ISO 3166-1 alpha-2.

سبد خرید

داده‌های سبد خرید مرتبط با رویداد.

فیلدها
merchant_id	string اختیاری. شناسه مرکز فروش مرتبط با اقلام.
merchant_feed_label	string اختیاری. برچسب فید مرکز فروشندگان که با فید اقلام مرتبط است.
merchant_feed_language_code	string اختیاری. کد زبان در ISO 639-1 مرتبط با فید مرکز فروشندگان اقلام. جایی که اقلام شما آپلود می‌شوند.
transaction_discount	double اختیاری. مجموع تمام تخفیف‌های مرتبط با تراکنش.
items[]	Item اختیاری. فهرست موارد مرتبط با رویداد.

رضایت

تنظیمات رضایت‌نامه‌ی قانون بازارهای دیجیتال (DMA) برای کاربر.

فیلدها
ad_user_data	ConsentStatus اختیاری. نشان می‌دهد که آیا کاربر با داده‌های کاربر تبلیغاتی موافقت می‌کند یا خیر.
ad_personalization	ConsentStatus اختیاری. نشان می‌دهد که آیا کاربر با شخصی‌سازی تبلیغ موافقت می‌کند یا خیر.

وضعیت رضایت

نشان می‌دهد که آیا کاربر رضایت خود را داده، رد کرده یا مشخص نکرده است.

انوم‌ها
CONSENT_STATUS_UNSPECIFIED	مشخص نشده است.
CONSENT_GRANTED	اعطا شد.
CONSENT_DENIED	تکذیب شد.

اطلاعات تماس

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

فیلدها
match_rate_percentage	int32 فقط خروجی. نرخ تطابق برای لیست‌های کاربر منطبق با مشتری.
data_source_type	DataSourceType اختیاری. تغییرناپذیر. منبع داده‌های آپلود

درخواست ایجاد لینک شریک

درخواست ایجاد یک منبع PartnerLink . یک PartnerLink برمی‌گرداند.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
parent	string الزامی. والد، که مالک این مجموعه از لینک‌های همکار است. قالب: accountTypes/{account_type}/accounts/{account}
partner_link	PartnerLink الزامی. لینک همکاری که باید ایجاد شود.

درخواست مجوز مستقیم ایجادلیست کاربر

درخواست ایجاد یک منبع UserListDirectLicense .

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
parent	string الزامی. حسابی که مالک فهرست کاربران دارای مجوز است. باید به فرمت accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} باشد.
user_list_direct_license	UserListDirectLicense الزامی. فهرست کاربران، مجوز مستقیم برای ایجاد.

درخواست مجوز سراسری (GlobalLicenseRequest)

درخواست ایجاد یک منبع UserListGlobalLicense .

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
parent	string الزامی. حسابی که مالک فهرست کاربران دارای مجوز است. باید به فرمت accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} باشد.
user_list_global_license	UserListGlobalLicense الزامی. فهرست کاربران، مجوز سراسری برای ایجاد.

درخواست ایجاد لیست کاربران

درخواست پیام برای CreateUserList.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
parent	string الزامی. حساب والد که این فهرست کاربران در آن ایجاد خواهد شد. قالب: accountTypes/{account_type}/accounts/{account}
user_list	UserList الزامی. فهرست کاربرانی که باید ایجاد شوند.
validate_only	bool اختیاری. اگر مقدار آن درست باشد، درخواست اعتبارسنجی می‌شود اما اجرا نمی‌شود.

متغیر سفارشی

متغیر سفارشی برای تبدیل تبلیغات.

فیلدها
variable	string اختیاری. نام متغیر سفارشی که قرار است تنظیم شود. اگر متغیر برای مقصد داده شده پیدا نشود، نادیده گرفته می‌شود.
value	string اختیاری. مقداری که قرار است برای متغیر سفارشی ذخیره شود.
destination_references[]	string اختیاری. رشته مرجعی که برای تعیین اینکه متغیر سفارشی باید به کدام یک از Event.destination_references ارسال شود، استفاده می‌شود. در صورت خالی بودن، از Event.destination_references استفاده خواهد شد.

نوع مشتری

نوع مشتری مرتبط با رویداد.

انوم‌ها
CUSTOMER_TYPE_UNSPECIFIED	نوع مشتری نامشخص. هرگز نباید استفاده شود.
NEW	مشتری برای تبلیغ کننده جدید است.
RETURNING	مشتری دوباره به تبلیغ کننده مراجعه می‌کند.
REENGAGED	مشتری دوباره با تبلیغ کننده ارتباط برقرار کرده است.

سبد ارزش مشتری

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

انوم‌ها
CUSTOMER_VALUE_BUCKET_UNSPECIFIED	CustomerValueBucket نامشخص. هرگز نباید استفاده شود.
LOW	مشتری ارزش پایینی دارد.
MEDIUM	مشتری ارزش متوسطی دارد.
HIGH	مشتری ارزش بالایی دارد.

نوع منبع داده

منبع داده‌های آپلود شده را نشان می‌دهد.

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

درخواست حذف لینک همکار

درخواست حذف یک منبع PartnerLink . مقدار google.protobuf.Empty را برمی‌گرداند.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
name	string الزامی. نام منبع لینک همکار برای حذف. قالب: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

درخواست حذف لیست کاربران

درخواست پیام برای DeleteUserList.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
name	string الزامی. نام فهرست کاربرانی که قرار است حذف شوند. قالب: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
validate_only	bool اختیاری. اگر مقدار آن درست باشد، درخواست اعتبارسنجی می‌شود اما اجرا نمی‌شود.

مقصد

محصول گوگلی که داده‌ها را برای آن ارسال می‌کنید. برای مثال، یک حساب Google Ads.

فیلدها
reference	string اختیاری. شناسه (ID) برای این منبع Destination ، منحصر به فرد در درخواست. برای ارجاع به این Destination در IngestEventsRequest و IngestAudienceMembersRequest استفاده می‌شود.
login_account	ProductAccount اختیاری. حسابی که برای فراخوانی این API استفاده می‌شود. برای اضافه کردن یا حذف داده‌ها از operating_account ، این login_account باید دسترسی نوشتن به operating_account داشته باشد. به عنوان مثال، یک حساب کاربری مدیر operating_account یا حسابی با پیوند برقرار شده به operating_account .
linked_account	ProductAccount اختیاری. حسابی که login_account کاربر فراخوانی‌کننده از طریق یک لینک حساب ایجاد شده به آن دسترسی دارد. برای مثال، login_account یک شریک داده ممکن است به linked_account یک مشتری دسترسی داشته باشد. شریک ممکن است از این فیلد برای ارسال داده از linked_account به operating_account دیگری استفاده کند.
operating_account	ProductAccount الزامی. حسابی که قرار است داده‌ها به آن ارسال یا از آن حذف شوند.
product_destination_id	string الزامی. شیء درون حساب محصول که باید در آن وارد شود. برای مثال، شناسه مخاطب گوگل ادز، شناسه مخاطب Display & Video 360 یا شناسه اقدام تبدیل گوگل ادز.

اطلاعات دستگاه

اطلاعات مربوط به دستگاهی که هنگام وقوع رویداد مورد استفاده قرار گرفته است (در صورت وجود).

فیلدها
user_agent	string اختیاری. رشته‌ی عامل کاربر دستگاه برای زمینه‌ی داده شده.
ip_address	string اختیاری. آدرس IP دستگاه برای زمینه داده شده. توجه: گوگل ادز از تطبیق آدرس IP برای کاربران نهایی در منطقه اقتصادی اروپا (EEA)، بریتانیا (UK) یا سوئیس (CH) پشتیبانی نمی‌کند. منطقی اضافه کنید تا به طور مشروط اشتراک‌گذاری آدرس‌های IP را از کاربران این مناطق حذف کنید و اطمینان حاصل کنید که اطلاعات واضح و جامعی در مورد داده‌هایی که در سایت‌ها، برنامه‌ها و سایر دارایی‌های خود جمع‌آوری می‌کنید در اختیار کاربران قرار می‌دهید و در صورت لزوم طبق قانون یا هرگونه سیاست گوگل، رضایت آنها را دریافت می‌کنید. برای جزئیات بیشتر به صفحه «درباره واردات تبدیل آفلاین» مراجعه کنید.

رمزگذاری

نوع کدگذاری اطلاعات شناسایی هش شده.

انوم‌ها
ENCODING_UNSPECIFIED	نوع رمزگذاری نامشخص. هرگز نباید استفاده شود.
HEX	کدگذاری هگز.
BASE64	کدگذاری پایه ۶۴

اطلاعات رمزگذاری

اطلاعات رمزگذاری برای داده‌های در حال مصرف.

فیلدها
فیلد union wrapped_key . کلید پیچیده شده‌ای که برای رمزگذاری داده‌ها استفاده می‌شود. wrapped_key می‌تواند فقط یکی از موارد زیر باشد:
gcp_wrapped_key_info	GcpWrappedKeyInfo پلتفرم ابری گوگل اطلاعات کلیدی را در خود جای داده است.
aws_wrapped_key_info	AwsWrappedKeyInfo خدمات وب آمازون اطلاعات کلیدی را در بر گرفت.

تعداد خطا

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

فیلدها
record_count	int64 تعداد رکوردهایی که به دلیل مشخصی آپلود نشده‌اند.
reason	ProcessingErrorReason دلیل خطای رکوردهای ناموفق.

اطلاعات خطا

برای هر نوع خطا، تعداد خطاها محاسبه می‌شود.

فیلدها
error_counts[]	ErrorCount فهرستی از خطاها و تعداد آنها به ازای هر دلیل خطا. ممکن است در همه موارد پر نشود.

دلیل خطا

دلایل خطا برای Data Manager API. توجه: این enum ثابت نیست و ممکن است در آینده مقادیر جدیدی اضافه شود.

انوم‌ها
ERROR_REASON_UNSPECIFIED	از این مقدار پیش‌فرض استفاده نکنید.
INTERNAL_ERROR	یک خطای داخلی رخ داده است.
DEADLINE_EXCEEDED	پاسخ به درخواست خیلی طول کشید.
RESOURCE_EXHAUSTED	درخواست‌ها خیلی زیاده.
NOT_FOUND	منبع یافت نشد.
PERMISSION_DENIED	کاربر مجوز ندارد یا منبع مورد نظر یافت نشد.
INVALID_ARGUMENT	مشکلی در درخواست وجود داشت.
REQUIRED_FIELD_MISSING	فیلد مورد نیاز موجود نیست.
INVALID_FORMAT	فرمت نامعتبر است.
INVALID_HEX_ENCODING	مقدار کدگذاری شده HEX ناقص است.
INVALID_BASE64_ENCODING	مقدار کدگذاری شده با base64 ناقص است.
INVALID_SHA256_FORMAT	مقدار رمزگذاری شده SHA256 ناقص است.
INVALID_POSTAL_CODE	کد پستی معتبر نیست.
INVALID_COUNTRY_CODE	منسوخ شده: Enum در رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) استفاده نمی‌شود. این کالا منسوخ شده است!
INVALID_ENUM_VALUE	مقدار Enum قابل استفاده نیست.
INVALID_USER_LIST_TYPE	نوع فهرست کاربران برای این درخواست قابل استفاده نیست.
INVALID_AUDIENCE_MEMBER	این عضو مخاطب معتبر نیست.
TOO_MANY_AUDIENCE_MEMBERS	حداکثر تعداد اعضای مخاطب مجاز برای هر درخواست 10،000 نفر است.
TOO_MANY_USER_IDENTIFIERS	حداکثر تعداد شناسه‌های کاربری مجاز برای هر مخاطب، ۱۰ است.
TOO_MANY_DESTINATIONS	حداکثر تعداد مقصد مجاز برای هر درخواست 10 است.
INVALID_DESTINATION	این مقصد معتبر نیست.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED	شریک داده به لیست کاربران متعلق به حساب عملیاتی دسترسی ندارد.
INVALID_MOBILE_ID_FORMAT	قالب شناسه موبایل معتبر نیست.
INVALID_USER_LIST_ID	لیست کاربران معتبر نیست.
MULTIPLE_DATA_TYPES_NOT_ALLOWED	دریافت چندین نوع داده در یک درخواست واحد مجاز نیست.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER	پیکربندی‌های مقصد حاوی یک حساب کاربری ورود به سیستم DataPartner باید در تمام پیکربندی‌های مقصد، حساب کاربری یکسانی داشته باشند.
TERMS_AND_CONDITIONS_NOT_SIGNED	شرایط و ضوابط الزامی پذیرفته نمی‌شود.
INVALID_NUMBER_FORMAT	قالب شماره نامعتبر است.
INVALID_CONVERSION_ACTION_ID	شناسه اقدام تبدیل معتبر نیست.
INVALID_CONVERSION_ACTION_TYPE	نوع عمل تبدیل معتبر نیست.
INVALID_CURRENCY_CODE	کد ارز پشتیبانی نمی‌شود.
INVALID_EVENT	این رویداد معتبر نیست.
TOO_MANY_EVENTS	حداکثر تعداد رویدادهای مجاز برای هر درخواست 10،000 است.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS	حساب مقصد برای تبدیل‌های پیشرفته برای سرنخ‌ها فعال نیست.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS	به دلیل سیاست‌های داده‌های مشتری گوگل، نمی‌توان از تبدیل‌های پیشرفته برای حساب مقصد استفاده کرد. با نماینده گوگل خود تماس بگیرید.
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED	حساب مقصد با شرایط تبدیل‌های پیشرفته موافقت نکرده است.
DUPLICATE_DESTINATION_REFERENCE	دو یا چند مقصد در درخواست، مرجع یکسانی دارند.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER	حساب عملیاتی پشتیبانی نشده برای مجوز شریک داده.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER	حساب پیوندی پشتیبانی نشده برای مجوز شریک داده.
NO_IDENTIFIERS_PROVIDED	داده‌های رویدادها حاوی هیچ شناسه کاربری یا شناسه تبلیغاتی نیستند.
INVALID_PROPERTY_TYPE	نوع ویژگی پشتیبانی نمی‌شود.
INVALID_STREAM_TYPE	نوع جریان پشتیبانی نمی‌شود.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT	حساب کاربری لینک‌شده فقط زمانی پشتیبانی می‌شود که حساب کاربری ورود، یک حساب DATA_PARTNER باشد.
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH	حساب کاربری ورود باید با حساب کاربری عملیاتی برای مورد استفاده داده شده یکسان باشد.
EVENT_TIME_INVALID	رویداد در بازه زمانی قابل قبول رخ نداده است.
RESERVED_NAME_USED	پارامتر از یک نام رزرو شده استفاده می‌کند.
INVALID_EVENT_NAME	نام رویداد پشتیبانی نمی‌شود.
NOT_ALLOWLISTED	این حساب برای ویژگی داده شده مجاز نیست.
INVALID_REQUEST_ID	شناسه درخواست استفاده شده برای بازیابی وضعیت یک درخواست معتبر نیست. وضعیت فقط برای درخواست‌هایی که موفق می‌شوند و validate_only=true ندارند، قابل بازیابی است.
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT	یک رویداد دو یا چند مقصد در گوگل آنالیتیکس داشت.
FIELD_VALUE_TOO_LONG	مقدار فیلد خیلی طولانی است.
TOO_MANY_ELEMENTS	تعداد عناصر موجود در لیست درخواست بسیار زیاد است.
ALREADY_EXISTS	منبع از قبل وجود دارد.
IMMUTABLE_FIELD_FOR_UPDATE	تلاش برای تنظیم یک فیلد تغییرناپذیر برای درخواست به‌روزرسانی.
INVALID_RESOURCE_NAME	نام منبع نامعتبر است.
INVALID_FILTER	فیلتر جستجو نامعتبر است.
INVALID_UPDATE_MASK	ماسک به‌روزرسانی نامعتبر است.
INVALID_PAGE_TOKEN	توکن صفحه نامعتبر است.
CANNOT_UPDATE_DISABLED_LICENSE	نمی‌توان مجوزی را که غیرفعال شده است، به‌روزرسانی کرد.
CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST	فهرست‌های حساس کاربران را نمی‌توان به این کلاینت مجوز داد.
INSUFFICIENT_COST	هزینه برای این مجوز خیلی کم است.
CANNOT_DISABLE_LICENSE	مجوز نمایندگی فروش را نمی‌توان غیرفعال کرد زیرا در حال استفاده است.
INVALID_CLIENT_ACCOUNT_ID	شناسه حساب مشتری نامعتبر است.
PRICING_ONLY_ZERO_COST_ALLOWED	هزینه غیر صفر برای این حساب مشتری مجاز نیست.
PRICE_TOO_HIGH	هزینه این مجوز خیلی بالاست.
CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE	مشتری مجاز به ایجاد مجوز نیست.
INVALID_PRICING_END_DATE	تاریخ پایان قیمت‌گذاری برای این مجوز نامعتبر است.
CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT	فهرست کاربران منطقی با بخش مشترک یا دارای مجوز، قابل مجوزدهی نیست.
MISMATCHED_ACCOUNT_TYPE	نوع حساب مشتری در درخواست با نوع حساب واقعی مشتری مطابقت ندارد.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE	نوع مجوز از هزینه اشتراک رسانه پشتیبانی نمی‌کند.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER	نوع مشتری مشتری از هزینه اشتراک رسانه پشتیبانی نمی‌کند.
INVALID_MEDIA_SHARE_COST	هزینه اشتراک رسانه نامعتبر است.
INVALID_COST_TYPE	نوع هزینه نامعتبر است.
MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST	نوع UserList از هزینه اشتراک رسانه پشتیبانی نمی‌کند.
MAX_COST_NOT_ALLOWED	حداکثر هزینه فقط برای cost_type MEDIA_SHARE مجاز است.
COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED	مخاطبان تجاری فقط می‌توانند مستقیماً مجوز بگیرند.
INVALID_DESCRIPTION	توضیحات معتبر نیست.
INVALID_DISPLAY_NAME	نام نمایشی معتبر نیست.
DISPLAY_NAME_ALREADY_USED	نام نمایشی قبلاً برای فهرست کاربران دیگری برای این حساب استفاده شده است.
OWNERSHIP_REQUIRED_FOR_UPDATE	برای تغییر فهرست کاربران، مالکیت لازم است.
USER_LIST_MUTATION_NOT_SUPPORTED	نوع لیست کاربر فقط خواندنی است و از جهش پشتیبانی نمی‌کند.
SENSITIVE_USER_LIST_IMMUTABLE	فهرست کاربری که به حریم خصوصی حساس است یا از نظر قانونی رد شده است، نمی‌تواند توسط کاربران خارجی تغییر داده شود.
BILLABLE_RECORD_COUNT_IMMUTABLE	فیلد رکورد قابل پرداخت در لیست کاربران ریمارکتینگ، پس از تنظیم، دیگر قابل تغییر نیست.
USER_LIST_NAME_RESERVED	نام فهرست کاربر برای فهرست‌های سیستمی رزرو شده است.
ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA	تبلیغ‌کننده باید برای استفاده از فهرست‌های بازاریابی مجدد ایجاد شده از داده‌های آپلود شده توسط تبلیغ‌کننده، در فهرست مجاز قرار گرفته باشد.
UNSUPPORTED_PARTNER_AUDIENCE_SOURCE	منبع مخاطب شریک برای نوع فهرست کاربر پشتیبانی نمی‌شود.
COMMERCE_PARTNER_NOT_ALLOWED	تنظیم فیلد commerce_partner فقط در صورتی پشتیبانی می‌شود که منبع partner_audience_source COMMERCE_AUDIENCE باشد.
UNSUPPORTED_PARTNER_AUDIENCE_INFO	فیلد partner_audience_info برای نوع لیست کاربران پشتیبانی نمی‌شود.
PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED	فهرست‌های کاربری Partner Match را نمی‌توان توسط حساب‌های مدیریتی ایجاد کرد.
DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA	شریک داده برای THIRD_PARTY_PARTNER_DATA در لیست مجاز قرار ندارد.
ADVERTISER_TOS_NOT_ACCEPTED	آگهی‌دهنده شرایط خدمات همکار را نپذیرفته است.
ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA	تبلیغ‌کننده برای داده‌های شریک سوم (THIRD_PARTY_PARTNER_DATA) در فهرست مجاز قرار ندارد.
USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT	این نوع فهرست کاربر برای این حساب پشتیبانی نمی‌شود.
INVALID_COMMERCE_PARTNER	فیلد commerce_partner نامعتبر است.
CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE	ارائه‌دهنده داده مجاز به ایجاد مخاطبان تجاری نیست.
UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES	انواع کلید آپلود لیست کاربر پشتیبانی نمی‌شوند.
UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG	پیکربندی اطلاعات لیست کاربرِ دریافت‌شده پشتیبانی نمی‌شود.
UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE	انواع حساب‌ها برای نوع فهرست کاربر پشتیبانی نمی‌شوند.
UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK	انواع حساب‌ها برای لینک همکار پشتیبانی نمی‌شوند.
MEMBERSHIP_DURATION_TOO_LONG	مدت زمان عضویت در لیست کاربران خیلی طولانی است.
INVALID_MERCHANT_ID	فیلد merchant_id معتبر نیست.
EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED	مشتری شامل کمپین‌های غیر معاف بدون اعلامیه تبلیغات سیاسی اتحادیه اروپا است.

رویداد

رویدادی که نشان‌دهنده تعامل کاربر با وب‌سایت یا برنامه تبلیغ‌کننده است.

فیلدها
destination_references[]	string اختیاری. رشته مرجع مورد استفاده برای تعیین مقصد. در صورت خالی بودن، رویداد به تمام destinations در درخواست ارسال خواهد شد.
transaction_id	string اختیاری. شناسه منحصر به فرد برای این رویداد. برای تبدیل‌هایی که از چندین منبع داده استفاده می‌کنند، الزامی است.
event_timestamp	Timestamp الزامی. زمان وقوع رویداد.
last_updated_timestamp	Timestamp اختیاری. آخرین باری که رویداد به‌روزرسانی شده است.
user_data	UserData اختیاری. بخش‌هایی از داده‌های ارائه شده توسط کاربر، که نشان دهنده کاربری است که رویداد با آن مرتبط است.
consent	Consent اختیاری. اطلاعاتی در مورد اینکه آیا کاربر مرتبط انواع مختلفی از رضایت را ارائه داده است یا خیر.
ad_identifiers	AdIdentifiers اختیاری. شناسه‌ها و سایر اطلاعات مورد استفاده برای تطبیق رویداد تبدیل با سایر فعالیت‌های آنلاین (مانند کلیک‌های تبلیغاتی).
currency	string اختیاری. کد ارزی مرتبط با تمام مقادیر پولی در این رویداد.
event_source	EventSource اختیاری. علامتی برای محل وقوع رویداد (وب، اپلیکیشن، فروشگاه و غیره).
event_device_info	DeviceInfo اختیاری. اطلاعات جمع‌آوری‌شده در مورد دستگاهی که هنگام وقوع رویداد مورد استفاده قرار گرفته است (در صورت وجود).
cart_data	CartData اختیاری. اطلاعات مربوط به تراکنش و موارد مرتبط با رویداد.
custom_variables[]	CustomVariable اختیاری. اطلاعات جفت کلید/مقدار اضافی برای ارسال به کانتینرهای تبدیل (عمل تبدیل یا فعالیت FL).
experimental_fields[]	ExperimentalField اختیاری. فهرستی از جفت‌های کلید/مقدار برای فیلدهای آزمایشی که ممکن است در نهایت به عنوان بخشی از API ارتقا یابند.
user_properties	UserProperties اختیاری. اطلاعات ارزیابی‌شده توسط تبلیغ‌کننده درباره کاربر در زمان وقوع رویداد.
event_name	string اختیاری. نام رویداد. برای رویدادهای GA4 الزامی است.
client_id	string اختیاری. یک شناسه منحصر به فرد برای نمونه کاربری یک کلاینت وب برای این جریان وب GA4.
user_id	string اختیاری. یک شناسه منحصر به فرد برای یک کاربر، همانطور که توسط تبلیغ کننده تعریف شده است.
additional_event_parameters[]	EventParameter اختیاری. مجموعه‌ای از پارامترهای رویداد که قرار است در رویداد گنجانده شوند و قبلاً با استفاده از فیلدهای ساختاریافته‌ی دیگر مشخص نشده‌اند.
conversion_value	double اختیاری. مقدار تبدیل مرتبط با رویداد، برای تبدیل‌های مبتنی بر ارزش.

پارامتر رویداد

پارامتر رویداد برای رویدادهای GA4.

فیلدها
parameter_name	string الزامی. نام پارامتری که قرار است استفاده شود.
value	string الزامی. نمایش رشته‌ای مقدار پارامتری که قرار است تنظیم شود.

منبع رویداد

منبع رویداد.

انوم‌ها
EVENT_SOURCE_UNSPECIFIED	منبع رویداد نامشخص. هرگز نباید استفاده شود.
WEB	این رویداد از یک مرورگر وب ایجاد شده است.
APP	این رویداد از یک برنامه ایجاد شده است.
IN_STORE	این رویداد از یک تراکنش درون فروشگاهی ایجاد شده است.
PHONE	این رویداد از یک تماس تلفنی ایجاد شد.
OTHER	این رویداد از منابع دیگر تولید شده است.

میدان تجربی

میدان تجربی که نمایانگر میدان‌های غیررسمی است.

فیلدها
field	string اختیاری. نام فیلدی که قرار است استفاده شود.
value	string اختیاری. مقداری که فیلد باید تنظیم کند.

اطلاعات کلید عمومی (GcpWrappedKeyInfo)

اطلاعات مربوط به کلید پیچیده‌شده در پلتفرم ابری گوگل.

فیلدها
key_type	KeyType الزامی. نوع الگوریتم مورد استفاده برای رمزگذاری داده‌ها.
wip_provider	string الزامی. ارائه‌دهنده‌ی استخر هویت بار کاری (Workload Identity Pool) ملزم به استفاده از KEK است.
kek_uri	string الزامی. شناسه منبع سرویس مدیریت کلید ابری پلتفرم گوگل کلود. باید به فرمت projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} یا gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}
encrypted_dek	string الزامی. کلید رمزگذاری داده‌های رمزگذاری شده با کد base64.

نوع کلید

نوع الگوریتمی که برای رمزگذاری داده‌ها استفاده می‌شود.

انوم‌ها
KEY_TYPE_UNSPECIFIED	نوع کلید نامشخص. هرگز نباید استفاده شود.
XCHACHA20_POLY1305	الگوریتم XChaCha20-Poly1305

جنسیت

نوع جنسیت‌های جمعیتی (مثلاً زن).

انوم‌ها
GENDER_UNSPECIFIED	مشخص نشده است.
GENDER_UNKNOWN	ناشناخته.
GENDER_MALE	مرد.
GENDER_FEMALE	زن

GetUserListDirectLicenseRequest

درخواست دریافت منبع UserListDirectLicense .

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
name	string الزامی. نام منبع مجوز مستقیم فهرست کاربران.

GetUserListGlobalLicenseRequest

درخواست دریافت منبع UserListGlobalLicense .

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
name	string الزامی. نام منبعِ مجوز سراسریِ فهرست کاربران.

درخواست دریافت لیست کاربران

درخواست پیام برای GetUserList.

می‌توانید این روش را در کاوشگر REST APIs امتحان کنید:

با REST امتحانش کن

فیلدها
name	string الزامی. نام منبع فهرست کاربری که قرار است بازیابی شود. قالب: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

درخواست اعضا برای دریافت اطلاعات مخاطبان

درخواست آپلود اعضای مخاطب به مقصدهای ارائه شده. یک IngestAudienceMembersResponse برمی‌گرداند.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
destinations[]	Destination Required. The list of destinations to send the audience members to.
audience_members[]	AudienceMember Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.
consent	Consent Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember .
validate_only	bool Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.
encoding	Encoding Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.
encryption_info	EncryptionInfo Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.
terms_of_service	TermsOfService Optional. The terms of service that the user has accepted/rejected.

IngestAudienceMembersResponse

Response from the IngestAudienceMembersRequest .

فیلدها
request_id	string The auto-generated ID of the request.

IngestEventsRequest

Request to upload audience members to the provided destinations. Returns an IngestEventsResponse .

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
destinations[]	Destination Required. The list of destinations to send the events to.
events[]	Event Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.
consent	Consent Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each Event .
validate_only	bool Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.
encoding	Encoding Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.
encryption_info	EncryptionInfo Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

IngestEventsResponse

Response from the IngestEventsRequest .

فیلدها
request_id	string The auto-generated ID of the request.

IngestedUserListInfo

Represents a user list that is populated by user provided data.

فیلدها
upload_key_types[]	UploadKeyType Required. Immutable. Upload key types of this user list.
contact_id_info	ContactIdInfo Optional. Additional information when CONTACT_ID is one of the upload_key_types .
mobile_id_info	MobileIdInfo Optional. Additional information when MOBILE_ID is one of the upload_key_types .
user_id_info	UserIdInfo Optional. Additional information when USER_ID is one of the upload_key_types .
pair_id_info	PairIdInfo Optional. Additional information when PAIR_ID is one of the upload_key_types . This feature is only available to data partners.
pseudonymous_id_info	PseudonymousIdInfo Optional. Additional information for PSEUDONYMOUS_ID is one of the upload_key_types .
partner_audience_info	PartnerAudienceInfo Optional. Additional information for partner audiences. This feature is only available to data partners.

UploadKeyType

Enum containing the possible upload key types of a user list.

انوم‌ها
UPLOAD_KEY_TYPE_UNSPECIFIED	مشخص نشده است.
CONTACT_ID	Customer info such as email address, phone number or physical address.
MOBILE_ID	Mobile advertising ids.
USER_ID	Third party provided user ids.
PAIR_ID	Publisher advertiser identity reconciliation ids.
PSEUDONYMOUS_ID	Data Management Platform IDs: - Google User ID - Partner Provided ID - Publisher Provided ID - iOS IDFA - Android advertising ID - Roku ID - Amazon Fire TV ID - Xbox or Microsoft ID

مورد

Represents an item in the cart associated with the event.

فیلدها
merchant_product_id	string Optional. The product ID within the Merchant Center account.
quantity	int64 Optional. The number of this item associated with the event.
unit_price	double Optional. The unit price excluding tax, shipping, and any transaction level discounts.
item_id	string Optional. A unique identifier to reference the item.
additional_item_parameters[]	ItemParameter Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

ItemParameter

A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

فیلدها
parameter_name	string Required. The name of the parameter to use.
value	string Required. The string representation of the value of the parameter to set.

ListUserListDirectLicensesRequest

Request to list all UserListDirectLicense resources for a given account.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
parent	string Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter	string Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported Operations: AND = != > >= < <= Unsupported Fields: name (use get method instead) historical_pricings and all its subfields pricing.start_time pricing.end_time
page_size	int32 Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

ListUserListDirectLicensesResponse

Response from the ListUserListDirectLicensesRequest .

فیلدها
user_list_direct_licenses[]	UserListDirectLicense The licenses for the given user list in the request.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListUserListGlobalLicenseCustomerInfosRequest

Request to list all UserListGlobalLicenseCustomerInfo resources for a given user list global license.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
parent	string Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID} . To list all global license customer info under an account, replace the user list global license id with a '-' (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/- )
filter	string Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported Operations: AND = != > >= < <= Unsupported Fields: name (use get method instead) historical_pricings and all its subfields pricing.start_time pricing.end_time
page_size	int32 Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

ListUserListGlobalLicenseCustomerInfosResponse

Response from the [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].

فیلدها
user_list_global_license_customer_infos[]	UserListGlobalLicenseCustomerInfo The customer information for the given license in the request.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListUserListGlobalLicensesRequest

Request to list all UserListGlobalLicense resources for a given account.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
parent	string Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}
filter	string Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. Supported Operations: AND = != > >= < <= Unsupported Fields: name (use get method instead) historical_pricings and all its subfields pricing.start_time pricing.end_time
page_size	int32 Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserListGlobalLicense call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

ListUserListGlobalLicensesResponse

Response from the ListUserListGlobalLicensesRequest .

فیلدها
user_list_global_licenses[]	UserListGlobalLicense The licenses for the given user list in the request.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListUserListsRequest

Request message for ListUserLists.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
parent	string Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}
page_size	int32 Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token	string Optional. A page token, received from a previous ListUserLists call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserLists must match the call that provided the page token.
filter	string Optional. A filter string . All fields need to be on the left hand side of each condition (for example: display_name = "list 1" ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. عملیات پشتیبانی شده: AND = != > >= < <= : (has) Supported fields: id display_name description membership_status integration_code access_reason ingested_user_list_info.upload_key_types

ListUserListsResponse

Response message for ListUserLists.

فیلدها
user_lists[]	UserList The user lists from the specified account.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

MatchRateRange

The match rate range of the upload or userlist.

انوم‌ها
MATCH_RATE_RANGE_UNKNOWN	The match rate range is unknown.
MATCH_RATE_RANGE_NOT_ELIGIBLE	The match rate range is not eligible.
MATCH_RATE_RANGE_LESS_THAN_20	The match rate range is less than 20% (in the interval [0, 20) ).
MATCH_RATE_RANGE_20_TO_30	The match rate range is between 20% and 30% (in the interval [20, 31) ).
MATCH_RATE_RANGE_31_TO_40	The match rate range is between 31% and 40% (in the interval [31, 41) ).
MATCH_RATE_RANGE_41_TO_50	The match rate range is between 41% and 50% (in the interval [41, 51) ).
MATCH_RATE_RANGE_51_TO_60	The match rate range is between 51% and 60% (in the interval [51, 61) .
MATCH_RATE_RANGE_61_TO_70	The match rate range is between 61% and 70% (in the interval [61, 71) ).
MATCH_RATE_RANGE_71_TO_80	The match rate range is between 71% and 80% (in the interval [71, 81) ).
MATCH_RATE_RANGE_81_TO_90	The match rate range is between 81% and 90% (in the interval [81, 91) ).
MATCH_RATE_RANGE_91_TO_100	The match rate range is between 91% and 100% (in the interval [91, 100] ).

MobileData

Mobile IDs for the audience. At least one mobile ID is required.

فیلدها
mobile_ids[]	string Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 mobileIds can be provided in a single AudienceMember .

MobileIdInfo

Additional information when MOBILE_ID is one of the upload_key_types .

فیلدها
data_source_type	DataSourceType Optional. Immutable. Source of the upload data.
key_space	KeySpace Required. Immutable. The key space of mobile IDs.
app_id	string Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.

KeySpace

Key space for mobile ID.

انوم‌ها
KEY_SPACE_UNSPECIFIED	مشخص نشده است.
IOS	The iOS keyspace.
ANDROID	The Android keyspace.

PairData

PAIR IDs for the audience. At least one PAIR ID is required.

This feature is only available to data partners.

فیلدها
pair_ids[]	string Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the PAIR user list. At most 10 pairIds can be provided in a single AudienceMember .

PairIdInfo

Additional information when PAIR_ID is one of the upload_key_types .

This feature is only available to data partners.

فیلدها
publisher_id	int64 Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
publisher_name	string Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
match_rate_percentage	int32 Required. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
advertiser_identifier_count	int64 Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
clean_room_identifier	string Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.

PartnerAudienceInfo

Additional information for partner audiences.

This feature is only available to data partners.

فیلدها
partner_audience_source	PartnerAudienceSource Required. Immutable. The source of the partner audience.
commerce_partner	string Optional. The commerce partner name. Only allowed if partner_audience_source is COMMERCE_AUDIENCE .

PartnerAudienceSource

Partner audience source.

انوم‌ها
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED	مشخص نشده است.
COMMERCE_AUDIENCE	Partner Audience source is commerce audience.
LINEAR_TV_AUDIENCE	Partner Audience source is linear TV audience.
AGENCY_PROVIDER_AUDIENCE	Partner Audience source is agency/provider audience.

PartnerLink

A partner link between an owning account and a partner account.

فیلدها
name	string Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}
partner_link_id	string Output only. The partner link ID.
owning_account	ProductAccount Required. The owning account granting access to the partner account.
partner_account	ProductAccount Required. The partner account granted access by the owning account.

PpidData

Publisher provided identifiers data holding the ppids. At least one ppid is required.

This feature is only available to data partners.

فیلدها
ppids[]	string Required. The list of publisher provided identifiers for a user.

ProcessingErrorReason

The processing error reason.

انوم‌ها
PROCESSING_ERROR_REASON_UNSPECIFIED	The processing error reason is unknown.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE	The custom variable is invalid.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED	The status of the custom variable is not enabled.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD	The conversion is older than max supported age.
PROCESSING_ERROR_REASON_DENIED_CONSENT	The ad user data is denied, either by the user or in the advertiser default settings.
PROCESSING_ERROR_REASON_NO_CONSENT	Advertiser did not give 3P consent for the Ads core platform services.
PROCESSING_ERROR_REASON_UNKNOWN_CONSENT	The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user
PROCESSING_ERROR_REASON_DUPLICATE_GCLID	A conversion with the same GCLID and conversion time already exists in the system.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID	A conversion with the same order id and conversion action combination was already uploaded.
PROCESSING_ERROR_REASON_INVALID_GBRAID	The gbraid could not be decoded.
PROCESSING_ERROR_REASON_INVALID_GCLID	The google click ID could not be decoded.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID	Merchant id contains non-digit characters.
PROCESSING_ERROR_REASON_INVALID_WBRAID	The wbraid could not be decoded.
PROCESSING_ERROR_REASON_INTERNAL_ERROR	Internal error.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED	Enhanced conversions terms are not signed in the destination account.
PROCESSING_ERROR_REASON_INVALID_EVENT	The event is invalid.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS	The matched transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS	The transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INVALID_FORMAT	The event has format error.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR	The event has a decryption error.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR	The DEK failed to be decrypted.
PROCESSING_ERROR_REASON_INVALID_WIP	The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_ERROR_REASON_INVALID_KEK	The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED	The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED	The system did not have the permissions needed to access the KEK.
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED	The system failed to authenticate with AWS.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR	Failed to decrypt the UserIdentifier data using the DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER	The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.

ProcessingWarningReason

The processing warning reason.

انوم‌ها
PROCESSING_WARNING_REASON_UNSPECIFIED	The processing warning reason is unknown.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED	The system did not have the permissions needed to access the KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR	The DEK failed to be decrypted.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR	The event has a decryption error.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED	The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_WARNING_REASON_INVALID_WIP	The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_WARNING_REASON_INVALID_KEK	The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR	Failed to decrypt th UserIdentifier data using the DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR	Internal error.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED	The system failed to authenticate with AWS.

محصول

This item is deprecated!

Deprecated. Use AccountType instead. Represents a specific Google product.

انوم‌ها
PRODUCT_UNSPECIFIED	Unspecified product. Should never be used.
GOOGLE_ADS	Google Ads.
DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
DATA_PARTNER	Data Partner.

ProductAccount

Represents a specific account.

فیلدها
product (deprecated)	Product This item is deprecated! Deprecated. Use account_type instead.
account_id	string Required. The ID of the account. For example, your Google Ads account ID.
account_type	AccountType Optional. The type of the account. For example, GOOGLE_ADS . Either account_type or the deprecated product is required. If both are set, the values must match.

AccountType

Represents Google account types. Used to locate accounts and destinations.

انوم‌ها
ACCOUNT_TYPE_UNSPECIFIED	Unspecified product. Should never be used.
GOOGLE_ADS	Google Ads.
DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
DATA_PARTNER	Data Partner.
GOOGLE_ANALYTICS_PROPERTY	Google Analytics.
GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google Ad Manager audience link.

PseudonymousIdInfo

Additional information when PSEUDONYMOUS_ID is one of the upload_key_types .

فیلدها
sync_status	SyncStatus Output only. Sync status of the user list.
billable_record_count	int64 Optional. Immutable. The number of billable records (eg uploaded or matched).

SyncStatus

Sync status of the user list.

انوم‌ها
SYNC_STATUS_UNSPECIFIED	مشخص نشده است.
CREATED	The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use.
READY_FOR_USE	The user list is ready for use. Contents and cookies have been synced correctly.
FAILED	An error has occurred syncing user list contents and/or metadata. The user list cannot be used.

RemoveAudienceMembersRequest

Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse .

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
destinations[]	Destination Required. The list of destinations to remove the users from.
audience_members[]	AudienceMember Required. The list of users to remove.
validate_only	bool Optional. For testing purposes. If true , the request is validated but not executed. Only errors are returned, not results.
encoding	Encoding Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non UserData uploads, this field is ignored.
encryption_info	EncryptionInfo Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

RemoveAudienceMembersResponse

Response from the RemoveAudienceMembersRequest .

فیلدها
request_id	string The auto-generated ID of the request.

RequestStatusPerDestination

A request status per destination.

فیلدها
destination	Destination A destination within a DM API request.
request_status	RequestStatus The request status of the destination.
error_info	ErrorInfo An error info error containing the error reason and error counts related to the upload.
warning_info	WarningInfo A warning info containing the warning reason and warning counts related to the upload.
Union field status . The status of the destination. status can be only one of the following:
audience_members_ingestion_status	IngestAudienceMembersStatus The status of the ingest audience members request.
events_ingestion_status	IngestEventsStatus The status of the ingest events request.
audience_members_removal_status	RemoveAudienceMembersStatus The status of the remove audience members request.

IngestAudienceMembersStatus

The status of the ingest audience members request.

فیلدها
Union field status . The status of the audience members ingestion to the destination. status can be only one of the following:
user_data_ingestion_status	IngestUserDataStatus The status of the user data ingestion to the destination.
mobile_data_ingestion_status	IngestMobileDataStatus The status of the mobile data ingestion to the destination.
pair_data_ingestion_status	IngestPairDataStatus The status of the pair data ingestion to the destination.
user_id_data_ingestion_status	IngestUserIdDataStatus The status of the user id data ingestion to the destination.
ppid_data_ingestion_status	IngestPpidDataStatus The status of the ppid data ingestion to the destination.

IngestEventsStatus

The status of the events ingestion to the destination.

فیلدها
record_count	int64 The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not.

IngestMobileDataStatus

The status of the mobile data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
mobile_id_count	int64 The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not.

IngestPairDataStatus

The status of the pair data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
pair_id_count	int64 The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not.

IngestPpidDataStatus

The status of the ppid data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
ppid_count	int64 The total count of ppids sent in the upload request for the destination. Includes all ppids in the request, regardless of whether they were successfully ingested or not.

IngestUserDataStatus

The status of the user data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
user_identifier_count	int64 The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not.
upload_match_rate_range	MatchRateRange The match rate range of the upload.

IngestUserIdDataStatus

The status of the user id data ingestion to the destination containing stats related to the ingestion.

فیلدها
record_count	int64 The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
user_id_count	int64 The total count of user ids sent in the upload request for the destination. Includes all user ids in the request, regardless of whether they were successfully ingested or not.

RemoveAudienceMembersStatus

The status of the remove audience members request.

فیلدها
Union field status . The status of the audience members removal from the destination. status can be only one of the following:
user_data_removal_status	RemoveUserDataStatus The status of the user data removal from the destination.
mobile_data_removal_status	RemoveMobileDataStatus The status of the mobile data removal from the destination.
pair_data_removal_status	RemovePairDataStatus The status of the pair data removal from the destination.
user_id_data_removal_status	RemoveUserIdDataStatus The status of the user id data removal from the destination.
ppid_data_removal_status	RemovePpidDataStatus The status of the ppid data removal from the destination.

RemoveMobileDataStatus

The status of the mobile data removal from the destination.

فیلدها
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
mobile_id_count	int64 The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not.

RemovePairDataStatus

The status of the pair data removal from the destination.

فیلدها
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
pair_id_count	int64 The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not.

RemovePpidDataStatus

The status of the ppid data removal from the destination.

فیلدها
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
ppid_count	int64 The total count of ppids sent in the removal request. Includes all ppids in the request, regardless of whether they were successfully removed or not.

RemoveUserDataStatus

The status of the user data removal from the destination.

فیلدها
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
user_identifier_count	int64 The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not.

RemoveUserIdDataStatus

The status of the user id data removal from the destination.

فیلدها
record_count	int64 The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
user_id_count	int64 The total count of user ids sent in the removal request. Includes all user ids in the request, regardless of whether they were successfully removed or not.

RequestStatus

The request status.

انوم‌ها
REQUEST_STATUS_UNKNOWN	The request status is unknown.
SUCCESS	The request succeeded.
PROCESSING	The request is processing.
FAILED	The request failed.
PARTIAL_SUCCESS	The request partially succeeded.

RetrieveInsightsRequest

Request message for DM API MarketingDataInsightsService.RetrieveInsights

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
parent	string Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}
baseline	Baseline Required. Baseline for the insights requested.
user_list_id	string Required. The user list ID for which insights are requested.

RetrieveInsightsResponse

Response message for DM API MarketingDataInsightsService.RetrieveInsights

فیلدها
marketing_data_insights[]	MarketingDataInsight Contains the insights for the marketing data.

MarketingDataInsight

Insights for marketing data.

This feature is only available to data partners.

فیلدها
dimension	AudienceInsightsDimension The dimension to which the insight belongs.
attributes[]	MarketingDataInsightsAttribute Insights for values of a given dimension.

AudienceInsightsDimension

Possible dimensions for use in generating insights.

انوم‌ها
AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED	مشخص نشده است.
AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN	مقدار در این نسخه ناشناخته است.
AFFINITY_USER_INTEREST	An Affinity UserInterest.
IN_MARKET_USER_INTEREST	An In-Market UserInterest.
AGE_RANGE	An age range.
GENDER	A gender.

MarketingDataInsightsAttribute

Insights for a collection of related attributes of the same dimension.

فیلدها
user_interest_id	int64 The user interest ID.
lift	float Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].
age_range	AgeRange Age range of the audience for which the lift is provided.
gender	Gender Gender of the audience for which the lift is provided.

RetrieveRequestStatusRequest

Request to get the status of request made to the DM API for a given request ID. Returns a RetrieveRequestStatusResponse .

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
request_id	string Required. Required. The request ID of the Data Manager API request.

RetrieveRequestStatusResponse

Response from the RetrieveRequestStatusRequest .

فیلدها
request_status_per_destination[]	RequestStatusPerDestination A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.

SearchPartnerLinksRequest

Request to search for PartnerLink resources. Returns a SearchPartnerLinksResponse .

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
parent	string Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned. Format: accountTypes/{account_type}/accounts/{account}
page_size	int32 The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token	string A page token, received from a previous SearchPartnerLinks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.
filter	string Optional. A filter string . All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789 ). Fields must be specified using either all camel case or all snake case . Don't use a combination of camel case and snake case. عملیات پشتیبانی شده: AND = != Supported fields: partner_link_id owning_account.account_type owning_account.account_id partner_account.account_type partner_account.account_id Example: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

SearchPartnerLinksResponse

Response from the SearchPartnerLinksRequest .

فیلدها
partner_links[]	PartnerLink The partner links for the given account.
next_page_token	string A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

SizeInfo

Estimated number of members in this user list in different target networks.

فیلدها
display_network_members_count	int64 Output only. Estimated number of members in this user list, on the Google Display Network.
search_network_members_count	int64 Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.

TargetNetworkInfo

Eligibility information for different target networks.

فیلدها
eligible_for_display	bool Output only. Indicates this user list is eligible for Google Display Network.
eligible_for_search	bool Optional. Indicates if this user list is eligible for Google Search Network.

TermsOfService

The terms of service that the user has accepted/rejected.

فیلدها
customer_match_terms_of_service_status	TermsOfServiceStatus Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717 . This must be accepted when ingesting UserData or MobileData . This field is not required for Partner Match User list.

TermsOfServiceStatus

Represents the caller's decision to accept or reject the terms of service.

انوم‌ها
TERMS_OF_SERVICE_STATUS_UNSPECIFIED	مشخص نشده است.
ACCEPTED	Status indicating the caller has chosen to accept the terms of service.
REJECTED	Status indicating the caller has chosen to reject the terms of service.

UpdateUserListDirectLicenseRequest

Request to update a UserListDirectLicense resource.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
user_list_direct_license	UserListDirectLicense Required. The licenses' name field is used to identify the license to update.
update_mask	FieldMask Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

UpdateUserListGlobalLicenseRequest

Request to update a UserListGlobalLicense resource.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
user_list_global_license	UserListGlobalLicense Required. The licenses' name field is used to identify the license to update.
update_mask	FieldMask Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

UpdateUserListRequest

Request message for UpdateUserList.

You can try this method in the REST APIs explorer:

Try it with REST

فیلدها
user_list	UserList Required. The user list to update. The user list's name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
update_mask	FieldMask Optional. The list of fields to update.
validate_only	bool Optional. If true, the request is validated but not executed.

UserData

Data that identifies the user. At least one identifier is required.

فیلدها
user_identifiers[]	UserIdentifier Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 userIdentifiers can be provided in a single AudienceMember or Event .

UserIdData

User id data holding the user id.

فیلدها
user_id	string Required. A unique identifier for a user, as defined by the advertiser.

UserIdInfo

Additional information when USER_ID is one of the upload_key_types .

فیلدها
data_source_type	DataSourceType Optional. Immutable. Source of the upload data.

UserIdentifier

A single identifier for the user.

فیلدها
Union field identifier . Exactly one must be specified. identifier can be only one of the following:
email_address	string Hashed email address using SHA-256 hash function after normalization.
phone_number	string Hashed phone number using SHA-256 hash function after normalization (E164 standard).
address	AddressInfo The known components of a user's address. Holds a grouping of identifiers that are matched all at once.

UserList

A user list resource.

فیلدها
name	string Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}
id	int64 Output only. The unique ID of the user list.
read_only	bool Output only. An option that indicates if a user may edit a list.
membership_duration	Duration Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.
access_reason	AccessReason Output only. The reason this account has been granted access to the list.
size_info	SizeInfo Output only. Estimated number of members in this user list in different target networks.
target_network_info	TargetNetworkInfo Optional. Eligibility information for different target networks.
display_name	string Required. The display name of the user list.
description	string Optional. A description of the user list.
membership_status	MembershipStatus Optional. Membership status of this user list.
integration_code	string Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.
closing_reason	ClosingReason Output only. The reason why this user list membership status is closed.
account_access_status	AccessStatus Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to ENABLED . Later the user list owner can decide to revoke the share and make it DISABLED .
Union field user_list_info . Additional information about the user list. user_list_info can be only one of the following:
ingested_user_list_info	IngestedUserListInfo Optional. Represents a user list that is populated by user ingested data.

AccessReason

Enum describing possible access reasons.

انوم‌ها
ACCESS_REASON_UNSPECIFIED	مشخص نشده است.
OWNED	The resource is owned by the user.
SHARED	The resource is shared to the user.
LICENSED	The resource is licensed to the user.
SUBSCRIBED	The user subscribed to the resource.
AFFILIATED	The resource is accessible to the user.

AccessStatus

Indicates if this client still has access to the list.

انوم‌ها
ACCESS_STATUS_UNSPECIFIED	مشخص نشده است.
ENABLED	The access is enabled.
DISABLED	The access is disabled.

ClosingReason

Indicates the reason why the user list was closed. This enum is only used when a list is auto-closed by the system.

انوم‌ها
CLOSING_REASON_UNSPECIFIED	مشخص نشده است.
UNUSED	The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details.

MembershipStatus

Status of the user list.

انوم‌ها
MEMBERSHIP_STATUS_UNSPECIFIED	مشخص نشده است.
OPEN	Open status - User list is accruing members and can be targeted to.
CLOSED	Closed status - No new members being added.

UserListDirectLicense

A user list direct license.

This feature is only available to data partners.

فیلدها
name	string Identifier. The resource name of the user list direct license.
user_list_display_name	string Output only. Name of the user list being licensed. This field is read-only.
client_account_display_name	string Output only. Name of client customer which the user list is being licensed to. This field is read-only.
pricing	UserListLicensePricing Optional. UserListDirectLicense pricing.
historical_pricings[]	UserListLicensePricing Output only. Pricing history of this user list license. This field is read-only.
metrics	UserListLicenseMetrics Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call
user_list_id	int64 Immutable. ID of the user list being licensed.
client_account_type	UserListLicenseClientAccountType Immutable. Account type of client customer which the user list is being licensed to.
client_account_id	int64 Immutable. ID of client customer which the user list is being licensed to.
status	UserListLicenseStatus Optional. Status of UserListDirectLicense - ENABLED or DISABLED.

UserListGlobalLicense

A user list global license.

This feature is only available to data partners.

فیلدها
name	string Identifier. The resource name of the user list global license.
user_list_display_name	string Output only. Name of the user list being licensed. This field is read-only.
pricing	UserListLicensePricing Optional. UserListGlobalLicense pricing.
historical_pricings[]	UserListLicensePricing Output only. Pricing history of this user list license. This field is read-only.
metrics	UserListLicenseMetrics Output only. Metrics related to this license This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call
user_list_id	int64 Immutable. ID of the user list being licensed.
license_type	UserListGlobalLicenseType Immutable. Product type of client customer which the user list is being licensed to.
status	UserListLicenseStatus Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.

UserListGlobalLicenseCustomerInfo

Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license.

فیلدها
name	string Identifier. The resource name of the user list global license customer.
user_list_id	int64 Output only. ID of the user list being licensed.
user_list_display_name	string Output only. Name of the user list being licensed.
license_type	UserListGlobalLicenseType Output only. Product type of client customer which the user list is being licensed to.
status	UserListLicenseStatus Output only. Status of UserListDirectLicense - ENABLED or DISABLED.
pricing	UserListLicensePricing Output only. UserListDirectLicense pricing.
client_account_type	UserListLicenseClientAccountType Output only. Product type of client customer which the user list is being licensed to.
client_account_id	int64 Output only. ID of client customer which the user list is being licensed to.
client_account_display_name	string Output only. Name of client customer which the user list is being licensed to.
historical_pricings[]	UserListLicensePricing Output only. Pricing history of this user list license.
metrics	UserListLicenseMetrics Output only. Metrics related to this license This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.

UserListGlobalLicenseType

User list global license types.

انوم‌ها
USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED	UNSPECIFIED.
USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER	Reseller license.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE	DataMart Sell Side license.
USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE	DataMart Buy Side license.

UserListLicenseClientAccountType

Possible product of a client account for a user list license.

انوم‌ها
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN	ناشناخته.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS	Google Ads customer.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER	Display & Video 360 partner.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER	Display & Video 360 advertiser.
USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK	Google Ad Manager audience link.

UserListLicenseMetrics

Metrics related to a user list license.

فیلدها
click_count	int64 Output only. The number of clicks for the user list license.
impression_count	int64 Output only. The number of impressions for the user list license.
revenue_usd_micros	int64 Output only. The revenue for the user list license in USD micros.
start_date	int64 Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If end_date is used in the filter, start_date is also required. If neither start_date nor end_date are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.
end_date	int64 Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If start_date is used in the filter, end_date is also required. If neither start_date nor end_date are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.

UserListLicensePricing

A user list license pricing.

فیلدها
pricing_id	int64 Output only. The ID of this pricing.
start_time	Timestamp Output only. Start time of the pricing.
end_time	Timestamp Optional. End time of the pricing.
pricing_active	bool Output only. Whether this pricing is active.
buyer_approval_state	UserListPricingBuyerApprovalState Output only. The buyer approval state of this pricing. This field is read-only.
cost_micros	int64 Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD .
currency_code	string Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.
cost_type	UserListPricingCostType Immutable. The cost type of this pricing. Can be set only in the create operation. Can't be updated for an existing license.
max_cost_micros	int64 Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD . This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to 0 , there is no cap.

UserListPricingBuyerApprovalState

User list pricing buyer approval state.

انوم‌ها
USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED	UNSPECIFIED.
PENDING	User list client has not yet accepted the pricing terms set by the user list owner.
APPROVED	User list client has accepted the pricing terms set by the user list owner.
REJECTED	User list client has rejected the pricing terms set by the user list owner.

UserListPricingCostType

User list pricing cost type.

انوم‌ها
USER_LIST_PRICING_COST_TYPE_UNSPECIFIED	Unspecified.
CPC	Cost per click.
CPM	Cost per mille (thousand impressions).
MEDIA_SHARE	Media share.

UserListLicenseStatus

User list license status.

انوم‌ها
USER_LIST_LICENSE_STATUS_UNSPECIFIED	ناشناخته.
USER_LIST_LICENSE_STATUS_ENABLED	Active status - user list is still being licensed.
USER_LIST_LICENSE_STATUS_DISABLED	Inactive status - user list is no longer being licensed.

UserProperties

Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.

فیلدها
customer_type	CustomerType Optional. Type of the customer associated with the event.
customer_value_bucket	CustomerValueBucket Optional. The advertiser-assessed value of the customer.
additional_user_properties[]	UserProperty Optional. A bucket of any additional user properties for the user associated with this event.

UserProperty

A bucket of any additional user properties for the user associated with this event.

فیلدها
property_name	string Required. The name of the user property to use.
value	string Required. The string representation of the value of the user property to use.

WarningCount

The warning count for a given warning reason.

فیلدها
record_count	int64 The count of records that have a warning.
reason	ProcessingWarningReason The warning reason.

WarningInfo

Warning counts for each type of warning.

فیلدها
warning_counts[]	WarningCount A list of warnings and counts per warning reason.