Method: properties.submitUserDeletion

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

درخواست HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*}:submitUserDeletion

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
name

string

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

درخواست بدنه

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

نمایش JSON 
{

  // Union field user can be only one of the following:
  "userId": string,
  "clientId": string,
  "appInstanceId": string,
  "userProvidedData": string
  // End of list of possible types for union field user.
}
فیلدها
user فیلد Union. user که درخواست حذف را ارسال می‌کند، فقط می‌تواند یکی از موارد زیر باشد:
userId

string

شناسه کاربری گوگل آنالیتیکس.

clientId

string

شناسه مشتری گوگل آنالیتیکس.

appInstanceId

string

شناسه نمونه برنامه Firebase.

userProvidedData

string

داده‌های ارائه شده توسط کاربر . ممکن است شامل یک آدرس ایمیل یا یک شماره تلفن باشد.

آدرس‌های ایمیل باید به این صورت نرمال‌سازی شوند:

  • حروف کوچک
  • حذف نقطه قبل از @ برای آدرس‌های gmail.com/googlemail.com
  • تمام فاصله‌ها را حذف کنید

شماره تلفن‌ها باید به این صورت نرمال‌سازی شوند:

  • حذف تمام کاراکترهای غیر رقمی
  • اضافه کردن + پیشوند

بدنه پاسخ

پیام پاسخ برای properties.submitUserDeletion RPC.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "deletionRequestTime": string
}
فیلدها
deletionRequestTime

string ( Timestamp format)

لحظه‌ای را مشخص می‌کند که تمام داده‌های بازدیدکننده قبل از این نقطه باید حذف شوند. این زمان، زمانی است که درخواست حذف دریافت شده است.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

دامنه‌های مجوز

به محدوده OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/analytics.edit