これは、Recommendations AI、Retail Search、新しい Retail コンソールに関するドキュメントです。

コントロールを作成して管理する

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

このページでは、コントロールを追加、表示、編集、削除、エクスポート、インポートする方法について説明します。

  • サービス提供コントロールは、個々のサービス提供構成を定義して適用するルールです。サービス提供構成の詳細については、サービス提供構成をご覧ください。
  • サイト全体のコントロールは、適用するサイト全体の管理の種類に応じて、すべての検索結果またはすべてのレコメンデーションの結果に適用されます。

サービス提供コントロール

サービス提供コントロールを使用すると、結果でのサービス提供構成をカスタマイズするルールを作成できます。

コントロールをトリガーする条件と、条件によってトリガーされるときに発生するアクションで構成されるサービス制御を Google Cloud コンソールで作成できます。その後、新しい提供コントロールをサービス構成に関連付けることができます。

サービス提供構成は、コントロールと多対多の関係を持ちます。1 つのサービス提供構成に複数のコントロールを追加でき、1 つのコントロールを複数のサービス提供構成に関連付けることができます。

サービス提供コントロールとサービス提供構成を作成するときに、それを使用できるプロダクト(Recommendations AI または Retail Search)を選択します。サービス提供コントロールを関連付けできるのは、同じプロダクトタイプのサービス提供構成のみです。たとえば、Recommendations AI 用に作成されたサービス提供コントロールを、Retail Search 用に作成されたサービス提供構成に関連付けることはできません。

サービス提供構成は、検索リクエストまたは予測リクエスト時に適用されるコントロールを管理します。リクエストの有効なサービス提供構成のコントロールだけが、サービス提供時に考慮されます。たとえば、「シューズ」が検索されたときに、gShoe のブランドの結果をブーストする「gShoe Sale」というコントールと、用語「ランニング シューズ」を使用して「スポーツ シューズ」を含めるようクエリを拡張する「More Shoes」というコントロールを 2 つ作成したとします。サービス提供構成に「gShoe Sale」コントロールのみを関連付けた場合、そのサービス提供を使用して検索リクエストを行うと、用語「シューズ」を使用したクエリに対する gShoe の結果はブーストされますが、「More Shoes」コントロールは使用しているサービス提供構成に関連付けられていないため影響がありません。

コントロールを作成し、ライブサービス提供構成に追加または入れ替えることができます。

サービス提供コントロールは、[コントロール] ページまたは Controls.create メソッドを使用してインラインでいつでも作成または変更できます。コンソールでは、オプションでサービス提供構成の作成プロセス中にコントロールを作成できます。

最大 100 個のサービス提供コントロールを作成できます。さらにサービス提供コントロールが必要な場合は、追加の割り当てをリクエストしてください。追加の割り当てをリクエストする方法については、割り当ての増加をご覧ください。サービス提供構成には、リダイレクト コントロール以外の最大 100 個のサービス提供コントロールを含めることができます。サービス提供構成ごとの上限は 1,000 個です。

サービス提供コントロールでは次の設定を使用できます。

  • ブースト / 埋め込み: 返される結果リスト内の検索結果のランキングと順序に影響します。 Retail Search と Recommendations AI で利用できます。
  • フィルタ: 返された結果リストからフィルタを通過しない結果を削除します。 Retail Search でのみ使用できます。
  • リダイレクト: 検索クエリに応じて、ユーザーを特定のページにリダイレクトします。Retail Search でのみ使用できます。
  • 言語: 検索クエリの言語をカスタマイズします。Retail Search でのみ使用できます。複数の言語管理を使用できます。
    • 類義語: 検索クエリの類義語と考えられるものを拡張します。
    • 一方向の類義語: 特定のキーワードの類義語と考えられるものを一方向に拡張します。
    • 関連付けない: 特定のキーワードが表示されたときに、あるキーワード グループが検索で使用されないようにします。
    • 無視: 検索に特定のキーワードが使用されないようにします。
    • 置換: 検索クエリのキーワードを置き換えます。

これらのコントロールの例については、サービス提供コントロールをご覧ください。

リダイレクト制御のチュートリアル

このチュートリアルでは、リダイレクト コントロールの使用方法について説明します。


このタスクを Cloud Shell エディタで直接行う際の順を追ったガイダンスについては、[ガイドを表示] をクリックしてください。

ガイドを表示


以降のセクションでは、[ガイドを表示] をクリックした場合と同じ手順について説明します。

新しいサービス提供コントロールを作成する

Google Cloud Console の [コントロール] ページで、または Controls.create メソッドを使用してインラインで新しいサービス提供コントロールを作成します。

コントロールには、タイプに応じて異なる要件があります。作成するコントロール タイプの作成手順に進みます。

ブースト / 埋め込みコントロールを作成する

このコントロール タイプの詳細については、ブースト / 埋め込みコントロールをご覧ください。

このコントロール タイプは、Retail Search と Recommendations AI で使用できます。

Retail Search のブースト / 埋め込みコントロールを作成するには:

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. [プロダクトの選択] で [検索] を選択します。

  4. コントロール タイプとして [ブースト / 埋め込みコントロール] を選択します。

  5. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、コントロールをトリガーする条件を設定します。

  1. このコントロールをトリガーするユーザーの行動のタイプを選択します。

    • カテゴリを閲覧する: ユーザーがサイトのカテゴリを閲覧したときにルールがトリガーされます(search.request.query は空です)。

    • 検索: ユーザーがサイトで検索したときにルールがトリガーされます(search.request.query は空ではありません)。

    次のステップでは、このコントロールをトリガーできる特定のカテゴリまたはクエリを設定できます。カテゴリが閲覧されたとき、またはクエリが検索されたときに、このコントロールを設定してトリガーするには、次の手順をスキップします。

  2. 省略可: 特定のカテゴリが閲覧されたか、特定のクエリが検索されたかどうかに基づいて、ルールをトリガーするコントロール条件を設定します。

    任意のカテゴリまたはクエリでトリガーするようにこのコントロールを設定するには、この手順をスキップします。

    使用可能なオプションは、[カテゴリを閲覧] か [検索] のどちらを選択するかによって異なります。

    • [カテゴリを閲覧] を選択した場合: [カテゴリ] フィールドに、閲覧時にこのコントロールをトリガーするカテゴリを入力します。

    • [検索] を選択した場合: [クエリを追加] ボタンをクリックし、フィルタするクエリ用語(running shoes など)を追加して、次の各用語のいずれかを選択します。

      • 部分一致: このコントロールは、クエリ語句に部分一致が含まれている場合に適用されます。
      • 完全一致: このコントロールは、クエリ語句に完全に一致する語句がクエリに含まれている場合にのみ適用されます。

      これらの用語のいずれかがクエリに含まれている場合は、コントロールが適用されます。

    このタイプの条件に加えて、時間範囲の条件を指定すると、両方の条件が満たされた場合にのみコントロールが適用されます。

  3. 省略可: [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

    時間範囲条件に加えてカテゴリまたはクエリの利用条件を指定すると、両方の条件が満たされた場合にのみコントロールが適用されます。

  4. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [ブースト / 埋め込み商品] フィールドに商品属性のフィルタを追加します。

    フィルタリングと並べ替えで記載されているフィルタ式の構文を使用してください。

    たとえば、「product1」と「product2」の赤と青のバージョンを指定するには: (id: ANY("product1","product2")) AND (colorFamily: ANY("Red","Blue"))

  2. [ブースト / 埋め込み値] には、スライダーを使用してブーストの強さを設定します。正の値は結果をブーストし、負の値は結果を埋め込みます。

  3. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

ユーザーがサイト上でカテゴリを閲覧した場合(search.request.query が空)、またはユーザーがサイトを検索した場合(search.request.query が空でない)、ブースト/ベリー・コントロールをトリガーできます。

次の例は、閲覧でトリガーされるコントロールのフィールドを示しています。ここで、searchSolutionUseCaseSEARCH_SOLUTION_USE_CASE_BROWSE に設定されています。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_BROWSE"
              ],
              "rule": {
                "condition": {
                  "pageCategories": [
                      "CATEGORY_ABC",
                      "CATEGORY_XYZ"
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "boostAction": {
                  "boost": BOOST_NUMBER,
                  "productsFilter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

次の例は、検索でトリガーされるコントロールのフィールドを示しています(searchSolutionUseCaseSEARCH_SOLUTION_USE_CASE_SEARCH に設定されています)。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_SEARCH"
              ],
              "rule": {
                "condition": {
                  "queryTerms": [
                    {
                      "value": "VALUE_1",
                      "fullMatch": "FULLMATCH_BOOLEAN_1"
                    },
                    {
                      "value": "VALUE_2",
                      "fullMatch": "FULLMATCH_BOOLEAN_2"
                    }
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "boostAction": {
                  "boost": BOOST_NUMBER,
                  "productsFilter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

Recommendations AI のブースト / 埋め込みコントロールを作成する

Recommendations AI のブースト / 埋め込みコントロールを作成するには:

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. [プロダクトの選択] セクションで、[レコメンデーション] を選択します。

  4. コントロール タイプとして [ブースト / 埋め込みコントロール] を選択します。

  5. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [ブースト / 埋め込み商品] フィールドに商品属性のフィルタを追加します。

    レコメンデーションのフィルタのドキュメントに記載されているフィルタ式の構文を使用します。

    たとえば、「product1」と「product2」の赤と青のバージョンを指定するには: (id: ANY("product1","product2")) AND (colorFamily: ANY("Red","Blue"))

  2. [ブースト / 埋め込み値] には、スライダーを使用してブーストの強さを設定します。正の値は結果をブーストし、負の値は結果を埋め込みます。

  3. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

フィルタ式を作成するには、レコメンデーションのフィルタに記載されているフィルタ式の構文を使用します。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_RECOMMENDATION" ],
                "boostAction": {
                  "boost": BOOST_NUMBER,
                  "productsFilter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

It takes a few minutes for newly created or updated controls to be ready to
serve live traffic. You can test if your changes have been applied on
the console Evaluate page.

    
To add a control to a serving configuration, use the
`ServingConfig.addControl` method. See
[Add controls to serving configurations inline][addcontrol-inline].

フィルタ オプションを作成する

このコントロール タイプの詳細については、フィルタ オプションをご覧ください。

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. コントロール タイプとして [フィルタ オプション] を選択します。

  4. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、次の操作を行います。

  1. このコントロールをトリガーするユーザーの行動のタイプを選択します。

    • カテゴリを閲覧する: ユーザーがサイトのカテゴリを閲覧したときにルールがトリガーされます(search.request.query は空です)。

    • 検索: ユーザーがサイトで検索したときにルールがトリガーされます(search.request.query は空ではありません)。

  2. 省略可: 閲覧されるカテゴリまたは検索されるクエリに基づいてルールをトリガーするコントロール条件を設定します。使用可能なオプションは、[カテゴリを閲覧] か [検索] のどちらを選択するかによって異なります。

    • [カテゴリを閲覧] を選択した場合: [カテゴリ] フィールドに、閲覧時にこのコントロールをトリガーするカテゴリを入力します。

    • [検索] を選択した場合: [クエリを追加] ボタンをクリックし、フィルタするクエリ用語(running shoes など)を追加して、次の各用語のいずれかを選択します。

      • 部分一致: このコントロールは、クエリ語句に部分一致が含まれている場合に適用されます。
      • 完全一致: このコントロールは、クエリ語句に完全に一致する語句がクエリに含まれている場合にのみ適用されます。

      これらの用語のいずれかがクエリに含まれている場合は、コントロールが適用されます。

    この条件に加えて、時間範囲の条件を指定すると、両方の条件が満たされた場合にのみコントロールが適用されます。

  3. 省略可: [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

    この時間範囲条件に加えて、カテゴリまたはクエリの利用条件を指定すると、両方の条件が満たされた場合にのみコントロールが適用されます。

  4. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [フィルタ アクション] フィールドに、商品属性のフィルタを追加します。

    フィルタリングと並べ替えで記載されているフィルタ式の構文を使用してください。

    たとえば、「product1」と「product2」の赤と青のバージョンを指定するには: (id: ANY("product1","product2")) AND (colorFamily: ANY("Red","Blue"))

  2. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

ユーザーがサイトのカテゴリを閲覧した(search.request.queryが空)場合、またはユーザーがサイトを検索した(search.request.queryが空でない)場合、フィルタ オプションをトリガーできます

次の例は、閲覧でトリガーされるコントロールのフィールドを示しています。ここで、searchSolutionUseCaseSEARCH_SOLUTION_USE_CASE_BROWSE に設定されています。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_BROWSE"
              ],
              "rule": {
                "condition": {
                  "pageCategories": [
                      "CATEGORY_ABC",
                      "CATEGORY_XYZ"
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "filterAction": {
                  "filter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

次の例は、検索でトリガーされるコントロールのフィールドを示しています(searchSolutionUseCaseSEARCH_SOLUTION_USE_CASE_SEARCH に設定されています)。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_SEARCH"
              ],
              "rule": {
                "condition": {
                  "pageCategories": [
                      "CATEGORY_ABC",
                      "CATEGORY_XYZ"
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "filterAction": {
                  "filter": "FILTER_EXPRESSION"
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

リダイレクト コントロールを作成する

このコントロール タイプの詳細については、リダイレクト コントロールをご覧ください。

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. コントロール タイプとして [リダイレクト コントロール] を選択します。

  4. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、少なくとも 1 つのクエリ用語または時間範囲トリガーを作成します。リダイレクト コントロールには少なくとも 1 つのトリガーが必要です。

  1. このコントロールをトリガーするユーザーの行動のタイプを選択します。

    • カテゴリを閲覧する: ユーザーがサイトのカテゴリを閲覧したときにルールがトリガーされます(search.request.query は空です)。

    • 検索: ユーザーがサイトで検索したときにルールがトリガーされます(search.request.query は空ではありません)。

  2. 閲覧されるカテゴリまたは検索されるクエリに基づいてルールをトリガーするコントロール条件を設定します。使用可能なオプションは、[カテゴリを閲覧] か [検索] のどちらを選択するかによって異なります。

    • [カテゴリを閲覧] を選択した場合: [カテゴリ] フィールドに、閲覧時にこのコントロールをトリガーするカテゴリを入力します。

    • [検索] を選択した場合: [クエリを追加] ボタンをクリックし、フィルタするクエリ用語(running shoes など)を追加して、次の各用語のいずれかを選択します。

      • 部分一致: このコントロールは、クエリ語句に部分一致が含まれている場合に適用されます。
      • 完全一致: このコントロールは、クエリ語句に完全に一致する語句がクエリに含まれている場合にのみ適用されます。

      これらの用語のいずれかがクエリに含まれている場合は、コントロールが適用されます。

    この条件に加えて、時間範囲の条件を指定すると、両方の条件が満たされた場合にのみコントロールが適用されます。

  3. [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

    この時間範囲条件に加えて、カテゴリまたはクエリの利用条件を指定すると、両方の条件が満たされた場合にのみコントロールが適用されます。

  4. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. このコントロールがトリガーされたときにリダイレクトする URI を入力します。

  2. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

ユーザーがサイトのカテゴリを閲覧した(search.request.queryが空)場合、またはユーザーがサイトを検索した(search.request.queryが空でない)場合、リダイレクト コントロールをトリガーできます

次の例は、閲覧でトリガーされるコントロールのフィールドを示しています。ここで、searchSolutionUseCaseSEARCH_SOLUTION_USE_CASE_BROWSE に設定されています。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_BROWSE"
              ],
              "rule": {
                "condition": {
                  "queryTerms": [
                    {
                      "value": "VALUE_1",
                      "fullMatch": "FULLMATCH_BOOLEAN_1"
                    },
                    {
                      "value": "VALUE_2",
                      "fullMatch": "FULLMATCH_BOOLEAN_2"
                    }
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "redirectAction": {
                  "redirectUri": "REDIRECT_URI",
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"

次の例は、検索でトリガーされるコントロールのフィールドを示しています(searchSolutionUseCaseSEARCH_SOLUTION_USE_CASE_SEARCH に設定されています)。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "searchSolutionUseCase": [
                "SEARCH_SOLUTION_USE_CASE_SEARCH"
              ],
              "rule": {
                "condition": {
                  "queryTerms": [
                    {
                      "value": "VALUE_1",
                      "fullMatch": "FULLMATCH_BOOLEAN_1"
                    },
                    {
                      "value": "VALUE_2",
                      "fullMatch": "FULLMATCH_BOOLEAN_2"
                    }
                  ],
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "redirectAction": {
                  "redirectUri": "REDIRECT_URI",
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

双方向の類義語コントロールを作成する

このコントロール タイプの詳細については、双方向の類義語コントロールをご覧ください。

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

  3. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  2. コントロール タイプとして [双方向の類義語コントロール] を選択します。

  3. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、次の操作を行います。

  1. 省略可: [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

  2. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [類義語] フィールドに、互いに類義語であるクエリキーワード(shirttop など)を 2 ~ 100 個入力します。

    これらの語句のいずれかがクエリに含まれている場合、検索ではその他のクエリ語句は含まれている語句の類義語と見なされます。

  2. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                    ]
                },
                "twoWaySynonymAction": {
                  "synonyms": [
                    "SYNONYM_1",
                    "SYNONYM_2"
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

一方向の類義語コントロールを作成する

このコントロール タイプの詳細については、一方向の類義語コントロールをご覧ください。

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. コントロール タイプとして [一方向の類義語コントロール] を選択します。

  4. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、次の操作を行います。

  1. 省略可: [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

  2. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [クエリキーワード] フィールドに、いずれかがクエリに含まれるときに類義語を関連付ける必要のある用語(shoes など)を入力します。

  2. [類義語] フィールドに、指定したクエリキーワードの類義語として使用するキーワードを入力します(例: クエリキーワード shoes の一方向の類義語としての sneakerssandals)。

  3. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "oneWaySynonymAction": {
                  "synonyms": [
                    "queryTerms": [
                      "QUERY_TERM_1",
                      "QUERY_TERM_2"
                    ],
                    "synonyms": [
                      "SYNONYM_1",
                      "SYNONYM_2"
                    ]
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

「関連付けなし」のコントロールを作成する

このコントロール タイプの詳細については、非関連付けコントロールをご覧ください。

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. コントロール タイプとして [コントロールを関連付けない] を選択します。

  4. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、次の操作を行います。

  1. 省略可: [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

  2. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [クエリキーワード] フィールドに、他のクエリと明確に区別するキーワード(gShoe など)を入力します。

  2. [関連付けられていないキーワード] フィールドに、指定したクエリキーワードに関連付けてはならないキーワードを入力します。

    たとえば、クエリキーワード gShoe と キーワード cheap の関連付けを解除できます。

  3. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "doNotAssociateAction": {
                    "queryTerms": [
                      "QUERY_TERM_1",
                      "QUERY_TERM_2"
                    ],
                    "doNotAssociateTerms": [
                      "DISSOCIATED_TERM_1",
                      "DISSOCIATED_TERM_2"
                    ]
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

取り消しコントロールを作成する

このコントロール タイプの詳細については、取り消しコントロールをご覧ください。

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. コントロール タイプとして [コントロールを関連付けない] を選択します。

  4. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、次の操作を行います。

  1. 省略可: [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

  2. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [キーワードを無視] フィールドに、クエリキーワードで入力するときに検索が無視するキーワード(shoddy など)を入力します。

  2. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "ignoreAction": {
                  "ignoreTerms": [
                      "IGNORE_TERM_1",
                      "IGNORE_TERM_2"
                    ]
                  ]
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

代替コントロールを作成する

このコントロール タイプの詳細については、代替コントロールをご覧ください。

コンソール

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Serving controls] タブで、 [Create control] をクリックします。

    [コントロールを作成する] ペインが開きます。

[Preferences] セクションで、次の操作を行います。

  1. [コントロール名] フィールドに、新しいコントロールの名前を入力します。

  2. 省略可: 自動的に作成されたコントロール ID を変更するには、[編集] をクリックして新しいコントロール ID を入力します。

  3. コントロール タイプとして [代替コントロール] を選択します。

  4. [続行]をクリックして [トリガー] セクションに進みます。

[トリガー] セクションで、次の操作を行います。

  1. 省略可: [時間範囲を追加] ボタンをクリックして、このコントロールを適用する時間範囲を 1 つ以上追加します。

  2. [続行] をクリックして [アクション] セクションに進みます。

[アクション] セクションで、次の操作を行います。

  1. [クエリキーワード] フィールドに、代替キーワードで置き換えるクエリキーワード(gShoe など)を入力します。

  2. [代替キーワード] フィールドに、指定したクエリキーワードを置き換えるキーワードを入力します。

    たとえば、クエリキーワード gShoe を代替キーワード Google Shoe に置き換えることができます。

  3. [続行] をクリックして [サービス提供構成] セクションに進みます。

[サービス提供構成] セクションで、次の操作を行います。

  1. コントロールを適用するサービス提供構成を選択します。

  2. コントロール設定を送信します。

    新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

curl

リクエスト本文に含まれる Control のコントロール ID とインスタンスを使用して、Control.create リクエストを行います。

フィールドの詳細については、Controls API リファレンスControls.create API リファレンスをご覧ください。

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     --data '{
              "displayName": "DISPLAY_NAME",
              "solutionTypes": [ "SOLUTION_TYPE_SEARCH" ],
              "rule": {
                "condition": {
                  "activeTimeRange": [
                    {
                      "startTime": "START_TIMESTAMP_1",
                      "endTime": "END_TIMESTAMP_1"
                    },
                    {
                      "startTime": "START_TIMESTAMP_2",
                      "endTime": "END_TIMESTAMP_2"
                    }
                  ]
                },
                "replacementAction": {
                    "queryTerms": [
                      "QUERY_TERM_1",
                      "QUERY_TERM_2"
                    ],
                    "replacementTerm": "REPLACEMENT_TERM"
                  }
                }
              }
    }' \
    "https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?controlId=CONTROL_ID"
  

サービス提供構成にコントロールを追加するには、ServingConfig.addControl メソッドを使用します。サービス提供構成にインラインにコントロールを追加するをご覧ください。

新しいコントロールは、[Controls] ページの [erving controls] タブに表示されます。

サービス提供コントロールを表示して編集する

サービス提供コントロールを表示するには、Retail コンソールまたは Retail API を使用します。

コンソールでサービス提供コントロールを表示して編集する

コントロール ページの [サービス提供コントロール] タブには、すべてのサービス提供コントロールとそれに関連するサービス提供構成が一覧表示されます。コントロールの [コントロールを編集] アイコンをクリックすると、[コントロールの編集] パネルで、コントロールの設定や関連するサービス提供構成を変更できます。コントロールを削除するには、コントロールの [コントロールを削除] アイコンをクリックします。これにより、すべてのサービス提供構成からコントロールが削除されます。

[サービス提供構成] ページで特定のサービス提供構成のコントロールを表示、編集することもできます。サービス提供構成をクリックして、[詳細] ページを表示します。そこでは、その構成のすべてのサービス提供コントロールが一覧表示されます。コントロールの [コントロールを編集] アイコンをクリックして、[コントロールを編集] パネルで設定を変更します。 [コントロールを削除] アイコンをクリックして、サービス提供構成からコントロールを切り離します(コントロールは削除されません)。

新規作成または更新されたコントロールがライブ トラフィックを提供できるようになるまでに、数分かかります。変更が適用されたかどうかは、コンソールの [評価] ページでテストできます。

サービス提供コントロールをインラインで表示する

単一のサービス提供コントロールをインラインで表示するには、Control.get を使用します。

このメソッドの詳細については、Control.get API リファレンスをご覧ください。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID'

複数のサービス提供コントロールをインラインで一覧表示するには、Controls.list を使用します。

必要に応じて、パラメータ pageSize を使用して返される結果の最大数を設定できます。より多くの結果が使用可能な場合、list レスポンスにページトークンが含まれます。list リクエストの pageToken パラメータでページトークンを渡して、結果の次のページを取得できます。

特定のサービス提供構成に関連付けられたコントロールだけを一覧表示するには、filter クエリ パラメータを使用してサービス提供構成 ID を指定します。

このメソッドの詳細については、Control.list API リファレンスをご覧ください。

curl -X GET \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN&filter=servingConfig=SERVING_CONFIG_ID

サービス提供コントロールをインラインでパッチ適用する

サービス提供コントロールのフィールドを更新するには、Controls.patch を使用し、リクエスト本文に Control のインスタンスを含めます。updateMask パラメータで更新するためにフィールドを指定するか、サポートされているすべてのフィールドを更新には未設定のままにします。

このメソッドの詳細については、Controls.patch API リファレンスをご覧ください。

curl -X PATCH \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d '{
      "name": "projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID",
      "FIELD_NAME_1": "NEW_FIELD_VALUE_1"
      "FIELD_NAME_2": "NEW_FIELD_VALUE_2"
    }' \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/CONTROL_ID?updateMask=FIELD_NAME_1,FIELD_NAME_2'

サービス提供構成にインラインでコントロールを追加する

サービス提供構成にコントロールを追加するには、ServingConfig.addControl を使用します。

このメソッドの詳細については、ServingConfig.addControl API リファレンスをご覧ください。

このメソッドの例については、サービス提供構成を管理をご覧ください。

サービス提供構成からインラインでコントロールを削除する

サービス提供構成からコントロールを削除するには、ServingConfig.removeControl を使用します。

このメソッドの詳細については、ServingConfig.addControl API リファレンスをご覧ください。

このメソッドの例については、サービス提供構成を管理をご覧ください。

サービス提供コントロールを削除する

サービス提供コントロールは、コンソールから、または Controls.delete メソッドを使用してインラインで削除できます。

コンソールでサービス提供コントロールを削除する

サービス提供コントロールを削除し、そのコントロールを使用しているすべてのサービス提供構成からコントロールを削除します。

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. 表の削除するコントロールの行で、 [Delete] をクリックします。

  3. 確認ウィンドウで、[Delete] をクリックして削除を完了します。

インラインでサービス提供コントロールを削除する

サービス提供コントロールをインラインで削除するには、Controls.delete を使用します。

このメソッドの詳細については、Controls.delete API リファレンスをご覧ください。

curl -X DELETE \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
'https://retail.googleapis.com/v2beta/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/controls/SERVING_CONTROL_ID'

サービス提供コントロールをエクスポートする

サービス提供コントロールを Cloud Storage バケット内のファイルにエクスポートできます。

サービス配信コントロールをエクスポートおよびインポートする可能性がある理由が 2 つあります。

  • プロジェクト間でサービス提供コントロールを移動するには:

  • すべてまたは一部のサービス提供コントロールを一括編集するには:サービス提供コントロールをエクスポートして、エクスポートされたファイルを編集してから、そのファイルをインポートしてサービス提供コントロールを変更または追加します。

エクスポートとインポートは、Google Cloud コンソールから行うことができます。サービス提供コントロールをエクスポートすると、プロジェクト内のすべてのサービス提供コントロールがエクスポートされます。

サービス提供コントロールをエクスポートする手順は次のとおりです。

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [サービス提供コントロール] タブで [コントロールをエクスポート] をクリックします。

  3. [サービス提供コントロールをエクスポート] ウィンドウで、コントロール ファイルをエクスポートする Cloud Storage バケットを選択します。

  4. [エクスポート] をクリックします。

    エクスポートされたコントロールは、選択したバケット内の NDJSON ファイルに、次の形式の名前で保存されます。

    projects_PROJECT_ID_TIMESTAMP_exported_controls.ndjson
    
  5. エクスポート オペレーションの完了後、[アクティビティをエクスポート] ウィンドウの [アクティビティを一括でインポート、エクスポート、削除] リストでオペレーションのステータスを確認できます。[アクティビティをエクスポート] ウィンドウを開くには、メッセージ ウィンドウで [表示]をクリックする、または特定の統合オペレーションのステータスを確認の手順に従います。

サービス提供コントロールをインポートする

サービス提供コントロールを追加したり、既存のサービス提供コントロールを一括で変更したりするには、エクスポートされたコントロール ファイルで変更を加えます。その後、それらを元の Retail プロジェクトまたは別の Retail プロジェクトにインポートできます。

サービス提供コントロールのインポートに関する注意事項:

  • サービス提供コントロールのファイルに、Retail Search と Recommendations AI の両方のサービス提供コントロールが含まれている場合、サービス提供ファイルをインポートすることはできません。

  • サービス提供コントロールをインポートすると、ファイル内のすべてのサービス提供コントロールは、インポート時に指定したサービス提供構成に関連付けられます。サービス提供コントロールがすでにプロジェクト内の別のサービス提供構成に関連付けられている場合、その関連付けも維持されます。

サービス提供コントロールをインポートする手順は次のとおりです。

  1. エクスポートされたサービス提供コントロールのファイルを編集して確認し、Cloud Storage バケット内のファイルに配置します。(サービス提供コントロールをエクスポートするには、前のタスクのサービス提供コントロールをエクスポートをご覧ください)。

    ファイルに Retail Search サービス提供コントロールのみ、または Recommendations AI サービス提供コントロールのみが含まれていることを確認します。両方のタイプを含むファイルをインポートすることはできません。

  2. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  3. [サービス提供コントロール] タブで [コントロールをインポート] をクリックします。

  4. [サービス提供コントロールをインポート] ウィンドウで、次の操作を行います。

    1. インポートするコントロールを含む Cloud Storage バケットと NDJSON ファイルを閲覧して選択します。

    2. インポートしたサービス提供コントロールを関連付けるサービス提供構成を選択します。

    3. インポート プレビュー プランを確認します。作成されるコントロールは [新規] タブに、変更されるコントロールは [変更] タブに表示されます。

  5. [Import(インポート)] をクリックします。

    長時間実行オペレーションが開始され、新しいコントロールと変更されたコントロールがインポートされます。

  6. インポート オペレーションが完了すると、[アクティビティのステータス] ウィンドウの [コントロール] タブでオペレーションのステータスを確認できます。[アクティビティのステータス] ウィンドウを開くには、メッセージ ウィンドウで [表示]をクリックする、または特定の統合オペレーションのステータスを確認の手順に従います。

サイト全体のコントロール

サイト全体のコントロールを使用すると、すべてのサービス提供構成にまたがって設定をグローバルに管理できます。

属性コントロール

サイト全体の属性コントロールは、Google Cloud コンソールでカタログの商品属性に使用できます。

サイト全体の属性コントロール機能は次のとおりです。

  • Indexable: この属性を使用すると、Retail Search でフィルタを使用してファセットをフィルタリングできます。
  • 動的ファセット: Retail Search では、ユーザーの過去の操作(ファセットのクリックや表示など)に基づいて、この属性が動的ファセットとして自動的に使用されます。属性の動的ファセットを有効にするには、その属性の Indexable を true に設定する必要があります。
  • 検索可能: この属性は Retail Search クエリで検索できます。これによって、この属性の再現率が向上します。このコントロールは、テキスト属性にのみ適用されます。
  • フィルタ可能(公開プレビュー版): この属性は Recommendations AI フィルタ式で使用できます。このコントロールは、テキスト属性にのみ適用されます。

個々の属性に対してサイト全体の属性コントロールを有効または無効にできます。

動的ファセットは、サイト全体の属性コントロールとして使用できます。デフォルトでは、動的ファセットはすべてのカスタム属性に対して有効になっています。

カタログレベルの構成モードでは、サイト全体の属性コントロールを Indexable と検索可能で使用できます。

属性の構成と、デフォルト設定と許可される設定の詳細については、属性を構成をご覧ください。

サイト全体の属性コントロールを設定する

Google Cloud Console の [Controls] ページでサイト全体のコントロールを設定します。

サイト全体の属性コントロールのグローバルな設定は、デフォルトのカタログレベルの構成モードで利用できます。以前は、商品レベルの構成がデフォルトのモードでした。まだ商品レベルの構成モードで、モードを切り替える必要がある場合は、小売サポートにお問い合わせください。

  1. Google Cloud Console の [Retail Controls] ページに移動します。

    [Controls] ページに移動

  2. [Site-wide controls] タブに移動します。

    このタブには、サイト全体のコントロールを設定できるすべての商品属性の表が表示されます。

  3. [Control Controls] をクリックします。

  4. コントロールを有効または無効にします。

    • True: その属性のコントロールを有効にします。これは、Retail API の商品レベルの属性構成をオーバーライドします。
    • False: その属性のコントロールを無効にします。これは、Retail API の商品レベルの属性構成をオーバーライドします。

      動的ファセットを true に設定できるのは、インデックス可能に設定されている属性のみです。

  5. [コントロールを保存] をクリックします。

    Indexable と検索可能についての属性構成の設定の変更は、12 時間以内、または次回のカタログ取り込み直後に有効になります。 動的ファセット構成の変更は最大 2 日かかります。変更が評価」ページで適用されているかどうかをテストできます。これにより、変更が直ちに反映されます。