Search moodle.org's
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: 1713 lines (46 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 31 classes

Google_Service_AdExchangeSeller:: (1 method):
  __construct()

Google_Service_AdExchangeSeller_Accounts_Resource:: (2 methods):
  get()
  listAccounts()

Google_Service_AdExchangeSeller_AccountsAdclients_Resource:: (1 method):
  listAccountsAdclients()

Google_Service_AdExchangeSeller_AccountsAlerts_Resource:: (1 method):
  listAccountsAlerts()

Google_Service_AdExchangeSeller_AccountsCustomchannels_Resource:: (2 methods):
  get()
  listAccountsCustomchannels()

Google_Service_AdExchangeSeller_AccountsMetadata_Resource:: (0 methods):

Google_Service_AdExchangeSeller_AccountsMetadataDimensions_Resource:: (1 method):
  listAccountsMetadataDimensions()

Google_Service_AdExchangeSeller_AccountsMetadataMetrics_Resource:: (1 method):
  listAccountsMetadataMetrics()

Google_Service_AdExchangeSeller_AccountsPreferreddeals_Resource:: (2 methods):
  get()
  listAccountsPreferreddeals()

Google_Service_AdExchangeSeller_AccountsReports_Resource:: (1 method):
  generate()

Google_Service_AdExchangeSeller_AccountsReportsSaved_Resource:: (2 methods):
  generate()
  listAccountsReportsSaved()

Google_Service_AdExchangeSeller_AccountsUrlchannels_Resource:: (1 method):
  listAccountsUrlchannels()

Google_Service_AdExchangeSeller_Account:: (6 methods):
  setId()
  getId()
  setKind()
  getKind()
  setName()
  getName()

Google_Service_AdExchangeSeller_Accounts:: (8 methods):
  setEtag()
  getEtag()
  setItems()
  getItems()
  setKind()
  getKind()
  setNextPageToken()
  getNextPageToken()

Google_Service_AdExchangeSeller_AdClient:: (10 methods):
  setArcOptIn()
  getArcOptIn()
  setId()
  getId()
  setKind()
  getKind()
  setProductCode()
  getProductCode()
  setSupportsReporting()
  getSupportsReporting()

Google_Service_AdExchangeSeller_AdClients:: (8 methods):
  setEtag()
  getEtag()
  setItems()
  getItems()
  setKind()
  getKind()
  setNextPageToken()
  getNextPageToken()

Google_Service_AdExchangeSeller_Alert:: (10 methods):
  setId()
  getId()
  setKind()
  getKind()
  setMessage()
  getMessage()
  setSeverity()
  getSeverity()
  setType()
  getType()

Google_Service_AdExchangeSeller_Alerts:: (4 methods):
  setItems()
  getItems()
  setKind()
  getKind()

Google_Service_AdExchangeSeller_CustomChannel:: (10 methods):
  setCode()
  getCode()
  setId()
  getId()
  setKind()
  getKind()
  setName()
  getName()
  setTargetingInfo()
  getTargetingInfo()

Google_Service_AdExchangeSeller_CustomChannelTargetingInfo:: (8 methods):
  setAdsAppearOn()
  getAdsAppearOn()
  setDescription()
  getDescription()
  setLocation()
  getLocation()
  setSiteLanguage()
  getSiteLanguage()

Google_Service_AdExchangeSeller_CustomChannels:: (8 methods):
  setEtag()
  getEtag()
  setItems()
  getItems()
  setKind()
  getKind()
  setNextPageToken()
  getNextPageToken()

Google_Service_AdExchangeSeller_Metadata:: (4 methods):
  setItems()
  getItems()
  setKind()
  getKind()

Google_Service_AdExchangeSeller_PreferredDeal:: (16 methods):
  setAdvertiserName()
  getAdvertiserName()
  setBuyerNetworkName()
  getBuyerNetworkName()
  setCurrencyCode()
  getCurrencyCode()
  setEndTime()
  getEndTime()
  setFixedCpm()
  getFixedCpm()
  setId()
  getId()
  setKind()
  getKind()
  setStartTime()
  getStartTime()

Google_Service_AdExchangeSeller_PreferredDeals:: (4 methods):
  setItems()
  getItems()
  setKind()
  getKind()

Google_Service_AdExchangeSeller_Report:: (14 methods):
  setAverages()
  getAverages()
  setHeaders()
  getHeaders()
  setKind()
  getKind()
  setRows()
  getRows()
  setTotalMatchedRows()
  getTotalMatchedRows()
  setTotals()
  getTotals()
  setWarnings()
  getWarnings()

Google_Service_AdExchangeSeller_ReportHeaders:: (6 methods):
  setCurrency()
  getCurrency()
  setName()
  getName()
  setType()
  getType()

Google_Service_AdExchangeSeller_ReportingMetadataEntry:: (14 methods):
  setCompatibleDimensions()
  getCompatibleDimensions()
  setCompatibleMetrics()
  getCompatibleMetrics()
  setId()
  getId()
  setKind()
  getKind()
  setRequiredDimensions()
  getRequiredDimensions()
  setRequiredMetrics()
  getRequiredMetrics()
  setSupportedProducts()
  getSupportedProducts()

Google_Service_AdExchangeSeller_SavedReport:: (6 methods):
  setId()
  getId()
  setKind()
  getKind()
  setName()
  getName()

Google_Service_AdExchangeSeller_SavedReports:: (8 methods):
  setEtag()
  getEtag()
  setItems()
  getItems()
  setKind()
  getKind()
  setNextPageToken()
  getNextPageToken()

Google_Service_AdExchangeSeller_UrlChannel:: (6 methods):
  setId()
  getId()
  setKind()
  getKind()
  setUrlPattern()
  getUrlPattern()

Google_Service_AdExchangeSeller_UrlChannels:: (8 methods):
  setEtag()
  getEtag()
  setItems()
  getItems()
  setKind()
  getKind()
  setNextPageToken()
  getNextPageToken()


Class: Google_Service_AdExchangeSeller  - X-Ref

Service definition for AdExchangeSeller (v2.0).

<p>
Gives Ad Exchange seller users access to their inventory and the ability to
generate reports</p>

<p>
For more information about this service, see the API
<a href="https://developers.google.com/ad-exchange/seller-rest/" target="_blank">Documentation</a>
</p>

__construct(Google_Client $client)   X-Ref
Constructs the internal representation of the AdExchangeSeller service.

param: Google_Client $client

Class: Google_Service_AdExchangeSeller_Accounts_Resource  - X-Ref

The "accounts" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$accounts = $adexchangesellerService->accounts;
</code>

get($accountId, $optParams = array()   X-Ref
Get information about the selected Ad Exchange account. (accounts.get)

param: string $accountId Account to get information about. Tip: 'myaccount'
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_Account

listAccounts($optParams = array()   X-Ref
List all accounts available to this Ad Exchange account.
(accounts.listAccounts)

param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_Accounts

Class: Google_Service_AdExchangeSeller_AccountsAdclients_Resource  - X-Ref

The "adclients" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$adclients = $adexchangesellerService->adclients;
</code>

listAccountsAdclients($accountId, $optParams = array()   X-Ref
List all ad clients in this Ad Exchange account.
(adclients.listAccountsAdclients)

param: string $accountId Account to which the ad client belongs.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_AdClients

Class: Google_Service_AdExchangeSeller_AccountsAlerts_Resource  - X-Ref

The "alerts" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$alerts = $adexchangesellerService->alerts;
</code>

listAccountsAlerts($accountId, $optParams = array()   X-Ref
List the alerts for this Ad Exchange account. (alerts.listAccountsAlerts)

param: string $accountId Account owning the alerts.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_Alerts

Class: Google_Service_AdExchangeSeller_AccountsCustomchannels_Resource  - X-Ref

The "customchannels" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$customchannels = $adexchangesellerService->customchannels;
</code>

get($accountId, $adClientId, $customChannelId, $optParams = array()   X-Ref
Get the specified custom channel from the specified ad client.
(customchannels.get)

param: string $accountId Account to which the ad client belongs.
param: string $adClientId Ad client which contains the custom channel.
param: string $customChannelId Custom channel to retrieve.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_CustomChannel

listAccountsCustomchannels($accountId, $adClientId, $optParams = array()   X-Ref
List all custom channels in the specified ad client for this Ad Exchange
account. (customchannels.listAccountsCustomchannels)

param: string $accountId Account to which the ad client belongs.
param: string $adClientId Ad client for which to list custom channels.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_CustomChannels

Class: Google_Service_AdExchangeSeller_AccountsMetadata_Resource  - X-Ref

The "metadata" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$metadata = $adexchangesellerService->metadata;
</code>

Class: Google_Service_AdExchangeSeller_AccountsMetadataDimensions_Resource  - X-Ref

The "dimensions" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$dimensions = $adexchangesellerService->dimensions;
</code>

listAccountsMetadataDimensions($accountId, $optParams = array()   X-Ref
List the metadata for the dimensions available to this AdExchange account.
(dimensions.listAccountsMetadataDimensions)

param: string $accountId Account with visibility to the dimensions.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_Metadata

Class: Google_Service_AdExchangeSeller_AccountsMetadataMetrics_Resource  - X-Ref

The "metrics" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$metrics = $adexchangesellerService->metrics;
</code>

listAccountsMetadataMetrics($accountId, $optParams = array()   X-Ref
List the metadata for the metrics available to this AdExchange account.
(metrics.listAccountsMetadataMetrics)

param: string $accountId Account with visibility to the metrics.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_Metadata

Class: Google_Service_AdExchangeSeller_AccountsPreferreddeals_Resource  - X-Ref

The "preferreddeals" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$preferreddeals = $adexchangesellerService->preferreddeals;
</code>

get($accountId, $dealId, $optParams = array()   X-Ref
Get information about the selected Ad Exchange Preferred Deal.
(preferreddeals.get)

param: string $accountId Account owning the deal.
param: string $dealId Preferred deal to get information about.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_PreferredDeal

listAccountsPreferreddeals($accountId, $optParams = array()   X-Ref
List the preferred deals for this Ad Exchange account.
(preferreddeals.listAccountsPreferreddeals)

param: string $accountId Account owning the deals.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_PreferredDeals

Class: Google_Service_AdExchangeSeller_AccountsReports_Resource  - X-Ref

The "reports" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$reports = $adexchangesellerService->reports;
</code>

generate($accountId, $startDate, $endDate, $optParams = array()   X-Ref
Generate an Ad Exchange report based on the report request sent in the query
parameters. Returns the result as JSON; to retrieve output in CSV format
specify "alt=csv" as a query parameter. (reports.generate)

param: string $accountId Account which owns the generated report.
param: string $startDate Start of the date range to report on in "YYYY-MM-DD"
param: string $endDate End of the date range to report on in "YYYY-MM-DD"
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_Report

Class: Google_Service_AdExchangeSeller_AccountsReportsSaved_Resource  - X-Ref

The "saved" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$saved = $adexchangesellerService->saved;
</code>

generate($accountId, $savedReportId, $optParams = array()   X-Ref
Generate an Ad Exchange report based on the saved report ID sent in the query
parameters. (saved.generate)

param: string $accountId Account owning the saved report.
param: string $savedReportId The saved report to retrieve.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_Report

listAccountsReportsSaved($accountId, $optParams = array()   X-Ref
List all saved reports in this Ad Exchange account.
(saved.listAccountsReportsSaved)

param: string $accountId Account owning the saved reports.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_SavedReports

Class: Google_Service_AdExchangeSeller_AccountsUrlchannels_Resource  - X-Ref

The "urlchannels" collection of methods.
Typical usage is:
<code>
$adexchangesellerService = new Google_Service_AdExchangeSeller(...);
$urlchannels = $adexchangesellerService->urlchannels;
</code>

listAccountsUrlchannels($accountId, $adClientId, $optParams = array()   X-Ref
List all URL channels in the specified ad client for this Ad Exchange
account. (urlchannels.listAccountsUrlchannels)

param: string $accountId Account to which the ad client belongs.
param: string $adClientId Ad client for which to list URL channels.
param: array $optParams Optional parameters.
return: Google_Service_AdExchangeSeller_UrlChannels

Class: Google_Service_AdExchangeSeller_Account  - X-Ref

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setName($name)   X-Ref
No description

getName()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_Accounts  - X-Ref

setEtag($etag)   X-Ref
No description

getEtag()   X-Ref
No description

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setNextPageToken($nextPageToken)   X-Ref
No description

getNextPageToken()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_AdClient  - X-Ref

setArcOptIn($arcOptIn)   X-Ref
No description

getArcOptIn()   X-Ref
No description

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setProductCode($productCode)   X-Ref
No description

getProductCode()   X-Ref
No description

setSupportsReporting($supportsReporting)   X-Ref
No description

getSupportsReporting()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_AdClients  - X-Ref

setEtag($etag)   X-Ref
No description

getEtag()   X-Ref
No description

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setNextPageToken($nextPageToken)   X-Ref
No description

getNextPageToken()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_Alert  - X-Ref

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setMessage($message)   X-Ref
No description

getMessage()   X-Ref
No description

setSeverity($severity)   X-Ref
No description

getSeverity()   X-Ref
No description

setType($type)   X-Ref
No description

getType()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_Alerts  - X-Ref

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_CustomChannel  - X-Ref

setCode($code)   X-Ref
No description

getCode()   X-Ref
No description

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setName($name)   X-Ref
No description

getName()   X-Ref
No description

setTargetingInfo(Google_Service_AdExchangeSeller_CustomChannelTargetingInfo $targetingInfo)   X-Ref
No description

getTargetingInfo()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_CustomChannelTargetingInfo  - X-Ref

setAdsAppearOn($adsAppearOn)   X-Ref
No description

getAdsAppearOn()   X-Ref
No description

setDescription($description)   X-Ref
No description

getDescription()   X-Ref
No description

setLocation($location)   X-Ref
No description

getLocation()   X-Ref
No description

setSiteLanguage($siteLanguage)   X-Ref
No description

getSiteLanguage()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_CustomChannels  - X-Ref

setEtag($etag)   X-Ref
No description

getEtag()   X-Ref
No description

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setNextPageToken($nextPageToken)   X-Ref
No description

getNextPageToken()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_Metadata  - X-Ref

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_PreferredDeal  - X-Ref

setAdvertiserName($advertiserName)   X-Ref
No description

getAdvertiserName()   X-Ref
No description

setBuyerNetworkName($buyerNetworkName)   X-Ref
No description

getBuyerNetworkName()   X-Ref
No description

setCurrencyCode($currencyCode)   X-Ref
No description

getCurrencyCode()   X-Ref
No description

setEndTime($endTime)   X-Ref
No description

getEndTime()   X-Ref
No description

setFixedCpm($fixedCpm)   X-Ref
No description

getFixedCpm()   X-Ref
No description

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setStartTime($startTime)   X-Ref
No description

getStartTime()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_PreferredDeals  - X-Ref

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_Report  - X-Ref

setAverages($averages)   X-Ref
No description

getAverages()   X-Ref
No description

setHeaders($headers)   X-Ref
No description

getHeaders()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setRows($rows)   X-Ref
No description

getRows()   X-Ref
No description

setTotalMatchedRows($totalMatchedRows)   X-Ref
No description

getTotalMatchedRows()   X-Ref
No description

setTotals($totals)   X-Ref
No description

getTotals()   X-Ref
No description

setWarnings($warnings)   X-Ref
No description

getWarnings()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_ReportHeaders  - X-Ref

setCurrency($currency)   X-Ref
No description

getCurrency()   X-Ref
No description

setName($name)   X-Ref
No description

getName()   X-Ref
No description

setType($type)   X-Ref
No description

getType()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_ReportingMetadataEntry  - X-Ref

setCompatibleDimensions($compatibleDimensions)   X-Ref
No description

getCompatibleDimensions()   X-Ref
No description

setCompatibleMetrics($compatibleMetrics)   X-Ref
No description

getCompatibleMetrics()   X-Ref
No description

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setRequiredDimensions($requiredDimensions)   X-Ref
No description

getRequiredDimensions()   X-Ref
No description

setRequiredMetrics($requiredMetrics)   X-Ref
No description

getRequiredMetrics()   X-Ref
No description

setSupportedProducts($supportedProducts)   X-Ref
No description

getSupportedProducts()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_SavedReport  - X-Ref

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setName($name)   X-Ref
No description

getName()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_SavedReports  - X-Ref

setEtag($etag)   X-Ref
No description

getEtag()   X-Ref
No description

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setNextPageToken($nextPageToken)   X-Ref
No description

getNextPageToken()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_UrlChannel  - X-Ref

setId($id)   X-Ref
No description

getId()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setUrlPattern($urlPattern)   X-Ref
No description

getUrlPattern()   X-Ref
No description

Class: Google_Service_AdExchangeSeller_UrlChannels  - X-Ref

setEtag($etag)   X-Ref
No description

getEtag()   X-Ref
No description

setItems($items)   X-Ref
No description

getItems()   X-Ref
No description

setKind($kind)   X-Ref
No description

getKind()   X-Ref
No description

setNextPageToken($nextPageToken)   X-Ref
No description

getNextPageToken()   X-Ref
No description