Cards v2

{
  "header": {
    object (CardHeader)
  },
  "sections": [
    {
      object (Section)
    }
  ],
  "sectionDividerStyle": enum (DividerStyle),
  "cardActions": [
    {
      object (CardAction)
    }
  ],
  "name": string,
  "fixedFooter": {
    object (CardFixedFooter)
  },
  "displayStyle": enum (DisplayStyle),
  "peekCardHeader": {
    object (CardHeader)
  }
}

object (CardHeader)

カードのヘッダー。通常、ヘッダーには先頭の画像とタイトルが含まれます。ヘッダーは常にカードの上部に表示されます。

object (Section)

ウィジェットのコレクションが含まれています。各セクションには独自のオプションのヘッダーがあります。セクションは線の区切りで視覚的に区切られます。Google Chat アプリの例については、 カードのセクションを定義する。

enum (DividerStyle)

セクション間の分割線のスタイル。

object (CardAction)

カードの操作。アクションはカードのツールバー メニューに追加されます。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

たとえば、次の JSON は、カード アクション メニューを Settings および Send Feedback オプション:

"cardActions": [
  {
    "actionLabel": "Settings",
    "onClick": {
      "action": {
        "functionName": "goToView",
        "parameters": [
          {
            "key": "viewType",
            "value": "SETTING"
         }
        ],
        "loadIndicator": "LoadIndicator.SPINNER"
      }
    }
  },
  {
    "actionLabel": "Send Feedback",
    "onClick": {
      "openLink": {
        "url": "https://example.com/feedback"
      }
    }
  }
]

string

カードの名前。カード ナビゲーションでカード ID として使用されます。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

object (CardFixedFooter)

このカードの下部に表示される固定フッター。

primaryButton または secondaryButton を指定せずに fixedFooter を設定すると、エラーが発生します。チャットアプリでは、ダイアログで固定フッターを使用できますが、カード メッセージでは使用できません。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

enum (DisplayStyle)

Google Workspace アドオンで、 peekCardHeader。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

object (CardHeader)

コンテキスト コンテンツを表示する場合、ピークカードのヘッダーはプレースホルダとして機能するため、ユーザーはホームページ カードとコンテキスト カードの間を行き来できます。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

{
  "title": string,
  "subtitle": string,
  "imageType": enum (ImageType),
  "imageUrl": string,
  "imageAltText": string
}

string

必須。カードヘッダーのタイトル。ヘッダーの高さは固定されています。タイトルとサブタイトルの両方を指定すると、それぞれが 1 行になります。タイトルのみを指定する場合は、2 行に記述します。

string

カードヘッダーのサブタイトル。指定した場合、 title。

enum (ImageType)

画像の切り抜きに使用するシェイプ。

Google Chat アプリと Google Workspace アドオンで利用できます。

string

カード ヘッダーの画像の HTTPS URL。

string

ユーザー補助に使用されるこの画像の代替テキスト。

{
  "header": string,
  "widgets": [
    {
      object (Widget)
    }
  ],
  "collapsible": boolean,
  "uncollapsibleWidgetsCount": integer,
  "collapseControl": {
    object (CollapseControl)
  }
}

string

セクションの上部に表示されるテキスト。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定の詳細については、Google Chat アプリでのテキストの書式設定とGoogle Workspace アドオンでのテキストの書式設定をご覧ください。

object (Widget)

セクション内のすべてのウィジェット。ウィジェットを少なくとも 1 つ含める必要があります。

boolean

このセクションが折りたたみ可能かどうかを示します。

折りたたみ可能なセクションでは一部またはすべてのウィジェットが非表示になりますが、 もっと見るウィジェットを非表示にするには、 一部表示。

非表示のウィジェットを特定するには、次のように指定します。 uncollapsibleWidgetsCount。

integer

セクションを折りたたんだ状態でも表示されたままになる、折りたたみできないウィジェットの数です。

たとえば、セクションに 5 つのウィジェットがあり、 uncollapsibleWidgetsCount の設定 2 の場合、最初の 2 つのウィジェットは常に表示され、残りの 3 つのウィジェットはデフォルトでは折りたたまれています。「 uncollapsibleWidgetsCount 考慮されるのは collapsible true。

object (CollapseControl)

省略可。セクションの展開ボタンと折りたたみボタンを定義します。このボタンは、セクションが折りたたみ可能な場合にのみ表示されます。このフィールドが設定されていない場合は、デフォルトのボタンが使用されます。 Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

{
  "horizontalAlignment": enum (HorizontalAlignment),

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "divider": {
    object (Divider)
  },
  "grid": {
    object (Grid)
  },
  "columns": {
    object (Columns)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

enum (HorizontalAlignment)

ウィジェットを列の左、右、中央のいずれに配置するかを指定します。

object (TextParagraph)

テキスト パラグラフを表示します。シンプルな HTML 形式のテキストをサポートします。テキストの書式設定について詳しくは、このモジュールの Google Chat アプリでのテキストの書式設定 および Google Workspace アドオンでのテキストの書式設定。

たとえば、次の JSON は太字のテキストを作成します。

"textParagraph": {
  "text": "  <b>bold text</b>"
}

object (Image)

画像を表示します。

たとえば、次の JSON は代替テキストを含む画像を作成します。

"image": {
  "imageUrl":
  "https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png",
  "altText": "Chat app avatar"
}

object (DecoratedText)

装飾されたテキスト アイテムを表示します。

たとえば、次の JSON はメールアドレスを表示する装飾テキスト ウィジェットを作成します。

"decoratedText": {
  "icon": {
    "knownIcon": "EMAIL"
  },
  "topLabel": "Email Address",
  "text": "sasha@example.com",
  "bottomLabel": "This is a new Email address!",
  "switchControl": {
    "name": "has_send_welcome_email_to_sasha",
    "selected": false,
    "controlType": "CHECKBOX"
  }
}

object (ButtonList)

ボタンのリスト。

たとえば、次の JSON は 2 つのボタンを作成します。1 つ目は青色のテキストボタン、2 つ目はリンクを開く画像ボタンです。

"buttonList": {
  "buttons": [
    {
      "text": "Edit",
      "color": {
        "red": 0,
        "green": 0,
        "blue": 1,
      },
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

object (TextInput)

ユーザーが入力できるテキスト ボックスを表示します。

たとえば、次の JSON はメールアドレスのテキスト入力を作成します。

"textInput": {
  "name": "mailing_address",
  "label": "Mailing Address"
}

別の例として、次の JSON は静的な候補を使用してプログラミング言語のテキスト入力を作成します。

"textInput": {
  "name": "preferred_programing_language",
  "label": "Preferred Language",
  "initialSuggestions": {
    "items": [
      {
        "text": "C++"
      },
      {
        "text": "Java"
      },
      {
        "text": "JavaScript"
      },
      {
        "text": "Python"
      }
    ]
  }
}

object (SelectionInput)

ユーザーがアイテムを選択できる選択コントロールを表示します。選択コントロールには、チェックボックス、ラジオボタン、スイッチ、プルダウン メニューなどがあります。

たとえば、次の JSON は、ユーザーがサイズを選択できるプルダウン メニューを作成します。

"selectionInput": {
  "name": "size",
  "label": "Size"
  "type": "DROPDOWN",
  "items": [
    {
      "text": "S",
      "value": "small",
      "selected": false
    },
    {
      "text": "M",
      "value": "medium",
      "selected": true
    },
    {
      "text": "L",
      "value": "large",
      "selected": false
    },
    {
      "text": "XL",
      "value": "extra_large",
      "selected": false
    }
  ]
}

object (DateTimePicker)

ユーザーが日付、時刻、または日時を入力できるウィジェットを表示します。

たとえば、次の JSON は、予約をスケジュールする日時選択ツールを作成します。

"dateTimePicker": {
  "name": "appointment_time",
  "label": "Book your appointment at:",
  "type": "DATE_AND_TIME",
  "valueMsEpoch": "796435200000"
}

object (Divider)

ウィジェット間に水平の線分割を表示します。

たとえば、次の JSON は分割線を作成します。

"divider": {
}

object (Grid)

アイテムのコレクションを含むグリッドを表示します。

グリッドは、任意の数の列とアイテムをサポートします。行数は、アイテム数の上限を列数で割った値によって決まります。10 個のアイテムと 2 列のグリッドが 5 行あります。11 個のアイテムと 2 列のグリッドは 6 行あります。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

たとえば、次の JSON は、1 つのアイテムを含む 2 列のグリッドを作成します。

"grid": {
  "title": "A fine collection of items",
  "columnCount": 2,
  "borderStyle": {
    "type": "STROKE",
    "cornerRadius": 4
  },
  "items": [
    {
      "image": {
        "imageUri": "https://www.example.com/image.png",
        "cropStyle": {
          "type": "SQUARE"
        },
        "borderStyle": {
          "type": "STROKE"
        }
      },
      "title": "An item",
      "textAlignment": "CENTER"
    }
  ],
  "onClick": {
    "openLink": {
      "url": "https://www.example.com"
    }
  }
}

object (Columns)

最大 2 列を表示します。

3 つ以上の列を含める、または行を使用する場合は、 Grid 追加します。

たとえば、次の JSON は、それぞれテキスト段落を含む 2 つの列を作成します。

"columns": {
  "columnItems": [
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "First column text paragraph"
          }
        }
      ]
    },
    {
      "horizontalSizeStyle": "FILL_AVAILABLE_SPACE",
      "horizontalAlignment": "CENTER",
      "verticalAlignment": "CENTER",
      "widgets": [
        {
          "textParagraph": {
            "text": "Second column text paragraph"
          }
        }
      ]
    }
  ]
}

object (ChipList)

チップのリスト。

たとえば、次の JSON は 2 つのチップを作成します。1 つ目はテキストチップ、2 つ目はリンクを開くアイコンチップです。

"chipList": {
  "chips": [
    {
      "text": "Edit",
      "disabled": true,
    },
    {
      "icon": {
        "knownIcon": "INVITE",
        "altText": "check calendar"
      },
      "onClick": {
        "openLink": {
          "url": "https://example.com/calendar"
        }
      }
    }
  ]
}

Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

{
  "text": string,
  "maxLines": integer
}

string

ウィジェットに表示されるテキストです。

integer

ウィジェットに表示されるテキストの最大行数。テキストが指定された最大行数を超えると、余分なコンテンツは もっと見る ] ボタンを離します。テキストが指定された最大行数以下の場合は、 もっと見る ボタンは表示されません。

デフォルト値は 0 で、この場合、すべてのコンテキストが表示されます。負の値は無視されます。 Google Chat アプリで利用可能で、Google Workspace アドオンでは利用できません。

{
  "imageUrl": string,
  "onClick": {
    object (OnClick)
  },
  "altText": string
}

string

イメージをホストする HTTPS URL。

次に例を示します。

https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png

object (OnClick)

ユーザーが画像をクリックすると、この操作がトリガーされます。

string

ユーザー補助に使用されるこの画像の代替テキスト。

{

  // Union field data can be only one of the following:
  "action": {
    object (Action)
  },
  "openLink": {
    object (OpenLink)
  },
  "openDynamicLinkAction": {
    object (Action)
  },
  "card": {
    object (Card)
  },
  "overflowMenu": {
    object (OverflowMenu)
  }
  // End of list of possible types for union field data.
}

object (Action)

指定すると、この onClick によってアクションがトリガーされます。

object (OpenLink)

指定すると、この onClick リンクを開くアクションがトリガーされます。

object (Action)

リンクを開く必要がある場合は、アドオンによってこのアクションがトリガーされます。これは Pod の openLink リンクを取得するためにサーバーと通信する必要がある点に留意してください。そのため、リンクを開くアクション レスポンスが返される前に、ウェブクライアントが準備作業を行う必要があります。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

object (Card)

指定されている場合、クリックすると新しいカードがカードスタックにプッシュされます。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

object (OverflowMenu)

指定すると、この onClick でオーバーフロー メニューが開きます。 Google Chat アプリで利用可能で、Google Workspace アドオンでは利用できません。

{
  "function": string,
  "parameters": [
    {
      object (ActionParameter)
    }
  ],
  "loadIndicator": enum (LoadIndicator),
  "persistValues": boolean,
  "interaction": enum (Interaction),
  "requiredWidgets": [
    string
  ],
  "allWidgetsAreRequired": boolean
}

string

要素を含む要素がクリックされるかアクティブ化されたときに呼び出されるカスタム関数。

使用例については、以下をご覧ください。 フォームデータを読み取る。

object (ActionParameter)

アクション パラメータのリスト。

enum (LoadIndicator)

アクションの呼び出し中に表示される読み込みインジケーターを指定します。

boolean

アクション後にフォームの値を保持するかどうかを示します。デフォルト値は false。

条件 true の場合、アクションがトリガーされた後もフォームの値は保持されます。アクションの処理中にユーザーが変更できるようにするには、 LoadIndicator から NONE。対象 カード メッセージ 設定するには、アクションの設定も ResponseType から UPDATE_MESSAGE 同じものを使用します。 cardId そのアクションを含むカードから選択します。

条件 false の場合、アクションがトリガーされるとフォームの値がクリアされます。アクションの処理中にユーザーが変更できないようにするには、 LoadIndicator から SPINNER。

enum (Interaction)

省略可。ダイアログを開く場合に必須です。

ユーザーとのやり取り（カード メッセージのボタンのクリックなど）に対する応答内容。

指定しない場合、アプリは action （リンクを開く、関数を実行するなど）を通常どおりに行うことができます。

Pod の interaction: アプリは特別なインタラクティブな方法で応答できます。たとえば、 interaction から OPEN_DIALOG の場合、アプリは ダイアログで表示できます。指定すると、読み込みインジケーターは表示されません。アドオンに対して指定すると、カード全体が削除され、クライアントには何も表示されません。

Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

string

このアクションが呼び出されたときにここにリストされているウィジェットに値がない場合、フォームの送信は中止されます。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

boolean

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

{
  "key": string,
  "value": string
}

string

アクション スクリプトのパラメータの名前。

string

パラメータの値。

{
  "url": string,
  "openAs": enum (OpenAs),
  "onClose": enum (OnClose)
}

string

開く URL。

enum (OpenAs)

リンクの開き方。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

enum (OnClose)

クライアントがリンクを開いた後にリンクを忘れたか、ウィンドウが閉じるまでリンクを監視するか。

Google Workspace アドオンでは利用でき、Google Chat アプリでは利用できません。

{
  "items": [
    {
      object (OverflowMenuItem)
    }
  ]
}

object (OverflowMenuItem)

必須。メニュー オプションのリスト。

{
  "startIcon": {
    object (Icon)
  },
  "text": string,
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean
}

object (Icon)

テキストの前に表示されるアイコン。

string

必須。ユーザーが商品アイテムを識別または説明するテキスト。

object (OnClick)

必須。メニュー オプションが選択されたときに呼び出されるアクション。この OnClick 次を含むことはできません OverflowMenu（任意の指定） OverflowMenu メニュー項目が無効化されます。

boolean

メニュー オプションを無効にするかどうか。デフォルトは false です。

{
  "altText": string,
  "imageType": enum (ImageType),

  // Union field icons can be only one of the following:
  "knownIcon": string,
  "iconUrl": string,
  "materialIcon": {
    object (MaterialIcon)
  }
  // End of list of possible types for union field icons.
}

string

省略可。ユーザー補助機能に使用されるアイコンの説明。指定しない場合、デフォルト値 Button 提供されます。ベスト プラクティスとして、アイコンに表示される内容と、アイコンで表示される内容（該当する場合）についてわかりやすい説明を記述することをおすすめします。たとえば A user's account portrait、または Opens a new browser tab and navigates to the Google Chat developer documentation at https://developers.google.com/workspace/chat。

アイコンが Button、 altText ユーザーがボタンにカーソルを合わせると、ヘルパー テキストとして表示されます。ただし、ボタンで text も設定されている場合、アイコンの altText は無視されます。

enum (ImageType)

画像に適用された切り抜きスタイル。場合によっては CIRCLE 切り抜きを使用すると、画像が組み込みのアイコンよりも大きく描画されます。

string

Google Workspace が提供する組み込みアイコンのいずれかを表示します。

たとえば、飛行機のアイコンを表示するには、AIRPLANE を指定します。バスの場合は、 BUS。

サポートされているアイコンの全一覧については、 組み込みのアイコン。

string

HTTPS URL でホストされるカスタム アイコンを表示します。

次に例を示します。

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

サポートされているファイル形式は次のとおりです。 .png および .jpg。

object (MaterialIcon)

次のいずれかを表示 Google マテリアル アイコン。

たとえば、 チェックボックス アイコンを使用する場合は、

"materialIcon": {
  "name": "check_box"
}

Google Chat アプリで利用可能で、Google Workspace アドオンでは利用できません。

{
  "name": string,
  "fill": boolean,
  "weight": integer,
  "grade": integer
}

string

アイコンの名前が Google マテリアル アイコンなど check_box。無効な名前は破棄されて空の文字列に置き換えられるため、アイコンのレンダリングに失敗します。

boolean

アイコンを塗りつぶしとしてレンダリングするかどうか。デフォルト値は false です。

さまざまなアイコン設定をプレビューするには、 Google フォント アイコン [設定]で カスタマイズ:

integer

アイコンのストロークの太さ。{100, 200, 300, 400, 500, 600, 700} から選択します。指定しない場合、デフォルト値は 400 です。他の値を指定した場合は、デフォルト値が使用されます。

さまざまなアイコン設定をプレビューするには、 Google フォント アイコン [設定]で カスタマイズ:

integer

重量とグレードはシンボルの太さに影響します。グレードの調整は、重みの調整よりも細かく、記号のサイズに小さな影響を及ぼします。{-25、0、200} から選択します。指定しない場合、デフォルト値は 0 です。他の値が指定されている場合は、デフォルト値が使用されます。

さまざまなアイコン設定をプレビューするには、 Google フォント アイコン [設定]で カスタマイズ:

{
  "icon": {
    object (Icon)
  },
  "startIcon": {
    object (Icon)
  },
  "topLabel": string,
  "text": string,
  "wrapText": boolean,
  "bottomLabel": string,
  "onClick": {
    object (OnClick)
  },

  // Union field control can be only one of the following:
  "button": {
    object (Button)
  },
  "switchControl": {
    object (SwitchControl)
  },
  "endIcon": {
    object (Icon)
  }
  // End of list of possible types for union field control.
}

object (Icon)

廃止により廃止 startIcon。

object (Icon)

テキストの前に表示されるアイコン。

string

上に表示されるテキスト text。常に切り捨てられます。

string

必須。プライマリ テキスト。

シンプルな書式をサポートします。テキストの書式設定について詳しくは、このモジュールの Google Chat アプリでのテキストの書式設定 および Google Workspace アドオンでのテキストの書式設定。

boolean

テキストの折り返しの設定。条件 true の場合、テキストは折り返されて複数行に表示されます。それ以外の場合、テキストは切り捨てられます。

適用対象 text、次を含まない topLabel および bottomLabel。

string

その下に表示されるテキストは text。常に折り返します。

object (OnClick)

この操作は、ユーザーが広告をクリックして topLabel または bottomLabel。

object (Button)

ユーザーがクリックしてアクションをトリガーできるボタン。

object (SwitchControl)

ユーザーがクリックして状態を変更し、アクションをトリガーできる切り替えウィジェット。

object (Icon)

テキストの後に表示されるアイコン。

サポート 組み込み および カスタム 追加できます。

{
  "text": string,
  "icon": {
    object (Icon)
  },
  "color": {
    object (Color)
  },
  "onClick": {
    object (OnClick)
  },
  "disabled": boolean,
  "altText": string,
  "type": enum (Type)
}

string

ボタン内に表示されるテキスト。

object (Icon)

ボタン内に表示されるアイコン。icon と text の両方を設定すると、テキストの前にアイコンが表示されます。

object (Color)

省略可。ボタンの色。設定すると、このボタンは type の設定 FILLED 色は text および icon 見やすくするために、各フィールドは識別しやすい色に設定されています。たとえば、ボタンの色を青に設定している場合、ボタン内のテキストやアイコンはすべて白に設定されます。

ボタンの色を設定するには、 red, green blue 表示されます。この値は、RGB カラー値に基づく 0 ～ 1 の浮動小数点数にする必要があります。 0 （0/255）は無色を表し、 1 (255/255) は色の最大強度を表します。

たとえば、次の例では、最大強度で色を赤に設定しています。

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

ボタンの色には alpha フィールドを使用できません。指定すると、このフィールドは無視されます。

object (OnClick)

必須。ハイパーリンクを開く、カスタム関数を実行するなど、ユーザーがボタンをクリックしたときに実行するアクション。

boolean

条件 true: ボタンは非アクティブな状態で表示され、ユーザーの操作に反応しません。

string

ユーザー補助に使用される代替テキスト。

ボタンの役割をユーザーに示す説明テキストを設定します。たとえば、ボタンでハイパーリンクが開く場合、次のように記述します。「新しいブラウザタブを開き、次の場所にある Google Chat デベロッパー向けドキュメントに移動 https://developers.google.com/workspace/chat".

enum (Type)

省略可。ボタンのタイプ。未設定の場合、ボタンのタイプはデフォルトで OUTLINED。もし color フィールドが設定されている場合、ボタンの型は FILLED このフィールドに設定された値はすべて無視されます。

Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

{
  "red": number,
  "green": number,
  "blue": number,
  "alpha": number
}

number

色の赤の量を [0, 1] の範囲内の値として表します。

number

カラーの緑色の量。区間 [0, 1] 内の値として示されます。

number

カラーの青色の量。[0, 1] の範囲内の値として示されます。

number

ピクセルに適用する必要があるこのカラーの割合。つまり、最終的なピクセル色は次の式で定義されます。

pixel color = alpha * (this color) + (1.0 - alpha) * (background color)

つまり、値 1.0 はソリッドカラーに相当し、値 0.0 は透明色に相当します。これは、単純な浮動小数点スカラーではなくラッパー メッセージを使用します。これにより、デフォルト値が設定されたのか未設定値だったのかを区別できます。省略すると、このカラー オブジェクトはソリッド カラーとしてレンダリングされます（アルファ値を明示的に 1.0 に設定した場合と同様です）。

{
  "name": string,
  "value": string,
  "selected": boolean,
  "onChangeAction": {
    object (Action)
  },
  "controlType": enum (ControlType)
}

string

フォーム入力イベントでスイッチ ウィジェットが識別される名前。

フォーム入力の操作について詳しくは、以下をご覧ください。 フォームデータの受信。

string

ユーザーが入力した値。フォーム入力イベントの一部として返されます。

フォーム入力の操作について詳しくは、以下をご覧ください。 フォームデータの受信。

boolean

日時 true の場合、スイッチは選択されています。

object (Action)

実行する関数など、切り替え状態が変更されたときに実行するアクション。

enum (ControlType)

ユーザー インターフェースにスイッチがどのように表示されるか。

Google Chat アプリと Google Workspace アドオンで利用できます。

{
  "buttons": [
    {
      object (Button)
    }
  ]
}

object (Button)

ボタンの配列。

{
  "name": string,
  "label": string,
  "hintText": string,
  "value": string,
  "type": enum (Type),
  "onChangeAction": {
    object (Action)
  },
  "initialSuggestions": {
    object (Suggestions)
  },
  "autoCompleteAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  },
  "placeholderText": string
}

string

フォーム入力イベントでテキスト入力を識別するための名前。

フォーム入力の操作について詳しくは、以下をご覧ください。 フォームデータの受信。

string

ユーザー インターフェースのテキスト入力フィールドの上に表示されるテキスト。

アプリに必要な情報をユーザーが入力できるように、テキストを指定します。たとえば、誰かの名前を尋ねるが、特に姓が必要とされる場合は、次のように記述します。 surname 、 name。

次の場合は必須 hintText は指定されていません。それ以外の場合は任意です。

string

テキスト入力フィールドの下に表示されるテキストで、ユーザーに特定の値を入力するよう促すために使用します。このテキストは常に表示されます。

label が指定されていない場合は必須です。それ以外の場合は任意です。

string

ユーザーが入力した値。フォーム入力イベントの一部として返されます。

フォーム入力の操作について詳しくは、以下をご覧ください。 フォームデータの受信。

enum (Type)

テキスト入力フィールドがユーザー インターフェースにどのように表示されるか。たとえば、フィールドが 1 行か複数行かを示します。

object (Action)

テキスト入力フィールドの変化があった場合の処理方法。（フィールドへの追加やテキストの削除など）。

実行するアクションの例としては、カスタム関数の実行や、Google Chat でダイアログを開くなどがあります。

object (Suggestions)

ユーザーが入力できる候補値。これらの値は、ユーザーがテキスト入力フィールドをクリックすると表示されます。ユーザーの入力に応じて、ユーザーの入力内容に合わせて候補の値が動的にフィルタリングされます。

たとえば、プログラミング言語のテキスト入力フィールドでは、Java、JavaScript、Python、C++ などが候補として表示されます。ユーザーが入力を開始したとき Jav、表示する候補フィルタのリスト Java および JavaScript。

候補値により、アプリが理解できる値をユーザーが入力しやすくなります。JavaScript について言及する場合、 javascript など java script。JavaScript を提案することで、ユーザーがアプリを操作する方法を標準化できます。

指定すると、 TextInput.type 常に SINGLE_LINE（以下の設定の場合も同様） MULTIPLE_LINE。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

object (Action)

省略可。テキスト入力フィールドを操作するユーザーに候補が提示されたときに実行するアクションを指定します。

指定しない場合、候補は initialSuggestions クライアントによって処理されます

指定すると、ここで指定したアクション（カスタム関数の実行など）が実行されます。

Google Workspace アドオンで利用可能で、Google Chat アプリでは利用できません。

object (Validation)

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

string

テキスト入力フィールドが空の場合に表示されるテキスト。このテキストを使用して、ユーザーに値の入力を促します。たとえば Enter a number from 0 to 100。

Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

Action

Navigation

表示されたカードのプッシュまたは更新を行います。

Card

カードスタックは、カードをカードスタックにプッシュします。

Card

カードスタックでは、一番上のカードが新しいカードで更新され、入力されたフォーム フィールドの値が保持されます。同等でないフィールドの場合、値は破棄されます。

{
  "items": [
    {
      object (SuggestionItem)
    }
  ]
}

object (SuggestionItem)

テキスト入力フィールドのオートコンプリート候補に使用される候補のリスト。

{

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}

string

テキスト入力フィールドへの入力候補の値。ユーザーが自分で入力した値と同じです。

{
  "characterLimit": integer,
  "inputType": enum (InputType)
}

integer

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

enum (InputType)

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

{
  "name": string,
  "label": string,
  "type": enum (SelectionType),
  "items": [
    {
      object (SelectionItem)
    }
  ],
  "onChangeAction": {
    object (Action)
  },
  "multiSelectMaxSelectedItems": integer,
  "multiSelectMinQueryLength": integer,
  "validation": {
    object (Validation)
  },

  // Union field multi_select_data_source can be only one of the following:
  "externalDataSource": {
    object (Action)
  },
  "platformDataSource": {
    object (PlatformDataSource)
  }
  // End of list of possible types for union field multi_select_data_source.
}

string

必須。フォーム入力イベント内の選択入力を識別する名前。

フォーム入力の操作について詳しくは、以下をご覧ください。 フォームデータの受信。

string

ユーザー インターフェースの選択入力フィールドの上に表示されるテキスト。

アプリに必要な情報を入力するのに役立つテキストを指定します。たとえば、ユーザーがプルダウン メニューから作業チケットの緊急度を選択する場合、ラベルは「緊急度」になります。または [緊急度を選択]を選択します

enum (SelectionType)

フォーマットでユーザーに表示されるアイテムのタイプ SelectionInput 追加します。選択タイプは、さまざまなタイプの操作に対応しています。たとえば、ユーザーは 1 つ以上のチェックボックスを選択できますが、プルダウン メニューから選択できるのは 1 つの値のみです。

object (SelectionItem)

選択可能な項目の配列。たとえば、ラジオボタンやチェックボックスの配列です。最大 100 個のアイテムをサポートします。

object (Action)

指定すると、選択が変更されたときにフォームが送信されます。指定しない場合は、フォームを送信する個別のボタンを指定する必要があります。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

integer

複数選択メニューの場合、ユーザーが選択できる項目の最大数。最小値は 1 アイテムです。指定しない場合のデフォルトは 3 項目です。

integer

複数選択メニューの場合、アプリがクエリする前にユーザーが入力したテキスト文字数が予測入力され、メニューの候補アイテムが表示されます。

指定しない場合のデフォルトは、静的データソースでは 0 文字、外部データソースでは 3 文字です。

object (Validation)

プルダウン メニューの場合、この選択入力フィールドの検証。

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

object (Action)

リレーショナル データベースなどの外部データソース。

object (PlatformDataSource)

Google Workspace のデータソース。

{
  "text": string,
  "value": string,
  "selected": boolean,
  "startIconUri": string,
  "bottomText": string
}

string

ユーザーが商品アイテムを識別または説明するテキスト。

string

このアイテムに関連付けられた値。クライアントはこれをフォームの入力値として使用する必要があります。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

boolean

アイテムがデフォルトで選択されるかどうか。選択入力で 1 つの値のみが許可される場合（ラジオボタンやプルダウン メニューなど）、このフィールドは 1 つの項目にのみ設定します。

string

複数選択メニューの場合、アイテムの text フィールドの横に表示されるアイコンの URL。PNG ファイルと JPEG ファイルをサポートします。HTTPS URL にする必要があります。たとえば https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png。

string

複数選択メニューの場合、アイテムの text フィールドの下に表示されるテキストの説明またはラベル。

{

  // Union field data_source can be only one of the following:
  "commonDataSource": enum (CommonDataSource),
  "hostAppDataSource": {
    object (HostAppDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

enum (CommonDataSource)

Google Workspace 組織内のユーザーなど、すべての Google Workspace アプリケーションで共有されるデータソース。

object (HostAppDataSourceMarkup)

Google Workspace ホスト アプリケーションに固有のデータソース（Google Chat のスペースなど）。

このフィールドは Google API クライアント ライブラリをサポートしていますが、Cloud クライアント ライブラリでは使用できません。詳しくは、 クライアント ライブラリをインストールします。

{

  // Union field data_source can be only one of the following:
  "chatDataSource": {
    object (ChatClientDataSourceMarkup)
  }
  // End of list of possible types for union field data_source.
}

object (ChatClientDataSourceMarkup)

Google Chat のデータソース。

{

  // Union field source can be only one of the following:
  "spaceDataSource": {
    object (SpaceDataSource)
  }
  // End of list of possible types for union field source.
}

object (SpaceDataSource)

ユーザーがメンバーである Google Chat スペース。

{
  "defaultToCurrentSpace": boolean
}

boolean

「 true の場合、複数選択メニューでは、デフォルトで現在の Google Chat スペースがアイテムとして選択されます。

{
  "name": string,
  "label": string,
  "type": enum (DateTimePickerType),
  "valueMsEpoch": string,
  "timezoneOffsetDate": integer,
  "onChangeAction": {
    object (Action)
  },
  "validation": {
    object (Validation)
  }
}

string

ファイアウォール ルールで DateTimePicker フォーム入力イベントで識別されます。

フォーム入力の操作の詳細については、フォームデータを受け取るをご覧ください。

string

日付、時刻、または日時の入力をユーザーに促すテキスト。たとえば、ユーザーが予約をスケジュールしている場合は、 Appointment date または Appointment date and time。

enum (DateTimePickerType)

ウィジェットが日付、時刻、または日時の入力をサポートしているかどうか。

string (int64 format)

ウィジェットに表示されるデフォルト値（ Unix エポック時刻。

選択ツールのタイプ（ DateTimePickerType）:

• DATE_AND_TIME : カレンダーの日時（UTC）。たとえば、2023 年 1 月 1 日午後 12 時（UTC）を表すには、次のコマンドを使用します。 1672574400000。
• DATE_ONLY : UTC 00:00:00 のカレンダーの日付。たとえば、2023 年 1 月 1 日を表すには、 1672531200000。
• TIME_ONLY : UTC の時刻。たとえば、午後 12 時を示すには、43200000（または 12 * 60 * 60 * 1000）を使用します。

integer

UTC からのタイムゾーン オフセットを表す数値（分単位）。設定すると、 valueMsEpoch 指定したタイムゾーンで表示されます。設定しない場合、値はデフォルトでユーザーのタイムゾーン設定になります。

object (Action)

ユーザーがクリックするとトリガーされます 保存 または クリア 取得 DateTimePicker 行うことができます。

object (Validation)

Google Chat アプリと Google Workspace アドオンでご利用いただけます。

{
  "title": string,
  "items": [
    {
      object (GridItem)
    }
  ],
  "borderStyle": {
    object (BorderStyle)
  },
  "columnCount": integer,
  "onClick": {
    object (OnClick)
  }
}

string

グリッドのヘッダーに表示されるテキスト。

object (GridItem)

グリッドに表示するアイテム。

object (BorderStyle)

各グリッド アイテムに適用する枠線のスタイル。

integer

グリッドに表示する列の数。このフィールドが指定されていない場合はデフォルト値が使用されます。デフォルト値は、グリッドが表示される場所（ダイアログまたはコンパニオン）によって異なります。

object (OnClick)

このコールバックは個々のグリッド アイテムで再利用されますが、コールバックのパラメータにはアイテムリスト内のアイテムの識別子とインデックスが追加されます。

{
  "id": string,
  "image": {
    object (ImageComponent)
  },
  "title": string,
  "subtitle": string,
  "layout": enum (GridItemLayout)
}

string

このグリッド アイテムのユーザー指定の識別子。この ID は、親グリッドの onClick コールバック パラメータで返されます。

object (ImageComponent)

グリッド アイテムに表示される画像。

string

グリッドアイテムのタイトル。

string

グリッド アイテムのサブタイトル。

enum (GridItemLayout)

グリッド アイテムに使用するレイアウト。

{
  "imageUri": string,
  "altText": string,
  "cropStyle": {
    object (ImageCropStyle)
  },
  "borderStyle": {
    object (BorderStyle)
  }
}

string

画像の URL。

string

画像のユーザー補助ラベル。

object (ImageCropStyle)

画像に適用する切り抜きスタイル。

object (BorderStyle)

画像に適用する枠線のスタイル。

{
  "type": enum (ImageCropType),
  "aspectRatio": number
}

enum (ImageCropType)

切り抜きタイプ。

number

切り抜きタイプが RECTANGLE_CUSTOM。

たとえば、アスペクト比 16:9 を適用する方法は次のとおりです。

cropStyle {
 "type": "RECTANGLE_CUSTOM",
 "aspectRatio": 16/9
}

{
  "type": enum (BorderType),
  "strokeColor": {
    object (Color)
  },
  "cornerRadius": integer
}

enum (BorderType)

枠線の種類。

object (Color)

タイプが BORDER_TYPE_STROKE。

ストロークの色を設定するには、 red, green blue 表示されます。この値は、RGB カラー値に基づく 0 ～ 1 の浮動小数点数にする必要があります。 0 （0/255）は無色を表し、 1 (255/255) は色の最大強度を表します。

たとえば、次のコードは、最大強度の赤色に設定します。

"color": {
   "red": 1,
   "green": 0,
   "blue": 0,
}

alpha フィールドはストローク色では使用できません。指定すると、このフィールドは無視されます。

integer

枠線の角の半径です。

{
  "columnItems": [
    {
      object (Column)
    }
  ]
}

object (Column)

列の配列。カードまたはダイアログには最大 2 列を含めることができます。

{
  "horizontalSizeStyle": enum (HorizontalSizeStyle),
  "horizontalAlignment": enum (HorizontalAlignment),
  "verticalAlignment": enum (VerticalAlignment),
  "widgets": [
    {
      object (Widgets)
    }
  ]
}

enum (HorizontalSizeStyle)

カードの幅を列で埋める方法を指定します。

enum (HorizontalAlignment)

ウィジェットの配置を、左、右、中央のいずれにするかを指定します。

enum (VerticalAlignment)

ウィジェットの配置を、列の上部、下部、中央のいずれにするかを指定します。

object (Widgets)

列に含まれるウィジェットの配列。ウィジェットは、指定された順序で表示されます。

{

  // Union field data can be only one of the following:
  "textParagraph": {
    object (TextParagraph)
  },
  "image": {
    object (Image)
  },
  "decoratedText": {
    object (DecoratedText)
  },
  "buttonList": {
    object (ButtonList)
  },
  "textInput": {
    object (TextInput)
  },
  "selectionInput": {
    object (SelectionInput)
  },
  "dateTimePicker": {
    object (DateTimePicker)
  },
  "chipList": {
    object (ChipList)
  }
  // End of list of possible types for union field data.
}

object (TextParagraph)

TextParagraph 追加します。

object (Image)

Image 追加します。

object (DecoratedText)

DecoratedText 追加します。

object (ButtonList)

ButtonList 追加します。

object (TextInput)

TextInput ウィジェットです。

object (SelectionInput)

SelectionInput ウィジェットです。

object (DateTimePicker)

DateTimePicker 追加します。

object (ChipList)

ChipList ウィジェットです。 Google Chat アプリで利用でき、Google Workspace アドオンでは利用できません。

{
  "layout": enum (Layout),
  "chips": [
    {
      object (Chip)
    }
  ]
}

enum (Layout)

指定されたチップリストのレイアウト。

object (Chip)

チップの配列。

{
  "icon": {
    object (Icon)
  },
  "label": string,
  "onClick": {
    object (OnClick)
  },
  "enabled": boolean,
  "disabled": boolean,
  "altText": string
}

object (Icon)

アイコン画像。icon と text の両方を設定すると、テキストの前にアイコンが表示されます。

string

チップ内に表示されるテキスト。

object (OnClick)

省略可。ハイパーリンクを開く、カスタム関数を実行するなど、ユーザーがチップをクリックしたときに実行するアクション。

boolean

チップがアクティブ状態にあり、ユーザーの操作に応答するかどうか。デフォルトは true。非推奨です。代わりに disabled を使用してください。

boolean

チップが非アクティブな状態にあり、ユーザーの操作を無視するかどうか。デフォルトは false。

string

ユーザー補助に使用される代替テキスト。

チップの機能をユーザーに示す説明テキストを設定します。たとえば、チップでハイパーリンクが開く場合は、「新しいブラウザタブを開き、次の場所にある Google Chat デベロッパー向けドキュメントに移動します。 https://developers.google.com/workspace/chat".

{
  "horizontalAlignment": enum (HorizontalAlignment),
  "expandButton": {
    object (Button)
  },
  "collapseButton": {
    object (Button)
  }
}

enum (HorizontalAlignment)

展開ボタンと折りたたみボタンの水平方向の配置。

object (Button)

省略可。セクションを展開するカスタマイズ可能なボタンを定義します。expandButton フィールドと collapseButton フィールドの両方を設定する必要があります。1 つのフィールド セットのみが有効になりません。このフィールドが設定されていない場合は、デフォルトのボタンが使用されます。

object (Button)

省略可。セクションを閉じるカスタマイズ可能なボタンを定義します。ExpandButton フィールドと expandButton フィールドの両方を設定する必要があります。1 つのフィールド セットのみが有効になりません。このフィールドが設定されていない場合は、デフォルトのボタンが使用されます。

{
  "actionLabel": string,
  "onClick": {
    object (OnClick)
  }
}

string

操作メニュー項目として表示されるラベル。

object (OnClick)

このアクション アイテムの onClick アクション。

{
  "primaryButton": {
    object (Button)
  },
  "secondaryButton": {
    object (Button)
  }
}

object (Button)

固定フッターのメインボタン。ボタンは、テキストと色が設定されたテキストボタンであること。

object (Button)

固定フッターのサブボタン。ボタンは、テキストと色が設定されたテキストボタンであること。条件 secondaryButton 次の値も設定する必要があります。 primaryButton。