サービス提供コントロールを管理する

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

サービス提供コントロールに関する一般的な情報とサービス提供コントロールの作成方法については、サービス提供コントロールについてとサービス提供コントロールを作成するをご覧ください。

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

コンソールと API を使用して Vertex AI Search for Retail のサービス提供コントロールを表示できます。

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

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

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

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

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

単一のサービス提供コントロールをインラインで表示するには、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. Search for Retail コンソールの [コントロール] ページに移動します。

    [コントロール] ページに移動

  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 つあります。

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

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

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

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

  1. Search for Retail コンソールの [コントロール] ページに移動します。

    [コントロール] ページに移動

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

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

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

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

    projects_PROJECT_ID_TIMESTAMP_exported_controls.ndjson

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

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

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

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

  • サービス提供コントロールのファイルに、検索とレコメンデーションの両方のサービス提供コントロールが含まれている場合、サービス提供ファイルをインポートすることはできません。

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

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

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

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

  2. Search for Retail コンソールの [コントロール] ページに移動します。

    [コントロール] ページに移動

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

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

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

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

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

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

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

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