Click to Rate and Give Feedback

  Switch on low bandwidth view
Microsoft Advertising APIs
Reporting SubmitGenerateReport Service Operation

Submits a report request.

<wsdl:operation name="SubmitGenerateReport">
  <soap:operation soapAction="SubmitGenerateReport" style="document"/>
  <wsdl:input name="SubmitGenerateReportRequest">
    <soap:header message="tns:SubmitGenerateReportRequest_Headers" part="ApplicationToken" use="literal"/>
    <soap:header message="tns:SubmitGenerateReportRequest_Headers" part="CustomerAccountId" use="literal"/>
    <soap:header message="tns:SubmitGenerateReportRequest_Headers" part="CustomerId" use="literal"/>
    <soap:header message="tns:SubmitGenerateReportRequest_Headers" part="DeveloperToken" use="literal"/>
    <soap:header message="tns:SubmitGenerateReportRequest_Headers" part="Password" use="literal"/>
    <soap:header message="tns:SubmitGenerateReportRequest_Headers" part="UserName" use="literal"/>
    <soap:body use="literal"/>
  </wsdl:input>
  <wsdl:output name="SubmitGenerateReportResponse">
    <soap:header message="tns:SubmitGenerateReportResponse_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>

A SubmitGenerateReportRequest object that contains the header and parameter information for the service operation.

A SubmitGenerateReportResponse object that contains the response information for the service request.

If a Microsoft adCenter API error occurs, a FaultException exception is thrown. It contains one of the following objects:

For more information about fault detail objects, see Microsoft adCenter API Error Handling. For a list of reporting-specific error codes, see Reporting Error Codes. For a list of generic error codes, see Common Error Codes.

The following is a fictitious example of a SubmitGenerateReport request.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:AccountId xmlns:h="https://adcenter.microsoft.com/v6">accountid</h:AccountId>
    <h:ApplicationToken xmlns:h="https://adcenter.microsoft.com/v6">apptoken</h:ApplicationToken>
    <h:CustomerId xmlns:h="https://adcenter.microsoft.com/v6">customerid</h:CustomerId>
    <h:DeveloperToken xmlns:h="https://adcenter.microsoft.com/v6">devtoken</h:DeveloperToken>
    <h:Password xmlns:h="https://adcenter.microsoft.com/v6">password</h:Password>
    <h:UserName xmlns:h="https://adcenter.microsoft.com/v6">username</h:UserName>
  </s:Header>
  <s:Body>
    <SubmitGenerateReportRequest xmlns="https://adcenter.microsoft.com/v6">
      <ReportRequest i:type="KeywordPerformanceReportRequest" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <Format>Xml</Format>
        <Language>English</Language>
        <ReportName>My Keyword Report</ReportName>
        <ReturnOnlyCompleteData>false</ReturnOnlyCompleteData>
        <Aggregation>Monthly</Aggregation>
        <Columns>
          <KeywordPerformanceReportColumn>AccountName</KeywordPerformanceReportColumn>
          <KeywordPerformanceReportColumn>CampaignName</KeywordPerformanceReportColumn>
          <KeywordPerformanceReportColumn>Keyword</KeywordPerformanceReportColumn>
          <KeywordPerformanceReportColumn>TimePeriod</KeywordPerformanceReportColumn>
          <KeywordPerformanceReportColumn>Impressions</KeywordPerformanceReportColumn>
          <KeywordPerformanceReportColumn>Conversions</KeywordPerformanceReportColumn>
          <KeywordPerformanceReportColumn>AdId</KeywordPerformanceReportColumn>
        </Columns>
        <Filter>
          <AdDistribution>Search</AdDistribution>
          <AdType i:nil="true"/>
          <DeliveredMatchType i:nil="true"/>
          <Keywords i:nil="true" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>
          <LanguageAndRegion>UnitedStates</LanguageAndRegion>
        </Filter>
        <Scope>
          <AccountIds xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <a:int>1234</a:int>
            <a:int>5678</a:int>
          </AccountIds>
          <AdGroups i:nil="true"/>
          <Campaigns i:nil="true"/>
        </Scope>
        <Time i:nil="true"/>
      </ReportRequest>
    </SubmitGenerateReportRequest>
  </s:Body>
</s:Envelope>

The following is a fictitious example of a SubmitGenerateReport response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:TrackingId xmlns:h="https://adcenter.microsoft.com/v6">XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</h:TrackingId>
  </s:Header>
  <s:Body>
    <SubmitGenerateReportResponse xmlns="https://adcenter.microsoft.com/v6">
      <ReportRequestId>XXXXX</ReportRequestId>
    </SubmitGenerateReportResponse>
  </s:Body>
</s:Envelope>

Because this service operation uses arrays, we recommend that you read the Quotas in Microsoft adCenter topic before you use this service operation. Arrays can consume a large percentage of your allocated quota.

The downloaded report is compressed by using zip compression. You must unzip the report before you can use its contents.

For more information, see Request and Download a Report.

WSDL: ReportingService.svc in version 6.

© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker