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