Method: projects.locations.requirements.checkRequirement

בודקים דרישה מסוימת.

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}/requirements:checkRequirement

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

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

פרמטרים
location

string

חובה. השם המלא של משאב המיקום. פורמט projects/{project_number_or_id}/locations/{location}

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "requirementType": string,
  "resources": [
    {
      object (MonitoredResource)
    }
  ]
}
שדות
requirementType

string

הסוג שמציין את הדרישה לבדיקה. הסוגים הנתמכים הם:

  • discoveryengine.googleapis.com/media_recs/general/all/warning
  • discoveryengine.googleapis.com/media_recs/oyml/cvr/warning
  • discoveryengine.googleapis.com/media_recs/rfy/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mlt/cvr/warning
  • discoveryengine.googleapis.com/media_recs/mp/cvr/warning
  • discoveryengine.googleapis.com/media_recs/oyml/wdps/warning
  • discoveryengine.googleapis.com/media_recs/rfy/wdps/warning
  • discoveryengine.googleapis.com/media_recs/mlt/wdps/warning
resources[]

object (MonitoredResource)

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

  • discoveryengine.googleapis.com/Branch.

    • התוויות שנדרשות למשאב הזה:
      • project_number
      • location_id
      • collection_id
      • datastore_id
      • branch_id

  • discoveryengine.googleapis.com/DataStore

    • התוויות שנדרשות למשאב הזה:
      • project_number
      • location_id
      • collection_id
      • datastore_id

גוף התשובה

תשובה לשיטה requirements.checkRequirement.

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

ייצוג ב-JSON 
{
  "requirement": {
    object (Requirement)
  },
  "requirementCondition": {
    object (Expr)
  },
  "metricResults": [
    {
      object (MetricQueryResult)
    }
  ],
  "oldestMetricTimestamp": string,
  "result": string
}
שדות
requirement

object (Requirement)

הגדרת הדרישה.
requirementCondition

object (Expr)

התנאי להערכת תוצאת הדרישה.
metricResults[]

object (MetricQueryResult)

תוצאות המדדים.
oldestMetricTimestamp

string (Timestamp format)

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

הפורמט הוא 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".
result

string

התוצאה של הדרישה. הוא צריך להיות אחד מהשדות severity בהגדרת הדרישה. אם מתרחשת שגיאה במהלך ההערכה, הערך יהיה UNKNOWN.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

דרישה

דרישה לגבי נתונים.

ייצוג ב-JSON 
{
  "type": string,
  "displayName": string,
  "description": string,
  "condition": {
    object (Expr)
  },
  "metricBindings": [
    {
      object (MetricBinding)
    }
  ],
  "thresholdBindings": [
    {
      object (ThresholdBinding)
    }
  ],
  "violationSamplesBindings": [
    {
      object (ViolationSamplesBinding)
    }
  ],
  "severity": [
    string
  ]
}
שדות
type

string

סוג הדרישה, שמשמש כמזהה. חייב להיות ייחודי.

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

דוגמאות:

  • library.googleapis.com/books/min_available_books
  • discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate
displayName

string

שם הדרישה.
description

string

תיאור הדרישה.
condition

object (Expr)

התנאי להערכת תוצאת הדרישה.

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

object (MetricBinding)

רשימה של קשרי המדדים לשימוש ב-condition.
thresholdBindings[]

object (ThresholdBinding)

רשימה של ספי התראות שיוגדרו ב-condition.
violationSamplesBindings[]

object (ViolationSamplesBinding)

רשימה של קשרי המדדים לשימוש ב-condition.
severity[]

string

רמת החומרה של השגיאות אם הדרישה לא מתקיימת. הסדר צריך להיות מהמגביל ביותר (מימין) למקל ביותר (משמאל). דוגמאות:

  • BLOCKING
  • CRITICAL
  • WARNING

כל ערכי הסף בדרישה חייבים להיות בעלי רמת החומרה הזו.

MetricBinding

מציינים שאילתת מדדים ומקשרים את התוצאה שלה למשתנה שישמש ב-condition.

ייצוג ב-JSON 
{
  "variableId": string,
  "resourceType": string,
  "metricFilter": string,
  "description": string,
  "category": string
}
שדות
variableId

string

מזהה המשתנה שאליו מתייחסים ב-condition.
resourceType

string

המשאב שנמדד על ידי המדד.
metricFilter

string

מחרוזת המסנן שמשמשת לשאילתת מדדים.

דוגמה:

‪"metric.type = "discoveryengine.googleapis.com/events/day_count" AND " "metric.conditions.time_range = "NINETY_DAYS""
description

string

תיאור קריא (לבני אדם) של מסנן המדדים המתאים.
category

string

הקטגוריה של משאב היעד של המדד. דוגמה: 'אירועים'

ThresholdBinding

מציין סף רב-רמות להחלה על metricBindings בביטוי CEL‏ condition.

ייצוג ב-JSON 
{
  "variableId": string,
  "description": string,
  "thresholdValues": [
    {
      object (ThresholdValue)
    }
  ]
}
שדות
variableId

string

מזהה המשתנה שאליו מתייחסים ב-condition. הערך חייב להיות ייחודי בכל metricBindings ו-thresholdBindings.
description

string

תיאור קריא (לבני אדם) של הסף והדרישה המשנית התואמים.
thresholdValues[]

object (ThresholdValue)

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

ThresholdValue

מציינים ערך סף לרמת חומרה מסוימת.

ייצוג ב-JSON 
{
  "severity": string,
  "value": number
}
שדות
severity

string

חומרת השגיאות אם לא עומדים בסף. צריך לבחור אחד מהשדות severity בדרישה.
value

number

ערך הסף.

ViolationSamplesBinding

מציינים שאילתת דוגמאות ומקשרים את התוצאה שלה למשתנה שישמש ב-condition.

ייצוג ב-JSON 
{
  "variableId": string,
  "sampleFilter": string,
  "description": string
}
שדות
variableId

string

מזהה המשתנה שאליו מתייחסים ב-condition.
sampleFilter

string

מחרוזת המסנן שמשמשת לשאילתת דוגמאות.

דוגמה: "sample.type = "retail.googleapis.com/userEvent" AND " "sample.labels.event_type = "PURCHASE" "
description

string

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

האורך צריך להיות פחות מ-128 תווים.

MetricQueryResult

תוצאת המדד. המדד מופיע ב-requirementCondition.

ייצוג ב-JSON 
{
  "name": string,
  "value": {
    object (TypedValue)
  },
  "timestamp": string,
  "unit": string,
  "metricType": string
}
שדות
name

string

שם השאילתה של המדד הזה ממופה למשתנים ב-requirementCondition.
value

object (TypedValue)

הערך של שאילתת המדד.
timestamp

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

string

היחידה שבה המדד הזה מדווח. עוקבים אחרי

התקן Unified Code for Units of Measure.
metricType

string

מזהה הסוג של המדד שמתאים לתוצאת השאילתה הזו.