Campaign Info

Below are the metrics available in Campaign Info.

📘

Note

All timestamps are provided in RFC3339 format and are based on the platform's timezone. This includes: creative.created_at, creative.updated_at, schedule_start, schedule_end, created_at, updated_at, timestamp


Field nameSub field nameTypeModeDescription
ad_account_idSTRINGREQUIREDThe id of the ad account that owns this campaign. It is platform-specific ad_account_id. Value and format can vary according to each Platform.
campaign_idSTRINGREQUIREDThe unique identifier of the campaign.
campaign_titleSTRINGNULLABLEA descriptive name of the campaign.
creativeSTRINGREPEATEDA container for all the creative asset information associated with the campaign. This field will only be provided when the creative configuration is enabled.
idSTRINGNULLABLEThe unique identifier of the creative.
titleSTRINGNULLABLETitle of the creative. It is often set as the file name of the image.
review_statusSTRINGNULLABLEThe review status of the creative. e.g., APPROVED, IN_REVIEW, REJECTED
created_atSTRINGNULLABLEThe timestamp when the creative was first created.
updated_atSTRINGNULLABLEThe timestamp when the campaign was last updated.
schedule_startSTRINGNULLABLEThe scheduled start time for the campaign.
schedule_endSTRINGNULLABLEThe scheduled end time for the campaign.
daily_budgetINTEGERNULLABLEA monetary amount in a specific currency; the unit is micro at fixed point value for accurate accumulation operation.
goal_typeSTRINGNULLABLECampaignGoal describes which cost-metric goal a campaign aims for. e.g., UNKNOWN_TYPE OPTIMIZE_NONE FIXED_CPC OPTIMIZE_ROAS FIXED_COMMISSION_RATE FIXED_CPM
target_cpcSTRINGNULLABLEA monetary amount in a specific currency; the unit is micro at fixed point value for accurate accumulation operation.
target_cpmSTRINGNULLABLEA monetary amount in a specific currency; the unit is micro at fixed point value for accurate accumulation operation.
target_roasSTRINGNULLABLETarget ROAS in percent.
catalog_item_idsSTRINGREPEATEDList of catalog items belonging to the campaign. A catalog item id can be a product id or deal id in the catalogs. Note that an item can belong to multiple campaigns.
stateBOOLEANNULLABLEThe state of the campaign. true(active) or false(inactive)
created_atSTRINGNULLABLEThe timestamp when the campaign was first created.
updated_atSTRINGNULLABLEThe timestamp when the campaign was last updated.
enabling_stateSTRINGNULLABLEThe status of the campaign's enabling condition, which determines its ability to run. e.g., UNKNOWN_STATE, ENABLED, DISABLED
offsite_setting_budgetINTEGERNULLABLEThe budget allocated for offsite settings within the campaign.
timestampSTRINGNULLABLEThe timestamp when the snapshot of the campaign was taken.