Contents

ReportingAdGroup

The response to a request to fetch ad group-level reports.

Declaration

object ReportingAdGroup

Properties

NameTypeDescription
adGroupDisplayStatusstring

The state of the operation.

See AdGroupDisplayStatus for enum descriptions.

adGroupIdint64

The identifier for the ad group.

You can use the EQUALS, IN, and STARTSWITH Selector Condition operators with Get Ad Group-Level Reports.

adGroupNamestring

The name of the ad group. This is unique within the campaign. Reports don’t include deleted ad groups.

You can use the EQUALS, IN, and STARTSWITH Selector Condition operators with Get Ad Group-Level Reports.

adGroupServingStateReasons[string]

A list of reasons that displays when an ad group isn’t running.

See AdGroupServingStateReasons for enum descriptions.

adGroupServingStatusstring

The status of whether the ad group is serving.

See AdGroupServingStatus for value descriptions.

adGroupStatusstring

The status of the ad group.

See AdGroupStatus for value descriptions.

You can use the EQUALS Selector Condition operator with Get Ad Group-Level Reports.

automatedKeywordsOptInboolean

The parameter for enabling and disabling Search Match. If true, the system automatically adds optimized keywords in addition to those you explicitly add to the ad group.

See the Enable and Disable Search Match section of Ad Groups.

You can use the EQUALS Selector Condition operator with Get Ad Group-Level Reports.

automatedKeywordsRequiredboolean

A read-only field validating an automated ad group. Defaults to false. An automated ad group must exist for Maximize Conversions campaigns to run.

biddingStrategystring

The bid strategy for the campaign. See Campaigns.

campaignIdint64

The unique identifier for the campaign.

You can use the EQUALS, IN, and STARTSWITH Selector Condition operators with Get Ad Group-Level Reports.

cpaGoalReportingAdGroup.CpaGoal

The cost-per-acquisition goal.

defaultBidAmountMoney

The default maximum cost per tap or impression bid for the ad group.

deletedboolean

The indicator of whether the ad group is soft-deleted. This includes keywords that belong to an ad group.

You can use the EQUALS and IN Selector Condition operators with the Get Ad Group-Level Reports.

endTimedate-time

The scheduled end date and time for the ad group.

modificationTimedate-time

The date and time of the most recent modification of the object.

orgIdint64

The identifier of the organization that owns the campaign. Your orgId is the same as your account in Apple Ads.

startTimedate-time

The scheduled start date and time for the ad group.

Topics

Dictionaries

See Also

Reports Request and Response Objects