Skip to main content

Campaign Info

Status: Trusted Tester

Information about an advertising campaign. Requires an Advanced Reporting Addon to be active on the Business Location to access

idstringrequired

The resource ID of the Connected Advertising Account

Example: AG-HDV4JKHW:google:7531238654:94749174
typestringrequired

campaignInfo

Possible values: [campaignInfo]

Default value: campaignInfo
attributes objectrequired
namestring

Name of the Campaign

isConnectedboolean

Flag indicating if the campaign is connected to the Business Location. Only stats from connected camapigns will be included in total account stats

statusstring

notSet - Default value, Campaign status is unknown or unset

pending - Campaign is pending review

needsAttention - Campaign is experiencing issues during creation that requires user action

scheduled - Campaign is sheduled to begin at a future date

live - Campaign is currently running

paused - Campaign has been paused and is not currently running

removed - Camapign has been removed or deleted

ended - Campaign has ended and is no longer runnning

Possible values: [notSet, pending, needsAttention, scheduled, live, paused, removed, ended]

startAtdate-time

Start date of the campaign

Example: 2018-10-23T00:00:00Z
endAtdate-time

End date of the campaign

Example: 2022-02-17T00:00:00Z
Campaign Info
{
  "id": "AG-HDV4JKHW:google:7531238654:94749174",
  "type": "campaignInfo",
  "attributes": {
    "name": "string",
    "isConnected": true,
    "status": "notSet",
    "startAt": "2018-10-23T00:00:00Z",
    "endAt": "2022-02-17T00:00:00Z"
  }
}