DataFilter

Filtr opisujący, które dane powinny zostać wybrane lub zwrócone w odpowiedzi na żądanie. Więcej informacji znajdziesz w artykule Odczytywanie, zapisywanie i wyszukiwanie metadanych.

Zapis 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.
}
Pola
Pole zbiorcze filter. Rodzaje filtrów, które mogą ograniczać wybór danych. filter może mieć tylko jedną z tych wartości:
developerMetadataLookup

object (DeveloperMetadataLookup)

Wybiera dane powiązane z metadanymi dewelopera, które spełniają kryteria opisane w tym DeveloperMetadataLookup.
a1Range

string

Wybiera dane, które pasują do określonego zakresu A1.
gridRange

object (GridRange)

Wybiera dane, które pasują do zakresu opisanego przez GridRange.

DeveloperMetadataLookup

Wybiera DeveloperMetadata, które pasuje do wszystkich określonych pól. Jeśli na przykład podany jest tylko identyfikator metadanych, oznacza to DeveloperMetadata z tym konkretnym unikalnym identyfikatorem. Jeśli określono klucz metadanych, uwzględniane są wszystkie metadane dewelopera z tym kluczem. Jeśli określono klucz, widoczność i typ lokalizacji, uwzględniane są wszystkie metadane dewelopera z tym kluczem i widocznością, które są powiązane z lokalizacją tego typu. Ogólnie rzecz biorąc, ta funkcja wybiera wszystkie DeveloperMetadata, które pasują do przecięcia wszystkich określonych pól. Można określić dowolne pole lub kombinację pól.

Zapis JSON 
{
  "locationType": enum (DeveloperMetadataLocationType),
  "metadataLocation": {
    object (DeveloperMetadataLocation)
  },
  "locationMatchingStrategy": enum (DeveloperMetadataLocationMatchingStrategy),
  "metadataId": integer,
  "metadataKey": string,
  "metadataValue": string,
  "visibility": enum (DeveloperMetadataVisibility)
}
Pola
locationType

enum (DeveloperMetadataLocationType)

Ogranicza wybrane metadane dewelopera do tych wpisów, które są powiązane z lokalizacjami określonego typu. Jeśli na przykład to pole ma wartość ROW, wyszukiwanie uwzględnia tylko metadane dewelopera powiązane z wierszami. Jeśli to pole nie zostanie określone, brane pod uwagę będą wszystkie typy lokalizacji. Nie można określić tego pola jako SPREADSHEET, gdy pole locationMatchingStrategy ma wartość INTERSECTING lub gdy pole metadataLocation ma wartość lokalizacji innej niż arkusz kalkulacyjny. Metadane arkusza kalkulacyjnego nie mogą przecinać się z żadną inną lokalizacją metadanych dewelopera. To pole musi pozostać nieokreślone, gdy w przypadku parametru locationMatchingStrategy podasz wartość EXACT.
metadataLocation

object (DeveloperMetadataLocation)

Ogranicza wybrane metadane dewelopera do wpisów powiązanych z określoną lokalizacją. To pole jest zgodne z dokładnymi lokalizacjami lub wszystkimi lokalizacjami, które się przecinają, zgodnie z określonym locationMatchingStrategy.
locationMatchingStrategy

enum (DeveloperMetadataLocationMatchingStrategy)

Określa, w jaki sposób to wyszukiwanie pasuje do lokalizacji. Jeśli to pole ma wartość EXACT, dopasowywane są tylko metadane dewelopera powiązane z dokładną określoną lokalizacją. Jeśli to pole ma wartość INTERSECTING, dopasowywane są też metadane dewelopera powiązane z przecinającymi się lokalizacjami. Jeśli to pole nie zostanie określone, przyjmie domyślną wartość INTERSECTING. Jeśli to pole jest określone, musi być też określony parametr metadataLocation.
metadataId

integer

Ogranicza wybrane metadane dewelopera do tych, które mają pasujący DeveloperMetadata.metadata_id.
metadataKey

string

Ogranicza wybrane metadane dewelopera do tych, które mają pasujący DeveloperMetadata.metadata_key.
metadataValue

string

Ogranicza wybrane metadane dewelopera do tych, które mają pasujący DeveloperMetadata.metadata_value.
visibility

enum (DeveloperMetadataVisibility)

Ogranicza wybrane metadane dewelopera do tych, które mają pasujący DeveloperMetadata.visibility. Jeśli nie zostanie określony, brane są pod uwagę wszystkie metadane dewelopera widoczne dla projektu wysyłającego żądanie.

DeveloperMetadataLocationMatchingStrategy

Wyliczenie strategii dopasowywania lokalizacji metadanych dewelopera.

Wartości w polu enum
DEVELOPER_METADATA_LOCATION_MATCHING_STRATEGY_UNSPECIFIED Wartość domyślna. Nie można użyć tej wartości.
EXACT_LOCATION Wskazuje, że określona lokalizacja powinna być dopasowana dokładnie. Jeśli na przykład wiersz 3 został określony jako lokalizacja, ta strategia dopasowywania będzie dopasowywać tylko metadane dewelopera powiązane z wierszem 3. Metadane powiązane z innymi lokalizacjami nie będą brane pod uwagę.
INTERSECTING_LOCATION Wskazuje, że określona lokalizacja powinna pasować do tej dokładnej lokalizacji, a także do wszystkich lokalizacji, które się z nią przecinają. Jeśli na przykład wiersz 3 został określony jako lokalizacja, ta strategia dopasowywania będzie dopasowywać metadane dewelopera powiązane z wierszem 3, a także metadane powiązane z lokalizacjami, które przecinają wiersz 3. Jeśli na przykład z kolumną B były powiązane metadane dewelopera, ta strategia dopasowywania również dopasuje tę lokalizację, ponieważ kolumna B przecina wiersz 3.