Method: indexing.datasources.items.push

Bir öğeyi daha sonra yoklama ve güncelleme amacıyla bir sıraya aktarır.

Bu API'nin yürütülebilmesi için bir yönetici veya hizmet hesabı gerekir. Kullanılan hizmet hesabı, ilgili veri kaynağında beyaz listeye eklenmiş olan 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 aktarılacak item öğesinin adı.

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

Bu alanının doldurulması zorunludur. En çok 1536 karakter kullanılabilir.

İstek içeriği

İstek gövdesi, aşağıdaki yapıya sahip 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

Öğenin depoya göre meta veri karması. Belirtilirse 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. En çok 2048 karakter kullanılabilir.
item.structuredDataHash

string

Depoya göre öğenin yapılandırılmış veri karması. Belirtilirse 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. En çok 2048 karakter kullanılabilir.
item.contentHash

string

Öğenin depoya göre içerik karması. Belirtilirse 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. En çok 2048 karakter kullanılabilir.
item.payload

string (bytes format)

Bağlayıcı için alternatif depo kimliği ve diğer meta veriler gibi ek doküman 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 sırası seçilir. En çok 512 karakter kullanılabilir.
item.repositoryError

object (RepositoryError)

Bağlayıcı veya depo hatası 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 karşılaşı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ılavuzunu inceleyin.

PushItem

Dizine ekleme sırasına aktarılacak 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 aktarılacak item öğesinin adı.

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

Bu alanının doldurulması zorunludur. En çok 1536 karakter kullanılabilir.
type

enum (PushItem.Type)

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

string

Öğenin depoya göre meta veri karması. Belirtilirse 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. En çok 2048 karakter kullanılabilir.
structuredDataHash

string

Depoya göre öğenin yapılandırılmış veri karması. Belirtilirse 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. En çok 2048 karakter kullanılabilir.
contentHash

string

Öğenin depoya göre içerik karması. Belirtilirse 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. En çok 2048 karakter kullanılabilir.
payload

string (bytes format)

Bağlayıcı için alternatif depo kimliği ve diğer meta veriler gibi ek doküman 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 sırası seçilir. En çok 512 karakter kullanılabilir.
repositoryError

object (RepositoryError)

Bağlayıcı veya depo hatası 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 değer: UNSPECIFIED. Aktarma işleminin ItemStatus öğesini değiştirmemesi gerektiğini belirtir
MODIFIED Kod deposu dokümanının, önceki update çağrısından bu yana değiştirildiğini veya güncellendiğini belirtir. Bu işlem, mevcut bir öğenin durumunu MODIFIED olarak değiştirir. Bu çağrı, mevcut olmayan bir öğede çağrılırsa durum NEW_ITEM olarak değiştirilir.
NOT_MODIFIED Son güncelleme çağrısından bu yana depodaki öğe değiştirilmedi. Bu aktarma işlemi, durumu ACCEPTED durumuna ayarlar.
REPOSITORY_ERROR Bağlayıcı, bu öğeyle ilgili bir depo hatasıyla karşılaşıyor. Durumu REPOSITORY_ERROR durumu olarak değiştirin. Öğe ayrılmadı ve üstel geri çekilme ile belirlenen gelecekteki bir zamanda yeniden planlandı.
REQUEUE Yalnızca ayrılmış öğeler için REQUEUE ile push çağrısı. Bu işlem, öğenin rezervasyonunu kaldırır ve mevcut süresini gerçek hayattaki saate sıfırlar.