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 נעשה שימוש בתחביר המרת 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 שלא קיימים או שנמחקו.