DataFilter

リクエストから選択または返されるデータの種類を記述するフィルタ。詳細については、メタデータの読み取り、書き込み、検索をご覧ください。

JSON 表現
{

  "developerMetadataLookup": {
    object (DeveloperMetadataLookup)
  },
  "a1Range": string,
  "gridRange": {
    object (GridRange)
  }
}
フィールド
共用体フィールド 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 行目と交差するため、その場所も一致します。