Method: indexing.datasources.items.push

Daha sonra sorgulanması ve güncellenmesi için bir öğeyi bir sıraya gönderir.

Bu API'nin çalıştırılması için bir yönetici veya hizmet hesabı gerekir. Kullanılan hizmet hesabı, ilgili veri kaynağında beyaz listeye eklenen hesaptır.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
item.name

string

Dizine ekleme sırasına eklenecek item öğesinin adı.

Biçim: datasources/{sourceId}/items/{ID}

Bu alanının doldurulması zorunludur. Maksimum uzunluk 1.536 karakterdir.

İstek içeriği

İstek metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Alanlar
item.type

enum (PushItem.Type)

Push davranışını tanımlayan push işleminin türü.
item.metadataHash

string

Depoya göre öğenin meta veri karması. Belirtilen durumlarda bu öğenin durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu alanın ve type alanının ayarlanması, bağımsız değişken hatasına neden olur. Maksimum uzunluk 2.048 karakterdir.
item.structuredDataHash

string

Depoya göre öğenin yapılandırılmış veri karması. Belirtilen bu değer, öğenin durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu alanın ve type alanının ayarlanması, bağımsız değişken hatasına neden olur. Maksimum uzunluk 2.048 karakterdir.
item.contentHash

string

Depoya göre öğenin içerik karması. Belirtilen durumlarda bu öğenin durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu alanın ve type alanının ayarlanması, bağımsız değişken hatasına neden olur. Maksimum uzunluk 2.048 karakterdir.
item.payload

string (bytes format)

Bağlantılayıcı için alternatif depolama alanı kimliği ve diğer meta veriler gibi ek belge durumu bilgileri sağlar. Maksimum uzunluk 8.192 bayttır.

Base64 kodlu bir dize.
item.queue

string

Bu öğenin ait olduğu sıra. Bu alan belirtilmezse default kuyruğu seçilir. Maksimum uzunluk 512 karakterdir.
item.repositoryError

object (RepositoryError)

Bağlayıcı veya depolama alanı hata ayrıntılarını depolamak için bu alanı doldurun. Bu bilgiler Yönetici Konsolu'nda gösterilir. Bu alan yalnızca type REPOSITORY_ERROR olduğunda doldurulabilir.
connectorName

string

Bu çağrıyı yapan bağlayıcının adı.

Biçim: datasources/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

Sık kullanılan hata ayıklama seçenekleri.

Yanıt gövdesi

Başarılıysa yanıt metni, Item öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

PushItem

Dizine ekleme sırasına eklenecek bir öğeyi temsil eder.

JSON gösterimi 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Alanlar
name

string

Dizine ekleme sırasına eklenecek item öğesinin adı.

Biçim: datasources/{sourceId}/items/{ID}

Bu alanının doldurulması zorunludur. Maksimum uzunluk 1.536 karakterdir.
type

enum (PushItem.Type)

Push davranışını tanımlayan push işleminin türü.
metadataHash

string

Depoya göre öğenin meta veri karması. Belirtilen durumlarda bu öğenin durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu alanın ve type alanının ayarlanması, bağımsız değişken hatasına neden olur. Maksimum uzunluk 2.048 karakterdir.
structuredDataHash

string

Depoya göre öğenin yapılandırılmış veri karması. Belirtiliyse bu öğenin durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu alanın ve type alanının ayarlanması, bağımsız değişken hatasına neden olur. Maksimum uzunluk 2.048 karakterdir.
contentHash

string

Depoya göre öğenin içerik karması. Belirtiliyse bu öğenin durumunun nasıl değiştirileceğini belirlemek için kullanılır. Bu alanın ve type alanının ayarlanması, bağımsız değişken hatasına neden olur. Maksimum uzunluk 2.048 karakterdir.
payload

string (bytes format)

Bağlantılayıcı için alternatif depolama alanı kimliği ve diğer meta veriler gibi ek belge durumu bilgileri sağlar. Maksimum uzunluk 8.192 bayttır.

Base64 kodlu bir dize.
queue

string

Bu öğenin ait olduğu sıra. Bu alan belirtilmezse default kuyruğu seçilir. Maksimum uzunluk 512 karakterdir.
repositoryError

object (RepositoryError)

Bağlayıcı veya depolama alanı hata ayrıntılarını depolamak için bu alanı doldurun. Bu bilgiler Yönetici Konsolu'nda gösterilir. Bu alan yalnızca type REPOSITORY_ERROR olduğunda doldurulabilir.

PushItem.Type

Push davranışını tanımlayan push işleminin türü.

Sıralamalar
UNSPECIFIED Varsayılan olarak UNSPECIFIED. İtme işleminin ItemStatus öğesini değiştirmemesi gerektiğini belirtir.
MODIFIED Depo dokümanının önceki update çağrısından bu yana değiştirildiğini veya güncellendiğini gösterir. Bu işlem, mevcut bir öğenin durumunu MODIFIED olarak değiştirir. Bu işlev, var olmayan bir öğe için çağrılırsa durum NEW_ITEM olarak değiştirilir.
NOT_MODIFIED Depodaki öğe, son güncelleme çağrısından bu yana değiştirilmemiştir. Bu push işlemi, durumu ACCEPTED durumuna ayarlar.
REPOSITORY_ERROR Bağlayıcı, bu öğeyle ilgili bir depolama alanı hatasıyla karşılaşıyor. Durumu REPOSITORY_ERROR olarak değiştirin. Öğenin rezervasyonu kaldırılır ve eksponansiyel geri yükleme ile belirlenen gelecekteki bir zamanda yeniden planlanır.
REQUEUE Yalnızca ayrılmış öğeler için REQUEUE ile çağrı itme. Bu işlem, öğenin rezervasyonunu iptal eder ve kullanılabilir zamanını duvar saati zamanına sıfırlar.