> For the complete documentation index, see [llms.txt](https://help.genser.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.genser.ai/ja/developers/action-data/api-references/jian-suo-search.md).

# 検索 (Search)

検索関連のユーザー行動収集API

## 検索送信

> 検索送信収集API

```json
{"openapi":"3.1.0","info":{"title":"Gelatto イベント収集API（基本）","version":"1.0.0"},"tags":[{"name":"検索 (Search)","description":"検索関連のユーザー行動収集API"}],"servers":[{"url":"https://api.gelatto.ai","description":"Production"},{"url":"https://api-dev.gelatto.ai","description":"Development"},{"url":"http://localhost","description":"Local Development (ポート80)"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"APIキー"}},"schemas":{"ActionsSearchSubmittedEvent":{"title":"検索送信","description":"ユーザーが検索キーワードを送信する行動を収集します","type":"object","required":["time","source","data"],"properties":{"specversion":{"type":"string","description":"仕様バージョン","enum":["1.0.0"]},"id":{"type":"string","description":"イベントの一意識別子","enum":["EVT-SEARCH-SUBMITTED"]},"type":{"type":"string","description":"イベントタイプ","enum":["search_submitted"]},"time":{"type":"string","description":"ISO 8601 UTC イベント作成時刻","format":"date-time"},"source":{"type":"string","description":"イベント発生元"},"datacontenttype":{"type":"string","description":"データコンテンツタイプ","enum":["application/ld+json"]},"dataschema":{"type":"string","description":"データスキーマパス","enum":["https://api.gelatto.ai/schema/actions/search_submitted.json"]},"data":{"type":"object","description":"イベントデータオブジェクト","required":["agent","query"],"properties":{"@context":{"type":"string","description":"スキーマコンテキスト","enum":["https://schema.org/"]},"@type":{"type":"string","description":"アクションタイプ","enum":["SearchAction"]},"agent":{"type":"object","description":"実行者（Person）","required":["identifier"],"properties":{"@type":{"type":"string","enum":["Person"]},"identifier":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"type":"string","description":"値"}}},"type":"array","description":"実行者識別子リスト（userId、memberId、cookieIdは必須で追加する必要があります。属性の追加が必要な場合は協議）"},"gender":{"type":"string","enum":["Female","Male","https://schema.org/Female","https://schema.org/Male"]},"additionalProperty":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"値"}}},"type":"array","description":"追加属性"}}},"query":{"type":"string","description":"検索クエリ"},"object":{"type":"object","description":"対象オブジェクト","required":["actionOption"],"properties":{"@type":{"type":"string","enum":["Thing"]},"actionOption":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"値"}}},"type":"array","description":"アクションオプション"}}},"target":{"type":"object","description":"エンドポイント情報","required":["urlTemplate"],"properties":{"@type":{"type":"string","enum":["EntryPoint"]},"urlTemplate":{"type":"string","description":"URL"}}}}}}}}},"paths":{"/actions/search/submitted":{"post":{"summary":"検索送信","description":"検索送信収集API","operationId":"collectSearchSubmitted","tags":["検索 (Search)"],"parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","enum":["application/json"]},"description":"コンテンツタイプ"},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","format":"uuid"},"description":"べき等性キー - クライアントが呼び出し時に渡す必要があります（UUID）"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionsSearchSubmittedEvent"}}}},"responses":{"200":{"description":"収集成功"},"400":{"description":"不正なリクエスト"},"503":{"description":"一時的にサービスを利用できません"}}}}}}
```

## 検索結果表示

> 検索結果収集API

```json
{"openapi":"3.1.0","info":{"title":"Gelatto イベント収集API（基本）","version":"1.0.0"},"tags":[{"name":"検索 (Search)","description":"検索関連のユーザー行動収集API"}],"servers":[{"url":"https://api.gelatto.ai","description":"Production"},{"url":"https://api-dev.gelatto.ai","description":"Development"},{"url":"http://localhost","description":"Local Development (ポート80)"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"APIキー"}},"schemas":{"ActionsSearchResultEvent":{"title":"検索結果表示","description":"ユーザーに検索結果が表示される行動を収集します","type":"object","required":["time","source","data"],"properties":{"specversion":{"type":"string","description":"仕様バージョン","enum":["1.0.0"]},"id":{"type":"string","description":"イベントの一意識別子","enum":["EVT-VIEW-SEARCH-RESULT"]},"type":{"type":"string","description":"イベントタイプ","enum":["view_search_result"]},"time":{"type":"string","description":"ISO 8601 UTC イベント作成時刻","format":"date-time"},"source":{"type":"string","description":"イベント発生元"},"datacontenttype":{"type":"string","description":"データコンテンツタイプ","enum":["application/ld+json"]},"dataschema":{"type":"string","description":"データスキーマパス","enum":["https://api.gelatto.ai/schema/actions/search_result.json"]},"data":{"type":"object","description":"イベントデータオブジェクト","required":["agent","object"],"properties":{"@context":{"type":"string","description":"スキーマコンテキスト","enum":["https://schema.org/"]},"@type":{"type":"string","description":"アクションタイプ","enum":["ViewAction"]},"agent":{"type":"object","description":"実行者（Person）","required":["identifier"],"properties":{"@type":{"type":"string","enum":["Person"]},"identifier":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"type":"string","description":"値"}}},"type":"array","description":"実行者識別子リスト（userId、memberId、cookieIdは必須で追加する必要があります。属性の追加が必要な場合は協議）"},"gender":{"type":"string","enum":["Female","Male","https://schema.org/Female","https://schema.org/Male"]},"additionalProperty":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"値"}}},"type":"array","description":"追加属性"}}},"object":{"$ref":"#/components/schemas/ActionsSearchResultItemList"},"target":{"type":"object","description":"エンドポイント情報","required":["urlTemplate"],"properties":{"@type":{"type":"string","enum":["EntryPoint"]},"urlTemplate":{"type":"string","description":"URL"}}}}}}},"ActionsSearchResultItemList":{"description":"商品リストオブジェクト","type":"object","required":["numberOfItems","itemListElement"],"properties":{"@type":{"type":"string","enum":["ItemList"]},"numberOfItems":{"type":"number","description":"検索結果の総件数"},"itemListElement":{"oneOf":[{"$ref":"#/components/schemas/ActionsSearchResultListItem"},{"type":"array","items":{"$ref":"#/components/schemas/ActionsSearchResultListItem"}}]}}},"ActionsSearchResultListItem":{"description":"商品リスト項目","type":"object","required":["position","item"],"properties":{"@type":{"type":"string","enum":["ListItem"]},"item":{"$ref":"#/components/schemas/ActionsSearchResultProduct"},"position":{"type":"number","description":"リスト内の表示順"}}},"ActionsSearchResultProduct":{"description":"商品オブジェクト","type":"object","required":["sku"],"properties":{"@type":{"type":"string","enum":["Product"]},"sku":{"type":"string","description":"商品一意識別子、商品コード（SKU）"},"name":{"description":"商品名","oneOf":[{"description":"単純文字列","type":"string"},{"description":"多言語オブジェクト","type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}},{"description":"多言語配列","type":"array","items":{"type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}}}]}}}}},"paths":{"/actions/search/result":{"post":{"summary":"検索結果表示","description":"検索結果収集API","operationId":"collectSearchResult","tags":["検索 (Search)"],"parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","enum":["application/json"]},"description":"コンテンツタイプ"},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","format":"uuid"},"description":"べき等性キー - クライアントが呼び出し時に渡す必要があります（UUID）"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionsSearchResultEvent"}}}},"responses":{"200":{"description":"収集成功"},"400":{"description":"不正なリクエスト"},"503":{"description":"一時的にサービスを利用できません"}}}}}}
```