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,則 DeveloperMetadata 會考慮具有該特定專屬 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 表示指定地區應完全符合。舉例來說,如果將第 3 列指定為地點,則這個比對策略只會比對到第 3 列的開發人員中繼資料。系統不會考慮其他位置的相關中繼資料。
INTERSECTING_LOCATION 表示指定的位置應與該確切位置以及所有交集的位置相符。舉例來說,如果將第 3 列指定為地點,則這個比對策略會符合第 3 列的相關開發人員中繼資料,以及與第 3 列交集地點的相關中繼資料。舉例來說,如果 B 欄有相關聯的開發人員中繼資料,則這項比對策略也會符合該位置,因為 B 欄與第 3 列相交。