Verwenden Sie Entwickler-APIs, um Ergebnisse zur Aktivierung an ein Snowflake-Konto zu senden¶

Erstellen einer Vorlage für die Anbieteraktivierung¶

Eine Vorlage zum Aktivieren von Ergebnissen ist ähnlich wie eine Vorlage zum Ausführen einer Analyse. Sie wird zum Beispiel mit dem Befehl provider.add_custom_sql_template wie eine Analysevorlage zum Reinraum hinzugefügt. Eine Aktivierungsvorlage weist jedoch die folgenden wichtigen Unterschiede auf:

• Der Name der Aktivierungsvorlage muss mit der Zeichenfolge activation beginnen. Eine Aktivierungsvorlage mit dem Namen activation_my_template erfüllt zum Beispiel die Anforderung.

• Die Aktivierungsvorlage muss eine Tabelle mit einem Namen erstellen, der bestimmten Konventionen entspricht und den Tabellennamen explizit zurückgibt.

Definieren Sie die Tabelle in einer Aktivierungsvorlage¶

Um die Aktivierungsergebnisse im Reinraum zu halten, muss jede Aktivierungsvorlage eine Tabelle erstellen. Für diese Tabelle gibt es zwei Anforderungen:

• Der Name der Tabelle muss mit der Zeichenfolge cleanroom.activation_data_ beginnen. Eine Tabelle mit dem Namen cleanroom.activation_data_analysis_results erfüllt zum Beispiel die Anforderung.

• Der Teil der Vorlagendefinition, der die Tabelle erstellt, muss die Zeichenfolge zurückgeben, die an cleanroom.activation_data_ angehängt wurde, um den Namen der Tabelle zu bilden. Wenn der Tabellenname zum Beispiel cleanroom.activation_data_analysis_results lautet, muss die Zeichenfolge analysis_results zurückgegeben werden.

Im Folgenden finden Sie ein Beispiel dafür, was in der Vorlagendefinition enthalten sein muss, um eine Tabelle zu definieren und zu exportieren:

BEGIN
  CREATE OR REPLACE TABLE cleanroom.activation_data_analysis_results AS
    SELECT * FROM identifier({{ my_table[0] }})
  RETURN 'analysis_results';
END;

Weitere Informationen über den Aufruf des Befehls provider.add_custom_sql_template, um eine Aktivierungsvorlage zu einem Reinraum hinzuzufügen, finden Sie unter Snowflake Data Clean Rooms: Anbieter-API-Referenzhandbuch.

Verknüpfen Sie die gewünschte Tabelle (nur Anbieteraktivierung)¶

Wenn der Anbieter oder Verbraucher Ergebnisse an das Snowflake-Konto des Anbieters weiterleiten möchte, muss der Anbieter die Tabelle samooha_by_snowflake_local_db.library.temp_public_key mit dem Reinraum verknüpfen. Um zum Beispiel die gewünschte Tabelle mit dem Reinraum my_activation_cleanroom führen Sie Folgendes aus:

CALL samooha_by_snowflake_local_db.provider.link_datasets(
    'my_activation_cleanroom',
    ['samooha_by_snowflake_local_db.library.temp_public_key']);

Der Anbieter könnte auch einen einzigen Aufruf zur Verknüpfung der gewünschten Tabelle verwenden, wenn er seine anderen Tabellen und Ansichten verknüpft.

Legen Sie eine Aktivierungsrichtlinie fest¶

Eine Aktivierungsrichtlinie legt fest, welche Spalten in Aktivierungsvorlagen verwendet werden können. Dies kann bei Aktivierungsvorlagen verwendet werden, um sicherzustellen, dass nur die vom Anbieter freigegebenen Spalten mit der Aktivierungsvorlage verwendet werden können.

Ein Anbieter verwendet die provider.set_activation_policy API, um die Aktivierungsrichtlinie festzulegen. Beispiel:

CALL samooha_by_snowflake_local_db.provider.set_activation_policy('my_cleanroom', [
    'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:HASHED_EMAIL',
    'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:STATUS',
    'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:AGE_BAND',
    'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:DAYS_ACTIVE',
    'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:REGION_CODE' ]);

Aktivieren Sie die Verbraucheraktivierung (nur von Verbrauchern durchgeführte Analysen)¶

Wenn der Verbraucher die Ergebnisse an sein eigenes Konto senden will, muss der Anbieter die provider.enable_template_for_consumer_activation API ausführen. Beispiel:

CALL samooha_by_snowflake_local_db.provider.enable_template_for_consumer_activation(
    'my_cleanroom', 'activation_my_template');

Berechtigung vom Verbraucher anfragen (nur Anbieteraktivierung)¶

Wenn der Anbieter die Aktivierungsvorlage so konfiguriert, dass er sich selbst oder dem Verbraucher erlaubt, Ergebnisse an das Snowflake-Konto des Anbieters zu senden, muss der Anbieter die provider.request_provider_activation_consent API ausführen. Diese API fragt beim Verbraucher an, die Vorlage zu diesem Zweck zu genehmigen. Beispiel:

CALL samooha_by_snowflake_local_db.provider.request_provider_activation_consent('my_cleanroom', 'activation_my_template');

Der Verbraucher muss die Anfrage genehmigen, bevor der Anbieter die Ergebnisse einer vom Anbieter durchgeführten Analyse aktivieren kann.

Aktivierung in der Web-App einrichten (optional)¶

Wenn der Anbieter eine Weboberfläche für den Reinraum erstellt, damit die Benutzer in der Web-App Analysen durchführen können, kann er den Reinraum auch so konfigurieren, dass die Benutzer die Ergebnisse über den Activation Hub in der Web-App aktivieren können. Wenn der Anbieter die provider.add_ui_form_customizations API ausführt, um die Benutzeroberfläche zu erstellen, gibt er den Namen der Aktivierungsvorlage an und ob die Vorlage für die Anbieteraktivierung, die Verbraucheraktivierung oder beides verwendet werden soll.

Im folgenden Beispiel können Benutzer den Activation Hub sowohl für die Anbieter- als auch für die Verbraucheraktivierung verwenden.

CALL samooha_by_snowflake_local_db.provider.add_ui_form_customizations(
    $cleanroom_name,
    'prod_test_references_1',
    {
      'display_name': 'PROD TEST REFERENCE FIRST',
      'description': 'Use our customized ML techniques to find lookalike audiences.',
      'methodology': 'Specify your own seed audience, while matching against our users. Then customize the lookalike model across number of boosting rounds and removing outliers.',
      'render_table_dropdowns': {
          'render_consumer_table_dropdown': TRUE,
          'render_provider_table_dropdown': TRUE
        },
     'activation_template_name': 'activation_my_template',
     'enabled_activations': ['consumer', 'provider']
    },
    {
    'reference_provider_join': {
        'display_name': 'Provider join column',
        'order': 4,
        'description': 'Which provider col do you want to join on',
        'size': 'S',
        'group': 'Seed Audience Selection',
        'references': ['PROVIDER_JOIN_POLICY'],
        'provider_parent_table_field': 'source_table',
        'type': 'dropdown'
    },
    'reference_consumer_join': {
        'display_name': 'Consumer join column',
        'order': 4,
        'description': 'Which consumer col do you want to join on',
        'size': 'S',
        'group': 'Seed Audience Selection',
        'references': ['CONSUMER_COLUMNS'],
        'consumer_parent_table_field': 'my_table',
        'type': 'dropdown'
    }
  },
  {
    'measure_columns': ['count'],
    'default_output_type': 'BAR'
  });

Aktivierungsrichtlinie festlegen¶

Eine Aktivierungsrichtlinie legt fest, welche Spalten in Aktivierungsvorlagen verwendet werden können. Diese Richtlinie kann mit Aktivierungsvorlagen verwendet werden, um sicherzustellen, dass nur die Spalten, die vom Verbraucher genehmigt wurden, mit der Aktivierungsvorlage verwendet werden können.

Ein Verbraucher verwendet die consumer.set_activation_policy API, um die Aktivierungsrichtlinie festzulegen. Beispiel:

CALL samooha_by_snowflake_local_db.consumer.set_activation_policy('my_cleanroom', [
    'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:HASHED_EMAIL',
    'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:REGION_CODE' ]);

Anfrage des Anbieters genehmigen (nur Anbieteraktivierung)¶

Wenn der Anbieter die provider.request_provider_activation_consent API für eine Aktivierungsvorlage ausgeführt hat, die dazu dienen soll, Ergebnisse an das Snowflake-Konto des Anbieters zu senden, muss der Verbraucher die Anfrage genehmigen. Diese Genehmigung ist unabhängig davon erforderlich, ob es der Anbieter oder der Verbraucher ist, der die Ergebnisse auf das Konto des Anbieters sendet.

Wenn der Verbraucher die Web-App verwendet, ist die Installation des Reinraums die Zustimmung, die der Anbieter benötigt.

Wenn der Verbraucher die Entwickler-APIs verwendet, führt der Verbraucher die consumer.approve_provider_activation_consent API aus. Beispiel:

CALL samooha_by_snowflake_local.consumer.approve_provider_activation_consent('my_cleanroom', 'activation_my_template');