Method: settings.datasources.update

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

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

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

Tham số
source.name

string

Tên của tài nguyên nguồn dữ liệu. Định dạng: nguồn dữ liệu/{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 biệt hiệu của nguồn. Giá trị này sẽ dùng để khớp với "nguồn" toán tử. Ví dụ: nếu tên ngắn là <value> thì các truy vấn như <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 ký tự chữ-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 đối tượng sau: mail, gmail, docs, drive, groups, sites, calendar, Hangouts, gplus, keep, people, team. Độ 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 lập chỉ mục.

source.disableServing

boolean

Vô hiệu hóa phân phát bất kỳ kết quả tìm kiếm hoặc hỗ trợ nào.

source.disableModifications

boolean

Nếu đúng, hãy đặt nguồn dữ liệu ở chế độ chỉ có thể đọc. Ở chế độ chỉ có thể đọ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 sẽ không dừng quá trình xử lý dữ liệu được chấp nhận trước đó.

source.itemsVisibility[]

object (GSuitePrincipal)

Trường này giới hạn khả năng hiển thị các mục ở cấp nguồn dữ liệu. Các mục trong nguồn dữ liệu chỉ được kết hợp với người dùng và nhóm có trong trường này. Lưu ý rằng điều 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 truy cập ACL đối với các mục được chứa 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 tải URI hình thu nhỏ đối với 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 Hoạt động chạy trong thời gian dài (LRO) hiện đ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 các trường cần cập nhật. Ví dụ về đường dẫn trường: name, displayName.

  • Nếu updateMask không phải là giá trị trống, thì chỉ các 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 updateMask không hiện diện hoặc trống hoặc có giá trị *, thì tất cả các trường đều đượ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 cấp phép

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.