GOgoogle
advertisers

PATCH /v4/advertisers/{advertisersId}/adGroups/{adGroupsId}

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.

Request

Path parameters

advertisersIdstring required
adGroupsIdstring required

Query parameters

updateMaskstring google-fieldmask

Required. The mask to control which fields to update.

Request body

adGroupFormat'AD_GROUP_FORMAT_UNSPECIFIED' | 'AD_GROUP_FORMAT_IN_STREAM' | 'AD_GROUP_FORMAT_VIDEO_DISCOVERY' | 'AD_GROUP_FORMAT_BUMPER' | 'AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM' | 'AD_GROUP_FORMAT_AUDIO' | 'AD_GROUP_FORMAT_RESPONSIVE' | 'AD_GROUP_FORMAT_REACH' | 'AD_GROUP_FORMAT_MASTHEAD' | 'AD_GROUP_FORMAT_DEMAND_GEN'

Required. Immutable. The format of the ads in the ad group.

adGroupIdstring int64

Output only. The unique ID of the ad group. Assigned by the system.

advertiserIdstring int64

Output only. The unique ID of the advertiser the ad group belongs to.

displayNamestring

Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.

entityStatus'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION'

Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is ENTITY_STATUS_ACTIVE.

lineItemIdstring int64

Required. Immutable. The unique ID of the line item that the ad group belongs to.

namestring

Output only. Identifier. The resource name of the ad group.

Response

Successful response

adGroupFormat'AD_GROUP_FORMAT_UNSPECIFIED' | 'AD_GROUP_FORMAT_IN_STREAM' | 'AD_GROUP_FORMAT_VIDEO_DISCOVERY' | 'AD_GROUP_FORMAT_BUMPER' | 'AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM' | 'AD_GROUP_FORMAT_AUDIO' | 'AD_GROUP_FORMAT_RESPONSIVE' | 'AD_GROUP_FORMAT_REACH' | 'AD_GROUP_FORMAT_MASTHEAD' | 'AD_GROUP_FORMAT_DEMAND_GEN'

Required. Immutable. The format of the ads in the ad group.

adGroupIdstring int64

Output only. The unique ID of the ad group. Assigned by the system.

advertiserIdstring int64

Output only. The unique ID of the advertiser the ad group belongs to.

displayNamestring

Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.

entityStatus'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION'

Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is ENTITY_STATUS_ACTIVE.

lineItemIdstring int64

Required. Immutable. The unique ID of the line item that the ad group belongs to.

namestring

Output only. Identifier. The resource name of the ad group.

Changes

No recorded changes to this operation across all 7 revisions of this API.