検索 (Search)

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

検索送信

post

/actions/search/submitted

検索送信収集API

Authorizations

Api-KeystringRequired

APIキー

Header parameters

Content-Typestring · enumRequired

コンテンツタイプ

Possible values:

Idempotency-Keystring · uuidRequired

べき等性キー - クライアントが呼び出し時に渡す必要があります（UUID）

Body

ユーザーが検索キーワードを送信する行動を収集します

specversionstring · enumOptional

仕様バージョン

Possible values:

idstring · enumOptional

イベントの一意識別子

Possible values:

typestring · enumOptional

イベントタイプ

Possible values:

timestring · date-timeRequired

ISO 8601 UTC イベント作成時刻

sourcestringRequired

イベント発生元

datacontenttypestring · enumOptional

データコンテンツタイプ

Possible values:

dataschemastring · enumOptional

データスキーマパス

Possible values:

Responses

200

収集成功

No content

400

不正なリクエスト

503

一時的にサービスを利用できません

post/actions/search/submitted

POST /actions/search/submitted HTTP/1.1
Host: api.gelatto.ai
Api-Key: YOUR_API_KEY
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 1316

{
  "specversion": "1.0.0",
  "id": "EVT-SEARCH-SUBMITTED",
  "type": "search_submitted",
  "time": "2025-11-28T10:00:00Z",
  "source": "https://shop.groobee.com",
  "datacontenttype": "application/ld+json",
  "dataschema": "https://api.gelatto.ai/schema/actions/search_submitted.json",
  "data": {
    "@context": "https://schema.org/",
    "@type": "SearchAction",
    "agent": {
      "@type": "Person",
      "identifier": [
        {
          "@type": "PropertyValue",
          "propertyID": "memberId",
          "value": "groobee1234"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "userId",
          "value": "2aa9a562-4182-4c59-b886-2be9d2a36b23"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "cookieId",
          "value": "bb404573-c87f-b4b1-d6e7-f2750499bf06"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "sessionId",
          "value": "8f9d2a6c-4e1b-4b2a-a9e1-7f6d5c4b3a21"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "deviceCode",
          "value": "PC"
        }
      ],
      "gender": "Female",
      "additionalProperty": [
        {
          "@type": "PropertyValue",
          "propertyID": "type",
          "value": "NORMAL"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "grade",
          "value": "VIP"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "age",
          "value": 18
        }
      ]
    },
    "query": "ナイキ エアジョーダン",
    "object": {
      "@type": "Thing",
      "actionOption": [
        {
          "@type": "PropertyValue",
          "propertyID": "search_type",
          "value": "AI"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "color",
          "value": "黒"
        }
      ]
    },
    "target": {
      "@type": "EntryPoint",
      "urlTemplate": "https://shop.groobee.com/search?color=黒"
    }
  }
}

No content

検索結果表示

post

/actions/search/result

検索結果収集API

Authorizations

Api-KeystringRequired

APIキー

Header parameters

Content-Typestring · enumRequired

コンテンツタイプ

Possible values:

Idempotency-Keystring · uuidRequired

べき等性キー - クライアントが呼び出し時に渡す必要があります（UUID）

Body

ユーザーに検索結果が表示される行動を収集します

specversionstring · enumOptional

仕様バージョン

Possible values:

idstring · enumOptional

イベントの一意識別子

Possible values:

typestring · enumOptional

イベントタイプ

Possible values:

timestring · date-timeRequired

ISO 8601 UTC イベント作成時刻

sourcestringRequired

イベント発生元

datacontenttypestring · enumOptional

データコンテンツタイプ

Possible values:

dataschemastring · enumOptional

データスキーマパス

Possible values:

Responses

200

収集成功

No content

400

不正なリクエスト

503

一時的にサービスを利用できません

post/actions/search/result

POST /actions/search/result HTTP/1.1
Host: api.gelatto.ai
Api-Key: YOUR_API_KEY
Idempotency-Key: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 1281

{
  "specversion": "1.0.0",
  "id": "EVT-VIEW-SEARCH-RESULT",
  "type": "view_search_result",
  "time": "2025-11-28T10:00:00Z",
  "source": "https://shop.groobee.com",
  "datacontenttype": "application/ld+json",
  "dataschema": "https://api.gelatto.ai/schema/actions/search_result.json",
  "data": {
    "@context": "https://schema.org/",
    "@type": "ViewAction",
    "agent": {
      "@type": "Person",
      "identifier": [
        {
          "@type": "PropertyValue",
          "propertyID": "memberId",
          "value": "groobee1234"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "userId",
          "value": "2aa9a562-4182-4c59-b886-2be9d2a36b23"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "cookieId",
          "value": "bb404573-c87f-b4b1-d6e7-f2750499bf06"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "sessionId",
          "value": "8f9d2a6c-4e1b-4b2a-a9e1-7f6d5c4b3a21"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "deviceCode",
          "value": "PC"
        }
      ],
      "gender": "Female",
      "additionalProperty": [
        {
          "@type": "PropertyValue",
          "propertyID": "type",
          "value": "NORMAL"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "grade",
          "value": "VIP"
        },
        {
          "@type": "PropertyValue",
          "propertyID": "age",
          "value": 18
        }
      ]
    },
    "object": {
      "@type": "ItemList",
      "numberOfItems": 1,
      "itemListElement": {
        "@type": "ListItem",
        "item": {
          "@type": "Product",
          "sku": "NIKE_0000001",
          "name": "ナイキ エアジョーダン"
        },
        "position": 1
      }
    },
    "target": {
      "@type": "EntryPoint",
      "urlTemplate": "https://shop.groobee.com/search"
    }
  }
}

No content