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)

この検索が場所と一致する方法を指定します。このフィールドが 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 と交差するため、この照合方法ではその場所も一致することになります。