Skip to main content

Ad Squad Ui Render Data

The Ad Squad Ui Render Data lives under the Ad Squad entity and it's purpose is to inform Snap Ads manager which business logic to use for the Ad Squad, there is no requirement to implement this entity but you may wish to do so to align with the same Business logic.

Together with the Campaign Objective V2 the Ad Squad Ui Render Data determines the Optimization Goals available to an Ad Squad, for the full business logic see the Business logic - objective to objective_v2 table.

Attributes​

AttributeDescriptionRequiredPossible Values
ad_squad_idAd Squad IDO
conversion_locationThe intended property where the conversion will take placeOAPP, CALL, LEAD_FORM, PUBLIC_PROFILE, TEXT, WEB

Create an Ad Squad Ui Render Data Object​

This request will create an Ad Squad Ui Render Data object for the Ad Squad.

HTTP Request​

POST https://adsapi.snapchat.com/v1/adsquads/{ad_squad_id}/ads

Request Parameters​

ParameterDefaultDescription
ad_squad_idAd Squad ID

Body Parameters​

ParameterDefaultDescription
ad_squad_idAd Squad ID

Example​

Creating an Ad Squad Ui Render Data object for Ad Squad Id 76a22dc1-3785-46b4-b78b-69406018c74c

curl -X POST \
  -d '{
   "ad_squad_ui_render_data": [
       {
            "conversion_location": "WEB"
       }
   ]
}' \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer meowmeowmeow" \
  https://adsapi.snapchat.com/v1/adsquads/76a22dc1-3785-46b4-b78b-69406018c74c/ad_squad_ui_render_data

The above command returns JSON structured like this:

{
  "request_status": "SUCCESS",
  "request_id": "a5ffda46-4630-4f0c-a968-e7cc667e9e6f",
  "ad_squad_ui_render_data": [
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "af0398c3-7097-4cbc-89e1-7b168245009f",
        "ad_squad_id": "76a22dc1-3785-46b4-b78b-69406018c74c",
        "conversion_location": "WEB"
      }
    }
  ]
}

Fetch the Ad Squad Ui Render Data Object for an Ad Squad​

This request will fetch the Ad Squad Ui Render Data object associated with an Ad Squad by using the Ad Squad ID.

HTTP Request​

`GET https://adsapi.snapchat.com/v1/adsquads/{adsquad_id}/ad_squad_ui_render_data

Request Parameters​

ParameterDefaultDescription
ad_squad_idAd Squad ID

Example​

Fetching the Ad Squad Ui Render object for a specific Ad Squad by providing the Ad Squad Ui Render object ID.

curl "https://adsapi.snapchat.com/v1/adsquads/56859a3c-fd0e-40d7-8ec3-063485917ebf/ad_squad_ui_render_data" \
  -H "Authorization: Bearer meowmeowmeow"

The above command returns JSON structured like this:

{
  "request_status": "SUCCESS",
  "request_id": "25c5798b-d395-4bf9-ae78-33688ca6f095",
  "paging": {},
  "ad_squad_ui_render_data": [
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "bc723337-02a0-4ec5-828e-785f220c3c25",
        "ad_squad_id": "56859a3c-fd0e-40d7-8ec3-063485917ebf",
        "conversion_location": "WEB"
      }
    }
  ]
}

Fetch all the Ad Squad Ui Render Data Objects in an Ad Account​

This request will fetch all Ad Squad Ui Render Data objects in an Ad Account.

HTTP Request​

GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/ad_squad_ui_render_data

Request Parameters​

ParameterDefaultDescription
ad_account_idAd Account ID
limitvalue between 50 - 1000

Example​

Fetching an Ad Squad Ui Render object by providing an Id.

curl "https://adsapi.snapchat.com/v1/adaccounts/5a757bbd-87ca-467a-b9bb-013601723041/ad_squad_ui_render_data?ids=bc723337-02a0-4ec5-828e-785f220c3c25" \
  -H "Authorization: Bearer meowmeowmeow"

The above command returns JSON structured like this:

{
  "request_status": "SUCCESS",
  "request_id": "c199fb83-6443-4696-8641-8a101805ca6c",
  "paging": {},
  "ad_squad_ui_render_data": [
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "bc723337-02a0-4ec5-828e-785f220c3c25",
        "ad_squad_id": "56859a3c-fd0e-40d7-8ec3-063485917ebf",
        "conversion_location": "WEB"
      }
    },
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "cb91c26e-b3e1-42c2-8a93-611ea9474d69",
        "ad_squad_id": "a3d49270-a845-4a65-8a2f-496edbbfaf1b",
        "conversion_location": "WEB"
      }
    },
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "8c92c26e-b3e1-42c2-8a93-611ea9474d89",
        "ad_squad_id": "77e49270-a845-4a65-8a2f-496edbbfaf8b",
        "conversion_location": "APP"
      }
    }
  ]
}

Fetch Ad Squad Ui Render Data Object by id​

This request will fetch one or more Ad Squad Ui Render Data objects using their id, the endpoint accepts a comma separated string of id values if you want to request more than one object.

HTTP Request​

GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/ad_squad_ui_render_data?ids={ad_squad_ui_render_data_id}

Request Parameters​

ParameterDefaultDescription
ad_account_idAd Account ID
ad_squad_ui_render_data_idOne or more Ad Squad Ui Render Data ID values, if more than one use comma to separate the ID values

Example 1​

Fetching an Ad Squad Ui Render object by providing an Id.

curl "https://adsapi.snapchat.com/v1/adaccounts/5a757bbd-87ca-467a-b9bb-013601723041/ad_squad_ui_render_data?ids=bc723337-02a0-4ec5-828e-785f220c3c25" \
  -H "Authorization: Bearer meowmeowmeow"

The above command returns JSON structured like this:

{
  "request_status": "SUCCESS",
  "request_id": "7a6199d0-133b-40a6-b26c-da542b6a4816",
  "ad_squad_ui_render_data": [
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "bc723337-02a0-4ec5-828e-785f220c3c25",
        "ad_squad_id": "56859a3c-fd0e-40d7-8ec3-063485917ebf",
        "conversion_location": "WEB"
      }
    }
  ]
}

Example 2​

Fetching two Ad Squad Ui Render objects by providing a string of comma separated values

curl "https://adsapi.snapchat.com/v1/adaccounts/5a757bbd-87ca-467a-b9bb-013601723041/ad_squad_ui_render_data?ids=bc723337-02a0-4ec5-828e-785f220c3c25,cb91c26e-b3e1-42c2-8a93-611ea9474d69" \
  -H "Authorization: Bearer meowmeowmeow"

The above command returns JSON structured like this:

{
  "request_status": "SUCCESS",
  "request_id": "62010bcb-d577-4269-89cc-70b6f326c809",
  "ad_squad_ui_render_data": [
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "bc723337-02a0-4ec5-828e-785f220c3c25",
        "ad_squad_id": "56859a3c-fd0e-40d7-8ec3-063485917ebf",
        "conversion_location": "WEB"
      }
    },
    {
      "sub_request_status": "SUCCESS",
      "ad_squad_ui_render_data": {
        "id": "cb91c26e-b3e1-42c2-8a93-611ea9474d69",
        "ad_squad_id": "a3d49270-a845-4a65-8a2f-496edbbfaf1b",
        "conversion_location": "WEB"
      }
    }
  ]
}
Was this page helpful?
Yes
No