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 行目と交差するため、この照合戦略でもその場所と一致します。