Use wide AdSense Host API integration

With Ants & Apps platform you can connect AdSense Host API with more than 30 available apps, 600+ functional formulas to boost your productivity

Reference

  • accounts.adclients

    • Get information about one of the ad clients in the specified publisher's AdSense account

      This action get information about one of the ad clients in the specified publisher's AdSense account.

      GETAdsensehostAccountsAdclientsGet

      Request parameters

      • accountId*string

        Account which contains the ad client.

      • adClientId*string

        Ad client to get.

    • List all hosted ad clients in the specified hosted account

      This action list all hosted ad clients in the specified hosted account.

      GETAdsensehostAccountsAdclientsList

      Request parameters

      • accountId*string

        Account for which to list ad clients.

      • maxResultsinteger

        The maximum number of ad clients to include in the response, used for paging.

      • pageTokenstring

        A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

  • accounts.adunits

    • Get the specified host ad unit in this AdSense account

      This action get the specified host ad unit in this AdSense account.

      GETAdsensehostAccountsAdunitsGet

      Request parameters

      • accountId*string

        Account which contains the ad unit.

      • adClientId*string

        Ad client for which to get ad unit.

      • adUnitId*string

        Ad unit to get.

    • Get ad code for the specified ad unit, attaching the specified host custom channels

      This action get ad code for the specified ad unit, attaching the specified host custom channels.

      GETAdsensehostAccountsAdunitsGetAdCode

      Request parameters

      • accountId*string

        Account which contains the ad client.

      • adClientId*string

        Ad client with contains the ad unit.

      • adUnitId*string

        Ad unit to get the code for.

      • hostCustomChannelIdstring

        Host custom channel to attach to the ad code.

    • List all ad units in the specified publisher's AdSense account

      This action list all ad units in the specified publisher's AdSense account.

      GETAdsensehostAccountsAdunitsList

      Request parameters

      • accountId*string

        Account which contains the ad client.

      • adClientId*string

        Ad client for which to list ad units.

      • includeInactiveboolean

        Whether to include inactive ad units. Default: true.

      • maxResultsinteger

        The maximum number of ad units to include in the response, used for paging.

      • pageTokenstring

        A continuation token, used to page through ad units. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

    • Insert the supplied ad unit into the specified publisher AdSense account

      This action insert the supplied ad unit into the specified publisher AdSense account.

      POSTAdsensehostAccountsAdunitsInsert

      Request parameters

      • accountId*string

        Account which will contain the ad unit.

      • adClientId*string

        Ad client into which to insert the ad unit.

      Request body

      • codestring

        Identity code of this ad unit, not necessarily unique across ad clients.

      • contentAdsSettingsobject

        Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).

      • customStyleobject

        Custom style information specific to this ad unit.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsensehost#adUnit.

      • mobileContentAdsSettingsobject

        Settings specific to WAP mobile content ads (AFMC - deprecated).

      • namestring

        Name of this ad unit.

      • statusstring

        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.

      • codestring

        Identity code of this ad unit, not necessarily unique across ad clients.

      • contentAdsSettingsobject

        Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).

      • customStyleobject

        Custom style information specific to this ad unit.

      • feedAdsSettingsobject

        Settings specific to feed ads (AFF) - deprecated.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsense#adUnit.

      • mobileContentAdsSettingsobject

        Settings specific to WAP mobile content ads (AFMC) - deprecated.

      • namestring

        Name of this ad unit.

      • savedStyleIdstring

        ID of the saved ad style which holds this ad unit's style information.

      • statusstring

        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.

    • Update the supplied ad unit in the specified publisher AdSense account

      This action update the supplied ad unit in the specified publisher AdSense account.

      PUTAdsensehostAccountsAdunitsUpdate

      Request parameters

      • accountId*string

        Account which contains the ad client.

      • adClientId*string

        Ad client which contains the ad unit.

      Request body

      • codestring

        Identity code of this ad unit, not necessarily unique across ad clients.

      • contentAdsSettingsobject

        Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).

      • customStyleobject

        Custom style information specific to this ad unit.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsensehost#adUnit.

      • mobileContentAdsSettingsobject

        Settings specific to WAP mobile content ads (AFMC - deprecated).

      • namestring

        Name of this ad unit.

      • statusstring

        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.

      • codestring

        Identity code of this ad unit, not necessarily unique across ad clients.

      • contentAdsSettingsobject

        Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).

      • customStyleobject

        Custom style information specific to this ad unit.

      • feedAdsSettingsobject

        Settings specific to feed ads (AFF) - deprecated.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsense#adUnit.

      • mobileContentAdsSettingsobject

        Settings specific to WAP mobile content ads (AFMC) - deprecated.

      • namestring

        Name of this ad unit.

      • savedStyleIdstring

        ID of the saved ad style which holds this ad unit's style information.

      • statusstring

        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.

    • Update the supplied ad unit in the specified publisher AdSense account

      This action update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.

      PATCHAdsensehostAccountsAdunitsPatch

      Request parameters

      • accountId*string

        Account which contains the ad client.

      • adClientId*string

        Ad client which contains the ad unit.

      • adUnitId*string

        Ad unit to get.

      Request body

      • codestring

        Identity code of this ad unit, not necessarily unique across ad clients.

      • contentAdsSettingsobject

        Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).

      • customStyleobject

        Custom style information specific to this ad unit.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsensehost#adUnit.

      • mobileContentAdsSettingsobject

        Settings specific to WAP mobile content ads (AFMC - deprecated).

      • namestring

        Name of this ad unit.

      • statusstring

        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.

      • codestring

        Identity code of this ad unit, not necessarily unique across ad clients.

      • contentAdsSettingsobject

        Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).

      • customStyleobject

        Custom style information specific to this ad unit.

      • feedAdsSettingsobject

        Settings specific to feed ads (AFF) - deprecated.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsense#adUnit.

      • mobileContentAdsSettingsobject

        Settings specific to WAP mobile content ads (AFMC) - deprecated.

      • namestring

        Name of this ad unit.

      • savedStyleIdstring

        ID of the saved ad style which holds this ad unit's style information.

      • statusstring

        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.

    • Delete the specified ad unit from the specified publisher AdSense account

      This action delete the specified ad unit from the specified publisher AdSense account.

      DELETEAdsensehostAccountsAdunitsDelete

      Request parameters

      • accountId*string

        Account which contains the ad unit.

      • adClientId*string

        Ad client for which to get ad unit.

      • adUnitId*string

        Ad unit to delete.

  • accounts

    • Get information about the selected associated AdSense account

      This action get information about the selected associated AdSense account.

      GETAdsensehostAccountsGet

      Request parameters

      • accountId*string

        Account to get information about.

    • List hosted accounts associated with this AdSense account by ad client id

      This action list hosted accounts associated with this AdSense account by ad client id.

      GETAdsensehostAccountsList

      Request parameters

      • filterAdClientId*string

        Ad clients to list accounts for.

  • accounts.reports

    • Generate an AdSense report based on the report request sent in the query parameters

      This action generate an AdSense 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.

      GETAdsensehostAccountsReportsGenerate

      Request parameters

      • accountId*string

        Hosted account upon which to report.

      • endDate*string

        End of the date range to report on in "YYYY-MM-DD" format, inclusive.

      • startDate*string

        Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

      • dimensionstring

        Dimensions to base the report on.

      • filterstring

        Filters to be run on the report.

      • localestring

        Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

      • maxResultsinteger

        The maximum number of rows of report data to return.

      • metricstring

        Numeric columns to include in the report.

      • sortstring

        The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

      • startIndexinteger

        Index of the first row of report data to return.

  • adclients

    • Get information about one of the ad clients in the Host AdSense account

      This action get information about one of the ad clients in the Host AdSense account.

      GETAdsensehostAdclientsGet

      Request parameters

      • adClientId*string

        Ad client to get.

    • List all host ad clients in this AdSense account

      This action list all host ad clients in this AdSense account.

      GETAdsensehostAdclientsList

      Request parameters

      • maxResultsinteger

        The maximum number of ad clients to include in the response, used for paging.

      • pageTokenstring

        A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

  • associationsessions

    • Create an association session for initiating an association with an AdSense user

      This action create an association session for initiating an association with an AdSense user.

      GETAdsensehostAssociationsessionsStart

      Request parameters

      • productCode*string

        Products to associate with the user.

      • websiteUrl*string

        The URL of the user's hosted website.

      • userLocalestring

        The preferred locale of the user.

      • websiteLocalestring

        The locale of the user's hosted website.

    • Verify an association session after the association callback returns from AdSense signup

      This action verify an association session after the association callback returns from AdSense signup.

      GETAdsensehostAssociationsessionsVerify

      Request parameters

      • token*string

        The token returned to the association callback URL.

  • customchannels

    • Get a specific custom channel from the host AdSense account

      This action get a specific custom channel from the host AdSense account.

      GETAdsensehostCustomchannelsGet

      Request parameters

      • adClientId*string

        Ad client from which to get the custom channel.

      • customChannelId*string

        Custom channel to get.

    • List all host custom channels in this AdSense account

      This action list all host custom channels in this AdSense account.

      GETAdsensehostCustomchannelsList

      Request parameters

      • adClientId*string

        Ad client for which to list custom channels.

      • maxResultsinteger

        The maximum number of custom channels to include in the response, used for paging.

      • pageTokenstring

        A continuation token, used to page through custom channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

    • Add a new custom channel to the host AdSense account

      This action add a new custom channel to the host AdSense account.

      POSTAdsensehostCustomchannelsInsert

      Request parameters

      • adClientId*string

        Ad client to which the new custom channel will be added.

      Request body

      • codestring

        Code of this custom channel, not necessarily unique across ad clients.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsensehost#customChannel.

      • namestring

        Name of this custom channel.

      • codestring

        Code of this custom channel, not necessarily unique across ad clients.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsense#customChannel.

      • namestring

        Name of this custom channel.

      • targetingInfoobject

        The targeting information of this custom channel, if activated.

    • Update a custom channel in the host AdSense account

      This action update a custom channel in the host AdSense account.

      PUTAdsensehostCustomchannelsUpdate

      Request parameters

      • adClientId*string

        Ad client in which the custom channel will be updated.

      Request body

      • codestring

        Code of this custom channel, not necessarily unique across ad clients.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsensehost#customChannel.

      • namestring

        Name of this custom channel.

      • codestring

        Code of this custom channel, not necessarily unique across ad clients.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsense#customChannel.

      • namestring

        Name of this custom channel.

      • targetingInfoobject

        The targeting information of this custom channel, if activated.

    • Update a custom channel in the host AdSense account

      This action update a custom channel in the host AdSense account. This method supports patch semantics.

      PATCHAdsensehostCustomchannelsPatch

      Request parameters

      • adClientId*string

        Ad client in which the custom channel will be updated.

      • customChannelId*string

        Custom channel to get.

      Request body

      • codestring

        Code of this custom channel, not necessarily unique across ad clients.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsensehost#customChannel.

      • namestring

        Name of this custom channel.

      • codestring

        Code of this custom channel, not necessarily unique across ad clients.

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsense#customChannel.

      • namestring

        Name of this custom channel.

      • targetingInfoobject

        The targeting information of this custom channel, if activated.

    • Delete a specific custom channel from the host AdSense account

      This action delete a specific custom channel from the host AdSense account.

      DELETEAdsensehostCustomchannelsDelete

      Request parameters

      • adClientId*string

        Ad client from which to delete the custom channel.

      • customChannelId*string

        Custom channel to delete.

  • reports

    • Generate an AdSense report based on the report request sent in the query parameters

      This action generate an AdSense 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.

      GETAdsensehostReportsGenerate

      Request parameters

      • endDate*string

        End of the date range to report on in "YYYY-MM-DD" format, inclusive.

      • startDate*string

        Start of the date range to report on in "YYYY-MM-DD" format, inclusive.

      • dimensionstring

        Dimensions to base the report on.

      • filterstring

        Filters to be run on the report.

      • localestring

        Optional locale to use for translating report output to a local language. Defaults to "en_US" if not specified.

      • maxResultsinteger

        The maximum number of rows of report data to return.

      • metricstring

        Numeric columns to include in the report.

      • sortstring

        The name of a dimension or metric to sort the resulting report on, optionally prefixed with "+" to sort ascending or "-" to sort descending. If no prefix is specified, the column is sorted ascending.

      • startIndexinteger

        Index of the first row of report data to return.

  • urlchannels

    • List all host URL channels in the host AdSense account

      This action list all host URL channels in the host AdSense account.

      GETAdsensehostUrlchannelsList

      Request parameters

      • adClientId*string

        Ad client for which to list URL channels.

      • maxResultsinteger

        The maximum number of URL channels to include in the response, used for paging.

      • pageTokenstring

        A continuation token, used to page through URL channels. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response.

    • Add a new URL channel to the host AdSense account

      This action add a new URL channel to the host AdSense account.

      POSTAdsensehostUrlchannelsInsert

      Request parameters

      • adClientId*string

        Ad client to which the new URL channel will be added.

      Request body

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsensehost#urlChannel.

      • urlPatternstring

        URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home

      • idstring

        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.

      • kindstring

        Kind of resource this is, in this case adsense#urlChannel.

      • urlPatternstring

        URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home

    • Delete a URL channel from the host AdSense account

      This action delete a URL channel from the host AdSense account.

      DELETEAdsensehostUrlchannelsDelete

      Request parameters

      • adClientId*string

        Ad client from which to delete the URL channel.

      • urlChannelId*string

        URL channel to delete.