google_api_ad_sense v0.5.0 API Reference
Modules
API calls for all endpoints tagged Accounts
.
API calls for all endpoints tagged Adclients
.
API calls for all endpoints tagged Adunits
.
API calls for all endpoints tagged Alerts
.
API calls for all endpoints tagged Customchannels
.
API calls for all endpoints tagged Metadata
.
API calls for all endpoints tagged Payments
.
API calls for all endpoints tagged Reports
.
API calls for all endpoints tagged Savedadstyles
.
API calls for all endpoints tagged Urlchannels
.
Handle Tesla connections for GoogleApi.AdSense.V14.
Attributes
creation_time
(type:String.t
, default:nil
) -id
(type:String.t
, default:nil
) - Unique identifier of this account.kind
(type:String.t
, default:adsense#account
) - Kind of resource this is, in this case adsense#account.name
(type:String.t
, default:nil
) - Name of this account.premium
(type:boolean()
, default:nil
) - Whether this account is premium.subAccounts
(type:list(GoogleApi.AdSense.V14.Model.Account.t)
, default:nil
) - Sub accounts of the this account.timezone
(type:String.t
, default:nil
) - AdSense timezone of this account.
Attributes
etag
(type:String.t
, default:nil
) - ETag of this response for caching purposes.items
(type:list(GoogleApi.AdSense.V14.Model.Account.t)
, default:nil
) - The accounts returned in this list response.kind
(type:String.t
, default:adsense#accounts
) - Kind of list this is, in this case adsense#accounts.nextPageToken
(type:String.t
, default:nil
) - Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this.
Attributes
arcOptIn
(type:boolean()
, default:nil
) - Whether this ad client is opted in to ARC.id
(type:String.t
, default:nil
) - Unique identifier of this ad client.kind
(type:String.t
, default:adsense#adClient
) - Kind of resource this is, in this case adsense#adClient.productCode
(type:String.t
, default:nil
) - This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.supportsReporting
(type:boolean()
, default:nil
) - Whether this ad client supports being reported on.
Attributes
etag
(type:String.t
, default:nil
) - ETag of this response for caching purposes.items
(type:list(GoogleApi.AdSense.V14.Model.AdClient.t)
, default:nil
) - The ad clients returned in this list response.kind
(type:String.t
, default:adsense#adClients
) - Kind of list this is, in this case adsense#adClients.nextPageToken
(type:String.t
, default:nil
) - Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
Attributes
adCode
(type:String.t
, default:nil
) - The Auto ad code snippet. The ad code snippet.ampBody
(type:String.t
, default:nil
) - The AMP Auto ad code snippet that goes in the body of an AMP page.ampHead
(type:String.t
, default:nil
) - The AMP Auto ad code snippet that goes in the head of an AMP page.kind
(type:String.t
, default:adsense#adCode
) - Kind this is, in this case adsense#adCode.
Attributes
colors
(type:GoogleApi.AdSense.V14.Model.AdStyleColors.t
, default:nil
) - The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.corners
(type:String.t
, default:nil
) - The style of the corners in the ad (deprecated: never populated, ignored).font
(type:GoogleApi.AdSense.V14.Model.AdStyleFont.t
, default:nil
) - The font which is included in the style.kind
(type:String.t
, default:adsense#adStyle
) - Kind this is, in this case adsense#adStyle.
The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
The font which is included in the style.
Attributes
code
(type:String.t
, default:nil
) - Identity code of this ad unit, not necessarily unique across ad clients.contentAdsSettings
(type:GoogleApi.AdSense.V14.Model.AdUnitContentAdsSettings.t
, default:nil
) - Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).customStyle
(type:GoogleApi.AdSense.V14.Model.AdStyle.t
, default:nil
) - Custom style information specific to this ad unit.feedAdsSettings
(type:GoogleApi.AdSense.V14.Model.AdUnitFeedAdsSettings.t
, default:nil
) - Settings specific to feed ads (AFF) - deprecated.id
(type:String.t
, default:nil
) - Unique identifier of this ad unit. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.kind
(type:String.t
, default:adsense#adUnit
) - Kind of resource this is, in this case adsense#adUnit.mobileContentAdsSettings
(type:GoogleApi.AdSense.V14.Model.AdUnitMobileContentAdsSettings.t
, default:nil
) - Settings specific to WAP mobile content ads (AFMC) - deprecated.name
(type:String.t
, default:nil
) - Name of this ad unit.savedStyleId
(type:String.t
, default:nil
) - ID of the saved ad style which holds this ad unit's style information.status
(type:String.t
, default:nil
) - Status of this ad unit. Possible values are: NEW: Indicates that the ad unit was created within the last seven days and does not yet have any activity associated with it.
Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
The backup option to be used in instances where no ad is available.
Settings specific to feed ads (AFF) - deprecated.
Settings specific to WAP mobile content ads (AFMC) - deprecated.
Attributes
etag
(type:String.t
, default:nil
) - ETag of this response for caching purposes.items
(type:list(GoogleApi.AdSense.V14.Model.AdUnit.t)
, default:nil
) - The ad units returned in this list response.kind
(type:String.t
, default:adsense#adUnits
) - Kind of list this is, in this case adsense#adUnits.nextPageToken
(type:String.t
, default:nil
) - Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
Attributes
averages
(type:list(String.t)
, default:nil
) - The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.endDate
(type:String.t
, default:nil
) - The requested end date in yyyy-mm-dd format.headers
(type:list(GoogleApi.AdSense.V14.Model.AdsenseReportsGenerateResponseHeaders.t)
, default:nil
) - The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request.kind
(type:String.t
, default:adsense#report
) - Kind this is, in this case adsense#report.rows
(type:list(list(String.t))
, default:nil
) - The output rows of the report. Each row is a list of cells; one for each dimension in the request, followed by one for each metric in the request. The dimension cells contain strings, and the metric cells contain numbers.startDate
(type:String.t
, default:nil
) - The requested start date in yyyy-mm-dd format.totalMatchedRows
(type:String.t
, default:nil
) - The total number of rows matched by the report request. Fewer rows may be returned in the response due to being limited by the row count requested or the report row limit.totals
(type:list(String.t)
, default:nil
) - The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.warnings
(type:list(String.t)
, default:nil
) - Any warnings associated with generation of the report.
Attributes
currency
(type:String.t
, default:nil
) - The currency of this column. Only present if the header type is METRIC_CURRENCY.name
(type:String.t
, default:nil
) - The name of the header.type
(type:String.t
, default:nil
) - The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY.
Attributes
id
(type:String.t
, default:nil
) - Unique identifier of this alert. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.isDismissible
(type:boolean()
, default:nil
) - Whether this alert can be dismissed.kind
(type:String.t
, default:adsense#alert
) - Kind of resource this is, in this case adsense#alert.message
(type:String.t
, default:nil
) - The localized alert message.severity
(type:String.t
, default:nil
) - Severity of this alert. Possible values: INFO, WARNING, SEVERE.type
(type:String.t
, default:nil
) - Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD.
Attributes
code
(type:String.t
, default:nil
) - Code of this custom channel, not necessarily unique across ad clients.id
(type:String.t
, default:nil
) - Unique identifier of this custom channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.kind
(type:String.t
, default:adsense#customChannel
) - Kind of resource this is, in this case adsense#customChannel.name
(type:String.t
, default:nil
) - Name of this custom channel.targetingInfo
(type:GoogleApi.AdSense.V14.Model.CustomChannelTargetingInfo.t
, default:nil
) - The targeting information of this custom channel, if activated.
The targeting information of this custom channel, if activated.
Attributes
etag
(type:String.t
, default:nil
) - ETag of this response for caching purposes.items
(type:list(GoogleApi.AdSense.V14.Model.CustomChannel.t)
, default:nil
) - The custom channels returned in this list response.kind
(type:String.t
, default:adsense#customChannels
) - Kind of list this is, in this case adsense#customChannels.nextPageToken
(type:String.t
, default:nil
) - Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
Attributes
id
(type:String.t
, default:nil
) - Unique identifier of this Payment.kind
(type:String.t
, default:adsense#payment
) - Kind of resource this is, in this case adsense#payment.paymentAmount
(type:String.t
, default:nil
) - The amount to be paid.paymentAmountCurrencyCode
(type:String.t
, default:nil
) - The currency code for the amount to be paid.paymentDate
(type:String.t
, default:nil
) - The date this payment was/will be credited to the user, or none if the payment threshold has not been met.
Attributes
items
(type:list(GoogleApi.AdSense.V14.Model.Payment.t)
, default:nil
) - The list of Payments for the account. One or both of a) the account's most recent payment; and b) the account's upcoming payment.kind
(type:String.t
, default:adsense#payments
) - Kind of list this is, in this case adsense#payments.
Attributes
compatibleDimensions
(type:list(String.t)
, default:nil
) - For metrics this is a list of dimension IDs which the metric is compatible with, for dimensions it is a list of compatibility groups the dimension belongs to.compatibleMetrics
(type:list(String.t)
, default:nil
) - The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with.id
(type:String.t
, default:nil
) - Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric.kind
(type:String.t
, default:adsense#reportingMetadataEntry
) - Kind of resource this is, in this case adsense#reportingMetadataEntry.requiredDimensions
(type:list(String.t)
, default:nil
) - The names of the dimensions which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.requiredMetrics
(type:list(String.t)
, default:nil
) - The names of the metrics which the dimension or metric this reporting metadata entry describes requires to also be present in order for the report to be valid. Omitting these will not cause an error or warning, but may result in data which cannot be correctly interpreted.supportedProducts
(type:list(String.t)
, default:nil
) - The codes of the projects supported by the dimension or metric this reporting metadata entry describes.
Attributes
adStyle
(type:GoogleApi.AdSense.V14.Model.AdStyle.t
, default:nil
) - The AdStyle itself.id
(type:String.t
, default:nil
) - Unique identifier of this saved ad style. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.kind
(type:String.t
, default:adsense#savedAdStyle
) - Kind of resource this is, in this case adsense#savedAdStyle.name
(type:String.t
, default:nil
) - The user selected name of this SavedAdStyle.
Attributes
etag
(type:String.t
, default:nil
) - ETag of this response for caching purposes.items
(type:list(GoogleApi.AdSense.V14.Model.SavedAdStyle.t)
, default:nil
) - The saved ad styles returned in this list response.kind
(type:String.t
, default:adsense#savedAdStyles
) - Kind of list this is, in this case adsense#savedAdStyles.nextPageToken
(type:String.t
, default:nil
) - Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
Attributes
etag
(type:String.t
, default:nil
) - ETag of this response for caching purposes.items
(type:list(GoogleApi.AdSense.V14.Model.SavedReport.t)
, default:nil
) - The saved reports returned in this list response.kind
(type:String.t
, default:adsense#savedReports
) - Kind of list this is, in this case adsense#savedReports.nextPageToken
(type:String.t
, default:nil
) - Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this.
Attributes
id
(type:String.t
, default:nil
) - Unique identifier of this URL channel. This should be considered an opaque identifier; it is not safe to rely on it being in any particular format.kind
(type:String.t
, default:adsense#urlChannel
) - Kind of resource this is, in this case adsense#urlChannel.urlPattern
(type:String.t
, default:nil
) - URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
Attributes
etag
(type:String.t
, default:nil
) - ETag of this response for caching purposes.items
(type:list(GoogleApi.AdSense.V14.Model.UrlChannel.t)
, default:nil
) - The URL channels returned in this list response.kind
(type:String.t
, default:adsense#urlChannels
) - Kind of list this is, in this case adsense#urlChannels.nextPageToken
(type:String.t
, default:nil
) - Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.