Method: properties.submitUserDeletion

שליחת בקשה למחיקת משתמש בנכס.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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. המשתמש שיכול לשלוח בקשת מחיקה עבור user יכול להיות רק אחד מהבאים:
userId

string

User-ID ב-Google Analytics.
clientId

string

מזהה לקוח של Google Analytics.
appInstanceId

string

מזהה המופע של האפליקציה ב-Firebase.
userProvidedData

string

פרטים שהמשתמשים סיפקו. יכול להכיל כתובת אימייל אחת או מספר טלפון אחד.

כתובות האימייל צריכות להיות מנורמלות באופן הבא:

  • אות ראשונה קטנה בכל המילים
  • מסירים את הנקודות לפני @ בכתובות עם הסיומות gmail.com ו-googlemail.com
  • הסרת כל הרווחים

מספרי הטלפון צריכים להיות בפורמט הבא:

  • הסרת כל התווים שאינם ספרות
  • הוספה של קידומת

גוף התשובה

הודעת תגובה ל-RPC של properties.submitUserDeletion.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "deletionRequestTime": string
}
שדות
deletionRequestTime

string (Timestamp format)

מציין את הרגע שבו צריך למחוק את כל נתוני המבקרים לפני הנקודה הזו. התאריך הזה הוא התאריך שבו קיבלנו את בקשת המחיקה.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-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