AdGroup
The response to ad group requests.
Declaration
object AdGroupProperties
| Name | Type | Description |
|---|---|---|
automatedKeywordsOptIn | boolean | The parameter for enabling and disabling Search Match. If Can be toggled See Ad Groups. You can use the |
automatedKeywordsRequired | boolean | A read-only field indicating if this is the automated ad group. Defaults to |
biddingStrategy | string | The bid strategy for the campaign. See Campaigns |
campaignId | int64 | The unique identifier for a campaign. You can use the |
cpaGoal | Money | Optional. The cost-per-acquisition goal. Cannot be set for ad groups in |
defaultBidAmount Required | Money | The default maximum cost-per-tap or cost-per-impression bid for the ad group. You can use the |
deleted | boolean | The indicator of whether the ad group is soft-deleted. This includes keywords that belong to an ad group. You can use the |
displayStatus | string | The status of the ad group. The status resolves according to |
endTime | date-time | The scheduled end time and date for the ad group, which the system determines from the ad group with the latest end time.
|
id | int64 | The unique identifier for the ad group that you can use as You can use the |
modificationTime | date-time | The date and time of the most recent modification of the object. |
name Required | string | The unique name of the ad group. Responses don’t include deleted ad groups. You can use the |
orgId | int64 | The identifier of the organization that owns the campaign. Your |
paymentModel | string | The payment model that you set through Apple Ads. If you don’t set a payment model, campaigns can’t run. See PaymentModel for value descriptions. If you don’t select a payment model, you can still create campaigns. You must select a payment model before a campaign is eligible to run. See BudgetOrder for details about setting a payment model. |
pricingModel Required | string | The type of pricing model for a bid. See PricingModel for value descriptions. |
servingStateReasons | [string] | A list of reasons that displays when an ad group isn’t running. |
servingStatus | string | The status of whether the ad group is serving. |
startTime Required | date-time | The scheduled start date and time for the ad group with the earliest start time in the campaign.
|
status | string | The user-controlled status to enable or pause the ad group. This field is updatable. You can use the |
targetingDimensions | TargetingDimensions | The targeting criteria to narrow the audience. |