CampaignAdGroupIds Data Object - Campaign Management

Identifies a campaign and the list of its ad groups to import.

Syntax

XML

<xs:complexType name="CampaignAdGroupIds" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="ActiveAdGroupsOnly" nillable="true" type="xs:boolean">
      <xs:annotation>
        <xs:appinfo>
          <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
        </xs:appinfo>
      </xs:annotation>
    </xs:element>
    <xs:element xmlns:q144="http://schemas.microsoft.com/2003/10/Serialization/Arrays" name="AdGroupIds" nillable="true" type="q144:ArrayOflong" />
    <xs:element name="CampaignId" type="xs:long" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "ActiveAdGroupsOnly": "ValueHere",
  "AdGroupIds": [
    "LongValueHere"
  ],
  "CampaignId": "LongValueHere"
}

Elements

The CampaignAdGroupIds object has the following elements: ActiveAdGroupsOnly, AdGroupIds, CampaignId.

Element	Description	Data Type
ActiveAdGroupsOnly	Determines whether to include paused ad groups or only import active ad groups. This element is not returned by default. To get this element, include the ActiveAdGroupsOnly value in the ReturnAdditionalFields element when you call the GetImportJobsByIds and GetImportResults service operations. If this element is true and if the AdGroupIds is not set, then only active ad groups from the campaign will be imported. Paused ad groups will not be imported. If this element is false or empty, then all of the campaign's ad groups will be imported. This element is ignored if specific ad groups are selected in the AdGroupIds element.	boolean
AdGroupIds	Identifies the list of specific ad groups to import within the campaign. If this element is nil or empty, include all ad groups of the campaign. The ActiveAdGroupsOnly element determines whether to include paused ad groups or only import active ad groups.	long array
CampaignId	Identifies the campaign to import.	long

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Used By

GoogleImportJob