DownloadCampaignHierarchy Service Operation
Note
|
|---|
|
The bulk download feature was moved to the Bulk Service. The DownloadCampaignHierarchy operation was replaced by the DownloadCampaignsByAccountIds and DownloadCampaignsByCampaignIds operations. |
Downloads the entities of the specified campaigns or the entities of all of the campaigns in the specified account. You can request all campaign entities or only those that have changed since the last time you synced the campaign data.
|
Note
|
|---|
|
This operation is available only to BulkDownload pilot program participants. |
<wsdl:operation name="DownloadCampaignHierarchy">
<soap:operation soapAction="DownloadCampaignHierarchy" style="document" />
<wsdl:input name="DownloadCampaignHierarchyRequest">
<soap:header message="tns:DownloadCampaignHierarchyRequest_Headers" part="ApplicationToken" use="literal" />
<soap:header message="tns:DownloadCampaignHierarchyRequest_Headers" part="CustomerAccountId" use="literal" />
<soap:header message="tns:DownloadCampaignHierarchyRequest_Headers" part="CustomerId" use="literal" />
<soap:header message="tns:DownloadCampaignHierarchyRequest_Headers" part="DeveloperToken" use="literal" />
<soap:header message="tns:DownloadCampaignHierarchyRequest_Headers" part="Password" use="literal" />
<soap:header message="tns:DownloadCampaignHierarchyRequest_Headers" part="UserName" use="literal" />
<soap:body use="literal" />
</wsdl:input>
<wsdl:output name="DownloadCampaignHierarchyResponse">
<soap:header message="tns:DownloadCampaignHierarchyResponse_Headers" part="TrackingId" use="literal" />
<soap:body use="literal" />
</wsdl:output>
<wsdl:fault name="AdApiFaultDetailFault">
<soap:fault name="AdApiFaultDetailFault" use="literal" />
</wsdl:fault>
<wsdl:fault name="ApiFaultDetailFault">
<soap:fault name="ApiFaultDetailFault" use="literal" />
</wsdl:fault>
</wsdl:operation>
<xs:element name="AdApiFaultDetail" nillable="true" type="tns:AdApiFaultDetail" />
<xs:element name="ApiFaultDetail" nillable="true" type="tns:ApiFaultDetail" />
Request
A DownloadCampaignHierarchyRequest object that contains the request message that the client passes to the service operation.
Response
A DownloadCampaignHierarchyResponse object that contains the response message that the operation returns to the client.
Fault
If the service operation fails, the operation throws a FaultException exception, which contains one of the following objects:
For more information about the fault detail objects, see Handling Errors. For a list of campaign management–specific error codes, see Campaign Management Error Codes. For a list of generic error codes, see Common Error Codes.
