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