Operations

• addAdGroup
• addAdGroups
• deleteAdGroup
• deleteAdGroups
• getAdGroup
• getAdGroupAdCount
• getAdGroupContentMatchMaxBid
• getAdGroupExcludedWordsCount
• getAdGroupKeywordCount
• getAdGroups
• getAdGroupsByCampaignID
• getAdGroupsByCampaignIDByStatus
• getAdGroupSponsoredSearchMaxBid
• getOptimizationGuidelinesForAdGroup
• getStatusForAdGroup
• moveAdGroup
• setAdGroupContentMatchMaxBid
• setAdGroupSponsoredSearchMaxBid
• setOptimizationGuidelinesForAdGroup
• updateAdGroup
• updateAdGroups
• updateStatusForAdGroup
• updateStatusForAdGroups

addAdGroup

Create an ad group.

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroup	AdGroup	The new ad group.

Response

AdGroupResponse - The response, which indicates if the operation succeeded or failed.

addAdGroups

Create one or more ad groups.

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroups	AdGroup[]	A list of ad groups.

Response

AdGroupResponse[] - A list of responses, which indicate if the operations succeeded or failed.

deleteAdGroup

Delete the ad group (specified by adGroupID).

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteAdGroups

Delete one or more ad groups (specified by adGroupIDs).

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupIDs	long[]	A list of ad group IDs.

Response

BasicResponse[] - A list of responses, which indicate if the operations succeeded or failed.

getAdGroup

Return the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.

Response

AdGroup - The ad group.

getAdGroupAdCount

Return the number of ads for the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.
includeDeleted	boolean	If True, include the deleted ads in the count.

Response

long - The number of ads for the ad group.

getAdGroupContentMatchMaxBid

Return the maximum bid for Content Match® for the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.

Response

double - The maximum bid for Content Match.

getAdGroupExcludedWordsCount

Return the number of excluded words for the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.
includeDeleted	boolean	If True, include excluded words that are in deleted ad groups in the count.

Response

long - The number of excluded words for the ad group.

getAdGroupKeywordCount

Return the number of keywords for the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.
includeDeleted	boolean	If True, include the deleted keywords in the count.

Response

long - The number of keywords for the ad group.

getAdGroups

Return one or more ad groups (specified by the list of adGroupIDs).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupIDs	long[]	A list of ad group IDs.

Response

AdGroup[] - The list of ad groups.

getAdGroupsByCampaignID

Return the ad groups for the campaign (specified by campaignID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
campaignID	long	The campaign ID.
includeDeleted	boolean	If True, include the deleted ad groups.
startElement	int	The first element to be returned (0-based; if a value <0 is entered, will default to 0).
numElements	int	The number of elements to be returned (1000 maximum; if a value <=0 is entered, will default to 1000).

Response

AdGroup[] - The list of ad groups for the campaign.

getAdGroupsByCampaignIDByStatus

Return the ad groups with the indicated status for the campaign (specified by campaignID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
campaignID	long	The campaign ID.
adGroupStatus	AdGroupStatus	The ad group status.

Response

AdGroup[] - The list of ad groups with the indicated status for the specified campaign.

getAdGroupSponsoredSearchMaxBid

Return the maximum bid for Sponsored Search for the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.

Response

double - The maximum bid for Sponsored Search.

getOptimizationGuidelinesForAdGroup

Return the optimization guidelines for the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: CampaignOptimization

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.

Response

AdGroupOptimizationGuidelines - The optimization guidelines for the ad group.

getStatusForAdGroup

Return the status of the ad group (specified by adGroupID).

Capability required: CampaignRead
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.

Response

AdGroupStatus - The ad group status.

moveAdGroup

Move the ad group (specified by adGroupdID) to the campaign (specified by destinationCampaignID).

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ID of the ad group to be moved.
destinationCampaignID	long	The ID of the campaign to move the ad group to.
newAdGroupName	string	The new name for the ad group. (For this parameter, you may pass in the null string. If you pass in the null string, the old ad group name is used.)

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

setAdGroupContentMatchMaxBid

Set the maximum bid for Content Match® for the ad group (specified by AdGroupID).

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.
maxBid	double	The maximum bid for Content Match.

Response

AdGroupResponse - The response, which indicates if the operation succeeded or failed.

setAdGroupSponsoredSearchMaxBid

Set the maximum bid for Sponsored Search for the ad group (specified by AdGroupID).

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.
maxBid	double	The maximum bid for Sponsored Search.

Response

AdGroupResponse - The response, which indicates if the operation succeeded or failed.

setOptimizationGuidelinesForAdGroup

Set the optimization guidelines for the ad group.

Capability required: CampaignWrite
License command group: CampaignOptimization

Parameters

Parameter	Data Type	Description
optimizationGuidelines	AdGroupOptimizationGuidelines	The optimization guidelines for the ad group.

Response

AdGroupOptimizationGuidelinesResponse - The response, which indicates if the operation succeeded or failed.

updateAdGroup

Update an ad group.

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroup	AdGroup	The ad group.
updateAll	boolean	If True, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared. If False, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an optional element, the current value is not changed.

Response

AdGroupResponse - The response, which indicates if the operation succeeded or failed.

updateAdGroups

Update one or more ad groups.

Capability required: CampaignWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
adGroups	AdGroup[]	A list of ad groups.
updateAll	boolean	If True, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared. If False, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an optional element, the current value is not changed.

Response

AdGroupResponse[] - A list of responses, which indicate if the operations succeeded or failed.

updateStatusForAdGroup

Update the status of the ad group (specified by adGroupID).

Capability required: CampaignWrite
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
adGroupID	long	The ad group ID.
status	AdGroupStatus	The new ad group status. You can set the status to On or Off, but not Deleted. (To delete an ad group, use the deleteAdGroup operation.)

Response

AdGroupResponse - The response, which indicates if the operation succeeded or failed.

updateStatusForAdGroups

Update the status of one or more ad groups (specified by the list of adGroupIDs).

Capability required: CampaignWrite
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
adGroupIDs	long[]	A list of ad group IDs.
status	AdGroupStatus	The new ad group status. You can set the status to On or Off, but not Deleted. (To delete one or more ad groups, use the deleteAdGroups operation.)

Response

AdGroupResponse[] - A list of responses, which indicate if the operations succeeded or failed.