diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index 8809af58899..fe19e4957e4 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -218,10 +218,10 @@ export namespace accesscontextmanager_v1beta { */ ipSubnetworks?: string[]; /** - * The signed-in user originating the request must be a part of one of the - * provided members. Syntax: `user:{emailid}` `group:{emailid}` + * The request must be made by one of the provided user or service accounts. + * Groups are not supported. Syntax: `user:{emailid}` * `serviceAccount:{emailid}` If not specified, a request may come from any - * user (logged in/not logged in, not present in any groups, etc.). + * user. */ members?: string[]; /** diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 3db445dda79..b021b07872b 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -1827,7 +1827,7 @@ export namespace adexchangebuyer2_v2beta1 { export interface Schema$PauseProposalRequest { /** * The reason why the proposal is being paused. This human readable message - * will be displayed in the seller's UI. (Max length: 100 unicode code + * will be displayed in the seller's UI. (Max length: 1000 unicode code * units.) */ reason?: string; diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index fe93afd3e73..590baf6836f 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -265,6 +265,11 @@ export namespace admin_directory_v1 { * JSON template for Building object in Directory API. */ export interface Schema$Building { + /** + * The postal address of the building. See PostalAddress for details. Note + * that only a single address line and region code are required. + */ + address?: Schema$BuildingAddress; /** * Unique identifier for the building. The maximum length is 100 characters. */ @@ -302,6 +307,80 @@ export namespace admin_directory_v1 { */ kind?: string; } + /** + * JSON template for the postal address of a building in Directory API. + */ + export interface Schema$BuildingAddress { + /** + * Unstructured address lines describing the lower levels of an address. + * Because values in addressLines do not have type information and may + * sometimes contain multiple values in a single field (e.g. "Austin, + * TX"), it is important that the line order is clear. The order of + * address lines should be "envelope order" for the country/region + * of the address. In places where this can vary (e.g. Japan), + * address_language is used to make it explicit (e.g. "ja" for + * large-to-small ordering and "ja-Latn" or "en" for + * small-to-large). This way, the most specific line of an address can be + * selected based on the language. The minimum permitted structural + * representation of an address consists of a regionCode with all remaining + * information placed in the addressLines. It would be possible to format + * such an address very approximately without geocoding, but no semantic + * reasoning could be made about any of the address components until it was + * at least partially resolved. Creating an address only containing a + * regionCode and addressLines, and then geocoding is the recommended way to + * handle completely unstructured addresses (as opposed to guessing which + * parts of the address should be localities or administrative areas). + */ + addressLines?: string[]; + /** + * Optional. Highest administrative subdivision which is used for postal + * addresses of a country or region. For example, this can be a state, a + * province, an oblast, or a prefecture. Specifically, for Spain this is the + * province and not the autonomous community (e.g. "Barcelona" and + * not "Catalonia"). Many countries don't use an + * administrative area in postal addresses. E.g. in Switzerland this should + * be left unpopulated. + */ + administrativeArea?: string; + /** + * Optional. BCP-47 language code of the contents of this address (if + * known). This is often the UI language of the input form or is expected to + * match one of the languages used in the address' country/region, or + * their transliterated equivalents. This can affect formatting in certain + * countries, but is not critical to the correctness of the data and will + * never affect any validation or other non-formatting related operations. + * If this value is not known, it should be omitted (rather than specifying + * a possibly incorrect default). Examples: "zh-Hant", + * "ja", "ja-Latn", "en". + */ + languageCode?: string; + /** + * Optional. Generally refers to the city/town portion of the address. + * Examples: US city, IT comune, UK post town. In regions of the world where + * localities are not well defined or do not fit into this structure well, + * leave locality empty and use addressLines. + */ + locality?: string; + /** + * Optional. Postal code of the address. Not all countries use or require + * postal codes to be present, but where they are used, they may trigger + * additional validation with other parts of the address (e.g. state/zip + * validation in the U.S.A.). + */ + postalCode?: string; + /** + * Required. CLDR region code of the country/region of the address. This is + * never inferred and it is up to the user to ensure the value is correct. + * See http://cldr.unicode.org/ and + * http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html + */ + regionCode?: string; + /** + * Optional. Sublocality of the address. For example, this can be + * neighborhoods, boroughs, districts. + */ + sublocality?: string; + } /** * JSON template for coordinates of a building in Directory API. */ @@ -7378,6 +7457,7 @@ export namespace admin_directory_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.coordinatesSource Source from which Building.coordinates are derived. * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. * @param {().Building} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7519,6 +7599,7 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.buildingId The ID of the building to update. + * @param {string=} params.coordinatesSource Source from which Building.coordinates are derived. * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. * @param {().Building} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7589,6 +7670,7 @@ export namespace admin_directory_v1 { * * @param {object} params Parameters for request * @param {string} params.buildingId The ID of the building to update. + * @param {string=} params.coordinatesSource Source from which Building.coordinates are derived. * @param {string} params.customer The unique ID for the customer's G Suite account. As an account administrator, you can also use the my_customer alias to represent your account's customer ID. * @param {().Building} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7694,6 +7776,10 @@ export namespace admin_directory_v1 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * Source from which Building.coordinates are derived. + */ + coordinatesSource?: string; /** * The unique ID for the customer's G Suite account. As an account * administrator, you can also use the my_customer alias to represent your @@ -7739,6 +7825,10 @@ export namespace admin_directory_v1 { * The ID of the building to update. */ buildingId?: string; + /** + * Source from which Building.coordinates are derived. + */ + coordinatesSource?: string; /** * The unique ID for the customer's G Suite account. As an account * administrator, you can also use the my_customer alias to represent your @@ -7762,6 +7852,10 @@ export namespace admin_directory_v1 { * The ID of the building to update. */ buildingId?: string; + /** + * Source from which Building.coordinates are derived. + */ + coordinatesSource?: string; /** * The unique ID for the customer's G Suite account. As an account * administrator, you can also use the my_customer alias to represent your diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index 1a250a5a761..b06e431b785 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -126,7 +126,7 @@ export namespace alertcenter_v1beta1 { loginDetails?: Schema$LoginDetails; } /** - * An alert affecting a customer. All fields are read-only once created. + * An alert affecting a customer. */ export interface Schema$Alert { /** @@ -163,9 +163,10 @@ export namespace alertcenter_v1beta1 { securityInvestigationToolLink?: string; /** * Required. A unique identifier for the system that reported the alert. - * Supported sources are any of the following: * Google Operations * Mobile - * device management * Gmail phishing * Domain wide takeout * Government - * attack warning * Google identity + * This is output only after alert is created. Supported sources are any of + * the following: * Google Operations * Mobile device management * Gmail + * phishing * Domain wide takeout * Government attack warning * Google + * identity */ source?: string; /** @@ -174,8 +175,9 @@ export namespace alertcenter_v1beta1 { */ startTime?: string; /** - * Required. The type of the alert. For a list of available alert types see - * [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). + * Required. The type of the alert. This is output only after alert is + * created. For a list of available alert types see [G Suite Alert + * types](/admin-sdk/alertcenter/reference/alert-types). */ type?: string; } @@ -208,6 +210,15 @@ export namespace alertcenter_v1beta1 { */ type?: string; } + /** + * Alerts from App Maker to notify admins to set up default SQL instance. + */ + export interface Schema$AppMakerSqlSetupNotification { + /** + * List of applications with requests for default SQL set up. + */ + requestInfo?: Schema$RequestInfo[]; + } /** * Attachment with application-specific information about an alert. */ @@ -531,6 +542,24 @@ export namespace alertcenter_v1beta1 { */ messages?: Schema$GmailMessageInfo[]; } + /** + * Requests for one application that needs default SQL setup. + */ + export interface Schema$RequestInfo { + /** + * List of app developers who triggered notifications for above application. + */ + appDeveloperEmail?: string[]; + /** + * Required. The application that requires the SQL setup. + */ + appName?: string; + /** + * Required. Number of requests sent for this application to set up default + * SQL instance. + */ + numberOfRequests?: string; + } /** * Customer-level settings. */ @@ -694,12 +723,13 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.get - * @desc Gets the specified alert. + * @desc Gets the specified alert. Attempting to get a nonexistent alert + * returns `NOT_FOUND` error. * @alias alertcenter.alerts.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.alertId Required. The identifier of the alert to retrieve. Returns a NOT_FOUND error if no such alert. + * @param {string} params.alertId Required. The identifier of the alert to retrieve. * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -916,8 +946,7 @@ export namespace alertcenter_v1beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The identifier of the alert to retrieve. Returns a NOT_FOUND - * error if no such alert. + * Required. The identifier of the alert to retrieve. */ alertId?: string; /** @@ -989,12 +1018,13 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.feedback.create - * @desc Creates new feedback for an alert. + * @desc Creates new feedback for an alert. Attempting to create a feedback + * for a non-existent alert returns `NOT_FOUND` error. * @alias alertcenter.alerts.feedback.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.alertId Required. The identifier of the alert this feedback belongs to. Returns a `NOT_FOUND` error if no such alert. + * @param {string} params.alertId Required. The identifier of the alert this feedback belongs to. * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alert is associated with. Inferred from the caller identity if not provided. * @param {().AlertFeedback} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1058,12 +1088,13 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.alerts.feedback.list - * @desc Lists all the feedback for an alert. + * @desc Lists all the feedback for an alert. Attempting to list feedbacks + * for a non-existent alert returns `NOT_FOUND` error. * @alias alertcenter.alerts.feedback.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.alertId Required. The alert identifier. The "-" wildcard could be used to represent all alerts. If alert does not exist returns a `NOT_FOUND` error. + * @param {string} params.alertId Required. The alert identifier. The "-" wildcard could be used to represent all alerts. * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alert feedback are associated with. Inferred from the caller identity if not provided. * @param {string=} params.filter Optional. A query string for filtering alert feedback results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1136,8 +1167,7 @@ export namespace alertcenter_v1beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The identifier of the alert this feedback belongs to. Returns a - * `NOT_FOUND` error if no such alert. + * Required. The identifier of the alert this feedback belongs to. */ alertId?: string; /** @@ -1161,8 +1191,7 @@ export namespace alertcenter_v1beta1 { /** * Required. The alert identifier. The "-" wildcard could be used to - * represent all alerts. If alert does not exist returns a `NOT_FOUND` - * error. + * represent all alerts. */ alertId?: string; /** @@ -1254,7 +1283,7 @@ export namespace alertcenter_v1beta1 { /** * alertcenter.updateSettings - * @desc Update the customer-level settings. + * @desc Updates the customer-level settings. * @alias alertcenter.updateSettings * @memberOf! () * diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 5073a4191e5..1501d961cf1 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -158,6 +158,11 @@ export namespace androidenterprise_v1 { * "androidenterprise#administratorWebTokenSpec". */ kind?: string; + /** + * Options for displaying the Managed Configuration page. + */ + managedConfigurations?: + Schema$AdministratorWebTokenSpecManagedConfigurations; /** * The URI of the parent frame hosting the iframe. To prevent XSS, the * iframe may not be hosted at other URIs. This URI must be https. @@ -184,6 +189,12 @@ export namespace androidenterprise_v1 { */ webApps?: Schema$AdministratorWebTokenSpecWebApps; } + export interface Schema$AdministratorWebTokenSpecManagedConfigurations { + /** + * Whether the Managed Configuration page is displayed. Default is true. + */ + enabled?: boolean; + } export interface Schema$AdministratorWebTokenSpecPlaySearch { /** * Allow access to the iframe in approve mode. Default is false. @@ -403,7 +414,7 @@ export namespace androidenterprise_v1 { token?: string; } /** - * The Auto install constraint. Defines a set of restrictions for + * The auto-install constraint. Defines a set of restrictions for * installation. At least one of the fields must be set. */ export interface Schema$AutoInstallConstraint { @@ -422,8 +433,8 @@ export namespace androidenterprise_v1 { } export interface Schema$AutoInstallPolicy { /** - * Constraints for auto-installing the app. You can specify a maximum of one - * constraint. + * The constraints for auto-installing the app. You can specify a maximum of + * one constraint. */ autoInstallConstraint?: Schema$AutoInstallConstraint[]; /** @@ -1401,7 +1412,7 @@ export namespace androidenterprise_v1 { */ export interface Schema$ProductPolicy { /** - * The auto install policy for the product. + * The auto-install policy for the product. */ autoInstallPolicy?: Schema$AutoInstallPolicy; /** diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 39fbaa47645..f4deffd0268 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -888,6 +888,15 @@ export namespace androidmanagement_v1 { */ skinTemperatures?: number[]; } + /** + * An action to launch an app. + */ + export interface Schema$LaunchAppAction { + /** + * Package name of app to be launched + */ + packageName?: string; + } /** * Response to a request to list devices for a given enterprise. */ @@ -1540,6 +1549,10 @@ export namespace androidmanagement_v1 { * Whether screen capture is disabled. */ screenCaptureDisabled?: boolean; + /** + * Actions to take during the setup process. + */ + setupActions?: Schema$SetupAction[]; /** * Whether changing the user icon is disabled. */ @@ -1624,8 +1637,7 @@ export namespace androidmanagement_v1 { */ wifiConfigDisabled?: boolean; /** - * Whether Wi-Fi networks defined in Open Network Configuration are locked - * so they can't be edited by the user. + * DEPRECATED - Use wifi_config_disabled. */ wifiConfigsLockdownEnabled?: boolean; } @@ -1670,6 +1682,23 @@ export namespace androidmanagement_v1 { */ port?: number; } + /** + * An action executed during setup. + */ + export interface Schema$SetupAction { + /** + * Description of this action. + */ + description?: Schema$UserFacingMessage; + /** + * An action to launch an app. + */ + launchApp?: Schema$LaunchAppAction; + /** + * Title of this action. + */ + title?: Schema$UserFacingMessage; + } /** * A resource containing sign in details for an enterprise. */ diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 62ce4c47d6c..eb4ebd1b3ba 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -1137,6 +1137,11 @@ export namespace appengine_v1 { * Specify the short name, not the resource path.Defaults to default. */ name?: string; + /** + * Enable session affinity. Only applicable in the App Engine flexible + * environment. + */ + sessionAffinity?: boolean; /** * Google Cloud Platform sub-network where the virtual machines are created. * Specify the short name, not the resource path.If a subnetwork name is diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index d5e53bd7d89..2fae6800285 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -1198,7 +1198,8 @@ export namespace appengine_v1beta { */ name?: string; /** - * Enable session affinity. + * Enable session affinity. Only applicable in the App Engine flexible + * environment. */ sessionAffinity?: boolean; /** diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 192e992939a..a762fd91332 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -2133,6 +2133,11 @@ export namespace bigquery_v2 { totalRows?: string; } export interface Schema$TableFieldSchema { + /** + * [Optional] The categories attached to this field, used for field-level + * access control. + */ + categories?: {names?: string[];}; /** * [Optional] The field description. The maximum length is 1,024 characters. */ diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index c8db61595f3..430452732e2 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -98,12 +98,14 @@ export namespace cloudasset_v1beta1 { * @param {object=} options Options for Cloudasset */ export class Cloudasset { + folders: Resource$Folders; organizations: Resource$Organizations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { context = {_options: options || {}, google}; + this.folders = new Resource$Folders(); this.organizations = new Resource$Organizations(); this.projects = new Resource$Projects(); } @@ -534,6 +536,188 @@ export namespace cloudasset_v1beta1 { } + export class Resource$Folders { + operations: Resource$Folders$Operations; + constructor() { + this.operations = new Resource$Folders$Operations(); + } + + + /** + * cloudasset.folders.exportAssets + * @desc Exports assets with time and resource types to a given Cloud + * Storage location. The output format is newline-delimited JSON. This API + * implements the google.longrunning.Operation API allowing you to keep + * track of the export. + * @alias cloudasset.folders.exportAssets + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), a project number (such as "projects/12345"), or a folder number (such as "folders/123"). + * @param {().ExportAssetsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + exportAssets( + params?: Params$Resource$Folders$Exportassets, + options?: MethodOptions): GaxiosPromise; + exportAssets( + params: Params$Resource$Folders$Exportassets, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + exportAssets( + params: Params$Resource$Folders$Exportassets, + callback: BodyResponseCallback): void; + exportAssets(callback: BodyResponseCallback): void; + exportAssets( + paramsOrCallback?: Params$Resource$Folders$Exportassets| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Folders$Exportassets; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Exportassets; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}:exportAssets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Folders$Exportassets extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The relative name of the root asset. This can only be an + * organization number (such as "organizations/123"), a project ID (such as + * "projects/my-project-id"), a project number (such as "projects/12345"), + * or a folder number (such as "folders/123"). + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportAssetsRequest; + } + + export class Resource$Folders$Operations { + constructor() {} + + + /** + * cloudasset.folders.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by + * the API service. + * @alias cloudasset.folders.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Folders$Operations$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Folders$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Folders$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Folders$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Folders$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Folders$Operations$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + + + export class Resource$Organizations { operations: Resource$Organizations$Operations; constructor() { @@ -547,7 +731,8 @@ export namespace cloudasset_v1beta1 { * For RESOURCE content, this API outputs history with asset in both * non-delete or deleted status. For IAM_POLICY content, this API outputs * history when the asset and its attached IAM POLICY both exist. This can - * create gaps in the output history. + * create gaps in the output history. If a specified asset does not exist, + * this API returns an INVALID_ARGUMENT error. * @alias cloudasset.organizations.batchGetAssetsHistory * @memberOf! () * @@ -634,7 +819,7 @@ export namespace cloudasset_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"). + * @param {string} params.parent Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), a project number (such as "projects/12345"), or a folder number (such as "folders/123"). * @param {().ExportAssetsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -742,8 +927,8 @@ export namespace cloudasset_v1beta1 { /** * Required. The relative name of the root asset. This can only be an * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id"), or a project number (such as - * "projects/12345"). + * "projects/my-project-id"), a project number (such as "projects/12345"), + * or a folder number (such as "folders/123"). */ parent?: string; @@ -849,7 +1034,8 @@ export namespace cloudasset_v1beta1 { * For RESOURCE content, this API outputs history with asset in both * non-delete or deleted status. For IAM_POLICY content, this API outputs * history when the asset and its attached IAM POLICY both exist. This can - * create gaps in the output history. + * create gaps in the output history. If a specified asset does not exist, + * this API returns an INVALID_ARGUMENT error. * @alias cloudasset.projects.batchGetAssetsHistory * @memberOf! () * @@ -936,7 +1122,7 @@ export namespace cloudasset_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), or a project number (such as "projects/12345"). + * @param {string} params.parent Required. The relative name of the root asset. This can only be an organization number (such as "organizations/123"), a project ID (such as "projects/my-project-id"), a project number (such as "projects/12345"), or a folder number (such as "folders/123"). * @param {().ExportAssetsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1044,8 +1230,8 @@ export namespace cloudasset_v1beta1 { /** * Required. The relative name of the root asset. This can only be an * organization number (such as "organizations/123"), a project ID (such as - * "projects/my-project-id"), or a project number (such as - * "projects/12345"). + * "projects/my-project-id"), a project number (such as "projects/12345"), + * or a folder number (such as "folders/123"). */ parent?: string; diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 373d3604a0d..adb602f93ad 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -1557,8 +1557,8 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.getIamPolicy - * @desc Gets the access control policy for a resource. Returns an empty - * policy if the resource exists and does not have a policy set. + * @desc Gets the IAM access control policy for a function. Returns an empty + * policy if the function exists and does not have a policy set. * @alias cloudfunctions.projects.locations.functions.getIamPolicy * @memberOf! () * @@ -1767,8 +1767,8 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces - * any existing policy. + * @desc Sets the IAM access control policy on the specified function. + * Replaces any existing policy. * @alias cloudfunctions.projects.locations.functions.setIamPolicy * @memberOf! () * @@ -1838,11 +1838,9 @@ export namespace cloudfunctions_v1 { /** * cloudfunctions.projects.locations.functions.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If - * the resource does not exist, this will return an empty set of - * permissions, not a NOT_FOUND error. Note: This operation is designed to - * be used for building permission-aware UIs and command-line tools, not for - * authorization checking. This operation may "fail open" without warning. + * @desc Tests the specified permissions against the IAM access control + * policy for a function. If the function does not exist, this will return + * an empty set of permissions, not a NOT_FOUND error. * @alias cloudfunctions.projects.locations.functions.testIamPermissions * @memberOf! () * diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index b2b7f357509..73725bdffa3 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -2865,7 +2865,7 @@ export namespace cloudresourcemanager_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Organization to fetch, e.g. "organizations/1234". + * @param {string} params.name The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4177,8 +4177,9 @@ export namespace cloudresourcemanager_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The resource name of the Organization to fetch, e.g. - * "organizations/1234". + * The resource name of the Organization to fetch. This is the + * organization's relative path in the API, formatted as + * "organizations/[organizationId]". For example, "organizations/1234". */ name?: string; } diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 4b70d084432..cf2360b26f1 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -643,7 +643,7 @@ export namespace cloudresourcemanager_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the Organization to fetch, e.g. "organizations/1234". + * @param {string} params.name The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234". * @param {string=} params.organizationId The id of the Organization resource to fetch. This field is deprecated and will be removed in v1. Use name instead. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1366,8 +1366,9 @@ export namespace cloudresourcemanager_v1beta1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The resource name of the Organization to fetch, e.g. - * "organizations/1234". + * The resource name of the Organization to fetch. This is the + * organization's relative path in the API, formatted as + * "organizations/[organizationId]". For example, "organizations/1234". */ name?: string; /** diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 12f5051f3ed..f07884c154e 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -230,7 +230,8 @@ export namespace cloudsearch_v1 { * all data sources. The value must only contain alphanumeric characters * (a-zA-Z0-9). The value cannot start with 'google' and cannot be * one of the following: mail, gmail, docs, drive, groups, sites, calendar, - * hangouts, gplus, keep. Its maximum length is 32 characters. + * hangouts, gplus, keep, people, teams. Its maximum length is 32 + * characters. */ shortName?: string; } diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 76c1b48fd2c..c985b430ec5 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -548,7 +548,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Queue { /** - * AppEngineHttpQueue settings apply only to AppEngine tasks in this queue. + * AppEngineHttpQueue settings apply only to App Engine tasks in this queue. */ appEngineHttpQueue?: Schema$AppEngineHttpQueue; /** diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index bc7c4abe9d0..d7e85868741 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -440,15 +440,22 @@ export namespace composer_v1 { */ envVariables?: {[key: string]: string;}; /** - * Output only. The version of the software running in the environment. This - * encapsulates both the version of Cloud Composer functionality and the - * version of Apache Airflow. It must match the regular expression - * `composer-[0-9]+\.[0-9]+(\.[0-9]+)?-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. - * The Cloud Composer portion of the version is a [semantic - * version](https://semver.org). The portion of the image version following - * _airflow-_ is an official Apache Airflow repository [release + * The version of the software running in the environment. This encapsulates + * both the version of Cloud Composer functionality and the version of + * Apache Airflow. It must match the regular expression + * `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. + * When used as input, the server also checks if the provided version is + * supported and denies the request for an unsupported version. The Cloud + * Composer portion of the version is a [semantic + * version](https://semver.org) or `latest`. When the patch version is + * omitted, the current Cloud Composer patch version is selected. When + * `latest` is provided instead of an explicit version number, the server + * replaces `latest` with the current Cloud Composer version and stores that + * version number in the same field. The portion of the image version that + * follows <em>airflow-</em> is an official Apache Airflow + * repository [release * name](https://github.com/apache/incubator-airflow/releases). See also - * [Release Notes](/composer/docs/release-notes). + * [Version List](/composer/docs/concepts/versioning/composer-versions). */ imageVersion?: string; /** diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 1c84475824a..22f7dbfeeee 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -447,23 +447,18 @@ export namespace composer_v1beta1 { * both the version of Cloud Composer functionality and the version of * Apache Airflow. It must match the regular expression * `composer-([0-9]+\.[0-9]+\.[0-9]+|latest)-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?`. - * When used as input, the server will also check if the provided version is - * supported and deny the request for an unsupported version. The Cloud + * When used as input, the server also checks if the provided version is + * supported and denies the request for an unsupported version. The Cloud * Composer portion of the version is a [semantic - * version](https://semver.org) or `latest`. The patch version can be - * omitted and the current Cloud Composer patch version will be selected. - * When `latest` is provided instead of an explicit version number, the - * server will replace `latest` with the current Cloud Composer version and - * store that version number in the same field. The portion of the image - * version that follows <em>airflow-</em> is an official Apache - * Airflow repository [release - * name](https://github.com/apache/incubator-airflow/releases). Supported - * values for input are: * `composer-latest-airflow-1.10.0` * - * `composer-latest-airflow-1.9.0` * `composer-latest-airflow-1.10` * - * `composer-latest-airflow-1.9` * `composer-1.3.0-airflow-1.10.0` * - * `composer-1.3.0-airflow-1.9.0` * `composer-1.3.0-airflow-1.10` * - * `composer-1.3.0-airflow-1.9` See also [Release - * Notes](/composer/docs/release-notes). + * version](https://semver.org) or `latest`. When the patch version is + * omitted, the current Cloud Composer patch version is selected. When + * `latest` is provided instead of an explicit version number, the server + * replaces `latest` with the current Cloud Composer version and stores that + * version number in the same field. The portion of the image version that + * follows <em>airflow-</em> is an official Apache Airflow + * repository [release + * name](https://github.com/apache/incubator-airflow/releases). See also + * [Version List](/composer/docs/concepts/versioning/composer-versions). */ imageVersion?: string; /** diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 542629c2b01..aced9337182 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -1407,6 +1407,10 @@ export namespace dataflow_v1b3 { * The initial lease period. */ requestedLeaseDuration?: string; + /** + * Untranslated bag-of-bytes WorkRequest from UnifiedWorker. + */ + unifiedWorkerRequest?: {[key: string]: any;}; /** * Worker capabilities. WorkItems might be limited to workers with specific * capabilities. @@ -1426,6 +1430,10 @@ export namespace dataflow_v1b3 { * Response to a request to lease WorkItems. */ export interface Schema$LeaseWorkItemResponse { + /** + * Untranslated bag-of-bytes WorkResponse for UnifiedWorker. + */ + unifiedWorkerResponse?: {[key: string]: any;}; /** * A list of the leased WorkItems. */ @@ -1938,6 +1946,10 @@ export namespace dataflow_v1b3 { * The location which contains the WorkItem's job. */ location?: string; + /** + * Untranslated bag-of-bytes WorkProgressUpdateRequest from UnifiedWorker. + */ + unifiedWorkerRequest?: {[key: string]: any;}; /** * The ID of the worker reporting the WorkItem status. If this does not * match the ID of the worker which the Dataflow service believes currently @@ -1956,6 +1968,10 @@ export namespace dataflow_v1b3 { * Response from a request to report the status of WorkItems. */ export interface Schema$ReportWorkItemStatusResponse { + /** + * Untranslated bag-of-bytes WorkProgressUpdateResponse for UnifiedWorker. + */ + unifiedWorkerResponse?: {[key: string]: any;}; /** * A set of messages indicating the service-side state for each WorkItem * whose status was reported, in the same order as the WorkItemStatus @@ -2640,6 +2656,11 @@ export namespace dataflow_v1b3 { * System defined name for this computation. */ systemName?: string; + /** + * Map from user name of stateful transforms in this stage to their state + * family. + */ + transformUserNameToStateFamily?: {[key: string]: string;}; } /** * Describes full or partial data disk assignment information of the diff --git a/src/apis/dfareporting/index.ts b/src/apis/dfareporting/index.ts index 87eba0fba0b..180c58bf821 100644 --- a/src/apis/dfareporting/index.ts +++ b/src/apis/dfareporting/index.ts @@ -16,10 +16,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {dfareporting_v3_1} from './v3.1'; import {dfareporting_v3_2} from './v3.2'; +import {dfareporting_v3_3} from './v3.3'; export const VERSIONS = { 'v3.1': dfareporting_v3_1.Dfareporting, 'v3.2': dfareporting_v3_2.Dfareporting, + 'v3.3': dfareporting_v3_3.Dfareporting, }; export function dfareporting(version: 'v3.1'): dfareporting_v3_1.Dfareporting; @@ -28,11 +30,15 @@ export function dfareporting(options: dfareporting_v3_1.Options): export function dfareporting(version: 'v3.2'): dfareporting_v3_2.Dfareporting; export function dfareporting(options: dfareporting_v3_2.Options): dfareporting_v3_2.Dfareporting; +export function dfareporting(version: 'v3.3'): dfareporting_v3_3.Dfareporting; +export function dfareporting(options: dfareporting_v3_3.Options): + dfareporting_v3_3.Dfareporting; export function dfareporting< - T = dfareporting_v3_1.Dfareporting | dfareporting_v3_2.Dfareporting>( + T = dfareporting_v3_1.Dfareporting | dfareporting_v3_2.Dfareporting | + dfareporting_v3_3.Dfareporting>( this: GoogleConfigurable, versionOrOptions: 'v3.1'|dfareporting_v3_1.Options|'v3.2'| - dfareporting_v3_2.Options) { + dfareporting_v3_2.Options|'v3.3'|dfareporting_v3_3.Options) { return getAPI('dfareporting', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/dfareporting/v3.3.ts b/src/apis/dfareporting/v3.3.ts new file mode 100644 index 00000000000..7dd1d9ccf86 --- /dev/null +++ b/src/apis/dfareporting/v3.3.ts @@ -0,0 +1,27507 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {GaxiosPromise} from 'gaxios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace dfareporting_v3_3 { + export interface Options extends GlobalOptions { + version: 'v3_3'; + } + + let context: APIRequestContext; + + interface StandardParameters { + /** + * 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; + } + + /** + * DCM/DFA Reporting And Trafficking API + * + * Manages your DoubleClick Campaign Manager ad campaigns and reports. + * + * @example + * const {google} = require('googleapis'); + * const dfareporting = google.dfareporting('v3.3'); + * + * @namespace dfareporting + * @type {Function} + * @version v3.3 + * @variation v3.3 + * @param {object=} options Options for Dfareporting + */ + export class Dfareporting { + accountActiveAdSummaries: Resource$Accountactiveadsummaries; + accountPermissionGroups: Resource$Accountpermissiongroups; + accountPermissions: Resource$Accountpermissions; + accounts: Resource$Accounts; + accountUserProfiles: Resource$Accountuserprofiles; + ads: Resource$Ads; + advertiserGroups: Resource$Advertisergroups; + advertiserLandingPages: Resource$Advertiserlandingpages; + advertisers: Resource$Advertisers; + browsers: Resource$Browsers; + campaignCreativeAssociations: Resource$Campaigncreativeassociations; + campaigns: Resource$Campaigns; + changeLogs: Resource$Changelogs; + cities: Resource$Cities; + connectionTypes: Resource$Connectiontypes; + contentCategories: Resource$Contentcategories; + conversions: Resource$Conversions; + countries: Resource$Countries; + creativeAssets: Resource$Creativeassets; + creativeFields: Resource$Creativefields; + creativeFieldValues: Resource$Creativefieldvalues; + creativeGroups: Resource$Creativegroups; + creatives: Resource$Creatives; + dimensionValues: Resource$Dimensionvalues; + directorySites: Resource$Directorysites; + dynamicTargetingKeys: Resource$Dynamictargetingkeys; + eventTags: Resource$Eventtags; + files: Resource$Files; + floodlightActivities: Resource$Floodlightactivities; + floodlightActivityGroups: Resource$Floodlightactivitygroups; + floodlightConfigurations: Resource$Floodlightconfigurations; + inventoryItems: Resource$Inventoryitems; + languages: Resource$Languages; + metros: Resource$Metros; + mobileApps: Resource$Mobileapps; + mobileCarriers: Resource$Mobilecarriers; + operatingSystems: Resource$Operatingsystems; + operatingSystemVersions: Resource$Operatingsystemversions; + orderDocuments: Resource$Orderdocuments; + orders: Resource$Orders; + placementGroups: Resource$Placementgroups; + placements: Resource$Placements; + placementStrategies: Resource$Placementstrategies; + platformTypes: Resource$Platformtypes; + postalCodes: Resource$Postalcodes; + projects: Resource$Projects; + regions: Resource$Regions; + remarketingLists: Resource$Remarketinglists; + remarketingListShares: Resource$Remarketinglistshares; + reports: Resource$Reports; + sites: Resource$Sites; + sizes: Resource$Sizes; + subaccounts: Resource$Subaccounts; + targetableRemarketingLists: Resource$Targetableremarketinglists; + targetingTemplates: Resource$Targetingtemplates; + userProfiles: Resource$Userprofiles; + userRolePermissionGroups: Resource$Userrolepermissiongroups; + userRolePermissions: Resource$Userrolepermissions; + userRoles: Resource$Userroles; + videoFormats: Resource$Videoformats; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + context = {_options: options || {}, google}; + + this.accountActiveAdSummaries = new Resource$Accountactiveadsummaries(); + this.accountPermissionGroups = new Resource$Accountpermissiongroups(); + this.accountPermissions = new Resource$Accountpermissions(); + this.accounts = new Resource$Accounts(); + this.accountUserProfiles = new Resource$Accountuserprofiles(); + this.ads = new Resource$Ads(); + this.advertiserGroups = new Resource$Advertisergroups(); + this.advertiserLandingPages = new Resource$Advertiserlandingpages(); + this.advertisers = new Resource$Advertisers(); + this.browsers = new Resource$Browsers(); + this.campaignCreativeAssociations = + new Resource$Campaigncreativeassociations(); + this.campaigns = new Resource$Campaigns(); + this.changeLogs = new Resource$Changelogs(); + this.cities = new Resource$Cities(); + this.connectionTypes = new Resource$Connectiontypes(); + this.contentCategories = new Resource$Contentcategories(); + this.conversions = new Resource$Conversions(); + this.countries = new Resource$Countries(); + this.creativeAssets = new Resource$Creativeassets(); + this.creativeFields = new Resource$Creativefields(); + this.creativeFieldValues = new Resource$Creativefieldvalues(); + this.creativeGroups = new Resource$Creativegroups(); + this.creatives = new Resource$Creatives(); + this.dimensionValues = new Resource$Dimensionvalues(); + this.directorySites = new Resource$Directorysites(); + this.dynamicTargetingKeys = new Resource$Dynamictargetingkeys(); + this.eventTags = new Resource$Eventtags(); + this.files = new Resource$Files(); + this.floodlightActivities = new Resource$Floodlightactivities(); + this.floodlightActivityGroups = new Resource$Floodlightactivitygroups(); + this.floodlightConfigurations = new Resource$Floodlightconfigurations(); + this.inventoryItems = new Resource$Inventoryitems(); + this.languages = new Resource$Languages(); + this.metros = new Resource$Metros(); + this.mobileApps = new Resource$Mobileapps(); + this.mobileCarriers = new Resource$Mobilecarriers(); + this.operatingSystems = new Resource$Operatingsystems(); + this.operatingSystemVersions = new Resource$Operatingsystemversions(); + this.orderDocuments = new Resource$Orderdocuments(); + this.orders = new Resource$Orders(); + this.placementGroups = new Resource$Placementgroups(); + this.placements = new Resource$Placements(); + this.placementStrategies = new Resource$Placementstrategies(); + this.platformTypes = new Resource$Platformtypes(); + this.postalCodes = new Resource$Postalcodes(); + this.projects = new Resource$Projects(); + this.regions = new Resource$Regions(); + this.remarketingLists = new Resource$Remarketinglists(); + this.remarketingListShares = new Resource$Remarketinglistshares(); + this.reports = new Resource$Reports(); + this.sites = new Resource$Sites(); + this.sizes = new Resource$Sizes(); + this.subaccounts = new Resource$Subaccounts(); + this.targetableRemarketingLists = + new Resource$Targetableremarketinglists(); + this.targetingTemplates = new Resource$Targetingtemplates(); + this.userProfiles = new Resource$Userprofiles(); + this.userRolePermissionGroups = new Resource$Userrolepermissiongroups(); + this.userRolePermissions = new Resource$Userrolepermissions(); + this.userRoles = new Resource$Userroles(); + this.videoFormats = new Resource$Videoformats(); + } + } + + /** + * Contains properties of a Campaign Manager account. + */ + export interface Schema$Account { + /** + * Account permissions assigned to this account. + */ + accountPermissionIds?: string[]; + /** + * Profile for this account. This is a read-only field that can be left + * blank. + */ + accountProfile?: string; + /** + * Whether this account is active. + */ + active?: boolean; + /** + * Maximum number of active ads allowed for this account. + */ + activeAdsLimitTier?: string; + /** + * Whether to serve creatives with Active View tags. If disabled, + * viewability data will not be available for any impressions. + */ + activeViewOptOut?: boolean; + /** + * User role permissions available to the user roles of this account. + */ + availablePermissionIds?: string[]; + /** + * ID of the country associated with this account. + */ + countryId?: string; + /** + * ID of currency associated with this account. This is a required field. + * Acceptable values are: - "1" for USD - "2" for GBP + * - "3" for ESP - "4" for SEK - "5" for CAD + * - "6" for JPY - "7" for DEM - "8" for AUD + * - "9" for FRF - "10" for ITL - "11" for + * DKK - "12" for NOK - "13" for FIM - "14" + * for ZAR - "15" for IEP - "16" for NLG - + * "17" for EUR - "18" for KRW - "19" for + * TWD - "20" for SGD - "21" for CNY - "22" + * for HKD - "23" for NZD - "24" for MYR - + * "25" for BRL - "26" for PTE - "27" for + * MXP - "28" for CLP - "29" for TRY - "30" + * for ARS - "31" for PEN - "32" for ILS - + * "33" for CHF - "34" for VEF - "35" for + * COP - "36" for GTQ - "37" for PLN - "39" + * for INR - "40" for THB - "41" for IDR - + * "42" for CZK - "43" for RON - "44" for + * HUF - "45" for RUB - "46" for AED - "47" + * for BGN - "48" for HRK - "49" for MXN - + * "50" for NGN + */ + currencyId?: string; + /** + * Default placement dimensions for this account. + */ + defaultCreativeSizeId?: string; + /** + * Description of this account. + */ + description?: string; + /** + * ID of this account. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#account". + */ + kind?: string; + /** + * Locale of this account. Acceptable values are: - "cs" (Czech) + * - "de" (German) - "en" (English) - + * "en-GB" (English United Kingdom) - "es" (Spanish) - + * "fr" (French) - "it" (Italian) - "ja" + * (Japanese) - "ko" (Korean) - "pl" (Polish) - + * "pt-BR" (Portuguese Brazil) - "ru" (Russian) - + * "sv" (Swedish) - "tr" (Turkish) - "zh-CN" + * (Chinese Simplified) - "zh-TW" (Chinese Traditional) + */ + locale?: string; + /** + * Maximum image size allowed for this account, in kilobytes. Value must be + * greater than or equal to 1. + */ + maximumImageSize?: string; + /** + * Name of this account. This is a required field, and must be less than 128 + * characters long and be globally unique. + */ + name?: string; + /** + * Whether campaigns created in this account will be enabled for Nielsen OCR + * reach ratings by default. + */ + nielsenOcrEnabled?: boolean; + /** + * Reporting configuration of this account. + */ + reportsConfiguration?: Schema$ReportsConfiguration; + /** + * Share Path to Conversion reports with Twitter. + */ + shareReportsWithTwitter?: boolean; + /** + * File size limit in kilobytes of Rich Media teaser creatives. Acceptable + * values are 1 to 10240, inclusive. + */ + teaserSizeLimit?: string; + } + /** + * Gets a summary of active ads in an account. + */ + export interface Schema$AccountActiveAdSummary { + /** + * ID of the account. + */ + accountId?: string; + /** + * Ads that have been activated for the account + */ + activeAds?: string; + /** + * Maximum number of active ads allowed for the account. + */ + activeAdsLimitTier?: string; + /** + * Ads that can be activated for the account. + */ + availableAds?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountActiveAdSummary". + */ + kind?: string; + } + /** + * AccountPermissions contains information about a particular account + * permission. Some features of Campaign Manager require an account permission + * to be present in the account. + */ + export interface Schema$AccountPermission { + /** + * Account profiles associated with this account permission. Possible + * values are: - "ACCOUNT_PROFILE_BASIC" - + * "ACCOUNT_PROFILE_STANDARD" + */ + accountProfiles?: string[]; + /** + * ID of this account permission. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountPermission". + */ + kind?: string; + /** + * Administrative level required to enable this account permission. + */ + level?: string; + /** + * Name of this account permission. + */ + name?: string; + /** + * Permission group of this account permission. + */ + permissionGroupId?: string; + } + /** + * AccountPermissionGroups contains a mapping of permission group IDs to + * names. A permission group is a grouping of account permissions. + */ + export interface Schema$AccountPermissionGroup { + /** + * ID of this account permission group. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountPermissionGroup". + */ + kind?: string; + /** + * Name of this account permission group. + */ + name?: string; + } + /** + * Account Permission Group List Response + */ + export interface Schema$AccountPermissionGroupsListResponse { + /** + * Account permission group collection. + */ + accountPermissionGroups?: Schema$AccountPermissionGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountPermissionGroupsListResponse". + */ + kind?: string; + } + /** + * Account Permission List Response + */ + export interface Schema$AccountPermissionsListResponse { + /** + * Account permission collection. + */ + accountPermissions?: Schema$AccountPermission[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountPermissionsListResponse". + */ + kind?: string; + } + /** + * Account List Response + */ + export interface Schema$AccountsListResponse { + /** + * Account collection. + */ + accounts?: Schema$Account[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * AccountUserProfiles contains properties of a Campaign Manager user profile. + * This resource is specifically for managing user profiles, whereas + * UserProfiles is for accessing the API. + */ + export interface Schema$AccountUserProfile { + /** + * Account ID of the user profile. This is a read-only field that can be + * left blank. + */ + accountId?: string; + /** + * Whether this user profile is active. This defaults to false, and must be + * set true on insert for the user profile to be usable. + */ + active?: boolean; + /** + * Filter that describes which advertisers are visible to the user profile. + */ + advertiserFilter?: Schema$ObjectFilter; + /** + * Filter that describes which campaigns are visible to the user profile. + */ + campaignFilter?: Schema$ObjectFilter; + /** + * Comments for this user profile. + */ + comments?: string; + /** + * Email of the user profile. The email addresss must be linked to a Google + * Account. This field is required on insertion and is read-only after + * insertion. + */ + email?: string; + /** + * ID of the user profile. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountUserProfile". + */ + kind?: string; + /** + * Locale of the user profile. This is a required field. Acceptable values + * are: - "cs" (Czech) - "de" (German) - + * "en" (English) - "en-GB" (English United Kingdom) - + * "es" (Spanish) - "fr" (French) - "it" + * (Italian) - "ja" (Japanese) - "ko" (Korean) - + * "pl" (Polish) - "pt-BR" (Portuguese Brazil) - + * "ru" (Russian) - "sv" (Swedish) - "tr" + * (Turkish) - "zh-CN" (Chinese Simplified) - "zh-TW" + * (Chinese Traditional) + */ + locale?: string; + /** + * Name of the user profile. This is a required field. Must be less than 64 + * characters long, must be globally unique, and cannot contain whitespace + * or any of the following characters: "&;"#%,". + */ + name?: string; + /** + * Filter that describes which sites are visible to the user profile. + */ + siteFilter?: Schema$ObjectFilter; + /** + * Subaccount ID of the user profile. This is a read-only field that can be + * left blank. + */ + subaccountId?: string; + /** + * Trafficker type of this user profile. This is a read-only field. + */ + traffickerType?: string; + /** + * User type of the user profile. This is a read-only field that can be left + * blank. + */ + userAccessType?: string; + /** + * Filter that describes which user roles are visible to the user profile. + */ + userRoleFilter?: Schema$ObjectFilter; + /** + * User role ID of the user profile. This is a required field. + */ + userRoleId?: string; + } + /** + * Account User Profile List Response + */ + export interface Schema$AccountUserProfilesListResponse { + /** + * Account user profile collection. + */ + accountUserProfiles?: Schema$AccountUserProfile[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#accountUserProfilesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Represents an activity group. + */ + export interface Schema$Activities { + /** + * List of activity filters. The dimension values need to be all either of + * type "dfa:activity" or "dfa:activityGroup". + */ + filters?: Schema$DimensionValue[]; + /** + * The kind of resource this is, in this case dfareporting#activities. + */ + kind?: string; + /** + * List of names of floodlight activity metrics. + */ + metricNames?: string[]; + } + /** + * Contains properties of a Campaign Manager ad. + */ + export interface Schema$Ad { + /** + * Account ID of this ad. This is a read-only field that can be left blank. + */ + accountId?: string; + /** + * Whether this ad is active. When true, archived must be false. + */ + active?: boolean; + /** + * Advertiser ID of this ad. This is a required field on insertion. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this ad is archived. When true, active must be false. + */ + archived?: boolean; + /** + * Audience segment ID that is being targeted for this ad. Applicable when + * type is AD_SERVING_STANDARD_AD. + */ + audienceSegmentId?: string; + /** + * Campaign ID of this ad. This is a required field on insertion. + */ + campaignId?: string; + /** + * Dimension value for the ID of the campaign. This is a read-only, + * auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Click-through URL for this ad. This is a required field on insertion. + * Applicable when type is AD_SERVING_CLICK_TRACKER. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Click-through URL suffix properties for this ad. Applies to the URL in + * the ad or (if overriding ad properties) the URL in the creative. + */ + clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; + /** + * Comments for this ad. + */ + comments?: string; + /** + * Compatibility of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. + * DISPLAY and DISPLAY_INTERSTITIAL refer to either rendering on desktop or + * on mobile devices or in mobile apps for regular or interstitial ads, + * respectively. APP and APP_INTERSTITIAL are only used for existing default + * ads. New mobile placements must be assigned DISPLAY or + * DISPLAY_INTERSTITIAL and default ads created for those placements will be + * limited to those compatibility types. IN_STREAM_VIDEO refers to rendering + * in-stream video ads developed with the VAST standard. + */ + compatibility?: string; + /** + * Information about the creation of this ad. This is a read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Creative group assignments for this ad. Applicable when type is + * AD_SERVING_CLICK_TRACKER. Only one assignment per creative group number + * is allowed for a maximum of two assignments. + */ + creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; + /** + * Creative rotation for this ad. Applicable when type is + * AD_SERVING_DEFAULT_AD, AD_SERVING_STANDARD_AD, or AD_SERVING_TRACKING. + * When type is AD_SERVING_DEFAULT_AD, this field should have exactly one + * creativeAssignment. + */ + creativeRotation?: Schema$CreativeRotation; + /** + * Time and day targeting information for this ad. This field must be left + * blank if the ad is using a targeting template. Applicable when type is + * AD_SERVING_STANDARD_AD. + */ + dayPartTargeting?: Schema$DayPartTargeting; + /** + * Default click-through event tag properties for this ad. + */ + defaultClickThroughEventTagProperties?: + Schema$DefaultClickThroughEventTagProperties; + /** + * Delivery schedule information for this ad. Applicable when type is + * AD_SERVING_STANDARD_AD or AD_SERVING_TRACKING. This field along with + * subfields priority and impressionRatio are required on insertion when + * type is AD_SERVING_STANDARD_AD. + */ + deliverySchedule?: Schema$DeliverySchedule; + /** + * Whether this ad is a dynamic click tracker. Applicable when type is + * AD_SERVING_CLICK_TRACKER. This is a required field on insert, and is + * read-only after insert. + */ + dynamicClickTracker?: boolean; + /** + * Date and time that this ad should stop serving. Must be later than the + * start time. This is a required field on insertion. + */ + endTime?: string; + /** + * Event tag overrides for this ad. + */ + eventTagOverrides?: Schema$EventTagOverride[]; + /** + * Geographical targeting information for this ad. This field must be left + * blank if the ad is using a targeting template. Applicable when type is + * AD_SERVING_STANDARD_AD. + */ + geoTargeting?: Schema$GeoTargeting; + /** + * ID of this ad. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Dimension value for the ID of this ad. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key-value targeting information for this ad. This field must be left + * blank if the ad is using a targeting template. Applicable when type is + * AD_SERVING_STANDARD_AD. + */ + keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#ad". + */ + kind?: string; + /** + * Language targeting information for this ad. This field must be left blank + * if the ad is using a targeting template. Applicable when type is + * AD_SERVING_STANDARD_AD. + */ + languageTargeting?: Schema$LanguageTargeting; + /** + * Information about the most recent modification of this ad. This is a + * read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this ad. This is a required field and must be less than 256 + * characters long. + */ + name?: string; + /** + * Placement assignments for this ad. + */ + placementAssignments?: Schema$PlacementAssignment[]; + /** + * Remarketing list targeting expression for this ad. This field must be + * left blank if the ad is using a targeting template. Applicable when type + * is AD_SERVING_STANDARD_AD. + */ + remarketingListExpression?: Schema$ListTargetingExpression; + /** + * Size of this ad. Applicable when type is AD_SERVING_DEFAULT_AD. + */ + size?: Schema$Size; + /** + * Whether this ad is ssl compliant. This is a read-only field that is + * auto-generated when the ad is inserted or updated. + */ + sslCompliant?: boolean; + /** + * Whether this ad requires ssl. This is a read-only field that is + * auto-generated when the ad is inserted or updated. + */ + sslRequired?: boolean; + /** + * Date and time that this ad should start serving. If creating an ad, this + * field must be a time in the future. This is a required field on + * insertion. + */ + startTime?: string; + /** + * Subaccount ID of this ad. This is a read-only field that can be left + * blank. + */ + subaccountId?: string; + /** + * Targeting template ID, used to apply preconfigured targeting information + * to this ad. This cannot be set while any of dayPartTargeting, + * geoTargeting, keyValueTargetingExpression, languageTargeting, + * remarketingListExpression, or technologyTargeting are set. Applicable + * when type is AD_SERVING_STANDARD_AD. + */ + targetingTemplateId?: string; + /** + * Technology platform targeting information for this ad. This field must be + * left blank if the ad is using a targeting template. Applicable when type + * is AD_SERVING_STANDARD_AD. + */ + technologyTargeting?: Schema$TechnologyTargeting; + /** + * Type of ad. This is a required field on insertion. Note that default ads + * (AD_SERVING_DEFAULT_AD) cannot be created directly (see Creative + * resource). + */ + type?: string; + } + /** + * Campaign ad blocking settings. + */ + export interface Schema$AdBlockingConfiguration { + /** + * Click-through URL used by brand-neutral ads. This is a required field + * when overrideClickThroughUrl is set to true. + */ + clickThroughUrl?: string; + /** + * ID of a creative bundle to use for this campaign. If set, brand-neutral + * ads will select creatives from this bundle. Otherwise, a default + * transparent pixel will be used. + */ + creativeBundleId?: string; + /** + * Whether this campaign has enabled ad blocking. When true, ad blocking is + * enabled for placements in the campaign, but this may be overridden by + * site and placement settings. When false, ad blocking is disabled for all + * placements under the campaign, regardless of site and placement settings. + */ + enabled?: boolean; + /** + * Whether the brand-neutral ad's click-through URL comes from the + * campaign's creative bundle or the override URL. Must be set to true + * if ad blocking is enabled and no creative bundle is configured. + */ + overrideClickThroughUrl?: boolean; + } + /** + * Ad List Response + */ + export interface Schema$AdsListResponse { + /** + * Ad collection. + */ + ads?: Schema$Ad[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#adsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Ad Slot + */ + export interface Schema$AdSlot { + /** + * Comment for this ad slot. + */ + comment?: string; + /** + * Ad slot compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to + * rendering either on desktop, mobile devices or in mobile apps for regular + * or interstitial ads respectively. APP and APP_INTERSTITIAL are for + * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in + * in-stream video ads developed with the VAST standard. + */ + compatibility?: string; + /** + * Height of this ad slot. + */ + height?: string; + /** + * ID of the placement from an external platform that is linked to this ad + * slot. + */ + linkedPlacementId?: string; + /** + * Name of this ad slot. + */ + name?: string; + /** + * Payment source type of this ad slot. + */ + paymentSourceType?: string; + /** + * Primary ad slot of a roadblock inventory item. + */ + primary?: boolean; + /** + * Width of this ad slot. + */ + width?: string; + } + /** + * Contains properties of a Campaign Manager advertiser. + */ + export interface Schema$Advertiser { + /** + * Account ID of this advertiser.This is a read-only field that can be left + * blank. + */ + accountId?: string; + /** + * ID of the advertiser group this advertiser belongs to. You can group + * advertisers for reporting purposes, allowing you to see aggregated + * information for all advertisers in each group. + */ + advertiserGroupId?: string; + /** + * Suffix added to click-through URL of ad creative associations under this + * advertiser. Must be less than 129 characters long. + */ + clickThroughUrlSuffix?: string; + /** + * ID of the click-through event tag to apply by default to the landing + * pages of this advertiser's campaigns. + */ + defaultClickThroughEventTagId?: string; + /** + * Default email address used in sender field for tag emails. + */ + defaultEmail?: string; + /** + * Floodlight configuration ID of this advertiser. The floodlight + * configuration ID will be created automatically, so on insert this field + * should be left blank. This field can be set to another advertiser's + * floodlight configuration ID in order to share that advertiser's + * floodlight configuration with this advertiser, so long as: - This + * advertiser's original floodlight configuration is not already + * associated with floodlight activities or floodlight activity groups. - + * This advertiser's original floodlight configuration is not already + * shared with another advertiser. + */ + floodlightConfigurationId?: string; + /** + * Dimension value for the ID of the floodlight configuration. This is a + * read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this advertiser. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Dimension value for the ID of this advertiser. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#advertiser". + */ + kind?: string; + /** + * Name of this advertiser. This is a required field and must be less than + * 256 characters long and unique among advertisers of the same account. + */ + name?: string; + /** + * Original floodlight configuration before any sharing occurred. Set the + * floodlightConfigurationId of this advertiser to + * originalFloodlightConfigurationId to unshare the advertiser's current + * floodlight configuration. You cannot unshare an advertiser's + * floodlight configuration if the shared configuration has activities + * associated with any campaign or placement. + */ + originalFloodlightConfigurationId?: string; + /** + * Status of this advertiser. + */ + status?: string; + /** + * Subaccount ID of this advertiser.This is a read-only field that can be + * left blank. + */ + subaccountId?: string; + /** + * Suspension status of this advertiser. + */ + suspended?: boolean; + } + /** + * Groups advertisers together so that reports can be generated for the entire + * group at once. + */ + export interface Schema$AdvertiserGroup { + /** + * Account ID of this advertiser group. This is a read-only field that can + * be left blank. + */ + accountId?: string; + /** + * ID of this advertiser group. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#advertiserGroup". + */ + kind?: string; + /** + * Name of this advertiser group. This is a required field and must be less + * than 256 characters long and unique among advertiser groups of the same + * account. + */ + name?: string; + } + /** + * Advertiser Group List Response + */ + export interface Schema$AdvertiserGroupsListResponse { + /** + * Advertiser group collection. + */ + advertiserGroups?: Schema$AdvertiserGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#advertiserGroupsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Landing Page List Response + */ + export interface Schema$AdvertiserLandingPagesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#advertiserLandingPagesListResponse". + */ + kind?: string; + /** + * Landing page collection + */ + landingPages?: Schema$LandingPage[]; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Advertiser List Response + */ + export interface Schema$AdvertisersListResponse { + /** + * Advertiser collection. + */ + advertisers?: Schema$Advertiser[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#advertisersListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Audience Segment. + */ + export interface Schema$AudienceSegment { + /** + * Weight allocated to this segment. The weight assigned will be understood + * in proportion to the weights assigned to other segments in the same + * segment group. Acceptable values are 1 to 1000, inclusive. + */ + allocation?: number; + /** + * ID of this audience segment. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Name of this audience segment. This is a required field and must be less + * than 65 characters long. + */ + name?: string; + } + /** + * Audience Segment Group. + */ + export interface Schema$AudienceSegmentGroup { + /** + * Audience segments assigned to this group. The number of segments must be + * between 2 and 100. + */ + audienceSegments?: Schema$AudienceSegment[]; + /** + * ID of this audience segment group. This is a read-only, auto-generated + * field. + */ + id?: string; + /** + * Name of this audience segment group. This is a required field and must be + * less than 65 characters long. + */ + name?: string; + } + /** + * Contains information about a browser that can be targeted by ads. + */ + export interface Schema$Browser { + /** + * ID referring to this grouping of browser and version numbers. This is the + * ID used for targeting. + */ + browserVersionId?: string; + /** + * DART ID of this browser. This is the ID used when generating reports. + */ + dartId?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#browser". + */ + kind?: string; + /** + * Major version number (leftmost number) of this browser. For example, for + * Chrome 5.0.376.86 beta, this field should be set to 5. An asterisk (*) + * may be used to target any version number, and a question mark (?) may be + * used to target cases where the version number cannot be identified. For + * example, Chrome *.* targets any version of Chrome: 1.2, 2.5, 3.5, and so + * on. Chrome 3.* targets Chrome 3.1, 3.5, but not 4.0. Firefox ?.? targets + * cases where the ad server knows the browser is Firefox but can't tell + * which version it is. + */ + majorVersion?: string; + /** + * Minor version number (number after first dot on left) of this browser. + * For example, for Chrome 5.0.375.86 beta, this field should be set to 0. + * An asterisk (*) may be used to target any version number, and a question + * mark (?) may be used to target cases where the version number cannot be + * identified. For example, Chrome *.* targets any version of Chrome: + * 1.2, 2.5, 3.5, and so on. Chrome 3.* targets Chrome 3.1, 3.5, but + * not 4.0. Firefox ?.? targets cases where the ad server knows the browser + * is Firefox but can't tell which version it is. + */ + minorVersion?: string; + /** + * Name of this browser. + */ + name?: string; + } + /** + * Browser List Response + */ + export interface Schema$BrowsersListResponse { + /** + * Browser collection. + */ + browsers?: Schema$Browser[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#browsersListResponse". + */ + kind?: string; + } + /** + * Contains properties of a Campaign Manager campaign. + */ + export interface Schema$Campaign { + /** + * Account ID of this campaign. This is a read-only field that can be left + * blank. + */ + accountId?: string; + /** + * Ad blocking settings for this campaign. + */ + adBlockingConfiguration?: Schema$AdBlockingConfiguration; + /** + * Additional creative optimization configurations for the campaign. + */ + additionalCreativeOptimizationConfigurations?: + Schema$CreativeOptimizationConfiguration[]; + /** + * Advertiser group ID of the associated advertiser. + */ + advertiserGroupId?: string; + /** + * Advertiser ID of this campaign. This is a required field. + */ + advertiserId?: string; + /** + * Dimension value for the advertiser ID of this campaign. This is a + * read-only, auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this campaign has been archived. + */ + archived?: boolean; + /** + * Audience segment groups assigned to this campaign. Cannot have more than + * 300 segment groups. + */ + audienceSegmentGroups?: Schema$AudienceSegmentGroup[]; + /** + * Billing invoice code included in the Campaign Manager client billing + * invoices associated with the campaign. + */ + billingInvoiceCode?: string; + /** + * Click-through URL suffix override properties for this campaign. + */ + clickThroughUrlSuffixProperties?: Schema$ClickThroughUrlSuffixProperties; + /** + * Arbitrary comments about this campaign. Must be less than 256 characters + * long. + */ + comment?: string; + /** + * Information about the creation of this campaign. This is a read-only + * field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * List of creative group IDs that are assigned to the campaign. + */ + creativeGroupIds?: string[]; + /** + * Creative optimization configuration for the campaign. + */ + creativeOptimizationConfiguration?: + Schema$CreativeOptimizationConfiguration; + /** + * Click-through event tag ID override properties for this campaign. + */ + defaultClickThroughEventTagProperties?: + Schema$DefaultClickThroughEventTagProperties; + /** + * The default landing page ID for this campaign. + */ + defaultLandingPageId?: string; + /** + * Date on which the campaign will stop running. On insert, the end date + * must be today or a future date. The end date must be later than or be the + * same as the start date. If, for example, you set 6/25/2015 as both the + * start and end dates, the effective campaign run date is just that day + * only, 6/25/2015. The hours, minutes, and seconds of the end date should + * not be set, as doing so will result in an error. This is a required + * field. + */ + endDate?: string; + /** + * Overrides that can be used to activate or deactivate advertiser event + * tags. + */ + eventTagOverrides?: Schema$EventTagOverride[]; + /** + * External ID for this campaign. + */ + externalId?: string; + /** + * ID of this campaign. This is a read-only auto-generated field. + */ + id?: string; + /** + * Dimension value for the ID of this campaign. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#campaign". + */ + kind?: string; + /** + * Information about the most recent modification of this campaign. This is + * a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this campaign. This is a required field and must be less than 256 + * characters long and unique among campaigns of the same advertiser. + */ + name?: string; + /** + * Whether Nielsen reports are enabled for this campaign. + */ + nielsenOcrEnabled?: boolean; + /** + * Date on which the campaign starts running. The start date can be any + * date. The hours, minutes, and seconds of the start date should not be + * set, as doing so will result in an error. This is a required field. + */ + startDate?: string; + /** + * Subaccount ID of this campaign. This is a read-only field that can be + * left blank. + */ + subaccountId?: string; + /** + * Campaign trafficker contact emails. + */ + traffickerEmails?: string[]; + } + /** + * Identifies a creative which has been associated with a given campaign. + */ + export interface Schema$CampaignCreativeAssociation { + /** + * ID of the creative associated with the campaign. This is a required + * field. + */ + creativeId?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#campaignCreativeAssociation". + */ + kind?: string; + } + /** + * Campaign Creative Association List Response + */ + export interface Schema$CampaignCreativeAssociationsListResponse { + /** + * Campaign creative association collection + */ + campaignCreativeAssociations?: Schema$CampaignCreativeAssociation[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#campaignCreativeAssociationsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Campaign List Response + */ + export interface Schema$CampaignsListResponse { + /** + * Campaign collection. + */ + campaigns?: Schema$Campaign[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#campaignsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Describes a change that a user has made to a resource. + */ + export interface Schema$ChangeLog { + /** + * Account ID of the modified object. + */ + accountId?: string; + /** + * Action which caused the change. + */ + action?: string; + /** + * Time when the object was modified. + */ + changeTime?: string; + /** + * Field name of the object which changed. + */ + fieldName?: string; + /** + * ID of this change log. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#changeLog". + */ + kind?: string; + /** + * New value of the object field. + */ + newValue?: string; + /** + * ID of the object of this change log. The object could be a campaign, + * placement, ad, or other type. + */ + objectId?: string; + /** + * Object type of the change log. + */ + objectType?: string; + /** + * Old value of the object field. + */ + oldValue?: string; + /** + * Subaccount ID of the modified object. + */ + subaccountId?: string; + /** + * Transaction ID of this change log. When a single API call results in many + * changes, each change will have a separate ID in the change log but will + * share the same transactionId. + */ + transactionId?: string; + /** + * ID of the user who modified the object. + */ + userProfileId?: string; + /** + * User profile name of the user who modified the object. + */ + userProfileName?: string; + } + /** + * Change Log List Response + */ + export interface Schema$ChangeLogsListResponse { + /** + * Change log collection. + */ + changeLogs?: Schema$ChangeLog[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#changeLogsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * City List Response + */ + export interface Schema$CitiesListResponse { + /** + * City collection. + */ + cities?: Schema$City[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#citiesListResponse". + */ + kind?: string; + } + /** + * Contains information about a city that can be targeted by ads. + */ + export interface Schema$City { + /** + * Country code of the country to which this city belongs. + */ + countryCode?: string; + /** + * DART ID of the country to which this city belongs. + */ + countryDartId?: string; + /** + * DART ID of this city. This is the ID used for targeting and generating + * reports. + */ + dartId?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#city". + */ + kind?: string; + /** + * Metro region code of the metro region (DMA) to which this city belongs. + */ + metroCode?: string; + /** + * ID of the metro region (DMA) to which this city belongs. + */ + metroDmaId?: string; + /** + * Name of this city. + */ + name?: string; + /** + * Region code of the region to which this city belongs. + */ + regionCode?: string; + /** + * DART ID of the region to which this city belongs. + */ + regionDartId?: string; + } + /** + * Creative Click Tag. + */ + export interface Schema$ClickTag { + /** + * Parameter value for the specified click tag. This field contains a + * click-through url. + */ + clickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * Advertiser event name associated with the click tag. This field is used + * by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to + * DISPLAY when the primary asset type is not HTML_IMAGE. + */ + eventName?: string; + /** + * Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY + * creative assets, this field must match the value of the creative + * asset's creativeAssetId.name field. + */ + name?: string; + } + /** + * Click-through URL + */ + export interface Schema$ClickThroughUrl { + /** + * Read-only convenience field representing the actual URL that will be used + * for this click-through. The URL is computed as follows: - If + * defaultLandingPage is enabled then the campaign's default landing + * page URL is assigned to this field. - If defaultLandingPage is not + * enabled and a landingPageId is specified then that landing page's URL + * is assigned to this field. - If neither of the above cases apply, then + * the customClickThroughUrl is assigned to this field. + */ + computedClickThroughUrl?: string; + /** + * Custom click-through URL. Applicable if the defaultLandingPage field is + * set to false and the landingPageId field is left unset. + */ + customClickThroughUrl?: string; + /** + * Whether the campaign default landing page is used. + */ + defaultLandingPage?: boolean; + /** + * ID of the landing page for the click-through URL. Applicable if the + * defaultLandingPage field is set to false. + */ + landingPageId?: string; + } + /** + * Click Through URL Suffix settings. + */ + export interface Schema$ClickThroughUrlSuffixProperties { + /** + * Click-through URL suffix to apply to all ads in this entity's scope. + * Must be less than 128 characters long. + */ + clickThroughUrlSuffix?: string; + /** + * Whether this entity should override the inherited click-through URL + * suffix with its own defined value. + */ + overrideInheritedSuffix?: boolean; + } + /** + * Companion Click-through override. + */ + export interface Schema$CompanionClickThroughOverride { + /** + * Click-through URL of this companion click-through override. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * ID of the creative for this companion click-through override. + */ + creativeId?: string; + } + /** + * Companion Settings + */ + export interface Schema$CompanionSetting { + /** + * Whether companions are disabled for this placement. + */ + companionsDisabled?: boolean; + /** + * Whitelist of companion sizes to be served to this placement. Set this + * list to null or empty to serve all companion sizes. + */ + enabledSizes?: Schema$Size[]; + /** + * Whether to serve only static images as companions. + */ + imageOnly?: boolean; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#companionSetting". + */ + kind?: string; + } + /** + * Represents a response to the queryCompatibleFields method. + */ + export interface Schema$CompatibleFields { + /** + * Contains items that are compatible to be selected for a report of type + * "CROSS_DIMENSION_REACH". + */ + crossDimensionReachReportCompatibleFields?: + Schema$CrossDimensionReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type + * "FLOODLIGHT". + */ + floodlightReportCompatibleFields?: Schema$FloodlightReportCompatibleFields; + /** + * The kind of resource this is, in this case dfareporting#compatibleFields. + */ + kind?: string; + /** + * Contains items that are compatible to be selected for a report of type + * "PATH_TO_CONVERSION". + */ + pathToConversionReportCompatibleFields?: + Schema$PathToConversionReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type + * "REACH". + */ + reachReportCompatibleFields?: Schema$ReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type + * "STANDARD". + */ + reportCompatibleFields?: Schema$ReportCompatibleFields; + } + /** + * Contains information about an internet connection type that can be targeted + * by ads. Clients can use the connection type to target mobile vs. broadband + * users. + */ + export interface Schema$ConnectionType { + /** + * ID of this connection type. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#connectionType". + */ + kind?: string; + /** + * Name of this connection type. + */ + name?: string; + } + /** + * Connection Type List Response + */ + export interface Schema$ConnectionTypesListResponse { + /** + * Collection of connection types such as broadband and mobile. + */ + connectionTypes?: Schema$ConnectionType[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#connectionTypesListResponse". + */ + kind?: string; + } + /** + * Content Category List Response + */ + export interface Schema$ContentCategoriesListResponse { + /** + * Content category collection. + */ + contentCategories?: Schema$ContentCategory[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#contentCategoriesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Organizes placements according to the contents of their associated + * webpages. + */ + export interface Schema$ContentCategory { + /** + * Account ID of this content category. This is a read-only field that can + * be left blank. + */ + accountId?: string; + /** + * ID of this content category. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#contentCategory". + */ + kind?: string; + /** + * Name of this content category. This is a required field and must be less + * than 256 characters long and unique among content categories of the same + * account. + */ + name?: string; + } + /** + * A Conversion represents when a user successfully performs a desired action + * after seeing an ad. + */ + export interface Schema$Conversion { + /** + * Whether this particular request may come from a user under the age of 13, + * under COPPA compliance. + */ + childDirectedTreatment?: boolean; + /** + * Custom floodlight variables. + */ + customVariables?: Schema$CustomFloodlightVariable[]; + /** + * The alphanumeric encrypted user ID. When set, encryptionInfo should also + * be specified. This field is mutually exclusive with + * encryptedUserIdCandidates[], mobileDeviceId and gclid. This or + * encryptedUserIdCandidates[] or mobileDeviceId or gclid is a required + * field. + */ + encryptedUserId?: string; + /** + * A list of the alphanumeric encrypted user IDs. Any user ID with exposure + * prior to the conversion timestamp will be used in the inserted + * conversion. If no such user ID is found then the conversion will be + * rejected with NO_COOKIE_MATCH_FOUND error. When set, encryptionInfo + * should also be specified. This field may only be used when calling + * batchinsert; it is not supported by batchupdate. This field is mutually + * exclusive with encryptedUserId, mobileDeviceId and gclid. This or + * encryptedUserId or mobileDeviceId or gclid is a required field. + */ + encryptedUserIdCandidates?: string[]; + /** + * Floodlight Activity ID of this conversion. This is a required field. + */ + floodlightActivityId?: string; + /** + * Floodlight Configuration ID of this conversion. This is a required field. + */ + floodlightConfigurationId?: string; + /** + * The Google click ID. This field is mutually exclusive with + * encryptedUserId, encryptedUserIdCandidates[] and mobileDeviceId. This or + * encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId is a + * required field. + */ + gclid?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#conversion". + */ + kind?: string; + /** + * Whether Limit Ad Tracking is enabled. When set to true, the conversion + * will be used for reporting but not targeting. This will prevent + * remarketing. + */ + limitAdTracking?: boolean; + /** + * The mobile device ID. This field is mutually exclusive with + * encryptedUserId, encryptedUserIdCandidates[] and gclid. This or + * encryptedUserId or encryptedUserIdCandidates[] or gclid is a required + * field. + */ + mobileDeviceId?: string; + /** + * Whether the conversion was for a non personalized ad. + */ + nonPersonalizedAd?: boolean; + /** + * The ordinal of the conversion. Use this field to control how conversions + * of the same user and day are de-duplicated. This is a required field. + */ + ordinal?: string; + /** + * The quantity of the conversion. + */ + quantity?: string; + /** + * The timestamp of conversion, in Unix epoch micros. This is a required + * field. + */ + timestampMicros?: string; + /** + * Whether this particular request may come from a user under the age of 16 + * (may differ by country), under compliance with the European Union's + * General Data Protection Regulation (GDPR). + */ + treatmentForUnderage?: boolean; + /** + * The value of the conversion. + */ + value?: number; + } + /** + * The error code and description for a conversion that failed to insert or + * update. + */ + export interface Schema$ConversionError { + /** + * The error code. + */ + code?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#conversionError". + */ + kind?: string; + /** + * A description of the error. + */ + message?: string; + } + /** + * Insert Conversions Request. + */ + export interface Schema$ConversionsBatchInsertRequest { + /** + * The set of conversions to insert. + */ + conversions?: Schema$Conversion[]; + /** + * Describes how encryptedUserId or encryptedUserIdCandidates[] is + * encrypted. This is a required field if encryptedUserId or + * encryptedUserIdCandidates[] is used. + */ + encryptionInfo?: Schema$EncryptionInfo; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#conversionsBatchInsertRequest". + */ + kind?: string; + } + /** + * Insert Conversions Response. + */ + export interface Schema$ConversionsBatchInsertResponse { + /** + * Indicates that some or all conversions failed to insert. + */ + hasFailures?: boolean; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#conversionsBatchInsertResponse". + */ + kind?: string; + /** + * The insert status of each conversion. Statuses are returned in the same + * order that conversions are inserted. + */ + status?: Schema$ConversionStatus[]; + } + /** + * Update Conversions Request. + */ + export interface Schema$ConversionsBatchUpdateRequest { + /** + * The set of conversions to update. + */ + conversions?: Schema$Conversion[]; + /** + * Describes how encryptedUserId is encrypted. This is a required field if + * encryptedUserId is used. + */ + encryptionInfo?: Schema$EncryptionInfo; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#conversionsBatchUpdateRequest". + */ + kind?: string; + } + /** + * Update Conversions Response. + */ + export interface Schema$ConversionsBatchUpdateResponse { + /** + * Indicates that some or all conversions failed to update. + */ + hasFailures?: boolean; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#conversionsBatchUpdateResponse". + */ + kind?: string; + /** + * The update status of each conversion. Statuses are returned in the same + * order that conversions are updated. + */ + status?: Schema$ConversionStatus[]; + } + /** + * The original conversion that was inserted or updated and whether there were + * any errors. + */ + export interface Schema$ConversionStatus { + /** + * The original conversion that was inserted or updated. + */ + conversion?: Schema$Conversion; + /** + * A list of errors related to this conversion. + */ + errors?: Schema$ConversionError[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#conversionStatus". + */ + kind?: string; + } + /** + * Country List Response + */ + export interface Schema$CountriesListResponse { + /** + * Country collection. + */ + countries?: Schema$Country[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#countriesListResponse". + */ + kind?: string; + } + /** + * Contains information about a country that can be targeted by ads. + */ + export interface Schema$Country { + /** + * Country code. + */ + countryCode?: string; + /** + * DART ID of this country. This is the ID used for targeting and generating + * reports. + */ + dartId?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#country". + */ + kind?: string; + /** + * Name of this country. + */ + name?: string; + /** + * Whether ad serving supports secure servers in this country. + */ + sslEnabled?: boolean; + } + /** + * Contains properties of a Creative. + */ + export interface Schema$Creative { + /** + * Account ID of this creative. This field, if left unset, will be + * auto-generated for both insert and update operations. Applicable to all + * creative types. + */ + accountId?: string; + /** + * Whether the creative is active. Applicable to all creative types. + */ + active?: boolean; + /** + * Additional sizes associated with a responsive creative. When inserting or + * updating a creative either the size ID field or size width and height + * fields can be used. Applicable to DISPLAY creatives when the primary + * asset type is HTML_IMAGE. + */ + additionalSizes?: Schema$Size[]; + /** + * Ad parameters user for VPAID creative. This is a read-only field. + * Applicable to the following creative types: all VPAID. + */ + adParameters?: string; + /** + * Keywords for a Rich Media creative. Keywords let you customize the + * creative settings of a Rich Media ad running on your site without having + * to contact the advertiser. You can use keywords to dynamically change the + * look or functionality of a creative. Applicable to the following creative + * types: all RICH_MEDIA, and all VPAID. + */ + adTagKeys?: string[]; + /** + * Advertiser ID of this creative. This is a required field. Applicable to + * all creative types. + */ + advertiserId?: string; + /** + * Whether script access is allowed for this creative. This is a read-only + * and deprecated field which will automatically be set to true on update. + * Applicable to the following creative types: FLASH_INPAGE. + */ + allowScriptAccess?: boolean; + /** + * Whether the creative is archived. Applicable to all creative types. + */ + archived?: boolean; + /** + * Type of artwork used for the creative. This is a read-only field. + * Applicable to the following creative types: all RICH_MEDIA, and all + * VPAID. + */ + artworkType?: string; + /** + * Source application where creative was authored. Presently, only DBM + * authored creatives will have this field set. Applicable to all creative + * types. + */ + authoringSource?: string; + /** + * Authoring tool for HTML5 banner creatives. This is a read-only field. + * Applicable to the following creative types: HTML5_BANNER. + */ + authoringTool?: string; + /** + * Whether images are automatically advanced for image gallery creatives. + * Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. + */ + autoAdvanceImages?: boolean; + /** + * The 6-character HTML color code, beginning with #, for the background of + * the window area where the Flash file is displayed. Default is white. + * Applicable to the following creative types: FLASH_INPAGE. + */ + backgroundColor?: string; + /** + * Click-through URL for backup image. Applicable to ENHANCED_BANNER when + * the primary asset type is not HTML_IMAGE. + */ + backupImageClickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * List of feature dependencies that will cause a backup image to be served + * if the browser that serves the ad does not support them. Feature + * dependencies are features that a browser must be able to support in order + * to render your HTML5 creative asset correctly. This field is initially + * auto-generated to contain all features detected by Campaign Manager for + * all the assets of this creative and can then be modified by the client. + * To reset this field, copy over all the creativeAssets' detected + * features. Applicable to the following creative types: HTML5_BANNER. + * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + backupImageFeatures?: string[]; + /** + * Reporting label used for HTML5 banner backup image. Applicable to the + * following creative types: DISPLAY when the primary asset type is not + * HTML_IMAGE. + */ + backupImageReportingLabel?: string; + /** + * Target window for backup image. Applicable to the following creative + * types: FLASH_INPAGE and HTML5_BANNER. Applicable to DISPLAY when the + * primary asset type is not HTML_IMAGE. + */ + backupImageTargetWindow?: Schema$TargetWindow; + /** + * Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER + * creatives, this is a subset of detected click tags for the assets + * associated with this creative. After creating a flash asset, detected + * click tags will be returned in the creativeAssetMetadata. When inserting + * the creative, populate the creative clickTags field using the + * creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY + * creatives, there should be exactly one entry in this list for each image + * creative asset. A click tag is matched with a corresponding creative + * asset by matching the clickTag.name field with the + * creativeAsset.assetIdentifier.name field. Applicable to the following + * creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. + * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + clickTags?: Schema$ClickTag[]; + /** + * Industry standard ID assigned to creative for reach and frequency. + * Applicable to INSTREAM_VIDEO_REDIRECT creatives. + */ + commercialId?: string; + /** + * List of companion creatives assigned to an in-Stream video creative. + * Acceptable values include IDs of existing flash and image creatives. + * Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO + * and all INSTREAM_VIDEO with dynamicAssetSelection set to false. + */ + companionCreatives?: string[]; + /** + * Compatibilities associated with this creative. This is a read-only field. + * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or + * on mobile devices or in mobile apps for regular or interstitial ads, + * respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. + * Only pre-existing creatives may have these compatibilities since new + * creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL + * instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads + * developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in + * in-stream audio ads developed with the VAST standard. Applicable to all + * creative types. Acceptable values are: - "APP" - + * "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - + * "IN_STREAM_AUDIO" - "DISPLAY" - + * "DISPLAY_INTERSTITIAL" + */ + compatibility?: string[]; + /** + * Whether Flash assets associated with the creative need to be + * automatically converted to HTML5. This flag is enabled by default and + * users can choose to disable it if they don't want the system to + * generate and use HTML5 asset for this creative. Applicable to the + * following creative type: FLASH_INPAGE. Applicable to DISPLAY when the + * primary asset type is not HTML_IMAGE. + */ + convertFlashToHtml5?: boolean; + /** + * List of counter events configured for the creative. For + * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated + * from clickTags. Applicable to the following creative types: + * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. + */ + counterCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Assets associated with a creative. Applicable to all but the following + * creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and + * REDIRECT + */ + creativeAssets?: Schema$CreativeAsset[]; + /** + * Required if dynamicAssetSelection is true. + */ + creativeAssetSelection?: Schema$CreativeAssetSelection; + /** + * Creative field assignments for this creative. Applicable to all creative + * types. + */ + creativeFieldAssignments?: Schema$CreativeFieldAssignment[]; + /** + * Custom key-values for a Rich Media creative. Key-values let you customize + * the creative settings of a Rich Media ad running on your site without + * having to contact the advertiser. You can use key-values to dynamically + * change the look or functionality of a creative. Applicable to the + * following creative types: all RICH_MEDIA, and all VPAID. + */ + customKeyValues?: string[]; + /** + * Set this to true to enable the use of rules to target individual assets + * in this creative. When set to true creativeAssetSelection must be set. + * This also controls asset-level companions. When this is true, companion + * creatives should be assigned to creative assets. Learn more. Applicable + * to INSTREAM_VIDEO creatives. + */ + dynamicAssetSelection?: boolean; + /** + * List of exit events configured for the creative. For DISPLAY and + * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated + * from clickTags, For DISPLAY, an event is also created from the + * backupImageReportingLabel. Applicable to the following creative types: + * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to + * DISPLAY when the primary asset type is not HTML_IMAGE. + */ + exitCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * OpenWindow FSCommand of this creative. This lets the SWF file communicate + * with either Flash Player or the program hosting Flash Player, such as a + * web browser. This is only triggered if allowScriptAccess field is true. + * Applicable to the following creative types: FLASH_INPAGE. + */ + fsCommand?: Schema$FsCommand; + /** + * HTML code for the creative. This is a required field when applicable. + * This field is ignored if htmlCodeLocked is true. Applicable to the + * following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and + * all RICH_MEDIA. + */ + htmlCode?: string; + /** + * Whether HTML code is generated by Campaign Manager or manually entered. + * Set to true to ignore changes to htmlCode. Applicable to the following + * creative types: FLASH_INPAGE and HTML5_BANNER. + */ + htmlCodeLocked?: boolean; + /** + * ID of this creative. This is a read-only, auto-generated field. + * Applicable to all creative types. + */ + id?: string; + /** + * Dimension value for the ID of this creative. This is a read-only field. + * Applicable to all creative types. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creative". + */ + kind?: string; + /** + * Creative last modification information. This is a read-only field. + * Applicable to all creative types. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Latest Studio trafficked creative ID associated with rich media and VPAID + * creatives. This is a read-only field. Applicable to the following + * creative types: all RICH_MEDIA, and all VPAID. + */ + latestTraffickedCreativeId?: string; + /** + * Description of the audio or video ad. Applicable to the following + * creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. + */ + mediaDescription?: string; + /** + * Creative audio or video duration in seconds. This is a read-only field. + * Applicable to the following creative types: INSTREAM_VIDEO, + * INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. + */ + mediaDuration?: number; + /** + * Name of the creative. This is a required field and must be less than 256 + * characters long. Applicable to all creative types. + */ + name?: string; + /** + * Override CSS value for rich media creatives. Applicable to the following + * creative types: all RICH_MEDIA. + */ + overrideCss?: string; + /** + * Amount of time to play the video before counting a view. Applicable to + * the following creative types: all INSTREAM_VIDEO. + */ + progressOffset?: Schema$VideoOffset; + /** + * URL of hosted image or hosted video or another ad tag. For + * INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect + * URL. The standard for a VAST (Video Ad Serving Template) ad response + * allows for a redirect link to another VAST 2.0 or 3.0 call. This is a + * required field when applicable. Applicable to the following creative + * types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, + * INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT + */ + redirectUrl?: string; + /** + * ID of current rendering version. This is a read-only field. Applicable to + * all creative types. + */ + renderingId?: string; + /** + * Dimension value for the rendering ID of this creative. This is a + * read-only field. Applicable to all creative types. + */ + renderingIdDimensionValue?: Schema$DimensionValue; + /** + * The minimum required Flash plugin version for this creative. For + * example, 11.2.202.235. This is a read-only field. Applicable to the + * following creative types: all RICH_MEDIA, and all VPAID. + */ + requiredFlashPluginVersion?: string; + /** + * The internal Flash version for this creative as calculated by Studio. + * This is a read-only field. Applicable to the following creative types: + * FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when + * the primary asset type is not HTML_IMAGE. + */ + requiredFlashVersion?: number; + /** + * Size associated with this creative. When inserting or updating a creative + * either the size ID field or size width and height fields can be used. + * This is a required field when applicable; however for IMAGE, FLASH_INPAGE + * creatives, and for DISPLAY creatives with a primary asset of type + * HTML_IMAGE, if left blank, this field will be automatically set using the + * actual size of the associated image assets. Applicable to the following + * creative types: DISPLAY, DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, + * HTML5_BANNER, IMAGE, and all RICH_MEDIA. + */ + size?: Schema$Size; + /** + * Amount of time to play the video before the skip button appears. + * Applicable to the following creative types: all INSTREAM_VIDEO. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can choose to skip the creative. Applicable to the + * following creative types: all INSTREAM_VIDEO and all VPAID. + */ + skippable?: boolean; + /** + * Whether the creative is SSL-compliant. This is a read-only field. + * Applicable to all creative types. + */ + sslCompliant?: boolean; + /** + * Whether creative should be treated as SSL compliant even if the system + * scan shows it's not. Applicable to all creative types. + */ + sslOverride?: boolean; + /** + * Studio advertiser ID associated with rich media and VPAID creatives. This + * is a read-only field. Applicable to the following creative types: all + * RICH_MEDIA, and all VPAID. + */ + studioAdvertiserId?: string; + /** + * Studio creative ID associated with rich media and VPAID creatives. This + * is a read-only field. Applicable to the following creative types: all + * RICH_MEDIA, and all VPAID. + */ + studioCreativeId?: string; + /** + * Studio trafficked creative ID associated with rich media and VPAID + * creatives. This is a read-only field. Applicable to the following + * creative types: all RICH_MEDIA, and all VPAID. + */ + studioTraffickedCreativeId?: string; + /** + * Subaccount ID of this creative. This field, if left unset, will be + * auto-generated for both insert and update operations. Applicable to all + * creative types. + */ + subaccountId?: string; + /** + * Third-party URL used to record backup image impressions. Applicable to + * the following creative types: all RICH_MEDIA. + */ + thirdPartyBackupImageImpressionsUrl?: string; + /** + * Third-party URL used to record rich media impressions. Applicable to the + * following creative types: all RICH_MEDIA. + */ + thirdPartyRichMediaImpressionsUrl?: string; + /** + * Third-party URLs for tracking in-stream creative events. Applicable to + * the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and + * all VPAID. + */ + thirdPartyUrls?: Schema$ThirdPartyTrackingUrl[]; + /** + * List of timer events configured for the creative. For + * DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated + * from clickTags. Applicable to the following creative types: + * DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to + * DISPLAY when the primary asset is not HTML_IMAGE. + */ + timerCustomEvents?: Schema$CreativeCustomEvent[]; + /** + * Combined size of all creative assets. This is a read-only field. + * Applicable to the following creative types: all RICH_MEDIA, and all + * VPAID. + */ + totalFileSize?: string; + /** + * Type of this creative. This is a required field. Applicable to all + * creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only + * used for existing creatives. New creatives should use DISPLAY as a + * replacement for these types. + */ + type?: string; + /** + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following + * creative types: INSTREAM_AUDIO and INSTREAM_VIDEO and VPAID. + */ + universalAdId?: Schema$UniversalAdId; + /** + * The version number helps you keep track of multiple versions of your + * creative in your reports. The version number will always be + * auto-generated during insert operations to start at 1. For tracking + * creatives the version cannot be incremented and will always remain at 1. + * For all other creative types the version can be incremented only by 1 + * during update operations. In addition, the version will be automatically + * incremented by 1 when undergoing Rich Media creative merging. Applicable + * to all creative types. + */ + version?: number; + } + /** + * Creative Asset. + */ + export interface Schema$CreativeAsset { + /** + * Whether ActionScript3 is enabled for the flash asset. This is a read-only + * field. Applicable to the following creative type: FLASH_INPAGE. + * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + actionScript3?: boolean; + /** + * Whether the video or audio asset is active. This is a read-only field for + * VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative + * types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. + */ + active?: boolean; + /** + * Additional sizes associated with this creative asset. HTML5 asset + * generated by compatible software such as GWD will be able to support more + * sizes this creative asset can render. + */ + additionalSizes?: Schema$Size[]; + /** + * Possible alignments for an asset. This is a read-only field. Applicable + * to the following creative types: + * RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL. + */ + alignment?: string; + /** + * Artwork type of rich media creative. This is a read-only field. + * Applicable to the following creative types: all RICH_MEDIA. + */ + artworkType?: string; + /** + * Identifier of this asset. This is the same identifier returned during + * creative asset insert operation. This is a required field. Applicable to + * all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + assetIdentifier?: Schema$CreativeAssetId; + /** + * Audio stream bit rate in kbps. This is a read-only field. Applicable to + * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all + * VPAID. + */ + audioBitRate?: number; + /** + * Audio sample bit rate in hertz. This is a read-only field. Applicable to + * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all + * VPAID. + */ + audioSampleRate?: number; + /** + * Exit event configured for the backup image. Applicable to the following + * creative types: all RICH_MEDIA. + */ + backupImageExit?: Schema$CreativeCustomEvent; + /** + * Detected bit-rate for audio or video asset. This is a read-only field. + * Applicable to the following creative types: INSTREAM_AUDIO, + * INSTREAM_VIDEO and all VPAID. + */ + bitRate?: number; + /** + * Rich media child asset type. This is a read-only field. Applicable to the + * following creative types: all VPAID. + */ + childAssetType?: string; + /** + * Size of an asset when collapsed. This is a read-only field. Applicable to + * the following creative types: all RICH_MEDIA and all VPAID. Additionally, + * applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or + * ASSET_DISPLAY_TYPE_PEEL_DOWN. + */ + collapsedSize?: Schema$Size; + /** + * List of companion creatives assigned to an in-stream video creative + * asset. Acceptable values include IDs of existing flash and image + * creatives. Applicable to INSTREAM_VIDEO creative type with + * dynamicAssetSelection set to true. + */ + companionCreativeIds?: string[]; + /** + * Custom start time in seconds for making the asset visible. Applicable to + * the following creative types: all RICH_MEDIA. Value must be greater than + * or equal to 0. + */ + customStartTimeValue?: number; + /** + * List of feature dependencies for the creative asset that are detected by + * Campaign Manager. Feature dependencies are features that a browser must + * be able to support in order to render your HTML5 creative correctly. This + * is a read-only, auto-generated field. Applicable to the following + * creative types: HTML5_BANNER. Applicable to DISPLAY when the primary + * asset type is not HTML_IMAGE. + */ + detectedFeatures?: string[]; + /** + * Type of rich media asset. This is a read-only field. Applicable to the + * following creative types: all RICH_MEDIA. + */ + displayType?: string; + /** + * Duration in seconds for which an asset will be displayed. Applicable to + * the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and + * VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. + */ + duration?: number; + /** + * Duration type for which an asset will be displayed. Applicable to the + * following creative types: all RICH_MEDIA. + */ + durationType?: string; + /** + * Detected expanded dimension for video asset. This is a read-only field. + * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. + */ + expandedDimension?: Schema$Size; + /** + * File size associated with this creative asset. This is a read-only field. + * Applicable to all but the following creative types: all REDIRECT and + * TRACKING_TEXT. + */ + fileSize?: string; + /** + * Flash version of the asset. This is a read-only field. Applicable to the + * following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. + * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + */ + flashVersion?: number; + /** + * Video frame rate for video asset in frames per second. This is a + * read-only field. Applicable to the following creative types: + * INSTREAM_VIDEO and all VPAID. + */ + frameRate?: number; + /** + * Whether to hide Flash objects flag for an asset. Applicable to the + * following creative types: all RICH_MEDIA. + */ + hideFlashObjects?: boolean; + /** + * Whether to hide selection boxes flag for an asset. Applicable to the + * following creative types: all RICH_MEDIA. + */ + hideSelectionBoxes?: boolean; + /** + * Whether the asset is horizontally locked. This is a read-only field. + * Applicable to the following creative types: all RICH_MEDIA. + */ + horizontallyLocked?: boolean; + /** + * Numeric ID of this creative asset. This is a required field and should + * not be modified. Applicable to all but the following creative types: all + * REDIRECT and TRACKING_TEXT. + */ + id?: string; + /** + * Dimension value for the ID of the asset. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Detected duration for audio or video asset. This is a read-only field. + * Applicable to the following creative types: INSTREAM_AUDIO, + * INSTREAM_VIDEO and all VPAID. + */ + mediaDuration?: number; + /** + * Detected MIME type for audio or video asset. This is a read-only field. + * Applicable to the following creative types: INSTREAM_AUDIO, + * INSTREAM_VIDEO and all VPAID. + */ + mimeType?: string; + /** + * Offset position for an asset in collapsed mode. This is a read-only + * field. Applicable to the following creative types: all RICH_MEDIA and all + * VPAID. Additionally, only applicable to assets whose displayType is + * ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN. + */ + offset?: Schema$OffsetPosition; + /** + * Orientation of video asset. This is a read-only, auto-generated field. + */ + orientation?: string; + /** + * Whether the backup asset is original or changed by the user in Campaign + * Manager. Applicable to the following creative types: all RICH_MEDIA. + */ + originalBackup?: boolean; + /** + * Whether this asset is used as a polite load asset. + */ + politeLoad?: boolean; + /** + * Offset position for an asset. Applicable to the following creative types: + * all RICH_MEDIA. + */ + position?: Schema$OffsetPosition; + /** + * Offset left unit for an asset. This is a read-only field. Applicable to + * the following creative types: all RICH_MEDIA. + */ + positionLeftUnit?: string; + /** + * Offset top unit for an asset. This is a read-only field if the asset + * displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following + * creative types: all RICH_MEDIA. + */ + positionTopUnit?: string; + /** + * Progressive URL for video asset. This is a read-only field. Applicable to + * the following creative types: INSTREAM_VIDEO and all VPAID. + */ + progressiveServingUrl?: string; + /** + * Whether the asset pushes down other content. Applicable to the following + * creative types: all RICH_MEDIA. Additionally, only applicable when the + * asset offsets are 0, the collapsedSize.width matches size.width, and the + * collapsedSize.height is less than size.height. + */ + pushdown?: boolean; + /** + * Pushdown duration in seconds for an asset. Applicable to the following + * creative types: all RICH_MEDIA.Additionally, only applicable when the + * asset pushdown field is true, the offsets are 0, the collapsedSize.width + * matches size.width, and the collapsedSize.height is less than + * size.height. Acceptable values are 0 to 9.99, inclusive. + */ + pushdownDuration?: number; + /** + * Role of the asset in relation to creative. Applicable to all but the + * following creative types: all REDIRECT and TRACKING_TEXT. This is a + * required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, + * IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple + * primary assets), and all VPAID creatives. BACKUP_IMAGE applies to + * FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. + * Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. + * ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. + * OTHER refers to assets from sources other than Campaign Manager, such as + * Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID + * creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign + * Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO + * creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign + * Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and + * VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign + * Manager representation of child asset videos from Studio, and is + * applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or + * removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, + * PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked + * active serve as backup in case the VPAID creative cannot be served. Only + * PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or + * VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by + * the user in Campaign Manager and is applicable to INSTREAM_AUDIO + * creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign + * Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO + * creatives. + */ + role?: string; + /** + * Size associated with this creative asset. This is a required field when + * applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, + * this field will be automatically set using the actual size of the + * associated image asset. Applicable to the following creative types: + * DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all + * RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not + * HTML_IMAGE. + */ + size?: Schema$Size; + /** + * Whether the asset is SSL-compliant. This is a read-only field. Applicable + * to all but the following creative types: all REDIRECT and TRACKING_TEXT. + */ + sslCompliant?: boolean; + /** + * Initial wait time type before making the asset visible. Applicable to the + * following creative types: all RICH_MEDIA. + */ + startTimeType?: string; + /** + * Streaming URL for video asset. This is a read-only field. Applicable to + * the following creative types: INSTREAM_VIDEO and all VPAID. + */ + streamingServingUrl?: string; + /** + * Whether the asset is transparent. Applicable to the following creative + * types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. + */ + transparency?: boolean; + /** + * Whether the asset is vertically locked. This is a read-only field. + * Applicable to the following creative types: all RICH_MEDIA. + */ + verticallyLocked?: boolean; + /** + * Window mode options for flash assets. Applicable to the following + * creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, + * RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and + * RICH_MEDIA_INPAGE_FLOATING. + */ + windowMode?: string; + /** + * zIndex value of an asset. Applicable to the following creative types: all + * RICH_MEDIA.Additionally, only applicable to assets whose displayType is + * NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or + * ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to + * 999999999, inclusive. + */ + zIndex?: number; + /** + * File name of zip file. This is a read-only field. Applicable to the + * following creative types: HTML5_BANNER. + */ + zipFilename?: string; + /** + * Size of zip file. This is a read-only field. Applicable to the following + * creative types: HTML5_BANNER. + */ + zipFilesize?: string; + } + /** + * Creative Asset ID. + */ + export interface Schema$CreativeAssetId { + /** + * Name of the creative asset. This is a required field while inserting an + * asset. After insertion, this assetIdentifier is used to identify the + * uploaded asset. Characters in the name must be alphanumeric or one of the + * following: ".-_ ". Spaces are allowed. + */ + name?: string; + /** + * Type of asset to upload. This is a required field. FLASH and IMAGE are no + * longer supported for new uploads. All image assets should use HTML_IMAGE. + */ + type?: string; + } + /** + * CreativeAssets contains properties of a creative asset file which will be + * uploaded or has already been uploaded. Refer to the creative sample code + * for how to upload assets and insert a creative. + */ + export interface Schema$CreativeAssetMetadata { + /** + * ID of the creative asset. This is a required field. + */ + assetIdentifier?: Schema$CreativeAssetId; + /** + * List of detected click tags for assets. This is a read-only + * auto-generated field. + */ + clickTags?: Schema$ClickTag[]; + /** + * List of feature dependencies for the creative asset that are detected by + * Campaign Manager. Feature dependencies are features that a browser must + * be able to support in order to render your HTML5 creative correctly. This + * is a read-only, auto-generated field. + */ + detectedFeatures?: string[]; + /** + * Numeric ID of the asset. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Dimension value for the numeric ID of the asset. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativeAssetMetadata". + */ + kind?: string; + /** + * Rules validated during code generation that generated a warning. This is + * a read-only, auto-generated field. Possible values are: - + * "ADMOB_REFERENCED" - "ASSET_FORMAT_UNSUPPORTED_DCM" - + * "ASSET_INVALID" - "CLICK_TAG_HARD_CODED" - + * "CLICK_TAG_INVALID" - "CLICK_TAG_IN_GWD" - + * "CLICK_TAG_MISSING" - "CLICK_TAG_MORE_THAN_ONE" - + * "CLICK_TAG_NON_TOP_LEVEL" - + * "COMPONENT_UNSUPPORTED_DCM" - + * "ENABLER_UNSUPPORTED_METHOD_DCM" - + * "EXTERNAL_FILE_REFERENCED" - "FILE_DETAIL_EMPTY" - + * "FILE_TYPE_INVALID" - "GWD_PROPERTIES_INVALID" - + * "HTML5_FEATURE_UNSUPPORTED" - "LINKED_FILE_NOT_FOUND" + * - "MAX_FLASH_VERSION_11" - "MRAID_REFERENCED" - + * "NOT_SSL_COMPLIANT" - "ORPHANED_ASSET" - + * "PRIMARY_HTML_MISSING" - "SVG_INVALID" - + * "ZIP_INVALID" + */ + warnedValidationRules?: string[]; + } + /** + * Encapsulates the list of rules for asset selection and a default asset in + * case none of the rules match. Applicable to INSTREAM_VIDEO creatives. + */ + export interface Schema$CreativeAssetSelection { + /** + * A creativeAssets[].id. This should refer to one of the parent assets in + * this creative, and will be served if none of the rules match. This is a + * required field. + */ + defaultAssetId?: string; + /** + * Rules determine which asset will be served to a viewer. Rules will be + * evaluated in the order in which they are stored in this list. This list + * must contain at least one rule. Applicable to INSTREAM_VIDEO creatives. + */ + rules?: Schema$Rule[]; + } + /** + * Creative Assignment. + */ + export interface Schema$CreativeAssignment { + /** + * Whether this creative assignment is active. When true, the creative will + * be included in the ad's rotation. + */ + active?: boolean; + /** + * Whether applicable event tags should fire when this creative assignment + * is rendered. If this value is unset when the ad is inserted or updated, + * it will default to true for all creative types EXCEPT for + * INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. + */ + applyEventTags?: boolean; + /** + * Click-through URL of the creative assignment. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Companion creative overrides for this creative assignment. Applicable to + * video ads. + */ + companionCreativeOverrides?: Schema$CompanionClickThroughOverride[]; + /** + * Creative group assignments for this creative assignment. Only one + * assignment per creative group number is allowed for a maximum of two + * assignments. + */ + creativeGroupAssignments?: Schema$CreativeGroupAssignment[]; + /** + * ID of the creative to be assigned. This is a required field. + */ + creativeId?: string; + /** + * Dimension value for the ID of the creative. This is a read-only, + * auto-generated field. + */ + creativeIdDimensionValue?: Schema$DimensionValue; + /** + * Date and time that the assigned creative should stop serving. Must be + * later than the start time. + */ + endTime?: string; + /** + * Rich media exit overrides for this creative assignment. Applicable when + * the creative type is any of the following: - DISPLAY - RICH_MEDIA_INPAGE + * - RICH_MEDIA_INPAGE_FLOATING - RICH_MEDIA_IM_EXPAND - + * RICH_MEDIA_EXPANDING - RICH_MEDIA_INTERSTITIAL_FLOAT - + * RICH_MEDIA_MOBILE_IN_APP - RICH_MEDIA_MULTI_FLOATING - + * RICH_MEDIA_PEEL_DOWN - VPAID_LINEAR - VPAID_NON_LINEAR + */ + richMediaExitOverrides?: Schema$RichMediaExitOverride[]; + /** + * Sequence number of the creative assignment, applicable when the rotation + * type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Acceptable values are 1 to + * 65535, inclusive. + */ + sequence?: number; + /** + * Whether the creative to be assigned is SSL-compliant. This is a read-only + * field that is auto-generated when the ad is inserted or updated. + */ + sslCompliant?: boolean; + /** + * Date and time that the assigned creative should start serving. + */ + startTime?: string; + /** + * Weight of the creative assignment, applicable when the rotation type is + * CREATIVE_ROTATION_TYPE_RANDOM. Value must be greater than or equal to 1. + */ + weight?: number; + } + /** + * Click-through URL + */ + export interface Schema$CreativeClickThroughUrl { + /** + * Read-only convenience field representing the actual URL that will be used + * for this click-through. The URL is computed as follows: - If + * landingPageId is specified then that landing page's URL is assigned + * to this field. - Otherwise, the customClickThroughUrl is assigned to this + * field. + */ + computedClickThroughUrl?: string; + /** + * Custom click-through URL. Applicable if the landingPageId field is left + * unset. + */ + customClickThroughUrl?: string; + /** + * ID of the landing page for the click-through URL. + */ + landingPageId?: string; + } + /** + * Creative Custom Event. + */ + export interface Schema$CreativeCustomEvent { + /** + * Unique ID of this event used by Reporting and Data Transfer. This is a + * read-only field. + */ + advertiserCustomEventId?: string; + /** + * User-entered name for the event. + */ + advertiserCustomEventName?: string; + /** + * Type of the event. This is a read-only field. + */ + advertiserCustomEventType?: string; + /** + * Artwork label column, used to link events in Campaign Manager back to + * events in Studio. This is a required field and should not be modified + * after insertion. + */ + artworkLabel?: string; + /** + * Artwork type used by the creative.This is a read-only field. + */ + artworkType?: string; + /** + * Exit click-through URL for the event. This field is used only for exit + * events. + */ + exitClickThroughUrl?: Schema$CreativeClickThroughUrl; + /** + * ID of this event. This is a required field and should not be modified + * after insertion. + */ + id?: string; + /** + * Properties for rich media popup windows. This field is used only for exit + * events. + */ + popupWindowProperties?: Schema$PopupWindowProperties; + /** + * Target type used by the event. + */ + targetType?: string; + /** + * Video reporting ID, used to differentiate multiple videos in a single + * creative. This is a read-only field. + */ + videoReportingId?: string; + } + /** + * Contains properties of a creative field. + */ + export interface Schema$CreativeField { + /** + * Account ID of this creative field. This is a read-only field that can be + * left blank. + */ + accountId?: string; + /** + * Advertiser ID of this creative field. This is a required field on + * insertion. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this creative field. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativeField". + */ + kind?: string; + /** + * Name of this creative field. This is a required field and must be less + * than 256 characters long and unique among creative fields of the same + * advertiser. + */ + name?: string; + /** + * Subaccount ID of this creative field. This is a read-only field that can + * be left blank. + */ + subaccountId?: string; + } + /** + * Creative Field Assignment. + */ + export interface Schema$CreativeFieldAssignment { + /** + * ID of the creative field. + */ + creativeFieldId?: string; + /** + * ID of the creative field value. + */ + creativeFieldValueId?: string; + } + /** + * Creative Field List Response + */ + export interface Schema$CreativeFieldsListResponse { + /** + * Creative field collection. + */ + creativeFields?: Schema$CreativeField[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativeFieldsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Contains properties of a creative field value. + */ + export interface Schema$CreativeFieldValue { + /** + * ID of this creative field value. This is a read-only, auto-generated + * field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativeFieldValue". + */ + kind?: string; + /** + * Value of this creative field value. It needs to be less than 256 + * characters in length and unique per creative field. + */ + value?: string; + } + /** + * Creative Field Value List Response + */ + export interface Schema$CreativeFieldValuesListResponse { + /** + * Creative field value collection. + */ + creativeFieldValues?: Schema$CreativeFieldValue[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativeFieldValuesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Contains properties of a creative group. + */ + export interface Schema$CreativeGroup { + /** + * Account ID of this creative group. This is a read-only field that can be + * left blank. + */ + accountId?: string; + /** + * Advertiser ID of this creative group. This is a required field on + * insertion. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Subgroup of the creative group. Assign your creative groups to a subgroup + * in order to filter or manage them more easily. This field is required on + * insertion and is read-only after insertion. Acceptable values are 1 to 2, + * inclusive. + */ + groupNumber?: number; + /** + * ID of this creative group. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativeGroup". + */ + kind?: string; + /** + * Name of this creative group. This is a required field and must be less + * than 256 characters long and unique among creative groups of the same + * advertiser. + */ + name?: string; + /** + * Subaccount ID of this creative group. This is a read-only field that can + * be left blank. + */ + subaccountId?: string; + } + /** + * Creative Group Assignment. + */ + export interface Schema$CreativeGroupAssignment { + /** + * ID of the creative group to be assigned. + */ + creativeGroupId?: string; + /** + * Creative group number of the creative group assignment. + */ + creativeGroupNumber?: string; + } + /** + * Creative Group List Response + */ + export interface Schema$CreativeGroupsListResponse { + /** + * Creative group collection. + */ + creativeGroups?: Schema$CreativeGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativeGroupsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Creative optimization settings. + */ + export interface Schema$CreativeOptimizationConfiguration { + /** + * ID of this creative optimization config. This field is auto-generated + * when the campaign is inserted or updated. It can be null for existing + * campaigns. + */ + id?: string; + /** + * Name of this creative optimization config. This is a required field and + * must be less than 129 characters long. + */ + name?: string; + /** + * List of optimization activities associated with this configuration. + */ + optimizationActivitys?: Schema$OptimizationActivity[]; + /** + * Optimization model for this configuration. + */ + optimizationModel?: string; + } + /** + * Creative Rotation. + */ + export interface Schema$CreativeRotation { + /** + * Creative assignments in this creative rotation. + */ + creativeAssignments?: Schema$CreativeAssignment[]; + /** + * Creative optimization configuration that is used by this ad. It should + * refer to one of the existing optimization configurations in the ad's + * campaign. If it is unset or set to 0, then the campaign's default + * optimization configuration will be used for this ad. + */ + creativeOptimizationConfigurationId?: string; + /** + * Type of creative rotation. Can be used to specify whether to use + * sequential or random rotation. + */ + type?: string; + /** + * Strategy for calculating weights. Used with + * CREATIVE_ROTATION_TYPE_RANDOM. + */ + weightCalculationStrategy?: string; + } + /** + * Creative List Response + */ + export interface Schema$CreativesListResponse { + /** + * Creative collection. + */ + creatives?: Schema$Creative[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#creativesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Represents fields that are compatible to be selected for a report of type + * "CROSS_DIMENSION_REACH". + */ + export interface Schema$CrossDimensionReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the + * "breakdown" section of the report. + */ + breakdown?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the + * "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case + * dfareporting#crossDimensionReachReportCompatibleFields. + */ + kind?: string; + /** + * Metrics which are compatible to be selected in the + * "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected in the + * "overlapMetricNames" section of the report. + */ + overlapMetrics?: Schema$Metric[]; + } + /** + * A custom floodlight variable. + */ + export interface Schema$CustomFloodlightVariable { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#customFloodlightVariable". + */ + kind?: string; + /** + * The type of custom floodlight variable to supply a value for. These map + * to the "u[1-20]=" in the tags. + */ + type?: string; + /** + * The value of the custom floodlight variable. The length of string must + * not exceed 50 characters. + */ + value?: string; + } + /** + * Represents a Custom Rich Media Events group. + */ + export interface Schema$CustomRichMediaEvents { + /** + * List of custom rich media event IDs. Dimension values must be all of type + * dfa:richMediaEventTypeIdAndName. + */ + filteredEventIds?: Schema$DimensionValue[]; + /** + * The kind of resource this is, in this case + * dfareporting#customRichMediaEvents. + */ + kind?: string; + } + /** + * Custom Viewability Metric + */ + export interface Schema$CustomViewabilityMetric { + /** + * Configuration of the custom viewability metric. + */ + configuration?: Schema$CustomViewabilityMetricConfiguration; + /** + * ID of the custom viewability metric. + */ + id?: string; + /** + * Name of the custom viewability metric. + */ + name?: string; + } + /** + * The attributes, like playtime and percent onscreen, that define the Custom + * Viewability Metric. + */ + export interface Schema$CustomViewabilityMetricConfiguration { + /** + * Whether the video must be audible to count an impression. + */ + audible?: boolean; + /** + * The time in milliseconds the video must play for the Custom Viewability + * Metric to count an impression. If both this and timePercent are + * specified, the earlier of the two will be used. + */ + timeMillis?: number; + /** + * The percentage of video that must play for the Custom Viewability Metric + * to count an impression. If both this and timeMillis are specified, the + * earlier of the two will be used. + */ + timePercent?: number; + /** + * The percentage of video that must be on screen for the Custom Viewability + * Metric to count an impression. + */ + viewabilityPercent?: number; + } + /** + * Represents a date range. + */ + export interface Schema$DateRange { + /** + * The end date of the date range, inclusive. A string of the format: + * "yyyy-MM-dd". + */ + endDate?: string; + /** + * The kind of resource this is, in this case dfareporting#dateRange. + */ + kind?: string; + /** + * The date range relative to the date of when the report is run. + */ + relativeDateRange?: string; + /** + * The start date of the date range, inclusive. A string of the format: + * "yyyy-MM-dd". + */ + startDate?: string; + } + /** + * Day Part Targeting. + */ + export interface Schema$DayPartTargeting { + /** + * Days of the week when the ad will serve. Acceptable values are: - + * "SUNDAY" - "MONDAY" - "TUESDAY" - + * "WEDNESDAY" - "THURSDAY" - "FRIDAY" - + * "SATURDAY" + */ + daysOfWeek?: string[]; + /** + * Hours of the day when the ad will serve, where 0 is midnight to 1 AM and + * 23 is 11 PM to midnight. Can be specified with days of week, in which + * case the ad would serve during these hours on the specified days. For + * example if Monday, Wednesday, Friday are the days of week specified and + * 9-10am, 3-5pm (hours 9, 15, and 16) is specified, the ad would serve + * Monday, Wednesdays, and Fridays at 9-10am and 3-5pm. Acceptable values + * are 0 to 23, inclusive. + */ + hoursOfDay?: number[]; + /** + * Whether or not to use the user's local time. If false, the + * America/New York time zone applies. + */ + userLocalTime?: boolean; + } + /** + * Contains information about a landing page deep link. + */ + export interface Schema$DeepLink { + /** + * The URL of the mobile app being linked to. + */ + appUrl?: string; + /** + * The fallback URL. This URL will be served to users who do not have the + * mobile app installed. + */ + fallbackUrl?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#deepLink". + */ + kind?: string; + /** + * The mobile app targeted by this deep link. + */ + mobileApp?: Schema$MobileApp; + /** + * Ads served to users on these remarketing lists will use this deep link. + * Applicable when mobileApp.directory is APPLE_APP_STORE. + */ + remarketingListIds?: string[]; + } + /** + * Properties of inheriting and overriding the default click-through event + * tag. A campaign may override the event tag defined at the advertiser level, + * and an ad may also override the campaign's setting further. + */ + export interface Schema$DefaultClickThroughEventTagProperties { + /** + * ID of the click-through event tag to apply to all ads in this + * entity's scope. + */ + defaultClickThroughEventTagId?: string; + /** + * Whether this entity should override the inherited default click-through + * event tag with its own defined value. + */ + overrideInheritedEventTag?: boolean; + } + /** + * Delivery Schedule. + */ + export interface Schema$DeliverySchedule { + /** + * Limit on the number of times an individual user can be served the ad + * within a specified period of time. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Whether or not hard cutoff is enabled. If true, the ad will not serve + * after the end date and time. Otherwise the ad will continue to be served + * until it has reached its delivery goals. + */ + hardCutoff?: boolean; + /** + * Impression ratio for this ad. This ratio determines how often each ad is + * served relative to the others. For example, if ad A has an impression + * ratio of 1 and ad B has an impression ratio of 3, then Campaign Manager + * will serve ad B three times as often as ad A. Acceptable values are 1 to + * 10, inclusive. + */ + impressionRatio?: string; + /** + * Serving priority of an ad, with respect to other ads. The lower the + * priority number, the greater the priority with which it is served. + */ + priority?: string; + } + /** + * Google Ad Manager Settings + */ + export interface Schema$DfpSettings { + /** + * Ad Manager network code for this directory site. + */ + dfpNetworkCode?: string; + /** + * Ad Manager network name for this directory site. + */ + dfpNetworkName?: string; + /** + * Whether this directory site accepts programmatic placements. + */ + programmaticPlacementAccepted?: boolean; + /** + * Whether this directory site is available only via Publisher Portal. + */ + publisherPortalOnly?: boolean; + /** + * Whether this directory site accepts publisher-paid tags. + */ + pubPaidPlacementAccepted?: boolean; + } + /** + * Represents a dimension. + */ + export interface Schema$Dimension { + /** + * The kind of resource this is, in this case dfareporting#dimension. + */ + kind?: string; + /** + * The dimension name, e.g. dfa:advertiser + */ + name?: string; + } + /** + * Represents a dimension filter. + */ + export interface Schema$DimensionFilter { + /** + * The name of the dimension to filter. + */ + dimensionName?: string; + /** + * The kind of resource this is, in this case dfareporting#dimensionFilter. + */ + kind?: string; + /** + * The value of the dimension to filter. + */ + value?: string; + } + /** + * Represents a DimensionValue resource. + */ + export interface Schema$DimensionValue { + /** + * The name of the dimension. + */ + dimensionName?: string; + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The ID associated with the value if available. + */ + id?: string; + /** + * The kind of resource this is, in this case dfareporting#dimensionValue. + */ + kind?: string; + /** + * Determines how the 'value' field is matched when filtering. If + * not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, + * '*' is allowed as a placeholder for variable length character + * sequences, and it can be escaped with a backslash. Note, only paid search + * dimensions ('dfa:paidSearch*') allow a matchType other than + * EXACT. + */ + matchType?: string; + /** + * The value of the dimension. + */ + value?: string; + } + /** + * Represents the list of DimensionValue resources. + */ + export interface Schema$DimensionValueList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The dimension values returned in this response. + */ + items?: Schema$DimensionValue[]; + /** + * The kind of list this is, in this case dfareporting#dimensionValueList. + */ + kind?: string; + /** + * Continuation token used to page through dimension values. To retrieve the + * next page of results, set the next request's "pageToken" to + * the value of this field. The page token is only valid for a limited + * amount of time and should not be persisted. + */ + nextPageToken?: string; + } + /** + * Represents a DimensionValuesRequest. + */ + export interface Schema$DimensionValueRequest { + /** + * The name of the dimension for which values should be requested. + */ + dimensionName?: string; + /** + * The end date of the date range for which to retrieve dimension values. A + * string of the format "yyyy-MM-dd". + */ + endDate?: string; + /** + * The list of filters by which to filter values. The filters are ANDed. + */ + filters?: Schema$DimensionFilter[]; + /** + * The kind of request this is, in this case + * dfareporting#dimensionValueRequest. + */ + kind?: string; + /** + * The start date of the date range for which to retrieve dimension values. + * A string of the format "yyyy-MM-dd". + */ + startDate?: string; + } + /** + * DirectorySites contains properties of a website from the Site Directory. + * Sites need to be added to an account via the Sites resource before they can + * be assigned to a placement. + */ + export interface Schema$DirectorySite { + /** + * Whether this directory site is active. + */ + active?: boolean; + /** + * ID of this directory site. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Dimension value for the ID of this directory site. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Tag types for regular placements. Acceptable values are: - + * "STANDARD" - "IFRAME_JAVASCRIPT_INPAGE" - + * "INTERNAL_REDIRECT_INPAGE" - "JAVASCRIPT_INPAGE" + */ + inpageTagFormats?: string[]; + /** + * Tag types for interstitial placements. Acceptable values are: - + * "IFRAME_JAVASCRIPT_INTERSTITIAL" - + * "INTERNAL_REDIRECT_INTERSTITIAL" - + * "JAVASCRIPT_INTERSTITIAL" + */ + interstitialTagFormats?: string[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#directorySite". + */ + kind?: string; + /** + * Name of this directory site. + */ + name?: string; + /** + * Directory site settings. + */ + settings?: Schema$DirectorySiteSettings; + /** + * URL of this directory site. + */ + url?: string; + } + /** + * Directory Site Settings + */ + export interface Schema$DirectorySiteSettings { + /** + * Whether this directory site has disabled active view creatives. + */ + activeViewOptOut?: boolean; + /** + * Directory site Ad Manager settings. + */ + dfpSettings?: Schema$DfpSettings; + /** + * Whether this site accepts in-stream video ads. + */ + instreamVideoPlacementAccepted?: boolean; + /** + * Whether this site accepts interstitial ads. + */ + interstitialPlacementAccepted?: boolean; + } + /** + * Directory Site List Response + */ + export interface Schema$DirectorySitesListResponse { + /** + * Directory site collection. + */ + directorySites?: Schema$DirectorySite[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#directorySitesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Contains properties of a dynamic targeting key. Dynamic targeting keys are + * unique, user-friendly labels, created at the advertiser level in DCM, that + * can be assigned to ads, creatives, and placements and used for targeting + * with Studio dynamic creatives. Use these labels instead of numeric Campaign + * Manager IDs (such as placement IDs) to save time and avoid errors in your + * dynamic feeds. + */ + export interface Schema$DynamicTargetingKey { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#dynamicTargetingKey". + */ + kind?: string; + /** + * Name of this dynamic targeting key. This is a required field. Must be + * less than 256 characters long and cannot contain commas. All characters + * are converted to lowercase. + */ + name?: string; + /** + * ID of the object of this dynamic targeting key. This is a required field. + */ + objectId?: string; + /** + * Type of the object of this dynamic targeting key. This is a required + * field. + */ + objectType?: string; + } + /** + * Dynamic Targeting Key List Response + */ + export interface Schema$DynamicTargetingKeysListResponse { + /** + * Dynamic targeting key collection. + */ + dynamicTargetingKeys?: Schema$DynamicTargetingKey[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#dynamicTargetingKeysListResponse". + */ + kind?: string; + } + /** + * A description of how user IDs are encrypted. + */ + export interface Schema$EncryptionInfo { + /** + * The encryption entity ID. This should match the encryption configuration + * for ad serving or Data Transfer. + */ + encryptionEntityId?: string; + /** + * The encryption entity type. This should match the encryption + * configuration for ad serving or Data Transfer. + */ + encryptionEntityType?: string; + /** + * Describes whether the encrypted cookie was received from ad serving (the + * %m macro) or from Data Transfer. + */ + encryptionSource?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#encryptionInfo". + */ + kind?: string; + } + /** + * Contains properties of an event tag. + */ + export interface Schema$EventTag { + /** + * Account ID of this event tag. This is a read-only field that can be left + * blank. + */ + accountId?: string; + /** + * Advertiser ID of this event tag. This field or the campaignId field is + * required on insertion. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Campaign ID of this event tag. This field or the advertiserId field is + * required on insertion. + */ + campaignId?: string; + /** + * Dimension value for the ID of the campaign. This is a read-only, + * auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this event tag should be automatically enabled for all of the + * advertiser's campaigns and ads. + */ + enabledByDefault?: boolean; + /** + * Whether to remove this event tag from ads that are trafficked through + * Display & Video 360 to Ad Exchange. This may be useful if the event + * tag uses a pixel that is unapproved for Ad Exchange bids on one or more + * networks, such as the Google Display Network. + */ + excludeFromAdxRequests?: boolean; + /** + * ID of this event tag. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#eventTag". + */ + kind?: string; + /** + * Name of this event tag. This is a required field and must be less than + * 256 characters long. + */ + name?: string; + /** + * Site filter type for this event tag. If no type is specified then the + * event tag will be applied to all sites. + */ + siteFilterType?: string; + /** + * Filter list of site IDs associated with this event tag. The + * siteFilterType determines whether this is a whitelist or blacklist + * filter. + */ + siteIds?: string[]; + /** + * Whether this tag is SSL-compliant or not. This is a read-only field. + */ + sslCompliant?: boolean; + /** + * Status of this event tag. Must be ENABLED for this event tag to fire. + * This is a required field. + */ + status?: string; + /** + * Subaccount ID of this event tag. This is a read-only field that can be + * left blank. + */ + subaccountId?: string; + /** + * Event tag type. Can be used to specify whether to use a third-party + * pixel, a third-party JavaScript URL, or a third-party click-through URL + * for either impression or click tracking. This is a required field. + */ + type?: string; + /** + * Payload URL for this event tag. The URL on a click-through event tag + * should have a landing page URL appended to the end of it. This field is + * required on insertion. + */ + url?: string; + /** + * Number of times the landing page URL should be URL-escaped before being + * appended to the click-through event tag URL. Only applies to + * click-through event tags as specified by the event tag type. + */ + urlEscapeLevels?: number; + } + /** + * Event tag override information. + */ + export interface Schema$EventTagOverride { + /** + * Whether this override is enabled. + */ + enabled?: boolean; + /** + * ID of this event tag override. This is a read-only, auto-generated field. + */ + id?: string; + } + /** + * Event Tag List Response + */ + export interface Schema$EventTagsListResponse { + /** + * Event tag collection. + */ + eventTags?: Schema$EventTag[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#eventTagsListResponse". + */ + kind?: string; + } + /** + * Represents a File resource. A file contains the metadata for a report run. + * It shows the status of the run and holds the URLs to the generated report + * data if the run is finished and the status is "REPORT_AVAILABLE". + */ + export interface Schema$File { + /** + * The date range for which the file has report data. The date range will + * always be the absolute date range for which the report is run. + */ + dateRange?: Schema$DateRange; + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The filename of the file. + */ + fileName?: string; + /** + * The output format of the report. Only available once the file is + * available. + */ + format?: string; + /** + * The unique ID of this report file. + */ + id?: string; + /** + * The kind of resource this is, in this case dfareporting#file. + */ + kind?: string; + /** + * The timestamp in milliseconds since epoch when this file was last + * modified. + */ + lastModifiedTime?: string; + /** + * The ID of the report this file was generated from. + */ + reportId?: string; + /** + * The status of the report file. + */ + status?: string; + /** + * The URLs where the completed report file can be downloaded. + */ + urls?: {apiUrl?: string; browserUrl?: string;}; + } + /** + * Represents the list of File resources. + */ + export interface Schema$FileList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The files returned in this response. + */ + items?: Schema$File[]; + /** + * The kind of list this is, in this case dfareporting#fileList. + */ + kind?: string; + /** + * Continuation token used to page through files. To retrieve the next page + * of results, set the next request's "pageToken" to the value + * of this field. The page token is only valid for a limited amount of time + * and should not be persisted. + */ + nextPageToken?: string; + } + /** + * Flight + */ + export interface Schema$Flight { + /** + * Inventory item flight end date. + */ + endDate?: string; + /** + * Rate or cost of this flight. + */ + rateOrCost?: string; + /** + * Inventory item flight start date. + */ + startDate?: string; + /** + * Units of this flight. + */ + units?: string; + } + /** + * Floodlight Activity GenerateTag Response + */ + export interface Schema$FloodlightActivitiesGenerateTagResponse { + /** + * Generated tag for this Floodlight activity. For global site tags, this is + * the event snippet. + */ + floodlightActivityTag?: string; + /** + * The global snippet section of a global site tag. The global site tag sets + * new cookies on your domain, which will store a unique identifier for a + * user or the ad click that brought the user to your site. Learn more. + */ + globalSiteTagGlobalSnippet?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#floodlightActivitiesGenerateTagResponse". + */ + kind?: string; + } + /** + * Floodlight Activity List Response + */ + export interface Schema$FloodlightActivitiesListResponse { + /** + * Floodlight activity collection. + */ + floodlightActivities?: Schema$FloodlightActivity[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#floodlightActivitiesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Contains properties of a Floodlight activity. + */ + export interface Schema$FloodlightActivity { + /** + * Account ID of this floodlight activity. This is a read-only field that + * can be left blank. + */ + accountId?: string; + /** + * Advertiser ID of this floodlight activity. If this field is left blank, + * the value will be copied over either from the activity group's + * advertiser or the existing activity's advertiser. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Code type used for cache busting in the generated tag. Applicable only + * when floodlightActivityGroupType is COUNTER and countingMethod is + * STANDARD_COUNTING or UNIQUE_COUNTING. + */ + cacheBustingType?: string; + /** + * Counting method for conversions for this floodlight activity. This is a + * required field. + */ + countingMethod?: string; + /** + * Dynamic floodlight tags. + */ + defaultTags?: Schema$FloodlightActivityDynamicTag[]; + /** + * URL where this tag will be deployed. If specified, must be less than 256 + * characters long. + */ + expectedUrl?: string; + /** + * Floodlight activity group ID of this floodlight activity. This is a + * required field. + */ + floodlightActivityGroupId?: string; + /** + * Name of the associated floodlight activity group. This is a read-only + * field. + */ + floodlightActivityGroupName?: string; + /** + * Tag string of the associated floodlight activity group. This is a + * read-only field. + */ + floodlightActivityGroupTagString?: string; + /** + * Type of the associated floodlight activity group. This is a read-only + * field. + */ + floodlightActivityGroupType?: string; + /** + * Floodlight configuration ID of this floodlight activity. If this field is + * left blank, the value will be copied over either from the activity + * group's floodlight configuration or from the existing activity's + * floodlight configuration. + */ + floodlightConfigurationId?: string; + /** + * Dimension value for the ID of the floodlight configuration. This is a + * read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * The type of Floodlight tag this activity will generate. This is a + * required field. + */ + floodlightTagType?: string; + /** + * Whether this activity is archived. + */ + hidden?: boolean; + /** + * ID of this floodlight activity. This is a read-only, auto-generated + * field. + */ + id?: string; + /** + * Dimension value for the ID of this floodlight activity. This is a + * read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#floodlightActivity". + */ + kind?: string; + /** + * Name of this floodlight activity. This is a required field. Must be less + * than 129 characters long and cannot contain quotes. + */ + name?: string; + /** + * General notes or implementation instructions for the tag. + */ + notes?: string; + /** + * Publisher dynamic floodlight tags. + */ + publisherTags?: Schema$FloodlightActivityPublisherDynamicTag[]; + /** + * Whether this tag should use SSL. + */ + secure?: boolean; + /** + * Whether the floodlight activity is SSL-compliant. This is a read-only + * field, its value detected by the system from the floodlight tags. + */ + sslCompliant?: boolean; + /** + * Whether this floodlight activity must be SSL-compliant. + */ + sslRequired?: boolean; + /** + * Subaccount ID of this floodlight activity. This is a read-only field that + * can be left blank. + */ + subaccountId?: string; + /** + * Tag format type for the floodlight activity. If left blank, the tag + * format will default to HTML. + */ + tagFormat?: string; + /** + * Value of the cat= parameter in the floodlight tag, which the ad servers + * use to identify the activity. This is optional: if empty, a new tag + * string will be generated for you. This string must be 1 to 8 characters + * long, with valid characters being [a-z][A-Z][0-9][-][ _ ]. This tag + * string must also be unique among activities of the same activity group. + * This field is read-only after insertion. + */ + tagString?: string; + /** + * List of the user-defined variables used by this conversion tag. These map + * to the "u[1-100]=" in the tags. Each of these can have a user + * defined type. Acceptable values are U1 to U100, inclusive. + */ + userDefinedVariableTypes?: string[]; + } + /** + * Dynamic Tag + */ + export interface Schema$FloodlightActivityDynamicTag { + /** + * ID of this dynamic tag. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Name of this tag. + */ + name?: string; + /** + * Tag code. + */ + tag?: string; + } + /** + * Contains properties of a Floodlight activity group. + */ + export interface Schema$FloodlightActivityGroup { + /** + * Account ID of this floodlight activity group. This is a read-only field + * that can be left blank. + */ + accountId?: string; + /** + * Advertiser ID of this floodlight activity group. If this field is left + * blank, the value will be copied over either from the floodlight + * configuration's advertiser or from the existing activity group's + * advertiser. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Floodlight configuration ID of this floodlight activity group. This is a + * required field. + */ + floodlightConfigurationId?: string; + /** + * Dimension value for the ID of the floodlight configuration. This is a + * read-only, auto-generated field. + */ + floodlightConfigurationIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this floodlight activity group. This is a read-only, auto-generated + * field. + */ + id?: string; + /** + * Dimension value for the ID of this floodlight activity group. This is a + * read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#floodlightActivityGroup". + */ + kind?: string; + /** + * Name of this floodlight activity group. This is a required field. Must be + * less than 65 characters long and cannot contain quotes. + */ + name?: string; + /** + * Subaccount ID of this floodlight activity group. This is a read-only + * field that can be left blank. + */ + subaccountId?: string; + /** + * Value of the type= parameter in the floodlight tag, which the ad servers + * use to identify the activity group that the activity belongs to. This is + * optional: if empty, a new tag string will be generated for you. This + * string must be 1 to 8 characters long, with valid characters being + * [a-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among + * activity groups of the same floodlight configuration. This field is + * read-only after insertion. + */ + tagString?: string; + /** + * Type of the floodlight activity group. This is a required field that is + * read-only after insertion. + */ + type?: string; + } + /** + * Floodlight Activity Group List Response + */ + export interface Schema$FloodlightActivityGroupsListResponse { + /** + * Floodlight activity group collection. + */ + floodlightActivityGroups?: Schema$FloodlightActivityGroup[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#floodlightActivityGroupsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Publisher Dynamic Tag + */ + export interface Schema$FloodlightActivityPublisherDynamicTag { + /** + * Whether this tag is applicable only for click-throughs. + */ + clickThrough?: boolean; + /** + * Directory site ID of this dynamic tag. This is a write-only field that + * can be used as an alternative to the siteId field. When this resource is + * retrieved, only the siteId field will be populated. + */ + directorySiteId?: string; + /** + * Dynamic floodlight tag. + */ + dynamicTag?: Schema$FloodlightActivityDynamicTag; + /** + * Site ID of this dynamic tag. + */ + siteId?: string; + /** + * Dimension value for the ID of the site. This is a read-only, + * auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this tag is applicable only for view-throughs. + */ + viewThrough?: boolean; + } + /** + * Contains properties of a Floodlight configuration. + */ + export interface Schema$FloodlightConfiguration { + /** + * Account ID of this floodlight configuration. This is a read-only field + * that can be left blank. + */ + accountId?: string; + /** + * Advertiser ID of the parent advertiser of this floodlight configuration. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether advertiser data is shared with Google Analytics. + */ + analyticsDataSharingEnabled?: boolean; + /** + * Custom Viewability metric for the floodlight configuration. + */ + customViewabilityMetric?: Schema$CustomViewabilityMetric; + /** + * Whether the exposure-to-conversion report is enabled. This report shows + * detailed pathway information on up to 10 of the most recent ad exposures + * seen by a user before converting. + */ + exposureToConversionEnabled?: boolean; + /** + * Day that will be counted as the first day of the week in reports. This is + * a required field. + */ + firstDayOfWeek?: string; + /** + * ID of this floodlight configuration. This is a read-only, auto-generated + * field. + */ + id?: string; + /** + * Dimension value for the ID of this floodlight configuration. This is a + * read-only, auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Whether in-app attribution tracking is enabled. + */ + inAppAttributionTrackingEnabled?: boolean; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#floodlightConfiguration". + */ + kind?: string; + /** + * Lookback window settings for this floodlight configuration. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Types of attribution options for natural search conversions. + */ + naturalSearchConversionAttributionOption?: string; + /** + * Settings for Campaign Manager Omniture integration. + */ + omnitureSettings?: Schema$OmnitureSettings; + /** + * Subaccount ID of this floodlight configuration. This is a read-only field + * that can be left blank. + */ + subaccountId?: string; + /** + * Configuration settings for dynamic and image floodlight tags. + */ + tagSettings?: Schema$TagSettings; + /** + * List of third-party authentication tokens enabled for this configuration. + */ + thirdPartyAuthenticationTokens?: Schema$ThirdPartyAuthenticationToken[]; + /** + * List of user defined variables enabled for this configuration. + */ + userDefinedVariableConfigurations?: + Schema$UserDefinedVariableConfiguration[]; + } + /** + * Floodlight Configuration List Response + */ + export interface Schema$FloodlightConfigurationsListResponse { + /** + * Floodlight configuration collection. + */ + floodlightConfigurations?: Schema$FloodlightConfiguration[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#floodlightConfigurationsListResponse". + */ + kind?: string; + } + /** + * Represents fields that are compatible to be selected for a report of type + * "FlOODLIGHT". + */ + export interface Schema$FloodlightReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the + * "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the + * "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case + * dfareporting#floodlightReportCompatibleFields. + */ + kind?: string; + /** + * Metrics which are compatible to be selected in the + * "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + } + /** + * Frequency Cap. + */ + export interface Schema$FrequencyCap { + /** + * Duration of time, in seconds, for this frequency cap. The maximum + * duration is 90 days. Acceptable values are 1 to 7776000, inclusive. + */ + duration?: string; + /** + * Number of times an individual user can be served the ad within the + * specified duration. Acceptable values are 1 to 15, inclusive. + */ + impressions?: string; + } + /** + * FsCommand. + */ + export interface Schema$FsCommand { + /** + * Distance from the left of the browser.Applicable when positionOption is + * DISTANCE_FROM_TOP_LEFT_CORNER. + */ + left?: number; + /** + * Position in the browser where the window will open. + */ + positionOption?: string; + /** + * Distance from the top of the browser. Applicable when positionOption is + * DISTANCE_FROM_TOP_LEFT_CORNER. + */ + top?: number; + /** + * Height of the window. + */ + windowHeight?: number; + /** + * Width of the window. + */ + windowWidth?: number; + } + /** + * Geographical Targeting. + */ + export interface Schema$GeoTargeting { + /** + * Cities to be targeted. For each city only dartId is required. The other + * fields are populated automatically when the ad is inserted or updated. If + * targeting a city, do not target or exclude the country of the city, and + * do not target the metro or region of the city. + */ + cities?: Schema$City[]; + /** + * Countries to be targeted or excluded from targeting, depending on the + * setting of the excludeCountries field. For each country only dartId is + * required. The other fields are populated automatically when the ad is + * inserted or updated. If targeting or excluding a country, do not target + * regions, cities, metros, or postal codes in the same country. + */ + countries?: Schema$Country[]; + /** + * Whether or not to exclude the countries in the countries field from + * targeting. If false, the countries field refers to countries which will + * be targeted by the ad. + */ + excludeCountries?: boolean; + /** + * Metros to be targeted. For each metro only dmaId is required. The other + * fields are populated automatically when the ad is inserted or updated. If + * targeting a metro, do not target or exclude the country of the metro. + */ + metros?: Schema$Metro[]; + /** + * Postal codes to be targeted. For each postal code only id is required. + * The other fields are populated automatically when the ad is inserted or + * updated. If targeting a postal code, do not target or exclude the country + * of the postal code. + */ + postalCodes?: Schema$PostalCode[]; + /** + * Regions to be targeted. For each region only dartId is required. The + * other fields are populated automatically when the ad is inserted or + * updated. If targeting a region, do not target or exclude the country of + * the region. + */ + regions?: Schema$Region[]; + } + /** + * Represents a buy from the Planning inventory store. + */ + export interface Schema$InventoryItem { + /** + * Account ID of this inventory item. + */ + accountId?: string; + /** + * Ad slots of this inventory item. If this inventory item represents a + * standalone placement, there will be exactly one ad slot. If this + * inventory item represents a placement group, there will be more than one + * ad slot, each representing one child placement in that placement group. + */ + adSlots?: Schema$AdSlot[]; + /** + * Advertiser ID of this inventory item. + */ + advertiserId?: string; + /** + * Content category ID of this inventory item. + */ + contentCategoryId?: string; + /** + * Estimated click-through rate of this inventory item. + */ + estimatedClickThroughRate?: string; + /** + * Estimated conversion rate of this inventory item. + */ + estimatedConversionRate?: string; + /** + * ID of this inventory item. + */ + id?: string; + /** + * Whether this inventory item is in plan. + */ + inPlan?: boolean; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#inventoryItem". + */ + kind?: string; + /** + * Information about the most recent modification of this inventory item. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this inventory item. For standalone inventory items, this is the + * same name as that of its only ad slot. For group inventory items, this + * can differ from the name of any of its ad slots. + */ + name?: string; + /** + * Negotiation channel ID of this inventory item. + */ + negotiationChannelId?: string; + /** + * Order ID of this inventory item. + */ + orderId?: string; + /** + * Placement strategy ID of this inventory item. + */ + placementStrategyId?: string; + /** + * Pricing of this inventory item. + */ + pricing?: Schema$Pricing; + /** + * Project ID of this inventory item. + */ + projectId?: string; + /** + * RFP ID of this inventory item. + */ + rfpId?: string; + /** + * ID of the site this inventory item is associated with. + */ + siteId?: string; + /** + * Subaccount ID of this inventory item. + */ + subaccountId?: string; + /** + * Type of inventory item. + */ + type?: string; + } + /** + * Inventory item List Response + */ + export interface Schema$InventoryItemsListResponse { + /** + * Inventory item collection + */ + inventoryItems?: Schema$InventoryItem[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#inventoryItemsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Key Value Targeting Expression. + */ + export interface Schema$KeyValueTargetingExpression { + /** + * Keyword expression being targeted by the ad. + */ + expression?: string; + } + /** + * Contains information about where a user's browser is taken after the + * user clicks an ad. + */ + export interface Schema$LandingPage { + /** + * Advertiser ID of this landing page. This is a required field. + */ + advertiserId?: string; + /** + * Whether this landing page has been archived. + */ + archived?: boolean; + /** + * Links that will direct the user to a mobile app, if installed. + */ + deepLinks?: Schema$DeepLink[]; + /** + * ID of this landing page. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#landingPage". + */ + kind?: string; + /** + * Name of this landing page. This is a required field. It must be less than + * 256 characters long. + */ + name?: string; + /** + * URL of this landing page. This is a required field. + */ + url?: string; + } + /** + * Contains information about a language that can be targeted by ads. + */ + export interface Schema$Language { + /** + * Language ID of this language. This is the ID used for targeting and + * generating reports. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#language". + */ + kind?: string; + /** + * Format of language code is an ISO 639 two-letter language code optionally + * followed by an underscore followed by an ISO 3166 code. Examples are + * "en" for English or "zh_CN" for Simplified Chinese. + */ + languageCode?: string; + /** + * Name of this language. + */ + name?: string; + } + /** + * Language List Response + */ + export interface Schema$LanguagesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#languagesListResponse". + */ + kind?: string; + /** + * Language collection. + */ + languages?: Schema$Language[]; + } + /** + * Language Targeting. + */ + export interface Schema$LanguageTargeting { + /** + * Languages that this ad targets. For each language only languageId is + * required. The other fields are populated automatically when the ad is + * inserted or updated. + */ + languages?: Schema$Language[]; + } + /** + * Modification timestamp. + */ + export interface Schema$LastModifiedInfo { + /** + * Timestamp of the last change in milliseconds since epoch. + */ + time?: string; + } + /** + * A group clause made up of list population terms representing constraints + * joined by ORs. + */ + export interface Schema$ListPopulationClause { + /** + * Terms of this list population clause. Each clause is made up of list + * population terms representing constraints and are joined by ORs. + */ + terms?: Schema$ListPopulationTerm[]; + } + /** + * Remarketing List Population Rule. + */ + export interface Schema$ListPopulationRule { + /** + * Floodlight activity ID associated with this rule. This field can be left + * blank. + */ + floodlightActivityId?: string; + /** + * Name of floodlight activity associated with this rule. This is a + * read-only, auto-generated field. + */ + floodlightActivityName?: string; + /** + * Clauses that make up this list population rule. Clauses are joined by + * ANDs, and the clauses themselves are made up of list population terms + * which are joined by ORs. + */ + listPopulationClauses?: Schema$ListPopulationClause[]; + } + /** + * Remarketing List Population Rule Term. + */ + export interface Schema$ListPopulationTerm { + /** + * Will be true if the term should check if the user is in the list and + * false if the term should check if the user is not in the list. This field + * is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by + * default. + */ + contains?: boolean; + /** + * Whether to negate the comparison result of this term during rule + * evaluation. This field is only relevant when type is left unset or set to + * CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + negation?: boolean; + /** + * Comparison operator of this term. This field is only relevant when type + * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + operator?: string; + /** + * ID of the list in question. This field is only relevant when type is set + * to LIST_MEMBERSHIP_TERM. + */ + remarketingListId?: string; + /** + * List population term type determines the applicable fields in this + * object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, + * variableFriendlyName, operator, value, and negation are applicable. If + * set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are + * applicable. If set to REFERRER_TERM then operator, value, and negation + * are applicable. + */ + type?: string; + /** + * Literal to compare the variable to. This field is only relevant when type + * is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. + */ + value?: string; + /** + * Friendly name of this term's variable. This is a read-only, + * auto-generated field. This field is only relevant when type is left unset + * or set to CUSTOM_VARIABLE_TERM. + */ + variableFriendlyName?: string; + /** + * Name of the variable (U1, U2, etc.) being compared in this term. This + * field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or + * REFERRER_TERM. + */ + variableName?: string; + } + /** + * Remarketing List Targeting Expression. + */ + export interface Schema$ListTargetingExpression { + /** + * Expression describing which lists are being targeted by the ad. + */ + expression?: string; + } + /** + * Lookback configuration settings. + */ + export interface Schema$LookbackConfiguration { + /** + * Lookback window, in days, from the last time a given user clicked on one + * of your ads. If you enter 0, clicks will not be considered as triggering + * events for floodlight tracking. If you leave this field blank, the + * default value for your account will be used. Acceptable values are 0 to + * 90, inclusive. + */ + clickDuration?: number; + /** + * Lookback window, in days, from the last time a given user viewed one of + * your ads. If you enter 0, impressions will not be considered as + * triggering events for floodlight tracking. If you leave this field blank, + * the default value for your account will be used. Acceptable values are 0 + * to 90, inclusive. + */ + postImpressionActivitiesDuration?: number; + } + /** + * Represents a metric. + */ + export interface Schema$Metric { + /** + * The kind of resource this is, in this case dfareporting#metric. + */ + kind?: string; + /** + * The metric name, e.g. dfa:impressions + */ + name?: string; + } + /** + * Contains information about a metro region that can be targeted by ads. + */ + export interface Schema$Metro { + /** + * Country code of the country to which this metro region belongs. + */ + countryCode?: string; + /** + * DART ID of the country to which this metro region belongs. + */ + countryDartId?: string; + /** + * DART ID of this metro region. + */ + dartId?: string; + /** + * DMA ID of this metro region. This is the ID used for targeting and + * generating reports, and is equivalent to metro_code. + */ + dmaId?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#metro". + */ + kind?: string; + /** + * Metro code of this metro region. This is equivalent to dma_id. + */ + metroCode?: string; + /** + * Name of this metro region. + */ + name?: string; + } + /** + * Metro List Response + */ + export interface Schema$MetrosListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#metrosListResponse". + */ + kind?: string; + /** + * Metro collection. + */ + metros?: Schema$Metro[]; + } + /** + * Contains information about a mobile app. Used as a landing page deep link. + */ + export interface Schema$MobileApp { + /** + * Mobile app directory. + */ + directory?: string; + /** + * ID of this mobile app. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#mobileApp". + */ + kind?: string; + /** + * Publisher name. + */ + publisherName?: string; + /** + * Title of this mobile app. + */ + title?: string; + } + /** + * Mobile app List Response + */ + export interface Schema$MobileAppsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#mobileAppsListResponse". + */ + kind?: string; + /** + * Mobile apps collection. + */ + mobileApps?: Schema$MobileApp[]; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + } + /** + * Contains information about a mobile carrier that can be targeted by ads. + */ + export interface Schema$MobileCarrier { + /** + * Country code of the country to which this mobile carrier belongs. + */ + countryCode?: string; + /** + * DART ID of the country to which this mobile carrier belongs. + */ + countryDartId?: string; + /** + * ID of this mobile carrier. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#mobileCarrier". + */ + kind?: string; + /** + * Name of this mobile carrier. + */ + name?: string; + } + /** + * Mobile Carrier List Response + */ + export interface Schema$MobileCarriersListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#mobileCarriersListResponse". + */ + kind?: string; + /** + * Mobile carrier collection. + */ + mobileCarriers?: Schema$MobileCarrier[]; + } + /** + * Object Filter. + */ + export interface Schema$ObjectFilter { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#objectFilter". + */ + kind?: string; + /** + * Applicable when status is ASSIGNED. The user has access to objects with + * these object IDs. + */ + objectIds?: string[]; + /** + * Status of the filter. NONE means the user has access to none of the + * objects. ALL means the user has access to all objects. ASSIGNED means the + * user has access to the objects with IDs in the objectIds list. + */ + status?: string; + } + /** + * Offset Position. + */ + export interface Schema$OffsetPosition { + /** + * Offset distance from left side of an asset or a window. + */ + left?: number; + /** + * Offset distance from top side of an asset or a window. + */ + top?: number; + } + /** + * Omniture Integration Settings. + */ + export interface Schema$OmnitureSettings { + /** + * Whether placement cost data will be sent to Omniture. This property can + * be enabled only if omnitureIntegrationEnabled is true. + */ + omnitureCostDataEnabled?: boolean; + /** + * Whether Omniture integration is enabled. This property can be enabled + * only when the "Advanced Ad Serving" account setting is enabled. + */ + omnitureIntegrationEnabled?: boolean; + } + /** + * Contains information about an operating system that can be targeted by ads. + */ + export interface Schema$OperatingSystem { + /** + * DART ID of this operating system. This is the ID used for targeting. + */ + dartId?: string; + /** + * Whether this operating system is for desktop. + */ + desktop?: boolean; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#operatingSystem". + */ + kind?: string; + /** + * Whether this operating system is for mobile. + */ + mobile?: boolean; + /** + * Name of this operating system. + */ + name?: string; + } + /** + * Operating System List Response + */ + export interface Schema$OperatingSystemsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#operatingSystemsListResponse". + */ + kind?: string; + /** + * Operating system collection. + */ + operatingSystems?: Schema$OperatingSystem[]; + } + /** + * Contains information about a particular version of an operating system that + * can be targeted by ads. + */ + export interface Schema$OperatingSystemVersion { + /** + * ID of this operating system version. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#operatingSystemVersion". + */ + kind?: string; + /** + * Major version (leftmost number) of this operating system version. + */ + majorVersion?: string; + /** + * Minor version (number after the first dot) of this operating system + * version. + */ + minorVersion?: string; + /** + * Name of this operating system version. + */ + name?: string; + /** + * Operating system of this operating system version. + */ + operatingSystem?: Schema$OperatingSystem; + } + /** + * Operating System Version List Response + */ + export interface Schema$OperatingSystemVersionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#operatingSystemVersionsListResponse". + */ + kind?: string; + /** + * Operating system version collection. + */ + operatingSystemVersions?: Schema$OperatingSystemVersion[]; + } + /** + * Creative optimization activity. + */ + export interface Schema$OptimizationActivity { + /** + * Floodlight activity ID of this optimization activity. This is a required + * field. + */ + floodlightActivityId?: string; + /** + * Dimension value for the ID of the floodlight activity. This is a + * read-only, auto-generated field. + */ + floodlightActivityIdDimensionValue?: Schema$DimensionValue; + /** + * Weight associated with this optimization. The weight assigned will be + * understood in proportion to the weights assigned to the other + * optimization activities. Value must be greater than or equal to 1. + */ + weight?: number; + } + /** + * Describes properties of a Planning order. + */ + export interface Schema$Order { + /** + * Account ID of this order. + */ + accountId?: string; + /** + * Advertiser ID of this order. + */ + advertiserId?: string; + /** + * IDs for users that have to approve documents created for this order. + */ + approverUserProfileIds?: string[]; + /** + * Buyer invoice ID associated with this order. + */ + buyerInvoiceId?: string; + /** + * Name of the buyer organization. + */ + buyerOrganizationName?: string; + /** + * Comments in this order. + */ + comments?: string; + /** + * Contacts for this order. + */ + contacts?: Schema$OrderContact[]; + /** + * ID of this order. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#order". + */ + kind?: string; + /** + * Information about the most recent modification of this order. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this order. + */ + name?: string; + /** + * Notes of this order. + */ + notes?: string; + /** + * ID of the terms and conditions template used in this order. + */ + planningTermId?: string; + /** + * Project ID of this order. + */ + projectId?: string; + /** + * Seller order ID associated with this order. + */ + sellerOrderId?: string; + /** + * Name of the seller organization. + */ + sellerOrganizationName?: string; + /** + * Site IDs this order is associated with. + */ + siteId?: string[]; + /** + * Free-form site names this order is associated with. + */ + siteNames?: string[]; + /** + * Subaccount ID of this order. + */ + subaccountId?: string; + /** + * Terms and conditions of this order. + */ + termsAndConditions?: string; + } + /** + * Contact of an order. + */ + export interface Schema$OrderContact { + /** + * Free-form information about this contact. It could be any information + * related to this contact in addition to type, title, name, and signature + * user profile ID. + */ + contactInfo?: string; + /** + * Name of this contact. + */ + contactName?: string; + /** + * Title of this contact. + */ + contactTitle?: string; + /** + * Type of this contact. + */ + contactType?: string; + /** + * ID of the user profile containing the signature that will be embedded + * into order documents. + */ + signatureUserProfileId?: string; + } + /** + * Contains properties of a Planning order document. + */ + export interface Schema$OrderDocument { + /** + * Account ID of this order document. + */ + accountId?: string; + /** + * Advertiser ID of this order document. + */ + advertiserId?: string; + /** + * The amended order document ID of this order document. An order document + * can be created by optionally amending another order document so that the + * change history can be preserved. + */ + amendedOrderDocumentId?: string; + /** + * IDs of users who have approved this order document. + */ + approvedByUserProfileIds?: string[]; + /** + * Whether this order document is cancelled. + */ + cancelled?: boolean; + /** + * Information about the creation of this order document. + */ + createdInfo?: Schema$LastModifiedInfo; + /** + * Effective date of this order document. + */ + effectiveDate?: string; + /** + * ID of this order document. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#orderDocument". + */ + kind?: string; + /** + * List of email addresses that received the last sent document. + */ + lastSentRecipients?: string[]; + /** + * Timestamp of the last email sent with this order document. + */ + lastSentTime?: string; + /** + * ID of the order from which this order document is created. + */ + orderId?: string; + /** + * Project ID of this order document. + */ + projectId?: string; + /** + * Whether this order document has been signed. + */ + signed?: boolean; + /** + * Subaccount ID of this order document. + */ + subaccountId?: string; + /** + * Title of this order document. + */ + title?: string; + /** + * Type of this order document + */ + type?: string; + } + /** + * Order document List Response + */ + export interface Schema$OrderDocumentsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#orderDocumentsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Order document collection + */ + orderDocuments?: Schema$OrderDocument[]; + } + /** + * Order List Response + */ + export interface Schema$OrdersListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#ordersListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Order collection. + */ + orders?: Schema$Order[]; + } + /** + * Represents fields that are compatible to be selected for a report of type + * "PATH_TO_CONVERSION". + */ + export interface Schema$PathToConversionReportCompatibleFields { + /** + * Conversion dimensions which are compatible to be selected in the + * "conversionDimensions" section of the report. + */ + conversionDimensions?: Schema$Dimension[]; + /** + * Custom floodlight variables which are compatible to be selected in the + * "customFloodlightVariables" section of the report. + */ + customFloodlightVariables?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case + * dfareporting#pathToConversionReportCompatibleFields. + */ + kind?: string; + /** + * Metrics which are compatible to be selected in the + * "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Per-interaction dimensions which are compatible to be selected in the + * "perInteractionDimensions" section of the report. + */ + perInteractionDimensions?: Schema$Dimension[]; + } + /** + * Contains properties of a placement. + */ + export interface Schema$Placement { + /** + * Account ID of this placement. This field can be left blank. + */ + accountId?: string; + /** + * Whether this placement opts out of ad blocking. When true, ad blocking is + * disabled for this placement. When false, the campaign and site settings + * take effect. + */ + adBlockingOptOut?: boolean; + /** + * Additional sizes associated with this placement. When inserting or + * updating a placement, only the size ID field is used. + */ + additionalSizes?: Schema$Size[]; + /** + * Advertiser ID of this placement. This field can be left blank. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this placement is archived. + */ + archived?: boolean; + /** + * Campaign ID of this placement. This field is a required field on + * insertion. + */ + campaignId?: string; + /** + * Dimension value for the ID of the campaign. This is a read-only, + * auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * Comments for this placement. + */ + comment?: string; + /** + * Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to + * rendering on desktop, on mobile devices or in mobile apps for regular or + * interstitial ads respectively. APP and APP_INTERSTITIAL are no longer + * allowed for new placement insertions. Instead, use DISPLAY or + * DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream + * video ads developed with the VAST standard. This field is required on + * insertion. + */ + compatibility?: string; + /** + * ID of the content category assigned to this placement. + */ + contentCategoryId?: string; + /** + * Information about the creation of this placement. This is a read-only + * field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Directory site ID of this placement. On insert, you must set either this + * field or the siteId field to specify the site associated with this + * placement. This is a required field that is read-only after insertion. + */ + directorySiteId?: string; + /** + * Dimension value for the ID of the directory site. This is a read-only, + * auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * External ID for this placement. + */ + externalId?: string; + /** + * ID of this placement. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Dimension value for the ID of this placement. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key name of this placement. This is a read-only, auto-generated field. + */ + keyName?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#placement". + */ + kind?: string; + /** + * Information about the most recent modification of this placement. This is + * a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Lookback window settings for this placement. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Name of this placement.This is a required field and must be less than 256 + * characters long. + */ + name?: string; + /** + * Whether payment was approved for this placement. This is a read-only + * field relevant only to publisher-paid placements. + */ + paymentApproved?: boolean; + /** + * Payment source for this placement. This is a required field that is + * read-only after insertion. + */ + paymentSource?: string; + /** + * ID of this placement's group, if applicable. + */ + placementGroupId?: string; + /** + * Dimension value for the ID of the placement group. This is a read-only, + * auto-generated field. + */ + placementGroupIdDimensionValue?: Schema$DimensionValue; + /** + * ID of the placement strategy assigned to this placement. + */ + placementStrategyId?: string; + /** + * Pricing schedule of this placement. This field is required on insertion, + * specifically subfields startDate, endDate and pricingType. + */ + pricingSchedule?: Schema$PricingSchedule; + /** + * Whether this placement is the primary placement of a roadblock (placement + * group). You cannot change this field from true to false. Setting this + * field to true will automatically set the primary field on the original + * primary placement of the roadblock to false, and it will automatically + * set the roadblock's primaryPlacementId field to the ID of this + * placement. + */ + primary?: boolean; + /** + * Information about the last publisher update. This is a read-only field. + */ + publisherUpdateInfo?: Schema$LastModifiedInfo; + /** + * Site ID associated with this placement. On insert, you must set either + * this field or the directorySiteId field to specify the site associated + * with this placement. This is a required field that is read-only after + * insertion. + */ + siteId?: string; + /** + * Dimension value for the ID of the site. This is a read-only, + * auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Size associated with this placement. When inserting or updating a + * placement, only the size ID field is used. This field is required on + * insertion. + */ + size?: Schema$Size; + /** + * Whether creatives assigned to this placement must be SSL-compliant. + */ + sslRequired?: boolean; + /** + * Third-party placement status. + */ + status?: string; + /** + * Subaccount ID of this placement. This field can be left blank. + */ + subaccountId?: string; + /** + * Tag formats to generate for this placement. This field is required on + * insertion. Acceptable values are: - "PLACEMENT_TAG_STANDARD" - + * "PLACEMENT_TAG_IFRAME_JAVASCRIPT" - + * "PLACEMENT_TAG_IFRAME_ILAYER" - + * "PLACEMENT_TAG_INTERNAL_REDIRECT" - + * "PLACEMENT_TAG_JAVASCRIPT" - + * "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT" - + * "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT" - + * "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT" - + * "PLACEMENT_TAG_CLICK_COMMANDS" - + * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH" - + * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3" - + * "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4" - + * "PLACEMENT_TAG_TRACKING" - + * "PLACEMENT_TAG_TRACKING_IFRAME" - + * "PLACEMENT_TAG_TRACKING_JAVASCRIPT" + */ + tagFormats?: string[]; + /** + * Tag settings for this placement. + */ + tagSetting?: Schema$TagSetting; + /** + * Whether Verification and ActiveView are disabled for in-stream video + * creatives for this placement. The same setting videoActiveViewOptOut + * exists on the site level -- the opt out occurs if either of these + * settings are true. These settings are distinct from + * DirectorySites.settings.activeViewOptOut or + * Sites.siteSettings.activeViewOptOut which only apply to display ads. + * However, Accounts.activeViewOptOut opts out both video traffic, as well + * as display ads, from Verification and ActiveView. + */ + videoActiveViewOptOut?: boolean; + /** + * A collection of settings which affect video creatives served through this + * placement. Applicable to placements with IN_STREAM_VIDEO compatibility. + */ + videoSettings?: Schema$VideoSettings; + /** + * VPAID adapter setting for this placement. Controls which VPAID format the + * measurement adapter will use for in-stream video creatives assigned to + * this placement. Note: Flash is no longer supported. This field now + * defaults to HTML5 when the following values are provided: FLASH, BOTH. + */ + vpaidAdapterChoice?: string; + } + /** + * Placement Assignment. + */ + export interface Schema$PlacementAssignment { + /** + * Whether this placement assignment is active. When true, the placement + * will be included in the ad's rotation. + */ + active?: boolean; + /** + * ID of the placement to be assigned. This is a required field. + */ + placementId?: string; + /** + * Dimension value for the ID of the placement. This is a read-only, + * auto-generated field. + */ + placementIdDimensionValue?: Schema$DimensionValue; + /** + * Whether the placement to be assigned requires SSL. This is a read-only + * field that is auto-generated when the ad is inserted or updated. + */ + sslRequired?: boolean; + } + /** + * Contains properties of a package or roadblock. + */ + export interface Schema$PlacementGroup { + /** + * Account ID of this placement group. This is a read-only field that can be + * left blank. + */ + accountId?: string; + /** + * Advertiser ID of this placement group. This is a required field on + * insertion. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Whether this placement group is archived. + */ + archived?: boolean; + /** + * Campaign ID of this placement group. This field is required on insertion. + */ + campaignId?: string; + /** + * Dimension value for the ID of the campaign. This is a read-only, + * auto-generated field. + */ + campaignIdDimensionValue?: Schema$DimensionValue; + /** + * IDs of placements which are assigned to this placement group. This is a + * read-only, auto-generated field. + */ + childPlacementIds?: string[]; + /** + * Comments for this placement group. + */ + comment?: string; + /** + * ID of the content category assigned to this placement group. + */ + contentCategoryId?: string; + /** + * Information about the creation of this placement group. This is a + * read-only field. + */ + createInfo?: Schema$LastModifiedInfo; + /** + * Directory site ID associated with this placement group. On insert, you + * must set either this field or the site_id field to specify the site + * associated with this placement group. This is a required field that is + * read-only after insertion. + */ + directorySiteId?: string; + /** + * Dimension value for the ID of the directory site. This is a read-only, + * auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * External ID for this placement. + */ + externalId?: string; + /** + * ID of this placement group. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Dimension value for the ID of this placement group. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#placementGroup". + */ + kind?: string; + /** + * Information about the most recent modification of this placement group. + * This is a read-only field. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this placement group. This is a required field and must be less + * than 256 characters long. + */ + name?: string; + /** + * Type of this placement group. A package is a simple group of placements + * that acts as a single pricing point for a group of tags. A roadblock is a + * group of placements that not only acts as a single pricing point, but + * also assumes that all the tags in it will be served at the same time. A + * roadblock requires one of its assigned placements to be marked as primary + * for reporting. This field is required on insertion. + */ + placementGroupType?: string; + /** + * ID of the placement strategy assigned to this placement group. + */ + placementStrategyId?: string; + /** + * Pricing schedule of this placement group. This field is required on + * insertion. + */ + pricingSchedule?: Schema$PricingSchedule; + /** + * ID of the primary placement, used to calculate the media cost of a + * roadblock (placement group). Modifying this field will automatically + * modify the primary field on all affected roadblock child placements. + */ + primaryPlacementId?: string; + /** + * Dimension value for the ID of the primary placement. This is a read-only, + * auto-generated field. + */ + primaryPlacementIdDimensionValue?: Schema$DimensionValue; + /** + * Site ID associated with this placement group. On insert, you must set + * either this field or the directorySiteId field to specify the site + * associated with this placement group. This is a required field that is + * read-only after insertion. + */ + siteId?: string; + /** + * Dimension value for the ID of the site. This is a read-only, + * auto-generated field. + */ + siteIdDimensionValue?: Schema$DimensionValue; + /** + * Subaccount ID of this placement group. This is a read-only field that can + * be left blank. + */ + subaccountId?: string; + } + /** + * Placement Group List Response + */ + export interface Schema$PlacementGroupsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#placementGroupsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Placement group collection. + */ + placementGroups?: Schema$PlacementGroup[]; + } + /** + * Placement GenerateTags Response + */ + export interface Schema$PlacementsGenerateTagsResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#placementsGenerateTagsResponse". + */ + kind?: string; + /** + * Set of generated tags for the specified placements. + */ + placementTags?: Schema$PlacementTag[]; + } + /** + * Placement List Response + */ + export interface Schema$PlacementsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#placementsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Placement collection. + */ + placements?: Schema$Placement[]; + } + /** + * Placement Strategy List Response + */ + export interface Schema$PlacementStrategiesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#placementStrategiesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Placement strategy collection. + */ + placementStrategies?: Schema$PlacementStrategy[]; + } + /** + * Contains properties of a placement strategy. + */ + export interface Schema$PlacementStrategy { + /** + * Account ID of this placement strategy.This is a read-only field that can + * be left blank. + */ + accountId?: string; + /** + * ID of this placement strategy. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#placementStrategy". + */ + kind?: string; + /** + * Name of this placement strategy. This is a required field. It must be + * less than 256 characters long and unique among placement strategies of + * the same account. + */ + name?: string; + } + /** + * Placement Tag + */ + export interface Schema$PlacementTag { + /** + * Placement ID + */ + placementId?: string; + /** + * Tags generated for this placement. + */ + tagDatas?: Schema$TagData[]; + } + /** + * Contains information about a platform type that can be targeted by ads. + */ + export interface Schema$PlatformType { + /** + * ID of this platform type. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#platformType". + */ + kind?: string; + /** + * Name of this platform type. + */ + name?: string; + } + /** + * Platform Type List Response + */ + export interface Schema$PlatformTypesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#platformTypesListResponse". + */ + kind?: string; + /** + * Platform type collection. + */ + platformTypes?: Schema$PlatformType[]; + } + /** + * Popup Window Properties. + */ + export interface Schema$PopupWindowProperties { + /** + * Popup dimension for a creative. This is a read-only field. Applicable to + * the following creative types: all RICH_MEDIA and all VPAID + */ + dimension?: Schema$Size; + /** + * Upper-left corner coordinates of the popup window. Applicable if + * positionType is COORDINATES. + */ + offset?: Schema$OffsetPosition; + /** + * Popup window position either centered or at specific coordinate. + */ + positionType?: string; + /** + * Whether to display the browser address bar. + */ + showAddressBar?: boolean; + /** + * Whether to display the browser menu bar. + */ + showMenuBar?: boolean; + /** + * Whether to display the browser scroll bar. + */ + showScrollBar?: boolean; + /** + * Whether to display the browser status bar. + */ + showStatusBar?: boolean; + /** + * Whether to display the browser tool bar. + */ + showToolBar?: boolean; + /** + * Title of popup window. + */ + title?: string; + } + /** + * Contains information about a postal code that can be targeted by ads. + */ + export interface Schema$PostalCode { + /** + * Postal code. This is equivalent to the id field. + */ + code?: string; + /** + * Country code of the country to which this postal code belongs. + */ + countryCode?: string; + /** + * DART ID of the country to which this postal code belongs. + */ + countryDartId?: string; + /** + * ID of this postal code. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#postalCode". + */ + kind?: string; + } + /** + * Postal Code List Response + */ + export interface Schema$PostalCodesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#postalCodesListResponse". + */ + kind?: string; + /** + * Postal code collection. + */ + postalCodes?: Schema$PostalCode[]; + } + /** + * Pricing Information + */ + export interface Schema$Pricing { + /** + * Cap cost type of this inventory item. + */ + capCostType?: string; + /** + * End date of this inventory item. + */ + endDate?: string; + /** + * Flights of this inventory item. A flight (a.k.a. pricing period) + * represents the inventory item pricing information for a specific period + * of time. + */ + flights?: Schema$Flight[]; + /** + * Group type of this inventory item if it represents a placement group. Is + * null otherwise. There are two type of placement groups: + * PLANNING_PLACEMENT_GROUP_TYPE_PACKAGE is a simple group of inventory + * items that acts as a single pricing point for a group of tags. + * PLANNING_PLACEMENT_GROUP_TYPE_ROADBLOCK is a group of inventory items + * that not only acts as a single pricing point, but also assumes that all + * the tags in it will be served at the same time. A roadblock requires one + * of its assigned inventory items to be marked as primary. + */ + groupType?: string; + /** + * Pricing type of this inventory item. + */ + pricingType?: string; + /** + * Start date of this inventory item. + */ + startDate?: string; + } + /** + * Pricing Schedule + */ + export interface Schema$PricingSchedule { + /** + * Placement cap cost option. + */ + capCostOption?: string; + /** + * Whether cap costs are ignored by ad serving. + */ + disregardOverdelivery?: boolean; + /** + * Placement end date. This date must be later than, or the same day as, the + * placement start date, but not later than the campaign end date. If, for + * example, you set 6/25/2015 as both the start and end dates, the effective + * placement date is just that day only, 6/25/2015. The hours, minutes, and + * seconds of the end date should not be set, as doing so will result in an + * error. This field is required on insertion. + */ + endDate?: string; + /** + * Whether this placement is flighted. If true, pricing periods will be + * computed automatically. + */ + flighted?: boolean; + /** + * Floodlight activity ID associated with this placement. This field should + * be set when placement pricing type is set to PRICING_TYPE_CPA. + */ + floodlightActivityId?: string; + /** + * Pricing periods for this placement. + */ + pricingPeriods?: Schema$PricingSchedulePricingPeriod[]; + /** + * Placement pricing type. This field is required on insertion. + */ + pricingType?: string; + /** + * Placement start date. This date must be later than, or the same day as, + * the campaign start date. The hours, minutes, and seconds of the start + * date should not be set, as doing so will result in an error. This field + * is required on insertion. + */ + startDate?: string; + /** + * Testing start date of this placement. The hours, minutes, and seconds of + * the start date should not be set, as doing so will result in an error. + */ + testingStartDate?: string; + } + /** + * Pricing Period + */ + export interface Schema$PricingSchedulePricingPeriod { + /** + * Pricing period end date. This date must be later than, or the same day + * as, the pricing period start date, but not later than the placement end + * date. The period end date can be the same date as the period start date. + * If, for example, you set 6/25/2015 as both the start and end dates, the + * effective pricing period date is just that day only, 6/25/2015. The + * hours, minutes, and seconds of the end date should not be set, as doing + * so will result in an error. + */ + endDate?: string; + /** + * Comments for this pricing period. + */ + pricingComment?: string; + /** + * Rate or cost of this pricing period in nanos (i.e., multipled by + * 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive. + */ + rateOrCostNanos?: string; + /** + * Pricing period start date. This date must be later than, or the same day + * as, the placement start date. The hours, minutes, and seconds of the + * start date should not be set, as doing so will result in an error. + */ + startDate?: string; + /** + * Units of this pricing period. Acceptable values are 0 to 10000000000, + * inclusive. + */ + units?: string; + } + /** + * Contains properties of a Planning project. + */ + export interface Schema$Project { + /** + * Account ID of this project. + */ + accountId?: string; + /** + * Advertiser ID of this project. + */ + advertiserId?: string; + /** + * Audience age group of this project. + */ + audienceAgeGroup?: string; + /** + * Audience gender of this project. + */ + audienceGender?: string; + /** + * Budget of this project in the currency specified by the current account. + * The value stored in this field represents only the non-fractional amount. + * For example, for USD, the smallest value that can be represented by this + * field is 1 US dollar. + */ + budget?: string; + /** + * Client billing code of this project. + */ + clientBillingCode?: string; + /** + * Name of the project client. + */ + clientName?: string; + /** + * End date of the project. + */ + endDate?: string; + /** + * ID of this project. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#project". + */ + kind?: string; + /** + * Information about the most recent modification of this project. + */ + lastModifiedInfo?: Schema$LastModifiedInfo; + /** + * Name of this project. + */ + name?: string; + /** + * Overview of this project. + */ + overview?: string; + /** + * Start date of the project. + */ + startDate?: string; + /** + * Subaccount ID of this project. + */ + subaccountId?: string; + /** + * Number of clicks that the advertiser is targeting. + */ + targetClicks?: string; + /** + * Number of conversions that the advertiser is targeting. + */ + targetConversions?: string; + /** + * CPA that the advertiser is targeting. + */ + targetCpaNanos?: string; + /** + * CPC that the advertiser is targeting. + */ + targetCpcNanos?: string; + /** + * vCPM from Active View that the advertiser is targeting. + */ + targetCpmActiveViewNanos?: string; + /** + * CPM that the advertiser is targeting. + */ + targetCpmNanos?: string; + /** + * Number of impressions that the advertiser is targeting. + */ + targetImpressions?: string; + } + /** + * Project List Response + */ + export interface Schema$ProjectsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#projectsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Project collection. + */ + projects?: Schema$Project[]; + } + /** + * Represents fields that are compatible to be selected for a report of type + * "REACH". + */ + export interface Schema$ReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the + * "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the + * "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case + * dfareporting#reachReportCompatibleFields. + */ + kind?: string; + /** + * Metrics which are compatible to be selected in the + * "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected as activity metrics to pivot + * on in the "activities" section of the report. + */ + pivotedActivityMetrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected in the + * "reachByFrequencyMetricNames" section of the report. + */ + reachByFrequencyMetrics?: Schema$Metric[]; + } + /** + * Represents a recipient. + */ + export interface Schema$Recipient { + /** + * The delivery type for the recipient. + */ + deliveryType?: string; + /** + * The email address of the recipient. + */ + email?: string; + /** + * The kind of resource this is, in this case dfareporting#recipient. + */ + kind?: string; + } + /** + * Contains information about a region that can be targeted by ads. + */ + export interface Schema$Region { + /** + * Country code of the country to which this region belongs. + */ + countryCode?: string; + /** + * DART ID of the country to which this region belongs. + */ + countryDartId?: string; + /** + * DART ID of this region. + */ + dartId?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#region". + */ + kind?: string; + /** + * Name of this region. + */ + name?: string; + /** + * Region code. + */ + regionCode?: string; + } + /** + * Region List Response + */ + export interface Schema$RegionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#regionsListResponse". + */ + kind?: string; + /** + * Region collection. + */ + regions?: Schema$Region[]; + } + /** + * Contains properties of a remarketing list. Remarketing enables you to + * create lists of users who have performed specific actions on a site, then + * target ads to members of those lists. This resource can be used to manage + * remarketing lists that are owned by your advertisers. To see all + * remarketing lists that are visible to your advertisers, including those + * that are shared to your advertiser or account, use the + * TargetableRemarketingLists resource. + */ + export interface Schema$RemarketingList { + /** + * Account ID of this remarketing list. This is a read-only, auto-generated + * field that is only returned in GET requests. + */ + accountId?: string; + /** + * Whether this remarketing list is active. + */ + active?: boolean; + /** + * Dimension value for the advertiser ID that owns this remarketing list. + * This is a required field. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Remarketing list description. + */ + description?: string; + /** + * Remarketing list ID. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#remarketingList". + */ + kind?: string; + /** + * Number of days that a user should remain in the remarketing list without + * an impression. Acceptable values are 1 to 540, inclusive. + */ + lifeSpan?: string; + /** + * Rule used to populate the remarketing list with users. + */ + listPopulationRule?: Schema$ListPopulationRule; + /** + * Number of users currently in the list. This is a read-only field. + */ + listSize?: string; + /** + * Product from which this remarketing list was originated. + */ + listSource?: string; + /** + * Name of the remarketing list. This is a required field. Must be no + * greater than 128 characters long. + */ + name?: string; + /** + * Subaccount ID of this remarketing list. This is a read-only, + * auto-generated field that is only returned in GET requests. + */ + subaccountId?: string; + } + /** + * Contains properties of a remarketing list's sharing information. + * Sharing allows other accounts or advertisers to target to your remarketing + * lists. This resource can be used to manage remarketing list sharing to + * other accounts and advertisers. + */ + export interface Schema$RemarketingListShare { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#remarketingListShare". + */ + kind?: string; + /** + * Remarketing list ID. This is a read-only, auto-generated field. + */ + remarketingListId?: string; + /** + * Accounts that the remarketing list is shared with. + */ + sharedAccountIds?: string[]; + /** + * Advertisers that the remarketing list is shared with. + */ + sharedAdvertiserIds?: string[]; + } + /** + * Remarketing list response + */ + export interface Schema$RemarketingListsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#remarketingListsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Remarketing list collection. + */ + remarketingLists?: Schema$RemarketingList[]; + } + /** + * Represents a Report resource. + */ + export interface Schema$Report { + /** + * The account ID to which this report belongs. + */ + accountId?: string; + /** + * The report criteria for a report of type "STANDARD". + */ + criteria?: { + activities?: Schema$Activities; + customRichMediaEvents?: Schema$CustomRichMediaEvents; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + metricNames?: string[]; + }; + /** + * The report criteria for a report of type + * "CROSS_DIMENSION_REACH". + */ + crossDimensionReachCriteria?: { + breakdown?: Schema$SortedDimension[]; + dateRange?: Schema$DateRange; + dimension?: string; + dimensionFilters?: Schema$DimensionValue[]; + metricNames?: string[]; + overlapMetricNames?: string[]; + pivoted?: boolean; + }; + /** + * The report's email delivery settings. + */ + delivery?: { + emailOwner?: boolean; + emailOwnerDeliveryType?: string; + message?: string; + recipients?: Schema$Recipient[]; + }; + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The filename used when generating report files for this report. + */ + fileName?: string; + /** + * The report criteria for a report of type "FLOODLIGHT". + */ + floodlightCriteria?: { + customRichMediaEvents?: Schema$DimensionValue[]; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + floodlightConfigId?: Schema$DimensionValue; + metricNames?: string[]; + reportProperties?: { + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + }; + }; + /** + * The output format of the report. If not specified, default format is + * "CSV". Note that the actual format in the completed report file + * might differ if for instance the report's size exceeds the + * format's capabilities. "CSV" will then be the fallback + * format. + */ + format?: string; + /** + * The unique ID identifying this report resource. + */ + id?: string; + /** + * The kind of resource this is, in this case dfareporting#report. + */ + kind?: string; + /** + * The timestamp (in milliseconds since epoch) of when this report was last + * modified. + */ + lastModifiedTime?: string; + /** + * The name of the report. + */ + name?: string; + /** + * The user profile id of the owner of this report. + */ + ownerProfileId?: string; + /** + * The report criteria for a report of type "PATH_TO_CONVERSION". + */ + pathToConversionCriteria?: { + activityFilters?: Schema$DimensionValue[]; + conversionDimensions?: Schema$SortedDimension[]; + customFloodlightVariables?: Schema$SortedDimension[]; + customRichMediaEvents?: Schema$DimensionValue[]; + dateRange?: Schema$DateRange; + floodlightConfigId?: Schema$DimensionValue; + metricNames?: string[]; + perInteractionDimensions?: Schema$SortedDimension[]; + reportProperties?: { + clicksLookbackWindow?: number; + impressionsLookbackWindow?: number; + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + maximumClickInteractions?: number; + maximumImpressionInteractions?: number; + maximumInteractionGap?: number; + pivotOnInteractionPath?: boolean; + }; + }; + /** + * The report criteria for a report of type "REACH". + */ + reachCriteria?: { + activities?: Schema$Activities; + customRichMediaEvents?: Schema$CustomRichMediaEvents; + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + enableAllDimensionCombinations?: boolean; + metricNames?: string[]; + reachByFrequencyMetricNames?: string[]; + }; + /** + * The report's schedule. Can only be set if the report's + * 'dateRange' is a relative date range and the relative date range + * is not "TODAY". + */ + schedule?: { + active?: boolean; + every?: number; + expirationDate?: string; + repeats?: string; + repeatsOnWeekDays?: string[]; + runsOnDayOfMonth?: string; + startDate?: string; + }; + /** + * The subaccount ID to which this report belongs if applicable. + */ + subAccountId?: string; + /** + * The type of the report. + */ + type?: string; + } + /** + * Represents fields that are compatible to be selected for a report of type + * "STANDARD". + */ + export interface Schema$ReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the + * "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the + * "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case + * dfareporting#reportCompatibleFields. + */ + kind?: string; + /** + * Metrics which are compatible to be selected in the + * "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + /** + * Metrics which are compatible to be selected as activity metrics to pivot + * on in the "activities" section of the report. + */ + pivotedActivityMetrics?: Schema$Metric[]; + } + /** + * Represents the list of reports. + */ + export interface Schema$ReportList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The reports returned in this response. + */ + items?: Schema$Report[]; + /** + * The kind of list this is, in this case dfareporting#reportList. + */ + kind?: string; + /** + * Continuation token used to page through reports. To retrieve the next + * page of results, set the next request's "pageToken" to the + * value of this field. The page token is only valid for a limited amount of + * time and should not be persisted. + */ + nextPageToken?: string; + } + /** + * Reporting Configuration + */ + export interface Schema$ReportsConfiguration { + /** + * Whether the exposure to conversion report is enabled. This report shows + * detailed pathway information on up to 10 of the most recent ad exposures + * seen by a user before converting. + */ + exposureToConversionEnabled?: boolean; + /** + * Default lookback windows for new advertisers in this account. + */ + lookbackConfiguration?: Schema$LookbackConfiguration; + /** + * Report generation time zone ID of this account. This is a required field + * that can only be changed by a superuser. Acceptable values are: - + * "1" for "America/New_York" - "2" for + * "Europe/London" - "3" for "Europe/Paris" + * - "4" for "Africa/Johannesburg" - "5" for + * "Asia/Jerusalem" - "6" for "Asia/Shanghai" + * - "7" for "Asia/Hong_Kong" - "8" for + * "Asia/Tokyo" - "9" for "Australia/Sydney" + * - "10" for "Asia/Dubai" - "11" for + * "America/Los_Angeles" - "12" for + * "Pacific/Auckland" - "13" for + * "America/Sao_Paulo" + */ + reportGenerationTimeZoneId?: string; + } + /** + * Rich Media Exit Override. + */ + export interface Schema$RichMediaExitOverride { + /** + * Click-through URL of this rich media exit override. Applicable if the + * enabled field is set to true. + */ + clickThroughUrl?: Schema$ClickThroughUrl; + /** + * Whether to use the clickThroughUrl. If false, the creative-level exit + * will be used. + */ + enabled?: boolean; + /** + * ID for the override to refer to a specific exit in the creative. + */ + exitId?: string; + } + /** + * A rule associates an asset with a targeting template for asset-level + * targeting. Applicable to INSTREAM_VIDEO creatives. + */ + export interface Schema$Rule { + /** + * A creativeAssets[].id. This should refer to one of the parent assets in + * this creative. This is a required field. + */ + assetId?: string; + /** + * A user-friendly name for this rule. This is a required field. + */ + name?: string; + /** + * A targeting template ID. The targeting from the targeting template will + * be used to determine whether this asset should be served. This is a + * required field. + */ + targetingTemplateId?: string; + } + /** + * Contains properties of a site. + */ + export interface Schema$Site { + /** + * Account ID of this site. This is a read-only field that can be left + * blank. + */ + accountId?: string; + /** + * Whether this site is approved. + */ + approved?: boolean; + /** + * Directory site associated with this site. This is a required field that + * is read-only after insertion. + */ + directorySiteId?: string; + /** + * Dimension value for the ID of the directory site. This is a read-only, + * auto-generated field. + */ + directorySiteIdDimensionValue?: Schema$DimensionValue; + /** + * ID of this site. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Dimension value for the ID of this site. This is a read-only, + * auto-generated field. + */ + idDimensionValue?: Schema$DimensionValue; + /** + * Key name of this site. This is a read-only, auto-generated field. + */ + keyName?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#site". + */ + kind?: string; + /** + * Name of this site.This is a required field. Must be less than 128 + * characters long. If this site is under a subaccount, the name must be + * unique among sites of the same subaccount. Otherwise, this site is a + * top-level site, and the name must be unique among top-level sites of the + * same account. + */ + name?: string; + /** + * Site contacts. + */ + siteContacts?: Schema$SiteContact[]; + /** + * Site-wide settings. + */ + siteSettings?: Schema$SiteSettings; + /** + * Subaccount ID of this site. This is a read-only field that can be left + * blank. + */ + subaccountId?: string; + /** + * Default video settings for new placements created under this site. This + * value will be used to populate the placements.videoSettings field, when + * no value is specified for the new placement. + */ + videoSettings?: Schema$SiteVideoSettings; + } + /** + * Companion Settings + */ + export interface Schema$SiteCompanionSetting { + /** + * Whether companions are disabled for this site template. + */ + companionsDisabled?: boolean; + /** + * Whitelist of companion sizes to be served via this site template. Set + * this list to null or empty to serve all companion sizes. + */ + enabledSizes?: Schema$Size[]; + /** + * Whether to serve only static images as companions. + */ + imageOnly?: boolean; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#siteCompanionSetting". + */ + kind?: string; + } + /** + * Site Contact + */ + export interface Schema$SiteContact { + /** + * Address of this site contact. + */ + address?: string; + /** + * Site contact type. + */ + contactType?: string; + /** + * Email address of this site contact. This is a required field. + */ + email?: string; + /** + * First name of this site contact. + */ + firstName?: string; + /** + * ID of this site contact. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Last name of this site contact. + */ + lastName?: string; + /** + * Primary phone number of this site contact. + */ + phone?: string; + /** + * Title or designation of this site contact. + */ + title?: string; + } + /** + * Site Settings + */ + export interface Schema$SiteSettings { + /** + * Whether active view creatives are disabled for this site. + */ + activeViewOptOut?: boolean; + /** + * Whether this site opts out of ad blocking. When true, ad blocking is + * disabled for all placements under the site, regardless of the individual + * placement settings. When false, the campaign and placement settings take + * effect. + */ + adBlockingOptOut?: boolean; + /** + * Whether new cookies are disabled for this site. + */ + disableNewCookie?: boolean; + /** + * Configuration settings for dynamic and image floodlight tags. + */ + tagSetting?: Schema$TagSetting; + /** + * Whether Verification and ActiveView for in-stream video creatives are + * disabled by default for new placements created under this site. This + * value will be used to populate the placement.videoActiveViewOptOut field, + * when no value is specified for the new placement. + */ + videoActiveViewOptOutTemplate?: boolean; + /** + * Default VPAID adapter setting for new placements created under this site. + * This value will be used to populate the placements.vpaidAdapterChoice + * field, when no value is specified for the new placement. Controls which + * VPAID format the measurement adapter will use for in-stream video + * creatives assigned to the placement. The publisher's specifications + * will typically determine this setting. For VPAID creatives, the adapter + * format will match the VPAID format (HTML5 VPAID creatives use the HTML5 + * adapter). Note: Flash is no longer supported. This field now defaults to + * HTML5 when the following values are provided: FLASH, BOTH. + */ + vpaidAdapterChoiceTemplate?: string; + } + /** + * Skippable Settings + */ + export interface Schema$SiteSkippableSetting { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#siteSkippableSetting". + */ + kind?: string; + /** + * Amount of time to play videos served to this site template before + * counting a view. Applicable when skippable is true. + */ + progressOffset?: Schema$VideoOffset; + /** + * Amount of time to play videos served to this site before the skip button + * should appear. Applicable when skippable is true. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can skip creatives served to this site. This will act as + * default for new placements created under this site. + */ + skippable?: boolean; + } + /** + * Site List Response + */ + export interface Schema$SitesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#sitesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Site collection. + */ + sites?: Schema$Site[]; + } + /** + * Transcode Settings + */ + export interface Schema$SiteTranscodeSetting { + /** + * Whitelist of video formats to be served to this site template. Set this + * list to null or empty to serve all video formats. + */ + enabledVideoFormats?: number[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#siteTranscodeSetting". + */ + kind?: string; + } + /** + * Video Settings + */ + export interface Schema$SiteVideoSettings { + /** + * Settings for the companion creatives of video creatives served to this + * site. + */ + companionSettings?: Schema$SiteCompanionSetting; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#siteVideoSettings". + */ + kind?: string; + /** + * Orientation of a site template used for video. This will act as default + * for new placements created under this site. + */ + orientation?: string; + /** + * Settings for the skippability of video creatives served to this site. + * This will act as default for new placements created under this site. + */ + skippableSettings?: Schema$SiteSkippableSetting; + /** + * Settings for the transcodes of video creatives served to this site. This + * will act as default for new placements created under this site. + */ + transcodeSettings?: Schema$SiteTranscodeSetting; + } + /** + * Represents the dimensions of ads, placements, creatives, or creative + * assets. + */ + export interface Schema$Size { + /** + * Height of this size. Acceptable values are 0 to 32767, inclusive. + */ + height?: number; + /** + * IAB standard size. This is a read-only, auto-generated field. + */ + iab?: boolean; + /** + * ID of this size. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#size". + */ + kind?: string; + /** + * Width of this size. Acceptable values are 0 to 32767, inclusive. + */ + width?: number; + } + /** + * Size List Response + */ + export interface Schema$SizesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#sizesListResponse". + */ + kind?: string; + /** + * Size collection. + */ + sizes?: Schema$Size[]; + } + /** + * Skippable Settings + */ + export interface Schema$SkippableSetting { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#skippableSetting". + */ + kind?: string; + /** + * Amount of time to play videos served to this placement before counting a + * view. Applicable when skippable is true. + */ + progressOffset?: Schema$VideoOffset; + /** + * Amount of time to play videos served to this placement before the skip + * button should appear. Applicable when skippable is true. + */ + skipOffset?: Schema$VideoOffset; + /** + * Whether the user can skip creatives served to this placement. + */ + skippable?: boolean; + } + /** + * Represents a sorted dimension. + */ + export interface Schema$SortedDimension { + /** + * The kind of resource this is, in this case dfareporting#sortedDimension. + */ + kind?: string; + /** + * The name of the dimension. + */ + name?: string; + /** + * An optional sort order for the dimension column. + */ + sortOrder?: string; + } + /** + * Contains properties of a Campaign Manager subaccount. + */ + export interface Schema$Subaccount { + /** + * ID of the account that contains this subaccount. This is a read-only + * field that can be left blank. + */ + accountId?: string; + /** + * IDs of the available user role permissions for this subaccount. + */ + availablePermissionIds?: string[]; + /** + * ID of this subaccount. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#subaccount". + */ + kind?: string; + /** + * Name of this subaccount. This is a required field. Must be less than 128 + * characters long and be unique among subaccounts of the same account. + */ + name?: string; + } + /** + * Subaccount List Response + */ + export interface Schema$SubaccountsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#subaccountsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Subaccount collection. + */ + subaccounts?: Schema$Subaccount[]; + } + /** + * Placement Tag Data + */ + export interface Schema$TagData { + /** + * Ad associated with this placement tag. Applicable only when format is + * PLACEMENT_TAG_TRACKING. + */ + adId?: string; + /** + * Tag string to record a click. + */ + clickTag?: string; + /** + * Creative associated with this placement tag. Applicable only when format + * is PLACEMENT_TAG_TRACKING. + */ + creativeId?: string; + /** + * TagData tag format of this tag. + */ + format?: string; + /** + * Tag string for serving an ad. + */ + impressionTag?: string; + } + /** + * Tag Settings + */ + export interface Schema$TagSetting { + /** + * Additional key-values to be included in tags. Each key-value pair must be + * of the form key=value, and pairs must be separated by a semicolon (;). + * Keys and values must not contain commas. For example, id=2;color=red is a + * valid value for this field. + */ + additionalKeyValues?: string; + /** + * Whether static landing page URLs should be included in the tags. This + * setting applies only to placements. + */ + includeClickThroughUrls?: boolean; + /** + * Whether click-tracking string should be included in the tags. + */ + includeClickTracking?: boolean; + /** + * Option specifying how keywords are embedded in ad tags. This setting can + * be used to specify whether keyword placeholders are inserted in placement + * tags for this site. Publishers can then add keywords to those + * placeholders. + */ + keywordOption?: string; + } + /** + * Dynamic and Image Tag Settings. + */ + export interface Schema$TagSettings { + /** + * Whether dynamic floodlight tags are enabled. + */ + dynamicTagEnabled?: boolean; + /** + * Whether image tags are enabled. + */ + imageTagEnabled?: boolean; + } + /** + * Contains properties of a targetable remarketing list. Remarketing enables + * you to create lists of users who have performed specific actions on a site, + * then target ads to members of those lists. This resource is a read-only + * view of a remarketing list to be used to faciliate targeting ads to + * specific lists. Remarketing lists that are owned by your advertisers and + * those that are shared to your advertisers or account are accessible via + * this resource. To manage remarketing lists that are owned by your + * advertisers, use the RemarketingLists resource. + */ + export interface Schema$TargetableRemarketingList { + /** + * Account ID of this remarketing list. This is a read-only, auto-generated + * field that is only returned in GET requests. + */ + accountId?: string; + /** + * Whether this targetable remarketing list is active. + */ + active?: boolean; + /** + * Dimension value for the advertiser ID that owns this targetable + * remarketing list. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Targetable remarketing list description. + */ + description?: string; + /** + * Targetable remarketing list ID. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#targetableRemarketingList". + */ + kind?: string; + /** + * Number of days that a user should remain in the targetable remarketing + * list without an impression. + */ + lifeSpan?: string; + /** + * Number of users currently in the list. This is a read-only field. + */ + listSize?: string; + /** + * Product from which this targetable remarketing list was originated. + */ + listSource?: string; + /** + * Name of the targetable remarketing list. Is no greater than 128 + * characters long. + */ + name?: string; + /** + * Subaccount ID of this remarketing list. This is a read-only, + * auto-generated field that is only returned in GET requests. + */ + subaccountId?: string; + } + /** + * Targetable remarketing list response + */ + export interface Schema$TargetableRemarketingListsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#targetableRemarketingListsListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Targetable remarketing list collection. + */ + targetableRemarketingLists?: Schema$TargetableRemarketingList[]; + } + /** + * Contains properties of a targeting template. A targeting template + * encapsulates targeting information which can be reused across multiple ads. + */ + export interface Schema$TargetingTemplate { + /** + * Account ID of this targeting template. This field, if left unset, will be + * auto-generated on insert and is read-only after insert. + */ + accountId?: string; + /** + * Advertiser ID of this targeting template. This is a required field on + * insert and is read-only after insert. + */ + advertiserId?: string; + /** + * Dimension value for the ID of the advertiser. This is a read-only, + * auto-generated field. + */ + advertiserIdDimensionValue?: Schema$DimensionValue; + /** + * Time and day targeting criteria. + */ + dayPartTargeting?: Schema$DayPartTargeting; + /** + * Geographical targeting criteria. + */ + geoTargeting?: Schema$GeoTargeting; + /** + * ID of this targeting template. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Key-value targeting criteria. + */ + keyValueTargetingExpression?: Schema$KeyValueTargetingExpression; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#targetingTemplate". + */ + kind?: string; + /** + * Language targeting criteria. + */ + languageTargeting?: Schema$LanguageTargeting; + /** + * Remarketing list targeting criteria. + */ + listTargetingExpression?: Schema$ListTargetingExpression; + /** + * Name of this targeting template. This field is required. It must be less + * than 256 characters long and unique within an advertiser. + */ + name?: string; + /** + * Subaccount ID of this targeting template. This field, if left unset, will + * be auto-generated on insert and is read-only after insert. + */ + subaccountId?: string; + /** + * Technology platform targeting criteria. + */ + technologyTargeting?: Schema$TechnologyTargeting; + } + /** + * Targeting Template List Response + */ + export interface Schema$TargetingTemplatesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#targetingTemplatesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * Targeting template collection. + */ + targetingTemplates?: Schema$TargetingTemplate[]; + } + /** + * Target Window. + */ + export interface Schema$TargetWindow { + /** + * User-entered value. + */ + customHtml?: string; + /** + * Type of browser window for which the backup image of the flash creative + * can be displayed. + */ + targetWindowOption?: string; + } + /** + * Technology Targeting. + */ + export interface Schema$TechnologyTargeting { + /** + * Browsers that this ad targets. For each browser either set + * browserVersionId or dartId along with the version numbers. If both are + * specified, only browserVersionId will be used. The other fields are + * populated automatically when the ad is inserted or updated. + */ + browsers?: Schema$Browser[]; + /** + * Connection types that this ad targets. For each connection type only id + * is required. The other fields are populated automatically when the ad is + * inserted or updated. + */ + connectionTypes?: Schema$ConnectionType[]; + /** + * Mobile carriers that this ad targets. For each mobile carrier only id is + * required, and the other fields are populated automatically when the ad is + * inserted or updated. If targeting a mobile carrier, do not set targeting + * for any zip codes. + */ + mobileCarriers?: Schema$MobileCarrier[]; + /** + * Operating systems that this ad targets. To target specific versions, use + * operatingSystemVersions. For each operating system only dartId is + * required. The other fields are populated automatically when the ad is + * inserted or updated. If targeting an operating system, do not set + * targeting for operating system versions for the same operating system. + */ + operatingSystems?: Schema$OperatingSystem[]; + /** + * Operating system versions that this ad targets. To target all versions, + * use operatingSystems. For each operating system version, only id is + * required. The other fields are populated automatically when the ad is + * inserted or updated. If targeting an operating system version, do not set + * targeting for the corresponding operating system in operatingSystems. + */ + operatingSystemVersions?: Schema$OperatingSystemVersion[]; + /** + * Platform types that this ad targets. For example, desktop, mobile, or + * tablet. For each platform type, only id is required, and the other fields + * are populated automatically when the ad is inserted or updated. + */ + platformTypes?: Schema$PlatformType[]; + } + /** + * Third Party Authentication Token + */ + export interface Schema$ThirdPartyAuthenticationToken { + /** + * Name of the third-party authentication token. + */ + name?: string; + /** + * Value of the third-party authentication token. This is a read-only, + * auto-generated field. + */ + value?: string; + } + /** + * Third-party Tracking URL. + */ + export interface Schema$ThirdPartyTrackingUrl { + /** + * Third-party URL type for in-stream video and in-stream audio creatives. + */ + thirdPartyUrlType?: string; + /** + * URL for the specified third-party URL type. + */ + url?: string; + } + /** + * Transcode Settings + */ + export interface Schema$TranscodeSetting { + /** + * Whitelist of video formats to be served to this placement. Set this list + * to null or empty to serve all video formats. + */ + enabledVideoFormats?: number[]; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#transcodeSetting". + */ + kind?: string; + } + /** + * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following + * creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. + */ + export interface Schema$UniversalAdId { + /** + * Registry used for the Ad ID value. + */ + registry?: string; + /** + * ID value for this creative. Only alphanumeric characters and the + * following symbols are valid: "_/\-". Maximum length is 64 + * characters. Read only when registry is DCM. + */ + value?: string; + } + /** + * User Defined Variable configuration. + */ + export interface Schema$UserDefinedVariableConfiguration { + /** + * Data type for the variable. This is a required field. + */ + dataType?: string; + /** + * User-friendly name for the variable which will appear in reports. This is + * a required field, must be less than 64 characters long, and cannot + * contain the following characters: ""<>". + */ + reportName?: string; + /** + * Variable name in the tag. This is a required field. + */ + variableType?: string; + } + /** + * Represents a UserProfile resource. + */ + export interface Schema$UserProfile { + /** + * The account ID to which this profile belongs. + */ + accountId?: string; + /** + * The account name this profile belongs to. + */ + accountName?: string; + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The kind of resource this is, in this case dfareporting#userProfile. + */ + kind?: string; + /** + * The unique ID of the user profile. + */ + profileId?: string; + /** + * The sub account ID this profile belongs to if applicable. + */ + subAccountId?: string; + /** + * The sub account name this profile belongs to if applicable. + */ + subAccountName?: string; + /** + * The user name. + */ + userName?: string; + } + /** + * Represents the list of user profiles. + */ + export interface Schema$UserProfileList { + /** + * The eTag of this response for caching purposes. + */ + etag?: string; + /** + * The user profiles returned in this response. + */ + items?: Schema$UserProfile[]; + /** + * The kind of list this is, in this case dfareporting#userProfileList. + */ + kind?: string; + } + /** + * Contains properties of auser role, which is used to manage user access. + */ + export interface Schema$UserRole { + /** + * Account ID of this user role. This is a read-only field that can be left + * blank. + */ + accountId?: string; + /** + * Whether this is a default user role. Default user roles are created by + * the system for the account/subaccount and cannot be modified or deleted. + * Each default user role comes with a basic set of preassigned permissions. + */ + defaultUserRole?: boolean; + /** + * ID of this user role. This is a read-only, auto-generated field. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#userRole". + */ + kind?: string; + /** + * Name of this user role. This is a required field. Must be less than 256 + * characters long. If this user role is under a subaccount, the name must + * be unique among sites of the same subaccount. Otherwise, this user role + * is a top-level user role, and the name must be unique among top-level + * user roles of the same account. + */ + name?: string; + /** + * ID of the user role that this user role is based on or copied from. This + * is a required field. + */ + parentUserRoleId?: string; + /** + * List of permissions associated with this user role. + */ + permissions?: Schema$UserRolePermission[]; + /** + * Subaccount ID of this user role. This is a read-only field that can be + * left blank. + */ + subaccountId?: string; + } + /** + * Contains properties of a user role permission. + */ + export interface Schema$UserRolePermission { + /** + * Levels of availability for a user role permission. + */ + availability?: string; + /** + * ID of this user role permission. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#userRolePermission". + */ + kind?: string; + /** + * Name of this user role permission. + */ + name?: string; + /** + * ID of the permission group that this user role permission belongs to. + */ + permissionGroupId?: string; + } + /** + * Represents a grouping of related user role permissions. + */ + export interface Schema$UserRolePermissionGroup { + /** + * ID of this user role permission. + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#userRolePermissionGroup". + */ + kind?: string; + /** + * Name of this user role permission group. + */ + name?: string; + } + /** + * User Role Permission Group List Response + */ + export interface Schema$UserRolePermissionGroupsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#userRolePermissionGroupsListResponse". + */ + kind?: string; + /** + * User role permission group collection. + */ + userRolePermissionGroups?: Schema$UserRolePermissionGroup[]; + } + /** + * User Role Permission List Response + */ + export interface Schema$UserRolePermissionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#userRolePermissionsListResponse". + */ + kind?: string; + /** + * User role permission collection. + */ + userRolePermissions?: Schema$UserRolePermission[]; + } + /** + * User Role List Response + */ + export interface Schema$UserRolesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#userRolesListResponse". + */ + kind?: string; + /** + * Pagination token to be used for the next list operation. + */ + nextPageToken?: string; + /** + * User role collection. + */ + userRoles?: Schema$UserRole[]; + } + /** + * Contains information about supported video formats. + */ + export interface Schema$VideoFormat { + /** + * File type of the video format. + */ + fileType?: string; + /** + * ID of the video format. + */ + id?: number; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#videoFormat". + */ + kind?: string; + /** + * The resolution of this video format. + */ + resolution?: Schema$Size; + /** + * The target bit rate of this video format. + */ + targetBitRate?: number; + } + /** + * Video Format List Response + */ + export interface Schema$VideoFormatsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#videoFormatsListResponse". + */ + kind?: string; + /** + * Video format collection. + */ + videoFormats?: Schema$VideoFormat[]; + } + /** + * Video Offset + */ + export interface Schema$VideoOffset { + /** + * Duration, as a percentage of video duration. Do not set when + * offsetSeconds is set. Acceptable values are 0 to 100, inclusive. + */ + offsetPercentage?: number; + /** + * Duration, in seconds. Do not set when offsetPercentage is set. Acceptable + * values are 0 to 86399, inclusive. + */ + offsetSeconds?: number; + } + /** + * Video Settings + */ + export interface Schema$VideoSettings { + /** + * Settings for the companion creatives of video creatives served to this + * placement. + */ + companionSettings?: Schema$CompanionSetting; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dfareporting#videoSettings". + */ + kind?: string; + /** + * Orientation of a video placement. If this value is set, placement will + * return assets matching the specified orientation. + */ + orientation?: string; + /** + * Settings for the skippability of video creatives served to this + * placement. If this object is provided, the creative-level skippable + * settings will be overridden. + */ + skippableSettings?: Schema$SkippableSetting; + /** + * Settings for the transcodes of video creatives served to this placement. + * If this object is provided, the creative-level transcode settings will be + * overridden. + */ + transcodeSettings?: Schema$TranscodeSetting; + } + + + export class Resource$Accountactiveadsummaries { + constructor() {} + + + /** + * dfareporting.accountActiveAdSummaries.get + * @desc Gets the account's active ad summary by account ID. + * @alias dfareporting.accountActiveAdSummaries.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.summaryAccountId Account ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Accountactiveadsummaries$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Accountactiveadsummaries$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Accountactiveadsummaries$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Accountactiveadsummaries$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Accountactiveadsummaries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountactiveadsummaries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'summaryAccountId'], + pathParams: ['profileId', 'summaryAccountId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accountactiveadsummaries$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Account ID. + */ + summaryAccountId?: string; + } + + + export class Resource$Accountpermissiongroups { + constructor() {} + + + /** + * dfareporting.accountPermissionGroups.get + * @desc Gets one account permission group by ID. + * @alias dfareporting.accountPermissionGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account permission group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Accountpermissiongroups$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Accountpermissiongroups$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Accountpermissiongroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Accountpermissiongroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Accountpermissiongroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissiongroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissionGroups/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accountPermissionGroups.list + * @desc Retrieves the list of account permission groups. + * @alias dfareporting.accountPermissionGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Accountpermissiongroups$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Accountpermissiongroups$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Accountpermissiongroups$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Accountpermissiongroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Accountpermissiongroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissiongroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissionGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Accountpermissiongroups$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Account permission group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountpermissiongroups$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Accountpermissions { + constructor() {} + + + /** + * dfareporting.accountPermissions.get + * @desc Gets one account permission by ID. + * @alias dfareporting.accountPermissions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account permission ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Accountpermissions$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Accountpermissions$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Accountpermissions$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Accountpermissions$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Accountpermissions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissions/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accountPermissions.list + * @desc Retrieves the list of account permissions. + * @alias dfareporting.accountPermissions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Accountpermissions$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Accountpermissions$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Accountpermissions$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Accountpermissions$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Accountpermissions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountpermissions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Accountpermissions$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Account permission ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountpermissions$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Accounts { + constructor() {} + + + /** + * dfareporting.accounts.get + * @desc Gets one account by ID. + * @alias dfareporting.accounts.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Accounts$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Accounts$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Accounts$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Accounts$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accounts/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accounts.list + * @desc Retrieves the list of accounts, possibly filtered. This method + * supports paging. + * @alias dfareporting.accounts.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active accounts. Don't set this field to select both active and non-active accounts. + * @param {string=} params.ids Select only accounts with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "account*2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "account" will match objects with name "my account", "account 2015", or simply "account". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Accounts$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Accounts$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Accounts$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Accounts$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accounts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accounts.patch + * @desc Updates an existing account. This method supports patch semantics. + * @alias dfareporting.accounts.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Account ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Account} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Accounts$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Accounts$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Accounts$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Accounts$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accounts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accounts.update + * @desc Updates an existing account. + * @alias dfareporting.accounts.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Account} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Accounts$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Accounts$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Accounts$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Accounts$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accounts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Account ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accounts$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only active accounts. Don't set this field to select both active + * and non-active accounts. + */ + active?: boolean; + /** + * Select only accounts with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "account*2015" will return objects with names like "account + * June 2015", "account April 2015", or simply "account 2015". Most of the + * searches also add wildcards implicitly at the start and the end of the + * search string. For example, a search string of "account" will match + * objects with name "my account", "account 2015", or simply "account". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Accounts$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Account ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + export interface Params$Resource$Accounts$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + + + export class Resource$Accountuserprofiles { + constructor() {} + + + /** + * dfareporting.accountUserProfiles.get + * @desc Gets one account user profile by ID. + * @alias dfareporting.accountUserProfiles.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User profile ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Accountuserprofiles$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Accountuserprofiles$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Accountuserprofiles$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Accountuserprofiles$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Accountuserprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accountUserProfiles.insert + * @desc Inserts a new account user profile. + * @alias dfareporting.accountUserProfiles.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AccountUserProfile} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Accountuserprofiles$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Accountuserprofiles$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Accountuserprofiles$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Accountuserprofiles$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Accountuserprofiles$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accountUserProfiles.list + * @desc Retrieves a list of account user profiles, possibly filtered. This + * method supports paging. + * @alias dfareporting.accountUserProfiles.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active user profiles. + * @param {string=} params.ids Select only user profiles with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name, ID or email. Wildcards (*) are allowed. For example, "user profile*2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only user profiles with the specified subaccount ID. + * @param {string=} params.userRoleId Select only user profiles with the specified user role ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Accountuserprofiles$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Accountuserprofiles$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Accountuserprofiles$List, + callback: BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Accountuserprofiles$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Accountuserprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.accountUserProfiles.patch + * @desc Updates an existing account user profile. This method supports + * patch semantics. + * @alias dfareporting.accountUserProfiles.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User profile ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AccountUserProfile} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Accountuserprofiles$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Accountuserprofiles$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Accountuserprofiles$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Accountuserprofiles$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Accountuserprofiles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.accountUserProfiles.update + * @desc Updates an existing account user profile. + * @alias dfareporting.accountUserProfiles.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AccountUserProfile} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Accountuserprofiles$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Accountuserprofiles$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Accountuserprofiles$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Accountuserprofiles$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Accountuserprofiles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accountuserprofiles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/accountUserProfiles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accountuserprofiles$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Accountuserprofiles$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + export interface Params$Resource$Accountuserprofiles$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only active user profiles. + */ + active?: boolean; + /** + * Select only user profiles with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or email. Wildcards (*) are + * allowed. For example, "user profile*2015" will return objects with names + * like "user profile June 2015", "user profile April 2015", or simply "user + * profile 2015". Most of the searches also add wildcards implicitly at the + * start and the end of the search string. For example, a search string of + * "user profile" will match objects with name "my user profile", "user + * profile 2015", or simply "user profile". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only user profiles with the specified subaccount ID. + */ + subaccountId?: string; + /** + * Select only user profiles with the specified user role ID. + */ + userRoleId?: string; + } + export interface Params$Resource$Accountuserprofiles$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + export interface Params$Resource$Accountuserprofiles$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountUserProfile; + } + + + export class Resource$Ads { + constructor() {} + + + /** + * dfareporting.ads.get + * @desc Gets one ad by ID. + * @alias dfareporting.ads.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Ad ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Ads$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Ads$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Ads$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Ads$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/ads/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.ads.insert + * @desc Inserts a new ad. + * @alias dfareporting.ads.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Ad} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Ads$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Ads$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Ads$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Ads$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.ads.list + * @desc Retrieves a list of ads, possibly filtered. This method supports + * paging. + * @alias dfareporting.ads.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active ads. + * @param {string=} params.advertiserId Select only ads with this advertiser ID. + * @param {boolean=} params.archived Select only archived ads. + * @param {string=} params.audienceSegmentIds Select only ads with these audience segment IDs. + * @param {string=} params.campaignIds Select only ads with these campaign IDs. + * @param {string=} params.compatibility Select default ads with the specified compatibility. Applicable when type is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an in-stream video ads developed with the VAST standard. + * @param {string=} params.creativeIds Select only ads with these creative IDs assigned. + * @param {string=} params.creativeOptimizationConfigurationIds Select only ads with these creative optimization configuration IDs. + * @param {boolean=} params.dynamicClickTracker Select only dynamic click trackers. Applicable when type is AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If false, select static click trackers. Leave unset to select both. + * @param {string=} params.ids Select only ads with these IDs. + * @param {string=} params.landingPageIds Select only ads with these landing page IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.overriddenEventTagId Select only ads with this event tag override ID. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string=} params.placementIds Select only ads with these placement IDs assigned. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.remarketingListIds Select only ads whose list targeting expression use these remarketing list IDs. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "ad*2015" will return objects with names like "ad June 2015", "ad April 2015", or simply "ad 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "ad" will match objects with name "my ad", "ad 2015", or simply "ad". + * @param {string=} params.sizeIds Select only ads with these size IDs. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {boolean=} params.sslCompliant Select only ads that are SSL-compliant. + * @param {boolean=} params.sslRequired Select only ads that require SSL. + * @param {string=} params.type Select only ads with these types. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Ads$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Ads$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Ads$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Ads$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.ads.patch + * @desc Updates an existing ad. This method supports patch semantics. + * @alias dfareporting.ads.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Ad ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Ad} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Ads$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Ads$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Ads$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Ads$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.ads.update + * @desc Updates an existing ad. + * @alias dfareporting.ads.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Ad} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Ads$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Ads$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Ads$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Ads$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Ads$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Ads$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}/ads') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Ads$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Ad ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Ads$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + export interface Params$Resource$Ads$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only active ads. + */ + active?: boolean; + /** + * Select only ads with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only archived ads. + */ + archived?: boolean; + /** + * Select only ads with these audience segment IDs. + */ + audienceSegmentIds?: string[]; + /** + * Select only ads with these campaign IDs. + */ + campaignIds?: string[]; + /** + * Select default ads with the specified compatibility. Applicable when type + * is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to + * rendering either on desktop or on mobile devices for regular or + * interstitial ads, respectively. APP and APP_INTERSTITIAL are for + * rendering in mobile apps. IN_STREAM_VIDEO refers to rendering an + * in-stream video ads developed with the VAST standard. + */ + compatibility?: string; + /** + * Select only ads with these creative IDs assigned. + */ + creativeIds?: string[]; + /** + * Select only ads with these creative optimization configuration IDs. + */ + creativeOptimizationConfigurationIds?: string[]; + /** + * Select only dynamic click trackers. Applicable when type is + * AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If + * false, select static click trackers. Leave unset to select both. + */ + dynamicClickTracker?: boolean; + /** + * Select only ads with these IDs. + */ + ids?: string[]; + /** + * Select only ads with these landing page IDs. + */ + landingPageIds?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only ads with this event tag override ID. + */ + overriddenEventTagId?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only ads with these placement IDs assigned. + */ + placementIds?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only ads whose list targeting expression use these remarketing + * list IDs. + */ + remarketingListIds?: string[]; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "ad*2015" will return objects with names like "ad June + * 2015", "ad April 2015", or simply "ad 2015". Most of the searches also + * add wildcards implicitly at the start and the end of the search string. + * For example, a search string of "ad" will match objects with name "my + * ad", "ad 2015", or simply "ad". + */ + searchString?: string; + /** + * Select only ads with these size IDs. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only ads that are SSL-compliant. + */ + sslCompliant?: boolean; + /** + * Select only ads that require SSL. + */ + sslRequired?: boolean; + /** + * Select only ads with these types. + */ + type?: string[]; + } + export interface Params$Resource$Ads$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Ad ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + export interface Params$Resource$Ads$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Ad; + } + + + export class Resource$Advertisergroups { + constructor() {} + + + /** + * dfareporting.advertiserGroups.delete + * @desc Deletes an existing advertiser group. + * @alias dfareporting.advertiserGroups.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Advertisergroups$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Advertisergroups$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Advertisergroups$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Advertisergroups$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertiserGroups.get + * @desc Gets one advertiser group by ID. + * @alias dfareporting.advertiserGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Advertisergroups$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Advertisergroups$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Advertisergroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Advertisergroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertiserGroups.insert + * @desc Inserts a new advertiser group. + * @alias dfareporting.advertiserGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AdvertiserGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Advertisergroups$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Advertisergroups$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Advertisergroups$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Advertisergroups$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertiserGroups.list + * @desc Retrieves a list of advertiser groups, possibly filtered. This + * method supports paging. + * @alias dfareporting.advertiserGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only advertiser groups with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Advertisergroups$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Advertisergroups$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Advertisergroups$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Advertisergroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisergroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.advertiserGroups.patch + * @desc Updates an existing advertiser group. This method supports patch + * semantics. + * @alias dfareporting.advertiserGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AdvertiserGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Advertisergroups$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Advertisergroups$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Advertisergroups$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Advertisergroups$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertiserGroups.update + * @desc Updates an existing advertiser group. + * @alias dfareporting.advertiserGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().AdvertiserGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Advertisergroups$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Advertisergroups$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Advertisergroups$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Advertisergroups$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisergroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisergroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisergroups$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisergroups$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisergroups$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + export interface Params$Resource$Advertisergroups$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only advertiser groups with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "advertiser*2015" will return objects with names like + * "advertiser group June 2015", "advertiser group April 2015", or simply + * "advertiser group 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "advertisergroup" will match objects with name "my + * advertisergroup", "advertisergroup 2015", or simply "advertisergroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Advertisergroups$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Advertiser group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + export interface Params$Resource$Advertisergroups$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AdvertiserGroup; + } + + + export class Resource$Advertiserlandingpages { + constructor() {} + + + /** + * dfareporting.advertiserLandingPages.get + * @desc Gets one landing page by ID. + * @alias dfareporting.advertiserLandingPages.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Landing page ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Advertiserlandingpages$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Advertiserlandingpages$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Advertiserlandingpages$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Advertiserlandingpages$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Advertiserlandingpages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertiserLandingPages.insert + * @desc Inserts a new landing page. + * @alias dfareporting.advertiserLandingPages.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().LandingPage} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Advertiserlandingpages$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Advertiserlandingpages$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Advertiserlandingpages$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Advertiserlandingpages$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertiserLandingPages.list + * @desc Retrieves a list of landing pages. + * @alias dfareporting.advertiserLandingPages.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only landing pages that belong to these advertisers. + * @param {boolean=} params.archived Select only archived landing pages. Don't set this field to select both archived and non-archived landing pages. + * @param {string=} params.campaignIds Select only landing pages that are associated with these campaigns. + * @param {string=} params.ids Select only landing pages with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only landing pages that belong to this subaccount. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Advertiserlandingpages$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Advertiserlandingpages$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Advertiserlandingpages$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Advertiserlandingpages$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Advertiserlandingpages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.advertiserLandingPages.patch + * @desc Updates an existing landing page. This method supports patch + * semantics. + * @alias dfareporting.advertiserLandingPages.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Landing page ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().LandingPage} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Advertiserlandingpages$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Advertiserlandingpages$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Advertiserlandingpages$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Advertiserlandingpages$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Advertiserlandingpages$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertiserLandingPages.update + * @desc Updates an existing landing page. + * @alias dfareporting.advertiserLandingPages.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().LandingPage} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Advertiserlandingpages$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Advertiserlandingpages$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Advertiserlandingpages$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Advertiserlandingpages$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Advertiserlandingpages$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertiserlandingpages$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertiserLandingPages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertiserlandingpages$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Landing page ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertiserlandingpages$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + export interface Params$Resource$Advertiserlandingpages$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only landing pages that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived landing pages. Don't set this field to select both + * archived and non-archived landing pages. + */ + archived?: boolean; + /** + * Select only landing pages that are associated with these campaigns. + */ + campaignIds?: string[]; + /** + * Select only landing pages with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for landing pages by name or ID. Wildcards (*) are + * allowed. For example, "landingpage*2017" will return landing pages with + * names like "landingpage July 2017", "landingpage March 2017", or simply + * "landingpage 2017". Most of the searches also add wildcards implicitly at + * the start and the end of the search string. For example, a search string + * of "landingpage" will match campaigns with name "my landingpage", + * "landingpage 2015", or simply "landingpage". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only landing pages that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Advertiserlandingpages$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Landing page ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + export interface Params$Resource$Advertiserlandingpages$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LandingPage; + } + + + export class Resource$Advertisers { + constructor() {} + + + /** + * dfareporting.advertisers.get + * @desc Gets one advertiser by ID. + * @alias dfareporting.advertisers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Advertisers$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Advertisers$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Advertisers$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Advertisers$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertisers.insert + * @desc Inserts a new advertiser. + * @alias dfareporting.advertisers.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Advertiser} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Advertisers$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Advertisers$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Advertisers$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Advertisers$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisers$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertisers.list + * @desc Retrieves a list of advertisers, possibly filtered. This method + * supports paging. + * @alias dfareporting.advertisers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserGroupIds Select only advertisers with these advertiser group IDs. + * @param {string=} params.floodlightConfigurationIds Select only advertisers with these floodlight configuration IDs. + * @param {string=} params.ids Select only advertisers with these IDs. + * @param {boolean=} params.includeAdvertisersWithoutGroupsOnly Select only advertisers which do not belong to any advertiser group. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {boolean=} params.onlyParent Select only advertisers which use another advertiser's floodlight configuration. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.status Select only advertisers with the specified status. + * @param {string=} params.subaccountId Select only advertisers with these subaccount IDs. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Advertisers$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Advertisers$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Advertisers$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Advertisers$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertisers.patch + * @desc Updates an existing advertiser. This method supports patch + * semantics. + * @alias dfareporting.advertisers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Advertiser ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Advertiser} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Advertisers$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Advertisers$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Advertisers$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.advertisers.update + * @desc Updates an existing advertiser. + * @alias dfareporting.advertisers.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Advertiser} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Advertisers$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Advertisers$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Advertisers$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Advertisers$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Advertisers$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/advertisers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Advertiser ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Advertisers$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only advertisers with these advertiser group IDs. + */ + advertiserGroupIds?: string[]; + /** + * Select only advertisers with these floodlight configuration IDs. + */ + floodlightConfigurationIds?: string[]; + /** + * Select only advertisers with these IDs. + */ + ids?: string[]; + /** + * Select only advertisers which do not belong to any advertiser group. + */ + includeAdvertisersWithoutGroupsOnly?: boolean; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only advertisers which use another advertiser's floodlight + * configuration. + */ + onlyParent?: boolean; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "advertiser*2015" will return objects with names like + * "advertiser June 2015", "advertiser April 2015", or simply "advertiser + * 2015". Most of the searches also add wildcards implicitly at the start + * and the end of the search string. For example, a search string of + * "advertiser" will match objects with name "my advertiser", "advertiser + * 2015", or simply "advertiser". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only advertisers with the specified status. + */ + status?: string; + /** + * Select only advertisers with these subaccount IDs. + */ + subaccountId?: string; + } + export interface Params$Resource$Advertisers$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Advertiser ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + + + export class Resource$Browsers { + constructor() {} + + + /** + * dfareporting.browsers.list + * @desc Retrieves a list of browsers. + * @alias dfareporting.browsers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Browsers$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Browsers$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Browsers$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Browsers$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Browsers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Browsers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/browsers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Browsers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Campaigncreativeassociations { + constructor() {} + + + /** + * dfareporting.campaignCreativeAssociations.insert + * @desc Associates a creative with the specified campaign. This method + * creates a default ad with dimensions matching the creative in the + * campaign if such a default ad does not exist already. + * @alias dfareporting.campaignCreativeAssociations.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.campaignId Campaign ID in this association. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CampaignCreativeAssociation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Campaigncreativeassociations$Insert, + options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + insert( + params: Params$Resource$Campaigncreativeassociations$Insert, + callback: BodyResponseCallback): + void; + insert(callback: BodyResponseCallback): + void; + insert( + paramsOrCallback?: Params$Resource$Campaigncreativeassociations$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Campaigncreativeassociations$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigncreativeassociations$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId', 'campaignId'], + pathParams: ['campaignId', 'profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.campaignCreativeAssociations.list + * @desc Retrieves the list of creative IDs associated with the specified + * campaign. This method supports paging. + * @alias dfareporting.campaignCreativeAssociations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.campaignId Campaign ID in this association. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Campaigncreativeassociations$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Campaigncreativeassociations$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse>): void; + list( + params: Params$Resource$Campaigncreativeassociations$List, + callback: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse>): void; + list(callback: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse>): void; + list( + paramsOrCallback?: Params$Resource$Campaigncreativeassociations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$CampaignCreativeAssociationsListResponse>): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Campaigncreativeassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigncreativeassociations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'campaignId'], + pathParams: ['campaignId', 'profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$CampaignCreativeAssociationsListResponse>(parameters); + } + } + } + + export interface Params$Resource$Campaigncreativeassociations$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Campaign ID in this association. + */ + campaignId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CampaignCreativeAssociation; + } + export interface Params$Resource$Campaigncreativeassociations$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Campaign ID in this association. + */ + campaignId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + export class Resource$Campaigns { + constructor() {} + + + /** + * dfareporting.campaigns.get + * @desc Gets one campaign by ID. + * @alias dfareporting.campaigns.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Campaign ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Campaigns$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Campaigns$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Campaigns$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Campaigns$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.campaigns.insert + * @desc Inserts a new campaign. + * @alias dfareporting.campaigns.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Campaign} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Campaigns$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Campaigns$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Campaigns$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Campaigns$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.campaigns.list + * @desc Retrieves a list of campaigns, possibly filtered. This method + * supports paging. + * @alias dfareporting.campaigns.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserGroupIds Select only campaigns whose advertisers belong to these advertiser groups. + * @param {string=} params.advertiserIds Select only campaigns that belong to these advertisers. + * @param {boolean=} params.archived Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. + * @param {boolean=} params.atLeastOneOptimizationActivity Select only campaigns that have at least one optimization activity. + * @param {string=} params.excludedIds Exclude campaigns with these IDs. + * @param {string=} params.ids Select only campaigns with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.overriddenEventTagId Select only campaigns that have overridden this event tag ID. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only campaigns that belong to this subaccount. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Campaigns$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Campaigns$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Campaigns$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Campaigns$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.campaigns.patch + * @desc Updates an existing campaign. This method supports patch semantics. + * @alias dfareporting.campaigns.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Campaign ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Campaign} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Campaigns$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Campaigns$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Campaigns$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Campaigns$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.campaigns.update + * @desc Updates an existing campaign. + * @alias dfareporting.campaigns.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Campaign} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Campaigns$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Campaigns$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Campaigns$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Campaigns$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Campaigns$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Campaigns$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/campaigns') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Campaigns$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Campaign ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Campaigns$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Campaigns$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only campaigns whose advertisers belong to these advertiser + * groups. + */ + advertiserGroupIds?: string[]; + /** + * Select only campaigns that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived campaigns. Don't set this field to select both + * archived and non-archived campaigns. + */ + archived?: boolean; + /** + * Select only campaigns that have at least one optimization activity. + */ + atLeastOneOptimizationActivity?: boolean; + /** + * Exclude campaigns with these IDs. + */ + excludedIds?: string[]; + /** + * Select only campaigns with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only campaigns that have overridden this event tag ID. + */ + overriddenEventTagId?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for campaigns by name or ID. Wildcards (*) are allowed. + * For example, "campaign*2015" will return campaigns with names like + * "campaign June 2015", "campaign April 2015", or simply "campaign 2015". + * Most of the searches also add wildcards implicitly at the start and the + * end of the search string. For example, a search string of "campaign" will + * match campaigns with name "my campaign", "campaign 2015", or simply + * "campaign". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only campaigns that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Campaigns$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Campaign ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Campaigns$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + + + export class Resource$Changelogs { + constructor() {} + + + /** + * dfareporting.changeLogs.get + * @desc Gets one change log by ID. + * @alias dfareporting.changeLogs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Change log ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Changelogs$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Changelogs$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Changelogs$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Changelogs$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Changelogs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/changeLogs/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.changeLogs.list + * @desc Retrieves a list of change logs. This method supports paging. + * @alias dfareporting.changeLogs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.action Select only change logs with the specified action. + * @param {string=} params.ids Select only change logs with these IDs. + * @param {string=} params.maxChangeTime Select only change logs whose change time is before the specified maxChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.minChangeTime Select only change logs whose change time is before the specified minChangeTime.The time should be formatted as an RFC3339 date/time string. For example, for 10:54 PM on July 18th, 2015, in the America/New York time zone, the format is "2015-07-18T22:54:00-04:00". In other words, the year, month, day, the letter T, the hour (24-hour clock system), minute, second, and then the time zone offset. + * @param {string=} params.objectIds Select only change logs with these object IDs. + * @param {string=} params.objectType Select only change logs with the specified object type. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Select only change logs whose object ID, user name, old or new values match the search string. + * @param {string=} params.userProfileIds Select only change logs with these user profile IDs. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Changelogs$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Changelogs$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Changelogs$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Changelogs$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Changelogs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Changelogs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/changeLogs') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Changelogs$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Change log ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Changelogs$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only change logs with the specified action. + */ + action?: string; + /** + * Select only change logs with these IDs. + */ + ids?: string[]; + /** + * Select only change logs whose change time is before the specified + * maxChangeTime.The time should be formatted as an RFC3339 date/time + * string. For example, for 10:54 PM on July 18th, 2015, in the America/New + * York time zone, the format is "2015-07-18T22:54:00-04:00". In other + * words, the year, month, day, the letter T, the hour (24-hour clock + * system), minute, second, and then the time zone offset. + */ + maxChangeTime?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only change logs whose change time is before the specified + * minChangeTime.The time should be formatted as an RFC3339 date/time + * string. For example, for 10:54 PM on July 18th, 2015, in the America/New + * York time zone, the format is "2015-07-18T22:54:00-04:00". In other + * words, the year, month, day, the letter T, the hour (24-hour clock + * system), minute, second, and then the time zone offset. + */ + minChangeTime?: string; + /** + * Select only change logs with these object IDs. + */ + objectIds?: string[]; + /** + * Select only change logs with the specified object type. + */ + objectType?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only change logs whose object ID, user name, old or new values + * match the search string. + */ + searchString?: string; + /** + * Select only change logs with these user profile IDs. + */ + userProfileIds?: string[]; + } + + + export class Resource$Cities { + constructor() {} + + + /** + * dfareporting.cities.list + * @desc Retrieves a list of cities, possibly filtered. + * @alias dfareporting.cities.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.countryDartIds Select only cities from these countries. + * @param {string=} params.dartIds Select only cities with these DART IDs. + * @param {string=} params.namePrefix Select only cities with names starting with this prefix. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.regionDartIds Select only cities from these regions. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Cities$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Cities$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Cities$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Cities$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Cities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Cities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/cities') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Cities$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only cities from these countries. + */ + countryDartIds?: string[]; + /** + * Select only cities with these DART IDs. + */ + dartIds?: string[]; + /** + * Select only cities with names starting with this prefix. + */ + namePrefix?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only cities from these regions. + */ + regionDartIds?: string[]; + } + + + export class Resource$Connectiontypes { + constructor() {} + + + /** + * dfareporting.connectionTypes.get + * @desc Gets one connection type by ID. + * @alias dfareporting.connectionTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Connection type ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Connectiontypes$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Connectiontypes$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Connectiontypes$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Connectiontypes$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Connectiontypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Connectiontypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/connectionTypes/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.connectionTypes.list + * @desc Retrieves a list of connection types. + * @alias dfareporting.connectionTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Connectiontypes$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Connectiontypes$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Connectiontypes$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Connectiontypes$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Connectiontypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Connectiontypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/connectionTypes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Connectiontypes$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Connection type ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Connectiontypes$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Contentcategories { + constructor() {} + + + /** + * dfareporting.contentCategories.delete + * @desc Deletes an existing content category. + * @alias dfareporting.contentCategories.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Content category ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Contentcategories$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Contentcategories$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Contentcategories$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Contentcategories$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Contentcategories$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.contentCategories.get + * @desc Gets one content category by ID. + * @alias dfareporting.contentCategories.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Content category ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Contentcategories$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Contentcategories$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Contentcategories$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Contentcategories$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Contentcategories$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.contentCategories.insert + * @desc Inserts a new content category. + * @alias dfareporting.contentCategories.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ContentCategory} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Contentcategories$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Contentcategories$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Contentcategories$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Contentcategories$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Contentcategories$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.contentCategories.list + * @desc Retrieves a list of content categories, possibly filtered. This + * method supports paging. + * @alias dfareporting.contentCategories.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only content categories with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "contentcategory*2015" will return objects with names like "contentcategory June 2015", "contentcategory April 2015", or simply "contentcategory 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "contentcategory" will match objects with name "my contentcategory", "contentcategory 2015", or simply "contentcategory". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Contentcategories$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Contentcategories$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Contentcategories$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Contentcategories$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Contentcategories$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.contentCategories.patch + * @desc Updates an existing content category. This method supports patch + * semantics. + * @alias dfareporting.contentCategories.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Content category ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ContentCategory} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Contentcategories$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Contentcategories$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Contentcategories$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Contentcategories$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Contentcategories$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.contentCategories.update + * @desc Updates an existing content category. + * @alias dfareporting.contentCategories.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ContentCategory} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Contentcategories$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Contentcategories$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Contentcategories$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Contentcategories$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Contentcategories$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Contentcategories$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/contentCategories') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Contentcategories$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Contentcategories$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Contentcategories$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + export interface Params$Resource$Contentcategories$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only content categories with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "contentcategory*2015" will return objects with names like + * "contentcategory June 2015", "contentcategory April 2015", or simply + * "contentcategory 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "contentcategory" will match objects with name "my + * contentcategory", "contentcategory 2015", or simply "contentcategory". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Contentcategories$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Content category ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + export interface Params$Resource$Contentcategories$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ContentCategory; + } + + + export class Resource$Conversions { + constructor() {} + + + /** + * dfareporting.conversions.batchinsert + * @desc Inserts conversions. + * @alias dfareporting.conversions.batchinsert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ConversionsBatchInsertRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + batchinsert( + params?: Params$Resource$Conversions$Batchinsert, + options?: MethodOptions): + GaxiosPromise; + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + batchinsert( + params: Params$Resource$Conversions$Batchinsert, + callback: BodyResponseCallback): + void; + batchinsert( + callback: BodyResponseCallback): + void; + batchinsert( + paramsOrCallback?: Params$Resource$Conversions$Batchinsert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Conversions$Batchinsert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Conversions$Batchinsert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/conversions/batchinsert') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.conversions.batchupdate + * @desc Updates existing conversions. + * @alias dfareporting.conversions.batchupdate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().ConversionsBatchUpdateRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + batchupdate( + params?: Params$Resource$Conversions$Batchupdate, + options?: MethodOptions): + GaxiosPromise; + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + batchupdate( + params: Params$Resource$Conversions$Batchupdate, + callback: BodyResponseCallback): + void; + batchupdate( + callback: BodyResponseCallback): + void; + batchupdate( + paramsOrCallback?: Params$Resource$Conversions$Batchupdate| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Conversions$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Conversions$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/conversions/batchupdate') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Conversions$Batchinsert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConversionsBatchInsertRequest; + } + export interface Params$Resource$Conversions$Batchupdate extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ConversionsBatchUpdateRequest; + } + + + export class Resource$Countries { + constructor() {} + + + /** + * dfareporting.countries.get + * @desc Gets one country by ID. + * @alias dfareporting.countries.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dartId Country DART ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Countries$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Countries$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Countries$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Countries$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Countries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Countries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/countries/{dartId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'dartId'], + pathParams: ['dartId', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.countries.list + * @desc Retrieves a list of countries. + * @alias dfareporting.countries.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Countries$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Countries$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Countries$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Countries$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Countries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Countries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/countries') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Countries$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Country DART ID. + */ + dartId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Countries$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Creativeassets { + constructor() {} + + + /** + * dfareporting.creativeAssets.insert + * @desc Inserts a new creative asset. + * @alias dfareporting.creativeAssets.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Advertiser ID of this creative. This is a required field. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} params.resource Media resource metadata + * @param {object} params.media Media object + * @param {string} params.media.mimeType Media mime-type + * @param {string|object} params.media.body Media body contents + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativeassets$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Creativeassets$Insert, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Creativeassets$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Creativeassets$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativeassets$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativeassets$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + mediaUrl: + (rootUrl + + '/upload/dfareporting/v3.3/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets') + .replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['advertiserId', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativeassets$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Advertiser ID of this creative. This is a required field. + */ + advertiserId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeAssetMetadata; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mediaType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + + export class Resource$Creativefields { + constructor() {} + + + /** + * dfareporting.creativeFields.delete + * @desc Deletes an existing creative field. + * @alias dfareporting.creativeFields.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative Field ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Creativefields$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Creativefields$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Creativefields$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Creativefields$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefields$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFields.get + * @desc Gets one creative field by ID. + * @alias dfareporting.creativeFields.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative Field ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Creativefields$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Creativefields$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Creativefields$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Creativefields$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefields$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFields.insert + * @desc Inserts a new creative field. + * @alias dfareporting.creativeFields.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeField} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativefields$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Creativefields$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Creativefields$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Creativefields$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefields$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFields.list + * @desc Retrieves a list of creative fields, possibly filtered. This method + * supports paging. + * @alias dfareporting.creativeFields.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only creative fields that belong to these advertisers. + * @param {string=} params.ids Select only creative fields with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for creative fields by name or ID. Wildcards (*) are allowed. For example, "creativefield*2015" will return creative fields with names like "creativefield June 2015", "creativefield April 2015", or simply "creativefield 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativefield" will match creative fields with the name "my creativefield", "creativefield 2015", or simply "creativefield". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Creativefields$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Creativefields$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Creativefields$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Creativefields$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefields$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFields.patch + * @desc Updates an existing creative field. This method supports patch + * semantics. + * @alias dfareporting.creativeFields.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative Field ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeField} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Creativefields$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Creativefields$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Creativefields$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Creativefields$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefields$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFields.update + * @desc Updates an existing creative field. + * @alias dfareporting.creativeFields.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeField} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Creativefields$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Creativefields$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Creativefields$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Creativefields$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefields$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefields$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativefields$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefields$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefields$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + export interface Params$Resource$Creativefields$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only creative fields that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only creative fields with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative fields by name or ID. Wildcards (*) are + * allowed. For example, "creativefield*2015" will return creative fields + * with names like "creativefield June 2015", "creativefield April 2015", or + * simply "creativefield 2015". Most of the searches also add wild-cards + * implicitly at the start and the end of the search string. For example, a + * search string of "creativefield" will match creative fields with the name + * "my creativefield", "creativefield 2015", or simply "creativefield". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativefields$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative Field ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + export interface Params$Resource$Creativefields$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeField; + } + + + export class Resource$Creativefieldvalues { + constructor() {} + + + /** + * dfareporting.creativeFieldValues.delete + * @desc Deletes an existing creative field value. + * @alias dfareporting.creativeFieldValues.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.id Creative Field Value ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Creativefieldvalues$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Creativefieldvalues$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Creativefieldvalues$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Creativefieldvalues$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Creativefieldvalues$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFieldValues.get + * @desc Gets one creative field value by ID. + * @alias dfareporting.creativeFieldValues.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.id Creative Field Value ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Creativefieldvalues$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Creativefieldvalues$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Creativefieldvalues$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Creativefieldvalues$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefieldvalues$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFieldValues.insert + * @desc Inserts a new creative field value. + * @alias dfareporting.creativeFieldValues.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeFieldValue} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativefieldvalues$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Creativefieldvalues$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Creativefieldvalues$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Creativefieldvalues$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Creativefieldvalues$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFieldValues.list + * @desc Retrieves a list of creative field values, possibly filtered. This + * method supports paging. + * @alias dfareporting.creativeFieldValues.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string=} params.ids Select only creative field values with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for creative field values by their values. Wildcards (e.g. *) are not allowed. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Creativefieldvalues$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Creativefieldvalues$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Creativefieldvalues$List, + callback: BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Creativefieldvalues$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefieldvalues$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.creativeFieldValues.patch + * @desc Updates an existing creative field value. This method supports + * patch semantics. + * @alias dfareporting.creativeFieldValues.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.id Creative Field Value ID + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeFieldValue} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Creativefieldvalues$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Creativefieldvalues$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Creativefieldvalues$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Creativefieldvalues$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativefieldvalues$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'creativeFieldId', 'id'], + pathParams: ['creativeFieldId', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeFieldValues.update + * @desc Updates an existing creative field value. + * @alias dfareporting.creativeFieldValues.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.creativeFieldId Creative field ID for this creative field value. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeFieldValue} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Creativefieldvalues$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Creativefieldvalues$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Creativefieldvalues$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Creativefieldvalues$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Creativefieldvalues$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativefieldvalues$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId', 'creativeFieldId'], + pathParams: ['creativeFieldId', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativefieldvalues$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefieldvalues$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativefieldvalues$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + export interface Params$Resource$Creativefieldvalues$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Select only creative field values with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative field values by their values. Wildcards + * (e.g. *) are not allowed. + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativefieldvalues$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * Creative Field Value ID + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + export interface Params$Resource$Creativefieldvalues$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative field ID for this creative field value. + */ + creativeFieldId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeFieldValue; + } + + + export class Resource$Creativegroups { + constructor() {} + + + /** + * dfareporting.creativeGroups.get + * @desc Gets one creative group by ID. + * @alias dfareporting.creativeGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Creativegroups$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Creativegroups$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Creativegroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Creativegroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeGroups.insert + * @desc Inserts a new creative group. + * @alias dfareporting.creativeGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Creativegroups$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Creativegroups$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Creativegroups$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Creativegroups$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativegroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeGroups.list + * @desc Retrieves a list of creative groups, possibly filtered. This method + * supports paging. + * @alias dfareporting.creativeGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only creative groups that belong to these advertisers. + * @param {integer=} params.groupNumber Select only creative groups that belong to this subgroup. + * @param {string=} params.ids Select only creative groups with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for creative groups by name or ID. Wildcards (*) are allowed. For example, "creativegroup*2015" will return creative groups with names like "creativegroup June 2015", "creativegroup April 2015", or simply "creativegroup 2015". Most of the searches also add wild-cards implicitly at the start and the end of the search string. For example, a search string of "creativegroup" will match creative groups with the name "my creativegroup", "creativegroup 2015", or simply "creativegroup". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Creativegroups$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Creativegroups$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Creativegroups$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Creativegroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeGroups.patch + * @desc Updates an existing creative group. This method supports patch + * semantics. + * @alias dfareporting.creativeGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Creativegroups$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Creativegroups$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Creativegroups$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Creativegroups$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativegroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creativeGroups.update + * @desc Updates an existing creative group. + * @alias dfareporting.creativeGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().CreativeGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Creativegroups$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Creativegroups$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Creativegroups$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Creativegroups$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Creativegroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creativegroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creativeGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creativegroups$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creativegroups$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + export interface Params$Resource$Creativegroups$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only creative groups that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only creative groups that belong to this subgroup. + */ + groupNumber?: number; + /** + * Select only creative groups with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for creative groups by name or ID. Wildcards (*) are + * allowed. For example, "creativegroup*2015" will return creative groups + * with names like "creativegroup June 2015", "creativegroup April 2015", or + * simply "creativegroup 2015". Most of the searches also add wild-cards + * implicitly at the start and the end of the search string. For example, a + * search string of "creativegroup" will match creative groups with the name + * "my creativegroup", "creativegroup 2015", or simply "creativegroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Creativegroups$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + export interface Params$Resource$Creativegroups$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreativeGroup; + } + + + export class Resource$Creatives { + constructor() {} + + + /** + * dfareporting.creatives.get + * @desc Gets one creative by ID. + * @alias dfareporting.creatives.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Creatives$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Creatives$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Creatives$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Creatives$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creatives/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creatives.insert + * @desc Inserts a new creative. + * @alias dfareporting.creatives.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Creative} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Creatives$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Creatives$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Creatives$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Creatives$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creatives') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creatives.list + * @desc Retrieves a list of creatives, possibly filtered. This method + * supports paging. + * @alias dfareporting.creatives.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active creatives. Leave blank to select active and inactive creatives. + * @param {string=} params.advertiserId Select only creatives with this advertiser ID. + * @param {boolean=} params.archived Select only archived creatives. Leave blank to select archived and unarchived creatives. + * @param {string=} params.campaignId Select only creatives with this campaign ID. + * @param {string=} params.companionCreativeIds Select only in-stream video creatives with these companion IDs. + * @param {string=} params.creativeFieldIds Select only creatives with these creative field IDs. + * @param {string=} params.ids Select only creatives with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.renderingIds Select only creatives with these rendering IDs. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "creative*2015" will return objects with names like "creative June 2015", "creative April 2015", or simply "creative 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "creative" will match objects with name "my creative", "creative 2015", or simply "creative". + * @param {string=} params.sizeIds Select only creatives with these size IDs. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.studioCreativeId Select only creatives corresponding to this Studio creative ID. + * @param {string=} params.types Select only creatives with these creative types. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Creatives$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Creatives$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Creatives$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Creatives$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creatives') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creatives.patch + * @desc Updates an existing creative. This method supports patch semantics. + * @alias dfareporting.creatives.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Creative ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Creative} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Creatives$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Creatives$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Creatives$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Creatives$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creatives') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.creatives.update + * @desc Updates an existing creative. + * @alias dfareporting.creatives.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Creative} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Creatives$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Creatives$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Creatives$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Creatives$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Creatives$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Creatives$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/creatives') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Creatives$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Creatives$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Creatives$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only active creatives. Leave blank to select active and inactive + * creatives. + */ + active?: boolean; + /** + * Select only creatives with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only archived creatives. Leave blank to select archived and + * unarchived creatives. + */ + archived?: boolean; + /** + * Select only creatives with this campaign ID. + */ + campaignId?: string; + /** + * Select only in-stream video creatives with these companion IDs. + */ + companionCreativeIds?: string[]; + /** + * Select only creatives with these creative field IDs. + */ + creativeFieldIds?: string[]; + /** + * Select only creatives with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only creatives with these rendering IDs. + */ + renderingIds?: string[]; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "creative*2015" will return objects with names like + * "creative June 2015", "creative April 2015", or simply "creative 2015". + * Most of the searches also add wildcards implicitly at the start and the + * end of the search string. For example, a search string of "creative" will + * match objects with name "my creative", "creative 2015", or simply + * "creative". + */ + searchString?: string; + /** + * Select only creatives with these size IDs. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only creatives corresponding to this Studio creative ID. + */ + studioCreativeId?: string; + /** + * Select only creatives with these creative types. + */ + types?: string[]; + } + export interface Params$Resource$Creatives$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Creative ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Creatives$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + + + export class Resource$Dimensionvalues { + constructor() {} + + + /** + * dfareporting.dimensionValues.query + * @desc Retrieves list of report dimension values for a list of filters. + * @alias dfareporting.dimensionValues.query + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA user profile ID. + * @param {().DimensionValueRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + query( + params?: Params$Resource$Dimensionvalues$Query, + options?: MethodOptions): GaxiosPromise; + query( + params: Params$Resource$Dimensionvalues$Query, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + query( + params: Params$Resource$Dimensionvalues$Query, + callback: BodyResponseCallback): void; + query(callback: BodyResponseCallback): void; + query( + paramsOrCallback?: Params$Resource$Dimensionvalues$Query| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Dimensionvalues$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dimensionvalues$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dimensionvalues/query') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Dimensionvalues$Query extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DimensionValueRequest; + } + + + export class Resource$Directorysites { + constructor() {} + + + /** + * dfareporting.directorySites.get + * @desc Gets one directory site by ID. + * @alias dfareporting.directorySites.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Directory site ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Directorysites$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Directorysites$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Directorysites$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Directorysites$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Directorysites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/directorySites/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.directorySites.insert + * @desc Inserts a new directory site. + * @alias dfareporting.directorySites.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().DirectorySite} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Directorysites$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Directorysites$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Directorysites$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Directorysites$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Directorysites$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/directorySites') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.directorySites.list + * @desc Retrieves a list of directory sites, possibly filtered. This method + * supports paging. + * @alias dfareporting.directorySites.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsPublisherPaidPlacements Select only directory sites that accept publisher paid placements. This field can be left blank. + * @param {boolean=} params.active Select only active directory sites. Leave blank to retrieve both active and inactive directory sites. + * @param {string=} params.dfpNetworkCode Select only directory sites with this Ad Manager network code. + * @param {string=} params.ids Select only directory sites with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Directorysites$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Directorysites$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Directorysites$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Directorysites$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Directorysites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Directorysites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/directorySites') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Directorysites$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Directory site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Directorysites$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DirectorySite; + } + export interface Params$Resource$Directorysites$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * This search filter is no longer supported and will have no effect on the + * results returned. + */ + acceptsInStreamVideoPlacements?: boolean; + /** + * This search filter is no longer supported and will have no effect on the + * results returned. + */ + acceptsInterstitialPlacements?: boolean; + /** + * Select only directory sites that accept publisher paid placements. This + * field can be left blank. + */ + acceptsPublisherPaidPlacements?: boolean; + /** + * Select only active directory sites. Leave blank to retrieve both active + * and inactive directory sites. + */ + active?: boolean; + /** + * Select only directory sites with this Ad Manager network code. + */ + dfpNetworkCode?: string; + /** + * Select only directory sites with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or URL. Wildcards (*) are + * allowed. For example, "directory site*2015" will return objects with + * names like "directory site June 2015", "directory site April 2015", or + * simply "directory site 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "directory site" will match objects with name "my + * directory site", "directory site 2015" or simply, "directory site". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + export class Resource$Dynamictargetingkeys { + constructor() {} + + + /** + * dfareporting.dynamicTargetingKeys.delete + * @desc Deletes an existing dynamic targeting key. + * @alias dfareporting.dynamicTargetingKeys.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of this dynamic targeting key. This is a required field. Must be less than 256 characters long and cannot contain commas. All characters are converted to lowercase. + * @param {string} params.objectId ID of the object of this dynamic targeting key. This is a required field. + * @param {string} params.objectType Type of the object of this dynamic targeting key. This is a required field. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Dynamictargetingkeys$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Dynamictargetingkeys$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Dynamictargetingkeys$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Dynamictargetingkeys$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Dynamictargetingkeys$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'objectId', 'name', 'objectType'], + pathParams: ['objectId', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.dynamicTargetingKeys.insert + * @desc Inserts a new dynamic targeting key. Keys must be created at the + * advertiser level before being assigned to the advertiser's ads, + * creatives, or placements. There is a maximum of 1000 keys per advertiser, + * out of which a maximum of 20 keys can be assigned per ad, creative, or + * placement. + * @alias dfareporting.dynamicTargetingKeys.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().DynamicTargetingKey} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Dynamictargetingkeys$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Dynamictargetingkeys$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Dynamictargetingkeys$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Dynamictargetingkeys$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dynamicTargetingKeys') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.dynamicTargetingKeys.list + * @desc Retrieves a list of dynamic targeting keys. + * @alias dfareporting.dynamicTargetingKeys.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only dynamic targeting keys whose object has this advertiser ID. + * @param {string=} params.names Select only dynamic targeting keys exactly matching these names. + * @param {string=} params.objectId Select only dynamic targeting keys with this object ID. + * @param {string=} params.objectType Select only dynamic targeting keys with this object type. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Dynamictargetingkeys$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Dynamictargetingkeys$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Dynamictargetingkeys$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Dynamictargetingkeys$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Dynamictargetingkeys$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Dynamictargetingkeys$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/dynamicTargetingKeys') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Dynamictargetingkeys$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of this dynamic targeting key. This is a required field. Must be + * less than 256 characters long and cannot contain commas. All characters + * are converted to lowercase. + */ + name?: string; + /** + * ID of the object of this dynamic targeting key. This is a required field. + */ + objectId?: string; + /** + * Type of the object of this dynamic targeting key. This is a required + * field. + */ + objectType?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Dynamictargetingkeys$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DynamicTargetingKey; + } + export interface Params$Resource$Dynamictargetingkeys$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only dynamic targeting keys whose object has this advertiser ID. + */ + advertiserId?: string; + /** + * Select only dynamic targeting keys exactly matching these names. + */ + names?: string[]; + /** + * Select only dynamic targeting keys with this object ID. + */ + objectId?: string; + /** + * Select only dynamic targeting keys with this object type. + */ + objectType?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Eventtags { + constructor() {} + + + /** + * dfareporting.eventTags.delete + * @desc Deletes an existing event tag. + * @alias dfareporting.eventTags.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Event tag ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: Params$Resource$Eventtags$Delete, options?: MethodOptions): + GaxiosPromise; + delete( + params: Params$Resource$Eventtags$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Eventtags$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Eventtags$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.eventTags.get + * @desc Gets one event tag by ID. + * @alias dfareporting.eventTags.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Event tag ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Eventtags$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Eventtags$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Eventtags$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Eventtags$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.eventTags.insert + * @desc Inserts a new event tag. + * @alias dfareporting.eventTags.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().EventTag} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Eventtags$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Eventtags$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Eventtags$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Eventtags$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.eventTags.list + * @desc Retrieves a list of event tags, possibly filtered. + * @alias dfareporting.eventTags.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.adId Select only event tags that belong to this ad. + * @param {string=} params.advertiserId Select only event tags that belong to this advertiser. + * @param {string=} params.campaignId Select only event tags that belong to this campaign. + * @param {boolean=} params.definitionsOnly Examine only the specified campaign or advertiser's event tags for matching selector criteria. When set to false, the parent advertiser and parent campaign of the specified ad or campaign is examined as well. In addition, when set to false, the status field is examined as well, along with the enabledByDefault field. This parameter can not be set to true when adId is specified as ads do not define their own even tags. + * @param {boolean=} params.enabled Select only enabled event tags. What is considered enabled or disabled depends on the definitionsOnly parameter. When definitionsOnly is set to true, only the specified advertiser or campaign's event tags' enabledByDefault field is examined. When definitionsOnly is set to false, the specified ad or specified campaign's parent advertiser's or parent campaign's event tags' enabledByDefault and status fields are examined as well. + * @param {string=} params.eventTagTypes Select only event tags with the specified event tag types. Event tag types can be used to specify whether to use a third-party pixel, a third-party JavaScript URL, or a third-party click-through URL for either impression or click tracking. + * @param {string=} params.ids Select only event tags with these IDs. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "eventtag*2015" will return objects with names like "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "eventtag" will match objects with name "my eventtag", "eventtag 2015", or simply "eventtag". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Eventtags$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Eventtags$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Eventtags$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Eventtags$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.eventTags.patch + * @desc Updates an existing event tag. This method supports patch + * semantics. + * @alias dfareporting.eventTags.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Event tag ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().EventTag} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Eventtags$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Eventtags$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Eventtags$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Eventtags$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.eventTags.update + * @desc Updates an existing event tag. + * @alias dfareporting.eventTags.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().EventTag} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Eventtags$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Eventtags$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Eventtags$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Eventtags$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Eventtags$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Eventtags$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/eventTags') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Eventtags$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Eventtags$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Eventtags$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + export interface Params$Resource$Eventtags$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only event tags that belong to this ad. + */ + adId?: string; + /** + * Select only event tags that belong to this advertiser. + */ + advertiserId?: string; + /** + * Select only event tags that belong to this campaign. + */ + campaignId?: string; + /** + * Examine only the specified campaign or advertiser's event tags for + * matching selector criteria. When set to false, the parent advertiser and + * parent campaign of the specified ad or campaign is examined as well. In + * addition, when set to false, the status field is examined as well, along + * with the enabledByDefault field. This parameter can not be set to true + * when adId is specified as ads do not define their own even tags. + */ + definitionsOnly?: boolean; + /** + * Select only enabled event tags. What is considered enabled or disabled + * depends on the definitionsOnly parameter. When definitionsOnly is set to + * true, only the specified advertiser or campaign's event tags' + * enabledByDefault field is examined. When definitionsOnly is set to false, + * the specified ad or specified campaign's parent advertiser's or parent + * campaign's event tags' enabledByDefault and status fields are examined as + * well. + */ + enabled?: boolean; + /** + * Select only event tags with the specified event tag types. Event tag + * types can be used to specify whether to use a third-party pixel, a + * third-party JavaScript URL, or a third-party click-through URL for either + * impression or click tracking. + */ + eventTagTypes?: string[]; + /** + * Select only event tags with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "eventtag*2015" will return objects with names like + * "eventtag June 2015", "eventtag April 2015", or simply "eventtag 2015". + * Most of the searches also add wildcards implicitly at the start and the + * end of the search string. For example, a search string of "eventtag" will + * match objects with name "my eventtag", "eventtag 2015", or simply + * "eventtag". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Eventtags$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Event tag ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + export interface Params$Resource$Eventtags$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EventTag; + } + + + export class Resource$Files { + constructor() {} + + + /** + * dfareporting.files.get + * @desc Retrieves a report file by its report ID and file ID. This method + * supports media download. + * @alias dfareporting.files.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the report file. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Files$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Files$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Files$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Files$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/reports/{reportId}/files/{fileId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['reportId', 'fileId'], + pathParams: ['fileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.files.list + * @desc Lists files for a user profile. + * @alias dfareporting.files.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA profile ID. + * @param {string=} params.scope The scope that defines which results are returned. + * @param {string=} params.sortField The field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Files$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Files$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Files$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Files$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/files') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Files$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the report file. + */ + fileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Files$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The scope that defines which results are returned. + */ + scope?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + export class Resource$Floodlightactivities { + constructor() {} + + + /** + * dfareporting.floodlightActivities.delete + * @desc Deletes an existing floodlight activity. + * @alias dfareporting.floodlightActivities.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Floodlightactivities$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Floodlightactivities$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Floodlightactivities$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Floodlightactivities$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivities$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightActivities.generatetag + * @desc Generates a tag for a floodlight activity. + * @alias dfareporting.floodlightActivities.generatetag + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.floodlightActivityId Floodlight activity ID for which we want to generate a tag. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generatetag( + params?: Params$Resource$Floodlightactivities$Generatetag, + options?: MethodOptions): + GaxiosPromise; + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse>): void; + generatetag( + params: Params$Resource$Floodlightactivities$Generatetag, + callback: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse>): void; + generatetag(callback: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse>): void; + generatetag( + paramsOrCallback?: Params$Resource$Floodlightactivities$Generatetag| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$FloodlightActivitiesGenerateTagResponse>): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivities$Generatetag; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Generatetag; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities/generatetag') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.floodlightActivities.get + * @desc Gets one floodlight activity by ID. + * @alias dfareporting.floodlightActivities.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Floodlightactivities$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Floodlightactivities$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Floodlightactivities$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Floodlightactivities$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Floodlightactivities$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightActivities.insert + * @desc Inserts a new floodlight activity. + * @alias dfareporting.floodlightActivities.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivity} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Floodlightactivities$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Floodlightactivities$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Floodlightactivities$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Floodlightactivities$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivities$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightActivities.list + * @desc Retrieves a list of floodlight activities, possibly filtered. This + * method supports paging. + * @alias dfareporting.floodlightActivities.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {string=} params.floodlightActivityGroupIds Select only floodlight activities with the specified floodlight activity group IDs. + * @param {string=} params.floodlightActivityGroupName Select only floodlight activities with the specified floodlight activity group name. + * @param {string=} params.floodlightActivityGroupTagString Select only floodlight activities with the specified floodlight activity group tag string. + * @param {string=} params.floodlightActivityGroupType Select only floodlight activities with the specified floodlight activity group type. + * @param {string=} params.floodlightConfigurationId Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {string=} params.ids Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.tagString Select only floodlight activities with the specified tag string. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Floodlightactivities$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Floodlightactivities$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Floodlightactivities$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Floodlightactivities$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Floodlightactivities$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.floodlightActivities.patch + * @desc Updates an existing floodlight activity. This method supports patch + * semantics. + * @alias dfareporting.floodlightActivities.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivity} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Floodlightactivities$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Floodlightactivities$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Floodlightactivities$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Floodlightactivities$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivities$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightActivities.update + * @desc Updates an existing floodlight activity. + * @alias dfareporting.floodlightActivities.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivity} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Floodlightactivities$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Floodlightactivities$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Floodlightactivities$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Floodlightactivities$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivities$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivities$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivities') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightactivities$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Generatetag extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight activity ID for which we want to generate a tag. + */ + floodlightActivityId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivities$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + export interface Params$Resource$Floodlightactivities$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only floodlight activities for the specified advertiser ID. Must + * specify either ids, advertiserId, or floodlightConfigurationId for a + * non-empty result. + */ + advertiserId?: string; + /** + * Select only floodlight activities with the specified floodlight activity + * group IDs. + */ + floodlightActivityGroupIds?: string[]; + /** + * Select only floodlight activities with the specified floodlight activity + * group name. + */ + floodlightActivityGroupName?: string; + /** + * Select only floodlight activities with the specified floodlight activity + * group tag string. + */ + floodlightActivityGroupTagString?: string; + /** + * Select only floodlight activities with the specified floodlight activity + * group type. + */ + floodlightActivityGroupType?: string; + /** + * Select only floodlight activities for the specified floodlight + * configuration ID. Must specify either ids, advertiserId, or + * floodlightConfigurationId for a non-empty result. + */ + floodlightConfigurationId?: string; + /** + * Select only floodlight activities with the specified IDs. Must specify + * either ids, advertiserId, or floodlightConfigurationId for a non-empty + * result. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "floodlightactivity*2015" will return objects with names + * like "floodlightactivity June 2015", "floodlightactivity April 2015", or + * simply "floodlightactivity 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "floodlightactivity" will match objects with name "my + * floodlightactivity activity", "floodlightactivity 2015", or simply + * "floodlightactivity". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only floodlight activities with the specified tag string. + */ + tagString?: string; + } + export interface Params$Resource$Floodlightactivities$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight activity ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + export interface Params$Resource$Floodlightactivities$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivity; + } + + + export class Resource$Floodlightactivitygroups { + constructor() {} + + + /** + * dfareporting.floodlightActivityGroups.get + * @desc Gets one floodlight activity group by ID. + * @alias dfareporting.floodlightActivityGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity Group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Floodlightactivitygroups$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Floodlightactivitygroups$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Floodlightactivitygroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivitygroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightActivityGroups.insert + * @desc Inserts a new floodlight activity group. + * @alias dfareporting.floodlightActivityGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivityGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Floodlightactivitygroups$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Floodlightactivitygroups$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): + void; + insert( + paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivitygroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightActivityGroups.list + * @desc Retrieves a list of floodlight activity groups, possibly filtered. + * This method supports paging. + * @alias dfareporting.floodlightActivityGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + * @param {string=} params.floodlightConfigurationId Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. + * @param {string=} params.ids Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.type Select only floodlight activity groups with the specified floodlight activity group type. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Floodlightactivitygroups$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Floodlightactivitygroups$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Floodlightactivitygroups$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Floodlightactivitygroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivitygroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.floodlightActivityGroups.patch + * @desc Updates an existing floodlight activity group. This method supports + * patch semantics. + * @alias dfareporting.floodlightActivityGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight activity Group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivityGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Floodlightactivitygroups$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Floodlightactivitygroups$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Floodlightactivitygroups$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivitygroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightActivityGroups.update + * @desc Updates an existing floodlight activity group. + * @alias dfareporting.floodlightActivityGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightActivityGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Floodlightactivitygroups$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Floodlightactivitygroups$Update, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Floodlightactivitygroups$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): + void; + update( + paramsOrCallback?: Params$Resource$Floodlightactivitygroups$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightactivitygroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightactivitygroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightActivityGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightactivitygroups$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight activity Group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightactivitygroups$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + export interface Params$Resource$Floodlightactivitygroups$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only floodlight activity groups with the specified advertiser ID. + * Must specify either advertiserId or floodlightConfigurationId for a + * non-empty result. + */ + advertiserId?: string; + /** + * Select only floodlight activity groups with the specified floodlight + * configuration ID. Must specify either advertiserId, or + * floodlightConfigurationId for a non-empty result. + */ + floodlightConfigurationId?: string; + /** + * Select only floodlight activity groups with the specified IDs. Must + * specify either advertiserId or floodlightConfigurationId for a non-empty + * result. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "floodlightactivitygroup*2015" will return objects with + * names like "floodlightactivitygroup June 2015", "floodlightactivitygroup + * April 2015", or simply "floodlightactivitygroup 2015". Most of the + * searches also add wildcards implicitly at the start and the end of the + * search string. For example, a search string of "floodlightactivitygroup" + * will match objects with name "my floodlightactivitygroup activity", + * "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only floodlight activity groups with the specified floodlight + * activity group type. + */ + type?: string; + } + export interface Params$Resource$Floodlightactivitygroups$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight activity Group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + export interface Params$Resource$Floodlightactivitygroups$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightActivityGroup; + } + + + export class Resource$Floodlightconfigurations { + constructor() {} + + + /** + * dfareporting.floodlightConfigurations.get + * @desc Gets one floodlight configuration by ID. + * @alias dfareporting.floodlightConfigurations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight configuration ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Floodlightconfigurations$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Floodlightconfigurations$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Floodlightconfigurations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Floodlightconfigurations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightconfigurations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightConfigurations.list + * @desc Retrieves a list of floodlight configurations, possibly filtered. + * @alias dfareporting.floodlightConfigurations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Set of IDs of floodlight configurations to retrieve. Required field; otherwise an empty list will be returned. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Floodlightconfigurations$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Floodlightconfigurations$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Floodlightconfigurations$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Floodlightconfigurations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightconfigurations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.floodlightConfigurations.patch + * @desc Updates an existing floodlight configuration. This method supports + * patch semantics. + * @alias dfareporting.floodlightConfigurations.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Floodlight configuration ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightConfiguration} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Floodlightconfigurations$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Floodlightconfigurations$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Floodlightconfigurations$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Floodlightconfigurations$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightconfigurations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.floodlightConfigurations.update + * @desc Updates an existing floodlight configuration. + * @alias dfareporting.floodlightConfigurations.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().FloodlightConfiguration} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Floodlightconfigurations$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Floodlightconfigurations$Update, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Floodlightconfigurations$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): + void; + update( + paramsOrCallback?: Params$Resource$Floodlightconfigurations$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Floodlightconfigurations$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightconfigurations$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/floodlightConfigurations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightconfigurations$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight configuration ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightconfigurations$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Set of IDs of floodlight configurations to retrieve. Required field; + * otherwise an empty list will be returned. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Floodlightconfigurations$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Floodlight configuration ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightConfiguration; + } + export interface Params$Resource$Floodlightconfigurations$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightConfiguration; + } + + + export class Resource$Inventoryitems { + constructor() {} + + + /** + * dfareporting.inventoryItems.get + * @desc Gets one inventory item by ID. + * @alias dfareporting.inventoryItems.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Inventory item ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Inventoryitems$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Inventoryitems$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Inventoryitems$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Inventoryitems$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Inventoryitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventoryitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'projectId', 'id'], + pathParams: ['id', 'profileId', 'projectId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.inventoryItems.list + * @desc Retrieves a list of inventory items, possibly filtered. This method + * supports paging. + * @alias dfareporting.inventoryItems.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only inventory items with these IDs. + * @param {boolean=} params.inPlan Select only inventory items that are in plan. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.orderId Select only inventory items that belong to specified orders. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {string=} params.siteId Select only inventory items that are associated with these sites. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.type Select only inventory items with this type. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Inventoryitems$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Inventoryitems$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Inventoryitems$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Inventoryitems$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Inventoryitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventoryitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/inventoryItems') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'projectId'], + pathParams: ['profileId', 'projectId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Inventoryitems$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Inventory item ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + } + export interface Params$Resource$Inventoryitems$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only inventory items with these IDs. + */ + ids?: string[]; + /** + * Select only inventory items that are in plan. + */ + inPlan?: boolean; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only inventory items that belong to specified orders. + */ + orderId?: string[]; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + /** + * Select only inventory items that are associated with these sites. + */ + siteId?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only inventory items with this type. + */ + type?: string; + } + + + export class Resource$Languages { + constructor() {} + + + /** + * dfareporting.languages.list + * @desc Retrieves a list of languages. + * @alias dfareporting.languages.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Languages$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Languages$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Languages$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Languages$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Languages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Languages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/languages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Languages$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Metros { + constructor() {} + + + /** + * dfareporting.metros.list + * @desc Retrieves a list of metros. + * @alias dfareporting.metros.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Metros$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Metros$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Metros$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Metros$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Metros$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Metros$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/metros') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Metros$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Mobileapps { + constructor() {} + + + /** + * dfareporting.mobileApps.get + * @desc Gets one mobile app by ID. + * @alias dfareporting.mobileApps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Mobile app ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Mobileapps$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Mobileapps$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Mobileapps$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Mobileapps$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobileapps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/mobileApps/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.mobileApps.list + * @desc Retrieves list of available mobile apps. + * @alias dfareporting.mobileApps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.directories Select only apps from these directories. + * @param {string=} params.ids Select only apps with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "app*2015" will return objects with names like "app Jan 2018", "app Jan 2018", or simply "app 2018". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "app" will match objects with name "my app", "app 2018", or simply "app". + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Mobileapps$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Mobileapps$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Mobileapps$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Mobileapps$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Mobileapps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobileapps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/mobileApps') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mobileapps$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Mobile app ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Mobileapps$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only apps from these directories. + */ + directories?: string[]; + /** + * Select only apps with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "app*2015" will return objects with names like "app Jan + * 2018", "app Jan 2018", or simply "app 2018". Most of the searches also + * add wildcards implicitly at the start and the end of the search string. + * For example, a search string of "app" will match objects with name "my + * app", "app 2018", or simply "app". + */ + searchString?: string; + } + + + export class Resource$Mobilecarriers { + constructor() {} + + + /** + * dfareporting.mobileCarriers.get + * @desc Gets one mobile carrier by ID. + * @alias dfareporting.mobileCarriers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Mobile carrier ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Mobilecarriers$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Mobilecarriers$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Mobilecarriers$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Mobilecarriers$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Mobilecarriers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobilecarriers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/mobileCarriers/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.mobileCarriers.list + * @desc Retrieves a list of mobile carriers. + * @alias dfareporting.mobileCarriers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Mobilecarriers$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Mobilecarriers$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Mobilecarriers$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Mobilecarriers$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Mobilecarriers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Mobilecarriers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/mobileCarriers') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Mobilecarriers$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Mobile carrier ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Mobilecarriers$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Operatingsystems { + constructor() {} + + + /** + * dfareporting.operatingSystems.get + * @desc Gets one operating system by DART ID. + * @alias dfareporting.operatingSystems.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dartId Operating system DART ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Operatingsystems$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Operatingsystems$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operatingsystems$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operatingsystems$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Operatingsystems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystems/{dartId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'dartId'], + pathParams: ['dartId', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.operatingSystems.list + * @desc Retrieves a list of operating systems. + * @alias dfareporting.operatingSystems.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Operatingsystems$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Operatingsystems$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Operatingsystems$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Operatingsystems$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Operatingsystems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystems') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Operatingsystems$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Operating system DART ID. + */ + dartId?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Operatingsystems$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Operatingsystemversions { + constructor() {} + + + /** + * dfareporting.operatingSystemVersions.get + * @desc Gets one operating system version by ID. + * @alias dfareporting.operatingSystemVersions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Operating system version ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Operatingsystemversions$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Operatingsystemversions$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operatingsystemversions$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operatingsystemversions$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Operatingsystemversions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystemversions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystemVersions/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.operatingSystemVersions.list + * @desc Retrieves a list of operating system versions. + * @alias dfareporting.operatingSystemVersions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Operatingsystemversions$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Operatingsystemversions$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Operatingsystemversions$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Operatingsystemversions$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Operatingsystemversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operatingsystemversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/operatingSystemVersions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Operatingsystemversions$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Operating system version ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Operatingsystemversions$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Orderdocuments { + constructor() {} + + + /** + * dfareporting.orderDocuments.get + * @desc Gets one order document by ID. + * @alias dfareporting.orderDocuments.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Order document ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Orderdocuments$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Orderdocuments$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Orderdocuments$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Orderdocuments$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Orderdocuments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orderdocuments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'projectId', 'id'], + pathParams: ['id', 'profileId', 'projectId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.orderDocuments.list + * @desc Retrieves a list of order documents, possibly filtered. This method + * supports paging. + * @alias dfareporting.orderDocuments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.approved Select only order documents that have been approved by at least one user. + * @param {string=} params.ids Select only order documents with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.orderId Select only order documents for specified orders. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for order documents. + * @param {string=} params.searchString Allows searching for order documents by name or ID. Wildcards (*) are allowed. For example, "orderdocument*2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument". + * @param {string=} params.siteId Select only order documents that are associated with these sites. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Orderdocuments$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Orderdocuments$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Orderdocuments$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Orderdocuments$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Orderdocuments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orderdocuments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orderDocuments') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'projectId'], + pathParams: ['profileId', 'projectId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Orderdocuments$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Order document ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + } + export interface Params$Resource$Orderdocuments$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only order documents that have been approved by at least one user. + */ + approved?: boolean; + /** + * Select only order documents with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only order documents for specified orders. + */ + orderId?: string[]; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for order documents. + */ + projectId?: string; + /** + * Allows searching for order documents by name or ID. Wildcards (*) are + * allowed. For example, "orderdocument*2015" will return order documents + * with names like "orderdocument June 2015", "orderdocument April 2015", or + * simply "orderdocument 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "orderdocument" will match order documents with name "my + * orderdocument", "orderdocument 2015", or simply "orderdocument". + */ + searchString?: string; + /** + * Select only order documents that are associated with these sites. + */ + siteId?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + export class Resource$Orders { + constructor() {} + + + /** + * dfareporting.orders.get + * @desc Gets one order by ID. + * @alias dfareporting.orders.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Order ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for orders. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Orders$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Orders$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Orders$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Orders$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Orders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orders/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'projectId', 'id'], + pathParams: ['id', 'profileId', 'projectId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.orders.list + * @desc Retrieves a list of orders, possibly filtered. This method supports + * paging. + * @alias dfareporting.orders.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only orders with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.projectId Project ID for orders. + * @param {string=} params.searchString Allows searching for orders by name or ID. Wildcards (*) are allowed. For example, "order*2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "order" will match orders with name "my order", "order 2015", or simply "order". + * @param {string=} params.siteId Select only orders that are associated with these site IDs. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Orders$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Orders$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Orders$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Orders$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Orders$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Orders$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orders') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'projectId'], + pathParams: ['profileId', 'projectId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Orders$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Order ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for orders. + */ + projectId?: string; + } + export interface Params$Resource$Orders$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only orders with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Project ID for orders. + */ + projectId?: string; + /** + * Allows searching for orders by name or ID. Wildcards (*) are allowed. For + * example, "order*2015" will return orders with names like "order June + * 2015", "order April 2015", or simply "order 2015". Most of the searches + * also add wildcards implicitly at the start and the end of the search + * string. For example, a search string of "order" will match orders with + * name "my order", "order 2015", or simply "order". + */ + searchString?: string; + /** + * Select only orders that are associated with these site IDs. + */ + siteId?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + export class Resource$Placementgroups { + constructor() {} + + + /** + * dfareporting.placementGroups.get + * @desc Gets one placement group by ID. + * @alias dfareporting.placementGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Placementgroups$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Placementgroups$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Placementgroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Placementgroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementGroups.insert + * @desc Inserts a new placement group. + * @alias dfareporting.placementGroups.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Placementgroups$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Placementgroups$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Placementgroups$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Placementgroups$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementGroups.list + * @desc Retrieves a list of placement groups, possibly filtered. This + * method supports paging. + * @alias dfareporting.placementGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only placement groups that belong to these advertisers. + * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. + * @param {string=} params.campaignIds Select only placement groups that belong to these campaigns. + * @param {string=} params.contentCategoryIds Select only placement groups that are associated with these content categories. + * @param {string=} params.directorySiteIds Select only placement groups that are associated with these directory sites. + * @param {string=} params.ids Select only placement groups with these IDs. + * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string=} params.placementGroupType Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. + * @param {string=} params.placementStrategyIds Select only placement groups that are associated with these placement strategies. + * @param {string=} params.pricingTypes Select only placement groups with these pricing types. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for placement groups by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placement groups with names like "placement group June 2015", "placement group May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementgroup" will match placement groups with name "my placementgroup", "placementgroup 2015", or simply "placementgroup". + * @param {string=} params.siteIds Select only placement groups that are associated with these sites. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Placementgroups$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Placementgroups$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Placementgroups$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Placementgroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementGroups.patch + * @desc Updates an existing placement group. This method supports patch + * semantics. + * @alias dfareporting.placementGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Placementgroups$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Placementgroups$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Placementgroups$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Placementgroups$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementGroups.update + * @desc Updates an existing placement group. + * @alias dfareporting.placementGroups.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementGroup} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Placementgroups$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Placementgroups$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Placementgroups$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Placementgroups$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementgroups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementgroups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placementgroups$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Placement group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementgroups$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + export interface Params$Resource$Placementgroups$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only placement groups that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived placements. Don't set this field to select both + * archived and non-archived placements. + */ + archived?: boolean; + /** + * Select only placement groups that belong to these campaigns. + */ + campaignIds?: string[]; + /** + * Select only placement groups that are associated with these content + * categories. + */ + contentCategoryIds?: string[]; + /** + * Select only placement groups that are associated with these directory + * sites. + */ + directorySiteIds?: string[]; + /** + * Select only placement groups with these IDs. + */ + ids?: string[]; + /** + * Select only placements or placement groups whose end date is on or before + * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + */ + maxEndDate?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only placements or placement groups whose start date is on or + * before the specified maxStartDate. The date should be formatted as + * "yyyy-MM-dd". + */ + maxStartDate?: string; + /** + * Select only placements or placement groups whose end date is on or after + * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + */ + minEndDate?: string; + /** + * Select only placements or placement groups whose start date is on or + * after the specified minStartDate. The date should be formatted as + * "yyyy-MM-dd". + */ + minStartDate?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only placement groups belonging with this group type. A package is + * a simple group of placements that acts as a single pricing point for a + * group of tags. A roadblock is a group of placements that not only acts as + * a single pricing point but also assumes that all the tags in it will be + * served at the same time. A roadblock requires one of its assigned + * placements to be marked as primary for reporting. + */ + placementGroupType?: string; + /** + * Select only placement groups that are associated with these placement + * strategies. + */ + placementStrategyIds?: string[]; + /** + * Select only placement groups with these pricing types. + */ + pricingTypes?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for placement groups by name or ID. Wildcards (*) are + * allowed. For example, "placement*2015" will return placement groups with + * names like "placement group June 2015", "placement group May 2015", or + * simply "placements 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "placementgroup" will match placement groups with name + * "my placementgroup", "placementgroup 2015", or simply "placementgroup". + */ + searchString?: string; + /** + * Select only placement groups that are associated with these sites. + */ + siteIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placementgroups$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Placement group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + export interface Params$Resource$Placementgroups$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementGroup; + } + + + export class Resource$Placements { + constructor() {} + + + /** + * dfareporting.placements.generatetags + * @desc Generates tags for a placement. + * @alias dfareporting.placements.generatetags + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.campaignId Generate placements belonging to this campaign. This is a required field. + * @param {string=} params.placementIds Generate tags for these placements. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.tagFormats Tag formats to generate for these placements. Note: PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + generatetags( + params?: Params$Resource$Placements$Generatetags, + options?: MethodOptions): + GaxiosPromise; + generatetags( + params: Params$Resource$Placements$Generatetags, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + generatetags( + params: Params$Resource$Placements$Generatetags, + callback: BodyResponseCallback): + void; + generatetags( + callback: BodyResponseCallback): + void; + generatetags( + paramsOrCallback?: Params$Resource$Placements$Generatetags| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placements$Generatetags; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Generatetags; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements/generatetags') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.placements.get + * @desc Gets one placement by ID. + * @alias dfareporting.placements.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Placements$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Placements$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Placements$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Placements$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placements.insert + * @desc Inserts a new placement. + * @alias dfareporting.placements.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Placement} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Placements$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Placements$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Placements$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Placements$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placements$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placements.list + * @desc Retrieves a list of placements, possibly filtered. This method + * supports paging. + * @alias dfareporting.placements.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only placements that belong to these advertisers. + * @param {boolean=} params.archived Select only archived placements. Don't set this field to select both archived and non-archived placements. + * @param {string=} params.campaignIds Select only placements that belong to these campaigns. + * @param {string=} params.compatibilities Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. + * @param {string=} params.contentCategoryIds Select only placements that are associated with these content categories. + * @param {string=} params.directorySiteIds Select only placements that are associated with these directory sites. + * @param {string=} params.groupIds Select only placements that belong to these placement groups. + * @param {string=} params.ids Select only placements with these IDs. + * @param {string=} params.maxEndDate Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.maxStartDate Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minEndDate Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.minStartDate Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string=} params.paymentSource Select only placements with this payment source. + * @param {string=} params.placementStrategyIds Select only placements that are associated with these placement strategies. + * @param {string=} params.pricingTypes Select only placements with these pricing types. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, "placement*2015" will return placements with names like "placement June 2015", "placement May 2015", or simply "placements 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placement" will match placements with name "my placement", "placement 2015", or simply "placement". + * @param {string=} params.siteIds Select only placements that are associated with these sites. + * @param {string=} params.sizeIds Select only placements that are associated with these sizes. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Placements$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Placements$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Placements$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Placements$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placements.patch + * @desc Updates an existing placement. This method supports patch + * semantics. + * @alias dfareporting.placements.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Placement} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Placements$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Placements$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Placements$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Placements$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Placements$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placements.update + * @desc Updates an existing placement. + * @alias dfareporting.placements.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Placement} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Placements$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Placements$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Placements$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Placements$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placements$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placements$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placements') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placements$Generatetags extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Generate placements belonging to this campaign. This is a required field. + */ + campaignId?: string; + /** + * Generate tags for these placements. + */ + placementIds?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Tag formats to generate for these placements. Note: + * PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. + */ + tagFormats?: string[]; + } + export interface Params$Resource$Placements$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Placement ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placements$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + export interface Params$Resource$Placements$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only placements that belong to these advertisers. + */ + advertiserIds?: string[]; + /** + * Select only archived placements. Don't set this field to select both + * archived and non-archived placements. + */ + archived?: boolean; + /** + * Select only placements that belong to these campaigns. + */ + campaignIds?: string[]; + /** + * Select only placements that are associated with these compatibilities. + * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or + * on mobile devices for regular or interstitial ads respectively. APP and + * APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers + * to rendering in in-stream video ads developed with the VAST standard. + */ + compatibilities?: string[]; + /** + * Select only placements that are associated with these content categories. + */ + contentCategoryIds?: string[]; + /** + * Select only placements that are associated with these directory sites. + */ + directorySiteIds?: string[]; + /** + * Select only placements that belong to these placement groups. + */ + groupIds?: string[]; + /** + * Select only placements with these IDs. + */ + ids?: string[]; + /** + * Select only placements or placement groups whose end date is on or before + * the specified maxEndDate. The date should be formatted as "yyyy-MM-dd". + */ + maxEndDate?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Select only placements or placement groups whose start date is on or + * before the specified maxStartDate. The date should be formatted as + * "yyyy-MM-dd". + */ + maxStartDate?: string; + /** + * Select only placements or placement groups whose end date is on or after + * the specified minEndDate. The date should be formatted as "yyyy-MM-dd". + */ + minEndDate?: string; + /** + * Select only placements or placement groups whose start date is on or + * after the specified minStartDate. The date should be formatted as + * "yyyy-MM-dd". + */ + minStartDate?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * Select only placements with this payment source. + */ + paymentSource?: string; + /** + * Select only placements that are associated with these placement + * strategies. + */ + placementStrategyIds?: string[]; + /** + * Select only placements with these pricing types. + */ + pricingTypes?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for placements by name or ID. Wildcards (*) are allowed. + * For example, "placement*2015" will return placements with names like + * "placement June 2015", "placement May 2015", or simply "placements 2015". + * Most of the searches also add wildcards implicitly at the start and the + * end of the search string. For example, a search string of "placement" + * will match placements with name "my placement", "placement 2015", or + * simply "placement". + */ + searchString?: string; + /** + * Select only placements that are associated with these sites. + */ + siteIds?: string[]; + /** + * Select only placements that are associated with these sizes. + */ + sizeIds?: string[]; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placements$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Placement ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + export interface Params$Resource$Placements$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Placement; + } + + + export class Resource$Placementstrategies { + constructor() {} + + + /** + * dfareporting.placementStrategies.delete + * @desc Deletes an existing placement strategy. + * @alias dfareporting.placementStrategies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement strategy ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Placementstrategies$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Placementstrategies$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Placementstrategies$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Placementstrategies$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Placementstrategies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementStrategies.get + * @desc Gets one placement strategy by ID. + * @alias dfareporting.placementStrategies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement strategy ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Placementstrategies$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Placementstrategies$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Placementstrategies$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Placementstrategies$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementstrategies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementStrategies.insert + * @desc Inserts a new placement strategy. + * @alias dfareporting.placementStrategies.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementStrategy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Placementstrategies$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Placementstrategies$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Placementstrategies$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Placementstrategies$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Placementstrategies$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementStrategies.list + * @desc Retrieves a list of placement strategies, possibly filtered. This + * method supports paging. + * @alias dfareporting.placementStrategies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only placement strategies with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Placementstrategies$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Placementstrategies$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Placementstrategies$List, + callback: BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Placementstrategies$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementstrategies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.placementStrategies.patch + * @desc Updates an existing placement strategy. This method supports patch + * semantics. + * @alias dfareporting.placementStrategies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Placement strategy ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementStrategy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Placementstrategies$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Placementstrategies$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Placementstrategies$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Placementstrategies$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Placementstrategies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.placementStrategies.update + * @desc Updates an existing placement strategy. + * @alias dfareporting.placementStrategies.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().PlacementStrategy} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Placementstrategies$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Placementstrategies$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Placementstrategies$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Placementstrategies$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Placementstrategies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Placementstrategies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/placementStrategies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Placementstrategies$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementstrategies$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Placementstrategies$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + export interface Params$Resource$Placementstrategies$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only placement strategies with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "placementstrategy*2015" will return objects with names like + * "placementstrategy June 2015", "placementstrategy April 2015", or simply + * "placementstrategy 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "placementstrategy" will match objects with name "my + * placementstrategy", "placementstrategy 2015", or simply + * "placementstrategy". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Placementstrategies$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Placement strategy ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + export interface Params$Resource$Placementstrategies$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PlacementStrategy; + } + + + export class Resource$Platformtypes { + constructor() {} + + + /** + * dfareporting.platformTypes.get + * @desc Gets one platform type by ID. + * @alias dfareporting.platformTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Platform type ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Platformtypes$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Platformtypes$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Platformtypes$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Platformtypes$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Platformtypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platformtypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/platformTypes/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.platformTypes.list + * @desc Retrieves a list of platform types. + * @alias dfareporting.platformTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Platformtypes$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Platformtypes$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Platformtypes$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Platformtypes$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Platformtypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platformtypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/platformTypes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platformtypes$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Platform type ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Platformtypes$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Postalcodes { + constructor() {} + + + /** + * dfareporting.postalCodes.get + * @desc Gets one postal code by ID. + * @alias dfareporting.postalCodes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.code Postal code ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Postalcodes$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Postalcodes$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Postalcodes$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Postalcodes$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Postalcodes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/postalCodes/{code}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'code'], + pathParams: ['code', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.postalCodes.list + * @desc Retrieves a list of postal codes. + * @alias dfareporting.postalCodes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Postalcodes$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Postalcodes$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Postalcodes$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Postalcodes$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Postalcodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Postalcodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/postalCodes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Postalcodes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Postal code ID. + */ + code?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Postalcodes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Projects { + constructor() {} + + + /** + * dfareporting.projects.get + * @desc Gets one project by ID. + * @alias dfareporting.projects.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Project ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.projects.list + * @desc Retrieves a list of projects, possibly filtered. This method + * supports paging. + * @alias dfareporting.projects.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserIds Select only projects with these advertiser IDs. + * @param {string=} params.ids Select only projects with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for projects by name or ID. Wildcards (*) are allowed. For example, "project*2015" will return projects with names like "project June 2015", "project April 2015", or simply "project 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "project" will match projects with name "my project", "project 2015", or simply "project". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Projects$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Projects$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/projects') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Project ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Projects$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only projects with these advertiser IDs. + */ + advertiserIds?: string[]; + /** + * Select only projects with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for projects by name or ID. Wildcards (*) are allowed. + * For example, "project*2015" will return projects with names like "project + * June 2015", "project April 2015", or simply "project 2015". Most of the + * searches also add wildcards implicitly at the start and the end of the + * search string. For example, a search string of "project" will match + * projects with name "my project", "project 2015", or simply "project". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + export class Resource$Regions { + constructor() {} + + + /** + * dfareporting.regions.list + * @desc Retrieves a list of regions. + * @alias dfareporting.regions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Regions$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Regions$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Regions$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Regions$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Regions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/regions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regions$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Remarketinglists { + constructor() {} + + + /** + * dfareporting.remarketingLists.get + * @desc Gets one remarketing list by ID. + * @alias dfareporting.remarketingLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Remarketing list ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Remarketinglists$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Remarketinglists$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Remarketinglists$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Remarketinglists$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.remarketingLists.insert + * @desc Inserts a new remarketing list. + * @alias dfareporting.remarketingLists.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingList} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Remarketinglists$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Remarketinglists$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Remarketinglists$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Remarketinglists$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.remarketingLists.list + * @desc Retrieves a list of remarketing lists, possibly filtered. This + * method supports paging. + * @alias dfareporting.remarketingLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active or only inactive remarketing lists. + * @param {string} params.advertiserId Select only remarketing lists owned by this advertiser. + * @param {string=} params.floodlightActivityId Select only remarketing lists that have this floodlight activity ID. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Remarketinglists$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Remarketinglists$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Remarketinglists$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Remarketinglists$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Remarketinglists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.remarketingLists.patch + * @desc Updates an existing remarketing list. This method supports patch + * semantics. + * @alias dfareporting.remarketingLists.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Remarketing list ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingList} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Remarketinglists$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Remarketinglists$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Remarketinglists$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Remarketinglists$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.remarketingLists.update + * @desc Updates an existing remarketing list. + * @alias dfareporting.remarketingLists.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingList} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Remarketinglists$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Remarketinglists$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Remarketinglists$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Remarketinglists$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Remarketinglists$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglists$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingLists') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Remarketinglists$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Remarketinglists$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + export interface Params$Resource$Remarketinglists$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only active or only inactive remarketing lists. + */ + active?: boolean; + /** + * Select only remarketing lists owned by this advertiser. + */ + advertiserId?: string; + /** + * Select only remarketing lists that have this floodlight activity ID. + */ + floodlightActivityId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "remarketing list*2015" will return objects with names like + * "remarketing list June 2015", "remarketing list April 2015", or simply + * "remarketing list 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "remarketing list" will match objects with name "my + * remarketing list", "remarketing list 2015", or simply "remarketing list". + */ + name?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Remarketinglists$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + export interface Params$Resource$Remarketinglists$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingList; + } + + + export class Resource$Remarketinglistshares { + constructor() {} + + + /** + * dfareporting.remarketingListShares.get + * @desc Gets one remarketing list share by remarketing list ID. + * @alias dfareporting.remarketingListShares.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.remarketingListId Remarketing list ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Remarketinglistshares$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Remarketinglistshares$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Remarketinglistshares$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Remarketinglistshares$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Remarketinglistshares$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingListShares/{remarketingListId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'remarketingListId'], + pathParams: ['profileId', 'remarketingListId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.remarketingListShares.patch + * @desc Updates an existing remarketing list share. This method supports + * patch semantics. + * @alias dfareporting.remarketingListShares.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {string} params.remarketingListId Remarketing list ID. + * @param {().RemarketingListShare} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Remarketinglistshares$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Remarketinglistshares$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Remarketinglistshares$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Remarketinglistshares$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Remarketinglistshares$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingListShares') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'remarketingListId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.remarketingListShares.update + * @desc Updates an existing remarketing list share. + * @alias dfareporting.remarketingListShares.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().RemarketingListShare} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Remarketinglistshares$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Remarketinglistshares$Update, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Remarketinglistshares$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Remarketinglistshares$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Remarketinglistshares$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Remarketinglistshares$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/remarketingListShares') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Remarketinglistshares$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Remarketing list ID. + */ + remarketingListId?: string; + } + export interface Params$Resource$Remarketinglistshares$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Remarketing list ID. + */ + remarketingListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingListShare; + } + export interface Params$Resource$Remarketinglistshares$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemarketingListShare; + } + + + export class Resource$Reports { + compatibleFields: Resource$Reports$Compatiblefields; + files: Resource$Reports$Files; + constructor() { + this.compatibleFields = new Resource$Reports$Compatiblefields(); + this.files = new Resource$Reports$Files(); + } + + + /** + * dfareporting.reports.delete + * @desc Deletes a report by its ID. + * @alias dfareporting.reports.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: Params$Resource$Reports$Delete, options?: MethodOptions): + GaxiosPromise; + delete( + params: Params$Resource$Reports$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Reports$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Reports$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.reports.get + * @desc Retrieves a report by its ID. + * @alias dfareporting.reports.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Reports$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Reports$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Reports$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Reports$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.reports.insert + * @desc Creates a report. + * @alias dfareporting.reports.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {().Report} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Reports$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Reports$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Reports$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Reports$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.reports.list + * @desc Retrieves list of reports. + * @alias dfareporting.reports.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA user profile ID. + * @param {string=} params.scope The scope that defines which results are returned. + * @param {string=} params.sortField The field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Reports$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Reports$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Reports$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Reports$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.reports.patch + * @desc Updates a report. This method supports patch semantics. + * @alias dfareporting.reports.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {().Report} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Reports$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Reports$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Reports$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Reports$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.reports.run + * @desc Runs a report. + * @alias dfareporting.reports.run + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA profile ID. + * @param {string} params.reportId The ID of the report. + * @param {boolean=} params.synchronous If set and true, tries to run the report synchronously. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + run(params?: Params$Resource$Reports$Run, + options?: MethodOptions): GaxiosPromise; + run(params: Params$Resource$Reports$Run, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + run(params: Params$Resource$Reports$Run, + callback: BodyResponseCallback): void; + run(callback: BodyResponseCallback): void; + run(paramsOrCallback?: Params$Resource$Reports$Run| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}/run') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.reports.update + * @desc Updates a report. + * @alias dfareporting.reports.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {string} params.reportId The ID of the report. + * @param {().Report} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Reports$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Reports$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Reports$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Reports$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Reports$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + export interface Params$Resource$Reports$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The scope that defines which results are returned. + */ + scope?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Reports$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + export interface Params$Resource$Reports$Run extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + /** + * If set and true, tries to run the report synchronously. + */ + synchronous?: boolean; + } + export interface Params$Resource$Reports$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + + export class Resource$Reports$Compatiblefields { + constructor() {} + + + /** + * dfareporting.reports.compatibleFields.query + * @desc Returns the fields that are compatible to be selected in the + * respective sections of a report criteria, given the fields already + * selected in the input report and user permissions. + * @alias dfareporting.reports.compatibleFields.query + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The DFA user profile ID. + * @param {().Report} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + query( + params?: Params$Resource$Reports$Compatiblefields$Query, + options?: MethodOptions): GaxiosPromise; + query( + params: Params$Resource$Reports$Compatiblefields$Query, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + query( + params: Params$Resource$Reports$Compatiblefields$Query, + callback: BodyResponseCallback): void; + query(callback: BodyResponseCallback): void; + query( + paramsOrCallback?: Params$Resource$Reports$Compatiblefields$Query| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Reports$Compatiblefields$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Compatiblefields$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/compatiblefields/query') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Compatiblefields$Query extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DFA user profile ID. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Report; + } + + + export class Resource$Reports$Files { + constructor() {} + + + /** + * dfareporting.reports.files.get + * @desc Retrieves a report file. This method supports media download. + * @alias dfareporting.reports.files.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.fileId The ID of the report file. + * @param {string} params.profileId The DFA profile ID. + * @param {string} params.reportId The ID of the report. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Reports$Files$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Reports$Files$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Reports$Files$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Reports$Files$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Reports$Files$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Files$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}/files/{fileId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'reportId', 'fileId'], + pathParams: ['fileId', 'profileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.reports.files.list + * @desc Lists files for a report. + * @alias dfareporting.reports.files.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken The value of the nextToken from the previous result page. + * @param {string} params.profileId The DFA profile ID. + * @param {string} params.reportId The ID of the parent report. + * @param {string=} params.sortField The field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Reports$Files$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Reports$Files$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Reports$Files$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Reports$Files$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Reports$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Reports$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/reports/{reportId}/files') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'reportId'], + pathParams: ['profileId', 'reportId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Reports$Files$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the report file. + */ + fileId?: string; + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The ID of the report. + */ + reportId?: string; + } + export interface Params$Resource$Reports$Files$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * The value of the nextToken from the previous result page. + */ + pageToken?: string; + /** + * The DFA profile ID. + */ + profileId?: string; + /** + * The ID of the parent report. + */ + reportId?: string; + /** + * The field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + + export class Resource$Sites { + constructor() {} + + + /** + * dfareporting.sites.get + * @desc Gets one site by ID. + * @alias dfareporting.sites.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Site ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Sites$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Sites$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Sites$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Sites$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sites/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.sites.insert + * @desc Inserts a new site. + * @alias dfareporting.sites.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Site} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Sites$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Sites$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Sites$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Sites$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sites') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.sites.list + * @desc Retrieves a list of sites, possibly filtered. This method supports + * paging. + * @alias dfareporting.sites.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.acceptsInStreamVideoPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsInterstitialPlacements This search filter is no longer supported and will have no effect on the results returned. + * @param {boolean=} params.acceptsPublisherPaidPlacements Select only sites that accept publisher paid placements. + * @param {boolean=} params.adWordsSite Select only AdWords sites. + * @param {boolean=} params.approved Select only approved sites. + * @param {string=} params.campaignIds Select only sites with these campaign IDs. + * @param {string=} params.directorySiteIds Select only sites with these directory site IDs. + * @param {string=} params.ids Select only sites with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only sites with this subaccount ID. + * @param {boolean=} params.unmappedSite Select only sites that have not been mapped to a directory site. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Sites$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Sites$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Sites$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Sites$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sites') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.sites.patch + * @desc Updates an existing site. This method supports patch semantics. + * @alias dfareporting.sites.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Site ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Site} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Sites$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Sites$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Sites$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Sites$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sites') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.sites.update + * @desc Updates an existing site. + * @alias dfareporting.sites.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Site} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Sites$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Sites$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Sites$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Sites$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sites') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sites$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Sites$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Sites$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * This search filter is no longer supported and will have no effect on the + * results returned. + */ + acceptsInStreamVideoPlacements?: boolean; + /** + * This search filter is no longer supported and will have no effect on the + * results returned. + */ + acceptsInterstitialPlacements?: boolean; + /** + * Select only sites that accept publisher paid placements. + */ + acceptsPublisherPaidPlacements?: boolean; + /** + * Select only AdWords sites. + */ + adWordsSite?: boolean; + /** + * Select only approved sites. + */ + approved?: boolean; + /** + * Select only sites with these campaign IDs. + */ + campaignIds?: string[]; + /** + * Select only sites with these directory site IDs. + */ + directorySiteIds?: string[]; + /** + * Select only sites with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name, ID or keyName. Wildcards (*) are + * allowed. For example, "site*2015" will return objects with names like + * "site June 2015", "site April 2015", or simply "site 2015". Most of the + * searches also add wildcards implicitly at the start and the end of the + * search string. For example, a search string of "site" will match objects + * with name "my site", "site 2015", or simply "site". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only sites with this subaccount ID. + */ + subaccountId?: string; + /** + * Select only sites that have not been mapped to a directory site. + */ + unmappedSite?: boolean; + } + export interface Params$Resource$Sites$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Site ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Sites$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + + + export class Resource$Sizes { + constructor() {} + + + /** + * dfareporting.sizes.get + * @desc Gets one size by ID. + * @alias dfareporting.sizes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Size ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Sizes$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Sizes$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Sizes$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Sizes$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sizes/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.sizes.insert + * @desc Inserts a new size. + * @alias dfareporting.sizes.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Size} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Sizes$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Sizes$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Sizes$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Sizes$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sizes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.sizes.list + * @desc Retrieves a list of sizes, possibly filtered. Retrieved sizes are + * globally unique and may include values not currently in use by your + * account. Due to this, the list of sizes returned by this method may + * differ from the list seen in the Trafficking UI. + * @alias dfareporting.sizes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.height Select only sizes with this height. + * @param {boolean=} params.iabStandard Select only IAB standard sizes. + * @param {string=} params.ids Select only sizes with these IDs. + * @param {string} params.profileId User profile ID associated with this request. + * @param {integer=} params.width Select only sizes with this width. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Sizes$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Sizes$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Sizes$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Sizes$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sizes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sizes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/sizes') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sizes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Size ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Sizes$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Size; + } + export interface Params$Resource$Sizes$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only sizes with this height. + */ + height?: number; + /** + * Select only IAB standard sizes. + */ + iabStandard?: boolean; + /** + * Select only sizes with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Select only sizes with this width. + */ + width?: number; + } + + + export class Resource$Subaccounts { + constructor() {} + + + /** + * dfareporting.subaccounts.get + * @desc Gets one subaccount by ID. + * @alias dfareporting.subaccounts.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Subaccount ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Subaccounts$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Subaccounts$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Subaccounts$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Subaccounts$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.subaccounts.insert + * @desc Inserts a new subaccount. + * @alias dfareporting.subaccounts.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Subaccount} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Subaccounts$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Subaccounts$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Subaccounts$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Subaccounts$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Subaccounts$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.subaccounts.list + * @desc Gets a list of subaccounts, possibly filtered. This method supports + * paging. + * @alias dfareporting.subaccounts.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only subaccounts with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "subaccount*2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Subaccounts$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Subaccounts$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Subaccounts$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Subaccounts$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Subaccounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.subaccounts.patch + * @desc Updates an existing subaccount. This method supports patch + * semantics. + * @alias dfareporting.subaccounts.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Subaccount ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Subaccount} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Subaccounts$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Subaccounts$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Subaccounts$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Subaccounts$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Subaccounts$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.subaccounts.update + * @desc Updates an existing subaccount. + * @alias dfareporting.subaccounts.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().Subaccount} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Subaccounts$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Subaccounts$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Subaccounts$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Subaccounts$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Subaccounts$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Subaccounts$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/subaccounts') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Subaccounts$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Subaccount ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Subaccounts$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + export interface Params$Resource$Subaccounts$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only subaccounts with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "subaccount*2015" will return objects with names like + * "subaccount June 2015", "subaccount April 2015", or simply "subaccount + * 2015". Most of the searches also add wildcards implicitly at the start + * and the end of the search string. For example, a search string of + * "subaccount" will match objects with name "my subaccount", "subaccount + * 2015", or simply "subaccount". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Subaccounts$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Subaccount ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + export interface Params$Resource$Subaccounts$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subaccount; + } + + + export class Resource$Targetableremarketinglists { + constructor() {} + + + /** + * dfareporting.targetableRemarketingLists.get + * @desc Gets one remarketing list by ID. + * @alias dfareporting.targetableRemarketingLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Remarketing list ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Targetableremarketinglists$Get, + options?: MethodOptions): + GaxiosPromise; + get(params: Params$Resource$Targetableremarketinglists$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Targetableremarketinglists$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Targetableremarketinglists$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Targetableremarketinglists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetableremarketinglists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetableRemarketingLists/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.targetableRemarketingLists.list + * @desc Retrieves a list of targetable remarketing lists, possibly + * filtered. This method supports paging. + * @alias dfareporting.targetableRemarketingLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.active Select only active or only inactive targetable remarketing lists. + * @param {string} params.advertiserId Select only targetable remarketing lists targetable by these advertisers. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.name Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "remarketing list*2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list". + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Targetableremarketinglists$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Targetableremarketinglists$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse>): void; + list( + params: Params$Resource$Targetableremarketinglists$List, + callback: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse>): void; + list(callback: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse>): void; + list( + paramsOrCallback?: Params$Resource$Targetableremarketinglists$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$TargetableRemarketingListsListResponse>): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Targetableremarketinglists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetableremarketinglists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetableRemarketingLists') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'advertiserId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Targetableremarketinglists$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Remarketing list ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Targetableremarketinglists$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only active or only inactive targetable remarketing lists. + */ + active?: boolean; + /** + * Select only targetable remarketing lists targetable by these advertisers. + */ + advertiserId?: string; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "remarketing list*2015" will return objects with names like + * "remarketing list June 2015", "remarketing list April 2015", or simply + * "remarketing list 2015". Most of the searches also add wildcards + * implicitly at the start and the end of the search string. For example, a + * search string of "remarketing list" will match objects with name "my + * remarketing list", "remarketing list 2015", or simply "remarketing list". + */ + name?: string; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + + + export class Resource$Targetingtemplates { + constructor() {} + + + /** + * dfareporting.targetingTemplates.get + * @desc Gets one targeting template by ID. + * @alias dfareporting.targetingTemplates.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Targeting template ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Targetingtemplates$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Targetingtemplates$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Targetingtemplates$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Targetingtemplates$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.targetingTemplates.insert + * @desc Inserts a new targeting template. + * @alias dfareporting.targetingTemplates.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().TargetingTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Targetingtemplates$Insert, + options?: MethodOptions): GaxiosPromise; + insert( + params: Params$Resource$Targetingtemplates$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Targetingtemplates$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Targetingtemplates$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.targetingTemplates.list + * @desc Retrieves a list of targeting templates, optionally filtered. This + * method supports paging. + * @alias dfareporting.targetingTemplates.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Select only targeting templates with this advertiser ID. + * @param {string=} params.ids Select only targeting templates with these IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "template*2015" will return objects with names like "template June 2015", "template April 2015", or simply "template 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "template" will match objects with name "my template", "template 2015", or simply "template". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Targetingtemplates$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Targetingtemplates$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Targetingtemplates$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Targetingtemplates$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * dfareporting.targetingTemplates.patch + * @desc Updates an existing targeting template. This method supports patch + * semantics. + * @alias dfareporting.targetingTemplates.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id Targeting template ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().TargetingTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Targetingtemplates$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Targetingtemplates$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Targetingtemplates$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Targetingtemplates$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.targetingTemplates.update + * @desc Updates an existing targeting template. + * @alias dfareporting.targetingTemplates.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().TargetingTemplate} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Targetingtemplates$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: Params$Resource$Targetingtemplates$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Targetingtemplates$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Targetingtemplates$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Targetingtemplates$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtemplates$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/targetingTemplates') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Targetingtemplates$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Targeting template ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Targetingtemplates$Insert extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + export interface Params$Resource$Targetingtemplates$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only targeting templates with this advertiser ID. + */ + advertiserId?: string; + /** + * Select only targeting templates with these IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "template*2015" will return objects with names like + * "template June 2015", "template April 2015", or simply "template 2015". + * Most of the searches also add wildcards implicitly at the start and the + * end of the search string. For example, a search string of "template" will + * match objects with name "my template", "template 2015", or simply + * "template". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + } + export interface Params$Resource$Targetingtemplates$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Targeting template ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + export interface Params$Resource$Targetingtemplates$Update extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TargetingTemplate; + } + + + export class Resource$Userprofiles { + constructor() {} + + + /** + * dfareporting.userProfiles.get + * @desc Gets one user profile by ID. + * @alias dfareporting.userProfiles.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId The user profile ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Userprofiles$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Userprofiles$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Userprofiles$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Userprofiles$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v3.3/userprofiles/{profileId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userProfiles.list + * @desc Retrieves list of user profiles for a user. + * @alias dfareporting.userProfiles.list + * @memberOf! () + * + * @param {object=} params Parameters for request + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Userprofiles$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Userprofiles$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Userprofiles$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Userprofiles$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Userprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dfareporting/v3.3/userprofiles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: [], + pathParams: [], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Userprofiles$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The user profile ID. + */ + profileId?: string; + } + export interface Params$Resource$Userprofiles$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + } + + + export class Resource$Userrolepermissiongroups { + constructor() {} + + + /** + * dfareporting.userRolePermissionGroups.get + * @desc Gets one user role permission group by ID. + * @alias dfareporting.userRolePermissionGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role permission group ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Userrolepermissiongroups$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Userrolepermissiongroups$Get, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Userrolepermissiongroups$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Userrolepermissiongroups$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Userrolepermissiongroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissiongroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissionGroups/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userRolePermissionGroups.list + * @desc Gets a list of all supported user role permission groups. + * @alias dfareporting.userRolePermissionGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Userrolepermissiongroups$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Userrolepermissiongroups$List, + options: MethodOptions| + BodyResponseCallback, + callback: + BodyResponseCallback): + void; + list( + params: Params$Resource$Userrolepermissiongroups$List, + callback: + BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Userrolepermissiongroups$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Userrolepermissiongroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissiongroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissionGroups') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Userrolepermissiongroups$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User role permission group ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userrolepermissiongroups$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Userrolepermissions { + constructor() {} + + + /** + * dfareporting.userRolePermissions.get + * @desc Gets one user role permission by ID. + * @alias dfareporting.userRolePermissions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role permission ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Userrolepermissions$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Userrolepermissions$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Userrolepermissions$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Userrolepermissions$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Userrolepermissions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissions/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userRolePermissions.list + * @desc Gets a list of user role permissions, possibly filtered. + * @alias dfareporting.userRolePermissions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.ids Select only user role permissions with these IDs. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Userrolepermissions$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Userrolepermissions$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Userrolepermissions$List, + callback: BodyResponseCallback): + void; + list(callback: + BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Userrolepermissions$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Userrolepermissions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userrolepermissions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRolePermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Userrolepermissions$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User role permission ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userrolepermissions$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only user role permissions with these IDs. + */ + ids?: string[]; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + + + export class Resource$Userroles { + constructor() {} + + + /** + * dfareporting.userRoles.delete + * @desc Deletes an existing user role. + * @alias dfareporting.userRoles.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete(params?: Params$Resource$Userroles$Delete, options?: MethodOptions): + GaxiosPromise; + delete( + params: Params$Resource$Userroles$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Userroles$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Userroles$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userRoles.get + * @desc Gets one user role by ID. + * @alias dfareporting.userRoles.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Userroles$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Userroles$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Userroles$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Userroles$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userRoles.insert + * @desc Inserts a new user role. + * @alias dfareporting.userRoles.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().UserRole} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert(params?: Params$Resource$Userroles$Insert, options?: MethodOptions): + GaxiosPromise; + insert( + params: Params$Resource$Userroles$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Userroles$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Userroles$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userRoles.list + * @desc Retrieves a list of user roles, possibly filtered. This method + * supports paging. + * @alias dfareporting.userRoles.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.accountUserRoleOnly Select only account level user roles not associated with any specific subaccount. + * @param {string=} params.ids Select only user roles with the specified IDs. + * @param {integer=} params.maxResults Maximum number of results to return. + * @param {string=} params.pageToken Value of the nextPageToken from the previous result page. + * @param {string} params.profileId User profile ID associated with this request. + * @param {string=} params.searchString Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "userrole*2015" will return objects with names like "userrole June 2015", "userrole April 2015", or simply "userrole 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "userrole" will match objects with name "my userrole", "userrole 2015", or simply "userrole". + * @param {string=} params.sortField Field by which to sort the list. + * @param {string=} params.sortOrder Order of sorted results. + * @param {string=} params.subaccountId Select only user roles that belong to this subaccount. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Userroles$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Userroles$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Userroles$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Userroles$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userRoles.patch + * @desc Updates an existing user role. This method supports patch + * semantics. + * @alias dfareporting.userRoles.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id User role ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {().UserRole} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch(params?: Params$Resource$Userroles$Patch, options?: MethodOptions): + GaxiosPromise; + patch( + params: Params$Resource$Userroles$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Userroles$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Userroles$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.userRoles.update + * @desc Updates an existing user role. + * @alias dfareporting.userRoles.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {().UserRole} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update(params?: Params$Resource$Userroles$Update, options?: MethodOptions): + GaxiosPromise; + update( + params: Params$Resource$Userroles$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Userroles$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Userroles$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Userroles$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Userroles$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/userRoles') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Userroles$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userroles$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Userroles$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + export interface Params$Resource$Userroles$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Select only account level user roles not associated with any specific + * subaccount. + */ + accountUserRoleOnly?: boolean; + /** + * Select only user roles with the specified IDs. + */ + ids?: string[]; + /** + * Maximum number of results to return. + */ + maxResults?: number; + /** + * Value of the nextPageToken from the previous result page. + */ + pageToken?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + /** + * Allows searching for objects by name or ID. Wildcards (*) are allowed. + * For example, "userrole*2015" will return objects with names like + * "userrole June 2015", "userrole April 2015", or simply "userrole 2015". + * Most of the searches also add wildcards implicitly at the start and the + * end of the search string. For example, a search string of "userrole" will + * match objects with name "my userrole", "userrole 2015", or simply + * "userrole". + */ + searchString?: string; + /** + * Field by which to sort the list. + */ + sortField?: string; + /** + * Order of sorted results. + */ + sortOrder?: string; + /** + * Select only user roles that belong to this subaccount. + */ + subaccountId?: string; + } + export interface Params$Resource$Userroles$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User role ID. + */ + id?: string; + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + export interface Params$Resource$Userroles$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UserRole; + } + + + export class Resource$Videoformats { + constructor() {} + + + /** + * dfareporting.videoFormats.get + * @desc Gets one video format by ID. + * @alias dfareporting.videoFormats.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer} params.id Video format ID. + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Videoformats$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Videoformats$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Videoformats$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Videoformats$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Videoformats$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Videoformats$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/videoFormats/{id}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dfareporting.videoFormats.list + * @desc Lists available video formats. + * @alias dfareporting.videoFormats.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.profileId User profile ID associated with this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Videoformats$List, options?: MethodOptions): + GaxiosPromise; + list( + params: Params$Resource$Videoformats$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Videoformats$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Videoformats$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Videoformats$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Videoformats$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dfareporting/v3.3/userprofiles/{profileId}/videoFormats') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Videoformats$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Video format ID. + */ + id?: number; + /** + * User profile ID associated with this request. + */ + profileId?: string; + } + export interface Params$Resource$Videoformats$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * User profile ID associated with this request. + */ + profileId?: string; + } +} diff --git a/src/apis/discovery/v1.ts b/src/apis/discovery/v1.ts index d30fec6f555..d9f87f5105d 100644 --- a/src/apis/discovery/v1.ts +++ b/src/apis/discovery/v1.ts @@ -66,7 +66,7 @@ export namespace discovery_v1 { } /** - * APIs Discovery Service + * API Discovery Service * * Provides information about other Google APIs, such as what APIs are * available, the resource, and method details for each API. diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 8c750151274..a5135aaf641 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -118,6 +118,11 @@ export namespace dlp_v2 { * https://cloud.google.com/dlp/docs/concepts-actions to learn more. */ export interface Schema$GooglePrivacyDlpV2Action { + /** + * Enable email notification to project owners and editors on job‘s + * completion/failure. + */ + jobNotificationEmails?: Schema$GooglePrivacyDlpV2JobNotificationEmails; /** * Publish summary to Cloud Security Command Center (Alpha). */ @@ -1508,6 +1513,11 @@ export namespace dlp_v2 { * InfoType description. */ export interface Schema$GooglePrivacyDlpV2InfoTypeDescription { + /** + * Description of the infotype. Translated when language is provided in the + * request. + */ + description?: string; /** * Human readable form of the infoType name. */ @@ -1776,6 +1786,11 @@ export namespace dlp_v2 { */ updateTime?: string; } + /** + * Enable email notification to project owners and editors on jobs's + * completion/failure. + */ + export interface Schema$GooglePrivacyDlpV2JobNotificationEmails {} /** * Contains a configuration to make dlp api calls on a repeating basis. See * https://cloud.google.com/dlp/docs/concepts-job-triggers to learn more. @@ -2602,6 +2617,11 @@ export namespace dlp_v2 { * Message defining a custom regular expression. */ export interface Schema$GooglePrivacyDlpV2Regex { + /** + * The index of the submatch to extract as findings. When not specified, the + * entire match is returned. No more than 3 may be included. + */ + groupIndexes?: number[]; /** * Pattern defining the regular expression. Its syntax * (https://github.com/google/re2/wiki/Syntax) can be found under the @@ -6978,7 +6998,8 @@ export namespace dlp_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.orderBy Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * @param {string=} params.filter Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of ` `. * Supported fields/values for inspect jobs: - `status` - HEALTHY|PAUSED|CANCELLED - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 formatted timestamp, surrounded by quotation marks. Nanoseconds are ignored. - 'error_count' - Number of errors that have occurred while running. * The operator must be `=` or `!=` for status and inspected_storage. Examples: * inspected_storage = cloud_storage AND status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Optional comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case-insensitive, default sorting order is ascending, redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to time the JobTrigger was created. - `update_time`: corresponds to time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - `display_name`: corresponds to JobTrigger's display name. - `status`: corresponds to JobTrigger's status. * @param {integer=} params.pageSize Optional size of the page, can be limited by a server. * @param {string=} params.pageToken Optional page token to continue retrieval. Comes from previous call to ListJobTriggers. `order_by` field must not change for subsequent calls. * @param {string} params.parent The parent resource name, for example `projects/my-project-id`. @@ -7174,6 +7195,24 @@ export namespace dlp_v2 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * Optional. Allows filtering. Supported syntax: * Filter expressions are + * made up of one or more restrictions. * Restrictions can be combined by + * `AND` or `OR` logical operators. A sequence of restrictions implicitly + * uses `AND`. * A restriction has the form of ` `. + * * Supported fields/values for inspect jobs: - `status` - + * HEALTHY|PAUSED|CANCELLED - `inspected_storage` - + * DATASTORE|CLOUD_STORAGE|BIGQUERY - 'last_run_time` - RFC 3339 + * formatted timestamp, surrounded by quotation marks. Nanoseconds are + * ignored. - 'error_count' - Number of errors that have occurred while + * running. * The operator must be `=` or `!=` for status and + * inspected_storage. Examples: * inspected_storage = cloud_storage AND + * status = HEALTHY * inspected_storage = cloud_storage OR inspected_storage + * = bigquery * inspected_storage = cloud_storage AND (state = PAUSED OR + * state = HEALTHY) * last_run_time > \"2017-12-12T00:00:00+00:00\" The + * length of this field should be no more than 500 characters. + */ + filter?: string; /** * Optional comma separated list of triggeredJob fields to order by, * followed by `asc` or `desc` postfix. This list is case-insensitive, @@ -7181,8 +7220,9 @@ export namespace dlp_v2 { * insignificant. Example: `name asc,update_time, create_time desc` * Supported fields are: - `create_time`: corresponds to time the * JobTrigger was created. - `update_time`: corresponds to time the - * JobTrigger was last updated. - `name`: corresponds to JobTrigger's name. - * - `display_name`: corresponds to JobTrigger's display name. - `status`: + * JobTrigger was last updated. - `last_run_time`: corresponds to the last + * time the JobTrigger ran. - `name`: corresponds to JobTrigger's name. - + * `display_name`: corresponds to JobTrigger's display name. - `status`: * corresponds to JobTrigger's status. */ orderBy?: string; diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index c4a954056fb..814ee5f5e5c 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -85,7 +85,7 @@ export namespace docs_v1 { /** * Google Docs API * - * An API for creating and editing Google Docs documents. + * Reads and writes Google Docs documents. * * @example * const {google} = require('googleapis'); @@ -195,7 +195,7 @@ export namespace docs_v1 { */ export interface Schema$Body { /** - * The contents of the body. The indices for the body's content begin + * The contents of the body. The indexes for the body's content begin * at zero. */ content?: Schema$StructuralElement[]; @@ -911,7 +911,7 @@ export namespace docs_v1 { */ export interface Schema$Footer { /** - * The contents of the footer. The indices for a footer's content begin + * The contents of the footer. The indexes for a footer's content begin * at zero. */ content?: Schema$StructuralElement[]; @@ -925,7 +925,7 @@ export namespace docs_v1 { */ export interface Schema$Footnote { /** - * The contents of the footnote. The indices for a footnote's content + * The contents of the footnote. The indexes for a footnote's content * begin at zero. */ content?: Schema$StructuralElement[]; @@ -975,7 +975,7 @@ export namespace docs_v1 { */ export interface Schema$Header { /** - * The contents of the header. The indices for a header's content begin + * The contents of the header. The indexes for a header's content begin * at zero. */ content?: Schema$StructuralElement[]; @@ -1388,7 +1388,7 @@ export namespace docs_v1 { * A collection of Ranges with the same named range ID. Named ranges allow * developers to associate parts of a document with an arbitrary user-defined * label so their contents can be programmatically read or edited at a later - * time. A document may contain multiple named ranges with the same name, but + * time. A document can contain multiple named ranges with the same name, but * every named range has a unique ID. A named range is created with a single * Range, and content inserted inside a named range generally expands that * range. However, certain document changes can cause the range to be split @@ -1723,9 +1723,9 @@ export namespace docs_v1 { /** * The zero-base end index of this paragraph element, exclusive, in Unicode * code units of the UTF-16 encoding. Unicode code units of the UTF-16 - * encoding means that surrogate pairs consume two indices. For example, the + * encoding means that surrogate pairs consume two indexes. For example, the * "GRINNING FACE" emoji would be represented as - * "\uD83D\uDE00" and would consume two indices. + * "\uD83D\uDE00" and would consume two indexes. */ endIndex?: number; /** @@ -1751,9 +1751,9 @@ export namespace docs_v1 { /** * The zero-based start index of this paragraph element, in Unicode code * units of the UTF-16 encoding. Unicode code units of the UTF-16 encoding - * means that surrogate pairs consume two indices. For example, the + * means that surrogate pairs consume two indexes. For example, the * "GRINNING FACE" emoji would be represented as - * "\uD83D\uDE00" and would consume two indices. + * "\uD83D\uDE00" and would consume two indexes. */ startIndex?: number; /** @@ -2378,9 +2378,9 @@ export namespace docs_v1 { /** * The zero-based end index of this structural element, exclusive, in * Unicode code units of the UTF-16 encoding. Unicode code units of the - * UTF-16 encoding means that surrogate pairs consume two indices. For + * UTF-16 encoding means that surrogate pairs consume two indexes. For * example, the "GRINNING FACE" emoji would be represented as - * "\uD83D\uDE00" and would consume two indices. + * "\uD83D\uDE00" and would consume two indexes. */ endIndex?: number; /** @@ -2394,9 +2394,9 @@ export namespace docs_v1 { /** * The zero-based start index of this structural element, in Unicode code * units of the UTF-16 encoding. Unicode code units of the UTF-16 encoding - * means that surrogate pairs consume two indices. For example, the + * means that surrogate pairs consume two indexes. For example, the * "GRINNING FACE" emoji would be represented as - * "\uD83D\uDE00" and would consume two indices. + * "\uD83D\uDE00" and would consume two indexes. */ startIndex?: number; /** @@ -2630,17 +2630,17 @@ export namespace docs_v1 { /** * The zero-based end index of this cell, exclusive, in Unicode code units * of the UTF-16 encoding. Unicode code units of the UTF-16 encoding means - * that surrogate pairs consume two indices. For example, the "GRINNING + * that surrogate pairs consume two indexes. For example, the "GRINNING * FACE" emoji would be represented as "\uD83D\uDE00" and - * would consume two indices. + * would consume two indexes. */ endIndex?: number; /** * The zero-based start index of this cell, in Unicode code units of the * UTF-16 encoding. Unicode code units of the UTF-16 encoding means that - * surrogate pairs consume two indices. For example, the "GRINNING + * surrogate pairs consume two indexes. For example, the "GRINNING * FACE" emoji would be represented as "\uD83D\uDE00" and - * would consume two indices. + * would consume two indexes. */ startIndex?: number; /** @@ -2852,17 +2852,17 @@ export namespace docs_v1 { /** * The zero-based end index of this row, exclusive, in Unicode code units of * the UTF-16 encoding. Unicode code units of the UTF-16 encoding means - * that surrogate pairs consume two indices. For example, the "GRINNING + * that surrogate pairs consume two indexes. For example, the "GRINNING * FACE" emoji would be represented as "\uD83D\uDE00" and - * would consume two indices. + * would consume two indexes. */ endIndex?: number; /** * The zero-based start index of this row, in Unicode code units of the * UTF-16 encoding. Unicode code units of the UTF-16 encoding means that - * surrogate pairs consume two indices. For example, the "GRINNING + * surrogate pairs consume two indexes. For example, the "GRINNING * FACE" emoji would be represented as "\uD83D\uDE00" and - * would consume two indices. + * would consume two indexes. */ startIndex?: number; /** diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index 11a379194d0..464e3aaa08c 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -153,6 +153,24 @@ export namespace firebasehosting_v1beta1 { */ token?: string; } + /** + * A configured rewrite that will direct any requests to a Cloud Run service. + * If the Cloud Run service does not exist when setting or updating your + * Firebase Hosting configuration then the request will fail. Any errors from + * the Cloud Run service (including when the service has been deleted) will be + * passed back down to the end user. + */ + export interface Schema$CloudRunRewrite { + /** + * Optional. The region where the Cloud Run service is hosted. Defaults to + * `us-central1` if not supplied. + */ + region?: string; + /** + * Required. User supplied ID of the Cloud Run service. + */ + serviceId?: string; + } /** * The intended behavior and status information of a domain. */ @@ -406,6 +424,10 @@ export namespace firebasehosting_v1beta1 { * The URL path to rewrite the request to. */ path?: string; + /** + * The request will be forwarded to Cloud Run. + */ + run?: Schema$CloudRunRewrite; } /** * The configuration for how incoming requests to a site should be routed and diff --git a/src/apis/healthcare/README.md b/src/apis/healthcare/README.md new file mode 100644 index 00000000000..78923bb3ed4 --- /dev/null +++ b/src/apis/healthcare/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# @google/healthcare + +> + +## Installation + +```sh +$ npm install @google/healthcare +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). + +## Building a browser bundle + +This library can be used in a browser. To prepare a single file bundle, clone the +[repository](https://github.com/googleapis/google-api-nodejs-client) and run + +```sh +$ cd src/apis/healthcare +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/healthcare.min.js`. Use it from your HTML file: + +```html + + +``` + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/master/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/healthcare/index.ts b/src/apis/healthcare/index.ts new file mode 100644 index 00000000000..052ec651fa3 --- /dev/null +++ b/src/apis/healthcare/index.ts @@ -0,0 +1,33 @@ +// Copyright 2019 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {healthcare_v1alpha} from './v1alpha'; + +export const VERSIONS = { + 'v1alpha': healthcare_v1alpha.Healthcare, +}; + +export function healthcare(version: 'v1alpha'): healthcare_v1alpha.Healthcare; +export function healthcare(options: healthcare_v1alpha.Options): + healthcare_v1alpha.Healthcare; +export function healthcare( + this: GoogleConfigurable, + versionOrOptions: 'v1alpha'|healthcare_v1alpha.Options) { + return getAPI('healthcare', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/healthcare/package.json b/src/apis/healthcare/package.json new file mode 100644 index 00000000000..755b9cd153c --- /dev/null +++ b/src/apis/healthcare/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/healthcare", + "version": "0.1.0", + "description": "healthcare", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=6.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "docs": "typedoc --out docs/", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^0.7.0" + }, + "devDependencies": { + "gts": "^0.9.0", + "null-loader": "^0.1.1", + "ts-loader": "^5.3.3", + "typedoc": "^0.14.0", + "typescript": "~3.3.0", + "webpack": "^4.28.4", + "webpack-cli": "^3.2.1" + } +} diff --git a/src/apis/healthcare/tsconfig.json b/src/apis/healthcare/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/healthcare/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/healthcare/v1alpha.ts b/src/apis/healthcare/v1alpha.ts new file mode 100644 index 00000000000..b12c74bad5c --- /dev/null +++ b/src/apis/healthcare/v1alpha.ts @@ -0,0 +1,8966 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {GaxiosPromise} from 'gaxios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace healthcare_v1alpha { + export interface Options extends GlobalOptions { + version: 'v1alpha'; + } + + let context: APIRequestContext; + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: 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; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Healthcare API + * + * + * + * @example + * const {google} = require('googleapis'); + * const healthcare = google.healthcare('v1alpha'); + * + * @namespace healthcare + * @type {Function} + * @version v1alpha + * @variation v1alpha + * @param {object=} options Options for Healthcare + */ + export class Healthcare { + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + context = {_options: options || {}, google}; + + this.projects = new Resource$Projects(); + } + } + + /** + * An annotation record. + */ + export interface Schema$Annotation { + /** + * Details of the source. + */ + annotationSource?: Schema$AnnotationSource; + /** + * Annnotations for images, e.g., bounding polygons. + */ + imageAnnotation?: Schema$ImageAnnotation; + /** + * Output only. Resource name of the Annotation, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. + */ + name?: string; + /** + * Annotations for resource, e.g., classification tags. + */ + resourceAnnotation?: Schema$ResourceAnnotation; + /** + * Annotations for sentitive texts, e.g., range of such texts. + */ + textAnnotation?: Schema$SensitiveTextAnnotation; + } + /** + * AnnotationSource holds the source information of the annotation. + */ + export interface Schema$AnnotationSource { + /** + * Cloud Healthcare API resource. + */ + cloudHealthcareSource?: Schema$CloudHealthcareSource; + } + /** + * An Annotation store that can store annotation resources such as labels and + * tags for text, image and audio. + */ + export interface Schema$AnnotationStore { + /** + * User-supplied key-value pairs used to organize Annotation stores. Label + * keys must be between 1 and 63 characters long, have a UTF-8 encoding of + * maximum 128 bytes, and must conform to the following PCRE regular + * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be + * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 + * bytes, and must conform to the following PCRE regular expression: + * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated + * with a given store. + */ + labels?: {[key: string]: string;}; + /** + * Output only. Resource name of the Annotation store, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + */ + name?: string; + } + /** + * Specifies the audit configuration for a service. The configuration + * determines which permission types are logged, and what identities, if any, + * are exempted from logging. An AuditConfig must have one or more + * AuditLogConfigs. If there are AuditConfigs for both `allServices` and a + * specific service, the union of the two AuditConfigs is used for that + * service: the log_types specified in each AuditConfig are enabled, and the + * exempted_members in each AuditLogConfig are exempted. Example Policy with + * multiple AuditConfigs: { "audit_configs": [ { + * "service": "allServices" "audit_log_configs": + * [ { "log_type": "DATA_READ", + * "exempted_members": [ "user:foo@gmail.com" ] }, { + * "log_type": "DATA_WRITE", }, { + * "log_type": "ADMIN_READ", } ] }, + * { "service": "fooservice.googleapis.com" + * "audit_log_configs": [ { "log_type": + * "DATA_READ", }, { "log_type": + * "DATA_WRITE", "exempted_members": [ + * "user:bar@gmail.com" ] } ] } + * ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and + * ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, + * and bar@gmail.com from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, + * `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a + * special value that covers all services. + */ + service?: string; + } + /** + * Provides the configuration for logging a type of permissions. Example: { + * "audit_log_configs": [ { "log_type": + * "DATA_READ", "exempted_members": [ + * "user:foo@gmail.com" ] }, { + * "log_type": "DATA_WRITE", } ] } This + * enables 'DATA_READ' and 'DATA_WRITE' logging, while + * exempting foo@gmail.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of + * permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[]; + /** + * The log type that this config enables. + */ + logType?: string; + } + /** + * The BigQuery table to which the output should be written. + */ + export interface Schema$BigQueryDestination { + /** + * Required. The BigQuery dataset to which the DICOM store should be + * exported. If this dataset does not exist, the export call returns an + * error. + */ + dataset?: string; + /** + * If the destination table already exists and this flag is `TRUE`, the + * table will be overwritten by the contents of the DICOM store. If the flag + * is not set and the destination table already exists, the export call + * returns an error. + */ + overwriteTable?: boolean; + /** + * Required. The BigQuery table to which the DICOM store should be written. + * If this table does not exist, a new table with the given name will be + * created. + */ + table?: string; + } + /** + * BigQuery dataset location. + */ + export interface Schema$BigQueryLocation { + /** + * ID of the dataset that houses the BigQuery tables. + */ + datasetId?: string; + /** + * ID of the project that owns the BigQuery datasets. + */ + projectId?: string; + /** + * The configuration for the exported BigQuery schema. + */ + schemaConfig?: Schema$SchemaConfig; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * Unimplemented. The condition that is associated with this binding. NOTE: + * an unsatisfied condition will not allow user access via current binding. + * Different bindings, including their conditions, are examined + * independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. + * `members` can have the following values: * `allUsers`: A special + * identifier that represents anyone who is on the internet; with or + * without a Google account. * `allAuthenticatedUsers`: A special + * identifier that represents anyone who is authenticated with a Google + * account or a service account. * `user:{emailid}`: An email address that + * represents a specific Google account. For example, `alice@gmail.com` . + * * `serviceAccount:{emailid}`: An email address that represents a service + * account. For example, `my-other-app@appspot.gserviceaccount.com`. * + * `group:{emailid}`: An email address that represents a Google group. For + * example, `admins@example.com`. * `domain:{domain}`: A Google Apps + * domain name that represents all the users of that domain. For example, + * `google.com` or `example.com`. + */ + members?: string[]; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, + * `roles/editor`, or `roles/owner`. + */ + role?: string; + } + /** + * A bounding polygon for the detected image annotation. + */ + export interface Schema$BoundingPoly { + label?: string; + vertices?: Schema$Vertex[]; + } + /** + * Cloud Healthcare API resource. + */ + export interface Schema$CloudHealthcareSource { + /** + * Full path of a Cloud Healthcare API resource. + */ + name?: string; + } + /** + * Creates a new message. + */ + export interface Schema$CreateMessageRequest { + /** + * HL7v2 message. + */ + message?: Schema$Message; + } + /** + * A message representing a health dataset. A health dataset represents a + * collection of healthcare data pertaining to one or more patients. This may + * include multiple modalities of healthcare data, such as electronic medical + * records or medical imaging data. + */ + export interface Schema$Dataset { + /** + * Output only. Resource name of the dataset, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + */ + name?: string; + /** + * The default timezone used by this dataset. Must be a either a valid IANA + * time zone name such as "America/New_York" or empty, which + * defaults to UTC. This is used for parsing times in resources (e.g., HL7 + * messages) where no explicit timezone is specified. + */ + timeZone?: string; + } + /** + * Configures de-id options specific to different types of content. Each + * submessage customizes the handling of an + * https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are + * applied in a nested manner at runtime. + */ + export interface Schema$DeidentifyConfig { + /** + * Configures de-id of application/DICOM content. + */ + dicom?: Schema$DicomConfig; + /** + * Configures de-id of application/FHIR content. + */ + fhir?: Schema$FhirConfig; + /** + * Configures de-identification of image pixels wherever they are found in + * the source_dataset. + */ + image?: Schema$ImageConfig; + } + /** + * Redacts identifying information from the specified dataset. + */ + export interface Schema$DeidentifyDatasetRequest { + /** + * Deidentify configuration + */ + config?: Schema$DeidentifyConfig; + /** + * The name of the dataset resource to which the redacted data should be + * written (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * The new dataset must not exist, or the request will fail. + */ + destinationDataset?: string; + } + /** + * Contains multiple sensitive information findings for each resource slice. + */ + export interface Schema$Detail { + findings?: Schema$Finding[]; + } + /** + * Specifies the parameters needed for de-identification of DICOM stores. + */ + export interface Schema$DicomConfig { + /** + * Tags to be whitelisted, for example "PatientID", + * "0010,0010". Any tag that is whitelisted will copied as is. All + * other tags will be omitted. + */ + whitelistTags?: string[]; + } + /** + * Represents a DICOM store. + */ + export interface Schema$DicomStore { + /** + * Output only. Resource name of the DICOM store, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + */ + name?: string; + /** + * Notification destination for new DICOM instances. Supplied by the client. + */ + notificationConfig?: Schema$NotificationConfig; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated + * empty messages in your APIs. A typical example is to use it as the request + * or the response type of an API method. For instance: service Foo { rpc + * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON + * representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Structure to describe the error encountered during batch operation on one + * resource. This is used both for sample errors in operation response, and + * for format of errors in error reports. + */ + export interface Schema$ErrorDetail { + /** + * The status of the error. + */ + error?: Schema$Status; + /** + * The identifier of the resource. + */ + resource?: string; + } + /** + * Exports data from the specified DICOM store. If a given resource (e.g., a + * DICOM object with the same SOPInstance UID) already exists in the output, + * it is overwritten with the version in the source dataset. Exported DICOM + * data will persist when the DICOM store from which it was exported is + * deleted. + */ + export interface Schema$ExportDicomDataRequest { + /** + * Specifies where the exported data should be placed. + */ + outputConfig?: Schema$OutputConfig; + } + /** + * Request to export resources. + */ + export interface Schema$ExportResourcesRequest { + /** + * The BigQuery destination location. The output will be one BigQuery table + * per resource type. The server implements a data-driven FHIR-to-SQL schema + * mapping in support of analytics workloads with BigQuery. Incompatible + * changes to the output schema may be introduced in the future as a result + * of continuous collaboration with the FHIR community to refine the + * [desired SQL projection of FHIR + * resources](https://github.com/rbrush/sql-on-fhir/blob/master/sql-on-fhir.md). + */ + bigqueryDestinationLocation?: Schema$BigQueryLocation; + /** + * The Cloud Storage destination location. Specify a path to a Cloud Storage + * bucket or folder rather than a concrete object. The exported outputs are + * organized by FHIR resource types. The server will create one object per + * resource type. Each object contains newline delimited JSON, and each line + * is a FHIR resource. + */ + gcsDestinationLocation?: Schema$GcsDataLocation; + } + /** + * Represents an expression text. Example: title: "User account + * presence" description: "Determines whether the request has a + * user account" expression: "size(request.user) > 0" + */ + export interface Schema$Expr { + /** + * An optional description of the expression. This is a longer text which + * describes the expression, e.g. when hovered over it in a UI. + */ + description?: string; + /** + * Textual representation of an expression in Common Expression Language + * syntax. The application context of the containing message determines + * which well-known feature set of CEL is supported. + */ + expression?: string; + /** + * An optional string indicating the location of the expression for error + * reporting, e.g. a file name and a position in the file. + */ + location?: string; + /** + * An optional title for the expression, i.e. a short string describing its + * purpose. This can be used e.g. in UIs which allow to enter the + * expression. + */ + title?: string; + } + /** + * Specifies how de-identification of a FHIR store should be handled. + */ + export interface Schema$FhirConfig {} + /** + * Represents a FHIR store. + */ + export interface Schema$FhirStore { + /** + * Whether to disable referential integrity in this FHIR store. This field + * is immutable after FHIR store creation. The default value is false, + * meaning that the API will enforce referential integrity and fail the + * requests that will result in inconsistent state in the FHIR store. When + * this field is set to true, the API will skip referential integrity check. + * Consequently, operations that rely on references, such as + * GetPatientEverything, will not return all the results if broken + * references exist. + */ + disableReferentialIntegrity?: boolean; + /** + * Whether to disable resource versioning for this FHIR store. This field + * can not be changed after the creation of FHIR store. If set to false, + * which is the default behavior, all write operations will cause historical + * versions to be recorded automatically. The historical versions can be + * fetched through the history APIs, but cannot be updated. If set to true, + * no historical versions will be kept. The server will send back errors for + * attempts to read the historical versions. + */ + disableResourceVersioning?: boolean; + /** + * Whether this FHIR store has the [updateCreate + * capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). + * This determines if the client can use an Update operation to create a new + * resource with a client-specified ID. If false, all IDs are + * server-assigned through the Create operation and attempts to Update a + * non-existent resource will return errors. Please treat the audit logs + * with appropriate levels of care if client-specified resource IDs contain + * sensitive data such as patient identifiers, those IDs will be part of the + * FHIR resource path recorded in Cloud audit logs and Cloud Pub/Sub + * notifications. + */ + enableUpdateCreate?: boolean; + /** + * Output only. Resource name of the FHIR store, of the form + * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + name?: string; + /** + * If non-empty, publish all resource modifications of this FHIR store to + * this destination. The Cloud Pub/Sub message attributes will contain a map + * with a string describing the action that has triggered the notification, + * e.g. "action":"CreateResource". + */ + notificationConfig?: Schema$NotificationConfig; + } + export interface Schema$Finding { + /** + * Zero-based ending index of the found text, exclusively. + */ + end?: string; + /** + * The type of information stored in this text range (e.g. HumanName, + * BirthDate, Address, etc.) + */ + infoType?: string; + /** + * Zero-based starting index of the found text, inclusively. + */ + start?: string; + } + /** + * Google Cloud Storage location. + */ + export interface Schema$GcsDataLocation { + /** + * The gcs_uri must be in the format "gs://bucket/path/to/object". + * The gcs_uri may include wildcards in the "path/to/object" part + * to to indicate potential matching of multiple objects. Supported + * wildcards: '*' to match 0 or more non-separator characters + * '**' to match 0 or more characters (including separators). Only + * supported at the end of a path and with no other wildcards. '?' + * to match 1 character. + */ + gcsUri?: string; + } + /** + * The Google Cloud Storage location to which the output should be written. + */ + export interface Schema$GcsDestination { + /** + * MIME types supported by DICOM spec. Each file will be written in the + * following format: + * `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` + * The frame_number component will exist only for multi-frame instances. + * Refer to the DICOM conformance statement for permissible MIME types: + * https://cloud.google.com/healthcare/docs/dicom#wado-rs The following + * extensions will be used for output files: application/dicom -> .dcm + * image/jpeg -> .jpg image/png -> .png If unspecified, the + * instances will be exported in their original DICOM format. + */ + mimeType?: string; + /** + * URI for a Google Cloud Storage directory to which result files should be + * written (e.g., `gs://bucket-id/path/to/destination/dir`). If there is no + * trailing slash, the service will append one when composing the object + * path. The user is responsible for creating the Google Cloud Storage + * bucket referenced in `uri_prefix`. + */ + uriPrefix?: string; + } + /** + * Request message for `GetIamPolicy` method. + */ + export interface Schema$GetIamPolicyRequest {} + /** + * Final response of exporting resources. This structure will be included in + * the response to describe the detailed outcome. It will only be included + * when the operation finishes. + */ + export interface Schema$GoogleCloudHealthcareV1alphaFhirRestExportResourcesResponse { + /** + * The FHIR store name of the resources that have been exported, in the + * format + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + name?: string; + /** + * The total number of resources exported from the requested FHIR store. + */ + resourceCount?: string; + } + /** + * Final response of importing resources. This structure will be included in + * the response to describe the detailed outcome. It will only be included + * when the operation finishes. + */ + export interface Schema$GoogleCloudHealthcareV1alphaFhirRestImportResourcesResponse { + /** + * The number of resources that had errors. + */ + errorCount?: string; + /** + * The total number of resources included in the source data. This is the + * sum of the success and error counts. + */ + inputSize?: string; + /** + * The FHIR store name the resources have been imported to, in the format + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + name?: string; + /** + * The number of resources that have been imported. + */ + successCount?: string; + } + /** + * The Google Cloud Storage location for the input content. + */ + export interface Schema$GoogleCloudHealthcareV1alphaGcsSource { + /** + * Points to a [Google Cloud Storage](https://cloud.google.com/storage/) URI + * containing file(s) with content only. The URI must be in the following + * format: `gs://bucket-id/object-id`. The URI can include wildcards in + * `object-id` and thus identify multiple files. Supported wildcards: + * '*' to match 0 or more non-separator characters '**' to + * match 0 or more characters (including separators). Must be used at the + * end of a path and with no other wildcards in the path. Can also be + * used with a file extension (such as .dcm), which imports all files + * with the extension in the specified directory and its + * sub-directories. For example, `gs://bucket-id/directory-id/**.dcm` + * imports all files with .dcm extensions in `directory-id/` and its + * sub-directories. '?' to match 1 character Returns + * [google.rpc.Code.INVALID_ARGUMENT] for all other URI formats. Files + * matching the wildcard are expected to contain content only, no metadata. + */ + contentUri?: string; + } + /** + * Represents an HL7v2 store. + */ + export interface Schema$Hl7V2Store { + /** + * Output only. Resource name of the HL7v2 store, of the form + * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + */ + name?: string; + /** + * The notification destination all messages (both Ingest & Create) are + * published on. Only the message name is sent as part of the notification. + * If this is unset, no notifications will be sent. Supplied by the client. + */ + notificationConfig?: Schema$NotificationConfig; + /** + * The configuration for the parser. It determines how the server parses the + * messages. + */ + parserConfig?: Schema$ParserConfig; + } + /** + * Message that represents an arbitrary HTTP body. It should only be used for + * payload formats that can't be represented as JSON, such as raw binary + * or an HTML page. This message can be used both in streaming and + * non-streaming API methods in the request as well as the response. It can + * be used as a top-level request field, which is convenient if one wants to + * extract parameters from either the URL or HTTP template into the request + * fields and also want access to the raw HTTP body. Example: message + * GetResourceRequest { // A unique request id. string request_id + * = 1; // The raw HTTP body is bound to this field. + * google.api.HttpBody http_body = 2; } service ResourceService { rpc + * GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc + * UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } + * Example with streaming methods: service CaldavService { rpc + * GetCalendar(stream google.api.HttpBody) returns (stream + * google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) + * returns (stream google.api.HttpBody); } Use of this type only changes + * how the request and response bodies are handled, all other features will + * continue to work unchanged. + */ + export interface Schema$HttpBody { + /** + * The HTTP Content-Type header value specifying the content type of the + * body. + */ + contentType?: string; + /** + * The HTTP request/response body as raw binary. + */ + data?: string; + /** + * Application specific response metadata. Must be set in the first response + * for streaming APIs. + */ + extensions?: Array<{[key: string]: any;}>; + } + /** + * Image annotation. + */ + export interface Schema$ImageAnnotation { + /** + * The list of polygons outlining the sensitive regions in the image. + */ + boundingPolys?: Schema$BoundingPoly[]; + } + /** + * Specifies how de-identification of image pixel should be handled. + */ + export interface Schema$ImageConfig { + /** + * If true, all text found in the image is redacted. + */ + redactAllText?: boolean; + } + /** + * Returns the errors encountered during DICOM store import. + */ + export interface Schema$ImportDicomDataErrorDetails { + /** + * Contains errors encountered in imports of individual resources (e.g., a + * Google Cloud Storage object). + */ + errors?: Schema$ImportError[]; + } + /** + * Imports data into the specified DICOM store. Returns an error if any of the + * files to import are not DICOM files. This API will accept duplicate DICOM + * instances, by simply ignoring the newly pushed instance (it will not + * overwrite). + */ + export interface Schema$ImportDicomDataRequest { + /** + * Specifies where the imported data resides. + */ + inputConfig?: Schema$InputConfig; + } + /** + * Contains error status for each import failure. + */ + export interface Schema$ImportError { + /** + * Resource name. + */ + resource?: string; + /** + * Error status associated with resource. + */ + status?: Schema$Status; + } + /** + * Request to import resources. The FHIR resources to be imported must have + * client supplied IDs. The server will retain the resource IDs. The import + * operation is idempotent. Retry will overwrite existing data identified by + * client supplied IDs. The import operation is not transactional. The server + * will not roll back any committed changes upon partial failures. + */ + export interface Schema$ImportResourcesRequest { + /** + * The content structure in the source location. The default is BUNDLE. + */ + contentStructure?: string; + /** + * The Cloud Storage bucket/folder path to write files that contain error + * details. + */ + gcsErrorLocation?: Schema$GcsDataLocation; + /** + * Cloud Storage source data locations. Each Cloud Storage object should be + * a text file that contains newline delimited JSON structures conforming to + * FHIR standard. + */ + gcsSourceLocation?: Schema$GcsDataLocation; + } + /** + * Ingests a message into the specified HL7v2 store. + */ + export interface Schema$IngestMessageRequest { + /** + * HL7v2 message to ingest. + */ + message?: Schema$Message; + } + /** + * Acknowledges that a message has been ingested into the specified HL7v2 + * store. + */ + export interface Schema$IngestMessageResponse { + /** + * HL7v2 ACK message. + */ + hl7Ack?: string; + /** + * Created message resource. + */ + message?: Schema$Message; + } + /** + * Specifies the location(s) from which data should be imported. + */ + export interface Schema$InputConfig { + /** + * Files on Google Cloud Storage. To enable the Cloud Healthcare API to read + * from resources in your project (e.g. Google Cloud Storage buckets), you + * must give the consumer Cloud Healthcare API service account the proper + * permissions. The service account is: + * `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`. The + * PROJECT_NUMBER identifies the project that contains the source Google + * Cloud Storage bucket. To get the project number, go to the GCP Console + * Dashboard. GcsSource requires the `roles/storage.objectViewer` Cloud IAM + * role. + */ + gcsSource?: Schema$GoogleCloudHealthcareV1alphaGcsSource; + } + /** + * Lists the Annotations in the specified Annotation store. + */ + export interface Schema$ListAnnotationsResponse { + /** + * The returned Annotations names. Won't be more values than the value + * of page_size in the request. + */ + annotations?: string[]; + /** + * Token to retrieve the next page of results or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * Lists the Annotation stores in the given dataset. + */ + export interface Schema$ListAnnotationStoresResponse { + /** + * The returned Annotation stores. Won't be more Annotation stores than + * the value of page_size in the request. + */ + annotationStores?: Schema$AnnotationStore[]; + /** + * Token to retrieve the next page of results or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * Lists the available datasets. + */ + export interface Schema$ListDatasetsResponse { + /** + * The first page of datasets. + */ + datasets?: Schema$Dataset[]; + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * Lists the DICOM stores in the given dataset. + */ + export interface Schema$ListDicomStoresResponse { + /** + * The returned DICOM stores. Won't be more DICOM stores than the value + * of page_size in the request. + */ + dicomStores?: Schema$DicomStore[]; + /** + * Token to retrieve the next page of results or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * Lists the FHIR stores in the given dataset. + */ + export interface Schema$ListFhirStoresResponse { + /** + * The returned FHIR stores. Won't be more FHIR stores than the value of + * page_size in the request. + */ + fhirStores?: Schema$FhirStore[]; + /** + * Token to retrieve the next page of results or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * Lists the HL7v2 stores in the given dataset. + */ + export interface Schema$ListHl7V2StoresResponse { + /** + * The returned HL7v2 stores. Won't be more HL7v2 stores than the value + * of page_size in the request. + */ + hl7V2Stores?: Schema$Hl7V2Store[]; + /** + * Token to retrieve the next page of results or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string; + } + /** + * Lists the messages in the specified HL7v2 store. + */ + export interface Schema$ListMessagesResponse { + /** + * The returned message names. Won't be more values than the value of + * page_size in the request. + */ + messages?: string[]; + /** + * Token to retrieve the next page of results or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents Google Cloud Platform location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For + * example, "Tokyo". + */ + displayName?: string; + /** + * Cross-service attributes for the location. For example + * {"cloud.googleapis.com/region": "us-east1"} + */ + labels?: {[key: string]: string;}; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string; + /** + * Service-specific metadata. For example the available capacity at the + * given location. + */ + metadata?: {[key: string]: any;}; + /** + * Resource name for the location, which may vary between implementations. + * For example: `"projects/example-project/locations/us-east1"` + */ + name?: string; + } + /** + * A complete HL7v2 message. See + * http://www.hl7.org/implement/standards/index.cfm?ref=common for details on + * the standard. + */ + export interface Schema$Message { + /** + * The datetime when the message was created. Set by the server. + */ + createTime?: string; + /** + * Raw message bytes. + */ + data?: string; + /** + * User-supplied key-value pairs used to organize HL7v2 stores. Label keys + * must be between 1 and 63 characters long, have a UTF-8 encoding of + * maximum 128 bytes, and must conform to the following PCRE regular + * expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be + * between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 + * bytes, and must conform to the following PCRE regular expression: + * [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated + * with a given store. + */ + labels?: {[key: string]: string;}; + /** + * The message type and trigger event for this message. MSH-9. + */ + messageType?: string; + /** + * Resource name of the Message, of the form + * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. + * Assigned by the server. + */ + name?: string; + /** + * The parsed version of the raw message data. + */ + parsedData?: Schema$ParsedData; + /** + * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this + * message. + */ + patientIds?: Schema$PatientId[]; + /** + * The hospital that this message came from. MSH-4. + */ + sendFacility?: string; + /** + * The datetime the sending application sent this message. MSH-7. + */ + sendTime?: string; + } + /** + * Specifies where notifications should be sent upon changes to a data store. + */ + export interface Schema$NotificationConfig { + /** + * The [Cloud Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that + * notifications of changes are published on. Supplied by the client. + * PubsubMessage.Data will contain the resource name. + * PubsubMessage.MessageId is the ID of this message. It is guaranteed to be + * unique within the topic. PubsubMessage.PublishTime is the time at which + * the message was published. Notifications are only sent if the topic is + * non-empty. [Topic + * names](https://cloud.google.com/pubsub/docs/overview#names) must be + * scoped to a project. cloud-healthcare@system.gserviceaccount.com must + * have publisher permissions on the given Cloud Pub/Sub topic. Not having + * adequate permissions will cause the calls that send notifications to + * fail. + */ + pubsubTopic?: string; + } + /** + * This resource represents a long-running operation that is the result of a + * network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. + * Some services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any;}; + /** + * The server-assigned name, which is only unique within the same service + * that originally returns it. If you use the default HTTP mapping, the + * `name` should have the format of `operations/some/unique/name`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any;}; + } + /** + * OperationMetadata provides information about the operation execution. + * Returned in the long-running operation's metadata field. + */ + export interface Schema$OperationMetadata { + /** + * The name of the API method that initiated the operation. + */ + apiMethodName?: string; + counter?: Schema$ProgressCounter; + /** + * The time at which the operation was created by the API. + */ + createTime?: string; + /** + * The time at which execution was completed. + */ + endTime?: string; + } + /** + * Specifies the location(s) to which data should be exported. + */ + export interface Schema$OutputConfig { + /** + * BigQueryDestination requires two IAM roles: `roles/bigquery.dataEditor` + * and `roles/bigquery.jobUser`. + */ + bigQueryDestination?: Schema$BigQueryDestination; + /** + * GcsDestination requires `roles/storage.objectAdmin` Cloud IAM role. Note + * that writing a file to the same destination multiple times will result in + * the previous version of the file being overwritten. + */ + gcsDestination?: Schema$GcsDestination; + } + /** + * The content of a HL7v2 message in a structured format. + */ + export interface Schema$ParsedData { + segments?: Schema$Segment[]; + } + /** + * The configuration for the parser. It determines how the server parses the + * messages. + */ + export interface Schema$ParserConfig { + /** + * Determines whether messages with no header are allowed. + */ + allowNullHeader?: boolean; + /** + * Byte(s) to be used as the segment terminator. If this is unset, + * '\r' will be used as segment terminator. + */ + segmentTerminator?: string; + } + /** + * A patient identifier and associated type. + */ + export interface Schema$PatientId { + /** + * ID type, e.g. MRN or NHS. + */ + type?: string; + /** + * The patient's unique identifier. + */ + value?: string; + } + /** + * Defines an Identity and Access Management (IAM) policy. It is used to + * specify access control policies for Cloud Platform resources. A `Policy` + * consists of a list of `bindings`. A `binding` binds a list of `members` to + * a `role`, where the members can be user accounts, Google groups, Google + * domains, and service accounts. A `role` is a named list of permissions + * defined by IAM. **JSON Example** { "bindings": [ { + * "role": "roles/owner", "members": [ + * "user:mike@example.com", "group:admins@example.com", + * "domain:google.com", + * "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { + * "role": "roles/viewer", "members": + * ["user:sean@example.com"] } ] } **YAML + * Example** bindings: - members: - user:mike@example.com - + * group:admins@example.com - domain:google.com - + * serviceAccount:my-other-app@appspot.gserviceaccount.com role: + * roles/owner - members: - user:sean@example.com role: + * roles/viewer For a description of IAM and its features, see the [IAM + * developer's guide](https://cloud.google.com/iam/docs). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members` to a `role`. `bindings` with no members + * will result in an error. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help + * prevent simultaneous updates of a policy from overwriting each other. It + * is strongly suggested that systems make use of the `etag` in the + * read-modify-write cycle to perform policy updates in order to avoid race + * conditions: An `etag` is returned in the response to `getIamPolicy`, and + * systems are expected to put that etag in the request to `setIamPolicy` to + * ensure that their change will be applied to the same version of the + * policy. If no `etag` is provided in the call to `setIamPolicy`, then the + * existing policy is overwritten blindly. + */ + etag?: string; + /** + * Deprecated. + */ + version?: number; + } + /** + * ProgressCounter provides counters to describe an operation's progress. + */ + export interface Schema$ProgressCounter { + /** + * The number of units that failed in the operation. + */ + failure?: string; + /** + * The number of units that are pending in the operation. + */ + pending?: string; + /** + * The number of units that succeeded in the operation. + */ + success?: string; + } + /** + * Resource level annotation. + */ + export interface Schema$ResourceAnnotation { + label?: string; + } + /** + * Configuration for the FHIR BigQuery schema. Determines how the server + * generates the schema. + */ + export interface Schema$SchemaConfig { + /** + * The depth for all recursive structures in the output analytics schema. + * For example, concept in the CodeSystem resource is a recursive structure; + * when the depth is 2, the CodeSystem table will have a column called + * `concept.concept` but not `concept.concept.concept`. If not specified or + * set to 0, the server will use the default value 2. + */ + recursiveStructureDepth?: string; + /** + * Specifies the output schema type. If unspecified, the default is + * `LOSSLESS`. + */ + schemaType?: string; + } + /** + * Request to search the resources in the specified FHIR store. + */ + export interface Schema$SearchResourcesRequest { + /** + * The type of the resource to search. + */ + resourceType?: string; + } + /** + * A segment in a structured format. + */ + export interface Schema$Segment { + /** + * A mapping from the positional location to the value. The key string uses + * indexes separated by dots to identify Fields, components and + * sub-components. To be consistent with how the standard refers to + * different parts of message, we use zero-based indexes for fields and + * one-based indexes for components and sub-components. A bracket notation + * is also used to identify different instances of a repeated field. + * Zero-based indexes are used to refer to each instance. Regex for key: + * (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: (0.1, + * "foo") denotes First component of Field 0 has the value + * "foo". (1.1.2, "bar") denotes Second sub-component + * of the first component of Field 1 has the value "bar". (1[0].1, + * "baz") denotes First component of the first Instance of Field + * 1, which is repeated, has the value "baz". + */ + fields?: {[key: string]: string;}; + /** + * A string that indicates the type of segment, e.g., EVN, PID. + */ + segmentId?: string; + /** + * Set ID for segments that can be in a set. This can be empty if it is + * missing or it is not applicable. + */ + setId?: string; + } + /** + * A TextAnnotation specifies a text range that includes sensitive + * information. + */ + export interface Schema$SensitiveTextAnnotation { + /** + * Maps from a resource slice (e.g. FHIR resource field path) to a set of + * sensitive text findings. For example, Appointment.Narrative text1 --> + * {findings_1, findings_2, findings_3} + */ + details?: {[key: string]: Schema$Detail;}; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size + * of the policy is limited to a few 10s of KB. An empty policy is a valid + * policy but certain Cloud Platform services (such as Projects) might + * reject them. + */ + policy?: Schema$Policy; + /** + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. + * Only the fields in the mask will be modified. If no mask is provided, the + * following default mask is used: paths: "bindings, etag" This + * field is only used by Cloud IAM. + */ + updateMask?: string; + } + /** + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should + * be an enum value of google.rpc.Code, but it may accept additional error + * codes if needed. The error message should be a developer-facing English + * message that helps developers *understand* and *resolve* the error. If a + * localized user-facing error message is needed, put the localized message in + * the error details or localize it in the client. The optional error details + * may contain arbitrary information about the error. There is a predefined + * set of error detail types in the package `google.rpc` that can be used for + * common error conditions. # Language mapping The `Status` message is the + * logical representation of the error model, but it is not necessarily the + * actual wire format. When the `Status` message is exposed in different + * client libraries and different wire protocols, it can be mapped + * differently. For example, it will likely be mapped to some exceptions in + * Java, but more likely mapped to some error codes in C. # Other uses The + * error model and the `Status` message can be used in a variety of + * environments, either with or without APIs, to provide a consistent + * developer experience across different environments. Example uses of this + * error model include: - Partial errors. If a service needs to return + * partial errors to the client, it may embed the `Status` in the normal + * response to indicate the partial errors. - Workflow errors. A typical + * workflow has multiple steps. Each step may have a `Status` message for + * error reporting. - Batch operations. If a client uses batch request and + * batch response, the `Status` message should be used directly inside + * batch response, one for each error sub-response. - Asynchronous + * operations. If an API call embeds asynchronous operation results in its + * response, the status of those operations should be represented directly + * using the `Status` message. - Logging. If some API errors are stored in + * logs, the message `Status` could be used directly after any stripping + * needed for security/privacy reasons. + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set + * of message types for APIs to use. + */ + details?: Array<{[key: string]: any;}>; + /** + * A developer-facing error message, which should be in English. Any + * user-facing error message should be localized and sent in the + * google.rpc.Status.details field, or localized by the client. + */ + message?: string; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with + * wildcards (such as '*' or 'storage.*') are not allowed. + * For more information see [IAM + * Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is + * allowed. + */ + permissions?: string[]; + } + /** + * A 2D coordinate in an image. The origin is the top-left. + */ + export interface Schema$Vertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + + + export class Resource$Projects { + locations: Resource$Projects$Locations; + constructor() { + this.locations = new Resource$Projects$Locations(); + } + } + + + export class Resource$Projects$Locations { + datasets: Resource$Projects$Locations$Datasets; + constructor() { + this.datasets = new Resource$Projects$Locations$Datasets(); + } + + + /** + * healthcare.projects.locations.get + * @desc Gets information about a location. + * @alias healthcare.projects.locations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name for the location. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Locations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Locations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias healthcare.projects.locations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The resource that owns the locations collection, if applicable. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/locations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datasets { + annotationStores: Resource$Projects$Locations$Datasets$Annotationstores; + dicomStores: Resource$Projects$Locations$Datasets$Dicomstores; + fhirStores: Resource$Projects$Locations$Datasets$Fhirstores; + hl7V2Stores: Resource$Projects$Locations$Datasets$Hl7v2stores; + operations: Resource$Projects$Locations$Datasets$Operations; + constructor() { + this.annotationStores = + new Resource$Projects$Locations$Datasets$Annotationstores(); + this.dicomStores = new Resource$Projects$Locations$Datasets$Dicomstores(); + this.fhirStores = new Resource$Projects$Locations$Datasets$Fhirstores(); + this.hl7V2Stores = new Resource$Projects$Locations$Datasets$Hl7v2stores(); + this.operations = new Resource$Projects$Locations$Datasets$Operations(); + } + + + /** + * healthcare.projects.locations.datasets.create + * @desc Creates a new health dataset. + * @alias healthcare.projects.locations.datasets.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.datasetId The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * @param {string} params.parent The name of the project in which the dataset should be created (e.g., `projects/{project_id}/locations/{location_id}`). + * @param {().Dataset} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Datasets$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/datasets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.deidentify + * @desc Creates a new dataset containing de-identified data from the source + * dataset. The metadata field type is OperationMetadata. If the request is + * successful, the response field type is DeidentifySummary. If errors + * occur, details field type is DeidentifyErrorDetails. + * @alias healthcare.projects.locations.datasets.deidentify + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.sourceDataset Source dataset resource name. (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * @param {().DeidentifyDatasetRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deidentify( + params?: Params$Resource$Projects$Locations$Datasets$Deidentify, + options?: MethodOptions): GaxiosPromise; + deidentify( + params: Params$Resource$Projects$Locations$Datasets$Deidentify, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deidentify( + params: Params$Resource$Projects$Locations$Datasets$Deidentify, + callback: BodyResponseCallback): void; + deidentify(callback: BodyResponseCallback): void; + deidentify( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Deidentify| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Deidentify; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Deidentify; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+sourceDataset}:deidentify') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['sourceDataset'], + pathParams: ['sourceDataset'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.delete + * @desc Deletes the specified health dataset and all data contained in the + * dataset. Deleting a dataset does not affect the sources from which the + * dataset was imported (if any). + * @alias healthcare.projects.locations.datasets.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the dataset to delete (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Datasets$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.get + * @desc Gets any metadata associated with a dataset. + * @alias healthcare.projects.locations.datasets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the dataset to read (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Locations$Datasets$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Locations$Datasets$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Datasets$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty + * policy if the resource exists and does not have a policy set. + * @alias healthcare.projects.locations.datasets.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.list + * @desc Lists the health datasets in the current project. + * @alias healthcare.projects.locations.datasets.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of items to return. Capped to 100 if not specified. May not be larger than 1000. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {string} params.parent The name of the project whose datasets should be listed (e.g., `projects/{project_id}/locations/{location_id}`). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Datasets$List, + options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Datasets$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/datasets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.patch + * @desc Updates dataset metadata. + * @alias healthcare.projects.locations.datasets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * @param {().Dataset} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Locations$Datasets$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias healthcare.projects.locations.datasets.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datasets$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If + * the resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. Note: This operation is designed to + * be used for building permission-aware UIs and command-line tools, not for + * authorization checking. This operation may "fail open" without warning. + * @alias healthcare.projects.locations.datasets.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datasets$Testiampermissions, + options?: MethodOptions): + GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the dataset that is being created. The string must match the + * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + */ + datasetId?: string; + /** + * The name of the project in which the dataset should be created (e.g., + * `projects/{project_id}/locations/{location_id}`). + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Deidentify + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Source dataset resource name. (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + */ + sourceDataset?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeidentifyDatasetRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the dataset to delete (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the dataset to read (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`). + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The maximum number of items to return. Capped to 100 if not specified. + * May not be larger than 1000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * The name of the project whose datasets should be listed (e.g., + * `projects/{project_id}/locations/{location_id}`). + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. Resource name of the dataset, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datasets$Annotationstores { + annotations: + Resource$Projects$Locations$Datasets$Annotationstores$Annotations; + constructor() { + this.annotations = + new Resource$Projects$Locations$Datasets$Annotationstores$Annotations(); + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.create + * @desc Creates a new Annotation store within the parent dataset. + * @alias healthcare.projects.locations.datasets.annotationStores.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.annotationStoreId The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * @param {string} params.parent The name of the dataset this Annotation store belongs to. + * @param {().AnnotationStore} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/annotationStores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.delete + * @desc Deletes the specified Annotation store and removes all annotations + * that are contained within it. + * @alias healthcare.projects.locations.datasets.annotationStores.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the Annotation store to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.get + * @desc Gets the specified Annotation store or returns NOT_FOUND if it does + * not exist. + * @alias healthcare.projects.locations.datasets.annotationStores.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the Annotation store to get. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, + options?: MethodOptions): GaxiosPromise; + get(params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.getIamPolicy + * @desc Gets the access control policy for a resource. Returns NOT_FOUND + * error if the resource does not exist. Returns an empty policy if the + * resource exists but does not have a policy set. Authorization requires + * the Google IAM permission `healthcare.AnnotationStores.getIamPolicy` on + * the specified resource + * @alias + * healthcare.projects.locations.datasets.annotationStores.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.list + * @desc Lists the Annotation stores in the given dataset for a source + * store. + * @alias healthcare.projects.locations.datasets.annotationStores.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Restricts stores returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Only filtering on labels is supported, for example `labels.key=value`. + * @param {integer=} params.pageSize Limit on the number of Annotation stores to return in a single response. If zero the default page size of 100 is used. + * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. + * @param {string} params.parent Name of the dataset. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$List, + options?: MethodOptions): + GaxiosPromise; + list( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/annotationStores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.patch + * @desc Updates the specified Annotation store. + * @alias healthcare.projects.locations.datasets.annotationStores.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * @param {().AnnotationStore} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.setIamPolicy + * @desc POLICIES Sets the access control policy for a resource. Replaces + * any existing policy. Authorization requires the Google IAM permission + * 'healthcare.annotationStores.setIamPolicy' on the specified resource + * @alias + * healthcare.projects.locations.datasets.annotationStores.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If + * the resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. There is no permission required to + * make this API call. + * @alias + * healthcare.projects.locations.datasets.annotationStores.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, + options?: MethodOptions): + GaxiosPromise; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the Annotation store that is being created. The string must + * match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + */ + annotationStoreId?: string; + /** + * The name of the dataset this Annotation store belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AnnotationStore; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the Annotation store to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the Annotation store to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Restricts stores returned to those matching a filter. Syntax: + * https://cloud.google.com/appengine/docs/standard/python/search/query_strings + * Only filtering on labels is supported, for example `labels.key=value`. + */ + filter?: string; + /** + * Limit on the number of Annotation stores to return in a single response. + * If zero the default page size of 100 is used. + */ + pageSize?: number; + /** + * The next_page_token value returned from the previous List request, if + * any. + */ + pageToken?: string; + /** + * Name of the dataset. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. Resource name of the Annotation store, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}`. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AnnotationStore; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class + Resource$Projects$Locations$Datasets$Annotationstores$Annotations { + constructor() {} + + + /** + * healthcare.projects.locations.datasets.annotationStores.annotations.create + * @desc Creates a new Annotation record. It is valid to create Annotation + * objects for the same source more than once since a unique ID is assigned + * to each record by this service. + * @alias + * healthcare.projects.locations.datasets.annotationStores.annotations.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. + * @param {().Annotation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/annotations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.annotations.delete + * @desc Deletes an Annotation or returns NOT_FOUND if it does not exist. + * @alias + * healthcare.projects.locations.datasets.annotationStores.annotations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the Annotation to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.annotations.get + * @desc Gets an Annotation. + * @alias + * healthcare.projects.locations.datasets.annotationStores.annotations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the Annotation to retrieve. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, + options?: MethodOptions): GaxiosPromise; + get(params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.annotations.list + * @desc Lists the Annotations in the given Annotation store for a source + * resource. + * @alias + * healthcare.projects.locations.datasets.annotationStores.annotations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Restricts Annotations returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - source_version + * @param {integer=} params.pageSize Limit on the number of Annotations to return in a single response. If zero the default page size of 100 is used. + * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. + * @param {string} params.parent Name of the Annotation store to retrieve Annotations from. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, + options?: MethodOptions): GaxiosPromise; + list( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/annotations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.annotationStores.annotations.patch + * @desc Updates the Annotation. + * @alias + * healthcare.projects.locations.datasets.annotationStores.annotations.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. + * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * @param {().Annotation} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the Annotation store this annotation belongs to. For example, + * `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/myannotationstore`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Annotation; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the Annotation to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the Annotation to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Restricts Annotations returned to those matching a filter. Syntax: + * https://cloud.google.com/appengine/docs/standard/python/search/query_strings + * Fields/functions available for filtering are: - source_version + */ + filter?: string; + /** + * Limit on the number of Annotations to return in a single response. If + * zero the default page size of 100 is used. + */ + pageSize?: number; + /** + * The next_page_token value returned from the previous List request, if + * any. + */ + pageToken?: string; + /** + * Name of the Annotation store to retrieve Annotations from. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Annotationstores$Annotations$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. Resource name of the Annotation, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/annotationStores/{annotation_store_id}/annotations/{annotation_id}`. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Annotation; + } + + + + export class Resource$Projects$Locations$Datasets$Dicomstores { + dicomWeb: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb; + constructor() { + this.dicomWeb = + new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb(); + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.create + * @desc Creates a new DICOM store within the parent dataset. + * @alias healthcare.projects.locations.datasets.dicomStores.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.dicomStoreId The ID of the DICOM store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * @param {string} params.parent The name of the dataset this DICOM store belongs to. + * @param {().DicomStore} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dicomStores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.delete + * @desc Deletes the specified DICOM store and removes all images that are + * contained within it. + * @alias healthcare.projects.locations.datasets.dicomStores.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the DICOM store to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.export + * @desc Exports data to the specified destination by copying it from the + * DICOM store. The metadata field type is OperationMetadata. + * @alias healthcare.projects.locations.datasets.dicomStores.export + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The DICOM store resource name from which the data should be exported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {().ExportDicomDataRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + export( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, + options?: MethodOptions): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + export( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Export, + callback: BodyResponseCallback): void; + export(callback: BodyResponseCallback): void; + export( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Export| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:export') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.get + * @desc Gets the specified DICOM store. + * @alias healthcare.projects.locations.datasets.dicomStores.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the DICOM store to get. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty + * policy if the resource exists and does not have a policy set. + * @alias healthcare.projects.locations.datasets.dicomStores.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + +/** + * healthcare.projects.locations.datasets.dicomStores.import + * @desc Imports data into the DICOM store by copying it from the specified + * source. For errors, the Operation will be populated with error details (in + * the form of ImportDicomDataErrorDetails in error.details), which will hold + * finer-grained error information. The metadata field type is + * OperationMetadata. + * @alias healthcare.projects.locations.datasets.dicomStores.import + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the DICOM store resource into which the data is imported (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {().ImportDicomDataRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ +import(params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, options?: MethodOptions): GaxiosPromise; +import(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; +import(params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import, callback: BodyResponseCallback): void; +import(callback: BodyResponseCallback): void; +import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Import|BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|GaxiosPromise {let params = (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Import; let options = (optionsOrCallback || {}) as MethodOptions; + + if(typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Import; + options = {}; + } + + if(typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; const parameters = {options: Object.assign({url: (rootUrl + '/v1alpha/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), method: 'POST'}, options), params, requiredParams: ['name'], pathParams: ['name'], context}; if(callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + }} + + + /** + * healthcare.projects.locations.datasets.dicomStores.list + * @desc Lists the DICOM stores in the given dataset. + * @alias healthcare.projects.locations.datasets.dicomStores.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Limit on the number of DICOM stores to return in a single response. If zero the default page size of 100 is used. + * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. + * @param {string} params.parent Name of the dataset. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dicomStores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.patch + * @desc Updates the specified DICOM store. + * @alias healthcare.projects.locations.datasets.dicomStores.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * @param {().DicomStore} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias healthcare.projects.locations.datasets.dicomStores.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If + * the resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. Note: This operation is designed to + * be used for building permission-aware UIs and command-line tools, not for + * authorization checking. This operation may "fail open" without warning. + * @alias + * healthcare.projects.locations.datasets.dicomStores.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, + options?: MethodOptions): + GaxiosPromise; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the DICOM store that is being created. The string must match + * the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + */ + dicomStoreId?: string; + /** + * The name of the dataset this DICOM store belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DicomStore; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the DICOM store to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Export + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The DICOM store resource name from which the data should be exported + * (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportDicomDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the DICOM store to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Import + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the DICOM store resource into which the data is imported + * (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportDicomDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Limit on the number of DICOM stores to return in a single response. If + * zero the default page size of 100 is used. + */ + pageSize?: number; + /** + * The next_page_token value returned from the previous List request, if + * any. + */ + pageToken?: string; + /** + * Name of the dataset. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. Resource name of the DICOM store, of the form + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DicomStore; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb { + constructor() {} + + + /** + * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebDelete + * @desc Handles DELETE requests equivalent to the GET requests specified in + * the WADO-RS standard. Since this implements an industry standard API, the + * dicom_web_path is interpreted directly by the serving binary. For + * example, if the request is for + * `/v1alpha/projects/{project_id}/locations/{location_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/1.2`, + * then `/studies/1.2` is passed to the serving binary as the + * dicom_web_path. + * @alias + * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebDelete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the WADO-RS standard. + * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + dicomWebDelete( + params?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete, + options?: MethodOptions): GaxiosPromise; + dicomWebDelete( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + dicomWebDelete( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete, + callback: BodyResponseCallback): void; + dicomWebDelete(callback: BodyResponseCallback): void; + dicomWebDelete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dicomWeb/{+dicomWebPath}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['parent', 'dicomWebPath'], + pathParams: ['dicomWebPath', 'parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebGet + * @desc Handles the GET requests specified in the STOW-RS, WADO-RS, or + * QIDO-RS standard. Since this implements an industry standard API, the + * dicom_web_path is interpreted directly by the serving binary. For + * example, if the request is for + * `/v1alpha/projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_id}/series?PatientName={patient_name}`, + * then `studies/{study_id}/series` is passed to the serving binary as the + * dicom_web_path. + * @alias + * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebGet + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}/series`). + * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + dicomWebGet( + params?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget, + options?: MethodOptions): GaxiosPromise; + dicomWebGet( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + dicomWebGet( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget, + callback: BodyResponseCallback): void; + dicomWebGet(callback: BodyResponseCallback): void; + dicomWebGet( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dicomWeb/{+dicomWebPath}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent', 'dicomWebPath'], + pathParams: ['dicomWebPath', 'parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebPost + * @desc Handles the POST requests specified in the STOW-RS, WADO-RS, or + * QIDO-RS standard. Since this implements an industry standard API, the + * dicom_web_path is interpreted directly by the serving binary. For + * example, if the request is for + * `/v1alpha/projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_id}`, + * then `/studies/{study_id}` is passed to the serving binary as the + * dicom_web_path. + * @alias + * healthcare.projects.locations.datasets.dicomStores.dicomWeb.dicomWebPost + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.dicomWebPath The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, or QIDO-RS standard (e.g., studies/{study_id}`). + * @param {string} params.parent The name of the DICOM store that is being accessed (e.g., `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + * @param {().HttpBody} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + dicomWebPost( + params?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost, + options?: MethodOptions): GaxiosPromise; + dicomWebPost( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + dicomWebPost( + params: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost, + callback: BodyResponseCallback): void; + dicomWebPost(callback: BodyResponseCallback): void; + dicomWebPost( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dicomWeb/{+dicomWebPath}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent', 'dicomWebPath'], + pathParams: ['dicomWebPath', 'parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebdelete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The path of the DICOMweb request, as specified in the WADO-RS standard. + */ + dicomWebPath?: string; + /** + * The name of the DICOM store that is being accessed (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebget + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, + * or QIDO-RS standard (e.g., studies/{study_id}/series`). + */ + dicomWebPath?: string; + /** + * The name of the DICOM store that is being accessed (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Dicomwebpost + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The path of the DICOMweb request, as specified in the STOW-RS, WADO-RS, + * or QIDO-RS standard (e.g., studies/{study_id}`). + */ + dicomWebPath?: string; + /** + * The name of the DICOM store that is being accessed (e.g., + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`). + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + + + + export class Resource$Projects$Locations$Datasets$Fhirstores { + resources: Resource$Projects$Locations$Datasets$Fhirstores$Resources; + securityLabels: + Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels; + constructor() { + this.resources = + new Resource$Projects$Locations$Datasets$Fhirstores$Resources(); + this.securityLabels = + new Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels(); + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.create + * @desc Creates a new FHIR store within the parent dataset. + * @alias healthcare.projects.locations.datasets.fhirStores.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.fhirStoreId The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * @param {string} params.parent The name of the dataset this FHIR store belongs to. + * @param {().FhirStore} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/fhirStores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.delete + * @desc Deletes the FHIR store and removes all resources that are contained + * within it. + * @alias healthcare.projects.locations.datasets.fhirStores.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the FHIR store to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.executeBundle + * @desc Executes all the requests in the given Bundle. Conforms to + * http://hl7.org/fhir/http.html#transaction except that only the + * transaction update is supported. + * @alias healthcare.projects.locations.datasets.fhirStores.executeBundle + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Name of the FHIR store in which this bundle will be executed. + * @param {().HttpBody} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + executeBundle( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, + options?: MethodOptions): GaxiosPromise; + executeBundle( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + executeBundle( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle, + callback: BodyResponseCallback): void; + executeBundle(callback: BodyResponseCallback): void; + executeBundle( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.export + * @desc Export resources from the FHIR store to the specified destination. + * Fatal errors will be populated in the error field. Otherwise a detailed + * response will be returned as of type ExportResourcesResponse contained in + * the response field when the operation finishes. The metadata field type + * is OperationMetadata. + * @alias healthcare.projects.locations.datasets.fhirStores.export + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The FHIR store name to export from. The name should be in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * @param {().ExportResourcesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + export( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, + options?: MethodOptions): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + export( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Export, + callback: BodyResponseCallback): void; + export(callback: BodyResponseCallback): void; + export( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Export| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:export') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.get + * @desc Gets the specified FHIR store. + * @alias healthcare.projects.locations.datasets.fhirStores.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the FHIR store to get. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.getIamPolicy + * @desc Gets the access control policy for a FHIR store or security label + * within a FHIR store. Returns NOT_FOUND error if the resource does not + * exist. Returns an empty policy if the resource exists but does not have a + * policy set. Authorization requires the Google IAM permission + * 'healthcare.fhirStores.getIamPolicy' for a FHIR store or + * 'healthcare.securityLabels.getIamPolicy' for a security label + * @alias healthcare.projects.locations.datasets.fhirStores.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.getMetadata + * @desc Gets the capabilities statement for the store. + * @alias healthcare.projects.locations.datasets.fhirStores.getMetadata + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getMetadata( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, + options?: MethodOptions): GaxiosPromise; + getMetadata( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getMetadata( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata, + callback: BodyResponseCallback): void; + getMetadata(callback: BodyResponseCallback): void; + getMetadata( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/metadata') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + +/** + * healthcare.projects.locations.datasets.fhirStores.import + * @desc Import resources to the FHIR store by loading data from the specified + * sources. Fatal errors will be populated in the error field. Otherwise a + * detailed response will be returned as of type ImportResourcesResponse + * contained in the response field when the operation finishes. The metadata + * field type is OperationMetadata. + * @alias healthcare.projects.locations.datasets.fhirStores.import + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The FHIR store name to import FHIR resources to. The name should be in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * @param {().ImportResourcesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ +import(params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, options?: MethodOptions): GaxiosPromise; +import(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; +import(params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import, callback: BodyResponseCallback): void; +import(callback: BodyResponseCallback): void; +import(paramsOrCallback?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Import|BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|GaxiosPromise {let params = (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Import; let options = (optionsOrCallback || {}) as MethodOptions; + + if(typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Import; + options = {}; + } + + if(typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; const parameters = {options: Object.assign({url: (rootUrl + '/v1alpha/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), method: 'POST'}, options), params, requiredParams: ['name'], pathParams: ['name'], context}; if(callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + }} + + + /** + * healthcare.projects.locations.datasets.fhirStores.list + * @desc Lists the FHIR stores in the given dataset. + * @alias healthcare.projects.locations.datasets.fhirStores.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Limit on the number of FHIR stores to return in a single response. If zero the default page size of 100 is used. + * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. + * @param {string} params.parent Name of the dataset. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list(params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/fhirStores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.patch + * @desc Updates the FHIR store. + * @alias healthcare.projects.locations.datasets.fhirStores.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * @param {().FhirStore} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.setIamPolicy + * @desc Sets the access control policy for a FHIR store or security label + * within a FHIR store. Replaces any existing policy. Authorization + * requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' + * for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a + * security label + * @alias healthcare.projects.locations.datasets.fhirStores.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If + * the resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. There is no permission required to + * make this API call. + * @alias + * healthcare.projects.locations.datasets.fhirStores.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, + options?: MethodOptions): + GaxiosPromise; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the FHIR store that is being created. The string must match the + * following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + */ + fhirStoreId?: string; + /** + * The name of the dataset this FHIR store belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FhirStore; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the FHIR store to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Executebundle + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the FHIR store in which this bundle will be executed. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Export + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The FHIR store name to export from. The name should be in the format + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportResourcesRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the FHIR store to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Getmetadata + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the FHIR store to retrieve the capabilities for. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Import + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The FHIR store name to import FHIR resources to. The name should be in + * the format + * `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportResourcesRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Limit on the number of FHIR stores to return in a single response. If + * zero the default page size of 100 is used. + */ + pageSize?: number; + /** + * The next_page_token value returned from the previous List request, if + * any. + */ + pageToken?: string; + /** + * Name of the dataset. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. Resource name of the FHIR store, of the form + * `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FhirStore; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datasets$Fhirstores$Resources { + Patient: Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient; + _history: + Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history; + constructor() { + this.Patient = + new Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient(); + this._history = + new Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history(); + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.conditionalDeleteResource + * @desc Deletes FHIR resources matching a search query. Note: unless + * resource versioning is disabled by setting the + * disable_resource_versioning flag on the FHIR store, the deleted resources + * will be moved to a history repository that can still be retrieved through + * GetResourceVersion and related methods, unless they are removed by the + * DeleteResourceVersions method. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.conditionalDeleteResource + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the FHIR store this resource belongs to. + * @param {string} params.type The type of the resource to update. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + conditionalDeleteResource( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource, + options?: MethodOptions): GaxiosPromise; + conditionalDeleteResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + conditionalDeleteResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource, + callback: BodyResponseCallback): void; + conditionalDeleteResource(callback: BodyResponseCallback): + void; + conditionalDeleteResource( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['parent', 'type'], + pathParams: ['parent', 'type'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.conditionalPatchResource + * @desc Updates parts of a resource if the resource exists based on the + * search criteria specified via query parameters. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.conditionalPatchResource + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the FHIR store this resource belongs to. + * @param {string} params.type The type of the resource to update. + * @param {().HttpBody} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + conditionalPatchResource( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource, + options?: MethodOptions): GaxiosPromise; + conditionalPatchResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + conditionalPatchResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource, + callback: BodyResponseCallback): void; + conditionalPatchResource(callback: BodyResponseCallback): + void; + conditionalPatchResource( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['parent', 'type'], + pathParams: ['parent', 'type'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.conditionalUpdateResource + * @desc Updates the entire resource if the resource exists based on the + * search criteria specified via query parameters. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.conditionalUpdateResource + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the FHIR store this resource belongs to. + * @param {string} params.type The type of the resource to update. + * @param {().HttpBody} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + conditionalUpdateResource( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource, + options?: MethodOptions): GaxiosPromise; + conditionalUpdateResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + conditionalUpdateResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource, + callback: BodyResponseCallback): void; + conditionalUpdateResource(callback: BodyResponseCallback): + void; + conditionalUpdateResource( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['parent', 'type'], + pathParams: ['parent', 'type'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.createResource + * @desc Creates a FHIR resource. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.createResource + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the FHIR store this resource belongs to. + * @param {string} params.type The type of the resource to create. + * @param {().HttpBody} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + createResource( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource, + options?: MethodOptions): GaxiosPromise; + createResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + createResource( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource, + callback: BodyResponseCallback): void; + createResource(callback: BodyResponseCallback): void; + createResource( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/resources/{+type}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent', 'type'], + pathParams: ['parent', 'type'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.delete + * @desc Deletes a FHIR resource. Note: unless resource versioning is + * disabled by setting the disable_resource_versioning flag on the FHIR + * store, the deleted resources will be moved to a history repository that + * can still be retrieved through GetResourceVersion and related methods, + * unless they are removed by the DeleteResourceVersions method. + * @alias healthcare.projects.locations.datasets.fhirStores.resources.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the resource to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.delete$purge + * @desc Deletes all the historical versions of a resource (excluding + * current version) from the FHIR store. To remove all versions of a + * resource, first delete the current version and call this API. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.delete$purge + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the resource to purge. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete$purge( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge, + options?: MethodOptions): GaxiosPromise; + delete$purge( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete$purge( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge, + callback: BodyResponseCallback): void; + delete$purge(callback: BodyResponseCallback): void; + delete$purge( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/$purge') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.get + * @desc Gets a FHIR resource. + * @alias healthcare.projects.locations.datasets.fhirStores.resources.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the resource to retrieve. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get, + options?: MethodOptions): GaxiosPromise; + get(params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.getMetadata + * @desc Gets the capabilities statement for the store. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.getMetadata + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the FHIR store to retrieve the capabilities for. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getMetadata( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata, + options?: MethodOptions): GaxiosPromise; + getMetadata( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getMetadata( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata, + callback: BodyResponseCallback): void; + getMetadata(callback: BodyResponseCallback): void; + getMetadata( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/resources/metadata') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.patch + * @desc Updates part of an existing resource. + * @alias healthcare.projects.locations.datasets.fhirStores.resources.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the resource to update. + * @param {().HttpBody} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.searchResources + * @desc Searches resources in the given FHIR store. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.searchResources + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Name of the FHIR store to retrieve resources from. + * @param {string} params.resourceType The type of the resource to search. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + searchResources( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources, + options?: MethodOptions): GaxiosPromise; + searchResources( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + searchResources( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources, + callback: BodyResponseCallback): void; + searchResources(callback: BodyResponseCallback): void; + searchResources( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/resources/{+resourceType}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent', 'resourceType'], + pathParams: ['parent', 'resourceType'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.update + * @desc Updates the entire resource or creates a new resource with a client + * specified ID if the resource does not exist and the FHIR store has + * enable_update_create set. + * @alias healthcare.projects.locations.datasets.fhirStores.resources.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the resource to update. + * @param {().HttpBody} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update, + options?: MethodOptions): GaxiosPromise; + update( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources._search + * @desc Searches resources in the given FHIR store. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources._search + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Name of the FHIR store to retrieve resources from. + * @param {().SearchResourcesRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + _search( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search, + options?: MethodOptions): GaxiosPromise; + _search( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + _search( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search, + callback: BodyResponseCallback): void; + _search(callback: BodyResponseCallback): void; + _search( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/resources/_search') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionaldeleteresource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The type of the resource to update. + */ + type?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalpatchresource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The type of the resource to update. + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Conditionalupdateresource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The type of the resource to update. + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Createresource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the FHIR store this resource belongs to. + */ + parent?: string; + /** + * The type of the resource to create. + */ + type?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the resource to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Delete$purge + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the resource to purge. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the resource to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Getmetadata + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the FHIR store to retrieve the capabilities for. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Searchresources + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the FHIR store to retrieve resources from. + */ + parent?: string; + /** + * The type of the resource to search. + */ + resourceType?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_search + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the FHIR store to retrieve resources from. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchResourcesRequest; + } + + export class + Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient { + constructor() {} + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources.Patient.get$everything + * @desc Gets all the resources in the patient compartment. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources.Patient.get$everything + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.end The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope. + * @param {string} params.name Name of the patient for which the information is required. + * @param {string=} params.start The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get$everything( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything, + options?: MethodOptions): GaxiosPromise; + get$everything( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get$everything( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything, + callback: BodyResponseCallback): void; + get$everything(callback: BodyResponseCallback): void; + get$everything( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/$everything') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$Patient$Get$everything + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The response includes records prior to the end date. If no end date is + * provided, all records subsequent to the start date are in scope. + */ + end?: string; + /** + * Name of the patient for which the information is required. + */ + name?: string; + /** + * The response includes records subsequent to the start date. If no start + * date is provided, all records prior to the end date are in scope. + */ + start?: string; + } + + + export class + Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history { + constructor() {} + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources._history.get + * @desc Gets a version (current or historical) of FHIR resource by version + * id. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources._history.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the resource version to retrieve. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get, + options?: MethodOptions): GaxiosPromise; + get(params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.resources._history.list + * @desc Lists all the versions of a resource (including the current version + * and deleted versions) from the FHIR store. + * @alias + * healthcare.projects.locations.datasets.fhirStores.resources._history.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the resource to retrieve. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List, + options?: MethodOptions): GaxiosPromise; + list( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/_history') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the resource version to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Resources$_history$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the resource to retrieve. + */ + name?: string; + } + + + + export class Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels { + constructor() {} + + + /** + * healthcare.projects.locations.datasets.fhirStores.securityLabels.getIamPolicy + * @desc Gets the access control policy for a FHIR store or security label + * within a FHIR store. Returns NOT_FOUND error if the resource does not + * exist. Returns an empty policy if the resource exists but does not have a + * policy set. Authorization requires the Google IAM permission + * 'healthcare.fhirStores.getIamPolicy' for a FHIR store or + * 'healthcare.securityLabels.getIamPolicy' for a security label + * @alias + * healthcare.projects.locations.datasets.fhirStores.securityLabels.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {().GetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.fhirStores.securityLabels.setIamPolicy + * @desc Sets the access control policy for a FHIR store or security label + * within a FHIR store. Replaces any existing policy. Authorization + * requires the Google IAM permission 'healthcare.fhirStores.setIamPolicy' + * for a FHIR store or 'healthcare.securityLabels.setIamPolicy' for a + * security label + * @alias + * healthcare.projects.locations.datasets.fhirStores.securityLabels.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Securitylabels$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + + + + export class Resource$Projects$Locations$Datasets$Hl7v2stores { + messages: Resource$Projects$Locations$Datasets$Hl7v2stores$Messages; + constructor() { + this.messages = + new Resource$Projects$Locations$Datasets$Hl7v2stores$Messages(); + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.create + * @desc Creates a new HL7v2 store within the parent dataset. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.hl7V2StoreId The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + * @param {string} params.parent The name of the dataset this HL7v2 store belongs to. + * @param {().Hl7V2Store} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/hl7V2Stores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.delete + * @desc Deletes the specified HL7v2 store and removes all messages that are + * contained within it. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the HL7v2 store to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.get + * @desc Gets the specified HL7v2 store. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the HL7v2 store to get. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy + * @desc Gets the access control policy for a resource. Returns an empty + * policy if the resource exists and does not have a policy set. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, + options?: MethodOptions): GaxiosPromise; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy, + callback: BodyResponseCallback): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.list + * @desc Lists the HL7v2 stores in the given dataset. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Limit on the number of HL7v2 stores to return in a single response. If zero the default page size of 100 is used. + * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. + * @param {string} params.parent Name of the dataset. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, + options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/hl7V2Stores') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.patch + * @desc Updates the HL7v2 store. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * @param {().Hl7V2Store} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy + * @desc Sets the access control policy on the specified resource. Replaces + * any existing policy. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. + * @param {().SetIamPolicyRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + options?: MethodOptions): GaxiosPromise; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + setIamPolicy( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy, + callback: BodyResponseCallback): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. If + * the resource does not exist, this will return an empty set of + * permissions, not a NOT_FOUND error. Note: This operation is designed to + * be used for building permission-aware UIs and command-line tools, not for + * authorization checking. This operation may "fail open" without warning. + * @alias + * healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resource_ REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. + * @param {().TestIamPermissionsRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + options?: MethodOptions): + GaxiosPromise; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + testIamPermissions( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions, + callback: BodyResponseCallback): + void; + testIamPermissions( + callback: BodyResponseCallback): + void; + testIamPermissions( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the HL7v2 store that is being created. The string must match + * the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. + */ + hl7V2StoreId?: string; + /** + * The name of the dataset this HL7v2 store belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Hl7V2Store; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the HL7v2 store to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the HL7v2 store to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Limit on the number of HL7v2 stores to return in a single response. If + * zero the default page size of 100 is used. + */ + pageSize?: number; + /** + * The next_page_token value returned from the previous List request, if + * any. + */ + pageToken?: string; + /** + * Name of the dataset. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Output only. Resource name of the HL7v2 store, of the form + * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Hl7V2Store; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being specified. See the + * operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy detail is being requested. + * See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datasets$Hl7v2stores$Messages { + constructor() {} + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.messages.create + * @desc Creates a message and sends a notification to the Cloud Pub/Sub + * topic. If configured, the MLLP adapter listens to messages created by + * this method and sends those back to the hospital. A successful response + * indicates the message has been persisted to storage and a Cloud Pub/Sub + * notification has been sent. Sending to the hospital by the MLLP adapter + * happens asynchronously. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the dataset this message belongs to. + * @param {().CreateMessageRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + create( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, + options?: MethodOptions): GaxiosPromise; + create( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/messages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.messages.delete + * @desc Deletes an HL7v2 message. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the HL7v2 message to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, + options?: MethodOptions): GaxiosPromise; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.messages.get + * @desc Gets an HL7v2 message. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the HL7v2 message to retrieve. + * @param {string=} params.view Specifies which parts of the Message resource should be returned in the response. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, + options?: MethodOptions): GaxiosPromise; + get(params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest + * @desc Ingests a new HL7v2 message from the hospital and sends a + * notification to the Cloud Pub/Sub topic. Return is an HL7v2 ACK message + * if the message was successfully stored. Otherwise an error is returned. + * If an identical HL7v2 message is created twice only one resource is + * created on the server and no error is reported. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the HL7v2 store this message belongs to. + * @param {().IngestMessageRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + ingest( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, + options?: MethodOptions): GaxiosPromise; + ingest( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + ingest( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest, + callback: BodyResponseCallback): void; + ingest(callback: BodyResponseCallback): void; + ingest( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/messages:ingest') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.messages.list + * @desc Lists all the messages in the given HL7v2 store with support for + * filtering. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Restricts messages returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings Fields/functions available for filtering are: - message_type, from the MSH-9 segment, e.g. 'NOT message_type = "ADT"' - send_date or sendDate, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment; e.g. 'send_date < "2017-01-02"' - send_time, the timestamp of when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment; e.g. 'send_time < "2017-01-02T00:00:00-05:00"' - send_facility, the hospital/trust that the message came from, from the MSH-4 segment, e.g. 'send_facility = "RAL"' - HL7RegExp(expr), which does regular expression matching of expr against the HL7 message payload using re2 (http://code.google.com/p/re2/) syntax; e.g. 'HL7RegExp("^.*\|.*\|CERNER")' - PatientId(value, type), which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments; e.g. 'PatientId("123456", "MRN")' - HasLabel(x), a boolean returning true if the message has a label with key x (having any value) set using the labels map in Message; e.g. 'HasLabel("priority")' - Label(x), a string value of the label with key x as set using the labels map in Message, e.g. 'Label("priority") = "high"' + * @param {string=} params.orderBy Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: - send_time + * @param {integer=} params.pageSize Limit on the number of messages to return in a single response. If zero the default page size of 100 is used. + * @param {string=} params.pageToken The next_page_token value returned from the previous List request, if any. + * @param {string} params.parent Name of the HL7v2 store to retrieve messages from. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, + options?: MethodOptions): GaxiosPromise; + list( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/messages') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.hl7V2Stores.messages.patch + * @desc Update the message. + * @alias healthcare.projects.locations.datasets.hl7V2Stores.messages.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. + * @param {string=} params.updateMask The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Only the `labels` field is allowed to be updated. The labels in the request will be merged with the existing set of labels. Existing labels with the same keys will be updated. + * @param {().Message} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, + options?: MethodOptions): GaxiosPromise; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the dataset this message belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateMessageRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the HL7v2 message to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the HL7v2 message to retrieve. + */ + name?: string; + /** + * Specifies which parts of the Message resource should be returned in the + * response. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Ingest + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the HL7v2 store this message belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$IngestMessageRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Restricts messages returned to those matching a filter. Syntax: + * https://cloud.google.com/appengine/docs/standard/python/search/query_strings + * Fields/functions available for filtering are: - message_type, from the + * MSH-9 segment, e.g. 'NOT message_type = "ADT"' - send_date or sendDate, + * the YYYY-MM-DD date the message was sent in the dataset's time_zone, + * from the MSH-7 segment; e.g. 'send_date < "2017-01-02"' - send_time, + * the timestamp of when the message was sent, using the RFC3339 time + * format for comparisons, from the MSH-7 segment; e.g. 'send_time < + * "2017-01-02T00:00:00-05:00"' - send_facility, the hospital/trust that the + * message came from, from the MSH-4 segment, e.g. 'send_facility = "RAL"' + * - HL7RegExp(expr), which does regular expression matching of expr against + * the HL7 message payload using re2 (http://code.google.com/p/re2/) syntax; + * e.g. 'HL7RegExp("^.*\|.*\|CERNER")' - PatientId(value, type), which + * matches if the message lists a patient having an ID of the given value + * and type in the PID-2, PID-3, or PID-4 segments; e.g. + * 'PatientId("123456", "MRN")' - HasLabel(x), a boolean returning true if + * the message has a label with key x (having any value) set using the + * labels map in Message; e.g. 'HasLabel("priority")' - Label(x), a string + * value of the label with key x as set using the labels map in Message, + * e.g. 'Label("priority") = "high"' + */ + filter?: string; + /** + * Orders messages returned by the specified order_by clause. Syntax: + * https://cloud.google.com/apis/design/design_patterns#sorting_order Fields + * available for ordering are: - send_time + */ + orderBy?: string; + /** + * Limit on the number of messages to return in a single response. If zero + * the default page size of 100 is used. + */ + pageSize?: number; + /** + * The next_page_token value returned from the previous List request, if + * any. + */ + pageToken?: string; + /** + * Name of the HL7v2 store to retrieve messages from. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of the Message, of the form + * `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. + * Assigned by the server. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, + * see + * https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + * Only the `labels` field is allowed to be updated. The labels in the + * request will be merged with the existing set of labels. Existing labels + * with the same keys will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Message; + } + + + + export class Resource$Projects$Locations$Datasets$Operations { + constructor() {} + + + /** + * healthcare.projects.locations.datasets.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use + * this method to poll the operation result at intervals as recommended by + * the API service. + * @alias healthcare.projects.locations.datasets.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get(params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, + options?: MethodOptions): GaxiosPromise; + get(params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * healthcare.projects.locations.datasets.operations.list + * @desc Lists operations that match the specified filter in the request. If + * the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: + * the `name` binding allows API services to override the binding to use + * different resource name schemes, such as `users/x/operations`. To + * override the binding, API services can add a binding such as + * `"/v1/{name=users/x}/operations"` to their service configuration. For + * backwards compatibility, the default name includes the operations + * collection id, however overriding users must ensure the name binding is + * the parent resource, without the operations collection id. + * @alias healthcare.projects.locations.datasets.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Datasets$Operations$List, + options?: MethodOptions): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Operations$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Operations$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Operations$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Datasets$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Operations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } +} diff --git a/src/apis/healthcare/webpack.config.js b/src/apis/healthcare/webpack.config.js new file mode 100644 index 00000000000..7e4545108af --- /dev/null +++ b/src/apis/healthcare/webpack.config.js @@ -0,0 +1,71 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Healthcare', + filename: 'healthcare.min.js', + path: path.resolve(__dirname, 'dist'), + }, + node: { + child_process: 'empty', + fs: 'empty', + crypto: 'empty', + }, + module: { + rules: [ + { + test: /node_modules\/google-auth-library\/src\/crypto\/node\/crypto/, + use: 'null-loader', + }, + { + test: /node_modules\/https-proxy-agent\//, + use: 'null-loader', + }, + { + test: /node_modules\/gcp-metadata\//, + use: 'null-loader', + }, + { + test: /node_modules\/gtoken\//, + use: 'null-loader', + }, + { + test: /node_modules\/pkginfo\//, + use: 'null-loader', + }, + { + test: /node_modules\/semver\//, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 0942fb2acf3..f16be0cd239 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -473,13 +473,6 @@ export namespace iam_v1 { */ nextPageToken?: string; } - /** - * The patch service account request. - */ - export interface Schema$PatchServiceAccountRequest { - serviceAccount?: Schema$ServiceAccount; - updateMask?: string; - } /** * A permission which can be included by a role. */ @@ -2621,76 +2614,6 @@ export namespace iam_v1 { } - /** - * iam.projects.serviceAccounts.patch - * @desc Patches a ServiceAccount. Currently, only the following fields are - * updatable: `display_name` and `description`. Only fields specified in - * the request are garaunteed to be returned in the response. Other fields - * in the response may be empty. Note: The field mask is required. - * @alias iam.projects.serviceAccounts.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. - * @param {().PatchServiceAccountRequest} params.resource Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - patch( - params?: Params$Resource$Projects$Serviceaccounts$Patch, - options?: MethodOptions): GaxiosPromise; - patch( - params: Params$Resource$Projects$Serviceaccounts$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Serviceaccounts$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Serviceaccounts$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|GaxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Serviceaccounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Serviceaccounts$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** * iam.projects.serviceAccounts.setIamPolicy * @desc Sets the IAM access control policy for a ServiceAccount. @@ -2761,7 +2684,11 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.signBlob - * @desc Signs a blob using a service account's system-managed private key. + * @desc **Note**: This method is in the process of being deprecated. Call + * the + * [`signBlob()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signBlob) + * method of the Cloud IAM Service Account Credentials API instead. Signs a + * blob using a service account's system-managed private key. * @alias iam.projects.serviceAccounts.signBlob * @memberOf! () * @@ -2829,10 +2756,14 @@ export namespace iam_v1 { /** * iam.projects.serviceAccounts.signJwt - * @desc Signs a JWT using a service account's system-managed private key. - * If no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets - * an an expiry time of one hour by default. If you request an expiry time - * of more than one hour, the request will fail. + * @desc **Note**: This method is in the process of being deprecated. Call + * the + * [`signJwt()`](/iam/credentials/reference/rest/v1/projects.serviceAccounts/signJwt) + * method of the Cloud IAM Service Account Credentials API instead. Signs a + * JWT using a service account's system-managed private key. If no expiry + * time (`exp`) is provided in the `SignJwtRequest`, IAM sets an an expiry + * time of one hour by default. If you request an expiry time of more than + * one hour, the request will fail. * @alias iam.projects.serviceAccounts.signJwt * @memberOf! () * @@ -3131,28 +3062,6 @@ export namespace iam_v1 { */ pageToken?: string; } - export interface Params$Resource$Projects$Serviceaccounts$Patch extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The resource name of the service account in the following format: - * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as - * a wildcard for the `PROJECT_ID` will infer the project from the `account` - * and the `ACCOUNT` value can be the `email` address or the `unique_id` of - * the service account. In responses the resource name will always be in - * the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PatchServiceAccountRequest; - } export interface Params$Resource$Projects$Serviceaccounts$Setiampolicy extends StandardParameters { /** diff --git a/src/apis/index.ts b/src/apis/index.ts index 9387609bc6a..14048638d15 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -93,6 +93,7 @@ import * as genomics from './genomics'; import * as gmail from './gmail'; import * as groupsmigration from './groupsmigration'; import * as groupssettings from './groupssettings'; +import * as healthcare from './healthcare'; import * as iam from './iam'; import * as iamcredentials from './iamcredentials'; import * as iap from './iap'; @@ -247,6 +248,7 @@ export const APIS: APIList = { gmail: gmail.VERSIONS, groupsmigration: groupsmigration.VERSIONS, groupssettings: groupssettings.VERSIONS, + healthcare: healthcare.VERSIONS, iam: iam.VERSIONS, iamcredentials: iamcredentials.VERSIONS, iap: iap.VERSIONS, @@ -398,6 +400,7 @@ export class GeneratedAPIs { gmail = gmail.gmail; groupsmigration = groupsmigration.groupsmigration; groupssettings = groupssettings.groupssettings; + healthcare = healthcare.healthcare; iam = iam.iam; iamcredentials = iamcredentials.iamcredentials; iap = iap.iap; diff --git a/src/apis/jobs/README.md b/src/apis/jobs/README.md index 891a8591f56..621f306363b 100644 --- a/src/apis/jobs/README.md +++ b/src/apis/jobs/README.md @@ -33,10 +33,6 @@ const { jobs, auth } = Jobs; ``` -## v3 Samples - -You can find samples of v3 of the Talent Solution API [here](https://github.com/GoogleCloudPlatform/nodejs-docs-samples/tree/master/jobs/v3) - ## License This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index d9e63d40717..f3d8ddf9ed3 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -2820,6 +2820,7 @@ export namespace monitoring_v3 { * * @param {object} params Parameters for request * @param {string} params.name The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}". + * @param {boolean=} params.recursive If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3265,6 +3266,12 @@ export namespace monitoring_v3 { * "projects/{project_id_or_number}/groups/{group_id}". */ name?: string; + /** + * If this field is true, then the request means to delete a group with all + * its descendants. Otherwise, the request means to delete a group only when + * it has no descendants. The default value is false. + */ + recursive?: boolean; } export interface Params$Resource$Projects$Groups$Get extends StandardParameters { diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index f133103c403..a4c0a9bd98a 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -857,7 +857,7 @@ export namespace remotebuildexecution_v1 { instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; /** * ID of the created instance. A valid `instance_id` must: be 6-50 - * characters long, contains only lowercase letters, digits, hyphens and + * characters long, contain only lowercase letters, digits, hyphens and * underscores, start with a lowercase letter, and end with a lowercase * letter or a digit. */ diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index e5ae9f322ed..5e3be210538 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -842,7 +842,7 @@ export namespace remotebuildexecution_v1alpha { instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; /** * ID of the created instance. A valid `instance_id` must: be 6-50 - * characters long, contains only lowercase letters, digits, hyphens and + * characters long, contain only lowercase letters, digits, hyphens and * underscores, start with a lowercase letter, and end with a lowercase * letter or a digit. */ diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index 7222cf909ba..4d39bc97c19 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -1147,7 +1147,7 @@ export namespace remotebuildexecution_v2 { instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; /** * ID of the created instance. A valid `instance_id` must: be 6-50 - * characters long, contains only lowercase letters, digits, hyphens and + * characters long, contain only lowercase letters, digits, hyphens and * underscores, start with a lowercase letter, and end with a lowercase * letter or a digit. */ diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index a6d17c1b27c..7c9953ba50a 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -264,9 +264,9 @@ export namespace script_v1 { */ parameters?: any[]; /** - * For Android add-ons only. An ID that represents the user's current - * session in the Android app for Google Docs or Sheets, included as extra - * data in the + * <b>Deprecated</b>. For use with Android add-ons only. An ID + * that represents the user's current session in the Android app for + * Google Docs or Sheets, included as extra data in the * [Intent](https://developer.android.com/guide/components/intents-filters.html) * that launches the add-on. When an Android add-on is run with a session * state, it gains the privileges of a diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index e2e7b5ad187..09e9536dae1 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -3188,9 +3188,10 @@ export namespace serviceconsumermanagement_v1 { * @desc Removes specified project resource identified by tenant resource * tag. It will remove project lien with 'TenantManager' origin if that was * added. It will then attempt to delete the project. If that operation - * fails, this method fails. After the project has been deleted, or if was - * already in DELETED state, resource metadata is permanently removed from - * the tenancy unit. Operation. + * fails, this method fails. Calls to remove already removed or non-existent + * tenant project will succeed. After the project has been deleted, or if + * was already in DELETED state, resource metadata is permanently removed + * from the tenancy unit. Operation. * @alias serviceconsumermanagement.services.tenancyUnits.removeProject * @memberOf! () * diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 1e6fd82300e..0eb0d27161a 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -377,6 +377,12 @@ export namespace servicecontrol_v1 { * Free-form text providing details on the error cause of the error. */ detail?: string; + /** + * Contains public information about the check error. If available, + * `status.code` will be non zero and client can propagate it out as public + * error. + */ + status?: Schema$Status; /** * Subject to whom this error applies. See the specific code enum for more * details on this field. For example: - “project:<project-id or diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index 830a8a2a583..86d1b49b5ec 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -83,7 +83,7 @@ export namespace speech_v1 { } /** - * Cloud Speech API + * Cloud Speech-to-Text API * * Converts audio to text by applying powerful neural network models. * @@ -326,9 +326,9 @@ export namespace speech_v1 { * messages. Valid values are: 8000-48000. 16000 is optimal. For best * results, set the sampling rate of the audio source to 16000 Hz. If * that's not possible, use the native sample rate of the audio source - * (instead of re-sampling). This field is optional for `FLAC` and `WAV` - * audio files and required for all other audio formats. For details, see - * AudioEncoding. + * (instead of re-sampling). This field is optional for `FLAC`, `WAV`. and + * 'MP3' audio files, and is required for all other audio formats. + * For details, see AudioEncoding. */ sampleRateHertz?: number; /** diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index 62534230601..88872c33a49 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -83,7 +83,7 @@ export namespace speech_v1p1beta1 { } /** - * Cloud Speech API + * Cloud Speech-to-Text API * * Converts audio to text by applying powerful neural network models. * @@ -385,9 +385,9 @@ export namespace speech_v1p1beta1 { * messages. Valid values are: 8000-48000. 16000 is optimal. For best * results, set the sampling rate of the audio source to 16000 Hz. If * that's not possible, use the native sample rate of the audio source - * (instead of re-sampling). This field is optional for `FLAC` and `WAV` - * audio files and required for all other audio formats. For details, see - * AudioEncoding. + * (instead of re-sampling). This field is optional for `FLAC`, `WAV`. and + * 'MP3' audio files, and is required for all other audio formats. + * For details, see AudioEncoding. */ sampleRateHertz?: number; /** diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index 6247ad49541..66392d55794 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -209,7 +209,8 @@ export namespace storagetransfer_v1 { */ errorCount?: string; /** - * Error samples. + * Error samples. No more than 100 error log entries may be recorded for a + * given error code for a single task. */ errorLogEntries?: Schema$ErrorLogEntry[]; } @@ -605,7 +606,7 @@ export namespace storagetransfer_v1 { */ name?: string; /** - * The ID of the Google Cloud Platform Console project that owns the job. + * The ID of the Google Cloud Platform Project that owns the job. */ projectId?: string; /** @@ -647,8 +648,8 @@ export namespace storagetransfer_v1 { */ name?: string; /** - * The ID of the Google Cloud Platform Console project that owns the - * operation. Required. + * The ID of the Google Cloud Platform Project that owns the operation. + * Required. */ projectId?: string; /** diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index db5e71c56c6..ff36eb59c97 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -1059,6 +1059,10 @@ export namespace testing_v1 { export interface Schema$RoboStartingIntent { launcherActivity?: Schema$LauncherActivityIntent; startActivity?: Schema$StartActivityIntent; + /** + * Timeout in seconds for each intent. + */ + timeout?: string; } /** * A starting intent specified by an action, uri, and categories. diff --git a/src/apis/videointelligence/index.ts b/src/apis/videointelligence/index.ts index 1d1e71303d0..f110fa4670f 100644 --- a/src/apis/videointelligence/index.ts +++ b/src/apis/videointelligence/index.ts @@ -17,11 +17,13 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {videointelligence_v1} from './v1'; import {videointelligence_v1beta2} from './v1beta2'; import {videointelligence_v1p1beta1} from './v1p1beta1'; +import {videointelligence_v1p2beta1} from './v1p2beta1'; export const VERSIONS = { 'v1': videointelligence_v1.Videointelligence, 'v1beta2': videointelligence_v1beta2.Videointelligence, 'v1p1beta1': videointelligence_v1p1beta1.Videointelligence, + 'v1p2beta1': videointelligence_v1p2beta1.Videointelligence, }; export function videointelligence(version: 'v1'): @@ -36,15 +38,21 @@ export function videointelligence(version: 'v1p1beta1'): videointelligence_v1p1beta1.Videointelligence; export function videointelligence(options: videointelligence_v1p1beta1.Options): videointelligence_v1p1beta1.Videointelligence; +export function videointelligence(version: 'v1p2beta1'): + videointelligence_v1p2beta1.Videointelligence; +export function videointelligence(options: videointelligence_v1p2beta1.Options): + videointelligence_v1p2beta1.Videointelligence; export function videointelligence< T = videointelligence_v1.Videointelligence | videointelligence_v1beta2.Videointelligence | - videointelligence_v1p1beta1.Videointelligence>( + videointelligence_v1p1beta1.Videointelligence | + videointelligence_v1p2beta1.Videointelligence>( this: GoogleConfigurable, versionOrOptions: 'v1'| videointelligence_v1.Options|'v1beta2'| videointelligence_v1beta2.Options|'v1p1beta1'| - videointelligence_v1p1beta1.Options) { + videointelligence_v1p1beta1.Options|'v1p2beta1'| + videointelligence_v1p2beta1.Options) { return getAPI('videointelligence', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/videointelligence/v1p2beta1.ts b/src/apis/videointelligence/v1p2beta1.ts new file mode 100644 index 00000000000..9546ab64066 --- /dev/null +++ b/src/apis/videointelligence/v1p2beta1.ts @@ -0,0 +1,1827 @@ +/** + * Copyright 2019 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import {GaxiosPromise} from 'gaxios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {APIRequestContext, BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from 'googleapis-common'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace videointelligence_v1p2beta1 { + export interface Options extends GlobalOptions { + version: 'v1p2beta1'; + } + + let context: APIRequestContext; + + interface StandardParameters { + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: 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; + /** + * Available to use for quota purposes for server-side applications. Can be + * any arbitrary string assigned to a user, but should not exceed 40 + * characters. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Cloud Video Intelligence API + * + * Detects objects, explicit content, and scene changes in videos. It also + * specifies the region for annotation and transcribes speech to text. + * + * @example + * const {google} = require('googleapis'); + * const videointelligence = google.videointelligence('v1p2beta1'); + * + * @namespace videointelligence + * @type {Function} + * @version v1p2beta1 + * @variation v1p2beta1 + * @param {object=} options Options for Videointelligence + */ + export class Videointelligence { + videos: Resource$Videos; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + context = {_options: options || {}, google}; + + this.videos = new Resource$Videos(); + } + } + + /** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress?: + Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress[]; + } + /** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults?: + Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults[]; + } + /** + * Detected entity from video analysis. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description?: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId?: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode?: string; + } + /** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present + * for that frame. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames?: Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame[]; + } + /** + * Video frame level annotation results for explicit content. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Label annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is + * `Terrier` the category is likely `dog`. And in some cases there might be + * more than one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; + /** + * Detected entity. + */ + entity?: Schema$GoogleCloudVideointelligenceV1beta2_Entity; + /** + * All video frames where a label was detected. + */ + frames?: Schema$GoogleCloudVideointelligenceV1beta2_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments?: Schema$GoogleCloudVideointelligenceV1beta2_LabelSegment[]; + } + /** + * Video frame level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Video segment level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Video segment where a label was detected. + */ + segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; + } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Annotation progress for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. + */ + progressPercent?: number; + /** + * Time when the request was received. + */ + startTime?: string; + /** + * Time of the most recent update. + */ + updateTime?: string; + } + /** + * Annotation results for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error?: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation?: + Schema$GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Label annotations on video level or user specified segment level. There + * is exactly one element for each unique label. + */ + segmentLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1beta2_SpeechTranscription[]; + } + /** + * Video segment. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset?: string; + } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1beta2_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } + /** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress?: + Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress[]; + } + /** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults?: + Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults[]; + } + /** + * Detected entity from video analysis. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description?: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId?: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode?: string; + } + /** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present + * for that frame. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames?: + Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentFrame[]; + } + /** + * Video frame level annotation results for explicit content. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Label annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is + * `Terrier` the category is likely `dog`. And in some cases there might be + * more than one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; + /** + * Detected entity. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity; + /** + * All video frames where a label was detected. + */ + frames?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelSegment[]; + } + /** + * Video frame level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Video segment level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Video segment where a label was detected. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; + } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Annotation progress for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. + */ + progressPercent?: number; + /** + * Time when the request was received. + */ + startTime?: string; + /** + * Time of the most recent update. + */ + updateTime?: string; + } + /** + * Annotation results for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error?: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation?: + Schema$GoogleCloudVideointelligenceV1p1beta1_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Label annotations on video level or user specified segment level. There + * is exactly one element for each unique label. + */ + segmentLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations?: + Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1p1beta1_SpeechTranscription[]; + } + /** + * Video segment. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset?: string; + } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } + /** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress?: + Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress[]; + } + /** + * Video annotation request. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoRequest { + /** + * Requested video annotation features. + */ + features?: string[]; + /** + * The video data bytes. If unset, the input video(s) should be specified + * via `input_uri`. If set, `input_uri` should be unset. + */ + inputContent?: string; + /** + * Input video location. Currently, only [Google Cloud + * Storage](https://cloud.google.com/storage/) URIs are supported, which + * must be specified in the following format: `gs://bucket-id/object-id` + * (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more + * information, see [Request URIs](/storage/docs/reference-uris). A video + * URI may include wildcards in `object-id`, and thus identify multiple + * videos. Supported wildcards: '*' to match 0 or more characters; + * '?' to match 1 character. If unset, the input video should be + * embedded in the request as `input_content`. If set, `input_content` + * should be unset. + */ + inputUri?: string; + /** + * Optional cloud region where annotation should take place. Supported cloud + * regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no + * region is specified, a region will be determined based on video file + * location. + */ + locationId?: string; + /** + * Optional location where the output (in JSON format) should be stored. + * Currently, only [Google Cloud Storage](https://cloud.google.com/storage/) + * URIs are supported, which must be specified in the following format: + * `gs://bucket-id/object-id` (other URI formats return + * google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request + * URIs](/storage/docs/reference-uris). + */ + outputUri?: string; + /** + * Additional video context and/or feature-specific parameters. + */ + videoContext?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoContext; + } + /** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults?: + Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults[]; + } + /** + * Detected entity from video analysis. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description?: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId?: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode?: string; + } + /** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present + * for that frame. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames?: + Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentFrame[]; + } + /** + * Config for EXPLICIT_CONTENT_DETECTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentDetectionConfig { + /** + * Model to use for explicit content detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model?: string; + } + /** + * Video frame level annotation results for explicit content. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Label annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is + * `Terrier` the category is likely `dog`. And in some cases there might be + * more than one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; + /** + * Detected entity. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity; + /** + * All video frames where a label was detected. + */ + frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelSegment[]; + } + /** + * Config for LABEL_DETECTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelDetectionConfig { + /** + * What labels should be detected with LABEL_DETECTION, in addition to + * video-level labels or segment-level labels. If unspecified, defaults to + * `SHOT_MODE`. + */ + labelDetectionMode?: string; + /** + * Model to use for label detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model?: string; + /** + * Whether the video has been shot from a stationary (i.e. non-moving) + * camera. When set to true, might improve detection accuracy for moving + * objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + */ + stationaryCamera?: boolean; + } + /** + * Video frame level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Video segment level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Video segment where a label was detected. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; + } + /** + * Normalized bounding box. The normalized vertex coordinates are relative to + * the original image. Range: [0, 1]. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox { + /** + * Bottom Y coordinate. + */ + bottom?: number; + /** + * Left X coordinate. + */ + left?: number; + /** + * Right X coordinate. + */ + right?: number; + /** + * Top Y coordinate. + */ + top?: number; + } + /** + * Normalized bounding polygon for text (that might not be aligned with axis). + * Contains list of the corner points in clockwise order starting from + * top-left corner. For example, for a rectangular bounding box: When the text + * is horizontal it might look like: 0----1 | | 3----2 When + * it's clockwise rotated 180 degrees around the top-left corner it + * becomes: 2----3 | | 1----0 and the vertex order + * will still be (0, 1, 2, 3). Note that values can be less than 0, or greater + * than 1 due to trignometric calculations for location of the box. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingPoly { + /** + * Normalized vertices of the bounding polygon. + */ + vertices?: Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex[]; + } + /** + * A vertex represents a 2D point in the image. NOTE: the normalized vertex + * coordinates are relative to the original image and range from 0 to 1. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } + /** + * Annotations corresponding to one tracked object. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation { + /** + * Object category's labeling confidence of this track. + */ + confidence?: number; + /** + * Entity to specify the object category that this track is labeled as. + */ + entity?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity; + /** + * Information corresponding to all frames where this object track appears. + * Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame + * messages in frames. Streaming mode: it can only be one + * ObjectTrackingFrame message in frames. + */ + frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame[]; + /** + * Non-streaming batch mode ONLY. Each object track corresponds to one video + * segment where it appears. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; + /** + * Streaming mode ONLY. In streaming mode, we do not know the end time of a + * tracked object before it is completed. Hence, there is no VideoSegment + * info returned. Instead, we provide a unique identifiable integer track_id + * so that the customers can correlate the results of the ongoing + * ObjectTrackAnnotation of the same track_id over time. + */ + trackId?: string; + } + /** + * Video frame level annotations for object detection and tracking. This field + * stores per frame location, time offset, and confidence. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingFrame { + /** + * The normalized bounding box location of this object track for the frame. + */ + normalizedBoundingBox?: + Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingBox; + /** + * The timestamp of the frame in microseconds. + */ + timeOffset?: string; + } + /** + * Config for SHOT_CHANGE_DETECTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_ShotChangeDetectionConfig { + /** + * Model to use for shot change detection. Supported values: + * "builtin/stable" (the default if unset) and + * "builtin/latest". + */ + model?: string; + } + /** + * Provides "hints" to the speech recognizer to favor specific words + * and phrases in the results. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechContext { + /** + * *Optional* A list of strings containing words and phrases + * "hints" so that the speech recognition is more likely to + * recognize them. This can be used to improve the accuracy for specific + * words and phrases, for example, if specific commands are typically spoken + * by the user. This can also be used to add additional words to the + * vocabulary of the recognizer. See [usage + * limits](https://cloud.google.com/speech/limits#content). + */ + phrases?: string[]; + } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Config for SPEECH_TRANSCRIPTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscriptionConfig { + /** + * *Optional* For file formats, such as MXF or MKV, supporting multiple + * audio tracks, specify up to two tracks. Default: track 0. + */ + audioTracks?: number[]; + /** + * *Optional* If set, specifies the estimated number of speakers in the + * conversation. If not set, defaults to '2'. Ignored unless + * enable_speaker_diarization is set to true. + */ + diarizationSpeakerCount?: number; + /** + * *Optional* If 'true', adds punctuation to recognition result + * hypotheses. This feature is only available in select languages. Setting + * this for requests in other languages has no effect at all. The default + * 'false' value does not add punctuation to result hypotheses. + * NOTE: "This is currently offered as an experimental service, + * complimentary to all users. In the future this may be exclusively + * available as a premium feature." + */ + enableAutomaticPunctuation?: boolean; + /** + * *Optional* If 'true', enables speaker detection for each + * recognized word in the top alternative of the recognition result using a + * speaker_tag provided in the WordInfo. Note: When this is true, we send + * all the words from the beginning of the audio for the top alternative in + * every consecutive responses. This is done in order to improve our speaker + * tags as our models learn to identify the speakers in the conversation + * over time. + */ + enableSpeakerDiarization?: boolean; + /** + * *Optional* If `true`, the top result includes a list of words and the + * confidence for those words. If `false`, no word-level confidence + * information is returned. The default is `false`. + */ + enableWordConfidence?: boolean; + /** + * *Optional* If set to `true`, the server will attempt to filter out + * profanities, replacing all but the initial character in each filtered + * word with asterisks, e.g. "f***". If set to `false` or omitted, + * profanities won't be filtered out. + */ + filterProfanity?: boolean; + /** + * *Required* The language of the supplied audio as a + * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. + * Example: "en-US". See [Language + * Support](https://cloud.google.com/speech/docs/languages) for a list of + * the currently supported language codes. + */ + languageCode?: string; + /** + * *Optional* Maximum number of recognition hypotheses to be returned. + * Specifically, the maximum number of `SpeechRecognitionAlternative` + * messages within each `SpeechTranscription`. The server may return fewer + * than `max_alternatives`. Valid values are `0`-`30`. A value of `0` or `1` + * will return a maximum of one. If omitted, will return a maximum of one. + */ + maxAlternatives?: number; + /** + * *Optional* A means to provide context to assist the speech recognition. + */ + speechContexts?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechContext[]; + } + /** + * Annotations related to one detected OCR text snippet. This will contain the + * corresponding text, confidence value, and frame level information for each + * detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation { + /** + * All video segments where OCR detected text appears. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment[]; + /** + * The detected text. + */ + text?: string; + } + /** + * Config for TEXT_DETECTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextDetectionConfig { + /** + * Language hint can be specified if the language to be detected is known a + * priori. It can increase the accuracy of the detection. Language hint must + * be language code in BCP-47 format. Automatic language detection is + * performed if no hint is provided. + */ + languageHints?: string[]; + } + /** + * Video frame level annotation results for text annotation (OCR). Contains + * information regarding timestamp and bounding box locations for the frames + * containing detected OCR text snippets. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame { + /** + * Bounding polygon of the detected text for this frame. + */ + rotatedBoundingBox?: + Schema$GoogleCloudVideointelligenceV1p2beta1_NormalizedBoundingPoly; + /** + * Timestamp of this frame. + */ + timeOffset?: string; + } + /** + * Video segment level annotation results for text detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_TextSegment { + /** + * Confidence for the track of detected text. It is calculated as the + * highest over all frames where OCR detected text appears. + */ + confidence?: number; + /** + * Information related to the frames where OCR detected text appears. + */ + frames?: Schema$GoogleCloudVideointelligenceV1p2beta1_TextFrame[]; + /** + * Video segment where a text snippet was detected. + */ + segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; + } + /** + * Annotation progress for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. + */ + progressPercent?: number; + /** + * Time when the request was received. + */ + startTime?: string; + /** + * Time of the most recent update. + */ + updateTime?: string; + } + /** + * Annotation results for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error?: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation?: + Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Annotations for list of objects detected and tracked in video. + */ + objectAnnotations?: + Schema$GoogleCloudVideointelligenceV1p2beta1_ObjectTrackingAnnotation[]; + /** + * Label annotations on video level or user specified segment level. There + * is exactly one element for each unique label. + */ + segmentLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations?: + Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscription[]; + /** + * OCR text detection and tracking. Annotations for list of detected text + * snippets. Each will have list of frame information associated with it. + */ + textAnnotations?: + Schema$GoogleCloudVideointelligenceV1p2beta1_TextAnnotation[]; + } + /** + * Video context and/or feature-specific parameters. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoContext { + /** + * Config for EXPLICIT_CONTENT_DETECTION. + */ + explicitContentDetectionConfig?: + Schema$GoogleCloudVideointelligenceV1p2beta1_ExplicitContentDetectionConfig; + /** + * Config for LABEL_DETECTION. + */ + labelDetectionConfig?: + Schema$GoogleCloudVideointelligenceV1p2beta1_LabelDetectionConfig; + /** + * Video segments to annotate. The segments may overlap and are not required + * to be contiguous or span the whole video. If unspecified, each video is + * treated as a single segment. + */ + segments?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment[]; + /** + * Config for SHOT_CHANGE_DETECTION. + */ + shotChangeDetectionConfig?: + Schema$GoogleCloudVideointelligenceV1p2beta1_ShotChangeDetectionConfig; + /** + * Config for SPEECH_TRANSCRIPTION. + */ + speechTranscriptionConfig?: + Schema$GoogleCloudVideointelligenceV1p2beta1_SpeechTranscriptionConfig; + /** + * Config for TEXT_DETECTION. + */ + textDetectionConfig?: + Schema$GoogleCloudVideointelligenceV1p2beta1_TextDetectionConfig; + } + /** + * Video segment. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset?: string; + } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } + /** + * Video annotation progress. Included in the `metadata` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoProgress { + /** + * Progress metadata for all videos specified in `AnnotateVideoRequest`. + */ + annotationProgress?: + Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress[]; + } + /** + * Video annotation response. Included in the `response` field of the + * `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$GoogleCloudVideointelligenceV1_AnnotateVideoResponse { + /** + * Annotation results for all videos specified in `AnnotateVideoRequest`. + */ + annotationResults?: + Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults[]; + } + /** + * Detected entity from video analysis. + */ + export interface Schema$GoogleCloudVideointelligenceV1_Entity { + /** + * Textual description, e.g. `Fixed-gear bicycle`. + */ + description?: string; + /** + * Opaque entity ID. Some IDs may be available in [Google Knowledge Graph + * Search API](https://developers.google.com/knowledge-graph/). + */ + entityId?: string; + /** + * Language code for `description` in BCP-47 format. + */ + languageCode?: string; + } + /** + * Explicit content annotation (based on per-frame visual signals only). If no + * explicit content has been detected in a frame, no annotations are present + * for that frame. + */ + export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation { + /** + * All video frames where explicit content was detected. + */ + frames?: Schema$GoogleCloudVideointelligenceV1_ExplicitContentFrame[]; + } + /** + * Video frame level annotation results for explicit content. + */ + export interface Schema$GoogleCloudVideointelligenceV1_ExplicitContentFrame { + /** + * Likelihood of the pornography content.. + */ + pornographyLikelihood?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Label annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { + /** + * Common categories for the detected entity. E.g. when the label is + * `Terrier` the category is likely `dog`. And in some cases there might be + * more than one categories e.g. `Terrier` could also be a `pet`. + */ + categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; + /** + * Detected entity. + */ + entity?: Schema$GoogleCloudVideointelligenceV1_Entity; + /** + * All video frames where a label was detected. + */ + frames?: Schema$GoogleCloudVideointelligenceV1_LabelFrame[]; + /** + * All video segments where a label was detected. + */ + segments?: Schema$GoogleCloudVideointelligenceV1_LabelSegment[]; + } + /** + * Video frame level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1_LabelFrame { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * video frame for this location. + */ + timeOffset?: string; + } + /** + * Video segment level annotation results for label detection. + */ + export interface Schema$GoogleCloudVideointelligenceV1_LabelSegment { + /** + * Confidence that the label is accurate. Range: [0, 1]. + */ + confidence?: number; + /** + * Video segment where a label was detected. + */ + segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; + } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative { + /** + * The confidence estimate between 0.0 and 1.0. A higher number indicates an + * estimated greater likelihood that the recognized words are correct. This + * field is typically provided only for the top hypothesis, and only for + * `is_final=true` results. Clients should not rely on the `confidence` + * field as it is not guaranteed to be accurate or consistent. The default + * of 0.0 is a sentinel value indicating `confidence` was not set. + */ + confidence?: number; + /** + * Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * A list of word-specific information for each recognized word. + */ + words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$GoogleCloudVideointelligenceV1_SpeechTranscription { + /** + * May contain one or more recognition hypotheses (up to the maximum + * specified in `max_alternatives`). These alternatives are ordered in + * terms of accuracy, with the top (first) alternative being the most + * probable, as ranked by the recognizer. + */ + alternatives?: + Schema$GoogleCloudVideointelligenceV1_SpeechRecognitionAlternative[]; + /** + * Output only. The [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) + * language tag of the language in this result. This language code was + * detected to have the most likelihood of being spoken in the audio. + */ + languageCode?: string; + } + /** + * Annotation progress for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Approximate percentage processed thus far. Guaranteed to be 100 when + * fully processed. + */ + progressPercent?: number; + /** + * Time when the request was received. + */ + startTime?: string; + /** + * Time of the most recent update. + */ + updateTime?: string; + } + /** + * Annotation results for a single video. + */ + export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationResults { + /** + * If set, indicates an error. Note that for a single `AnnotateVideoRequest` + * some videos may succeed and some may fail. + */ + error?: Schema$GoogleRpc_Status; + /** + * Explicit content annotation. + */ + explicitAnnotation?: + Schema$GoogleCloudVideointelligenceV1_ExplicitContentAnnotation; + /** + * Label annotations on frame level. There is exactly one element for each + * unique label. + */ + frameLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Video file location in [Google Cloud + * Storage](https://cloud.google.com/storage/). + */ + inputUri?: string; + /** + * Label annotations on video level or user specified segment level. There + * is exactly one element for each unique label. + */ + segmentLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Shot annotations. Each shot is represented as a video segment. + */ + shotAnnotations?: Schema$GoogleCloudVideointelligenceV1_VideoSegment[]; + /** + * Label annotations on shot level. There is exactly one element for each + * unique label. + */ + shotLabelAnnotations?: + Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; + /** + * Speech transcription. + */ + speechTranscriptions?: + Schema$GoogleCloudVideointelligenceV1_SpeechTranscription[]; + } + /** + * Video segment. + */ + export interface Schema$GoogleCloudVideointelligenceV1_VideoSegment { + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * end of the segment (inclusive). + */ + endTimeOffset?: string; + /** + * Time-offset, relative to the beginning of the video, corresponding to the + * start of the segment (inclusive). + */ + startTimeOffset?: string; + } + /** + * Word-specific information for recognized words. Word information is only + * included in the response when certain request parameters are set, such as + * `enable_word_time_offsets`. + */ + export interface Schema$GoogleCloudVideointelligenceV1_WordInfo { + /** + * Output only. The confidence estimate between 0.0 and 1.0. A higher number + * indicates an estimated greater likelihood that the recognized words are + * correct. This field is set only for the top alternative. This field is + * not guaranteed to be accurate and users should not rely on it to be + * always provided. The default of 0.0 is a sentinel value indicating + * `confidence` was not set. + */ + confidence?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the end of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + endTime?: string; + /** + * Output only. A distinct integer value is assigned for every speaker + * within the audio. This field specifies which one of those speakers was + * detected to have spoken this word. Value ranges from 1 up to + * diarization_speaker_count, and is only set if speaker diarization is + * enabled. + */ + speakerTag?: number; + /** + * Time offset relative to the beginning of the audio, and corresponding to + * the start of the spoken word. This field is only set if + * `enable_word_time_offsets=true` and only in the top hypothesis. This is + * an experimental feature and the accuracy of the time offset can vary. + */ + startTime?: string; + /** + * The word corresponding to this set of information. + */ + word?: string; + } + /** + * This resource represents a long-running operation that is the result of a + * network API call. + */ + export interface Schema$GoogleLongrunning_Operation { + /** + * If the value is `false`, it means the operation is still in progress. If + * `true`, the operation is completed, and either `error` or `response` is + * available. + */ + done?: boolean; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpc_Status; + /** + * Service-specific metadata associated with the operation. It typically + * contains progress information and common metadata such as create time. + * Some services might not provide such metadata. Any method that returns a + * long-running operation should document the metadata type, if any. + */ + metadata?: {[key: string]: any;}; + /** + * The server-assigned name, which is only unique within the same service + * that originally returns it. If you use the default HTTP mapping, the + * `name` should have the format of `operations/some/unique/name`. + */ + name?: string; + /** + * The normal response of the operation in case of success. If the original + * method returns no data on success, such as `Delete`, the response is + * `google.protobuf.Empty`. If the original method is standard + * `Get`/`Create`/`Update`, the response should be the resource. For other + * methods, the response should have the type `XxxResponse`, where `Xxx` is + * the original method name. For example, if the original method name is + * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any;}; + } + /** + * The `Status` type defines a logical error model that is suitable for + * different programming environments, including REST APIs and RPC APIs. It is + * used by [gRPC](https://github.com/grpc). The error model is designed to be: + * - Simple to use and understand for most users - Flexible enough to meet + * unexpected needs # Overview The `Status` message contains three pieces of + * data: error code, error message, and error details. The error code should + * be an enum value of google.rpc.Code, but it may accept additional error + * codes if needed. The error message should be a developer-facing English + * message that helps developers *understand* and *resolve* the error. If a + * localized user-facing error message is needed, put the localized message in + * the error details or localize it in the client. The optional error details + * may contain arbitrary information about the error. There is a predefined + * set of error detail types in the package `google.rpc` that can be used for + * common error conditions. # Language mapping The `Status` message is the + * logical representation of the error model, but it is not necessarily the + * actual wire format. When the `Status` message is exposed in different + * client libraries and different wire protocols, it can be mapped + * differently. For example, it will likely be mapped to some exceptions in + * Java, but more likely mapped to some error codes in C. # Other uses The + * error model and the `Status` message can be used in a variety of + * environments, either with or without APIs, to provide a consistent + * developer experience across different environments. Example uses of this + * error model include: - Partial errors. If a service needs to return + * partial errors to the client, it may embed the `Status` in the normal + * response to indicate the partial errors. - Workflow errors. A typical + * workflow has multiple steps. Each step may have a `Status` message for + * error reporting. - Batch operations. If a client uses batch request and + * batch response, the `Status` message should be used directly inside + * batch response, one for each error sub-response. - Asynchronous + * operations. If an API call embeds asynchronous operation results in its + * response, the status of those operations should be represented directly + * using the `Status` message. - Logging. If some API errors are stored in + * logs, the message `Status` could be used directly after any stripping + * needed for security/privacy reasons. + */ + export interface Schema$GoogleRpc_Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number; + /** + * A list of messages that carry the error details. There is a common set + * of message types for APIs to use. + */ + details?: Array<{[key: string]: any;}>; + /** + * A developer-facing error message, which should be in English. Any + * user-facing error message should be localized and sent in the + * google.rpc.Status.details field, or localized by the client. + */ + message?: string; + } + + + export class Resource$Videos { + constructor() {} + + + /** + * videointelligence.videos.annotate + * @desc Performs asynchronous video annotation. Progress and results can be + * retrieved through the `google.longrunning.Operations` interface. + * `Operation.metadata` contains `AnnotateVideoProgress` (progress). + * `Operation.response` contains `AnnotateVideoResponse` (results). + * @alias videointelligence.videos.annotate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoRequest} params.resource Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + annotate(params?: Params$Resource$Videos$Annotate, options?: MethodOptions): + GaxiosPromise; + annotate( + params: Params$Resource$Videos$Annotate, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + annotate( + params: Params$Resource$Videos$Annotate, + callback: BodyResponseCallback): + void; + annotate(callback: + BodyResponseCallback): + void; + annotate( + paramsOrCallback?: Params$Resource$Videos$Annotate| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Videos$Annotate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Videos$Annotate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://videointelligence.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p2beta1/videos:annotate') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Videos$Annotate extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: + Schema$GoogleCloudVideointelligenceV1p2beta1_AnnotateVideoRequest; + } +} diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index d013cf4a392..052cef47b67 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -143,7 +143,7 @@ export namespace vision_v1 { } /** * Request for performing Google Cloud Vision API tasks over a user-provided - * image, with user-requested features. + * image, with user-requested features, and with context information. */ export interface Schema$AnnotateImageRequest { /** diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 4a0cf90f28c..f3d08e3150d 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -622,7 +622,7 @@ export namespace vision_v1p1beta1 { } /** * Request for performing Google Cloud Vision API tasks over a user-provided - * image, with user-requested features. + * image, with user-requested features, and with context information. */ export interface Schema$GoogleCloudVisionV1p1beta1AnnotateImageRequest { /** diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index f348c589ddb..181745b718d 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -1607,7 +1607,7 @@ export namespace vision_v1p2beta1 { } /** * Request for performing Google Cloud Vision API tasks over a user-provided - * image, with user-requested features. + * image, with user-requested features, and with context information. */ export interface Schema$GoogleCloudVisionV1p2beta1AnnotateImageRequest { /** diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 6b91c038b67..7ecc91f501a 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -760,14 +760,6 @@ export namespace youtube_v3 { * Whether or not the channel has any copyright strikes. */ copyrightStrikesGoodStanding?: boolean; - /** - * Describes the general state of the channel. This field will always show - * if there are any issues whatsoever with the channel. Currently this field - * represents the result of the logical and operation over the community - * guidelines good standing, the copyright strikes good standing and the - * content ID claims good standing, but this may change in the future. - */ - overallGoodStanding?: boolean; } /** * A channel banner returned as the response to a channel_banner.insert call. @@ -1159,7 +1151,15 @@ export namespace youtube_v3 { /** * A map of thumbnail images associated with the channel. For each object in * the map, the key is the name of the thumbnail image, and the value is an - * object that contains other information about the thumbnail. + * object that contains other information about the thumbnail. When + * displaying thumbnails in your application, make sure that your code uses + * the image URLs exactly as they are returned in API responses. For + * example, your application should not use the http domain instead of the + * https domain in a URL returned in an API response. Beginning in July + * 2018, channel thumbnail URLs will only be available in the https domain, + * which is how the URLs appear in API responses. After that time, you might + * see broken images in your application if it tries to load YouTube images + * from the http domain. */ thumbnails?: Schema$ThumbnailDetails; /** @@ -2686,6 +2686,11 @@ export namespace youtube_v3 { * 'superChatEvent'. */ superChatDetails?: Schema$LiveChatSuperChatDetails; + /** + * Details about the Super Sticker event, this is only set if the type is + * 'superStickerEvent'. + */ + superStickerDetails?: Schema$LiveChatSuperStickerDetails; /** * Details about the text message, this is only set if the type is * 'textMessageEvent'. @@ -2814,8 +2819,8 @@ export namespace youtube_v3 { */ currency?: string; /** - * The tier in which the amount belongs to. Lower amounts belong to lower - * tiers. Starts at 1. + * The tier in which the amount belongs. Lower amounts belong to lower + * tiers. The lowest tier is 1. */ tier?: number; /** @@ -2823,6 +2828,29 @@ export namespace youtube_v3 { */ userComment?: string; } + export interface Schema$LiveChatSuperStickerDetails { + /** + * A rendered string that displays the fund amount and currency to the user. + */ + amountDisplayString?: string; + /** + * The amount purchased by the user, in micros (1,750,000 micros = 1.75). + */ + amountMicros?: string; + /** + * The currency in which the purchase was made. + */ + currency?: string; + /** + * Information about the Super Sticker. + */ + superStickerMetadata?: Schema$SuperStickerMetadata; + /** + * The tier in which the amount belongs. Lower amounts belong to lower + * tiers. The lowest tier is 1. + */ + tier?: number; + } export interface Schema$LiveChatTextMessageDetails { /** * The user's message. @@ -3917,6 +3945,10 @@ export namespace youtube_v3 { * True if this event is a Super Chat for Good purchase. */ isSuperChatForGood?: boolean; + /** + * True if this event is a Super Sticker event. + */ + isSuperStickerEvent?: boolean; /** * The tier for the paid message, which is based on the amount of money * spent to purchase the message. @@ -3927,11 +3959,33 @@ export namespace youtube_v3 { * information about the charity the purchase is donated to. */ nonprofit?: Schema$Nonprofit; + /** + * If this event is a Super Sticker event, this field will contain metadata + * about the Super Sticker. + */ + superStickerMetadata?: Schema$SuperStickerMetadata; /** * Details about the supporter. */ supporterDetails?: Schema$ChannelProfileDetails; } + export interface Schema$SuperStickerMetadata { + /** + * Internationalized alt text that describes the sticker image and any + * animation associated with it. + */ + altText?: string; + /** + * Specifies the localization language in which the alt text is returned. + */ + altTextLanguage?: string; + /** + * Unique identifier of the Super Sticker. This is a shorter form of the + * alt_text that includes pack name and a recognizable characteristic of the + * sticker. + */ + stickerId?: string; + } /** * A thumbnail is an image representing a YouTube resource. */ diff --git a/src/generator/templates/package.json.njk b/src/generator/templates/package.json.njk index ff4443da4d0..250044d3839 100644 --- a/src/generator/templates/package.json.njk +++ b/src/generator/templates/package.json.njk @@ -36,7 +36,7 @@ "null-loader": "^0.1.1", "ts-loader": "^5.3.3", "typedoc": "^0.14.0", - "typescript": "~3.2.0", + "typescript": "~3.3.0", "webpack": "^4.28.4", "webpack-cli": "^3.2.1" } diff --git a/src/index.ts b/src/index.ts index 4b7319aad7e..37c5b900138 100644 --- a/src/index.ts +++ b/src/index.ts @@ -110,6 +110,7 @@ export {deploymentmanager_v2} from './apis/deploymentmanager/v2'; export {deploymentmanager_v2beta} from './apis/deploymentmanager/v2beta'; export {dfareporting_v3_1} from './apis/dfareporting/v3.1'; export {dfareporting_v3_2} from './apis/dfareporting/v3.2'; +export {dfareporting_v3_3} from './apis/dfareporting/v3.3'; export {dialogflow_v2} from './apis/dialogflow/v2'; export {dialogflow_v2beta1} from './apis/dialogflow/v2beta1'; export {digitalassetlinks_v1} from './apis/digitalassetlinks/v1'; @@ -144,6 +145,7 @@ export {genomics_v2alpha1} from './apis/genomics/v2alpha1'; export {gmail_v1} from './apis/gmail/v1'; export {groupsmigration_v1} from './apis/groupsmigration/v1'; export {groupssettings_v1} from './apis/groupssettings/v1'; +export {healthcare_v1alpha} from './apis/healthcare/v1alpha'; export {iam_v1} from './apis/iam/v1'; export {iamcredentials_v1} from './apis/iamcredentials/v1'; export {iap_v1} from './apis/iap/v1'; @@ -233,6 +235,7 @@ export {vault_v1} from './apis/vault/v1'; export {videointelligence_v1} from './apis/videointelligence/v1'; export {videointelligence_v1beta2} from './apis/videointelligence/v1beta2'; export {videointelligence_v1p1beta1} from './apis/videointelligence/v1p1beta1'; +export {videointelligence_v1p2beta1} from './apis/videointelligence/v1p2beta1'; export {vision_v1} from './apis/vision/v1'; export {vision_v1p1beta1} from './apis/vision/v1p1beta1'; export {vision_v1p2beta1} from './apis/vision/v1p2beta1';