PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of gglAdWDefinedReportJob variables
  • Functions that use the gglAdWDefinedReportJob type
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
gglAdWDefinedReportJob (Type of variable)
In French: gglAdWRequêteRapportDéfini (Type de variable)
Warning
From version 17, this feature is not available anymore. To use Google AdWords, see the corresponding Google API: https://developers.google.com/adwords/api/docs/guides/start
The gglAdWDefinedReportJob type represents a request for editing reports about one or more Google AdWords advertising campaigns. This type of variable is used to define the characteristics of the report that will be created by the "Google AdWords Report Service".
The characteristics of this type can be defined and modified by several WLanguage properties.
Caution: The report data is truncated at 263064146 bytes (about 250MB). Google advises you not to generate reports containing "too much" data.
Note: See Declaring a variable for more details.
Example
// Connection to Google
Cnt is gglAdWConnection
Cnt..Email = "vince@gmail.com"
Cnt..Password = "azerty"
Cnt..UserAgent = "MyApp-01"
Cnt..SandboxMode = True

// Create a report
MyRequest is gglAdWDefinedReportJob
MyRequest..AdGroupStatus = gglEnabled + CR + gglPaused
MyRequest..AdWordsType = "searchOnly"
MyRequest..StartDay = "20090302"
MyRequest..EndDay = "20090302"
MyRequest..KeywordStatuses= "Enabled" + CR + "Paused"
MyRequest..Name = "My report of March 3"
MyRequest..SelectedReportType = "Campaign"

// Validate the request and send if OK
id is int = 0
IF GglAdWValidateReportJob(Cnt, MyRequest) THEN
id = GglAdWScheduleReportJob(Cnt, MyRequest)
END
Remarks

Properties specific to the description of gglAdWDefinedReportJob variables

The following properties can be used to handle a request for report:
NameType usedEffect
CampaignCharacter stringList of identifiers for the Google AdWords campaigns that must be included in the report. The different identifiers are separated by CR characters (Carriage Return).
Note: CampaignStatus cannot be specified if this property is specified.
SelectedColumnCharacter stringList of columns that must be included in the report. The different columns are separated by CR characters (Carriage Return).
The list of available columns depends on the selected type of report (SelectedReportType) and on the type of aggregation (AggregationType). See the help about Google AdWords API regarding the rules for managing reports for more details.
ClientEmailCharacter stringThis property must only be used by the managers of a multi-account center (also called My Client Center).
List of identifiers for the client accounts that must be included in the report. The different identifiers are separated by CR characters (Carriage Return)
Note: In order for this list to be used, CrossClient must be set to True.
CampaignStatusCharacter stringList of constants representing the status of the Google AdWords advertising campaigns that must be included in the report. The different constants are separated by CR characters (Carriage Return). Only the campaigns in one of the specified statuses will be included in the report. The possible values are:
  • gglActive
  • gglPaused
  • gglDeleted
Note: Campaign cannot be specified if this property is specified.
AdGroupStatusCharacter stringList of constants representing the status of the ad groups that must be included in the report. The different constants are separated by CR characters (Carriage Return). Only the ad groups in one of the specified statuses will be included in the report. The possible values are:
  • gglEnabled
  • gglPaused
  • gglDeleted
Note: AdGroup cannot be specified if this property is specified.
KeywordStatusesCharacter stringList of statuses for the keywords that must be taken into account in the report. The different statuses are separated by CR characters (Carriage Return). Only the keywords in one of the specified statuses will be included in the report. The possible values are:
  • "Disapproved"
  • "Deleted"
  • "Paused"
  • "Active"
  • "Inactive"
Note: Keyword cannot be specified if this property is specified.
AdGroupCharacter stringList of identifiers for the ad groups that must be included in the report. The different identifiers are separated by CR characters (Carriage Return).
Note: AdGroupStatus cannot be specified if this property is specified.
IdentifierCharacter stringIdentifier of the report. This identifier is associated with the report when running GglAdWScheduleReportJob.
This property is available in read-only
IncludeZeroImpressionBoolean
  • True to include the entities that have not been printed in the report,
  • False to avoid including these elements.
Note: To use this property, SelectedReportType must be equal to "Keyword".
StartDayDateTimeStart date for taking into account the data that must be displayed in the report. This date will be included in the report.
Note: This property must necessarily be specified.
EndDayDateTimeEnd date for taking into account the data that must be displayed in the report. This date will be included in the report.
Note: This property must necessarily be specified.
KeywordCharacter stringKeywords that must be included in the report. By default, all the keywords found in the selected ads and campaigns are included in the report.
Note: KeywordStatuses cannot be specified if this property is specified.
NameCharacter stringName of report (up to 80 characters).
StatusCharacter stringCurrent status of the print request. This property is filled by GglAdWListReportJobs and GglAdWGetReportJobStatus.
The possible values are as follows:
  • "Pending": The request is pending
  • "InProgress": The request is in progress
  • "Completed": The request is completed
  • "Failed": The request failed
CrossClientBooleanThis property must only be used by the managers of a multi-account center (also called My Client Center).
  • True if the report affects a simple account,
  • False if the report affects a set of accounts.
To manage all the accounts in the report, ClientEmail must be left empty.
AdWordsTypeCharacter stringType of the AdWords account to take into account. The available values are as follows:
  • "SearchOnly": the ads are displayed on the result page of the search.
  • "ContentOnly": the ads are displayed on the content pages.
AggregationTypeCharacter stringList of aggregation types that will be used in the report. The different aggregates are separated by CR characters (Carriage Return).
This property depends on the selected type of report (SelectedReportType).
See the help about the Google AdWords API regarding the rules for managing the reports for more details.
KeywordTypeCharacter stringType of the keywords that must be included in the report. By default, all the types of keywords are included in the report.
The available values are as follows:
  • "Broad"
  • "Phrase"
  • "Exact"
SelectedReportTypeCharacter stringType of report to schedule. The available values are:
  • "Account": Performance report for the accounts.
  • "AdGroup": Performance report for the ad groups.
  • "Campaign": Performance report for the campaigns.
  • "Demographic": Performance report for the demographic data.
  • "ContentPlacement": Performance report for specific domains and for specific URLs in the content network.
  • "Creative": Performance report for the ads (text ads, image ads as well as mobile ads and local ads if necessary).
  • "Geographic": Performance report for the geographic data (according to the geographical origin).
  • "Keyword": Performance report for positioning in relation to the keywords used in the campaigns.
  • "Query": Performance report for the search queries (that trigger the display of the ad).
  • "ReachAndFrequency": Report showing how many persons have seen the ad and how many times for a specified period of time.
  • "Structure": Report used to retrieve the data of your account.
  • "Url": Report of the data linked to the ads with a destination URL.
See the help about the Google AdWords API regarding the rules for managing reports for more details.
Note: These properties can be handled by using one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Functions that use the gglAdWDefinedReportJob type

Versions 14 and later
GglAdWScheduleReportJob
New in version 14
GglAdWScheduleReportJob
GglAdWScheduleReportJob
Schedules the execution of a Google AdWords report by the "Google AdWords Report Service".
Versions 14 and later
GglAdWValidateReportJob
New in version 14
GglAdWValidateReportJob
GglAdWValidateReportJob
Validates the description of a Google AdWords report.
Minimum required version
  • Version 14
This page is also available for…
Comments
Click [Add] to post a comment