הוספת דומיין לרשימת ההיתרים

בדף הזה מוסבר איך להוסיף דומיין לרשימת ההיתרים באמצעות Allowlisted Domains API.

לפני שמתחילים

• לקרוא את המאמר סקירה כללית של Allowlisted Domains API.
• מגדירים את API של דומיינים ברשימת ההיתרים.

שיקולים עיקריים

• עיצוב בלתי ניתן לשינוי: מכיוון שאי אפשר לשנות שמות דומיינים, כדי לבצע עדכונים צריך למחוק את הרשומה הקיימת וליצור רשומה חדשה.
• קצב העברת נתונים: המערכת תומכת במכסת שימוש של שאילתה אחת לשנייה (QPS) בערך, שמשותפת לכל הדומיינים של כל חשבון לקוח ייחודי.
• קיבולת: אדמינים יכולים להוסיף עד 5,000 דומיינים לכל חשבון לקוח יחיד.

הוספת דומיין לרשימת ההיתרים

משתמשים ב-create method כדי להוסיף רשומה חדשה. המוטציה הזו היא אסינכרונית ומחזירה פעולה ממושכת (LRO).

Python

def create_allowlisted_domain(service, domain_name):
  """Creates an allowlisted domain."""
  try:
    payload = {'domain': domain_name}
    response = service.allowlistedDomains().create(body=payload).execute()
    return response
  except Exception as e:
    print(f'An error occurred during create: {e}')
    return None

טיפול בשגיאות

תנאי שגיאה	קוד הסטטוס של RPC	הודעת השגיאה	פתרון בעיות / נימוק
אין הרשאה למשאב	PERMISSION_DENIED (403)	"Permission denied for allowlisted domain resource."	• מוודאים שהמשתמש קיבל את ההיקף המתאים. • מוודאים שלמשתמש יש את ההרשאה הנדרשת. • כדאי לפנות לכתובת האימייל של איש הקשר כדי לוודא שהפרויקט או המשתמש נכללים ברשימת ההיתרים.
לא נמצא מספר לקוח עבור המשתמש	NOT_FOUND (404)	"Customer ID not found for user."	המשתמש שמחובר כרגע למערכת לא מקושר לדומיין תקין.
עדכון של רשימת ההיתרים כבר מתבצע.	FAILED_PRECONDITION (400)	"An allowlist update is already in progress. Please wait for it to complete before making another request."	מחכים שהמוטציות הקודמות יושלמו.
הגעתם למגבלת הדומיינים ברשימת ההיתרים.	FAILED_PRECONDITION (400)	"Allowlisted domain limit has been reached."	הגעתם למגבלה המקסימלית של 5,000 דומיינים בחשבון הלקוח, ואי אפשר להוסיף עוד דומיינים.
שם הדומיין ריק	INVALID_ARGUMENT (400)	"Domain name cannot be empty."	כדאי לבדוק שוב את הדומיין שמועבר לבקשת היצירה. הוא לא יכול להיות ריק.
שם הדומיין לא חוקי	INVALID_ARGUMENT (400)	"Invalid domain name: <domain>."	שם הדומיין שצוין בבקשה לא תקין או שהפורמט שלו שגוי. השגיאה הזו מתרחשת בדרך כלל באחד מהתרחישים הבאים: • תחביר לא תקין: שם הדומיין לא עומד בתקני הפורמט הנדרשים. • דומיינים מוגבלים: הדומיינים הספציפיים הבאים מוגבלים ואי אפשר להוסיף אותם לרשימת ההיתרים: • aol.com • gmail.com • hotmail.com • mail.ru • outlook.com • web.de • yahoo.com • yandex.com • yandex.ru

יומני ביקורת

יצירות שנוצרות באמצעות Allowlisted Domains API יוצרות אירועים ביומן הביקורת, שאדמינים יכולים לבדוק. מידע נוסף זמין במאמר בנושא צפייה ביומני ביקורת.