Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

AdSenseHost

import { AdSenseHost } from "https://googleapis.deno.dev/v1/adsensehost:v4.1.ts";

Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.

class AdSenseHost {
constructor(client?: CredentialsClient, baseUrl?: string);
async accountsAdclientsGet(accountId: string, adClientId: string): Promise<AdClient>;
async accountsAdclientsList(accountId: string, opts?: AccountsAdclientsListOptions): Promise<AdClients>;
async accountsAdunitsDelete(
accountId: string,
adClientId: string,
adUnitId: string,
): Promise<AdUnit>;
async accountsAdunitsGet(
accountId: string,
adClientId: string,
adUnitId: string,
): Promise<AdUnit>;
async accountsAdunitsGetAdCode(
accountId: string,
adClientId: string,
adUnitId: string,
): Promise<AdCode>;
async accountsAdunitsInsert(
accountId: string,
adClientId: string,
req: AdUnit,
): Promise<AdUnit>;
async accountsAdunitsList(
accountId: string,
adClientId: string,
): Promise<AdUnits>;
async accountsAdunitsPatch(
accountId: string,
adClientId: string,
req: AdUnit,
): Promise<AdUnit>;
async accountsAdunitsUpdate(
accountId: string,
adClientId: string,
req: AdUnit,
): Promise<AdUnit>;
async accountsGet(accountId: string): Promise<Account>;
async accountsList(opts?: AccountsListOptions): Promise<Accounts>;
async accountsReportsGenerate(accountId: string, opts?: AccountsReportsGenerateOptions): Promise<Report>;
async adclientsGet(adClientId: string): Promise<AdClient>;
async adclientsList(opts?: AdclientsListOptions): Promise<AdClients>;
async associationsessionsStart(opts?: AssociationsessionsStartOptions): Promise<AssociationSession>;
async associationsessionsVerify(opts?: AssociationsessionsVerifyOptions): Promise<AssociationSession>;
async customchannelsDelete(adClientId: string, customChannelId: string): Promise<CustomChannel>;
async customchannelsGet(adClientId: string, customChannelId: string): Promise<CustomChannel>;
async customchannelsInsert(adClientId: string, req: CustomChannel): Promise<CustomChannel>;
async customchannelsList(adClientId: string, opts?: CustomchannelsListOptions): Promise<CustomChannels>;
async customchannelsPatch(
adClientId: string,
): Promise<CustomChannel>;
async customchannelsUpdate(adClientId: string, req: CustomChannel): Promise<CustomChannel>;
async reportsGenerate(opts?: ReportsGenerateOptions): Promise<Report>;
async urlchannelsDelete(adClientId: string, urlChannelId: string): Promise<UrlChannel>;
async urlchannelsInsert(adClientId: string, req: UrlChannel): Promise<UrlChannel>;
async urlchannelsList(adClientId: string, opts?: UrlchannelsListOptions): Promise<UrlChannels>;
}

§Constructors

§
new AdSenseHost(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
accountsAdclientsGet(accountId: string, adClientId: string): Promise<AdClient>
[src]

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

@param accountId

Account which contains the ad client.

@param adClientId

Ad client to get.

§
accountsAdclientsList(accountId: string, opts?: AccountsAdclientsListOptions): Promise<AdClients>
[src]

List all hosted ad clients in the specified hosted account.

@param accountId

Account for which to list ad clients.

§
accountsAdunitsDelete(accountId: string, adClientId: string, adUnitId: string): Promise<AdUnit>
[src]

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

@param accountId

Account which contains the ad unit.

@param adClientId

Ad client for which to get ad unit.

@param adUnitId

Ad unit to delete.

§
accountsAdunitsGet(accountId: string, adClientId: string, adUnitId: string): Promise<AdUnit>
[src]

Get the specified host ad unit in this AdSense account.

@param accountId

Account which contains the ad unit.

@param adClientId

Ad client for which to get ad unit.

@param adUnitId

Ad unit to get.

§
accountsAdunitsGetAdCode(accountId: string, adClientId: string, adUnitId: string, opts?: AccountsAdunitsGetAdCodeOptions): Promise<AdCode>
[src]

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

@param accountId

Account which contains the ad client.

@param adClientId

Ad client with contains the ad unit.

@param adUnitId

Ad unit to get the code for.

§
accountsAdunitsInsert(accountId: string, adClientId: string, req: AdUnit): Promise<AdUnit>
[src]

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

@param accountId

Account which will contain the ad unit.

@param adClientId

Ad client into which to insert the ad unit.

§
accountsAdunitsList(accountId: string, adClientId: string, opts?: AccountsAdunitsListOptions): Promise<AdUnits>
[src]

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

@param accountId

Account which contains the ad client.

@param adClientId

Ad client for which to list ad units.

§
accountsAdunitsPatch(accountId: string, adClientId: string, req: AdUnit, opts?: AccountsAdunitsPatchOptions): Promise<AdUnit>
[src]

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

@param accountId

Account which contains the ad client.

@param adClientId

Ad client which contains the ad unit.

§
accountsAdunitsUpdate(accountId: string, adClientId: string, req: AdUnit): Promise<AdUnit>
[src]

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

@param accountId

Account which contains the ad client.

@param adClientId

Ad client which contains the ad unit.

§
accountsGet(accountId: string): Promise<Account>
[src]

Get information about the selected associated AdSense account.

@param accountId

Account to get information about.

§
accountsList(opts?: AccountsListOptions): Promise<Accounts>
[src]

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

§
accountsReportsGenerate(accountId: string, opts?: AccountsReportsGenerateOptions): Promise<Report>
[src]

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.

@param accountId

Hosted account upon which to report.

§
adclientsGet(adClientId: string): Promise<AdClient>
[src]

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

@param adClientId

Ad client to get.

§
adclientsList(opts?: AdclientsListOptions): Promise<AdClients>
[src]

List all host ad clients in this AdSense account.

§
associationsessionsStart(opts?: AssociationsessionsStartOptions): Promise<AssociationSession>
[src]

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

§
associationsessionsVerify(opts?: AssociationsessionsVerifyOptions): Promise<AssociationSession>
[src]

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

§
customchannelsDelete(adClientId: string, customChannelId: string): Promise<CustomChannel>
[src]

Delete a specific custom channel from the host AdSense account.

@param adClientId

Ad client from which to delete the custom channel.

@param customChannelId

Custom channel to delete.

§
customchannelsGet(adClientId: string, customChannelId: string): Promise<CustomChannel>
[src]

Get a specific custom channel from the host AdSense account.

@param adClientId

Ad client from which to get the custom channel.

@param customChannelId

Custom channel to get.

§
customchannelsInsert(adClientId: string, req: CustomChannel): Promise<CustomChannel>
[src]

Add a new custom channel to the host AdSense account.

@param adClientId

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

§
customchannelsList(adClientId: string, opts?: CustomchannelsListOptions): Promise<CustomChannels>
[src]

List all host custom channels in this AdSense account.

@param adClientId

Ad client for which to list custom channels.

§
customchannelsPatch(adClientId: string, req: CustomChannel, opts?: CustomchannelsPatchOptions): Promise<CustomChannel>
[src]

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

@param adClientId

Ad client in which the custom channel will be updated.

§
customchannelsUpdate(adClientId: string, req: CustomChannel): Promise<CustomChannel>
[src]

Update a custom channel in the host AdSense account.

@param adClientId

Ad client in which the custom channel will be updated.

§
reportsGenerate(opts?: ReportsGenerateOptions): Promise<Report>
[src]

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.

§
urlchannelsDelete(adClientId: string, urlChannelId: string): Promise<UrlChannel>
[src]

Delete a URL channel from the host AdSense account.

@param adClientId

Ad client from which to delete the URL channel.

@param urlChannelId

URL channel to delete.

§
urlchannelsInsert(adClientId: string, req: UrlChannel): Promise<UrlChannel>
[src]

Add a new URL channel to the host AdSense account.

@param adClientId

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

§
urlchannelsList(adClientId: string, opts?: UrlchannelsListOptions): Promise<UrlChannels>
[src]

List all host URL channels in the host AdSense account.

@param adClientId

Ad client for which to list URL channels.