No public description

PiperOrigin-RevId: 735751140
Change-Id: Ifa795164478679905c7f71b1c34a4dcb93fde9f7

Author: thinkallabout

adservices_cli/ad_selection.py

@@ -15,9 +15,11 @@
 """Command for interacting with Protected Audience Ad Selection CLI Commands."""
 
 import base64
+import gzip
 import json
 
 from google.protobuf.json_format import MessageToJson
+from google.protobuf.message import DecodeError
 
 import adb
 import bidding_auction_servers_pb2
@@ -30,6 +32,7 @@
 _CONSENTED_DEBUG_COMMAND_ENABLE_EXPIRY_IN_HOURS = "--expires-in-hours"
 _CONSENTED_DEBUG_COMMAND_DISABLE = "disable"
 _CONSENTED_DEBUG_COMMAND_VIEW = "view"
+_FAILURE_TEMPLATE = "Failed to parse output: %s"
 _GET_AD_SELECTION_DATA_COMMAND = "get-ad-selection-data"
 _VIEW_AUCTION_RESULT_COMMAND = "view-auction-result"
 _ARG_BUYER = "--buyer"
@@ -118,11 +121,14 @@ def disable_consented_debug(self) -> str:
         )
     )
 
-  def get_ad_selection_data(self, buyer: str) -> str:
-    """Prints the JSON formatted input for GetBids request to BuyerFrontEnd service.
+  def get_ad_selection_data(self, buyer: str = "") -> str:
+    """Prints the JSON formatted input for usage with secure_invoke.
 
     Args:
-      buyer: AdTech buyer.
+      buyer: AdTech buyer used to generate the payload to a BuyerFrontend
+        GetBids API. If omitted, then an "raw" SelectAdRequest will be returned
+        for usage with an SellerFrontend SelectAds API. Note that this only
+        works with secure_invoke.
 
     Returns:
       Textual output of get_ad_selection__data command.
@@ -132,18 +138,97 @@ def get_ad_selection_data(self, buyer: str) -> str:
             _COMMAND_PREFIX,
             _GET_AD_SELECTION_DATA_COMMAND,
             "",
-            {_ARG_BUYER: buyer},
+            {_ARG_BUYER: buyer} if buyer else {},
         )
     )
     try:
-      proto_json = json.loads(command_output)
+      proto_json = json.loads(command_output.replace("\n", ""))
       base64_decoded_str = base64.b64decode(proto_json.get("output_proto"))
-      return MessageToJson(
-          bidding_auction_servers_pb2.GetBidsRequest.GetBidsRawRequest.FromString(
+      if buyer:
+        print("Querying for buyer: " + buyer)
+        try:
+          message = bidding_auction_servers_pb2.GetBidsRequest.GetBidsRawRequest.FromString(
               base64_decoded_str
           )
-      )
-    except ValueError:
+          return MessageToJson(message)
+        except DecodeError as e:
+          return _FAILURE_TEMPLATE % e
+      else:
+        print("Querying for seller")
+        try:
+          auction_input = (
+              bidding_auction_servers_pb2.ProtectedAuctionInput.FromString(
+                  base64_decoded_str
+              )
+          )
+        except DecodeError as e:
+          return _FAILURE_TEMPLATE % e
+        decompressed_buyer_inputs = {}
+        for buyer, compressed_buyer_input in auction_input.buyer_input.items():
+          buyer_input_bytes = gzip.decompress(compressed_buyer_input)
+          buyer_input = bidding_auction_servers_pb2.BuyerInput.FromString(
+              buyer_input_bytes
+          )
+          interest_groups = []
+          for interest_group in buyer_input.interest_groups:
+            interest_groups.append({
+                "name": interest_group.name,
+                "origin": interest_group.origin,
+                "bidding_signals_keys": list(
+                    interest_group.bidding_signals_keys
+                ),
+                "ad_render_ids": list(interest_group.ad_render_ids),
+                "component_ads": list(interest_group.component_ads),
+                "user_bidding_signals": interest_group.user_bidding_signals,
+            })
+          raw_buyer_input = {
+              "interest_groups": interest_groups,
+          }
+          if buyer_input.protected_app_signals.app_install_signals:
+            raw_buyer_input["protected_app_signals"] = {
+                "app_install_signals": base64.b64encode(
+                    buyer_input.protected_app_signals.app_install_signals
+                    or "{}"
+                ).decode("utf-8"),
+                "encoding_version": (
+                    buyer_input.protected_app_signals.encoding_version
+                ),
+            }
+          decompressed_buyer_inputs[buyer] = raw_buyer_input
+        empty_per_buyer_config = {}
+        for buyer in decompressed_buyer_inputs:
+          empty_per_buyer_config[buyer] = {
+              "buyer_signals": "Replace-With-Buyer-Signals",
+              "auction_signals": "Replace-With-Auction-Signals",
+          }
+        return json.dumps({
+            "auction_config": {
+                "seller_signals": "Replace-With-Seller-Signals",
+                "auction_signals": "Replace-With-Auction-Signals",
+                "buyer_list": list(decompressed_buyer_inputs.keys()),
+                "seller": "Replace-With-Seller",
+                "per_buyer_config": empty_per_buyer_config,
+            },
+            "client_type": "CLIENT_TYPE_ANDROID",
+            "raw_protected_audience_input": {
+                "raw_buyer_input": decompressed_buyer_inputs,
+                "publisher_name": auction_input.publisher_name,
+                "enable_debug_reporting": auction_input.enable_debug_reporting,
+                "generation_id": auction_input.generation_id,
+                "consented_debug_config": {
+                    "is_consented": (
+                        auction_input.consented_debug_config.is_consented
+                    ),
+                    "token": auction_input.consented_debug_config.token,
+                    "is_debug_info_in_response": (
+                        auction_input.consented_debug_config.is_debug_info_in_response
+                    ),
+                },
+            },
+        })
+
+    except ValueError as e:
+      print("Failed to parse output: %s" % e)
       return command_output
 
   def view_auction_result(self, ad_selection_id: str) -> str:

adservices_cli/ad_selection_test.py

@@ -35,11 +35,20 @@
 )
 
 _GET_AD_SELECTION_DATA_SHELL_CMD_RESPONSE = '{"output_proto":"EvgBCngKCXdpbm5pbmdDQRIFc2hvZXMSIGJhLWJ1eWVyLTVqeXk1dWxhZ3EtdWMuYS5ydW4uYXBwEgRrZXkxEgRrZXkyGgExKgJ7fUIvY29tLmV4YW1wbGUuYWRzZXJ2aWNlcy5zYW1wbGVzLmZsZWRnZS5zYW1wbGVhcHAKfAoNc2hpcnRzX3NlcnZlchIFc2hvZXMSIGJhLWJ1eWVyLTVqeXk1dWxhZ3EtdWMuYS5ydW4uYXBwEgRrZXkxEgRrZXkyGgEyKgJ7fUIvY29tLmV4YW1wbGUuYWRzZXJ2aWNlcy5zYW1wbGVzLmZsZWRnZS5zYW1wbGVhcHAaAnt9IgJ7fSpAUGxhY2Vob2xkZXItU2hvdWxkLU1hdGNoLVdpdGgtU2VsbGVyLU9yaWdpbi1Eb21haW4tSW4tU0ZFLUNvbmZpZzIuUGxhY2Vob2xkZXItU2hvdWxkLU1hdGNoLVdpdGgtQXBwLVBhY2thZ2UtTmFtZTgBSg4IARIKMTIzNDU2Nzg5MFICCgBYAWJKUGxhY2Vob2xkZXItU2hvdWxkLU1hdGNoLVdpdGgtVG9wLUxldmVsLVNlbGxlci1PcmlnaW4tRG9tYWluLUluLVNGRS1Db25maWdoAHAB"}'
+_GET_AD_SELECTION_DATA_SHELL_CMD_RESPONSE_FOR_SELLER = '{"output_proto":"CooBCgtleGFtcGxlLmNvbRJ7H4sIAAAAAAAA\\/+NK5uIsz8zLy8xLd3YUYi3OyE8tFuJOrUjMLchJ\n1UvOzxViyU6tNASTRlKMhlpM1bVO+kBxPZiaxJTi1KKyzOTUYr1isEixXlpOakp6KpSbWFDAlc7F\nW5yRWVRSHA9Sm1pE2CIjsiwCAAj\\/PHbOAAAAEi5QbGFjZWhvbGRlci1TaG91bGQtTWF0Y2gtV2l0aC1BcHAtUGFja2FnZS1OYW1lGAEiFC01NjU2OTEzNzcwNjQ1MjI1NDIzKgAwAVAB"}'
+_GET_AD_SELECTION_DATA_SHELL_CMD_RESPONSE_FOR_SELLER_EMPTY = '{"output_proto":"Ei5QbGFjZWhvbGRlci1TaG91bGQtTWF0Y2gtV2l0aC1BcHAtUGFja2FnZS1OYW1lGAEiFC00NzU2\nMjI2NjQ2NTEwODU1MjUzKgAwAVAB\n"}'
+_GET_AD_SELECTION_DATA_SHELL_CMD_INVALID_PROTO_RESPONSE = '{"output_proto":"EvgBCngKCXdpbm5pbmdDQRIFc2hvZXMSIGJhLWJ1eWVyLTVqeXk1dWxhZ3EtdWMuYS5ydW4uYXBwEgRrZXkxEgRrZXkyGgExKgJ7fUIvY29tLmV4YW1wbGUuYWRzZXJ2aWNlcy5zYW1wbGVzLmZsZWRnZS5zYW1wbGVhcA=="}'
 
 
 _GET_AD_SELECTION_DATA_EXPECTED_RESPONSE = json.loads(
     '{"buyerInput":{"interestGroups":[{"name":"winningCA","biddingSignalsKeys":["shoes","ba-buyer-5jyy5ulagq-uc.a.run.app","key1","key2"],"adRenderIds":["1"],"userBiddingSignals":"{}","origin":"com.example.adservices.samples.fledge.sampleapp"},{"name":"shirts_server","biddingSignalsKeys":["shoes","ba-buyer-5jyy5ulagq-uc.a.run.app","key1","key2"],"adRenderIds":["2"],"userBiddingSignals":"{}","origin":"com.example.adservices.samples.fledge.sampleapp"}]},"auctionSignals":"{}","buyerSignals":"{}","seller":"Placeholder-Should-Match-With-Seller-Origin-Domain-In-SFE-Config","publisherName":"Placeholder-Should-Match-With-App-Package-Name","enableDebugReporting":true,"consentedDebugConfig":{"isConsented":true,"token":"1234567890"},"protectedAppSignalsBuyerInput":{"protectedAppSignals":{}},"clientType":"CLIENT_TYPE_ANDROID","topLevelSeller":"Placeholder-Should-Match-With-Top-Level-Seller-Origin-Domain-In-SFE-Config","buyerKvExperimentGroupId":0,"enableUnlimitedEgress":true}'
 )
+_GET_AD_SELECTION_DATA_EXPECTED_RESPONSE_FOR_SELLER = json.loads(
+    '{"auction_config":{"seller_signals":"Replace-With-Seller-Signals","auction_signals":"Replace-With-Auction-Signals","buyer_list":["example.com"],"seller":"Replace-With-Seller","per_buyer_config":{"example.com":{"buyer_signals":"Replace-With-Buyer-Signals","auction_signals":"Replace-With-Auction-Signals"}}},"client_type":"CLIENT_TYPE_ANDROID","raw_protected_audience_input":{"raw_buyer_input":{"example.com":{"interest_groups":[{"name":"winningCA","origin":"com.example.adservices.samples.fledge.sampleapp","bidding_signals_keys":["shoes","example.com","key1","key2"],"ad_render_ids":["1"],"component_ads":[],"user_bidding_signals":"{}"},{"name":"shirts_server","origin":"com.example.adservices.samples.fledge.sampleapp","bidding_signals_keys":["shoes","example.com","key1","key2"],"ad_render_ids":["2"],"component_ads":[],"user_bidding_signals":"{}"}]}},"publisher_name":"Placeholder-Should-Match-With-App-Package-Name","enable_debug_reporting":true,"generation_id":"-5656913770645225423","consented_debug_config":{"is_consented":false,"token":"","is_debug_info_in_response":false}}}'
+)
+_GET_AD_SELECTION_DATA_EXPECTED_RESPONSE_FOR_SELLER_EMPTY = json.loads(
+    '{"client_type":"CLIENT_TYPE_ANDROID","auction_config":{"seller_signals":"Replace-With-Seller-Signals","auction_signals":"Replace-With-Auction-Signals","buyer_list":[],"seller":"Replace-With-Seller","per_buyer_config":{}},"raw_protected_audience_input":{"raw_buyer_input":{},"publisher_name":"Placeholder-Should-Match-With-App-Package-Name","enable_debug_reporting":true,"generation_id":"-4756226646510855253","consented_debug_config":{"is_consented":false,"token":"","is_debug_info_in_response":false}}}'
+)
 
 _GET_AD_SELECTION_DATA_SHELL_CMD_NO_DATA_RESPONSE = (
     "could not find data for buyer: test-buyer"
@@ -154,6 +163,78 @@ def test_get_ad_selection_data_happy_path(self):
     json_output = json.loads(output)
     self.assertEqual(json_output, _GET_AD_SELECTION_DATA_EXPECTED_RESPONSE)
 
+  def test_get_ad_selection_data_happy_path_for_seller(self):
+    self.adb.set_shell_outputs(
+        [_GET_AD_SELECTION_DATA_SHELL_CMD_RESPONSE_FOR_SELLER]
+    )
+
+    output = self.ad_selection.get_ad_selection_data()
+
+    self.assertContainsSubset(
+        utilities.split_adb_command(ad_selection._COMMAND_PREFIX)
+        + [
+            ad_selection._GET_AD_SELECTION_DATA_COMMAND,
+        ],
+        self.adb.shell_calls[0],
+    )
+    print("output: ")
+    print(output)
+    json_output = json.loads(output)
+    self.assertEqual(
+        json_output, _GET_AD_SELECTION_DATA_EXPECTED_RESPONSE_FOR_SELLER
+    )
+
+  def test_get_ad_selection_data_happy_path_for_seller_empty(self):
+    self.adb.set_shell_outputs(
+        [_GET_AD_SELECTION_DATA_SHELL_CMD_RESPONSE_FOR_SELLER_EMPTY]
+    )
+
+    output = self.ad_selection.get_ad_selection_data()
+
+    self.assertContainsSubset(
+        utilities.split_adb_command(ad_selection._COMMAND_PREFIX)
+        + [
+            ad_selection._GET_AD_SELECTION_DATA_COMMAND,
+        ],
+        self.adb.shell_calls[0],
+    )
+    json_output = json.loads(output)
+    self.assertEqual(
+        json_output, _GET_AD_SELECTION_DATA_EXPECTED_RESPONSE_FOR_SELLER_EMPTY
+    )
+
+  def test_get_ad_selection_data_invalid_proto(self):
+    self.adb.set_shell_outputs(
+        [_GET_AD_SELECTION_DATA_SHELL_CMD_INVALID_PROTO_RESPONSE]
+    )
+
+    output = self.ad_selection.get_ad_selection_data(buyer="test-buyer")
+
+    self.assertStartsWith(output, ad_selection._FAILURE_TEMPLATE % "")
+    self.assertContainsSubset(
+        utilities.split_adb_command(ad_selection._COMMAND_PREFIX)
+        + [
+            ad_selection._GET_AD_SELECTION_DATA_COMMAND,
+        ],
+        self.adb.shell_calls[0],
+    )
+
+  def test_get_ad_selection_data_invalid_proto_seller(self):
+    self.adb.set_shell_outputs(
+        [_GET_AD_SELECTION_DATA_SHELL_CMD_INVALID_PROTO_RESPONSE]
+    )
+
+    output = self.ad_selection.get_ad_selection_data()
+
+    self.assertStartsWith(output, ad_selection._FAILURE_TEMPLATE % "")
+    self.assertContainsSubset(
+        utilities.split_adb_command(ad_selection._COMMAND_PREFIX)
+        + [
+            ad_selection._GET_AD_SELECTION_DATA_COMMAND,
+        ],
+        self.adb.shell_calls[0],
+    )
+
   def test_get_ad_selection_data_no_data_for_buyer(self):
     self.adb.set_shell_outputs(
         [_GET_AD_SELECTION_DATA_SHELL_CMD_NO_DATA_RESPONSE]