Validates parts of an AWQL string.
validateFieldName(string $fieldName): \Google\AdsApi\AdWords\Query\ValidationResult
Validates a field name for using in the SELECT, WHERE or ORDER BY clauses of an AWQL string.
| string | $fieldName | the field name to be validated |
the object containing whether the validation is passed or failed with detail explanation
validateCustomDateRange(string $startDateString,string $endDateString): \Google\AdsApi\AdWords\Query\ValidationResult
Validates the start and end dates of a custom date range in the DURING clause of an AWQL string.
| string | $startDateString | the start date string |
| string | $endDateString | the end date string |
the object containing whether the validation is passed or failed with detail explanation
validateServiceQuery(string $awqlString,boolean|null $allowPagination = true): \Google\AdsApi\AdWords\Query\ValidationResult
Validates a service query AWQL string.
| string | $awqlString | the AWQL string to be validated |
| boolean|null | $allowPagination | optional, indicates whether the AWQL is allowed to have the pagination (LIMIT) clause |
the object containing whether the validation is passed or failed with detail explanation
validateReportQuery(string $awqlString): \Google\AdsApi\AdWords\Query\ValidationResult
Validates a report query AWQL string.
| string | $awqlString | the AWQL string to be validated |
the object containing whether the validation is passed or failed with detail explanation
containKeywords(string $awqlString,array<mixed,string> $clauseKeywords,boolean $containAll): boolean
Checks if an AWQL string contains certain clauses by searching for the clause opening keywords.
| string | $awqlString | the AWQL string to check |
| array<mixed,string> | $clauseKeywords | the clause opening keywords (e.g. SELECT, FROM, WHERE, ORDER BY) to search |
| boolean | $containAll | whether the AWQL string should contain all of the given keywords. Set to false for checking whether the AWQL string should contain any of the given keywords |
true if the AWQL string contains all or any the clause
keywords accordingly to the $containAll parameter; Otherwise,
returns false
containAllKeywords(string $awqlString,array<mixed,string> $clauseKeywords): boolean
Checks if the AWQL string contains all of the clause opening keywords.
| string | $awqlString | the AWQL string to check |
| array<mixed,string> | $clauseKeywords | the clause opening keywords (e.g. SELECT, FROM, WHERE, ORDER BY) to search |
true if the AWQL string contains all of the given keywords; Otherwise, returns false
containAnyKeywords(string $awqlString,array<mixed,string> $clauseKeywords): boolean
Checks if the AWQL string contains any of the given clause opening keywords.
| string | $awqlString | the AWQL string to check |
| array<mixed,string> | $clauseKeywords | the clause opening keywords (e.g. SELECT, FROM, WHERE, ORDER BY) to search |
true if the AWQL string contains any of the given keywords; Otherwise, returns false
validateQuery(string $awqlString,array<mixed,string> $requiredKeywords,array<mixed,string> $forbiddenKeywords): \Google\AdsApi\AdWords\Query\ValidationResult
Checks if the AWQL string contains the required clause opening keywords, but not the forbidden ones.
| string | $awqlString | the AWQL string to check |
| array<mixed,string> | $requiredKeywords | the opening keywords (e.g. SELECT, FROM, WHERE, ORDER BY) for the required clauses |
| array<mixed,string> | $forbiddenKeywords | the opening keywords (e.g. SELECT, FROM, WHERE, ORDER BY) for the forbidden clauses |
the object containing whether the validation is passed or failed with detail explanation