How to generate csv with awql report?

[Ken Dan Tinio]

Download a criteria performance report with AWQL

Reference: https://developers.google.com/adwords/api/docs/samples/php/reporting#download-a-criteria-performance-report-with-awql

This is my code:

    public static function runExample(AdWordsSession $session, $reportFormat) 

    {

        // Create report query to get the data for last 7 days.

        $reportQuery = 'SELECT CampaignId, AdGroupId, Id, Criteria, CriteriaType, '

            . 'Impressions, Clicks, Cost FROM CRITERIA_PERFORMANCE_REPORT '

            . 'WHERE Status IN [ENABLED, PAUSED] DURING LAST_7_DAYS';

        // Download report as a string.

        $reportDownloader = new ReportDownloader($session);

        // Optional: If you need to adjust report settings just for this one

        // request, you can create and supply the settings override here. Otherwise,

        // default values from the configuration file (adsapi_php.ini) are used.

        $reportSettingsOverride = (new ReportSettingsBuilder())

            ->includeZeroImpressions(false)

            ->build();

        $reportDownloadResult = $reportDownloader->downloadReportWithAwql($reportQuery, $reportFormat, $reportSettingsOverride);

        

        self::$report = $reportDownloadResult->getAsString();

        self::$status  = "success";

        self::$message = "";

    }

    public static function main() 

    {

        // Generate a refreshable OAuth2 credential for authentication.

        $oAuth2Credential = (new OAuth2TokenBuilder())

            ->fromFile()

            ->build();

        // See: AdWordsSessionBuilder for setting a client customer ID that is

        // different from that specified in your adsapi_php.ini file.

        // Construct an API session configured from a properties file and the OAuth2

        // credentials above.

        $session = (new AdWordsSessionBuilder())

            ->fromFile()

            ->withOAuth2Credential($oAuth2Credential)

            ->build();

        try {

            self::runExample($session, DownloadFormat::CSV);

        } catch (\Exception $e) {

            return array(

                "status" => "fail",

                "message" => $e->getMessage()

            );

        }

        

        return array(

            "status" => self::$status,

            "report" => self::$report,

        );

    }

How do I generate the csv?

[Peter Oliquino]

Hi Ken,

Running this PHP example should already generate a report in CSV format. You may specify the type of the report using the "DownloadFormat::CSV" part of the code. You may also refer to this guide for the supported download types.

This said, could you confirm if the generated report is indeed already in CSV?

Best regards,

Peter

AdWords API Team

[Ken Dan Tinio]

No it doesn't generate any file. it just return text, not in array.

[Peter Oliquino]

Hi Ken,

My apologies for not noticing earlier. You will need to remove the "getAsString()" code as this allows the user to download the report as a string object instead of an actual file. Let me know if this helps.

Thanks and regards,

Peter

AdWords API Team

[Ken Dan Tinio]

Where can I set the path?

[Ken Dan Tinio]

I got it. The correct answer is,

$reportDownloadResult->saveToFile('docs/test.csv')

Thank you!