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 , соответствующие всем указанным полям. Например, если указан только идентификатор метаданных, рассматриваются метаданные 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 то при поиске учитываются только метаданные разработчика, связанные со строками. Если поле не указано, рассматриваются все типы местоположений. Это поле нельзя указать как SPREADSHEET , если locationMatchingStrategy указано как INTERSECTING или если metadataLocation указано как местоположение, не являющееся электронной таблицей. Метаданные электронной таблицы не могут пересекаться с какими-либо другими местоположениями метаданных разработчика. Это поле также должно быть оставлено неуказанным, если 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 пересекает третью строку.