Query Campaigns

id

integer

EQUALS, IN

Yes

System-assigned unique identifier for the campaign.

name

string

EQUALS, IN, LIKE, STARTS_WITH, ENDS_WITH

Yes

Campaign name.

status

string (enum)

EQUALS, IN

Yes

Captures the advertiser’s intent for the campaign to serve. See Campaignstatus.

systemStatus

string (enum)

EQUALS, IN

Yes

System-computed operational status reflecting the campaign’s serving state. See Campaignsystemstatus.

systemStatusReasons

array of strings

CONTAINS_ANY, CONTAINS_ALL, NOT_CONTAINS_ANY, NOT_CONTAINS_ALL

No

Reasons contributing to the current systemStatus. See Campaignsystemstatusreason.

systemStatusLimitingReasons

array of strings

CONTAINS_ANY, CONTAINS_ALL, NOT_CONTAINS_ANY, NOT_CONTAINS_ALL

No

Reasons limiting delivery below maximum potential. See Campaignsystemlimitedstatusreason.

billingEvent

string (enum)

EQUALS, IN

Yes

The event type that triggers a charge. See Billingevent.

paymentModel

string (enum)

EQUALS, IN

Yes

The payment model for the campaign. See Paymentmodel.

promotedObjectType

string (enum)

EQUALS, NOT_EQUALS, IN, NOT_IN

Yes

Whether the campaign promotes an App Store app or a brand. See Promotedobjecttype.

promotedObjectId

string

EQUALS, NOT_EQUALS, IN, NOT_IN

Yes

The identifier of the promoted entity.

startTime

string (ISO 8601)

EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO

Yes

The scheduled start date and time of the campaign.

endTime

string (ISO 8601)

EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO

Yes

The scheduled end date and time of the campaign.

creationTime

string (ISO 8601)

EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO

Yes

Timestamp when the campaign was created.

modificationTime

string (ISO 8601)

EQUALS, NOT_EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN, LESS_THAN_OR_EQUAL_TO

Yes

Timestamp of the last modification to the campaign.

deleted

boolean

EQUALS, IN

Yes

Whether the campaign has been soft-deleted.