DataFilter

描述應從要求選取或傳回哪些資料的篩選器。

JSON 表示法
{

  // Union field filter can be only one of the following:
  "developerMetadataLookup": {
    object (DeveloperMetadataLookup)
  },
  "a1Range": string,
  "gridRange": {
    object (GridRange)
  }
  // End of list of possible types for union field filter.
}
欄位
聯集欄位 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)

決定這項查詢比對地點的方式。如果將這個欄位指定為「明確」,則系統只會比對與指定位置相關聯的開發人員中繼資料。如果將這個欄位指定為 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 表示指定地點應完全相符。舉例來說,如果將第 3 列指定為地點,則這項比對策略只會比對第 3 列的開發人員中繼資料。其他位置關聯的中繼資料不會列入考慮。
INTERSECTING_LOCATION 表示指定地區應與該確切位置以及任何交會地點相符。舉例來說,如果將第 3 列指定為地點,這項比對策略就會與第 3 列相關的開發人員中繼資料,以及與第 3 列之間位置相關聯的中繼資料進行比對。舉例來說,如果 B 欄存在開發人員中繼資料,這項比對策略也會與該位置相符,因為 B 欄與第 3 列交會。