googleapis
Version:
Google APIs Client Library for Node.js
1,170 lines • 113 kB
TypeScript
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace adsensehost_v4_1 {
export interface Options extends GlobalOptions {
version: 'v4.1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* Data format for the response.
*/
alt?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
*/
quotaUser?: string;
/**
* Deprecated. Please use quotaUser instead.
*/
userIp?: string;
}
/**
* AdSense Host API
*
* Generates performance reports, generates ad codes, and provides publisher management capabilities for AdSense Hosts.
*
* @example
* ```js
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
* ```
*/
export class Adsensehost {
context: APIRequestContext;
accounts: Resource$Accounts;
adclients: Resource$Adclients;
associationsessions: Resource$Associationsessions;
customchannels: Resource$Customchannels;
reports: Resource$Reports;
urlchannels: Resource$Urlchannels;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
export interface Schema$Account {
/**
* Unique identifier of this account.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#account.
*/
kind?: string | null;
/**
* Name of this account.
*/
name?: string | null;
/**
* Approval status of this account. One of: PENDING, APPROVED, DISABLED.
*/
status?: string | null;
}
export interface Schema$Accounts {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The accounts returned in this list response.
*/
items?: Schema$Account[];
/**
* Kind of list this is, in this case adsensehost#accounts.
*/
kind?: string | null;
}
export interface Schema$AdClient {
/**
* Whether this ad client is opted in to ARC.
*/
arcOptIn?: boolean | null;
/**
* Unique identifier of this ad client.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#adClient.
*/
kind?: string | null;
/**
* This ad client's product code, which corresponds to the PRODUCT_CODE report dimension.
*/
productCode?: string | null;
/**
* Whether this ad client supports being reported on.
*/
supportsReporting?: boolean | null;
}
export interface Schema$AdClients {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ad clients returned in this list response.
*/
items?: Schema$AdClient[];
/**
* Kind of list this is, in this case adsensehost#adClients.
*/
kind?: string | null;
/**
* Continuation token used to page through ad clients. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export interface Schema$AdCode {
/**
* The ad code snippet.
*/
adCode?: string | null;
/**
* Kind this is, in this case adsensehost#adCode.
*/
kind?: string | null;
}
export interface Schema$AdStyle {
/**
* The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash.
*/
colors?: {
background?: string;
border?: string;
text?: string;
title?: string;
url?: string;
} | null;
/**
* The style of the corners in the ad (deprecated: never populated, ignored).
*/
corners?: string | null;
/**
* The font which is included in the style.
*/
font?: {
family?: string;
size?: string;
} | null;
/**
* Kind this is, in this case adsensehost#adStyle.
*/
kind?: string | null;
}
export interface Schema$AdUnit {
/**
* Identity code of this ad unit, not necessarily unique across ad clients.
*/
code?: string | null;
/**
* Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated).
*/
contentAdsSettings?: {
backupOption?: {
color?: string;
type?: string;
url?: string;
};
size?: string;
type?: string;
} | null;
/**
* Custom style information specific to this ad unit.
*/
customStyle?: Schema$AdStyle;
/**
* 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.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#adUnit.
*/
kind?: string | null;
/**
* Settings specific to WAP mobile content ads (AFMC - deprecated).
*/
mobileContentAdsSettings?: {
markupLanguage?: string;
scriptingLanguage?: string;
size?: string;
type?: string;
} | null;
/**
* Name of this ad unit.
*/
name?: string | null;
/**
* 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.
*/
status?: string | null;
}
export interface Schema$AdUnits {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The ad units returned in this list response.
*/
items?: Schema$AdUnit[];
/**
* Kind of list this is, in this case adsensehost#adUnits.
*/
kind?: string | null;
/**
* Continuation token used to page through ad units. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export interface Schema$AssociationSession {
/**
* Hosted account id of the associated publisher after association. Present if status is ACCEPTED.
*/
accountId?: string | null;
/**
* Unique identifier of this association session.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#associationSession.
*/
kind?: string | null;
/**
* The products to associate with the user. Options: AFC, AFG, AFV, AFS (deprecated), AFMC (deprecated)
*/
productCodes?: string[] | null;
/**
* Redirect URL of this association session. Used to redirect users into the AdSense association flow.
*/
redirectUrl?: string | null;
/**
* Status of the completed association, available once the association callback token has been verified. One of ACCEPTED, REJECTED, or ERROR.
*/
status?: string | null;
/**
* The preferred locale of the user themselves when going through the AdSense association flow.
*/
userLocale?: string | null;
/**
* The locale of the user's hosted website.
*/
websiteLocale?: string | null;
/**
* The URL of the user's hosted website.
*/
websiteUrl?: string | null;
}
export interface Schema$CustomChannel {
/**
* Code of this custom channel, not necessarily unique across ad clients.
*/
code?: string | null;
/**
* 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.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#customChannel.
*/
kind?: string | null;
/**
* Name of this custom channel.
*/
name?: string | null;
}
export interface Schema$CustomChannels {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The custom channels returned in this list response.
*/
items?: Schema$CustomChannel[];
/**
* Kind of list this is, in this case adsensehost#customChannels.
*/
kind?: string | null;
/**
* Continuation token used to page through custom channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export interface Schema$Report {
/**
* The averages of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
averages?: string[] | null;
/**
* 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.
*/
headers?: Array<{
currency?: string;
name?: string;
type?: string;
}> | null;
/**
* Kind this is, in this case adsensehost#report.
*/
kind?: string | null;
/**
* 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.
*/
rows?: string[][] | null;
/**
* 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.
*/
totalMatchedRows?: string | null;
/**
* The totals of the report. This is the same length as any other row in the report; cells corresponding to dimension columns are empty.
*/
totals?: string[] | null;
/**
* Any warnings associated with generation of the report.
*/
warnings?: string[] | null;
}
export interface Schema$UrlChannel {
/**
* 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.
*/
id?: string | null;
/**
* Kind of resource this is, in this case adsensehost#urlChannel.
*/
kind?: string | null;
/**
* URL Pattern of this URL channel. Does not include "http://" or "https://". Example: www.example.com/home
*/
urlPattern?: string | null;
}
export interface Schema$UrlChannels {
/**
* ETag of this response for caching purposes.
*/
etag?: string | null;
/**
* The URL channels returned in this list response.
*/
items?: Schema$UrlChannel[];
/**
* Kind of list this is, in this case adsensehost#urlChannels.
*/
kind?: string | null;
/**
* Continuation token used to page through URL channels. To retrieve the next page of results, set the next request's "pageToken" value to this.
*/
nextPageToken?: string | null;
}
export class Resource$Accounts {
context: APIRequestContext;
adclients: Resource$Accounts$Adclients;
adunits: Resource$Accounts$Adunits;
reports: Resource$Accounts$Reports;
constructor(context: APIRequestContext);
/**
* Get information about the selected associated AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.get({
* // Account to get information about.
* accountId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "id": "my_id",
* // "kind": "my_kind",
* // "name": "my_name",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Get, options?: MethodOptions): GaxiosPromise<Schema$Account>;
get(params: Params$Resource$Accounts$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Get, options: MethodOptions | BodyResponseCallback<Schema$Account>, callback: BodyResponseCallback<Schema$Account>): void;
get(params: Params$Resource$Accounts$Get, callback: BodyResponseCallback<Schema$Account>): void;
get(callback: BodyResponseCallback<Schema$Account>): void;
/**
* List hosted accounts associated with this AdSense account by ad client id.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.list({
* // Ad clients to list accounts for.
* filterAdClientId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$List, options?: MethodOptions): GaxiosPromise<Schema$Accounts>;
list(params: Params$Resource$Accounts$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$List, options: MethodOptions | BodyResponseCallback<Schema$Accounts>, callback: BodyResponseCallback<Schema$Accounts>): void;
list(params: Params$Resource$Accounts$List, callback: BodyResponseCallback<Schema$Accounts>): void;
list(callback: BodyResponseCallback<Schema$Accounts>): void;
}
export interface Params$Resource$Accounts$Get extends StandardParameters {
/**
* Account to get information about.
*/
accountId?: string;
}
export interface Params$Resource$Accounts$List extends StandardParameters {
/**
* Ad clients to list accounts for.
*/
filterAdClientId?: string[];
}
export class Resource$Accounts$Adclients {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Get information about one of the ad clients in the specified publisher's AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adclients.get({
* // Account which contains the ad client.
* accountId: 'placeholder-value',
* // Ad client to get.
* adClientId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "arcOptIn": false,
* // "id": "my_id",
* // "kind": "my_kind",
* // "productCode": "my_productCode",
* // "supportsReporting": false
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Adclients$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Adclients$Get, options?: MethodOptions): GaxiosPromise<Schema$AdClient>;
get(params: Params$Resource$Accounts$Adclients$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Adclients$Get, options: MethodOptions | BodyResponseCallback<Schema$AdClient>, callback: BodyResponseCallback<Schema$AdClient>): void;
get(params: Params$Resource$Accounts$Adclients$Get, callback: BodyResponseCallback<Schema$AdClient>): void;
get(callback: BodyResponseCallback<Schema$AdClient>): void;
/**
* List all hosted ad clients in the specified hosted account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adclients.list({
* // Account for which to list ad clients.
* accountId: 'placeholder-value',
* // The maximum number of ad clients to include in the response, used for paging.
* maxResults: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Adclients$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Adclients$List, options?: MethodOptions): GaxiosPromise<Schema$AdClients>;
list(params: Params$Resource$Accounts$Adclients$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Adclients$List, options: MethodOptions | BodyResponseCallback<Schema$AdClients>, callback: BodyResponseCallback<Schema$AdClients>): void;
list(params: Params$Resource$Accounts$Adclients$List, callback: BodyResponseCallback<Schema$AdClients>): void;
list(callback: BodyResponseCallback<Schema$AdClients>): void;
}
export interface Params$Resource$Accounts$Adclients$Get extends StandardParameters {
/**
* Account which contains the ad client.
*/
accountId?: string;
/**
* Ad client to get.
*/
adClientId?: string;
}
export interface Params$Resource$Accounts$Adclients$List extends StandardParameters {
/**
* Account for which to list ad clients.
*/
accountId?: string;
/**
* The maximum number of ad clients to include in the response, used for paging.
*/
maxResults?: number;
/**
* 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.
*/
pageToken?: string;
}
export class Resource$Accounts$Adunits {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Delete the specified ad unit from the specified publisher AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adunits.delete({
* // Account which contains the ad unit.
* accountId: 'placeholder-value',
* // Ad client for which to get ad unit.
* adClientId: 'placeholder-value',
* // Ad unit to delete.
* adUnitId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Accounts$Adunits$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Accounts$Adunits$Delete, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
delete(params: Params$Resource$Accounts$Adunits$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Accounts$Adunits$Delete, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
delete(params: Params$Resource$Accounts$Adunits$Delete, callback: BodyResponseCallback<Schema$AdUnit>): void;
delete(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* Get the specified host ad unit in this AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adunits.get({
* // Account which contains the ad unit.
* accountId: 'placeholder-value',
* // Ad client for which to get ad unit.
* adClientId: 'placeholder-value',
* // Ad unit to get.
* adUnitId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Adunits$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Accounts$Adunits$Get, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
get(params: Params$Resource$Accounts$Adunits$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Accounts$Adunits$Get, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
get(params: Params$Resource$Accounts$Adunits$Get, callback: BodyResponseCallback<Schema$AdUnit>): void;
get(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* Get ad code for the specified ad unit, attaching the specified host custom channels.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adunits.getAdCode({
* // Account which contains the ad client.
* accountId: 'placeholder-value',
* // Ad client with contains the ad unit.
* adClientId: 'placeholder-value',
* // Ad unit to get the code for.
* adUnitId: 'placeholder-value',
* // Host custom channel to attach to the ad code.
* hostCustomChannelId: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "adCode": "my_adCode",
* // "kind": "my_kind"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
getAdCode(params: Params$Resource$Accounts$Adunits$Getadcode, options: StreamMethodOptions): GaxiosPromise<Readable>;
getAdCode(params?: Params$Resource$Accounts$Adunits$Getadcode, options?: MethodOptions): GaxiosPromise<Schema$AdCode>;
getAdCode(params: Params$Resource$Accounts$Adunits$Getadcode, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
getAdCode(params: Params$Resource$Accounts$Adunits$Getadcode, options: MethodOptions | BodyResponseCallback<Schema$AdCode>, callback: BodyResponseCallback<Schema$AdCode>): void;
getAdCode(params: Params$Resource$Accounts$Adunits$Getadcode, callback: BodyResponseCallback<Schema$AdCode>): void;
getAdCode(callback: BodyResponseCallback<Schema$AdCode>): void;
/**
* Insert the supplied ad unit into the specified publisher AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adunits.insert({
* // Account which will contain the ad unit.
* accountId: 'placeholder-value',
* // Ad client into which to insert the ad unit.
* adClientId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
insert(params: Params$Resource$Accounts$Adunits$Insert, options: StreamMethodOptions): GaxiosPromise<Readable>;
insert(params?: Params$Resource$Accounts$Adunits$Insert, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
insert(params: Params$Resource$Accounts$Adunits$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
insert(params: Params$Resource$Accounts$Adunits$Insert, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
insert(params: Params$Resource$Accounts$Adunits$Insert, callback: BodyResponseCallback<Schema$AdUnit>): void;
insert(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* List all ad units in the specified publisher's AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adunits.list({
* // Account which contains the ad client.
* accountId: 'placeholder-value',
* // Ad client for which to list ad units.
* adClientId: 'placeholder-value',
* // Whether to include inactive ad units. Default: true.
* includeInactive: 'placeholder-value',
* // The maximum number of ad units to include in the response, used for paging.
* maxResults: 'placeholder-value',
* // 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.
* pageToken: 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "etag": "my_etag",
* // "items": [],
* // "kind": "my_kind",
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Adunits$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Accounts$Adunits$List, options?: MethodOptions): GaxiosPromise<Schema$AdUnits>;
list(params: Params$Resource$Accounts$Adunits$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Accounts$Adunits$List, options: MethodOptions | BodyResponseCallback<Schema$AdUnits>, callback: BodyResponseCallback<Schema$AdUnits>): void;
list(params: Params$Resource$Accounts$Adunits$List, callback: BodyResponseCallback<Schema$AdUnits>): void;
list(callback: BodyResponseCallback<Schema$AdUnits>): void;
/**
* Update the supplied ad unit in the specified publisher AdSense account. This method supports patch semantics.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adunits.patch({
* // Account which contains the ad client.
* accountId: 'placeholder-value',
* // Ad client which contains the ad unit.
* adClientId: 'placeholder-value',
* // Ad unit to get.
* adUnitId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Accounts$Adunits$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Accounts$Adunits$Patch, options?: MethodOptions): GaxiosPromise<Schema$AdUnit>;
patch(params: Params$Resource$Accounts$Adunits$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Accounts$Adunits$Patch, options: MethodOptions | BodyResponseCallback<Schema$AdUnit>, callback: BodyResponseCallback<Schema$AdUnit>): void;
patch(params: Params$Resource$Accounts$Adunits$Patch, callback: BodyResponseCallback<Schema$AdUnit>): void;
patch(callback: BodyResponseCallback<Schema$AdUnit>): void;
/**
* Update the supplied ad unit in the specified publisher AdSense account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/adsensehost.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const adsensehost = google.adsensehost('v4.1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adsensehost'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await adsensehost.accounts.adunits.update({
* // Account which contains the ad client.
* accountId: 'placeholder-value',
* // Ad client which contains the ad unit.
* adClientId: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "code": "my_code",
* // "contentAdsSettings": {},
* // "customStyle": {},
* // "id": "my_id",
* // "kind": "my_kind",
* // "mobileContentAdsSettings": {},
* // "name": "my_name",
* // "status": "my_status"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally ove