Method: indexing.datasources.items.index

עדכון ה-ACL, המטא-נתונים והתוכן של Item. אם הוא לא קיים, הוא יוכנס.Item בשיטה הזו אין תמיכה בעדכונים חלקיים. שדות ללא ערכים שצוינו נמחקים מאינדקס Cloud Search.

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

בקשת HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index

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

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

פרמטרים
item.name

string

שם הפריט. פורמט: datasources/{sourceId}/items/{itemId}

יש למלא שדה זה. האורך המקסימלי הוא 1,536 תווים.

גוף הבקשה

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

ייצוג ב-JSON
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "title": string,
      "sourceRepositoryUrl": string,
      "containerName": string,
      "objectType": string,
      "createTime": string,
      "updateTime": string,
      "interactions": [
        {
          object (Interaction)
        }
      ],
      "contentLanguage": string,
      "mimeType": string,
      "searchQualityMetadata": {
        object (SearchQualityMetadata)
      },
      "keywords": [
        string
      ],
      "hash": string,
      "contextAttributes": [
        {
          object (ContextAttribute)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "contentFormat": enum (ItemContent.ContentFormat),
      "hash": string,

      // Union field content can be only one of the following:
      "inlineContent": string,
      "contentDataRef": {
        object (UploadItemRef)
      }
      // End of list of possible types for union field content.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
שדות
item.acl

object (ItemAcl)

רשימת בקרת הגישה של הפריט הזה.

item.metadata

object (ItemMetadata)

פרטי המטא-נתונים.

item.structuredData

object (ItemStructuredData)

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

item.content

object (ItemContent)

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

item.version

string (bytes format)

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

המערכת של הוספה לאינדקס של Cloud Search לא תוסיף לאינדקס או תמחק פריט כלשהו בתור עם ערך גרסה שקטן או שווה לגרסה של הפריט שנוסף כרגע לאינדקס. האורך המקסימלי של השדה הזה הוא 1,024 בייטים.

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

מחרוזת בקידוד Base64.

item.status

object (ItemStatus)

סטטוס הפריט. שדה פלט בלבד.

item.queue

string

התור שאליו הפריט הזה שייך. האורך המקסימלי הוא 100 תווים.

item.payload

string (bytes format)

מחבר מצב נוסף יכול לאחסן את הפריט הזה. האורך המקסימלי הוא 10,000 בייטים.

מחרוזת בקידוד Base64.

item.itemType

enum (Item.ItemType)

הסוג של הפריט.

connectorName

string

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

פורמט: datasources/{sourceId}/connectors/{ID}

mode

enum (RequestMode.Mode)

חובה. RequestMode של הבקשה הזו.

debugOptions

object (DebugOptions)

אפשרויות נפוצות לניפוי באגים.

indexItemOptions

object (IndexItemOptions)

גוף התשובה

אם הפעולה מצליחה, גוף התגובה מכיל מופע של Operation.

היקפי הרשאה

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

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

מידע נוסף זמין במדריך ההרשאות.

IndexItemOptions

ייצוג ב-JSON
{
  "allowUnknownGsuitePrincipals": boolean
}
שדות
allowUnknownGsuitePrincipals

boolean

מציין אם בקשת האינדקס תאפשר לחשבונות משתמשים ב-Google Workspace שלא קיימים או נמחקו.