DataFilter

篩選器,說明應從要求中選取或傳回哪些資料。詳情請參閱「讀取、寫入及搜尋中繼資料」。

JSON 表示法
{

  "developerMetadataLookup": {
    object (DeveloperMetadataLookup)
  },
  "a1Range": string,
  "gridRange": {
    object (GridRange)
  }
}
欄位
聯集欄位 filter。可能會限制所選資料的篩選器類型。filter 只能是下列其中一項:
developerMetadataLookup

object (DeveloperMetadataLookup)

選取與開發人員中繼資料相關聯的資料,這些資料符合這個 DeveloperMetadataLookup 所述的條件。

a1Range

string

選取符合指定 A1 範圍的資料。

gridRange

object (GridRange)

選取符合 GridRange 所述範圍的資料。

DeveloperMetadataLookup

選取符合所有指定欄位的 DeveloperMetadata。舉例來說,如果只指定中繼資料 ID,系統會將該特定不重複 ID 視為 DeveloperMetadata。如果指定中繼資料鍵,系統會將具有該鍵的所有開發人員中繼資料納入考量。如果指定了鍵、顯示方式和位置類型,系統會考量與該類型位置相關聯,且具有該鍵和顯示方式的所有開發人員中繼資料。一般來說,這會選取所有符合指定欄位交集的 DeveloperMetadata;您可以指定任何欄位或欄位組合。

JSON 表示法
{
  "locationType": enum (DeveloperMetadataLocationType),
  "metadataLocation": {
    object (DeveloperMetadataLocation)
  },
  "locationMatchingStrategy": enum (DeveloperMetadataLocationMatchingStrategy),
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "visibility": enum (DeveloperMetadataVisibility)
}
欄位
locationType

enum (DeveloperMetadataLocationType)

將所選開發人員中繼資料限制為與指定類型位置相關聯的項目。舉例來說,如果這個欄位指定為 ROW,這項查詢只會考量與資料列相關聯的開發人員中繼資料。如果未指定這個欄位,系統會將所有地點類型納入考量。如果 locationMatchingStrategy 指定為 INTERSECTING,或 metadataLocation 指定為非試算表位置,則此欄位不得指定為 SPREADSHEET。試算表中繼資料不得與任何其他開發人員中繼資料位置相交。如果 locationMatchingStrategy 指定為「EXACT」,這個欄位也必須留空。

metadataLocation

object (DeveloperMetadataLocation)

將所選開發人員中繼資料限制為與指定位置相關聯的項目。這個欄位會根據指定的 locationMatchingStrategy,比對確切位置或所有相交位置。

locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

決定這項查詢與位置的相符程度。如果這個欄位指定為「EXACT」,系統只會比對與指定確切位置相關聯的開發人員中繼資料。如果這個欄位指定為 INTERSECTING,系統也會比對與交集位置相關聯的開發人員中繼資料。如未指定,這個欄位會採用預設值 INTERSECTING。如果指定這個欄位,也必須指定 metadataLocation

metadataId

integer

將所選開發人員中繼資料限制為具有相符 DeveloperMetadata.metadata_id 的資料。

metadataKey

string

將所選開發人員中繼資料限制為具有相符 DeveloperMetadata.metadata_key 的資料。

metadataValue

string

將所選開發人員中繼資料限制為具有相符 DeveloperMetadata.metadata_value 的資料。

visibility

enum (DeveloperMetadataVisibility)

將所選開發人員中繼資料限制為具有相符 DeveloperMetadata.visibility 的資料。如果未指定,系統會將要求專案可見的所有開發人員中繼資料納入考量。

DeveloperMetadataLocationMatchingStrategy

列舉比對開發人員中繼資料位置的策略。

列舉
DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED 預設值。不得使用這個值。
EXACT_LOCATION 表示指定位置必須完全相符。舉例來說,如果將第三列指定為位置,這項比對策略就只會比對也與第三列相關聯的開發人員中繼資料。系統不會考慮其他位置的相關聯中繼資料。
INTERSECTING_LOCATION 表示指定位置應與該確切位置以及任何相交位置相符。舉例來說,如果指定第三列為位置,這個比對策略會比對與第三列相關聯的開發人員中繼資料,以及與第三列相交位置相關聯的中繼資料。舉例來說,如果 B 欄有相關聯的開發人員中繼資料,這個比對策略也會比對該位置,因為 B 欄與第三列相交。