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 .

Поиск метаданных разработчика

Выбирает 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 )

Определяет, насколько этот поиск соответствует местоположению. Если в этом поле указано ТОЧНО, сопоставляются только метаданные разработчика, связанные с указанным точным местоположением. Если в этом поле указано значение INTERSECTING, метаданные разработчика, связанные с пересекающимися местоположениями, также сопоставляются. Если это поле не указано, оно принимает значение по умолчанию INTERSECTING . Если это поле указано, необходимо также указать metadataLocation .

metadataId

integer

Ограничивает выбранные метаданные разработчика теми, которые имеют соответствующий DeveloperMetadata.metadata_id .

metadataKey

string

Ограничивает выбранные метаданные разработчика теми, которые имеют соответствующий DeveloperMetadata.metadata_key .

metadataValue

string

Ограничивает выбранные метаданные разработчика теми, которые имеют соответствующее DeveloperMetadata.metadata_value .

visibility

enum ( DeveloperMetadataVisibility )

Ограничивает выбранные метаданные разработчика теми, которые имеют соответствующий DeveloperMetadata.visibility . Если не указать, учитываются все метаданные разработчика, видимые для запрашивающего проекта.

РазработчикМетаданныеLocationMatchingStrategy

Перечень стратегий сопоставления местоположений метаданных разработчика.

Перечисления
DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED Значение по умолчанию. Это значение нельзя использовать.
EXACT_LOCATION Указывает, что указанное местоположение должно точно совпадать. Например, если в качестве местоположения была указана третья строка, эта стратегия сопоставления будет соответствовать только метаданным разработчика, также связанным с третьей строкой. Метаданные, связанные с другими местоположениями, не будут учитываться.
INTERSECTING_LOCATION Указывает, что указанное местоположение должно соответствовать этому точному местоположению, а также любым пересекающимся местоположениям. Например, если в качестве местоположения была указана третья строка, эта стратегия сопоставления будет соответствовать метаданным разработчика, связанным с третьей строкой, а также метаданным, связанным с местоположениями, которые пересекают третью строку. Если, например, в столбце B были связаны метаданные разработчика, эта стратегия сопоставления также будет соответствовать этому местоположению, поскольку столбец B пересекает третью строку.