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 שלא קיימים או שנמחקו.