Method: settings.datasources.update

Cập nhật nguồn dữ liệu.

Lưu ý: API này yêu cầu tài khoản quản trị để thực thi.

Yêu cầu HTTP

PUT https://cloudsearch.googleapis.com/v1/settings/{source.name=datasources/*}

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
source.name

string

Tên của tài nguyên nguồn dữ liệu. Định dạng: datasources/{sourceId}.

Tên này sẽ bị bỏ qua khi tạo nguồn dữ liệu.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "source": {
    "name": string,
    "displayName": string,
    "shortName": string,
    "indexingServiceAccounts": [
      string
    ],
    "disableServing": boolean,
    "disableModifications": boolean,
    "itemsVisibility": [
      {

        // Union field gsuite_principal can be only one of the following:
        "gsuiteUserEmail": string,
        "gsuiteGroupEmail": string,
        "gsuiteDomain": boolean
        // End of list of possible types for union field gsuite_principal.
      }
    ],
    "returnThumbnailUrls": boolean,
    "operationIds": [
      string
    ]
  },
  "debugOptions": {
    object (DebugOptions)
  },
  "updateMask": string
}
Trường
source.displayName

string

Bắt buộc. Tên hiển thị của nguồn dữ liệu. Độ dài tối đa là 300 ký tự.
source.shortName

string

Tên ngắn hoặc bí danh cho nguồn. Giá trị này sẽ được dùng để so khớp với toán tử "nguồn". Ví dụ: nếu tên ngắn là <value>, thì các cụm từ tìm kiếm như source:<value> sẽ chỉ trả về kết quả cho nguồn này. Giá trị này phải là duy nhất trên tất cả các nguồn dữ liệu. Giá trị chỉ được chứa các ký tự chữ và số (a-zA-Z0-9). Giá trị không được bắt đầu bằng "google" và không được là một trong những giá trị sau: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Độ dài tối đa là 32 ký tự.
source.indexingServiceAccounts[]

string

Danh sách tài khoản dịch vụ có quyền truy cập vào tính năng lập chỉ mục.
source.disableServing

boolean

Tắt tính năng phân phát kết quả tìm kiếm hoặc trợ giúp.
source.disableModifications

boolean

Nếu đúng, hãy đặt nguồn dữ liệu thành chế độ chỉ có thể đọc. Ở chế độ chỉ đọc, API Lập chỉ mục sẽ từ chối mọi yêu cầu lập chỉ mục hoặc xoá các mục trong nguồn này. Việc bật chế độ chỉ có thể đọc sẽ không ngăn việc xử lý dữ liệu đã được chấp nhận trước đó.
source.itemsVisibility[]

object (GSuitePrincipal)

Trường này hạn chế chế độ hiển thị đối với các mục ở cấp nguồn dữ liệu. Các mục trong nguồn dữ liệu chỉ được giới hạn ở tập hợp người dùng và nhóm có trong trường này. Xin lưu ý rằng việc này không đảm bảo quyền truy cập vào một mục cụ thể, vì người dùng cần có quyền ACL đối với các mục có trong đó. Điều này đảm bảo quyền truy cập cấp cao trên toàn bộ nguồn dữ liệu và các mục riêng lẻ không được chia sẻ bên ngoài chế độ hiển thị này.
source.returnThumbnailUrls

boolean

Người dùng có thể yêu cầu lấy URI hình thu nhỏ cho các Mục được lập chỉ mục trong nguồn dữ liệu này không.
source.operationIds[]

string

Mã của các Thao tác thực hiện lâu (LRO) đang chạy cho giản đồ này.
debugOptions

object (DebugOptions)

Các tuỳ chọn gỡ lỗi phổ biến.
updateMask

string (FieldMask format)

Chỉ áp dụng cho settings.datasources.patch.

Cập nhật mặt nạ để kiểm soát những trường cần cập nhật. Ví dụ về đường dẫn trường: name, displayName.

  • Nếu updateMask không trống, thì chỉ những trường được chỉ định trong updateMask mới được cập nhật.
  • Nếu bạn chỉ định một trường trong updateMask nhưng không chỉ định giá trị của trường đó trong nguồn, thì trường đó sẽ bị xoá.
  • Nếu không có updateMask hoặc trường này trống hoặc có giá trị *, thì tất cả các trường sẽ được cập nhật.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Operation.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.