PIpinterest
ad_groups

Get audience sizing

Changed on

Get potential audience size for an ad group with given targeting criteria. Potential audience size estimates the number of people you may be able to reach per month with your campaign. It is based on historical advertising data and the targeting criteria you select. It does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments.

post/ad_accounts/{ad_account_id}/ad_groups/audience_sizing

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

auto_targeting_enabledboolean

Enable auto-targeting for ad group. Default value is True. Also known as Pinterest Performance+ targeting.

creative_typesAdGroupAudienceSizingCreativeTypes[] nullable

Pin creative types filter. Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.

placement_group'ALL' | 'SEARCH' | 'BROWSE' | 'OTHER'

Campaign placement group type

product_group_idsAdGroupAudienceSizingProductGroupId[] nullable

Targeted product group IDs. Note: This can only be combined with shopping/catalog sales campaigns. For more information, click here. SHOPPING_RETARGETING must be included in targeting_spec object or this field will be ignored.

Example request

{
  "keywords": [
    {
      "match_type": "BROAD"
    }
  ],
  "targeting_spec": {
    "SHOPPING_RETARGETING": [
      {
        "lookback_window": 30,
        "exclusion_window": 14,
        "tag_types": [
          0,
          6
        ]
      }
    ]
  }
}

Response

The request has succeeded.

audience_size_lower_boundnumber

The lower confidence bound of the estimated potential audience size. "Potential audience size" estimates the number of people you may be able to reach per month with your campaign. It is based on historical advertising data and the targeting criteria you select. It does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments.

audience_size_upper_boundnumber

The upper confidence bound of the estimated potential audience size. "Potential audience size" estimates the number of people you may be able to reach per month with your campaign. It is based on historical advertising data and the targeting criteria you select. It does not guarantee results or take into account factors such as bid, budget, schedule, seasonality or product experiments.

Changes

  • v5b698c180678aRevision changes
    • breaking

      added to the request property allOf list

    • breaking

      the request property // became not nullable

    • breaking

      removed the enum value undefined of the request property //

    • breaking

      the request property type changed from string to no type

    • breaking

      the // request property type changed from no type to string

    • warning

      removed from the request property allOf list

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response optional property became read-only for the status

    • info

      the response optional property became read-only for the status

    • info

      added the success response with the status

  • v579f62f71f05bRevision changes
    • breaking

      request body became required