Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
Differences Between: [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 1543 lines (41 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 22 classes
Google_Service_Doubleclicksearch:: (1 method):
__construct()
Google_Service_Doubleclicksearch_Conversion_Resource:: (5 methods):
get()
insert()
patch()
update()
updateAvailability()
Google_Service_Doubleclicksearch_Reports_Resource:: (4 methods):
generate()
get()
getFile()
request()
Google_Service_Doubleclicksearch_SavedColumns_Resource:: (1 method):
listSavedColumns()
Google_Service_Doubleclicksearch_Availability:: (12 methods):
setAdvertiserId()
getAdvertiserId()
setAgencyId()
getAgencyId()
setAvailabilityTimestamp()
getAvailabilityTimestamp()
setSegmentationId()
getSegmentationId()
setSegmentationName()
getSegmentationName()
setSegmentationType()
getSegmentationType()
Google_Service_Doubleclicksearch_Conversion:: (66 methods):
setAdGroupId()
getAdGroupId()
setAdId()
getAdId()
setAdvertiserId()
getAdvertiserId()
setAgencyId()
getAgencyId()
setAttributionModel()
getAttributionModel()
setCampaignId()
getCampaignId()
setChannel()
getChannel()
setClickId()
getClickId()
setConversionId()
getConversionId()
setConversionModifiedTimestamp()
getConversionModifiedTimestamp()
setConversionTimestamp()
getConversionTimestamp()
setCountMillis()
getCountMillis()
setCriterionId()
getCriterionId()
setCurrencyCode()
getCurrencyCode()
setCustomDimension()
getCustomDimension()
setCustomMetric()
getCustomMetric()
setDeviceType()
getDeviceType()
setDsConversionId()
getDsConversionId()
setEngineAccountId()
getEngineAccountId()
setFloodlightOrderId()
getFloodlightOrderId()
setInventoryAccountId()
getInventoryAccountId()
setProductCountry()
getProductCountry()
setProductGroupId()
getProductGroupId()
setProductId()
getProductId()
setProductLanguage()
getProductLanguage()
setQuantityMillis()
getQuantityMillis()
setRevenueMicros()
getRevenueMicros()
setSegmentationId()
getSegmentationId()
setSegmentationName()
getSegmentationName()
setSegmentationType()
getSegmentationType()
setState()
getState()
setStoreId()
getStoreId()
setType()
getType()
Google_Service_Doubleclicksearch_ConversionList:: (4 methods):
setConversion()
getConversion()
setKind()
getKind()
Google_Service_Doubleclicksearch_CustomDimension:: (4 methods):
setName()
getName()
setValue()
getValue()
Google_Service_Doubleclicksearch_CustomMetric:: (4 methods):
setName()
getName()
setValue()
getValue()
Google_Service_Doubleclicksearch_Report:: (18 methods):
setFiles()
getFiles()
setId()
getId()
setIsReportReady()
getIsReportReady()
setKind()
getKind()
setRequest()
getRequest()
setRowCount()
getRowCount()
setRows()
getRows()
setStatisticsCurrencyCode()
getStatisticsCurrencyCode()
setStatisticsTimeZone()
getStatisticsTimeZone()
Google_Service_Doubleclicksearch_ReportApiColumnSpec:: (20 methods):
setColumnName()
getColumnName()
setCustomDimensionName()
getCustomDimensionName()
setCustomMetricName()
getCustomMetricName()
setEndDate()
getEndDate()
setGroupByColumn()
getGroupByColumn()
setHeaderText()
getHeaderText()
setPlatformSource()
getPlatformSource()
setProductReportPerspective()
getProductReportPerspective()
setSavedColumnName()
getSavedColumnName()
setStartDate()
getStartDate()
Google_Service_Doubleclicksearch_ReportFiles:: (4 methods):
setByteCount()
getByteCount()
setUrl()
getUrl()
Google_Service_Doubleclicksearch_ReportRequest:: (28 methods):
setColumns()
getColumns()
setDownloadFormat()
getDownloadFormat()
setFilters()
getFilters()
setIncludeDeletedEntities()
getIncludeDeletedEntities()
setIncludeRemovedEntities()
getIncludeRemovedEntities()
setMaxRowsPerFile()
getMaxRowsPerFile()
setOrderBy()
getOrderBy()
setReportScope()
getReportScope()
setReportType()
getReportType()
setRowCount()
getRowCount()
setStartRow()
getStartRow()
setStatisticsCurrency()
getStatisticsCurrency()
setTimeRange()
getTimeRange()
setVerifySingleTimeZone()
getVerifySingleTimeZone()
Google_Service_Doubleclicksearch_ReportRequestFilters:: (6 methods):
setColumn()
getColumn()
setOperator()
getOperator()
setValues()
getValues()
Google_Service_Doubleclicksearch_ReportRequestOrderBy:: (4 methods):
setColumn()
getColumn()
setSortOrder()
getSortOrder()
Google_Service_Doubleclicksearch_ReportRequestReportScope:: (14 methods):
setAdGroupId()
getAdGroupId()
setAdId()
getAdId()
setAdvertiserId()
getAdvertiserId()
setAgencyId()
getAgencyId()
setCampaignId()
getCampaignId()
setEngineAccountId()
getEngineAccountId()
setKeywordId()
getKeywordId()
Google_Service_Doubleclicksearch_ReportRequestTimeRange:: (8 methods):
setChangedAttributesSinceTimestamp()
getChangedAttributesSinceTimestamp()
setChangedMetricsSinceTimestamp()
getChangedMetricsSinceTimestamp()
setEndDate()
getEndDate()
setStartDate()
getStartDate()
Google_Service_Doubleclicksearch_ReportRow:: (0 methods):
Google_Service_Doubleclicksearch_SavedColumn:: (6 methods):
setKind()
getKind()
setSavedColumnName()
getSavedColumnName()
setType()
getType()
Google_Service_Doubleclicksearch_SavedColumnList:: (4 methods):
setItems()
getItems()
setKind()
getKind()
Google_Service_Doubleclicksearch_UpdateAvailabilityRequest:: (2 methods):
setAvailabilities()
getAvailabilities()
Google_Service_Doubleclicksearch_UpdateAvailabilityResponse:: (2 methods):
setAvailabilities()
getAvailabilities()
Class: Google_Service_Doubleclicksearch - X-Ref
Service definition for Doubleclicksearch (v2).<p>
Report and modify your advertising data in DoubleClick Search (for example,
campaigns, ad groups, keywords, and conversions).</p>
<p>
For more information about this service, see the API
<a href="https://developers.google.com/doubleclick-search/" target="_blank">Documentation</a>
</p>
| __construct(Google_Client $client) X-Ref |
| Constructs the internal representation of the Doubleclicksearch service. param: Google_Client $client |
Class: Google_Service_Doubleclicksearch_Conversion_Resource - X-Ref
The "conversion" collection of methods.Typical usage is:
<code>
$doubleclicksearchService = new Google_Service_Doubleclicksearch(...);
$conversion = $doubleclicksearchService->conversion;
</code>
| get($agencyId, $advertiserId, $engineAccountId, $endDate, $rowCount, $startDate, $startRow, $optParams = array() X-Ref |
| Retrieves a list of conversions from a DoubleClick Search engine account. (conversion.get) param: string $agencyId Numeric ID of the agency. param: string $advertiserId Numeric ID of the advertiser. param: string $engineAccountId Numeric ID of the engine account. param: int $endDate Last date (inclusive) on which to retrieve conversions. param: int $rowCount The number of conversions to return per call. param: int $startDate First date (inclusive) on which to retrieve param: string $startRow The 0-based starting index for retrieving conversions param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_ConversionList |
| insert(Google_Service_Doubleclicksearch_ConversionList $postBody, $optParams = array() X-Ref |
| Inserts a batch of new conversions into DoubleClick Search. (conversion.insert) param: Google_ConversionList $postBody param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_ConversionList |
| patch($advertiserId, $agencyId, $endDate, $engineAccountId, $rowCount, $startDate, $startRow, Google_Service_Doubleclicksearch_ConversionList $postBody, $optParams = array() X-Ref |
| Updates a batch of conversions in DoubleClick Search. This method supports patch semantics. (conversion.patch) param: string $advertiserId Numeric ID of the advertiser. param: string $agencyId Numeric ID of the agency. param: int $endDate Last date (inclusive) on which to retrieve conversions. param: string $engineAccountId Numeric ID of the engine account. param: int $rowCount The number of conversions to return per call. param: int $startDate First date (inclusive) on which to retrieve param: string $startRow The 0-based starting index for retrieving conversions param: Google_ConversionList $postBody param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_ConversionList |
| update(Google_Service_Doubleclicksearch_ConversionList $postBody, $optParams = array() X-Ref |
| Updates a batch of conversions in DoubleClick Search. (conversion.update) param: Google_ConversionList $postBody param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_ConversionList |
| updateAvailability(Google_Service_Doubleclicksearch_UpdateAvailabilityRequest $postBody, $optParams = array() X-Ref |
| Updates the availabilities of a batch of floodlight activities in DoubleClick Search. (conversion.updateAvailability) param: Google_UpdateAvailabilityRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_UpdateAvailabilityResponse |
Class: Google_Service_Doubleclicksearch_Reports_Resource - X-Ref
The "reports" collection of methods.Typical usage is:
<code>
$doubleclicksearchService = new Google_Service_Doubleclicksearch(...);
$reports = $doubleclicksearchService->reports;
</code>
| generate(Google_Service_Doubleclicksearch_ReportRequest $postBody, $optParams = array() X-Ref |
| Generates and returns a report immediately. (reports.generate) param: Google_ReportRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_Report |
| get($reportId, $optParams = array() X-Ref |
| Polls for the status of a report request. (reports.get) param: string $reportId ID of the report request being polled. param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_Report |
| getFile($reportId, $reportFragment, $optParams = array() X-Ref |
| Downloads a report file encoded in UTF-8. (reports.getFile) param: string $reportId ID of the report. param: int $reportFragment The index of the report fragment to download. param: array $optParams Optional parameters. |
| request(Google_Service_Doubleclicksearch_ReportRequest $postBody, $optParams = array() X-Ref |
| Inserts a report request into the reporting system. (reports.request) param: Google_ReportRequest $postBody param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_Report |
Class: Google_Service_Doubleclicksearch_SavedColumns_Resource - X-Ref
The "savedColumns" collection of methods.Typical usage is:
<code>
$doubleclicksearchService = new Google_Service_Doubleclicksearch(...);
$savedColumns = $doubleclicksearchService->savedColumns;
</code>
| listSavedColumns($agencyId, $advertiserId, $optParams = array() X-Ref |
| Retrieve the list of saved columns for a specified advertiser. (savedColumns.listSavedColumns) param: string $agencyId DS ID of the agency. param: string $advertiserId DS ID of the advertiser. param: array $optParams Optional parameters. return: Google_Service_Doubleclicksearch_SavedColumnList |
Class: Google_Service_Doubleclicksearch_Availability - X-Ref
| setAdvertiserId($advertiserId) X-Ref |
| No description |
| getAdvertiserId() X-Ref |
| No description |
| setAgencyId($agencyId) X-Ref |
| No description |
| getAgencyId() X-Ref |
| No description |
| setAvailabilityTimestamp($availabilityTimestamp) X-Ref |
| No description |
| getAvailabilityTimestamp() X-Ref |
| No description |
| setSegmentationId($segmentationId) X-Ref |
| No description |
| getSegmentationId() X-Ref |
| No description |
| setSegmentationName($segmentationName) X-Ref |
| No description |
| getSegmentationName() X-Ref |
| No description |
| setSegmentationType($segmentationType) X-Ref |
| No description |
| getSegmentationType() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_Conversion - X-Ref
| setAdGroupId($adGroupId) X-Ref |
| No description |
| getAdGroupId() X-Ref |
| No description |
| setAdId($adId) X-Ref |
| No description |
| getAdId() X-Ref |
| No description |
| setAdvertiserId($advertiserId) X-Ref |
| No description |
| getAdvertiserId() X-Ref |
| No description |
| setAgencyId($agencyId) X-Ref |
| No description |
| getAgencyId() X-Ref |
| No description |
| setAttributionModel($attributionModel) X-Ref |
| No description |
| getAttributionModel() X-Ref |
| No description |
| setCampaignId($campaignId) X-Ref |
| No description |
| getCampaignId() X-Ref |
| No description |
| setChannel($channel) X-Ref |
| No description |
| getChannel() X-Ref |
| No description |
| setClickId($clickId) X-Ref |
| No description |
| getClickId() X-Ref |
| No description |
| setConversionId($conversionId) X-Ref |
| No description |
| getConversionId() X-Ref |
| No description |
| setConversionModifiedTimestamp($conversionModifiedTimestamp) X-Ref |
| No description |
| getConversionModifiedTimestamp() X-Ref |
| No description |
| setConversionTimestamp($conversionTimestamp) X-Ref |
| No description |
| getConversionTimestamp() X-Ref |
| No description |
| setCountMillis($countMillis) X-Ref |
| No description |
| getCountMillis() X-Ref |
| No description |
| setCriterionId($criterionId) X-Ref |
| No description |
| getCriterionId() X-Ref |
| No description |
| setCurrencyCode($currencyCode) X-Ref |
| No description |
| getCurrencyCode() X-Ref |
| No description |
| setCustomDimension($customDimension) X-Ref |
| No description |
| getCustomDimension() X-Ref |
| No description |
| setCustomMetric($customMetric) X-Ref |
| No description |
| getCustomMetric() X-Ref |
| No description |
| setDeviceType($deviceType) X-Ref |
| No description |
| getDeviceType() X-Ref |
| No description |
| setDsConversionId($dsConversionId) X-Ref |
| No description |
| getDsConversionId() X-Ref |
| No description |
| setEngineAccountId($engineAccountId) X-Ref |
| No description |
| getEngineAccountId() X-Ref |
| No description |
| setFloodlightOrderId($floodlightOrderId) X-Ref |
| No description |
| getFloodlightOrderId() X-Ref |
| No description |
| setInventoryAccountId($inventoryAccountId) X-Ref |
| No description |
| getInventoryAccountId() X-Ref |
| No description |
| setProductCountry($productCountry) X-Ref |
| No description |
| getProductCountry() X-Ref |
| No description |
| setProductGroupId($productGroupId) X-Ref |
| No description |
| getProductGroupId() X-Ref |
| No description |
| setProductId($productId) X-Ref |
| No description |
| getProductId() X-Ref |
| No description |
| setProductLanguage($productLanguage) X-Ref |
| No description |
| getProductLanguage() X-Ref |
| No description |
| setQuantityMillis($quantityMillis) X-Ref |
| No description |
| getQuantityMillis() X-Ref |
| No description |
| setRevenueMicros($revenueMicros) X-Ref |
| No description |
| getRevenueMicros() X-Ref |
| No description |
| setSegmentationId($segmentationId) X-Ref |
| No description |
| getSegmentationId() X-Ref |
| No description |
| setSegmentationName($segmentationName) X-Ref |
| No description |
| getSegmentationName() X-Ref |
| No description |
| setSegmentationType($segmentationType) X-Ref |
| No description |
| getSegmentationType() X-Ref |
| No description |
| setState($state) X-Ref |
| No description |
| getState() X-Ref |
| No description |
| setStoreId($storeId) X-Ref |
| No description |
| getStoreId() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_ConversionList - X-Ref
| setConversion($conversion) X-Ref |
| No description |
| getConversion() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_Report - X-Ref
| setFiles($files) X-Ref |
| No description |
| getFiles() X-Ref |
| No description |
| setId($id) X-Ref |
| No description |
| getId() X-Ref |
| No description |
| setIsReportReady($isReportReady) X-Ref |
| No description |
| getIsReportReady() X-Ref |
| No description |
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setRequest(Google_Service_Doubleclicksearch_ReportRequest $request) X-Ref |
| No description |
| getRequest() X-Ref |
| No description |
| setRowCount($rowCount) X-Ref |
| No description |
| getRowCount() X-Ref |
| No description |
| setRows($rows) X-Ref |
| No description |
| getRows() X-Ref |
| No description |
| setStatisticsCurrencyCode($statisticsCurrencyCode) X-Ref |
| No description |
| getStatisticsCurrencyCode() X-Ref |
| No description |
| setStatisticsTimeZone($statisticsTimeZone) X-Ref |
| No description |
| getStatisticsTimeZone() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_ReportApiColumnSpec - X-Ref
| setColumnName($columnName) X-Ref |
| No description |
| getColumnName() X-Ref |
| No description |
| setCustomDimensionName($customDimensionName) X-Ref |
| No description |
| getCustomDimensionName() X-Ref |
| No description |
| setCustomMetricName($customMetricName) X-Ref |
| No description |
| getCustomMetricName() X-Ref |
| No description |
| setEndDate($endDate) X-Ref |
| No description |
| getEndDate() X-Ref |
| No description |
| setGroupByColumn($groupByColumn) X-Ref |
| No description |
| getGroupByColumn() X-Ref |
| No description |
| setHeaderText($headerText) X-Ref |
| No description |
| getHeaderText() X-Ref |
| No description |
| setPlatformSource($platformSource) X-Ref |
| No description |
| getPlatformSource() X-Ref |
| No description |
| setProductReportPerspective($productReportPerspective) X-Ref |
| No description |
| getProductReportPerspective() X-Ref |
| No description |
| setSavedColumnName($savedColumnName) X-Ref |
| No description |
| getSavedColumnName() X-Ref |
| No description |
| setStartDate($startDate) X-Ref |
| No description |
| getStartDate() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_ReportFiles - X-Ref
| setByteCount($byteCount) X-Ref |
| No description |
| getByteCount() X-Ref |
| No description |
| setUrl($url) X-Ref |
| No description |
| getUrl() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_ReportRequest - X-Ref
| setColumns($columns) X-Ref |
| No description |
| getColumns() X-Ref |
| No description |
| setDownloadFormat($downloadFormat) X-Ref |
| No description |
| getDownloadFormat() X-Ref |
| No description |
| setFilters($filters) X-Ref |
| No description |
| getFilters() X-Ref |
| No description |
| setIncludeDeletedEntities($includeDeletedEntities) X-Ref |
| No description |
| getIncludeDeletedEntities() X-Ref |
| No description |
| setIncludeRemovedEntities($includeRemovedEntities) X-Ref |
| No description |
| getIncludeRemovedEntities() X-Ref |
| No description |
| setMaxRowsPerFile($maxRowsPerFile) X-Ref |
| No description |
| getMaxRowsPerFile() X-Ref |
| No description |
| setOrderBy($orderBy) X-Ref |
| No description |
| getOrderBy() X-Ref |
| No description |
| setReportScope(Google_Service_Doubleclicksearch_ReportRequestReportScope $reportScope) X-Ref |
| No description |
| getReportScope() X-Ref |
| No description |
| setReportType($reportType) X-Ref |
| No description |
| getReportType() X-Ref |
| No description |
| setRowCount($rowCount) X-Ref |
| No description |
| getRowCount() X-Ref |
| No description |
| setStartRow($startRow) X-Ref |
| No description |
| getStartRow() X-Ref |
| No description |
| setStatisticsCurrency($statisticsCurrency) X-Ref |
| No description |
| getStatisticsCurrency() X-Ref |
| No description |
| setTimeRange(Google_Service_Doubleclicksearch_ReportRequestTimeRange $timeRange) X-Ref |
| No description |
| getTimeRange() X-Ref |
| No description |
| setVerifySingleTimeZone($verifySingleTimeZone) X-Ref |
| No description |
| getVerifySingleTimeZone() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_ReportRequestOrderBy - X-Ref
| setColumn(Google_Service_Doubleclicksearch_ReportApiColumnSpec $column) X-Ref |
| No description |
| getColumn() X-Ref |
| No description |
| setSortOrder($sortOrder) X-Ref |
| No description |
| getSortOrder() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_ReportRequestReportScope - X-Ref
| setAdGroupId($adGroupId) X-Ref |
| No description |
| getAdGroupId() X-Ref |
| No description |
| setAdId($adId) X-Ref |
| No description |
| getAdId() X-Ref |
| No description |
| setAdvertiserId($advertiserId) X-Ref |
| No description |
| getAdvertiserId() X-Ref |
| No description |
| setAgencyId($agencyId) X-Ref |
| No description |
| getAgencyId() X-Ref |
| No description |
| setCampaignId($campaignId) X-Ref |
| No description |
| getCampaignId() X-Ref |
| No description |
| setEngineAccountId($engineAccountId) X-Ref |
| No description |
| getEngineAccountId() X-Ref |
| No description |
| setKeywordId($keywordId) X-Ref |
| No description |
| getKeywordId() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_ReportRequestTimeRange - X-Ref
| setChangedAttributesSinceTimestamp($changedAttributesSinceTimestamp) X-Ref |
| No description |
| getChangedAttributesSinceTimestamp() X-Ref |
| No description |
| setChangedMetricsSinceTimestamp($changedMetricsSinceTimestamp) X-Ref |
| No description |
| getChangedMetricsSinceTimestamp() X-Ref |
| No description |
| setEndDate($endDate) X-Ref |
| No description |
| getEndDate() X-Ref |
| No description |
| setStartDate($startDate) X-Ref |
| No description |
| getStartDate() X-Ref |
| No description |
Class: Google_Service_Doubleclicksearch_SavedColumn - X-Ref
| setKind($kind) X-Ref |
| No description |
| getKind() X-Ref |
| No description |
| setSavedColumnName($savedColumnName) X-Ref |
| No description |
| getSavedColumnName() X-Ref |
| No description |
| setType($type) X-Ref |
| No description |
| getType() X-Ref |
| No description |
