REST Resource: projects.locations.consumerEnforcementActions

משאב: ConsumerEnforcementAction

מייצג פעולה ששותף ביצע כדי לאכוף את הסכם הספק של השותף.

ייצוג JSON
{
  "name": string,
  "uid": string,
  "etag": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "succeedTime": string,
  "displayName": string,
  "labels": {
    string: string,
    ...
  },
  "consumerScope": {
    object (ConsumerScope)
  },
  "productScope": {
    object (ProductScope)
  },
  "denyReason": {
    object (DenyReason)
  },

  // Union field action can be only one of the following:
  "projectAccessRestrictionAction": {
    object (ProjectAccessRestrictionConfig)
  }
  // End of list of possible types for union field action.
}
שדות
name

string

מזהה. השם של משאב ConsumerEnforcementAction.

פורמט: projects/{project}/locations/{location}/consumerEnforcementActions/{consumerEnforcementAction}

uid

string

פלט בלבד. המזהה הייחודי של המשאב.

etag

string

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

state

enum (State)

פלט בלבד. מצב מחזור החיים הנוכחי של המשאב.

createTime

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".

updateTime

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".

succeedTime

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".

displayName

string

זה שינוי אופציונלי. השם המוצג של המשאב, בפורמט שקריא לבני אדם. האורך המרבי הוא 63 תווים.

labels

map (key: string, value: string)

זה שינוי אופציונלי. תוויות שהוגדרו על ידי המשתמש למשאב.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

consumerScope

object (ConsumerScope)

חובה. אי אפשר לשנות. היקף הצרכנים של פעולת האכיפה.

productScope

object (ProductScope)

חובה. אי אפשר לשנות. היקף המוצרים של פעולת האכיפה.

denyReason

object (DenyReason)

פלט בלבד. הסיבה לדחייה. הערך הזה מוצג כשמצב המשאב הוא DENIED.

שדה איחוד action. חובה. פעולת האכיפה שהוגדרה. הערך action יכול להיות רק אחד מהבאים:
projectAccessRestrictionAction

object (ProjectAccessRestrictionConfig)

זה שינוי אופציונלי. אי אפשר לשנות. הגבלת הגישה למוצרים בפרויקטים לצרכנים.

ProjectAccessRestrictionConfig

הגדרה של הגבלת גישה שחלה על פרויקטים לצרכנים.

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

ייצוג JSON
{
  "falsePositiveGuardDisabled": boolean
}
שדות
falsePositiveGuardDisabled

boolean

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

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

מדינה

מייצג את המצב של מחזור החיים של פעולת האכיפה.

יכול להיות שבעתיד יתווספו ערכים חדשים ל-enum הזה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב לא מוגדר. לא בשימוש.
RUNNING

פעולת האכיפה מתבצעת. זהו המצב ההתחלתי של המשאב, והוא נשאר כזה בזמן שהפעולה הממושכת consumerEnforcementActions.create פועלת.

אם הפעולה תבוטל או תסתיים לפני שיתרחשו השפעות אכיפה כלשהן, המשאב יוסר. אחרת, כשהפעולה תסתיים, מצב המשאב יהיה אחד מהמצבים הבאים.

  • אם פעולת האכיפה תתקבל ותוחל בהצלחה, בסיום המצב ישתנה ל-SUCCEEDED.
  • אם פעולת האכיפה נדחית, לאחר השלמתה המצב ישתנה לDENIED.
  • אם פעולת האכיפה נכשלת אחרי הפעלה חלקית של אפקטים של אכיפה, המצב ישתנה ל-FAILED כדי לשקף את מצב האכיפה החלקי הלא עקבי.
SUCCEEDED פעולת האכיפה התקבלה והוחלה בהצלחה. כל ההשפעות המתמשכות של פעולת האכיפה פעילות.
DENIED הפעולה לא התקבלה ולא נכנסה לתוקף מהסיבה שמפורטת בקטע denyReason.
FAILED מעבר מצב נכשל בגלל שגיאה זמנית או שגיאה פנימית במערכת. יכול להיות שההתנהגות של האכיפה לא תהיה עקבית. מחיקה של משאב במצב הזה תסיר את כל ההשפעות המתמשכות.

ConsumerScope

מציין את ישות משאב הצרכן שאליה מכוונת פעולת האכיפה.

ייצוג JSON
{

  // Union field target_consumer_entity can be only one of the following:
  "project": string,
  "billingAccount": string,
  "organization": string
  // End of list of possible types for union field target_consumer_entity.
}
שדות
שדה איחוד target_consumer_entity. חובה. חובה להגדיר בדיוק מזהה אחד של משאב יעד. הערך target_consumer_entity יכול להיות רק אחד מהבאים:
project

string

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

המשתמש חייב להיות קיים בזמן יצירת פעולת האכיפה. חובה לציין את מספר הפרויקט בפורמט project_number.

פורמט: projects/{project_number}

billingAccount

string

מטרגט משאב של חשבון לחיוב. היקף פעולת האכיפה כולל את החשבון לחיוב ואת כל הפרויקטים שמקושרים אליו.

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

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

פורמט: billingAccounts/{billingAccount}

organization

string

מטרגט משאב ארגון. היקף פעולת האכיפה כולל את כל הפרויקטים בארגון, את כל החשבונות לחיוב בארגון ואת כל הפרויקטים שמקושרים לחשבונות האלה לחיוב.

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

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

פורמט: organizations/{organization}

ProductScope

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

ייצוג JSON
{
  "aiplatformPublisherId": string
}
שדות
aiplatformPublisherId

string

זה שינוי אופציונלי. מטרגט את כל המוצרים המנוהלים של מודלים ב-AI Platform Model Garden שמשויכים למזהה בעל אפליקציה שצוין.

ב-AI Platform Model Garden, המזהה publisher_id מציין את מפרסם המודל. לשותפים עם מוצרים שזמינים ב-Model Garden מוקצה מזהה בעל אפליקציה ייחודי בזמן ההצטרפות הראשונית. אפשר לציין רק את מזהה בעל האפליקציה של השותף. אם אינכם יודעים מהו מזהה בעל האפליקציה, פנו לתמיכה בשותפים לקבלת עזרה.

פורמט: {publisher_id} (לדוגמה, google).

DenyReason

הסבר למה לא בוצעה פעולת אכיפה.

ייצוג JSON
{
  "reasonCode": enum (ReasonCode),
  "detailMessage": string
}
שדות
reasonCode

enum (ReasonCode)

פלט בלבד. קוד הסיבה. הוא תמיד מוצג כשהאכיפה נדחית.

detailMessage

string

פלט בלבד. הודעה אופציונלית נוספת שקריאה לאנשים, שמסבירה למה נדחתה פעולת האכיפה.

ReasonCode

קוד שמציין למה Google דחתה את פעולת האכיפה.

טיפוסים בני מנייה (enum)
REASON_CODE_UNSPECIFIED סיבה לא ידועה. לא בשימוש.
EXEMPT ישות הצרכן המטרה (או ישות משנה שנמצאת נמוך יותר בהיררכיית הישויות) פטורה מהחלת פעולת האכיפה המבוקשת שהופעלה על ידי ה-API. כדי להמשיך באכיפה נגד הצרכן, צריך לפנות אל Google.
FALSE_POSITIVE_GUARD הבקשה לאכיפת פעולה נדחתה כי נדרש מצב שמירה מפני תוצאות חיוביות שגויות, והופעלה הגנה מפני תוצאות חיוביות שגויות.

Methods

create

יוצר משאב ConsumerEnforcementAction.

delete

מחיקת משאב ConsumerEnforcementAction.

get

מקבל משאב ConsumerEnforcementAction לפי שם.

list

רשימה של ConsumerEnforcementActions מתחת למיקום הורה.

patch

עדכון של משאב ConsumerEnforcementAction קיים.