google_api_ad_sense v0.2.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.

Helper functions for deserializing responses into models.

Attributes

  • creation_time (String.t): Defaults to: null.
  • id (String.t): Unique identifier of this account. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#account. Defaults to: null.
  • name (String.t): Name of this account. Defaults to: null.
  • premium (boolean()): Whether this account is premium. Defaults to: null.
  • subAccounts ([Account]): Sub accounts of the this account. Defaults to: null.
  • timezone (String.t): AdSense timezone of this account. Defaults to: null.

Attributes

  • etag (String.t): ETag of this response for caching purposes. Defaults to: null.
  • items ([Account]): The accounts returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#accounts. Defaults to: null.
  • nextPageToken (String.t): Continuation token used to page through accounts. To retrieve the next page of results, set the next request's "pageToken" value to this. Defaults to: null.

Attributes

  • arcOptIn (boolean()): Whether this ad client is opted in to ARC. Defaults to: null.
  • id (String.t): Unique identifier of this ad client. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#adClient. Defaults to: null.
  • productCode (String.t): This ad client's product code, which corresponds to the PRODUCT_CODE report dimension. Defaults to: null.
  • supportsReporting (boolean()): Whether this ad client supports being reported on. Defaults to: null.

Attributes

  • etag (String.t): ETag of this response for caching purposes. Defaults to: null.
  • items ([AdClient]): The ad clients returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#adClients. Defaults to: null.
  • nextPageToken (String.t): Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this. Defaults to: null.

Attributes

  • adCode (String.t): The Auto ad code snippet. The ad code snippet. Defaults to: null.
  • ampBody (String.t): The AMP Auto ad code snippet that goes in the body of an AMP page. Defaults to: null.
  • ampHead (String.t): The AMP Auto ad code snippet that goes in the head of an AMP page. Defaults to: null.
  • kind (String.t): Kind this is, in this case adsense#adCode. Defaults to: null.

Attributes

  • colors (AdStyleColors): Defaults to: null.
  • corners (String.t): The style of the corners in the ad (deprecated: never populated, ignored). Defaults to: null.
  • font (AdStyleFont): Defaults to: null.
  • kind (String.t): Kind this is, in this case adsense#adStyle. Defaults to: null.

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 (String.t): Identity code of this ad unit, not necessarily unique across ad clients. Defaults to: null.
  • contentAdsSettings (AdUnitContentAdsSettings): Defaults to: null.
  • customStyle (AdStyle): Custom style information specific to this ad unit. Defaults to: null.
  • feedAdsSettings (AdUnitFeedAdsSettings): Defaults to: null.
  • id (String.t): 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. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#adUnit. Defaults to: null.
  • mobileContentAdsSettings (AdUnitMobileContentAdsSettings): Defaults to: null.
  • name (String.t): Name of this ad unit. Defaults to: null.
  • savedStyleId (String.t): ID of the saved ad style which holds this ad unit's style information. Defaults to: null.
  • status (String.t): 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. ACTIVE: Indicates that there has been activity on this ad unit in the last seven days. INACTIVE: Indicates that there has been no activity on this ad unit in the last seven days. Defaults to: null.

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 (String.t): ETag of this response for caching purposes. Defaults to: null.
  • items ([AdUnit]): The ad units returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#adUnits. Defaults to: null.
  • nextPageToken (String.t): Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. Defaults to: null.

Attributes

  • averages ([String.t]): The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. Defaults to: null.
  • endDate (String.t): The requested end date in yyyy-mm-dd format. Defaults to: null.
  • headers ([AdsenseReportsGenerateResponseHeaders]): 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. Defaults to: null.
  • kind (String.t): Kind this is, in this case adsense#report. Defaults to: null.
  • rows ([[String.t]]): 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. Defaults to: null.
  • startDate (String.t): The requested start date in yyyy-mm-dd format. Defaults to: null.
  • totalMatchedRows (String.t): 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. Defaults to: null.
  • totals ([String.t]): The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty. Defaults to: null.
  • warnings ([String.t]): Any warnings associated with generation of the report. Defaults to: null.

Attributes

  • currency (String.t): The currency of this column. Only present if the header type is METRIC_CURRENCY. Defaults to: null.
  • name (String.t): The name of the header. Defaults to: null.
  • type (String.t): The type of the header; one of DIMENSION, METRIC_TALLY, METRIC_RATIO, or METRIC_CURRENCY. Defaults to: null.

Attributes

  • id (String.t): 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. Defaults to: null.
  • isDismissible (boolean()): Whether this alert can be dismissed. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#alert. Defaults to: null.
  • message (String.t): The localized alert message. Defaults to: null.
  • severity (String.t): Severity of this alert. Possible values: INFO, WARNING, SEVERE. Defaults to: null.
  • type (String.t): Type of this alert. Possible values: SELF_HOLD, MIGRATED_TO_BILLING3, ADDRESS_PIN_VERIFICATION, PHONE_PIN_VERIFICATION, CORPORATE_ENTITY, GRAYLISTED_PUBLISHER, API_HOLD. Defaults to: null.

Attributes

  • items ([Alert]): The alerts returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#alerts. Defaults to: null.

Attributes

  • code (String.t): Code of this custom channel, not necessarily unique across ad clients. Defaults to: null.
  • id (String.t): 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. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#customChannel. Defaults to: null.
  • name (String.t): Name of this custom channel. Defaults to: null.
  • targetingInfo (CustomChannelTargetingInfo): Defaults to: null.

The targeting information of this custom channel, if activated.

Attributes

  • etag (String.t): ETag of this response for caching purposes. Defaults to: null.
  • items ([CustomChannel]): The custom channels returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#customChannels. Defaults to: null.
  • nextPageToken (String.t): Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this. Defaults to: null.

Attributes

  • items ([ReportingMetadataEntry]): Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#metadata. Defaults to: null.

Attributes

  • id (String.t): Unique identifier of this Payment. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#payment. Defaults to: null.
  • paymentAmount (String.t): The amount to be paid. Defaults to: null.
  • paymentAmountCurrencyCode (String.t): The currency code for the amount to be paid. Defaults to: null.
  • paymentDate (String.t): The date this payment was/will be credited to the user, or none if the payment threshold has not been met. Defaults to: null.

Attributes

  • items ([Payment]): 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. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#payments. Defaults to: null.

Attributes

  • compatibleDimensions ([String.t]): 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. Defaults to: null.
  • compatibleMetrics ([String.t]): The names of the metrics the dimension or metric this reporting metadata entry describes is compatible with. Defaults to: null.
  • id (String.t): Unique identifier of this reporting metadata entry, corresponding to the name of the appropriate dimension or metric. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#reportingMetadataEntry. Defaults to: null.
  • requiredDimensions ([String.t]): 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. Defaults to: null.
  • requiredMetrics ([String.t]): 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. Defaults to: null.
  • supportedProducts ([String.t]): The codes of the projects supported by the dimension or metric this reporting metadata entry describes. Defaults to: null.

Attributes

  • adStyle (AdStyle): The AdStyle itself. Defaults to: null.
  • id (String.t): 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. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#savedAdStyle. Defaults to: null.
  • name (String.t): The user selected name of this SavedAdStyle. Defaults to: null.

Attributes

  • etag (String.t): ETag of this response for caching purposes. Defaults to: null.
  • items ([SavedAdStyle]): The saved ad styles returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#savedAdStyles. Defaults to: null.
  • nextPageToken (String.t): Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this. Defaults to: null.

Attributes

  • id (String.t): Unique identifier of this saved report. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#savedReport. Defaults to: null.
  • name (String.t): This saved report's name. Defaults to: null.

Attributes

  • etag (String.t): ETag of this response for caching purposes. Defaults to: null.
  • items ([SavedReport]): The saved reports returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#savedReports. Defaults to: null.
  • nextPageToken (String.t): Continuation token used to page through saved reports. To retrieve the next page of results, set the next request's "pageToken" value to this. Defaults to: null.

Attributes

  • id (String.t): 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. Defaults to: null.
  • kind (String.t): Kind of resource this is, in this case adsense#urlChannel. Defaults to: null.
  • urlPattern (String.t): URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home Defaults to: null.

Attributes

  • etag (String.t): ETag of this response for caching purposes. Defaults to: null.
  • items ([UrlChannel]): The URL channels returned in this list response. Defaults to: null.
  • kind (String.t): Kind of list this is, in this case adsense#urlChannels. Defaults to: null.
  • nextPageToken (String.t): Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this. Defaults to: null.

Helper functions for building Tesla requests.