Contents

BrandsOptions

Reports options for brands promoted object campaigns.

Declaration

object BrandsOptions

Properties

NameTypeDescription
includeRows[string]

Row inclusion options for the report. Set to GRAND_TOTAL to append a summary row with aggregated totals across all result rows. EMPTY_METRICS is not a supported value for any brands entity type.

Discussion

The BrandsOptions configures optional row behavior for brands report responses. The only supported value for includeRows is GRAND_TOTAL, which appends an aggregated summary row at the end of the result set. This totals all numeric metric fields across the full result page, giving a quick overview without requiring a client-side sum.

Note that EMPTY_METRICS (which is available for some other promoted object types) is explicitly unsupported for brands entities. If you omit BrandsOptions entirely from the report request, the response returns only individual data rows with no summary.

Example

{
  "includeRows": ["GRAND_TOTAL"]
}

See Also