From 5cb4b09a7218d849e655d22cd6c10d7fa1486297 Mon Sep 17 00:00:00 2001 From: Justin Beckwith Date: Mon, 3 Dec 2018 21:54:30 -0800 Subject: [PATCH] feat: run the generator --- src/apis/accesscontextmanager/v1beta.ts | 6 +- src/apis/adexchangebuyer/v1.2.ts | 12 +- src/apis/adexchangebuyer/v1.3.ts | 37 +- src/apis/adexchangebuyer/v1.4.ts | 67 +- src/apis/adexchangebuyer2/v2beta1.ts | 3 +- src/apis/admin/directory_v1.ts | 58 +- src/apis/admin/reports_v1.ts | 52 +- src/apis/adsense/v1.4.ts | 57 +- src/apis/adsensehost/v4.1.ts | 47 +- src/apis/alertcenter/v1beta1.ts | 13 +- src/apis/analytics/v3.ts | 219 +- src/apis/androiddeviceprovisioning/v1.ts | 16 +- src/apis/androidenterprise/v1.ts | 580 +- src/apis/androidmanagement/v1.ts | 18 +- src/apis/androidpublisher/v2.ts | 4 +- src/apis/androidpublisher/v3.ts | 10 +- src/apis/appengine/v1.ts | 27 +- src/apis/appengine/v1alpha.ts | 10 +- src/apis/appengine/v1beta.ts | 27 +- src/apis/appengine/v1beta4.ts | 22 +- src/apis/appengine/v1beta5.ts | 20 +- src/apis/bigquery/v2.ts | 92 +- src/apis/bigquerydatatransfer/v1.ts | 22 +- src/apis/binaryauthorization/v1beta1.ts | 2 +- src/apis/blogger/v2.ts | 43 +- src/apis/blogger/v3.ts | 66 +- src/apis/books/v1.ts | 316 +- src/apis/calendar/v3.ts | 70 +- src/apis/civicinfo/v2.ts | 12 +- src/apis/classroom/v1.ts | 20 +- src/apis/cloudasset/v1beta1.ts | 12 +- src/apis/cloudbuild/v1.ts | 16 +- src/apis/clouddebugger/v2.ts | 12 +- src/apis/clouderrorreporting/v1beta1.ts | 2 +- src/apis/cloudfunctions/v1.ts | 25 +- src/apis/cloudfunctions/v1beta2.ts | 25 +- src/apis/cloudiot/v1.ts | 522 +- src/apis/cloudkms/v1.ts | 6 +- src/apis/cloudprofiler/v2.ts | 4 +- src/apis/cloudresourcemanager/v1.ts | 8 +- src/apis/cloudresourcemanager/v1beta1.ts | 2 +- src/apis/cloudresourcemanager/v2.ts | 6 +- src/apis/cloudresourcemanager/v2beta1.ts | 6 +- .../{partners => cloudscheduler}/README.md | 6 +- src/apis/cloudscheduler/index.ts | 31 + src/apis/cloudscheduler/package.json | 24 + src/apis/cloudscheduler/v1beta1.ts | 1532 + src/apis/cloudsearch/v1.ts | 240 +- src/apis/cloudshell/v1.ts | 6 +- src/apis/cloudshell/v1alpha1.ts | 6 +- src/apis/cloudtasks/v2beta2.ts | 8 +- src/apis/cloudtasks/v2beta3.ts | 8 +- src/apis/cloudtrace/v1.ts | 2 +- src/apis/cloudtrace/v2.ts | 4 +- src/apis/composer/v1.ts | 21 +- src/apis/composer/v1beta1.ts | 14 +- src/apis/compute/alpha.ts | 944 +- src/apis/compute/beta.ts | 784 +- src/apis/compute/v1.ts | 722 +- src/apis/container/v1.ts | 108 +- src/apis/container/v1beta1.ts | 70 +- src/apis/content/v2.ts | 18 +- src/apis/customsearch/v1.ts | 36 +- src/apis/dataflow/v1b3.ts | 344 +- src/apis/dataproc/v1.ts | 52 +- src/apis/dataproc/v1beta2.ts | 78 +- src/apis/datastore/v1.ts | 18 +- src/apis/datastore/v1beta1.ts | 14 +- src/apis/datastore/v1beta3.ts | 8 +- src/apis/deploymentmanager/alpha.ts | 26 +- src/apis/deploymentmanager/v2.ts | 26 +- src/apis/deploymentmanager/v2beta.ts | 26 +- src/apis/dfareporting/index.ts | 12 +- src/apis/dfareporting/v3.0.ts | 27863 ---------------- src/apis/dfareporting/v3.1.ts | 269 +- src/apis/dfareporting/v3.2.ts | 271 +- src/apis/dialogflow/v2.ts | 65 +- src/apis/dialogflow/v2beta1.ts | 699 +- src/apis/discovery/v1.ts | 55 +- src/apis/dlp/v2.ts | 4 +- src/apis/dns/v1.ts | 2 +- src/apis/dns/v1beta2.ts | 720 +- src/apis/dns/v2beta1.ts | 2 +- src/apis/doubleclicksearch/v2.ts | 26 +- src/apis/drive/v2.ts | 143 +- src/apis/drive/v3.ts | 126 +- src/apis/driveactivity/README.md | 27 + src/apis/{partners => driveactivity}/index.ts | 15 +- .../{partners => driveactivity}/package.json | 4 +- src/apis/driveactivity/v2.ts | 945 + src/apis/file/v1beta1.ts | 12 +- src/apis/firebasedynamiclinks/v1.ts | 9 +- src/apis/firebasehosting/v1beta1.ts | 233 +- src/apis/firestore/v1.ts | 10 +- src/apis/firestore/v1beta1.ts | 24 +- src/apis/firestore/v1beta2.ts | 6 +- src/apis/fitness/v1.ts | 17 +- src/apis/fusiontables/v1.ts | 8 +- src/apis/fusiontables/v2.ts | 8 +- src/apis/games/v1.ts | 4 +- src/apis/gamesManagement/v1management.ts | 2 +- src/apis/genomics/v1.ts | 38 +- src/apis/genomics/v1alpha2.ts | 30 +- src/apis/genomics/v2alpha1.ts | 43 +- src/apis/gmail/v1.ts | 10 +- src/apis/iam/v1.ts | 4 +- src/apis/identitytoolkit/v3.ts | 22 +- src/apis/index.ts | 9 +- src/apis/jobs/v2.ts | 30 +- src/apis/jobs/v3.ts | 46 +- src/apis/jobs/v3p1beta1.ts | 62 +- src/apis/kgsearch/v1.ts | 6 +- src/apis/language/v1.ts | 4 +- src/apis/language/v1beta1.ts | 4 +- src/apis/language/v1beta2.ts | 4 +- src/apis/logging/v2.ts | 16 +- src/apis/logging/v2beta1.ts | 16 +- src/apis/manufacturers/v1.ts | 4 +- src/apis/ml/v1.ts | 18 +- src/apis/monitoring/v3.ts | 1680 +- src/apis/oauth2/v1.ts | 16 +- src/apis/oauth2/v2.ts | 9 +- src/apis/oslogin/v1.ts | 2 +- src/apis/oslogin/v1alpha.ts | 2 +- src/apis/oslogin/v1beta.ts | 2 +- src/apis/pagespeedonline/index.ts | 12 +- src/apis/pagespeedonline/v1.ts | 49 +- src/apis/pagespeedonline/v2.ts | 53 +- src/apis/pagespeedonline/v4.ts | 76 +- src/apis/pagespeedonline/v5.ts | 427 + src/apis/partners/v2.ts | 3662 -- src/apis/people/v1.ts | 6 +- src/apis/plus/v1.ts | 104 +- src/apis/plusDomains/v1.ts | 129 +- src/apis/proximitybeacon/v1beta1.ts | 2 +- src/apis/pubsub/v1.ts | 258 +- src/apis/pubsub/v1beta2.ts | 4 +- src/apis/redis/README.md | 2 +- src/apis/redis/v1.ts | 16 +- src/apis/redis/v1beta1.ts | 17 +- src/apis/replicapoolupdater/v1beta1.ts | 26 +- src/apis/reseller/v1.ts | 13 +- src/apis/runtimeconfig/v1.ts | 6 +- src/apis/runtimeconfig/v1beta1.ts | 6 +- src/apis/script/v1.ts | 16 +- src/apis/servicebroker/v1alpha1.ts | 24 +- src/apis/servicebroker/v1beta1.ts | 24 +- src/apis/serviceconsumermanagement/v1.ts | 242 +- src/apis/servicecontrol/v1.ts | 38 +- src/apis/servicemanagement/v1.ts | 20 +- src/apis/servicenetworking/v1beta.ts | 121 +- src/apis/serviceusage/v1.ts | 14 +- src/apis/serviceusage/v1beta1.ts | 14 +- src/apis/sheets/v4.ts | 10 +- src/apis/siteVerification/v1.ts | 4 +- src/apis/slides/README.md | 2 +- src/apis/slides/v1.ts | 137 +- src/apis/sourcerepo/v1.ts | 6 +- src/apis/spanner/v1.ts | 26 +- src/apis/speech/index.ts | 14 +- src/apis/speech/v1.ts | 6 +- src/apis/speech/v1beta1.ts | 750 - src/apis/speech/v1p1beta1.ts | 2044 ++ src/apis/sqladmin/v1beta4.ts | 14 +- src/apis/storage/v1.ts | 69 +- src/apis/storage/v1beta1.ts | 18 +- src/apis/storage/v1beta2.ts | 39 +- src/apis/storagetransfer/v1.ts | 6 +- src/apis/streetviewpublish/v1.ts | 17 +- src/apis/tagmanager/v1.ts | 6 +- src/apis/tagmanager/v2.ts | 10 +- src/apis/tasks/v1.ts | 2 +- src/apis/testing/v1.ts | 24 + src/apis/toolresults/v1beta3.ts | 29 +- src/apis/tpu/v1.ts | 12 +- src/apis/tpu/v1alpha1.ts | 12 +- src/apis/translate/v2.ts | 6 +- src/apis/vault/v1.ts | 10 +- src/apis/videointelligence/README.md | 2 +- src/apis/videointelligence/v1.ts | 6 +- src/apis/videointelligence/v1beta2.ts | 6 +- src/apis/videointelligence/v1p1beta1.ts | 6 +- src/apis/vision/v1.ts | 48 +- src/apis/vision/v1p1beta1.ts | 48 +- src/apis/vision/v1p2beta1.ts | 48 +- src/apis/webfonts/v1.ts | 2 +- src/apis/youtube/v3.ts | 16 +- src/apis/youtubeAnalytics/v1.ts | 9 +- src/apis/youtubeAnalytics/v1beta1.ts | 9 +- src/index.ts | 7 +- 190 files changed, 14463 insertions(+), 35826 deletions(-) rename src/apis/{partners => cloudscheduler}/README.md (87%) create mode 100644 src/apis/cloudscheduler/index.ts create mode 100644 src/apis/cloudscheduler/package.json create mode 100644 src/apis/cloudscheduler/v1beta1.ts delete mode 100644 src/apis/dfareporting/v3.0.ts create mode 100644 src/apis/driveactivity/README.md rename src/apis/{partners => driveactivity}/index.ts (60%) rename src/apis/{partners => driveactivity}/package.json (88%) create mode 100644 src/apis/driveactivity/v2.ts create mode 100644 src/apis/pagespeedonline/v5.ts delete mode 100644 src/apis/partners/v2.ts delete mode 100644 src/apis/speech/v1beta1.ts create mode 100644 src/apis/speech/v1p1beta1.ts diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index 230886672d6..a4003dad534 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -342,7 +342,7 @@ export namespace accesscontextmanager_v1beta { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -358,7 +358,7 @@ export namespace accesscontextmanager_v1beta { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A restriction on the OS type and version of devices making requests. @@ -525,7 +525,7 @@ export namespace accesscontextmanager_v1beta { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/adexchangebuyer/v1.2.ts b/src/apis/adexchangebuyer/v1.2.ts index f6673732281..4a5aa552273 100644 --- a/src/apis/adexchangebuyer/v1.2.ts +++ b/src/apis/adexchangebuyer/v1.2.ts @@ -109,7 +109,8 @@ export namespace adexchangebuyer_v1_2 { /** * Your bidder locations that have distinct URLs. */ - bidderLocation?: any[]; + bidderLocation?: + Array<{maximumQps?: number; region?: string; url?: string;}>; /** * The nid parameter value used in cookie match requests. Please contact * your technical account manager if you need to change this. @@ -201,7 +202,7 @@ export namespace adexchangebuyer_v1_2 { * Shows any corrections that were applied to this creative. Read-only. This * field should not be set in requests. */ - corrections?: any[]; + corrections?: Array<{details?: string[]; reason?: string;}>; /** * The reasons for disapproval, if any. Note that not all disapproval * reasons may be categorized, so it is possible for the creative to have a @@ -209,12 +210,15 @@ export namespace adexchangebuyer_v1_2 { * case, please reach out to your TAM to help debug the issue. Read-only. * This field should not be set in requests. */ - disapprovalReasons?: any[]; + disapprovalReasons?: Array<{details?: string[]; reason?: string;}>; /** * The filtering reasons for the creative. Read-only. This field should not * be set in requests. */ - filteringReasons?: any; + filteringReasons?: { + date?: string; + reasons?: Array<{filteringCount?: string; filteringStatus?: number;}>; + }; /** * Ad height. */ diff --git a/src/apis/adexchangebuyer/v1.3.ts b/src/apis/adexchangebuyer/v1.3.ts index f3202450540..e1bf84c11a5 100644 --- a/src/apis/adexchangebuyer/v1.3.ts +++ b/src/apis/adexchangebuyer/v1.3.ts @@ -119,7 +119,8 @@ export namespace adexchangebuyer_v1_3 { /** * Your bidder locations that have distinct URLs. */ - bidderLocation?: any[]; + bidderLocation?: + Array<{maximumQps?: number; region?: string; url?: string;}>; /** * The nid parameter value used in cookie match requests. Please contact * your technical account manager if you need to change this. @@ -279,7 +280,7 @@ export namespace adexchangebuyer_v1_3 { * Shows any corrections that were applied to this creative. Read-only. This * field should not be set in requests. */ - corrections?: any[]; + corrections?: Array<{details?: string[]; reason?: string;}>; /** * The reasons for disapproval, if any. Note that not all disapproval * reasons may be categorized, so it is possible for the creative to have a @@ -287,12 +288,15 @@ export namespace adexchangebuyer_v1_3 { * case, please reach out to your TAM to help debug the issue. Read-only. * This field should not be set in requests. */ - disapprovalReasons?: any[]; + disapprovalReasons?: Array<{details?: string[]; reason?: string;}>; /** * The filtering reasons for the creative. Read-only. This field should not * be set in requests. */ - filteringReasons?: any; + filteringReasons?: { + date?: string; + reasons?: Array<{filteringCount?: string; filteringStatus?: number;}>; + }; /** * Ad height. */ @@ -313,7 +317,20 @@ export namespace adexchangebuyer_v1_3 { /** * If nativeAd is set, HTMLSnippet and videoURL should not be set. */ - nativeAd?: any; + nativeAd?: { + advertiser?: string; + appIcon?: {height?: number; url?: string; width?: number;}; + body?: string; + callToAction?: string; + clickTrackingUrl?: string; + headline?: string; + image?: {height?: number; url?: string; width?: number;}; + impressionTrackingUrl?: string[]; + logo?: {height?: number; url?: string; width?: number;}; + price?: string; + starRating?: number; + store?: string; + }; /** * Detected product categories, if any. Read-only. This field should not be * set in requests. @@ -604,7 +621,7 @@ export namespace adexchangebuyer_v1_3 { * Requests which allow one of these (width, height) pairs will match. All * pairs must be supported ad dimensions. */ - dimensions?: any[]; + dimensions?: Array<{height?: string; width?: string;}>; /** * Requests with any of these content labels will not match. Values are from * content-labels.txt in the downloadable files section. @@ -617,7 +634,7 @@ export namespace adexchangebuyer_v1_3 { /** * Requests containing any of these placements will not match. */ - excludedPlacements?: any[]; + excludedPlacements?: Array<{token?: string; type?: string;}>; /** * Requests containing any of these users list ids will not match. */ @@ -662,7 +679,7 @@ export namespace adexchangebuyer_v1_3 { /** * Requests containing any of these placements will match. */ - placements?: any[]; + placements?: Array<{token?: string; type?: string;}>; /** * Requests matching any of these platforms will match. Possible values are * PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and @@ -1696,12 +1713,12 @@ export namespace adexchangebuyer_v1_3 { /** * When specified, only creatives for the given account ids are returned. */ - accountId?: number; + accountId?: number[]; /** * When specified, only creatives for the given buyer creative ids are * returned. */ - buyerCreativeId?: string; + buyerCreativeId?: string[]; /** * Maximum number of entries returned on one result page. If not set, the * default is 100. Optional. diff --git a/src/apis/adexchangebuyer/v1.4.ts b/src/apis/adexchangebuyer/v1.4.ts index 891fb53315d..da7595ef5f5 100644 --- a/src/apis/adexchangebuyer/v1.4.ts +++ b/src/apis/adexchangebuyer/v1.4.ts @@ -138,7 +138,12 @@ export namespace adexchangebuyer_v1_4 { /** * Your bidder locations that have distinct URLs. */ - bidderLocation?: any[]; + bidderLocation?: Array<{ + bidProtocol?: string; + maximumQps?: number; + region?: string; + url?: string; + }>; /** * The nid parameter value used in cookie match requests. Please contact * your technical account manager if you need to change this. @@ -371,7 +376,16 @@ export namespace adexchangebuyer_v1_4 { * Shows any corrections that were applied to this creative. Read-only. This * field should not be set in requests. */ - corrections?: any[]; + corrections?: Array<{ + contexts?: Array<{ + auctionType?: string[]; + contextType?: string; + geoCriteriaId?: number[]; + platform?: string[]; + }>; + details?: string[]; + reason?: string; + }>; /** * Creative status identity type that the creative item applies to. Ad * Exchange real-time bidding is migrating to the sizeless creative @@ -401,7 +415,10 @@ export namespace adexchangebuyer_v1_4 { * The filtering reasons for the creative. Read-only. This field should not * be set in requests. */ - filteringReasons?: any; + filteringReasons?: { + date?: string; + reasons?: Array<{filteringCount?: string; filteringStatus?: number;}>; + }; /** * Ad height. */ @@ -428,7 +445,22 @@ export namespace adexchangebuyer_v1_4 { * If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside * of nativeAd should not be set. (The videoURL inside nativeAd can be set.) */ - nativeAd?: any; + nativeAd?: { + advertiser?: string; + appIcon?: {height?: number; url?: string; width?: number;}; + body?: string; + callToAction?: string; + clickLinkUrl?: string; + clickTrackingUrl?: string; + headline?: string; + image?: {height?: number; url?: string; width?: number;}; + impressionTrackingUrl?: string[]; + logo?: {height?: number; url?: string; width?: number;}; + price?: string; + starRating?: number; + store?: string; + videoURL?: string; + }; /** * Top-level open auction status. Read-only. This field should not be set in * requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) @@ -462,7 +494,16 @@ export namespace adexchangebuyer_v1_4 { * Read-only. This field should not be set in requests. See the examples in * the Creatives guide for more details. */ - servingRestrictions?: any[]; + servingRestrictions?: Array<{ + contexts?: Array<{ + auctionType?: string[]; + contextType?: string; + geoCriteriaId?: number[]; + platform?: string[]; + }>; + disapprovalReasons?: Array<{details?: string[]; reason?: string;}>; + reason?: string; + }>; /** * List of vendor types for the ads that may be shown from this snippet. * Each vendor type is represented by an integer as defined in vendors.txt. @@ -497,7 +538,8 @@ export namespace adexchangebuyer_v1_4 { /** * A list of external deal ids and ARC approval status. */ - dealStatuses?: any[]; + dealStatuses?: + Array<{arcStatus?: string; dealId?: string; webPropertyId?: number;}>; /** * Resource type. */ @@ -1140,7 +1182,7 @@ export namespace adexchangebuyer_v1_4 { * Requests which allow one of these (width, height) pairs will match. All * pairs must be supported ad dimensions. */ - dimensions?: any[]; + dimensions?: Array<{height?: string; width?: string;}>; /** * Requests with any of these content labels will not match. Values are from * content-labels.txt in the downloadable files section. @@ -1153,7 +1195,7 @@ export namespace adexchangebuyer_v1_4 { /** * Requests containing any of these placements will not match. */ - excludedPlacements?: any[]; + excludedPlacements?: Array<{token?: string; type?: string;}>; /** * Requests containing any of these users list ids will not match. */ @@ -1205,7 +1247,7 @@ export namespace adexchangebuyer_v1_4 { /** * Requests containing any of these placements will match. */ - placements?: any[]; + placements?: Array<{token?: string; type?: string;}>; /** * Requests matching any of these platforms will match. Possible values are * PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and @@ -1244,7 +1286,8 @@ export namespace adexchangebuyer_v1_4 { * Video requests satisfying any of these player size constraints will * match. */ - videoPlayerSizes?: any[]; + videoPlayerSizes?: + Array<{aspectRatio?: string; minHeight?: string; minWidth?: string;}>; } export interface Schema$PretargetingConfigList { /** @@ -3024,12 +3067,12 @@ export namespace adexchangebuyer_v1_4 { /** * When specified, only creatives for the given account ids are returned. */ - accountId?: number; + accountId?: number[]; /** * When specified, only creatives for the given buyer creative ids are * returned. */ - buyerCreativeId?: string; + buyerCreativeId?: string[]; /** * When specified, only creatives having the given deals status are * returned. diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 8e21a9aa2e3..eb20e479404 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -2235,7 +2235,8 @@ export namespace adexchangebuyer2_v2beta1 { export interface Schema$RowDimensions { /** * The publisher identifier for this row, if a breakdown by - * BreakdownDimension.PUBLISHER_IDENTIFIER was requested. + * [BreakdownDimension.PUBLISHER_IDENTIFIER](https://developers.google.com/authorized-buyers/apis/reference/rest/v2beta1/bidders.accounts.filterSets#FilterSet.BreakdownDimension) + * was requested. */ publisherIdentifier?: string; /** diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index c12a69347ee..533d7d65f60 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -462,7 +462,7 @@ export namespace admin_directory_v1 { /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: any; + params?: {[key: string]: string;}; /** * A Boolean value to indicate whether payload is wanted. Optional. */ @@ -493,7 +493,7 @@ export namespace admin_directory_v1 { /** * List of active time ranges (Read-only) */ - activeTimeRanges?: any[]; + activeTimeRanges?: Array<{activeTime?: number; date?: string;}>; /** * AssetId specified during enrollment or through later annotation */ @@ -513,11 +513,20 @@ export namespace admin_directory_v1 { /** * Reports of CPU utilization and temperature (Read-only) */ - cpuStatusReports?: any[]; + cpuStatusReports?: Array<{ + cpuTemperatureInfo?: Array<{label?: string; temperature?: number;}>; + cpuUtilizationPercentageInfo?: number[]; + reportTime?: string; + }>; /** * List of device files to download (Read-only) */ - deviceFiles?: any[]; + deviceFiles?: Array<{ + createTime?: string; + downloadUrl?: string; + name?: string; + type?: string; + }>; /** * Unique identifier of Chrome OS Device (Read-only) */ @@ -525,7 +534,10 @@ export namespace admin_directory_v1 { /** * Reports of disk space and other info about mounted/connected volumes. */ - diskVolumeReports?: any[]; + diskVolumeReports?: Array<{ + volumeInfo?: Array< + {storageFree?: string; storageTotal?: string; volumeId?: string;}>; + }>; /** * ETag of the resource. */ @@ -588,7 +600,7 @@ export namespace admin_directory_v1 { * List of recent device users, in descending order by last login time * (Read-only) */ - recentUsers?: any[]; + recentUsers?: Array<{email?: string; type?: string;}>; /** * Chromebook serial number (Read-only) */ @@ -604,7 +616,8 @@ export namespace admin_directory_v1 { /** * Reports of amounts of available RAM memory (Read-only) */ - systemRamFreeReports?: any[]; + systemRamFreeReports?: + Array<{reportTime?: string; systemRamFreeInfo?: string[];}>; /** * Total RAM on the device [in bytes] (Read-only) */ @@ -612,7 +625,14 @@ export namespace admin_directory_v1 { /** * Trusted Platform Module (TPM) (Read-only) */ - tpmVersionInfo?: any; + tpmVersionInfo?: { + family?: string; + firmwareVersion?: string; + manufacturer?: string; + specLevel?: string; + tpmModel?: string; + vendorSpecific?: string; + }; /** * Will Chromebook auto renew after support end date (Read-only) */ @@ -1052,7 +1072,13 @@ export namespace admin_directory_v1 { /** * List of applications installed on Mobile Device */ - applications?: any[]; + applications?: Array<{ + displayName?: string; + packageName?: string; + permission?: string[]; + versionCode?: number; + versionName?: string; + }>; /** * Mobile Device Baseband version (Read-only) */ @@ -1445,7 +1471,7 @@ export namespace admin_directory_v1 { /** * The set of privileges that are granted to this role. */ - rolePrivileges?: any[]; + rolePrivileges?: Array<{privilegeName?: string; serviceId?: string;}>; } /** * JSON template for roleAssignment resource in Directory API. @@ -1590,7 +1616,7 @@ export namespace admin_directory_v1 { * will be supported for numeric fields. Setting the numericIndexingSpec * allows range queries to be supported. */ - numericIndexingSpec?: any; + numericIndexingSpec?: {maxValue?: number; minValue?: number;}; /** * Read ACLs on the field specifying who can view values of this field. * Valid values are "ALL_DOMAIN_USERS" and @@ -1743,7 +1769,7 @@ export namespace admin_directory_v1 { /** * Custom fields of the user. */ - customSchemas?: any; + customSchemas?: {[key: string]: Schema$UserCustomProperties;}; deletionTime?: string; emails?: any; /** @@ -6956,7 +6982,7 @@ export namespace admin_directory_v1 { /** * Full path of the organizational unit or its ID */ - orgUnitPath?: string; + orgUnitPath?: string[]; } export interface Params$Resource$Orgunits$Get extends StandardParameters { /** @@ -6971,7 +6997,7 @@ export namespace admin_directory_v1 { /** * Full path of the organizational unit or its ID */ - orgUnitPath?: string; + orgUnitPath?: string[]; } export interface Params$Resource$Orgunits$Insert extends StandardParameters { /** @@ -7021,7 +7047,7 @@ export namespace admin_directory_v1 { /** * Full path of the organizational unit or its ID */ - orgUnitPath?: string; + orgUnitPath?: string[]; /** * Request body metadata @@ -7041,7 +7067,7 @@ export namespace admin_directory_v1 { /** * Full path of the organizational unit or its ID */ - orgUnitPath?: string; + orgUnitPath?: string[]; /** * Request body metadata diff --git a/src/apis/admin/reports_v1.ts b/src/apis/admin/reports_v1.ts index 5d96ad655b1..edb1545b897 100644 --- a/src/apis/admin/reports_v1.ts +++ b/src/apis/admin/reports_v1.ts @@ -135,7 +135,12 @@ export namespace admin_reports_v1 { /** * User doing the action. */ - actor?: any; + actor?: { + callerType?: string; + email?: string; + key?: string; + profileId?: string; + }; /** * ETag of the entry. */ @@ -143,11 +148,27 @@ export namespace admin_reports_v1 { /** * Activity events. */ - events?: any[]; + events?: Array<{ + name?: string; + parameters?: Array<{ + boolValue?: boolean; + intValue?: string; + multiIntValue?: string[]; + multiValue?: string[]; + name?: string; + value?: string; + }>; + type?: string; + }>; /** * Unique identifier for each activity record. */ - id?: any; + id?: { + applicationName?: string; + customerId?: string; + time?: string; + uniqueQualifier?: string; + }; /** * IP Address of the user doing the action. */ @@ -186,7 +207,7 @@ export namespace admin_reports_v1 { /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: any; + params?: {[key: string]: string;}; /** * A Boolean value to indicate whether payload is wanted. Optional. */ @@ -221,7 +242,13 @@ export namespace admin_reports_v1 { /** * Information about the type of the item. */ - entity?: any; + entity?: { + customerId?: string; + entityId?: string; + profileId?: string; + type?: string; + userEmail?: string; + }; /** * ETag of the resource. */ @@ -233,7 +260,14 @@ export namespace admin_reports_v1 { /** * Parameter value pairs for various applications. */ - parameters?: any[]; + parameters?: Array<{ + boolValue?: boolean; + datetimeValue?: string; + intValue?: string; + msgValue?: Array<{[key: string]: any;}>; + name?: string; + stringValue?: string; + }>; } /** * JSON template for a collection of usage reports. @@ -258,7 +292,11 @@ export namespace admin_reports_v1 { /** * Warnings if any. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts index 9525838a54d..ab397ea8b95 100644 --- a/src/apis/adsense/v1.4.ts +++ b/src/apis/adsense/v1.4.ts @@ -240,7 +240,7 @@ export namespace adsense_v1_4 { * list of headers; one for each dimension in the request, followed by one * for each metric in the request. */ - headers?: any[]; + headers?: Array<{currency?: string; name?: string; type?: string;}>; /** * Kind this is, in this case adsense#report. */ @@ -278,7 +278,13 @@ export namespace adsense_v1_4 { * hexadecimal characters, similar to HTML color codes, but without the * leading hash. */ - colors?: any; + colors?: { + background?: string; + border?: string; + text?: string; + title?: string; + url?: string; + }; /** * The style of the corners in the ad (deprecated: never populated, * ignored). @@ -287,7 +293,7 @@ export namespace adsense_v1_4 { /** * The font which is included in the style. */ - font?: any; + font?: {family?: string; size?: string;}; /** * Kind this is, in this case adsense#adStyle. */ @@ -302,7 +308,11 @@ export namespace adsense_v1_4 { * Settings specific to content ads (AFC) and highend mobile content ads * (AFMC - deprecated). */ - contentAdsSettings?: any; + contentAdsSettings?: { + backupOption?: {color?: string; type?: string; url?: string;}; + size?: string; + type?: string; + }; /** * Custom style information specific to this ad unit. */ @@ -310,7 +320,12 @@ export namespace adsense_v1_4 { /** * Settings specific to feed ads (AFF) - deprecated. */ - feedAdsSettings?: any; + feedAdsSettings?: { + adPosition?: string; + frequency?: number; + minimumWordCount?: number; + type?: string; + }; /** * Unique identifier of this ad unit. This should be considered an opaque * identifier; it is not safe to rely on it being in any particular format. @@ -323,7 +338,12 @@ export namespace adsense_v1_4 { /** * Settings specific to WAP mobile content ads (AFMC) - deprecated. */ - mobileContentAdsSettings?: any; + mobileContentAdsSettings?: { + markupLanguage?: string; + scriptingLanguage?: string; + size?: string; + type?: string; + }; /** * Name of this ad unit. */ @@ -423,7 +443,12 @@ export namespace adsense_v1_4 { /** * The targeting information of this custom channel, if activated. */ - targetingInfo?: any; + targetingInfo?: { + adsAppearOn?: string; + description?: string; + location?: string; + siteLanguage?: string; + }; } export interface Schema$CustomChannels { /** @@ -2157,7 +2182,7 @@ export namespace adsense_v1_4 { /** * Dimensions to base the report on. */ - dimension?: string; + dimension?: string[]; /** * End of the date range to report on in "YYYY-MM-DD" format, inclusive. */ @@ -2165,7 +2190,7 @@ export namespace adsense_v1_4 { /** * Filters to be run on the report. */ - filter?: string; + filter?: string[]; /** * Optional locale to use for translating report output to a local language. * Defaults to "en_US" if not specified. @@ -2178,13 +2203,13 @@ export namespace adsense_v1_4 { /** * Numeric columns to include in the report. */ - metric?: string; + metric?: string[]; /** * The name of a dimension or metric to sort the resulting report on, * optionally prefixed with "+" to sort ascending or "-" to sort descending. * If no prefix is specified, the column is sorted ascending. */ - sort?: string; + sort?: string[]; /** * Start of the date range to report on in "YYYY-MM-DD" format, inclusive. */ @@ -4065,7 +4090,7 @@ export namespace adsense_v1_4 { /** * Accounts upon which to report. */ - accountId?: string; + accountId?: string[]; /** * Optional currency to use when reporting on monetary metrics. Defaults to * the account's currency if not set. @@ -4074,7 +4099,7 @@ export namespace adsense_v1_4 { /** * Dimensions to base the report on. */ - dimension?: string; + dimension?: string[]; /** * End of the date range to report on in "YYYY-MM-DD" format, inclusive. */ @@ -4082,7 +4107,7 @@ export namespace adsense_v1_4 { /** * Filters to be run on the report. */ - filter?: string; + filter?: string[]; /** * Optional locale to use for translating report output to a local language. * Defaults to "en_US" if not specified. @@ -4095,13 +4120,13 @@ export namespace adsense_v1_4 { /** * Numeric columns to include in the report. */ - metric?: string; + metric?: string[]; /** * The name of a dimension or metric to sort the resulting report on, * optionally prefixed with "+" to sort ascending or "-" to sort descending. * If no prefix is specified, the column is sorted ascending. */ - sort?: string; + sort?: string[]; /** * Start of the date range to report on in "YYYY-MM-DD" format, inclusive. */ diff --git a/src/apis/adsensehost/v4.1.ts b/src/apis/adsensehost/v4.1.ts index 98f3addd0ef..56524df521f 100644 --- a/src/apis/adsensehost/v4.1.ts +++ b/src/apis/adsensehost/v4.1.ts @@ -200,7 +200,13 @@ export namespace adsensehost_v4_1 { * hexadecimal characters, similar to HTML color codes, but without the * leading hash. */ - colors?: any; + colors?: { + background?: string; + border?: string; + text?: string; + title?: string; + url?: string; + }; /** * The style of the corners in the ad (deprecated: never populated, * ignored). @@ -209,7 +215,7 @@ export namespace adsensehost_v4_1 { /** * The font which is included in the style. */ - font?: any; + font?: {family?: string; size?: string;}; /** * Kind this is, in this case adsensehost#adStyle. */ @@ -224,7 +230,11 @@ export namespace adsensehost_v4_1 { * Settings specific to content ads (AFC) and highend mobile content ads * (AFMC - deprecated). */ - contentAdsSettings?: any; + contentAdsSettings?: { + backupOption?: {color?: string; type?: string; url?: string;}; + size?: string; + type?: string; + }; /** * Custom style information specific to this ad unit. */ @@ -241,7 +251,12 @@ export namespace adsensehost_v4_1 { /** * Settings specific to WAP mobile content ads (AFMC - deprecated). */ - mobileContentAdsSettings?: any; + mobileContentAdsSettings?: { + markupLanguage?: string; + scriptingLanguage?: string; + size?: string; + type?: string; + }; /** * Name of this ad unit. */ @@ -369,7 +384,7 @@ export namespace adsensehost_v4_1 { * list of headers; one for each dimension in the request, followed by one * for each metric in the request. */ - headers?: any[]; + headers?: Array<{currency?: string; name?: string; type?: string;}>; /** * Kind this is, in this case adsensehost#report. */ @@ -600,7 +615,7 @@ export namespace adsensehost_v4_1 { /** * Ad clients to list accounts for. */ - filterAdClientId?: string; + filterAdClientId?: string[]; } export class Resource$Accounts$Adclients { @@ -1361,7 +1376,7 @@ export namespace adsensehost_v4_1 { /** * Host custom channel to attach to the ad code. */ - hostCustomChannelId?: string; + hostCustomChannelId?: string[]; } export interface Params$Resource$Accounts$Adunits$Insert extends StandardParameters { @@ -1566,7 +1581,7 @@ export namespace adsensehost_v4_1 { /** * Dimensions to base the report on. */ - dimension?: string; + dimension?: string[]; /** * End of the date range to report on in "YYYY-MM-DD" format, inclusive. */ @@ -1574,7 +1589,7 @@ export namespace adsensehost_v4_1 { /** * Filters to be run on the report. */ - filter?: string; + filter?: string[]; /** * Optional locale to use for translating report output to a local language. * Defaults to "en_US" if not specified. @@ -1587,13 +1602,13 @@ export namespace adsensehost_v4_1 { /** * Numeric columns to include in the report. */ - metric?: string; + metric?: string[]; /** * The name of a dimension or metric to sort the resulting report on, * optionally prefixed with "+" to sort ascending or "-" to sort descending. * If no prefix is specified, the column is sorted ascending. */ - sort?: string; + sort?: string[]; /** * Start of the date range to report on in "YYYY-MM-DD" format, inclusive. */ @@ -1938,7 +1953,7 @@ export namespace adsensehost_v4_1 { /** * Products to associate with the user. */ - productCode?: string; + productCode?: string[]; /** * The preferred locale of the user. */ @@ -2600,7 +2615,7 @@ export namespace adsensehost_v4_1 { /** * Dimensions to base the report on. */ - dimension?: string; + dimension?: string[]; /** * End of the date range to report on in "YYYY-MM-DD" format, inclusive. */ @@ -2608,7 +2623,7 @@ export namespace adsensehost_v4_1 { /** * Filters to be run on the report. */ - filter?: string; + filter?: string[]; /** * Optional locale to use for translating report output to a local language. * Defaults to "en_US" if not specified. @@ -2621,13 +2636,13 @@ export namespace adsensehost_v4_1 { /** * Numeric columns to include in the report. */ - metric?: string; + metric?: string[]; /** * The name of a dimension or metric to sort the resulting report on, * optionally prefixed with "+" to sort ascending or "-" to sort descending. * If no prefix is specified, the column is sorted ascending. */ - sort?: string; + sort?: string[]; /** * Start of the date range to report on in "YYYY-MM-DD" format, inclusive. */ diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index a9d954e8704..ee2ed2b2423 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -150,7 +150,7 @@ export namespace alertcenter_v1beta1 { * Optional. The data associated with this alert, for example * google.apps.alertcenter.type.DeviceCompromised. */ - data?: any; + data?: {[key: string]: any;}; /** * Output only. `True` if this alert is marked for deletion. */ @@ -726,7 +726,7 @@ export namespace alertcenter_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.customerId Optional. The unique identifier of the G Suite organization account of the customer the alerts are associated with. Inferred from the caller identity if not provided. - * @param {string=} params.filter Optional. A query string for filtering alert results. For more details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields). + * @param {string=} params.filter Optional. A query string for filtering alert 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.list). * @param {string=} params.orderBy Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, only sorting by `create_time desc` is supported. * @param {integer=} params.pageSize Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default. * @param {string=} params.pageToken Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field. @@ -837,7 +837,7 @@ export namespace alertcenter_v1beta1 { * Optional. A query string for filtering alert results. For more details, * see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and * [Supported query filter - * fields](/admin-sdk/alertcenter/reference/filter-fields). + * fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list). */ filter?: string; /** @@ -951,7 +951,7 @@ export namespace alertcenter_v1beta1 { * @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.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 + * @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`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1058,7 +1058,10 @@ export namespace alertcenter_v1beta1 { */ customerId?: string; /** - * + * 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). */ filter?: string; } diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index c1cee7ad28b..d383d66f37a 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -114,7 +114,7 @@ export namespace analytics_v3 { * Child link for an account entry. Points to the list of web properties for * this account. */ - childLink?: any; + childLink?: {href?: string; type?: string;}; /** * Time the account was created. */ @@ -134,7 +134,7 @@ export namespace analytics_v3 { /** * Permissions the user has for this account. */ - permissions?: any; + permissions?: {effective?: string[];}; /** * Link for this account. */ @@ -324,7 +324,12 @@ export namespace analytics_v3 { */ export interface Schema$AccountTreeRequest { accountName?: string; - accountSettings?: any; + accountSettings?: { + shareAnonymouslyWithOthers?: boolean; + shareWithGoogleProducts?: boolean; + shareWithSpecialists?: boolean; + shareWithSupport?: boolean; + }; /** * Resource type for account ticket. */ @@ -344,7 +349,12 @@ export namespace analytics_v3 { * The account created. */ account?: Schema$Account; - accountSettings?: any; + accountSettings?: { + shareAnonymouslyWithOthers?: boolean; + shareWithGoogleProducts?: boolean; + shareWithSpecialists?: boolean; + shareWithSupport?: boolean; + }; /** * Resource type for account ticket. */ @@ -392,7 +402,7 @@ export namespace analytics_v3 { /** * Map of attribute name and value for this column. */ - attributes?: any; + attributes?: {[key: string]: string;}; /** * Column id. */ @@ -436,7 +446,7 @@ export namespace analytics_v3 { * Account ID to which this custom data source belongs. */ accountId?: string; - childLink?: any; + childLink?: {href?: string; type?: string;}; /** * Time this custom data source was created. */ @@ -462,7 +472,7 @@ export namespace analytics_v3 { * Parent link for this custom data source. Points to the web property to * which this custom data source belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * IDs of views (profiles) linked to the custom data source. */ @@ -574,7 +584,7 @@ export namespace analytics_v3 { * Parent link for the custom dimension. Points to the property to which the * custom dimension belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. */ @@ -681,7 +691,7 @@ export namespace analytics_v3 { * Parent link for the custom metric. Points to the property to which the * custom metric belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * Scope of the custom metric: HIT or PRODUCT. */ @@ -759,7 +769,7 @@ export namespace analytics_v3 { /** * Web property being linked. */ - entity?: any; + entity?: {webPropertyRef?: Schema$WebPropertyRef;}; /** * Entity AdWords link ID */ @@ -829,7 +839,11 @@ export namespace analytics_v3 { * Entity for this link. It can be an account, a web property, or a view * (profile). */ - entity?: any; + entity?: { + accountRef?: Schema$AccountRef; + profileRef?: Schema$ProfileRef; + webPropertyRef?: Schema$WebPropertyRef; + }; /** * Entity user link ID */ @@ -841,7 +855,7 @@ export namespace analytics_v3 { /** * Permissions the user has for this entity. */ - permissions?: any; + permissions?: {effective?: string[]; local?: string[];}; /** * Self link for this resource. */ @@ -971,7 +985,7 @@ export namespace analytics_v3 { * Parent link for an experiment. Points to the view (profile) to which this * experiment belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * View (Profile) ID to which this experiment belongs. This field is * read-only. @@ -1045,7 +1059,13 @@ export namespace analytics_v3 { * RUNNING state. At least two variations are required before status can be * set to RUNNING. */ - variations?: any[]; + variations?: Array<{ + name?: string; + status?: string; + url?: string; + weight?: number; + won?: boolean; + }>; /** * Web property ID to which this experiment belongs. The web property ID is * of the form UA-XXXXX-YY. This field is read-only. @@ -1118,7 +1138,21 @@ export namespace analytics_v3 { /** * Details for the filter of the type ADVANCED. */ - advancedDetails?: any; + advancedDetails?: { + caseSensitive?: boolean; + extractA?: string; + extractB?: string; + fieldA?: string; + fieldAIndex?: number; + fieldARequired?: boolean; + fieldB?: string; + fieldBIndex?: number; + fieldBRequired?: boolean; + outputConstructor?: string; + outputToField?: string; + outputToFieldIndex?: number; + overrideOutputField?: boolean; + }; /** * Time this filter was created. */ @@ -1142,7 +1176,7 @@ export namespace analytics_v3 { /** * Details for the filter of the type LOWER. */ - lowercaseDetails?: any; + lowercaseDetails?: {field?: string; fieldIndex?: number;}; /** * Name of this filter. */ @@ -1151,11 +1185,17 @@ export namespace analytics_v3 { * Parent link for this filter. Points to the account to which this filter * belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * Details for the filter of the type SEARCH_AND_REPLACE. */ - searchAndReplaceDetails?: any; + searchAndReplaceDetails?: { + caseSensitive?: boolean; + field?: string; + fieldIndex?: number; + replaceString?: string; + searchString?: string; + }; /** * Link for this filter. */ @@ -1172,7 +1212,7 @@ export namespace analytics_v3 { /** * Details for the filter of the type UPPER. */ - uppercaseDetails?: any; + uppercaseDetails?: {field?: string; fieldIndex?: number;}; } /** * JSON template for an Analytics filter expression. @@ -1313,7 +1353,8 @@ export namespace analytics_v3 { * Column headers that list dimension names followed by the metric names. * The order of dimensions and metrics is same as specified in the request. */ - columnHeaders?: any[]; + columnHeaders?: + Array<{columnType?: string; dataType?: string; name?: string;}>; /** * Determines if Analytics data contains samples. */ @@ -1322,7 +1363,10 @@ export namespace analytics_v3 { * The last refreshed time in seconds for Analytics data. */ dataLastRefreshed?: string; - dataTable?: any; + dataTable?: { + cols?: Array<{id?: string; label?: string; type?: string;}>; + rows?: Array<{c?: Array<{v?: string;}>;}>; + }; /** * Unique ID for this data response. */ @@ -1350,11 +1394,30 @@ export namespace analytics_v3 { * Information for the view (profile), for which the Analytics data was * requested. */ - profileInfo?: any; + profileInfo?: { + accountId?: string; + internalWebPropertyId?: string; + profileId?: string; + profileName?: string; + tableId?: string; + webPropertyId?: string; + }; /** * Analytics data request query parameters. */ - query?: any; + query?: { + dimensions?: string; + 'end-date'?: string; + filters?: string; + ids?: string; + 'max-results'?: number; + metrics?: string[]; + samplingLevel?: string; + segment?: string; + sort?: string[]; + 'start-date'?: string; + 'start-index'?: number; + }; /** * Analytics data rows, where each row contains a list of dimension values * followed by the metric values. The order of dimensions and metrics is @@ -1383,7 +1446,7 @@ export namespace analytics_v3 { * results returned in this response. The order of the metric totals is same * as the metric order specified in the request. */ - totalsForAllResults?: any; + totalsForAllResults?: {[key: string]: string;}; } /** * JSON template for Analytics goal resource. @@ -1404,7 +1467,16 @@ export namespace analytics_v3 { /** * Details for the goal of the type EVENT. */ - eventDetails?: any; + eventDetails?: { + eventConditions?: Array<{ + comparisonType?: string; + comparisonValue?: string; + expression?: string; + matchType?: string; + type?: string; + }>; + useEventValue?: boolean; + }; /** * Goal ID. */ @@ -1425,7 +1497,7 @@ export namespace analytics_v3 { * Parent link for a goal. Points to the view (profile) to which this goal * belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * View (Profile) ID to which this goal belongs. */ @@ -1446,7 +1518,13 @@ export namespace analytics_v3 { /** * Details for the goal of the type URL_DESTINATION. */ - urlDestinationDetails?: any; + urlDestinationDetails?: { + caseSensitive?: boolean; + firstStepRequired?: boolean; + matchType?: string; + steps?: Array<{name?: string; number?: number; url?: string;}>; + url?: string; + }; /** * Goal value. */ @@ -1454,11 +1532,12 @@ export namespace analytics_v3 { /** * Details for the goal of the type VISIT_NUM_PAGES. */ - visitNumPagesDetails?: any; + visitNumPagesDetails?: {comparisonType?: string; comparisonValue?: string;}; /** * Details for the goal of the type VISIT_TIME_ON_SITE. */ - visitTimeOnSiteDetails?: any; + visitTimeOnSiteDetails?: + {comparisonType?: string; comparisonValue?: string;}; /** * Web property ID to which this goal belongs. The web property ID is of the * form UA-XXXXX-YY. @@ -1614,7 +1693,8 @@ export namespace analytics_v3 { * Column headers that list dimension names followed by the metric names. * The order of dimensions and metrics is same as specified in the request. */ - columnHeaders?: any[]; + columnHeaders?: + Array<{columnType?: string; dataType?: string; name?: string;}>; /** * Determines if the Analytics data contains sampled data. */ @@ -1646,17 +1726,40 @@ export namespace analytics_v3 { * Information for the view (profile), for which the Analytics data was * requested. */ - profileInfo?: any; + profileInfo?: { + accountId?: string; + internalWebPropertyId?: string; + profileId?: string; + profileName?: string; + tableId?: string; + webPropertyId?: string; + }; /** * Analytics data request query parameters. */ - query?: any; + query?: { + dimensions?: string; + 'end-date'?: string; + filters?: string; + ids?: string; + 'max-results'?: number; + metrics?: string[]; + samplingLevel?: string; + segment?: string; + sort?: string[]; + 'start-date'?: string; + 'start-index'?: number; + }; /** * Analytics data rows, where each row contains a list of dimension values * followed by the metric values. The order of dimensions and metrics is * same as specified in the request. */ - rows?: any[][]; + rows?: Array; + primitiveValue?: string; + }>>; /** * The number of samples used to calculate the result. */ @@ -1679,7 +1782,7 @@ export namespace analytics_v3 { * results returned in this response. The order of the metric totals is same * as the metric order specified in the request. */ - totalsForAllResults?: any; + totalsForAllResults?: {[key: string]: string;}; } /** * JSON template for an Analytics view (profile). @@ -1697,7 +1800,7 @@ export namespace analytics_v3 { * Child link for this view (profile). Points to the list of goals for this * view (profile). */ - childLink?: any; + childLink?: {href?: string; type?: string;}; /** * Time this view (profile) was created. */ @@ -1748,11 +1851,11 @@ export namespace analytics_v3 { * Parent link for this view (profile). Points to the web property to which * this view (profile) belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * Permissions the user has for this view (profile). */ - permissions?: any; + permissions?: {effective?: string[];}; /** * Link for this view (profile). */ @@ -1997,7 +2100,8 @@ export namespace analytics_v3 { * Column headers that list dimension names followed by the metric names. * The order of dimensions and metrics is same as specified in the request. */ - columnHeaders?: any[]; + columnHeaders?: + Array<{columnType?: string; dataType?: string; name?: string;}>; /** * Unique ID for this data response. */ @@ -2010,11 +2114,25 @@ export namespace analytics_v3 { * Information for the view (profile), for which the real time data was * requested. */ - profileInfo?: any; + profileInfo?: { + accountId?: string; + internalWebPropertyId?: string; + profileId?: string; + profileName?: string; + tableId?: string; + webPropertyId?: string; + }; /** * Real time data request query parameters. */ - query?: any; + query?: { + dimensions?: string; + filters?: string; + ids?: string; + 'max-results'?: number; + metrics?: string[]; + sort?: string[]; + }; /** * Real time data rows, where each row contains a list of dimension values * followed by the metric values. The order of dimensions and metrics is @@ -2035,7 +2153,7 @@ export namespace analytics_v3 { * results returned in this response. The order of the metric totals is same * as the metric order specified in the request. */ - totalsForAllResults?: any; + totalsForAllResults?: {[key: string]: string;}; } /** * JSON template for an Analytics remarketing audience. @@ -2049,7 +2167,7 @@ export namespace analytics_v3 { * The simple audience definition that will cause a user to be added to an * audience. */ - audienceDefinition?: any; + audienceDefinition?: {includeConditions?: Schema$IncludeConditions;}; /** * The type of audience, either SIMPLE or STATE_BASED. */ @@ -2092,7 +2210,10 @@ export namespace analytics_v3 { * A state based audience definition that will cause a user to be added or * removed from an audience. */ - stateBasedAudienceDefinition?: any; + stateBasedAudienceDefinition?: { + excludeConditions?: {exclusionDuration?: string; segment?: string;}; + includeConditions?: Schema$IncludeConditions; + }; /** * Time this remarketing audience was last modified. */ @@ -2244,7 +2365,7 @@ export namespace analytics_v3 { /** * Download details for a file stored in Google Cloud Storage. */ - cloudStorageDownloadDetails?: any; + cloudStorageDownloadDetails?: {bucketId?: string; objectId?: string;}; /** * Time this unsampled report was created. */ @@ -2263,7 +2384,7 @@ export namespace analytics_v3 { /** * Download details for a file stored in Google Drive. */ - driveDownloadDetails?: any; + driveDownloadDetails?: {documentId?: string;}; /** * The end date for the unsampled report. */ @@ -2454,7 +2575,7 @@ export namespace analytics_v3 { /** * User ID. */ - id?: any; + id?: {type?: string; userId?: string;}; /** * Value is "analytics#userDeletionRequest". */ @@ -2534,7 +2655,7 @@ export namespace analytics_v3 { * Child link for this web property. Points to the list of views (profiles) * for this web property. */ - childLink?: any; + childLink?: {href?: string; type?: string;}; /** * Time this web property was created. */ @@ -2584,11 +2705,11 @@ export namespace analytics_v3 { * Parent link for this web property. Points to the account to which this * web property belongs. */ - parentLink?: any; + parentLink?: {href?: string; type?: string;}; /** * Permissions the user has for this web property. */ - permissions?: any; + permissions?: {effective?: string[];}; /** * View (Profile) count for this web property. */ diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index 166a2ae6569..a320843f4b7 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -132,6 +132,10 @@ export namespace androiddeviceprovisioning_v1 { * Required. The device identifier of the device to claim. */ deviceIdentifier?: Schema$DeviceIdentifier; + /** + * Optional. The metadata to attach to the device. + */ + deviceMetadata?: Schema$DeviceMetadata; /** * Required. The section type of the device's provisioning record. */ @@ -461,7 +465,7 @@ export namespace androiddeviceprovisioning_v1 { /** * Metadata entries recorded as key-value pairs. */ - entries?: any; + entries?: {[key: string]: string;}; } /** * A `DeviceReference` is an API abstraction that lets you supply a _device_ @@ -714,7 +718,7 @@ export namespace androiddeviceprovisioning_v1 { * the operation is created by `claimAsync`, `unclaimAsync`, or * `updateMetadataAsync`. */ - metadata?: 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 @@ -726,7 +730,7 @@ export namespace androiddeviceprovisioning_v1 { * the operation is created by `claimAsync`, `unclaimAsync`, or * `updateMetadataAsync`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A task for each device in the operation. Corresponds to each device change @@ -854,7 +858,7 @@ export namespace androiddeviceprovisioning_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -2716,7 +2720,7 @@ export namespace androiddeviceprovisioning_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.deviceId Required. The ID of the reseller partner. + * @param {string} params.deviceId Required. The ID of the device. * @param {string} params.metadataOwnerId Required. The owner of the newly set metadata. Set this to the partner ID. * @param {().UpdateDeviceMetadataRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3083,7 +3087,7 @@ export namespace androiddeviceprovisioning_v1 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. The ID of the reseller partner. + * Required. The ID of the device. */ deviceId?: string; /** diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 7841d9b6915..dfb948ced2e 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -98,6 +98,7 @@ export namespace androidenterprise_v1 { storelayoutclusters: Resource$Storelayoutclusters; storelayoutpages: Resource$Storelayoutpages; users: Resource$Users; + webapps: Resource$Webapps; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this._options = options || {}; @@ -122,6 +123,7 @@ export namespace androidenterprise_v1 { this.storelayoutclusters = new Resource$Storelayoutclusters(this); this.storelayoutpages = new Resource$Storelayoutpages(this); this.users = new Resource$Users(this); + this.webapps = new Resource$Webapps(this); } getRoot() { @@ -1840,6 +1842,70 @@ export namespace androidenterprise_v1 { */ userValue?: string; } + /** + * WebApp resource info. + */ + export interface Schema$WebApp { + /** + * The display mode of the web app. + */ + displayMode?: string; + /** + * A list of icons representing this website. Must have at least one + * element. + */ + icons?: Schema$WebAppIcon[]; + /** + * A flag whether the app has been published to the Play store yet. + */ + isPublished?: boolean; + /** + * The start URL, i.e. the URL that should load when the user opens the + * application. + */ + startUrl?: string; + /** + * The title of the web application as displayed to the user (e.g., amongst + * a list of other applications, or as a label for an icon). + */ + title?: string; + /** + * The current version of the app. Note that the version can automatically + * increase during the lifetime of the web app, while Google does internal + * housekeeping to keep the web app up-to-date. + */ + versionCode?: string; + /** + * The ID of the application. + */ + webAppId?: string; + } + /** + * Icon for a web app. + */ + export interface Schema$WebAppIcon { + /** + * The actual bytes of the image in a base64url encoded string (c.f. + * RFC4648, section 5 "Base 64 Encoding with URL and Filename Safe + * Alphabet"). - The image type can be png or jpg. - The image should + * ideally be square. - The image should ideally have a size of 512x512. + */ + imageData?: string; + } + /** + * The web app details for an enterprise. + */ + export interface Schema$WebAppsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "androidenterprise#webAppsListResponse". + */ + kind?: string; + /** + * The manifest describing a web app. + */ + webApp?: Schema$WebApp[]; + } export class Resource$Devices { @@ -8503,8 +8569,9 @@ export namespace androidenterprise_v1 { * androidenterprise.users.generateAuthenticationToken * @desc Generates an authentication token which the device policy client * can use to provision the given EMM-managed user account on a device. The - * generated token is single-use and expires after a few minutes. This call - * only works with EMM-managed accounts. + * generated token is single-use and expires after a few minutes. You can + * provision a maximum of 10 devices per user. This call only works with + * EMM-managed accounts. * @alias androidenterprise.users.generateAuthenticationToken * @memberOf! () * @@ -9480,4 +9547,513 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$User; } + + + export class Resource$Webapps { + root: Androidenterprise; + constructor(root: Androidenterprise) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * androidenterprise.webapps.delete + * @desc Deletes an existing web app. + * @alias androidenterprise.webapps.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.enterpriseId The ID of the enterprise. + * @param {string} params.webAppId The ID of the web 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 + */ + delete(params?: Params$Resource$Webapps$Delete, options?: MethodOptions): + AxiosPromise; + delete( + params: Params$Resource$Webapps$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Webapps$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Webapps$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Webapps$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Webapps$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['enterpriseId', 'webAppId'], + pathParams: ['enterpriseId', 'webAppId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * androidenterprise.webapps.get + * @desc Gets an existing web app. + * @alias androidenterprise.webapps.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.enterpriseId The ID of the enterprise. + * @param {string} params.webAppId The ID of the web 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 + */ + get(params?: Params$Resource$Webapps$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Webapps$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Webapps$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Webapps$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Webapps$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Webapps$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['enterpriseId', 'webAppId'], + pathParams: ['enterpriseId', 'webAppId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * androidenterprise.webapps.insert + * @desc Creates a new web app for the enterprise. + * @alias androidenterprise.webapps.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.enterpriseId The ID of the enterprise. + * @param {().WebApp} 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$Webapps$Insert, options?: MethodOptions): + AxiosPromise; + insert( + params: Params$Resource$Webapps$Insert, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + insert( + params: Params$Resource$Webapps$Insert, + callback: BodyResponseCallback): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: Params$Resource$Webapps$Insert| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Webapps$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Webapps$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/webApps') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['enterpriseId'], + pathParams: ['enterpriseId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * androidenterprise.webapps.list + * @desc Retrieves the details of all web apps for a given enterprise. + * @alias androidenterprise.webapps.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.enterpriseId The ID of the enterprise. + * @param {object} [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$Webapps$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Webapps$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Webapps$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Webapps$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Webapps$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Webapps$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/webApps') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['enterpriseId'], + pathParams: ['enterpriseId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * androidenterprise.webapps.patch + * @desc Updates an existing web app. This method supports patch semantics. + * @alias androidenterprise.webapps.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.enterpriseId The ID of the enterprise. + * @param {string} params.webAppId The ID of the web app. + * @param {().WebApp} 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$Webapps$Patch, options?: MethodOptions): + AxiosPromise; + patch( + params: Params$Resource$Webapps$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Webapps$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Webapps$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Webapps$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Webapps$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['enterpriseId', 'webAppId'], + pathParams: ['enterpriseId', 'webAppId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * androidenterprise.webapps.update + * @desc Updates an existing web app. + * @alias androidenterprise.webapps.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.enterpriseId The ID of the enterprise. + * @param {string} params.webAppId The ID of the web app. + * @param {().WebApp} 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$Webapps$Update, options?: MethodOptions): + AxiosPromise; + update( + params: Params$Resource$Webapps$Update, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Webapps$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Webapps$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Webapps$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Webapps$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['enterpriseId', 'webAppId'], + pathParams: ['enterpriseId', 'webAppId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Webapps$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the enterprise. + */ + enterpriseId?: string; + /** + * The ID of the web app. + */ + webAppId?: string; + } + export interface Params$Resource$Webapps$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the enterprise. + */ + enterpriseId?: string; + /** + * The ID of the web app. + */ + webAppId?: string; + } + export interface Params$Resource$Webapps$Insert extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the enterprise. + */ + enterpriseId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WebApp; + } + export interface Params$Resource$Webapps$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the enterprise. + */ + enterpriseId?: string; + } + export interface Params$Resource$Webapps$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the enterprise. + */ + enterpriseId?: string; + /** + * The ID of the web app. + */ + webAppId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WebApp; + } + export interface Params$Resource$Webapps$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The ID of the enterprise. + */ + enterpriseId?: string; + /** + * The ID of the web app. + */ + webAppId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WebApp; + } } diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 6c6de808688..4d7bc761695 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -244,7 +244,7 @@ export namespace androidmanagement_v1 { * <tr><td>BUNDLE_ARRAY</td><td>array of * objects</td></tr> </table> */ - managedConfiguration?: any; + managedConfiguration?: {[key: string]: any;}; /** * The managed configurations template for the app, saved from the managed * configurations iframe. This field is ignored if managed_configuration is @@ -944,7 +944,7 @@ export namespace androidmanagement_v1 { * Optional, a map containing <key, value> configuration variables * defined for the configuration. */ - configurationVariables?: any; + configurationVariables?: {[key: string]: string;}; /** * The ID of the managed configurations template. */ @@ -1141,7 +1141,7 @@ export namespace androidmanagement_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1157,7 +1157,7 @@ export namespace androidmanagement_v1 { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * A list of package names. @@ -1483,7 +1483,7 @@ export namespace androidmanagement_v1 { * Network configuration for the device. See configure networks for more * information. */ - openNetworkConfiguration?: any; + openNetworkConfiguration?: {[key: string]: any;}; /** * Whether using NFC to beam data from apps is disabled. */ @@ -1615,7 +1615,7 @@ export namespace androidmanagement_v1 { */ usbFileTransferDisabled?: boolean; /** - * Whether USB storage is enabled. + * Whether USB storage is enabled. Deprecated. */ usbMassStorageEnabled?: boolean; /** @@ -1813,7 +1813,7 @@ export namespace androidmanagement_v1 { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1926,7 +1926,7 @@ export namespace androidmanagement_v1 { * (https://www.w3.org/International/articles/language-tags/) code, such as * en-US, es-ES, or fr. */ - localizedMessages?: any; + localizedMessages?: {[key: string]: string;}; } /** * A web token used to access the managed Google Play iframe. @@ -2703,7 +2703,7 @@ export namespace androidmanagement_v1 { /** * Optional flags that control the device wiping behavior. */ - wipeDataFlags?: string; + wipeDataFlags?: string[]; } export interface Params$Resource$Enterprises$Devices$Get extends StandardParameters { diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index 7b9332be902..e083d7401c7 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -450,7 +450,7 @@ export namespace androidpublisher_v2 { /** * List of localized title and description data. */ - listings?: any; + listings?: {[key: string]: Schema$InAppProductListing;}; /** * The package name of the parent app. */ @@ -459,7 +459,7 @@ export namespace androidpublisher_v2 { * Prices per buyer region. None of these prices should be zero. In-app * products can never be free. */ - prices?: any; + prices?: {[key: string]: Schema$Price;}; /** * Purchase type enum value. Unmodifiable after creation. */ diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index f174c9a261f..272e91575ab 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -432,7 +432,7 @@ export namespace androidpublisher_v3 { /** * List of localized title and description data. */ - listings?: any; + listings?: {[key: string]: Schema$InAppProductListing;}; /** * The package name of the parent app. */ @@ -441,7 +441,7 @@ export namespace androidpublisher_v3 { * Prices per buyer region. None of these prices should be zero. In-app * products can never be free. */ - prices?: any; + prices?: {[key: string]: Schema$Price;}; /** * Purchase type enum value. Unmodifiable after creation. */ @@ -732,6 +732,12 @@ export namespace androidpublisher_v3 { * its current expiry time. */ autoRenewing?: boolean; + /** + * Time at which the subscription will be automatically resumed, in + * milliseconds since the Epoch. Only present if the user has requested to + * pause the subscription. + */ + autoResumeTimeMillis?: string; /** * The reason why a subscription was canceled or is not auto-renewing. * Possible values are: - User canceled the subscription - Subscription diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index c87e72762d2..3cb8391e30b 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -527,10 +527,9 @@ export namespace appengine_v1 { export interface Schema$Deployment { /** * Options for any Google Cloud Build builds created as a part of this - * deployment.Note that this is orthogonal to the build parameter, where the - * deployment depends on an already existing cloud build. These options will - * only be used if a new build is created, such as when deploying to the App - * Engine flexible environment using files or zip. + * deployment.These options will only be used if a new build is created, + * such as when deploying to the App Engine flexible environment using files + * or zip. */ cloudBuildOptions?: Schema$CloudBuildOptions; /** @@ -543,7 +542,7 @@ export namespace appengine_v1 { * part of this version. All files must be readable using the credentials * supplied with this call. */ - files?: any; + files?: {[key: string]: Schema$FileInfo;}; /** * The zip file for this deployment, if this is a zip deployment. */ @@ -1064,7 +1063,7 @@ export namespace appengine_v1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: "us-east1". */ @@ -1073,7 +1072,7 @@ export namespace appengine_v1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: "projects/example-project/locations/us-east1" @@ -1207,7 +1206,7 @@ export namespace appengine_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1223,7 +1222,7 @@ export namespace appengine_v1 { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata for the given google.longrunning.Operation. @@ -1602,7 +1601,7 @@ export namespace appengine_v1 { /** * HTTP headers to use for all responses from these URLs. */ - httpHeaders?: any; + httpHeaders?: {[key: string]: string;}; /** * MIME type used to serve all files served by this handler.Defaults to * file-specific MIME types, which are derived from each file's filename @@ -1670,7 +1669,7 @@ export namespace appengine_v1 { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1693,7 +1692,7 @@ export namespace appengine_v1 { * for IP-based splits and up to three decimal places is supported for * cookie-based splits. */ - allocations?: any; + allocations?: {[key: string]: number;}; /** * Mechanism used to determine which version a request is sent to. The * traffic selection algorithm will be stable for either type until @@ -1797,7 +1796,7 @@ export namespace appengine_v1 { * Metadata settings that are supplied to this version to enable beta * runtime features. */ - betaSettings?: any; + betaSettings?: {[key: string]: string;}; /** * Email address of the user who created this version.@OutputOnly */ @@ -1842,7 +1841,7 @@ export namespace appengine_v1 { * Environment variables available to the application.Only returned in GET * requests if view=FULL is set. */ - envVariables?: any; + envVariables?: {[key: string]: string;}; /** * Custom static error pages. Limited to 10KB per page.Only returned in GET * requests if view=FULL is set. diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 51a4f297783..e0f1f9aee30 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -360,7 +360,7 @@ export namespace appengine_v1alpha { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: "us-east1". */ @@ -369,7 +369,7 @@ export namespace appengine_v1alpha { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: "projects/example-project/locations/us-east1" @@ -429,7 +429,7 @@ export namespace appengine_v1alpha { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -445,7 +445,7 @@ export namespace appengine_v1alpha { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata for the given google.longrunning.Operation. @@ -702,7 +702,7 @@ export namespace appengine_v1alpha { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 4d86bf3924b..1ce7b62ba4b 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -576,10 +576,9 @@ export namespace appengine_v1beta { build?: Schema$BuildInfo; /** * Options for any Google Cloud Build builds created as a part of this - * deployment.Note that this is orthogonal to the build parameter, where the - * deployment depends on an already existing cloud build. These options will - * only be used if a new build is created, such as when deploying to the App - * Engine flexible environment using files or zip. + * deployment.These options will only be used if a new build is created, + * such as when deploying to the App Engine flexible environment using files + * or zip. */ cloudBuildOptions?: Schema$CloudBuildOptions; /** @@ -592,7 +591,7 @@ export namespace appengine_v1beta { * part of this version. All files must be readable using the credentials * supplied with this call. */ - files?: any; + files?: {[key: string]: Schema$FileInfo;}; /** * The zip file for this deployment, if this is a zip deployment. */ @@ -1124,7 +1123,7 @@ export namespace appengine_v1beta { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: "us-east1". */ @@ -1133,7 +1132,7 @@ export namespace appengine_v1beta { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: "projects/example-project/locations/us-east1" @@ -1286,7 +1285,7 @@ export namespace appengine_v1beta { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1302,7 +1301,7 @@ export namespace appengine_v1beta { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata for the given google.longrunning.Operation. @@ -1681,7 +1680,7 @@ export namespace appengine_v1beta { /** * HTTP headers to use for all responses from these URLs. */ - httpHeaders?: any; + httpHeaders?: {[key: string]: string;}; /** * MIME type used to serve all files served by this handler.Defaults to * file-specific MIME types, which are derived from each file's filename @@ -1749,7 +1748,7 @@ export namespace appengine_v1beta { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1772,7 +1771,7 @@ export namespace appengine_v1beta { * for IP-based splits and up to three decimal places is supported for * cookie-based splits. */ - allocations?: any; + allocations?: {[key: string]: number;}; /** * Mechanism used to determine which version a request is sent to. The * traffic selection algorithm will be stable for either type until @@ -1876,7 +1875,7 @@ export namespace appengine_v1beta { * Metadata settings that are supplied to this version to enable beta * runtime features. */ - betaSettings?: any; + betaSettings?: {[key: string]: string;}; /** * Email address of the user who created this version.@OutputOnly */ @@ -1921,7 +1920,7 @@ export namespace appengine_v1beta { * Environment variables available to the application.Only returned in GET * requests if view=FULL is set. */ - envVariables?: any; + envVariables?: {[key: string]: string;}; /** * Custom static error pages. Limited to 10KB per page.Only returned in GET * requests if view=FULL is set. diff --git a/src/apis/appengine/v1beta4.ts b/src/apis/appengine/v1beta4.ts index 213e2aeea6a..867faf94156 100644 --- a/src/apis/appengine/v1beta4.ts +++ b/src/apis/appengine/v1beta4.ts @@ -379,7 +379,7 @@ export namespace appengine_v1beta4 { * part of this version. All files must be readable using the credentials * supplied with this call. */ - files?: any; + files?: {[key: string]: Schema$FileInfo;}; /** * Origin of the source code for this deployment. There can be more than one * source reference per version if source code is distributed among multiple @@ -713,7 +713,7 @@ export namespace appengine_v1beta4 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: "us-east1". */ @@ -722,7 +722,7 @@ export namespace appengine_v1beta4 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: "projects/example-project/locations/us-east1" @@ -843,7 +843,7 @@ export namespace appengine_v1beta4 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -859,7 +859,7 @@ export namespace appengine_v1beta4 { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata for the given google.longrunning.Operation. @@ -1118,7 +1118,7 @@ export namespace appengine_v1beta4 { /** * HTTP headers to use for all responses from these URLs. */ - httpHeaders?: any; + httpHeaders?: {[key: string]: string;}; /** * MIME type used to serve all files served by this handler. Defaults to * file-specific MIME types, which are direved from each file's filename @@ -1153,7 +1153,7 @@ export namespace appengine_v1beta4 { /** * HTTP headers to use for all responses from these URLs. */ - httpHeaders?: any; + httpHeaders?: {[key: string]: string;}; /** * MIME type used to serve all files served by this handler. Defaults to * file-specific MIME types, which are derived from each file's filename @@ -1221,7 +1221,7 @@ export namespace appengine_v1beta4 { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1244,7 +1244,7 @@ export namespace appengine_v1beta4 { * for IP-based splits and up to three decimal places is supported for * cookie-based splits. */ - allocations?: any; + allocations?: {[key: string]: number;}; /** * Mechanism used to determine which version a request is sent to. The * traffic selection algorithm will be stable for either type until @@ -1351,7 +1351,7 @@ export namespace appengine_v1beta4 { * Metadata settings that are supplied to this version to enable beta * runtime features. */ - betaSettings?: any; + betaSettings?: {[key: string]: string;}; /** * Time that this version was created.@OutputOnly */ @@ -1387,7 +1387,7 @@ export namespace appengine_v1beta4 { * Environment variables made available to the application.Only returned in * GET requests if view=FULL is set. */ - envVariables?: any; + envVariables?: {[key: string]: string;}; /** * Custom static error pages. Limited to 10KB per page.Only returned in GET * requests if view=FULL is set. diff --git a/src/apis/appengine/v1beta5.ts b/src/apis/appengine/v1beta5.ts index 7eb61772430..aafacb4967d 100644 --- a/src/apis/appengine/v1beta5.ts +++ b/src/apis/appengine/v1beta5.ts @@ -379,7 +379,7 @@ export namespace appengine_v1beta5 { * part of this version. All files must be readable using the credentials * supplied with this call. */ - files?: any; + files?: {[key: string]: Schema$FileInfo;}; /** * Origin of the source code for this deployment. There can be more than one * source reference per version if source code is distributed among multiple @@ -713,7 +713,7 @@ export namespace appengine_v1beta5 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: "us-east1". */ @@ -722,7 +722,7 @@ export namespace appengine_v1beta5 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: "projects/example-project/locations/us-east1" @@ -834,7 +834,7 @@ export namespace appengine_v1beta5 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -850,7 +850,7 @@ export namespace appengine_v1beta5 { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata for the given google.longrunning.Operation. @@ -1130,7 +1130,7 @@ export namespace appengine_v1beta5 { /** * HTTP headers to use for all responses from these URLs. */ - httpHeaders?: any; + httpHeaders?: {[key: string]: string;}; /** * MIME type used to serve all files served by this handler. Defaults to * file-specific MIME types, which are derived from each file's filename @@ -1198,7 +1198,7 @@ export namespace appengine_v1beta5 { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1221,7 +1221,7 @@ export namespace appengine_v1beta5 { * for IP-based splits and up to three decimal places is supported for * cookie-based splits. */ - allocations?: any; + allocations?: {[key: string]: number;}; /** * Mechanism used to determine which version a request is sent to. The * traffic selection algorithm will be stable for either type until @@ -1322,7 +1322,7 @@ export namespace appengine_v1beta5 { * Metadata settings that are supplied to this version to enable beta * runtime features. */ - betaSettings?: any; + betaSettings?: {[key: string]: string;}; /** * Time that this version was created.@OutputOnly */ @@ -1363,7 +1363,7 @@ export namespace appengine_v1beta5 { * Environment variables made available to the application.Only returned in * GET requests if view=FULL is set. */ - envVariables?: any; + envVariables?: {[key: string]: string;}; /** * Custom static error pages. Limited to 10KB per page.Only returned in GET * requests if view=FULL is set. diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 70b1ba80a88..5b3199cad93 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -296,7 +296,14 @@ export namespace bigquery_v2 { * access.specialGroup: projectOwners; access.role: OWNER; * access.userByEmail: [dataset creator email]; access.role: OWNER; */ - access?: any[]; + access?: Array<{ + domain?: string; + groupByEmail?: string; + role?: string; + specialGroup?: string; + userByEmail?: string; + view?: Schema$TableReference; + }>; /** * [Output-only] The time when this dataset was created, in milliseconds * since the epoch. @@ -364,7 +371,7 @@ export namespace bigquery_v2 { * updating a dataset. See Creating and Updating Dataset Labels for more * information. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output-only] The date when this dataset or any of its tables was last * modified, in milliseconds since the epoch. @@ -389,7 +396,14 @@ export namespace bigquery_v2 { * resource, use the Datasets: get method. This property is omitted when * there are no datasets in the project. */ - datasets?: any[]; + datasets?: Array<{ + datasetReference?: Schema$DatasetReference; + friendlyName?: string; + id?: string; + kind?: string; + labels?: {[key: string]: string;}; + location?: string; + }>; /** * A hash value of the results page. You can use this property to determine * if the page has changed since the last request. @@ -876,7 +890,7 @@ export namespace bigquery_v2 { * values are optional. Label keys must start with a letter and each label * in the list must have a different key. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Pick one] Configures a load job. */ @@ -1229,7 +1243,7 @@ export namespace bigquery_v2 { * source. By defining these properties, the data source can then be queried * as if it were a standard BigQuery table. */ - tableDefinitions?: any; + tableDefinitions?: {[key: string]: Schema$ExternalDataConfiguration;}; /** * Time-based partitioning specification for the destination table. Only one * of timePartitioning and rangePartitioning should be specified. @@ -1317,7 +1331,17 @@ export namespace bigquery_v2 { /** * List of jobs that were requested. */ - jobs?: any[]; + jobs?: Array<{ + configuration?: Schema$JobConfiguration; + errorResult?: Schema$ErrorProto; + id?: string; + jobReference?: Schema$JobReference; + kind?: string; + state?: string; + statistics?: Schema$JobStatistics; + status?: Schema$JobStatus; + user_email?: string; + }>; /** * The resource type of the response. */ @@ -1446,7 +1470,7 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: any[]; + reservationUsage?: Array<{name?: string; slotMs?: string;}>; /** * [Output-only] The schema of the results. Present only for successful dry * run of non-legacy SQL queries. @@ -1561,7 +1585,7 @@ export namespace bigquery_v2 { * options are immutable for subsequent training runs. Default values are * used for any options not specified in the input query. */ - modelOptions?: any; + modelOptions?: {labels?: string[]; lossType?: string; modelType?: string;}; /** * [Output-only, Beta] Information about ml training runs, each training run * comprises of multiple iterations and there may be multiple training runs @@ -1586,7 +1610,13 @@ export namespace bigquery_v2 { /** * Projects to which you have at least READ access. */ - projects?: any[]; + projects?: Array<{ + friendlyName?: string; + id?: string; + kind?: string; + numericId?: string; + projectReference?: Schema$ProjectReference; + }>; /** * The total number of projects in the list. */ @@ -1623,7 +1653,11 @@ export namespace bigquery_v2 { * [Optional] The types of the fields of this struct, in order, if this is a * struct. */ - structTypes?: any[]; + structTypes?: Array<{ + description?: string; + name?: string; + type?: Schema$QueryParameterType; + }>; /** * [Required] The top level type of this field. */ @@ -1638,7 +1672,7 @@ export namespace bigquery_v2 { * [Optional] The struct field values, in order of the struct type's * declaration. */ - structValues?: any; + structValues?: {[key: string]: Schema$QueryParameterValue;}; /** * [Optional] The value of this value, if a simple scalar type. */ @@ -1818,7 +1852,7 @@ export namespace bigquery_v2 { /** * [Experimental] [Required] Defines the ranges for range partitioning. */ - range?: any; + range?: {end?: string; interval?: string; start?: string;}; } export interface Schema$Streamingbuffer { /** @@ -1899,7 +1933,7 @@ export namespace bigquery_v2 { * values are optional. Label keys must start with a letter and each label * in the list must have a different key. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output-only] The time when this table was last modified, in milliseconds * since the epoch. @@ -2001,7 +2035,7 @@ export namespace bigquery_v2 { /** * The rows to insert. */ - rows?: any[]; + rows?: Array<{insertId?: string; json?: Schema$JsonObject;}>; /** * [Optional] Insert all valid rows of a request, even if invalid rows * exist. The default value is false, which causes the entire request to @@ -2022,7 +2056,7 @@ export namespace bigquery_v2 { /** * An array of errors for rows that were not inserted. */ - insertErrors?: any[]; + insertErrors?: Array<{errors?: Schema$ErrorProto[]; index?: number;}>; /** * The resource type of the response. */ @@ -2098,7 +2132,19 @@ export namespace bigquery_v2 { /** * Tables in the requested dataset. */ - tables?: any[]; + tables?: Array<{ + clustering?: Schema$Clustering; + creationTime?: string; + expirationTime?: string; + friendlyName?: string; + id?: string; + kind?: string; + labels?: {[key: string]: string;}; + tableReference?: Schema$TableReference; + timePartitioning?: Schema$TimePartitioning; + type?: string; + view?: {useLegacySql?: boolean;}; + }>; /** * The total number of tables in the dataset. */ @@ -2185,7 +2231,17 @@ export namespace bigquery_v2 { * explicitly specified in the input query will be copied from the previous * training run. */ - trainingOptions?: any; + trainingOptions?: { + earlyStop?: boolean; + l1Reg?: number; + l2Reg?: number; + learnRate?: number; + learnRateStrategy?: string; + lineSearchInitLearnRate?: number; + maxIteration?: string; + minRelProgress?: number; + warmStart?: boolean; + }; } export interface Schema$UserDefinedFunctionResource { /** @@ -4076,7 +4132,7 @@ export namespace bigquery_v2 { /** * Filter for job state */ - stateFilter?: string; + stateFilter?: string[]; } export interface Params$Resource$Jobs$Query extends StandardParameters { /** diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index c08b2a5c7df..f9efcfbf257 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -387,7 +387,7 @@ export namespace bigquerydatatransfer_v1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -396,7 +396,7 @@ export namespace bigquerydatatransfer_v1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -472,7 +472,7 @@ export namespace bigquerydatatransfer_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -535,7 +535,7 @@ export namespace bigquerydatatransfer_v1 { /** * Data transfer specific parameters. */ - params?: any; + params?: {[key: string]: any;}; /** * Data transfer schedule. If the data source does not support a custom * schedule, this should be empty. If it is empty, the default value for the @@ -611,7 +611,7 @@ export namespace bigquerydatatransfer_v1 { /** * Output only. Data transfer specific parameters. */ - params?: any; + params?: {[key: string]: any;}; /** * For batch transfer runs, specifies the date and time that data should be * ingested. @@ -1951,7 +1951,7 @@ export namespace bigquerydatatransfer_v1 { * When specified, only configurations of requested data sources are * returned. */ - dataSourceIds?: string; + dataSourceIds?: string[]; /** * Page size. The default page size is the maximum value of 1000 results. */ @@ -2314,7 +2314,7 @@ export namespace bigquerydatatransfer_v1 { /** * When specified, only transfer runs with requested states are returned. */ - states?: string; + states?: string[]; } export class Resource$Projects$Locations$Transferconfigs$Runs$Transferlogs { @@ -2418,7 +2418,7 @@ export namespace bigquerydatatransfer_v1 { * Message types to return. If not populated - INFO, WARNING and ERROR * messages are returned. */ - messageTypes?: string; + messageTypes?: string[]; /** * Page size. The default page size is the maximum value of 1000 results. */ @@ -2957,7 +2957,7 @@ export namespace bigquerydatatransfer_v1 { * When specified, only configurations of requested data sources are * returned. */ - dataSourceIds?: string; + dataSourceIds?: string[]; /** * Page size. The default page size is the maximum value of 1000 results. */ @@ -3312,7 +3312,7 @@ export namespace bigquerydatatransfer_v1 { /** * When specified, only transfer runs with requested states are returned. */ - states?: string; + states?: string[]; } export class Resource$Projects$Transferconfigs$Runs$Transferlogs { @@ -3414,7 +3414,7 @@ export namespace bigquerydatatransfer_v1 { * Message types to return. If not populated - INFO, WARNING and ERROR * messages are returned. */ - messageTypes?: string; + messageTypes?: string[]; /** * Page size. The default page size is the maximum value of 1000 results. */ diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index ce0cce55e24..1e060ef7d86 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -347,7 +347,7 @@ export namespace binaryauthorization_v1beta1 { * region (e.g. us-central1). For `clusterId` syntax restrictions see * https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters. */ - clusterAdmissionRules?: any; + clusterAdmissionRules?: {[key: string]: Schema$AdmissionRule;}; /** * Required. Default admission rule for a cluster without a per-cluster * admission rule. diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts index 5afc578c4a1..f8a5dd57200 100644 --- a/src/apis/blogger/v2.ts +++ b/src/apis/blogger/v2.ts @@ -122,7 +122,7 @@ export namespace blogger_v2 { /** * The locale this Blog is set to. */ - locale?: any; + locale?: {country?: string; language?: string; variant?: string;}; /** * The name of this blog. This is displayed as the title. */ @@ -130,11 +130,11 @@ export namespace blogger_v2 { /** * The container of pages in this blog. */ - pages?: any; + pages?: {selfLink?: string; totalItems?: number;}; /** * The container of posts in this blog. */ - posts?: any; + posts?: {selfLink?: string; totalItems?: number;}; /** * RFC 3339 date-time when this blog was published. */ @@ -166,11 +166,16 @@ export namespace blogger_v2 { /** * The author of this Comment. */ - author?: any; + author?: { + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + }; /** * Data about the blog containing this comment. */ - blog?: any; + blog?: {id?: string;}; /** * The actual content of the comment. May include HTML markup. */ @@ -182,7 +187,7 @@ export namespace blogger_v2 { /** * Data about the comment this is in reply to. */ - inReplyTo?: any; + inReplyTo?: {id?: string;}; /** * The kind of this entry. Always blogger#comment */ @@ -190,7 +195,7 @@ export namespace blogger_v2 { /** * Data about the post containing this comment. */ - post?: any; + post?: {id?: string;}; /** * RFC 3339 date-time when this comment was published. */ @@ -226,11 +231,16 @@ export namespace blogger_v2 { /** * The author of this Page. */ - author?: any; + author?: { + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + }; /** * Data about the blog containing this Page. */ - blog?: any; + blog?: {id?: string;}; /** * The body content of this Page, in HTML. */ @@ -279,11 +289,16 @@ export namespace blogger_v2 { /** * The author of this Post. */ - author?: any; + author?: { + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + }; /** * Data about the blog containing this Post. */ - blog?: any; + blog?: {id?: string;}; /** * The content of the Post. May contain HTML markup. */ @@ -307,7 +322,7 @@ export namespace blogger_v2 { /** * The container of comments on this Post. */ - replies?: any; + replies?: {selfLink?: string; totalItems?: string;}; /** * The API REST URL to fetch this resource from. */ @@ -351,7 +366,7 @@ export namespace blogger_v2 { /** * The container of blogs for this user. */ - blogs?: any; + blogs?: {selfLink?: string;}; /** * The timestamp of when this profile was created, in seconds since epoch. */ @@ -371,7 +386,7 @@ export namespace blogger_v2 { /** * This user's locale */ - locale?: any; + locale?: {country?: string; language?: string; variant?: string;}; /** * The API REST URL to fetch this resource from. */ diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts index 9d44195029c..d9b52d56ac7 100644 --- a/src/apis/blogger/v3.ts +++ b/src/apis/blogger/v3.ts @@ -132,7 +132,7 @@ export namespace blogger_v3 { /** * The locale this Blog is set to. */ - locale?: any; + locale?: {country?: string; language?: string; variant?: string;}; /** * The name of this blog. This is displayed as the title. */ @@ -140,11 +140,11 @@ export namespace blogger_v3 { /** * The container of pages in this blog. */ - pages?: any; + pages?: {selfLink?: string; totalItems?: number;}; /** * The container of posts in this blog. */ - posts?: any; + posts?: {items?: Schema$Post[]; selfLink?: string; totalItems?: number;}; /** * RFC 3339 date-time when this blog was published. */ @@ -225,11 +225,16 @@ export namespace blogger_v3 { /** * The author of this Comment. */ - author?: any; + author?: { + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + }; /** * Data about the blog containing this comment. */ - blog?: any; + blog?: {id?: string;}; /** * The actual content of the comment. May include HTML markup. */ @@ -241,7 +246,7 @@ export namespace blogger_v3 { /** * Data about the comment this is in reply to. */ - inReplyTo?: any; + inReplyTo?: {id?: string;}; /** * The kind of this entry. Always blogger#comment */ @@ -249,7 +254,7 @@ export namespace blogger_v3 { /** * Data about the post containing this comment. */ - post?: any; + post?: {id?: string;}; /** * RFC 3339 date-time when this comment was published. */ @@ -293,11 +298,16 @@ export namespace blogger_v3 { /** * The author of this Page. */ - author?: any; + author?: { + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + }; /** * Data about the blog containing this Page. */ - blog?: any; + blog?: {id?: string;}; /** * The body content of this Page, in HTML. */ @@ -366,7 +376,7 @@ export namespace blogger_v3 { /** * The container of posts in this blog. */ - counts?: any[]; + counts?: Array<{count?: string; timeRange?: string;}>; /** * The kind of this entry. Always blogger#page_views */ @@ -376,11 +386,16 @@ export namespace blogger_v3 { /** * The author of this Post. */ - author?: any; + author?: { + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + }; /** * Data about the blog containing this Post. */ - blog?: any; + blog?: {id?: string;}; /** * The content of the Post. May contain HTML markup. */ @@ -400,7 +415,7 @@ export namespace blogger_v3 { /** * Display image for the Post. */ - images?: any[]; + images?: Array<{url?: string;}>; /** * The kind of this entity. Always blogger#post */ @@ -412,7 +427,7 @@ export namespace blogger_v3 { /** * The location for geotagged posts. */ - location?: any; + location?: {lat?: number; lng?: number; name?: string; span?: string;}; /** * RFC 3339 date-time when this Post was published. */ @@ -424,7 +439,8 @@ export namespace blogger_v3 { /** * The container of comments on this Post. */ - replies?: any; + replies?: + {items?: Schema$Comment[]; selfLink?: string; totalItems?: string;}; /** * The API REST URL to fetch this resource from. */ @@ -526,7 +542,7 @@ export namespace blogger_v3 { /** * The container of blogs for this user. */ - blogs?: any; + blogs?: {selfLink?: string;}; /** * The timestamp of when this profile was created, in seconds since epoch. */ @@ -546,7 +562,7 @@ export namespace blogger_v3 { /** * This user's locale */ - locale?: any; + locale?: {country?: string; language?: string; variant?: string;}; /** * The API REST URL to fetch this resource from. */ @@ -819,12 +835,12 @@ export namespace blogger_v3 { * return blogs where the user has author level access. If no roles are * specified, defaults to ADMIN and AUTHOR roles. */ - role?: string; + role?: string[]; /** * Blog statuses to include in the result (default: Live blogs only). Note * that ADMIN access is required to view deleted blogs. */ - status?: string; + status?: string[]; /** * ID of the user whose blogs are to be fetched. Either the word 'self' * (sans quote marks) or the user's profile identifier. @@ -1540,7 +1556,7 @@ export namespace blogger_v3 { /** * */ - status?: string; + status?: string[]; /** * Access level with which to view the returned result. Note that some * fields require elevated access. @@ -1581,7 +1597,7 @@ export namespace blogger_v3 { /** * */ - status?: string; + status?: string[]; } export interface Params$Resource$Comments$Markasspam extends StandardParameters { @@ -2247,7 +2263,7 @@ export namespace blogger_v3 { /** * */ - status?: string; + status?: string[]; /** * Access level with which to view the returned result. Note that some * fields require elevated access. @@ -2434,7 +2450,7 @@ export namespace blogger_v3 { /** * */ - range?: string; + range?: string[]; } @@ -3283,7 +3299,7 @@ export namespace blogger_v3 { /** * Statuses to include in the results. */ - status?: string; + status?: string[]; /** * Access level with which to view the returned result. Note that some * fields require escalated access. @@ -3668,7 +3684,7 @@ export namespace blogger_v3 { /** * */ - status?: string; + status?: string[]; /** * ID of the user for the per-user information to be fetched. Either the * word 'self' (sans quote marks) or the user's profile identifier. diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts index 1dd12479ca3..18ab19fc3a2 100644 --- a/src/apis/books/v1.ts +++ b/src/apis/books/v1.ts @@ -136,7 +136,13 @@ export namespace books_v1 { /** * Selection ranges sent from the client. */ - clientVersionRanges?: any; + clientVersionRanges?: { + cfiRange?: Schema$BooksAnnotationsRange; + contentVersion?: string; + gbImageRange?: Schema$BooksAnnotationsRange; + gbTextRange?: Schema$BooksAnnotationsRange; + imageCfiRange?: Schema$BooksAnnotationsRange; + }; /** * Timestamp for the created time of this annotation. */ @@ -144,7 +150,13 @@ export namespace books_v1 { /** * Selection ranges for the most recent content version. */ - currentVersionRanges?: any; + currentVersionRanges?: { + cfiRange?: Schema$BooksAnnotationsRange; + contentVersion?: string; + gbImageRange?: Schema$BooksAnnotationsRange; + gbTextRange?: Schema$BooksAnnotationsRange; + imageCfiRange?: Schema$BooksAnnotationsRange; + }; /** * User-created data for this annotation. */ @@ -169,7 +181,11 @@ export namespace books_v1 { * The layer this annotation is for. */ layerId?: string; - layerSummary?: any; + layerSummary?: { + allowedCharacterCount?: number; + limitType?: string; + remainingCharacterCount?: number; + }; /** * Pages that this annotation spans. */ @@ -268,7 +284,13 @@ export namespace books_v1 { } export interface Schema$AnnotationsSummary { kind?: string; - layers?: any[]; + layers?: Array<{ + allowedCharacterCount?: number; + layerId?: string; + limitType?: string; + remainingCharacterCount?: number; + updated?: string; + }>; } export interface Schema$BooksAnnotationsRange { /** @@ -356,7 +378,7 @@ export namespace books_v1 { /** * A list of onboarding categories. */ - items?: any[]; + items?: Array<{badgeUrl?: string; categoryId?: string; name?: string;}>; /** * Resource type. */ @@ -411,12 +433,54 @@ export namespace books_v1 { volumeId?: string; } export interface Schema$Dictlayerdata { - common?: any; - dict?: any; + common?: {title?: string;}; + dict?: { + source?: {attribution?: string; url?: string;}; + words?: Array<{ + derivatives?: Array< + {source?: {attribution?: string; url?: string;}; text?: string;}>; + examples?: Array< + {source?: {attribution?: string; url?: string;}; text?: string;}>; + senses?: Array<{ + conjugations?: Array<{type?: string; value?: string;}>; + definitions?: Array<{ + definition?: string; + examples?: Array<{ + source?: {attribution?: string; url?: string;}; + text?: string; + }>; + }>; + partOfSpeech?: string; + pronunciation?: string; + pronunciationUrl?: string; + source?: {attribution?: string; url?: string;}; + syllabification?: string; + synonyms?: Array<{ + source?: {attribution?: string; url?: string;}; + text?: string; + }>; + }>; + source?: {attribution?: string; url?: string;}; + }>; + }; kind?: string; } export interface Schema$Discoveryclusters { - clusters?: any[]; + clusters?: Array<{ + banner_with_content_container?: { + fillColorArgb?: string; + imageUrl?: string; + maskColorArgb?: string; + moreButtonText?: string; + moreButtonUrl?: string; + textColorArgb?: string; + }; + subTitle?: string; + title?: string; + totalVolumes?: number; + uid?: string; + volumes?: Schema$Volume[]; + }>; /** * Resorce type. */ @@ -497,11 +561,35 @@ export namespace books_v1 { /** * Family membership info of the user that made the request. */ - membership?: any; + membership?: { + acquirePermission?: string; + ageGroup?: string; + allowedMaturityRating?: string; + isInFamily?: boolean; + role?: string; + }; } export interface Schema$Geolayerdata { - common?: any; - geo?: any; + common?: { + lang?: string; + previewImageUrl?: string; + snippet?: string; + snippetUrl?: string; + title?: string; + }; + geo?: { + boundary?: Array>; + cachePolicy?: string; + countryCode?: string; + latitude?: number; + longitude?: number; + mapType?: string; + viewport?: { + hi?: {latitude?: number; longitude?: number;}; + lo?: {latitude?: number; longitude?: number;}; + }; + zoom?: number; + }; kind?: string; } export interface Schema$Layersummaries { @@ -580,7 +668,13 @@ export namespace books_v1 { /** * A list of offline dictionary metadata. */ - items?: any[]; + items?: Array<{ + download_url?: string; + encrypted_key?: string; + language?: string; + size?: string; + version?: string; + }>; /** * Resource type. */ @@ -613,7 +707,19 @@ export namespace books_v1 { /** * A list of offers. */ - items?: any[]; + items?: Array<{ + artUrl?: string; + gservicesKey?: string; + id?: string; + items?: Array<{ + author?: string; + canonicalVolumeLink?: string; + coverUrl?: string; + description?: string; + title?: string; + volumeId?: string; + }>; + }>; /** * Resource type. */ @@ -668,7 +774,7 @@ export namespace books_v1 { /** * Author of this review. */ - author?: any; + author?: {displayName?: string;}; /** * Review text. */ @@ -694,7 +800,7 @@ export namespace books_v1 { * Information regarding the source of this review, when the review is not * from a Google Books user. */ - source?: any; + source?: {description?: string; extraDescription?: string; url?: string;}; /** * Title for this review. */ @@ -714,7 +820,13 @@ export namespace books_v1 { * Resource type. */ kind?: string; - series?: any[]; + series?: Array<{ + bannerImageUrl?: string; + imageUrl?: string; + seriesId?: string; + seriesType?: string; + title?: string; + }>; } export interface Schema$Seriesmembership { /** @@ -732,8 +844,14 @@ export namespace books_v1 { /** * User settings in sub-objects, each for different purposes. */ - notesExport?: any; - notification?: any; + notesExport?: {folderName?: string; isEnabled?: boolean;}; + notification?: { + matchMyInterests?: {opted_state?: string;}; + moreFromAuthors?: {opted_state?: string;}; + moreFromSeries?: {opted_state?: string;}; + priceDrop?: {opted_state?: string;}; + rewardExpirations?: {opted_state?: string;}; + }; } export interface Schema$Volume { /** @@ -741,7 +859,30 @@ export namespace books_v1 { * volume text. This information can depend on country (books may be public * domain in one country but not in another, e.g.). */ - accessInfo?: any; + accessInfo?: { + accessViewStatus?: string; + country?: string; + downloadAccess?: Schema$DownloadAccessRestriction; + driveImportedContentLink?: string; + embeddable?: boolean; + epub?: { + acsTokenLink?: string; + downloadLink?: string; + isAvailable?: boolean; + }; + explicitOfflineLicenseManagement?: boolean; + pdf?: { + acsTokenLink?: string; + downloadLink?: string; + isAvailable?: boolean; + }; + publicDomain?: boolean; + quoteSharingAllowed?: boolean; + textToSpeechPermission?: string; + viewOrderUrl?: string; + viewability?: string; + webReaderLink?: string; + }; /** * Opaque identifier for a specific version of a volume resource. (In LITE * projection) @@ -758,22 +899,39 @@ export namespace books_v1 { /** * What layers exist in this volume and high level information about them. */ - layerInfo?: any; + layerInfo?: { + layers?: Array<{layerId?: string; volumeAnnotationsVersion?: string;}>; + }; /** * Recommendation related information for this volume. */ - recommendedInfo?: any; + recommendedInfo?: {explanation?: string;}; /** * Any information about a volume related to the eBookstore and/or * purchaseability. This information can depend on the country where the * request originates from (i.e. books may not be for sale in certain * countries). */ - saleInfo?: any; + saleInfo?: { + buyLink?: string; + country?: string; + isEbook?: boolean; + listPrice?: {amount?: number; currencyCode?: string;}; + offers?: Array<{ + finskyOfferType?: number; + giftable?: boolean; + listPrice?: {amountInMicros?: number; currencyCode?: string;}; + rentalDuration?: {count?: number; unit?: string;}; + retailPrice?: {amountInMicros?: number; currencyCode?: string;}; + }>; + onSaleDate?: string; + retailPrice?: {amount?: number; currencyCode?: string;}; + saleability?: string; + }; /** * Search result information related to this volume. */ - searchInfo?: any; + searchInfo?: {textSnippet?: string;}; /** * URL to this resource. (In LITE projection.) */ @@ -782,11 +940,81 @@ export namespace books_v1 { * User specific information related to this volume. (e.g. page this user * last read or whether they purchased this book) */ - userInfo?: any; + userInfo?: { + acquiredTime?: string; + acquisitionType?: number; + copy?: { + allowedCharacterCount?: number; + limitType?: string; + remainingCharacterCount?: number; + updated?: string; + }; + entitlementType?: number; + familySharing?: { + familyRole?: string; + isSharingAllowed?: boolean; + isSharingDisabledByFop?: boolean; + }; + isFamilySharedFromUser?: boolean; + isFamilySharedToUser?: boolean; + isFamilySharingAllowed?: boolean; + isFamilySharingDisabledByFop?: boolean; + isInMyBooks?: boolean; + isPreordered?: boolean; + isPurchased?: boolean; + isUploaded?: boolean; + readingPosition?: Schema$ReadingPosition; + rentalPeriod?: {endUtcSec?: string; startUtcSec?: string;}; + rentalState?: string; + review?: Schema$Review; + updated?: string; + userUploadedVolumeInfo?: {processingState?: string;}; + }; /** * General volume information. */ - volumeInfo?: any; + volumeInfo?: { + allowAnonLogging?: boolean; + authors?: string[]; + averageRating?: number; + canonicalVolumeLink?: string; + categories?: string[]; + comicsContent?: boolean; + contentVersion?: string; + description?: string; + dimensions?: {height?: string; thickness?: string; width?: string;}; + imageLinks?: { + extraLarge?: string; + large?: string; + medium?: string; + small?: string; + smallThumbnail?: string; + thumbnail?: string; + }; + industryIdentifiers?: Array<{identifier?: string; type?: string;}>; + infoLink?: string; + language?: string; + mainCategory?: string; + maturityRating?: string; + pageCount?: number; + panelizationSummary?: { + containsEpubBubbles?: boolean; + containsImageBubbles?: boolean; + epubBubbleVersion?: string; + imageBubbleVersion?: string; + }; + previewLink?: string; + printType?: string; + printedPageCount?: number; + publishedDate?: string; + publisher?: string; + ratingsCount?: number; + readingModes?: any; + samplePageCount?: number; + seriesInfo?: Schema$Volumeseriesinfo; + subtitle?: string; + title?: string; + }; } export interface Schema$Volume2 { /** @@ -815,7 +1043,12 @@ export namespace books_v1 { /** * The content ranges to identify the selected text. */ - contentRanges?: any; + contentRanges?: { + cfiRange?: Schema$BooksAnnotationsRange; + contentVersion?: string; + gbImageRange?: Schema$BooksAnnotationsRange; + gbTextRange?: Schema$BooksAnnotationsRange; + }; /** * Data for this annotation. */ @@ -913,7 +1146,12 @@ export namespace books_v1 { * Short book title in the context of the series. */ shortSeriesBookTitle?: string; - volumeSeries?: any[]; + volumeSeries?: Array<{ + issue?: Array<{issueDisplayNumber?: string; issueOrderNumber?: number;}>; + orderNumber?: number; + seriesBookType?: string; + seriesId?: string; + }>; } @@ -2278,7 +2516,7 @@ export namespace books_v1 { * The list of Annotation Data Ids to retrieve. Pagination is ignored if * this is set. */ - annotationDataId?: string; + annotationDataId?: string[]; /** * The content version for the requested volume. */ @@ -2995,7 +3233,7 @@ export namespace books_v1 { /** * The volume(s) to release restrictions for. */ - volumeIds?: string; + volumeIds?: string[]; } export interface Params$Resource$Myconfig$Requestaccess extends StandardParameters { @@ -3044,7 +3282,7 @@ export namespace books_v1 { /** * List of features supported by the client, i.e., 'RENTALS' */ - features?: string; + features?: string[]; /** * Set to true to include non-comics series. Defaults to false. */ @@ -3068,7 +3306,7 @@ export namespace books_v1 { /** * The volume(s) to request download restrictions for. */ - volumeIds?: string; + volumeIds?: string[]; } export interface Params$Resource$Myconfig$Updateusersettings extends StandardParameters { @@ -3530,7 +3768,7 @@ export namespace books_v1 { /** * The layer ID(s) to limit annotation by. */ - layerIds?: string; + layerIds?: string[]; /** * Maximum number of results to return */ @@ -3573,7 +3811,7 @@ export namespace books_v1 { /** * Array of layer IDs to get the summary for. */ - layerIds?: string; + layerIds?: string[]; /** * Volume id to get the summary for. */ @@ -4748,7 +4986,7 @@ export namespace books_v1 { /** * List of category ids requested. */ - categoryId?: string; + categoryId?: string[]; /** * ISO-639-1 language and ISO-3166-1 country code. Default is en-US if * unset. @@ -5282,7 +5520,7 @@ export namespace books_v1 { /** * String that identifies the series */ - series_id?: string; + series_id?: string[]; } export class Resource$Series$Membership { @@ -5857,7 +6095,7 @@ export namespace books_v1 { /** * How the book was acquired */ - acquireMethod?: string; + acquireMethod?: string[]; /** * ISO-3166-1 code to override the IP-based location. */ @@ -5875,7 +6113,7 @@ export namespace books_v1 { * The processing state of the user uploaded volumes to be returned. * Applicable only if the UPLOADED is specified in the acquireMethod. */ - processingState?: string; + processingState?: string[]; /** * String to identify the originator of this request. */ @@ -6199,7 +6437,7 @@ export namespace books_v1 { /** * The processing state of the user uploaded volumes to be returned. */ - processingState?: string; + processingState?: string[]; /** * String to identify the originator of this request. */ @@ -6212,6 +6450,6 @@ export namespace books_v1 { * The ids of the volumes to be returned. If not specified all that match * the processingState are returned. */ - volumeId?: string; + volumeId?: string[]; } } diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 9bce6976c11..485b4cb4ec5 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -166,7 +166,7 @@ export namespace calendar_v3 { /** * The scope of the rule. */ - scope?: any; + scope?: {type?: string; value?: string;}; } export interface Schema$Calendar { /** @@ -311,7 +311,7 @@ export namespace calendar_v3 { * The notifications that the authenticated user is receiving for this * calendar. */ - notificationSettings?: any; + notificationSettings?: {notifications?: Schema$CalendarNotification[];}; /** * Whether the calendar is the primary calendar of the authenticated user. * Read-only. Optional. The default is False. @@ -339,10 +339,13 @@ export namespace calendar_v3 { export interface Schema$CalendarNotification { /** * The method used to deliver the notification. Possible values are: - - * "email" - Reminders are sent via email. - "sms" - - * Reminders are sent via SMS. This value is read-only and is ignored on - * inserts and updates. SMS reminders are only available for G Suite - * customers. Required when adding a notification. + * "email" - Notifications are sent via email. - "sms" + * - Deprecated. Once this feature is shutdown, the API will no longer + * return notifications using this method. Any newly added SMS notifications + * will be ignored. See Google Calendar SMS notifications to be removed for + * more information. Notifications are sent via SMS. This value is read-only + * and is ignored on inserts and updates. SMS notifications are only + * available for G Suite customers. Required when adding a notification. */ method?: string; /** @@ -379,7 +382,7 @@ export namespace calendar_v3 { /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: any; + params?: {[key: string]: string;}; /** * A Boolean value to indicate whether payload is wanted. Optional. */ @@ -420,13 +423,13 @@ export namespace calendar_v3 { * definition. A calendarListEntry resource refers to one of these color IDs * in its color field. Read-only. */ - calendar?: any; + calendar?: {[key: string]: Schema$ColorDefinition;}; /** * A global palette of event colors, mapping from the color ID to its * definition. An event resource may refer to one of these color IDs in its * color field. Read-only. */ - event?: any; + event?: {[key: string]: Schema$ColorDefinition;}; /** * Type of the resource ("calendar#colors"). */ @@ -492,7 +495,7 @@ export namespace calendar_v3 { addOnParameters?: Schema$ConferenceParametersAddOnParameters; } export interface Schema$ConferenceParametersAddOnParameters { - parameters?: any; + parameters?: {[key: string]: string;}; } export interface Schema$ConferenceProperties { /** @@ -701,7 +704,8 @@ export namespace calendar_v3 { /** * The creator of the event. Read-only. */ - creator?: any; + creator?: + {displayName?: string; email?: string; id?: string; self?: boolean;}; /** * Description of the event. Optional. */ @@ -724,11 +728,23 @@ export namespace calendar_v3 { /** * Extended properties of the event. */ - extendedProperties?: any; + extendedProperties?: { + private?: {[key: string]: string;}; + shared?: {[key: string]: string;}; + }; /** * A gadget that extends this event. */ - gadget?: any; + gadget?: { + display?: string; + height?: number; + iconLink?: string; + link?: string; + preferences?: {[key: string]: string;}; + title?: string; + type?: string; + width?: number; + }; /** * Whether attendees other than the organizer can invite others to the * event. Optional. The default is True. @@ -801,7 +817,8 @@ export namespace calendar_v3 { * to True. To change the organizer, use the move operation. Read-only, * except when importing an event. */ - organizer?: any; + organizer?: + {displayName?: string; email?: string; id?: string; self?: boolean;}; /** * For an instance of a recurring event, this is the time at which this * event would start according to the recurrence data in the recurring event @@ -832,7 +849,7 @@ export namespace calendar_v3 { /** * Information about the event's reminders for the authenticated user. */ - reminders?: any; + reminders?: {overrides?: Schema$EventReminder[]; useDefault?: boolean;}; /** * Sequence number as per iCalendar. */ @@ -842,7 +859,7 @@ export namespace calendar_v3 { * email message or any document identifiable by an URL with HTTP or HTTPS * scheme. Can only be seen or modified by the creator of the event. */ - source?: any; + source?: {title?: string; url?: string;}; /** * The (inclusive) start time of the event. For a recurring event, this is * the start time of the first instance. @@ -1009,9 +1026,12 @@ export namespace calendar_v3 { /** * The method used by this reminder. Possible values are: - * "email" - Reminders are sent via email. - "sms" - - * Reminders are sent via SMS. These are only available for G Suite - * customers. Requests to set SMS reminders for other account types are - * ignored. - "popup" - Reminders are sent via a UI popup. + * Deprecated. Once this feature is shutdown, the API will no longer return + * reminders using this method. Any newly added SMS reminders will be + * ignored. See Google Calendar SMS notifications to be removed for more + * information. Reminders are sent via SMS. These are only available for G + * Suite customers. Requests to set SMS reminders for other account types + * are ignored. - "popup" - Reminders are sent via a UI popup. * Required when adding a reminder. */ method?: string; @@ -1144,11 +1164,11 @@ export namespace calendar_v3 { /** * List of free/busy information for calendars. */ - calendars?: any; + calendars?: {[key: string]: Schema$FreeBusyCalendar;}; /** * Expansion of groups. */ - groups?: any; + groups?: {[key: string]: Schema$FreeBusyGroup;}; /** * Type of the resource ("calendar#freeBusy"). */ @@ -4292,7 +4312,7 @@ import(paramsOrCallback?: Params$Resource$Events$Import|BodyResponseCallback; /** * A developer-facing error message, which should be in English. Any * user-facing error message should be localized and sent in the @@ -725,7 +725,7 @@ export namespace cloudasset_v1beta1 { * for more info. The request becomes a no-op if the asset name list is * empty, and the max size of the asset name list is 100 in one request. */ - assetNames?: string; + assetNames?: string[]; /** * Required. The content type. */ @@ -1042,7 +1042,7 @@ export namespace cloudasset_v1beta1 { * for more info. The request becomes a no-op if the asset name list is * empty, and the max size of the asset name list is 100 in one request. */ - assetNames?: string; + assetNames?: string[]; /** * Required. The content type. */ diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index e6fb70bfbda..fc7913203d6 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -280,7 +280,7 @@ export namespace cloudbuild_v1 { /** * Substitutions data for `Build` resource. */ - substitutions?: any; + substitutions?: {[key: string]: string;}; /** * Tags for annotation of a `Build`. These are not docker tags. */ @@ -297,7 +297,7 @@ export namespace cloudbuild_v1 { * all specified images. * FETCHSOURCE: time to fetch source. If the build * does not specify source or images, these keys will not be included. */ - timing?: any; + timing?: {[key: string]: Schema$TimeSpan;}; } /** * Metadata for build operations. @@ -531,7 +531,7 @@ export namespace cloudbuild_v1 { /** * Substitutions data for Build resource. */ - substitutions?: any; + substitutions?: {[key: string]: string;}; /** * Template describing the types of source changes to trigger a build. * Branch and tag names in trigger templates are interpreted as regular @@ -653,7 +653,7 @@ export namespace cloudbuild_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -669,7 +669,7 @@ export namespace cloudbuild_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Location of the source in a Google Cloud Source Repository. @@ -755,7 +755,7 @@ export namespace cloudbuild_v1 { * in size. There can be at most 100 secret values across all of a * build's secrets. */ - secretEnv?: any; + secretEnv?: {[key: string]: string;}; } /** * Location of the source in a supported storage service. @@ -785,7 +785,7 @@ export namespace cloudbuild_v1 { * the build source came in a single package such as a gzipped tarfile * (`.tar.gz`), the `FileHash` will be for the single path to that file. */ - fileHashes?: any; + fileHashes?: {[key: string]: Schema$FileHashes;}; /** * A copy of the build's `source.repo_source`, if exists, with any * revisions resolved. @@ -842,7 +842,7 @@ export namespace cloudbuild_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index d6d68bf5c58..2efb7a2349d 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -184,7 +184,7 @@ export namespace clouddebugger_v2 { * A set of custom breakpoint properties, populated by the agent, to be * displayed to the user. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Breakpoint source location. */ @@ -330,7 +330,7 @@ export namespace clouddebugger_v2 { * A set of custom debuggee properties, populated by the agent, to be * displayed to the user. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Project the debuggee is associated with. Use project number or id when * registering a Google Cloud Platform project. @@ -348,10 +348,10 @@ export namespace clouddebugger_v2 { */ status?: Schema$StatusMessage; /** - * Uniquifier to further distiguish the application. It is possible that + * Uniquifier to further distinguish the application. It is possible that * different applications might have identical values in the debuggee * message, thus, incorrectly identified as a single application by the - * Controller service. This field adds salt to further distiguish the + * Controller service. This field adds salt to further distinguish the * application. Agents should consider seeding this field with value that * identifies the code, binary, configuration and environment. */ @@ -377,7 +377,7 @@ export namespace clouddebugger_v2 { /** * Labels with user defined metadata. */ - labels?: any; + labels?: {[key: string]: string;}; } /** * Represents a message with parameters. @@ -527,7 +527,7 @@ export namespace clouddebugger_v2 { */ export interface Schema$RegisterDebuggeeResponse { /** - * Debuggee resource. The field `id` is guranteed to be set (in addition to + * Debuggee resource. The field `id` is guaranteed to be set (in addition to * the echoed fields). If the field `is_disabled` is set to `true`, the * agent should disable itself by removing all breakpoints and detaching * from the application. It should however continue to poll diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index 281712a7a9f..a7a0b1f9b51 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -1108,7 +1108,7 @@ export namespace clouderrorreporting_v1beta1 { /** * [Optional] List all ErrorGroupStats with these IDs. */ - groupId?: string; + groupId?: string[]; /** * [Optional] The sort order in which the results are returned. Default is * `COUNT_DESC`. diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 0f406323548..ef92e0bc1dd 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -257,10 +257,9 @@ export namespace cloudfunctions_v1 { */ entryPoint?: string; /** - * **Beta Feature** Environment variables that shall be available during - * function execution. + * Environment variables that shall be available during function execution. */ - environmentVariables?: any; + environmentVariables?: {[key: string]: string;}; /** * A source that fires events in response to a condition in another service. */ @@ -272,7 +271,7 @@ export namespace cloudfunctions_v1 { /** * Labels associated with this Cloud Function. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The limit on the maximum number of function instances that may coexist at * a given time. This feature is currently in alpha, available only for @@ -535,7 +534,7 @@ export namespace cloudfunctions_v1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -544,7 +543,7 @@ export namespace cloudfunctions_v1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -572,7 +571,7 @@ export namespace cloudfunctions_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -588,7 +587,7 @@ export namespace cloudfunctions_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata describing an Operation @@ -597,7 +596,7 @@ export namespace cloudfunctions_v1 { /** * The original request that started the operation. */ - request?: any; + request?: {[key: string]: any;}; /** * Target of the operation - for example * projects/project-1/locations/region-1/functions/function-1 @@ -613,7 +612,7 @@ export namespace cloudfunctions_v1 { updateTime?: string; /** * Version id of the function created or updated by an API call. This field - * is only pupulated for Create and Update operations. + * is only populated for Create and Update operations. */ versionId?: string; } @@ -624,7 +623,7 @@ export namespace cloudfunctions_v1 { /** * The original request that started the operation. */ - request?: any; + request?: {[key: string]: any;}; /** * Target of the operation - for example * projects/project-1/locations/region-1/functions/function-1 @@ -640,7 +639,7 @@ export namespace cloudfunctions_v1 { updateTime?: string; /** * Version id of the function created or updated by an API call. This field - * is only pupulated for Create and Update operations. + * is only populated for Create and Update operations. */ versionId?: string; } @@ -787,7 +786,7 @@ export namespace cloudfunctions_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudfunctions/v1beta2.ts b/src/apis/cloudfunctions/v1beta2.ts index f83c8c64d38..92b8ef25726 100644 --- a/src/apis/cloudfunctions/v1beta2.ts +++ b/src/apis/cloudfunctions/v1beta2.ts @@ -164,10 +164,9 @@ export namespace cloudfunctions_v1beta2 { */ entryPoint?: string; /** - * **Beta Feature** Environment variables that shall be available during - * function execution. + * Environment variables that shall be available during function execution. */ - environmentVariables?: any; + environmentVariables?: {[key: string]: string;}; /** * A source that fires events in response to a condition in another service. */ @@ -179,7 +178,7 @@ export namespace cloudfunctions_v1beta2 { /** * Labels associated with this Cloud Function. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. Name of the most recent operation modifying the function. If * the function status is `DEPLOYING` or `DELETING`, then it points to the @@ -423,7 +422,7 @@ export namespace cloudfunctions_v1beta2 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -432,7 +431,7 @@ export namespace cloudfunctions_v1beta2 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -460,7 +459,7 @@ export namespace cloudfunctions_v1beta2 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -476,7 +475,7 @@ export namespace cloudfunctions_v1beta2 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata describing an Operation @@ -485,7 +484,7 @@ export namespace cloudfunctions_v1beta2 { /** * The original request that started the operation. */ - request?: any; + request?: {[key: string]: any;}; /** * Target of the operation - for example * projects/project-1/locations/region-1/functions/function-1 @@ -501,7 +500,7 @@ export namespace cloudfunctions_v1beta2 { updateTime?: string; /** * Version id of the function created or updated by an API call. This field - * is only pupulated for Create and Update operations. + * is only populated for Create and Update operations. */ versionId?: string; } @@ -512,7 +511,7 @@ export namespace cloudfunctions_v1beta2 { /** * The original request that started the operation. */ - request?: any; + request?: {[key: string]: any;}; /** * Target of the operation - for example * projects/project-1/locations/region-1/functions/function-1 @@ -528,7 +527,7 @@ export namespace cloudfunctions_v1beta2 { updateTime?: string; /** * Version id of the function created or updated by an API call. This field - * is only pupulated for Create and Update operations. + * is only populated for Create and Update operations. */ versionId?: string; } @@ -624,7 +623,7 @@ export namespace cloudfunctions_v1beta2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index 1717f89964c..cdba9ddafab 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -116,6 +116,26 @@ export namespace cloudiot_v1 { } } + /** + * Request for `BindDeviceToGateway`. + */ + export interface Schema$BindDeviceToGatewayRequest { + /** + * The device to associate with the specified gateway. The value of + * `device_id` can be either the device numeric ID or the user-defined + * device identifier. + */ + deviceId?: string; + /** + * The value of `gateway_id` can be either the device numeric ID or the + * user-defined device identifier. + */ + gatewayId?: string; + } + /** + * Response for `BindDeviceToGateway`. + */ + export interface Schema$BindDeviceToGatewayResponse {} /** * Associates `members` with a `role`. */ @@ -176,6 +196,10 @@ export namespace cloudiot_v1 { * description of the `DeviceRegistry.credentials` field. */ credentials?: Schema$DeviceCredential[]; + /** + * Gateway-related configuration and state. + */ + gatewayConfig?: Schema$GatewayConfig; /** * The user-defined device identifier. The device ID must be unique within a * device registry. @@ -240,7 +264,7 @@ export namespace cloudiot_v1 { * size. The total size of all keys and values must be less than 256 KB, * and the maximum number of key-value pairs is 500. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * The resource path name. For example, * `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or @@ -448,6 +472,29 @@ export namespace cloudiot_v1 { */ title?: string; } + /** + * Gateway-related configuration and state. + */ + export interface Schema$GatewayConfig { + /** + * Indicates how to authorize and/or authenticate devices to access the + * gateway. + */ + gatewayAuthMethod?: string; + /** + * Indicates whether the device is a gateway. + */ + gatewayType?: string; + /** + * [Output only] The ID of the gateway the device accessed most recently. + */ + lastAccessedGatewayId?: string; + /** + * [Output only] The most recent time at which the device accessed the + * gateway specified in `last_accessed_gateway`. + */ + lastAccessedGatewayTime?: string; + } /** * Request message for `GetIamPolicy` method. */ @@ -709,7 +756,7 @@ export namespace cloudiot_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -739,6 +786,26 @@ export namespace cloudiot_v1 { */ permissions?: string[]; } + /** + * Request for `UnbindDeviceFromGateway`. + */ + export interface Schema$UnbindDeviceFromGatewayRequest { + /** + * The device to disassociate from the specified gateway. The value of + * `device_id` can be either the device numeric ID or the user-defined + * device identifier. + */ + deviceId?: string; + /** + * The value of `gateway_id` can be either the device numeric ID or the + * user-defined device identifier. + */ + gatewayId?: string; + } + /** + * Response for `UnbindDeviceFromGateway`. + */ + export interface Schema$UnbindDeviceFromGatewayResponse {} /** * Details of an X.509 certificate. For informational purposes only. */ @@ -816,6 +883,86 @@ export namespace cloudiot_v1 { } + /** + * cloudiot.projects.locations.registries.bindDeviceToGateway + * @desc Associates the device with the gateway. + * @alias cloudiot.projects.locations.registries.bindDeviceToGateway + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {().BindDeviceToGatewayRequest} 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 + */ + bindDeviceToGateway( + params?: + Params$Resource$Projects$Locations$Registries$Binddevicetogateway, + options?: MethodOptions): + AxiosPromise; + bindDeviceToGateway( + params: + Params$Resource$Projects$Locations$Registries$Binddevicetogateway, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + bindDeviceToGateway( + params: + Params$Resource$Projects$Locations$Registries$Binddevicetogateway, + callback: BodyResponseCallback): + void; + bindDeviceToGateway( + callback: BodyResponseCallback): + void; + bindDeviceToGateway( + paramsOrCallback?: + Params$Resource$Projects$Locations$Registries$Binddevicetogateway| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Registries$Binddevicetogateway; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Registries$Binddevicetogateway; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:bindDeviceToGateway') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * cloudiot.projects.locations.registries.create * @desc Creates a device registry that contains devices. @@ -1375,8 +1522,108 @@ export namespace cloudiot_v1 { return createAPIRequest(parameters); } } + + + /** + * cloudiot.projects.locations.registries.unbindDeviceFromGateway + * @desc Deletes the association between the device and the gateway. + * @alias cloudiot.projects.locations.registries.unbindDeviceFromGateway + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {().UnbindDeviceFromGatewayRequest} 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 + */ + unbindDeviceFromGateway( + params?: + Params$Resource$Projects$Locations$Registries$Unbinddevicefromgateway, + options?: MethodOptions): + AxiosPromise; + unbindDeviceFromGateway( + params: + Params$Resource$Projects$Locations$Registries$Unbinddevicefromgateway, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + unbindDeviceFromGateway( + params: + Params$Resource$Projects$Locations$Registries$Unbinddevicefromgateway, + callback: BodyResponseCallback): + void; + unbindDeviceFromGateway( + callback: BodyResponseCallback): + void; + unbindDeviceFromGateway( + paramsOrCallback?: + Params$Resource$Projects$Locations$Registries$Unbinddevicefromgateway| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Registries$Unbinddevicefromgateway; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Registries$Unbinddevicefromgateway; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:unbindDeviceFromGateway') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } } + export interface Params$Resource$Projects$Locations$Registries$Binddevicetogateway + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the registry. For example, + * `projects/example-project/locations/us-central1/registries/my-registry`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BindDeviceToGatewayRequest; + } export interface Params$Resource$Projects$Locations$Registries$Create extends StandardParameters { /** @@ -1527,6 +1774,24 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } + export interface Params$Resource$Projects$Locations$Registries$Unbinddevicefromgateway + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the registry. For example, + * `projects/example-project/locations/us-central1/registries/my-registry`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UnbindDeviceFromGatewayRequest; + } export class Resource$Projects$Locations$Registries$Devices { root: Cloudiot; @@ -1758,6 +2023,9 @@ export namespace cloudiot_v1 { * @param {string=} params.deviceIds A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000 * @param {string=} params.deviceNumIds A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000. * @param {string=} params.fieldMask The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified. + * @param {string=} params.gatewayListOptions.associationsDeviceId If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound. + * @param {string=} params.gatewayListOptions.associationsGatewayId If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned. + * @param {string=} params.gatewayListOptions.gatewayType If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. * @param {integer=} params.pageSize The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. * @param {string=} params.pageToken The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data. * @param {string} params.parent The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. @@ -2125,18 +2393,38 @@ export namespace cloudiot_v1 { * A list of device string IDs. For example, `['device0', 'device12']`. If * empty, this field is ignored. Maximum IDs: 10,000 */ - deviceIds?: string; + deviceIds?: string[]; /** * A list of device numeric IDs. If empty, this field is ignored. Maximum * IDs: 10,000. */ - deviceNumIds?: string; + deviceNumIds?: string[]; /** * The fields of the `Device` resource to be returned in the response. The * fields `id` and `num_id` are always returned, along with any other fields * specified. */ fieldMask?: string; + /** + * If set, returns only the gateways with which the specified device is + * associated. The device ID can be numeric (`num_id`) or the user-defined + * string (`id`). For example, if `456` is specified, returns only the + * gateways to which the device with `num_id` 456 is bound. + */ + 'gatewayListOptions.associationsDeviceId'?: string; + /** + * If set, only devices associated with the specified gateway are returned. + * The gateway ID can be numeric (`num_id`) or the user-defined string + * (`id`). For example, if `123` is specified, only devices bound to the + * gateway with `num_id` 123 are returned. + */ + 'gatewayListOptions.associationsGatewayId'?: string; + /** + * If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` + * is specified, only non-gateway devices are returned. If + * `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. + */ + 'gatewayListOptions.gatewayType'?: string; /** * The maximum number of devices to return in the response. If this value is * zero, the service will select a default size. A call may return fewer @@ -2471,6 +2759,86 @@ export namespace cloudiot_v1 { } + /** + * cloudiot.projects.locations.registries.groups.bindDeviceToGateway + * @desc Associates the device with the gateway. + * @alias cloudiot.projects.locations.registries.groups.bindDeviceToGateway + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {().BindDeviceToGatewayRequest} 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 + */ + bindDeviceToGateway( + params?: + Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway, + options?: MethodOptions): + AxiosPromise; + bindDeviceToGateway( + params: + Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + bindDeviceToGateway( + params: + Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway, + callback: BodyResponseCallback): + void; + bindDeviceToGateway( + callback: BodyResponseCallback): + void; + bindDeviceToGateway( + paramsOrCallback?: + Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:bindDeviceToGateway') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * cloudiot.projects.locations.registries.groups.getIamPolicy * @desc Gets the access control policy for a resource. Returns an empty @@ -2697,8 +3065,109 @@ export namespace cloudiot_v1 { return createAPIRequest(parameters); } } + + + /** + * cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway + * @desc Deletes the association between the device and the gateway. + * @alias + * cloudiot.projects.locations.registries.groups.unbindDeviceFromGateway + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The name of the registry. For example, `projects/example-project/locations/us-central1/registries/my-registry`. + * @param {().UnbindDeviceFromGatewayRequest} 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 + */ + unbindDeviceFromGateway( + params?: + Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway, + options?: MethodOptions): + AxiosPromise; + unbindDeviceFromGateway( + params: + Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + unbindDeviceFromGateway( + params: + Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway, + callback: BodyResponseCallback): + void; + unbindDeviceFromGateway( + callback: BodyResponseCallback): + void; + unbindDeviceFromGateway( + paramsOrCallback?: + Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudiot.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:unbindDeviceFromGateway') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } } + export interface Params$Resource$Projects$Locations$Registries$Groups$Binddevicetogateway + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the registry. For example, + * `projects/example-project/locations/us-central1/registries/my-registry`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BindDeviceToGatewayRequest; + } export interface Params$Resource$Projects$Locations$Registries$Groups$Getiampolicy extends StandardParameters { /** @@ -2753,6 +3222,24 @@ export namespace cloudiot_v1 { */ requestBody?: Schema$TestIamPermissionsRequest; } + export interface Params$Resource$Projects$Locations$Registries$Groups$Unbinddevicefromgateway + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the registry. For example, + * `projects/example-project/locations/us-central1/registries/my-registry`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UnbindDeviceFromGatewayRequest; + } export class Resource$Projects$Locations$Registries$Groups$Devices { root: Cloudiot; @@ -2852,6 +3339,9 @@ export namespace cloudiot_v1 { * @param {string=} params.deviceIds A list of device string IDs. For example, `['device0', 'device12']`. If empty, this field is ignored. Maximum IDs: 10,000 * @param {string=} params.deviceNumIds A list of device numeric IDs. If empty, this field is ignored. Maximum IDs: 10,000. * @param {string=} params.fieldMask The fields of the `Device` resource to be returned in the response. The fields `id` and `num_id` are always returned, along with any other fields specified. + * @param {string=} params.gatewayListOptions.associationsDeviceId If set, returns only the gateways with which the specified device is associated. The device ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `456` is specified, returns only the gateways to which the device with `num_id` 456 is bound. + * @param {string=} params.gatewayListOptions.associationsGatewayId If set, only devices associated with the specified gateway are returned. The gateway ID can be numeric (`num_id`) or the user-defined string (`id`). For example, if `123` is specified, only devices bound to the gateway with `num_id` 123 are returned. + * @param {string=} params.gatewayListOptions.gatewayType If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` is specified, only non-gateway devices are returned. If `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. * @param {integer=} params.pageSize The maximum number of devices to return in the response. If this value is zero, the service will select a default size. A call may return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available. * @param {string=} params.pageToken The value returned by the last `ListDevicesResponse`; indicates that this is a continuation of a prior `ListDevices` call and the system should return the next page of data. * @param {string} params.parent The device registry path. Required. For example, `projects/my-project/locations/us-central1/registries/my-registry`. @@ -3192,18 +3682,38 @@ export namespace cloudiot_v1 { * A list of device string IDs. For example, `['device0', 'device12']`. If * empty, this field is ignored. Maximum IDs: 10,000 */ - deviceIds?: string; + deviceIds?: string[]; /** * A list of device numeric IDs. If empty, this field is ignored. Maximum * IDs: 10,000. */ - deviceNumIds?: string; + deviceNumIds?: string[]; /** * The fields of the `Device` resource to be returned in the response. The * fields `id` and `num_id` are always returned, along with any other fields * specified. */ fieldMask?: string; + /** + * If set, returns only the gateways with which the specified device is + * associated. The device ID can be numeric (`num_id`) or the user-defined + * string (`id`). For example, if `456` is specified, returns only the + * gateways to which the device with `num_id` 456 is bound. + */ + 'gatewayListOptions.associationsDeviceId'?: string; + /** + * If set, only devices associated with the specified gateway are returned. + * The gateway ID can be numeric (`num_id`) or the user-defined string + * (`id`). For example, if `123` is specified, only devices bound to the + * gateway with `num_id` 123 are returned. + */ + 'gatewayListOptions.associationsGatewayId'?: string; + /** + * If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY` + * is specified, only non-gateway devices are returned. If + * `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned. + */ + 'gatewayListOptions.gatewayType'?: string; /** * The maximum number of devices to return in the response. If this value is * zero, the service will select a default size. A call may return fewer diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 8482412513d..75cf4199cda 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -257,7 +257,7 @@ export namespace cloudkms_v1 { * Labels with user-defined metadata. For more information, see [Labeling * Keys](/kms/docs/labeling-keys). */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The resource name for this CryptoKey in the format * `projects/x/locations/x/keyRings/x/cryptoKeys/x. @@ -591,7 +591,7 @@ export namespace cloudkms_v1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -600,7 +600,7 @@ export namespace cloudkms_v1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` diff --git a/src/apis/cloudprofiler/v2.ts b/src/apis/cloudprofiler/v2.ts index 018d2a42768..2dc1b9507bf 100644 --- a/src/apis/cloudprofiler/v2.ts +++ b/src/apis/cloudprofiler/v2.ts @@ -149,7 +149,7 @@ export namespace cloudprofiler_v2 { * a zone is "us-central1-a", an example of a region is * "us-central1" or "us-central". */ - labels?: any; + labels?: {[key: string]: string;}; /** * Project ID is the ID of a cloud project. Validation regex: * `^a-z{4,61}[a-z0-9]$`. @@ -185,7 +185,7 @@ export namespace cloudprofiler_v2 { * get merged with the deployment labels for the final data set. See * documentation on deployment labels for validation rules and limits. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. Opaque, server-assigned, unique ID for this profile. */ diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 595b758fe02..8cd159ec7e1 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -723,7 +723,7 @@ export namespace cloudresourcemanager_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -739,7 +739,7 @@ export namespace cloudresourcemanager_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The root node in the resource hierarchy to which a particular entity's @@ -906,7 +906,7 @@ export namespace cloudresourcemanager_v1 { * <code>"environment" : "dev"</code> * Read-write. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The Project lifecycle state. Read-only. */ @@ -1109,7 +1109,7 @@ export namespace cloudresourcemanager_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index cf9f8224d41..2dd6105df0d 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -467,7 +467,7 @@ export namespace cloudresourcemanager_v1beta1 { * <code>"environment" : "dev"</code> * Read-write. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The Project lifecycle state. Read-only. */ diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 0fcfc953baa..dad76394bf6 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -353,7 +353,7 @@ export namespace cloudresourcemanager_v2 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -369,7 +369,7 @@ export namespace cloudresourcemanager_v2 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Defines an Identity and Access Management (IAM) policy. It is used to @@ -551,7 +551,7 @@ export namespace cloudresourcemanager_v2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index df3778ac130..e179593d6a0 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -353,7 +353,7 @@ export namespace cloudresourcemanager_v2beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -369,7 +369,7 @@ export namespace cloudresourcemanager_v2beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Defines an Identity and Access Management (IAM) policy. It is used to @@ -551,7 +551,7 @@ export namespace cloudresourcemanager_v2beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/partners/README.md b/src/apis/cloudscheduler/README.md similarity index 87% rename from src/apis/partners/README.md rename to src/apis/cloudscheduler/README.md index 41e0df7ecf2..4abecafdda1 100644 --- a/src/apis/partners/README.md +++ b/src/apis/cloudscheduler/README.md @@ -1,13 +1,13 @@ Google Inc. logo -# @google/partners +# @google/cloudscheduler -> Searches certified companies and creates contact leads with them, and also audits the usage of clients. +> Creates and manages jobs run on a regular recurring schedule. ## Installation ```sh -$ npm install @google/partners +$ npm install @google/cloudscheduler ``` ## Usage diff --git a/src/apis/cloudscheduler/index.ts b/src/apis/cloudscheduler/index.ts new file mode 100644 index 00000000000..c81c3225193 --- /dev/null +++ b/src/apis/cloudscheduler/index.ts @@ -0,0 +1,31 @@ +// Copyright 2018, 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 {getAPI, GoogleConfigurable} from 'googleapis-common'; +import {cloudscheduler_v1beta1} from './v1beta1'; + +export const VERSIONS = { + 'v1beta1': cloudscheduler_v1beta1.Cloudscheduler, +}; + +export function cloudscheduler(version: 'v1beta1'): + cloudscheduler_v1beta1.Cloudscheduler; +export function cloudscheduler(options: cloudscheduler_v1beta1.Options): + cloudscheduler_v1beta1.Cloudscheduler; +export function cloudscheduler( + this: GoogleConfigurable, + versionOrOptions: 'v1beta1'|cloudscheduler_v1beta1.Options) { + return getAPI('cloudscheduler', versionOrOptions, VERSIONS, this); +} diff --git a/src/apis/cloudscheduler/package.json b/src/apis/cloudscheduler/package.json new file mode 100644 index 00000000000..36c4b5f42c1 --- /dev/null +++ b/src/apis/cloudscheduler/package.json @@ -0,0 +1,24 @@ +{ + "name": "@google/cloudscheduler", + "version": "0.1.0", + "description": "cloudscheduler", + "main": "index.js", + "types": "index.d.ts", + "keywords": ["google"], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/google/google-api-nodejs-client", + "bugs": { + "url" : "https://github.com/google/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url" : "https://github.com/google/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=6.0.0" + }, + "dependencies": { + "googleapis-common": "^0.4.0" + } +} diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts new file mode 100644 index 00000000000..cfb1eeaca4d --- /dev/null +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -0,0 +1,1532 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * 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 {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {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 cloudscheduler_v1beta1 { + export interface Options extends GlobalOptions { + version: 'v1beta1'; + } + + 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 Scheduler API + * + * Creates and manages jobs run on a regular recurring schedule. + * + * @example + * const {google} = require('googleapis'); + * const cloudscheduler = google.cloudscheduler('v1beta1'); + * + * @namespace cloudscheduler + * @type {Function} + * @version v1beta1 + * @variation v1beta1 + * @param {object=} options Options for Cloudscheduler + */ + export class Cloudscheduler { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.projects = new Resource$Projects(this); + } + + getRoot() { + return this.root; + } + } + + /** + * App Engine target. The job will be pushed to a job handler by means of an + * HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job + * is acknowledged by means of an HTTP response code in the range [200 - 299]. + * Error 503 is considered an App Engine system error instead of an + * application error. Requests returning error 503 will be retried regardless + * of retry configuration and not counted against retry counts. Any other + * response code, or a failure to receive a response before the deadline, + * constitutes a failed attempt. + */ + export interface Schema$AppEngineHttpTarget { + /** + * App Engine Routing setting for the job. + */ + appEngineRouting?: Schema$AppEngineRouting; + /** + * Body. HTTP request body. A request body is allowed only if the HTTP + * method is POST or PUT. It will result in invalid argument error to set a + * body on a job with an incompatible HttpMethod. + */ + body?: string; + /** + * HTTP request headers. This map contains the header field names and + * values. Headers can be set when the job is created. Cloud Scheduler sets + * some headers to default values: * `User-Agent`: By default, this header + * is `"AppEngine-Google; (+http://code.google.com/appengine)"`. + * This header can be modified, but Cloud Scheduler will append + * `"AppEngine-Google; (+http://code.google.com/appengine)"` to + * the modified `User-Agent`. If the job has an body, Cloud Scheduler + * sets the following headers: * `Content-Type`: By default, the + * `Content-Type` header is set to `"application/octet-stream"`. + * The default can be overridden by explictly setting `Content-Type` to a + * particular media type when the job is created. For example, + * `Content-Type` can be set to `"application/json"`. * + * `Content-Length`: This is computed by Cloud Scheduler. This value is + * output only. It cannot be changed. The headers below are output only. + * They cannot be set or overridden: * `X-Google-*`: For Google internal + * use only. * `X-AppEngine-*`: For Google internal use only. See [Reading + * request + * headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). + * In addition, some App Engine headers, which contain job-specific + * information, are also be sent to the job handler; see [request + * headers](https://cloud.google.comappengine/docs/standard/python/config/cron#securing_urls_for_cron). + */ + headers?: {[key: string]: string;}; + /** + * The HTTP method to use for the request. PATCH and OPTIONS are not + * permitted. + */ + httpMethod?: string; + /** + * The relative URI. The relative URL must begin with "/" and + * must be a valid HTTP relative URL. It can contain a path, query string + * arguments, and `#` fragments. If the relative URL is empty, then the root + * path "/" will be used. No spaces are allowed, and the maximum + * length allowed is 2083 characters. + */ + relativeUri?: string; + } + /** + * App Engine Routing. For more information about services, versions, and + * instances see [An Overview of App + * Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), + * [Microservices Architecture on Google App + * Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), + * [App Engine Standard request + * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), + * and [App Engine Flex request + * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + */ + export interface Schema$AppEngineRouting { + /** + * Output only. The host that the job is sent to. For more information + * about how App Engine requests are routed, see + * [here](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). + * The host is constructed as: * `host = + * [application_domain_name]`</br> `| [service] + '.' + + * [application_domain_name]`</br> `| [version] + '.' + + * [application_domain_name]`</br> `| [version_dot_service]+ + * '.' + [application_domain_name]`</br> `| [instance] + + * '.' + [application_domain_name]`</br> `| + * [instance_dot_service] + '.' + + * [application_domain_name]`</br> `| [instance_dot_version] + + * '.' + [application_domain_name]`</br> `| + * [instance_dot_version_dot_service] + '.' + + * [application_domain_name]` * `application_domain_name` = The domain name + * of the app, for example <app-id>.appspot.com, which is associated + * with the job's project ID. * `service =` service * `version =` + * version * `version_dot_service =` version `+ '.' +` service + * * `instance =` instance * `instance_dot_service =` instance `+ + * '.' +` service * `instance_dot_version =` instance `+ + * '.' +` version * `instance_dot_version_dot_service =` instance + * `+ '.' +` version `+ '.' +` service If service is + * empty, then the job will be sent to the service which is the default + * service when the job is attempted. If version is empty, then the job + * will be sent to the version which is the default version when the job is + * attempted. If instance is empty, then the job will be sent to an + * instance which is available when the job is attempted. If service, + * version, or instance is invalid, then the job will be sent to the default + * version of the default service when the job is attempted. + */ + host?: string; + /** + * App instance. By default, the job is sent to an instance which is + * available when the job is attempted. Requests can only be sent to a + * specific instance if [manual scaling is used in App Engine + * Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + * App Engine Flex does not support instances. For more information, see + * [App Engine Standard request + * routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) + * and [App Engine Flex request + * routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + */ + instance?: string; + /** + * App service. By default, the job is sent to the service which is the + * default service when the job is attempted. + */ + service?: string; + /** + * App version. By default, the job is sent to the version which is the + * default version when the job is attempted. + */ + version?: string; + } + /** + * 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 {} + /** + * Http target. The job will be pushed to the job handler by means of an HTTP + * request via an http_method such as HTTP POST, HTTP GET, etc. The job is + * acknowledged by means of an HTTP response code in the range [200 - 299]. A + * failure to receive a response constitutes a failed execution. For a + * redirected request, the response returned by the redirected request is + * considered. + */ + export interface Schema$HttpTarget { + /** + * HTTP request body. A request body is allowed only if the HTTP method is + * POST, PUT, or PATCH. It is an error to set body on a job with an + * incompatible HttpMethod. + */ + body?: string; + /** + * The user can specify HTTP request headers to send with the job's HTTP + * request. This map contains the header field names and values. Repeated + * headers are not supported, but a header value can contain commas. These + * headers represent a subset of the headers that will accompany the + * job's HTTP request. Some HTTP request headers will be ignored or + * replaced. A partial list of headers that will be ignored or replaced is + * below: - Host: This will be computed by Cloud Scheduler and derived from + * uri. * `Content-Length`: This will be computed by Cloud Scheduler. * + * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * + * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google + * internal use only. The total size of headers must be less than 80KB. + */ + headers?: {[key: string]: string;}; + /** + * Which HTTP method to use for the request. + */ + httpMethod?: string; + /** + * Required. The full URI path that the request will be sent to. This + * string must begin with either "http://" or + * "https://". Some examples of valid values for uri are: + * `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will + * encode some characters for safety and compatibility. The maximum allowed + * URL length is 2083 characters after encoding. + */ + uri?: string; + } + /** + * Configuration for a job. The maximum allowed size for a job is 100KB. + */ + export interface Schema$Job { + /** + * App Engine HTTP target. + */ + appEngineHttpTarget?: Schema$AppEngineHttpTarget; + /** + * A human-readable description for the job. This string must not contain + * more than 500 characters. + */ + description?: string; + /** + * HTTP target. + */ + httpTarget?: Schema$HttpTarget; + /** + * Output only. The time the last job attempt started. + */ + lastAttemptTime?: string; + /** + * The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` + * can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons + * (:), or periods (.). For more information, see [Identifying + * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) + * * `LOCATION_ID` is the canonical ID for the job's location. The + * list of available locations can be obtained by calling ListLocations. + * For more information, see https://cloud.google.com/about/locations/. * + * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens + * (-), or underscores (_). The maximum length is 500 characters. + */ + name?: string; + /** + * Pub/Sub target. + */ + pubsubTarget?: Schema$PubsubTarget; + /** + * Settings that determine the retry behavior. + */ + retryConfig?: Schema$RetryConfig; + /** + * Required. Describes the schedule on which the job will be executed. As + * a general rule, execution `n + 1` of a job will not begin until execution + * `n` has finished. Cloud Scheduler will never allow two simultaneously + * outstanding executions. For example, this implies that if the `n+1`th + * execution is scheduled to run at 16:00 but the `n`th execution takes + * until 16:15, the `n+1`th execution will not start until `16:15`. A + * scheduled start time will be delayed if the previous execution has not + * ended when its scheduled time occurs. If retry_count > 0 and a job + * attempt fails, the job will be tried a total of retry_count times, with + * exponential backoff, until the next scheduled start time. The schedule + * can be either of the following types: * + * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like + * [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) + */ + schedule?: string; + /** + * Output only. The next time the job is scheduled. Note that this may be a + * retry of a previously failed attempt or the next execution time according + * to the schedule. + */ + scheduleTime?: string; + /** + * Output only. State of the job. + */ + state?: string; + /** + * Output only. The response from the target for the last attempted + * execution. + */ + status?: Schema$Status; + /** + * Specifies the time zone to be used in interpreting schedule. The value of + * this field must be a time zone name from the [tz + * database](http://en.wikipedia.org/wiki/Tz_database). Note that some time + * zones include a provision for daylight savings time. The rules for + * daylight saving time are determined by the chosen tz. For UTC use the + * string "utc". If a time zone is not specified, the default will + * be in UTC (also known as GMT). + */ + timeZone?: string; + /** + * Output only. The creation time of the job. + */ + userUpdateTime?: string; + } + /** + * Response message for listing jobs using ListJobs. + */ + export interface Schema$ListJobsResponse { + /** + * The list of jobs. + */ + jobs?: Schema$Job[]; + /** + * A token to retrieve next page of results. Pass this value in the + * page_token field in the subsequent call to ListJobs to retrieve the next + * page of results. If this is empty it indicates that there are no more + * results through which to paginate. The page token is valid for only 2 + * hours. + */ + 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; + } + /** + * 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; + } + /** + * Request message for PauseJob. + */ + export interface Schema$PauseJobRequest {} + /** + * A message that is published by publishers and consumed by subscribers. The + * message must contain either a non-empty data field or at least one + * attribute. Note that client libraries represent this object differently + * depending on the language. See the corresponding <a + * href="https://cloud.google.com/pubsub/docs/reference/libraries">client + * library documentation</a> for more information. See <a + * href="https://cloud.google.com/pubsub/quotas">Quotas and + * limits</a> for more information about message limits. + */ + export interface Schema$PubsubMessage { + /** + * Optional attributes for this message. + */ + attributes?: {[key: string]: string;}; + /** + * The message data field. If this field is empty, the message must contain + * at least one attribute. + */ + data?: string; + /** + * ID of this message, assigned by the server when the message is published. + * Guaranteed to be unique within the topic. This value may be read by a + * subscriber that receives a `PubsubMessage` via a `Pull` call or a push + * delivery. It must not be populated by the publisher in a `Publish` call. + */ + messageId?: string; + /** + * The time at which the message was published, populated by the server when + * it receives the `Publish` call. It must not be populated by the publisher + * in a `Publish` call. + */ + publishTime?: string; + } + /** + * Pub/Sub target. The job will be delivered by publishing a message to the + * given Pub/Sub topic. + */ + export interface Schema$PubsubTarget { + /** + * Attributes for PubsubMessage. Pubsub message must contain either + * non-empty data, or at least one attribute. + */ + attributes?: {[key: string]: string;}; + /** + * The message payload for PubsubMessage. Pubsub message must contain + * either non-empty data, or at least one attribute. + */ + data?: string; + /** + * Required. The name of the Cloud Pub/Sub topic to which messages will be + * published when a job is delivered. The topic name must be in the same + * format as required by PubSub's + * [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), + * for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in + * the same project as the Cloud Scheduler job. + */ + topicName?: string; + } + /** + * Request message for ResumeJob. + */ + export interface Schema$ResumeJobRequest {} + /** + * Settings that determine the retry behavior. By default, if a job does not + * complete successfully (meaning that an acknowledgement is not received from + * the handler, then it will be retried with exponential backoff according to + * the settings in RetryConfig. + */ + export interface Schema$RetryConfig { + /** + * The maximum amount of time to wait before retrying a job after it fails. + * The default value of this field is 1 hour. + */ + maxBackoffDuration?: string; + /** + * The time between retries will double `max_doublings` times. A job's + * retry interval starts at min_backoff_duration, then doubles + * `max_doublings` times, then increases linearly, and finally retries + * retries at intervals of max_backoff_duration up to retry_count times. For + * example, if min_backoff_duration is 10s, max_backoff_duration is 300s, + * and `max_doublings` is 3, then the a job will first be retried in 10s. + * The retry interval will double three times, and then increase linearly by + * 2^3 * 10s. Finally, the job will retry at intervals of + * max_backoff_duration until the job has been attempted retry_count times. + * Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, + * 300s, .... The default value of this field is 5. + */ + maxDoublings?: number; + /** + * The time limit for retrying a failed job, measured from time when an + * execution was first attempted. If specified with retry_count, the job + * will be retried until both limits are reached. The default value for + * max_retry_duration is zero, which means retry duration is unlimited. + */ + maxRetryDuration?: string; + /** + * The minimum amount of time to wait before retrying a job after it fails. + * The default value of this field is 5 seconds. + */ + minBackoffDuration?: string; + /** + * The number of attempts that the system will make to run a job using the + * exponential backoff procedure described by max_doublings. The default + * value of retry_count is zero. If retry_count is zero, a job attempt will + * *not* be retried if it fails. Instead the Cloud Scheduler system will + * wait for the next scheduled execution time. If retry_count is set to a + * non-zero number then Cloud Scheduler will retry failed attempts, using + * exponential backoff, retry_count times, or until the next scheduled + * execution time, whichever comes first. Values greater than 5 and + * negative values are not allowed. + */ + retryCount?: number; + } + /** + * Request message for forcing a job to run now using RunJob. + */ + export interface Schema$RunJobRequest {} + /** + * 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; + } + + + export class Resource$Projects { + root: Cloudscheduler; + locations: Resource$Projects$Locations; + constructor(root: Cloudscheduler) { + this.root = root; + this.getRoot.bind(this); + this.locations = new Resource$Projects$Locations(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Locations { + root: Cloudscheduler; + jobs: Resource$Projects$Locations$Jobs; + constructor(root: Cloudscheduler) { + this.root = root; + this.getRoot.bind(this); + this.jobs = new Resource$Projects$Locations$Jobs(root); + } + + getRoot() { + return this.root; + } + + + /** + * cloudscheduler.projects.locations.get + * @desc Gets information about a location. + * @alias cloudscheduler.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): AxiosPromise; + 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|AxiosPromise { + 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://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias cloudscheduler.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): AxiosPromise; + 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|AxiosPromise { + 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://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/locations') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + 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$Jobs { + root: Cloudscheduler; + constructor(root: Cloudscheduler) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * cloudscheduler.projects.locations.jobs.create + * @desc Creates a job. + * @alias cloudscheduler.projects.locations.jobs.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. + * @param {().Job} 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$Jobs$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Jobs$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/jobs') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.delete + * @desc Deletes a job. + * @alias cloudscheduler.projects.locations.jobs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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$Jobs$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Locations$Jobs$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.get + * @desc Gets a job. + * @alias cloudscheduler.projects.locations.jobs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_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$Jobs$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Locations$Jobs$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Locations$Jobs$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.list + * @desc Lists jobs. + * @alias cloudscheduler.projects.locations.jobs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use next_page_token to determine if more jobs exist. + * @param {string=} params.pageToken A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages. + * @param {string} params.parent Required. The location name. For example: `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$Jobs$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Projects$Locations$Jobs$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Jobs$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/jobs') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.patch + * @desc Updates a job. If successful, the updated Job is returned. If the + * job does not exist, `NOT_FOUND` is returned. If UpdateJob does not + * successfully return, it is possible for the job to be in an + * Job.State.UPDATE_FAILED state. A job in this state may not be executed. + * If this happens, retry the UpdateJob request until a successful response + * is received. + * @alias cloudscheduler.projects.locations.jobs.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. + * @param {string=} params.updateMask A mask used to specify which fields of the job are being updated. + * @param {().Job} 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$Jobs$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Locations$Jobs$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.pause + * @desc Pauses a job. If a job is paused then the system will stop + * executing the job until it is re-enabled via ResumeJob. The state of the + * job is stored in state; if paused it will be set to Job.State.PAUSED. A + * job must be in Job.State.ENABLED to be paused. + * @alias cloudscheduler.projects.locations.jobs.pause + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * @param {().PauseJobRequest} 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 + */ + pause( + params?: Params$Resource$Projects$Locations$Jobs$Pause, + options?: MethodOptions): AxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + pause( + params: Params$Resource$Projects$Locations$Jobs$Pause, + callback: BodyResponseCallback): void; + pause(callback: BodyResponseCallback): void; + pause( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Pause| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Pause; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:pause') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.resume + * @desc Resume a job. This method reenables a job after it has been + * Job.State.PAUSED. The state of a job is stored in Job.state; after + * calling this method it will be set to Job.State.ENABLED. A job must be in + * Job.State.PAUSED to be resumed. + * @alias cloudscheduler.projects.locations.jobs.resume + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * @param {().ResumeJobRequest} 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 + */ + resume( + params?: Params$Resource$Projects$Locations$Jobs$Resume, + options?: MethodOptions): AxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + resume( + params: Params$Resource$Projects$Locations$Jobs$Resume, + callback: BodyResponseCallback): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Resume| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:resume') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudscheduler.projects.locations.jobs.run + * @desc Forces a job to run now. When this method is called, Cloud + * Scheduler will dispatch the job, even if the job is already running. + * @alias cloudscheduler.projects.locations.jobs.run + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + * @param {().RunJobRequest} 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 + */ + run(params?: Params$Resource$Projects$Locations$Jobs$Run, + options?: MethodOptions): AxiosPromise; + run(params: Params$Resource$Projects$Locations$Jobs$Run, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + run(params: Params$Resource$Projects$Locations$Jobs$Run, + callback: BodyResponseCallback): void; + run(callback: BodyResponseCallback): void; + run(paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Run| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:run') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Jobs$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The location name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Job; + } + export interface Params$Resource$Projects$Locations$Jobs$Delete extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Requested page size. The maximum page size is 500. If unspecified, the + * page size will be the maximum. Fewer jobs than requested might be + * returned, even if more jobs exist; use next_page_token to determine if + * more jobs exist. + */ + pageSize?: number; + /** + * A token identifying a page of results the server will return. To request + * the first page results, page_token must be empty. To request the next + * page of results, page_token must be the value of next_page_token returned + * from the previous call to ListJobs. It is an error to switch the value of + * filter or order_by while iterating through pages. + */ + pageToken?: string; + /** + * Required. The location name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Jobs$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` + * can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons + * (:), or periods (.). For more information, see [Identifying + * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) + * * `LOCATION_ID` is the canonical ID for the job's location. The list + * of available locations can be obtained by calling ListLocations. For + * more information, see https://cloud.google.com/about/locations/. * + * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens + * (-), or underscores (_). The maximum length is 500 characters. + */ + name?: string; + /** + * A mask used to specify which fields of the job are being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Job; + } + export interface Params$Resource$Projects$Locations$Jobs$Pause extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PauseJobRequest; + } + export interface Params$Resource$Projects$Locations$Jobs$Resume extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResumeJobRequest; + } + export interface Params$Resource$Projects$Locations$Jobs$Run extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The job name. For example: + * `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunJobRequest; + } +} diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 34feb9a4928..e2f9f04c43c 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -157,6 +157,12 @@ export namespace cloudsearch_v1 { */ operatorOptions?: Schema$BooleanOperatorOptions; } + export interface Schema$CheckAccessResponse { + /** + * Returns true if principal has access. Returns false otherwise. + */ + hasAccess?: boolean; + } export interface Schema$CompositeFilter { /** * The logic operator of the sub filter. @@ -1362,7 +1368,7 @@ export namespace cloudsearch_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1378,7 +1384,7 @@ export namespace cloudsearch_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A people suggestion. @@ -1960,6 +1966,29 @@ export namespace cloudsearch_v1 { */ sourceConfig?: Schema$SourceConfig[]; } + export interface Schema$SearchItemsByViewUrlRequest { + /** + * Common debug options. + */ + debugOptions?: Schema$DebugOptions; + /** + * The next_page_token value returned from a previous request, if any. + */ + pageToken?: string; + /** + * Specify the full view URL to find the corresponding item. The maximum + * length is 2048 characters. + */ + viewUrl?: string; + } + export interface Schema$SearchItemsByViewUrlResponse { + items?: Schema$Item[]; + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } /** * Additional search quality metadata of the item. */ @@ -2275,7 +2304,7 @@ export namespace cloudsearch_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -2585,8 +2614,195 @@ export namespace cloudsearch_v1 { getRoot() { return this.root; } + + + /** + * cloudsearch.debug.datasources.items.checkAccess + * @desc Checks whether an item is accessible by specified principal. + * @alias cloudsearch.debug.datasources.items.checkAccess + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. + * @param {string} params.name Item name, format: datasources/{source_id}/items/{item_id} + * @param {().Principal} 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 + */ + checkAccess( + params?: Params$Resource$Debug$Datasources$Items$Checkaccess, + options?: MethodOptions): AxiosPromise; + checkAccess( + params: Params$Resource$Debug$Datasources$Items$Checkaccess, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + checkAccess( + params: Params$Resource$Debug$Datasources$Items$Checkaccess, + callback: BodyResponseCallback): void; + checkAccess(callback: BodyResponseCallback): + void; + checkAccess( + paramsOrCallback?: Params$Resource$Debug$Datasources$Items$Checkaccess| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Debug$Datasources$Items$Checkaccess; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Debug$Datasources$Items$Checkaccess; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/debug/{+name}:checkAccess') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * cloudsearch.debug.datasources.items.searchByViewUrl + * @desc Fetches the item whose viewUrl exactly matches that of the URL + * provided in the request. + * @alias cloudsearch.debug.datasources.items.searchByViewUrl + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Source name, format: datasources/{source_id} + * @param {().SearchItemsByViewUrlRequest} 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 + */ + searchByViewUrl( + params?: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, + options?: MethodOptions): + AxiosPromise; + searchByViewUrl( + params: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + searchByViewUrl( + params: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, + callback: BodyResponseCallback): + void; + searchByViewUrl( + callback: BodyResponseCallback): + void; + searchByViewUrl( + paramsOrCallback?: + Params$Resource$Debug$Datasources$Items$Searchbyviewurl| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Debug$Datasources$Items$Searchbyviewurl; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Debug$Datasources$Items$Searchbyviewurl; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudsearch.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/debug/{+name}/items:searchByViewUrl') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } } + export interface Params$Resource$Debug$Datasources$Items$Checkaccess extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; + /** + * Item name, format: datasources/{source_id}/items/{item_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Principal; + } + export interface Params$Resource$Debug$Datasources$Items$Searchbyviewurl + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Source name, format: datasources/{source_id} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchItemsByViewUrlRequest; + } export class Resource$Debug$Datasources$Items$Unmappedids { root: Cloudsearch; @@ -2607,6 +2823,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @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 item, in the following format: datasources/{source_id}/items/{ID} @@ -2684,6 +2901,11 @@ export namespace cloudsearch_v1 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; /** * Maximum number of items to fetch in a request. Defaults to 100. */ @@ -2737,6 +2959,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string=} params.groupResourceName * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. @@ -2822,6 +3045,11 @@ export namespace cloudsearch_v1 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; /** * */ @@ -2865,6 +3093,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @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 identity source, in the following format: identitysources/{source_id} @@ -2943,6 +3172,11 @@ export namespace cloudsearch_v1 { */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** + * If set, the request will enable debugging features of Cloud Search. Only + * turn on this field, if asked by Google to help with debugging. + */ + 'debugOptions.enableDebugging'?: boolean; /** * Maximum number of items to fetch in a request. Defaults to 100. */ diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index e752916c377..4075e1c36af 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -215,7 +215,7 @@ export namespace cloudshell_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -231,7 +231,7 @@ export namespace cloudshell_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A public SSH key, corresponding to a private SSH key held by the client. @@ -321,7 +321,7 @@ export namespace cloudshell_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudshell/v1alpha1.ts b/src/apis/cloudshell/v1alpha1.ts index af33603075d..d046441ad44 100644 --- a/src/apis/cloudshell/v1alpha1.ts +++ b/src/apis/cloudshell/v1alpha1.ts @@ -216,7 +216,7 @@ export namespace cloudshell_v1alpha1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -232,7 +232,7 @@ export namespace cloudshell_v1alpha1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A public SSH key, corresponding to a private SSH key held by the client. @@ -334,7 +334,7 @@ export namespace cloudshell_v1alpha1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index 47d794999d9..caf7fef359f 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -195,7 +195,7 @@ export namespace cloudtasks_v2beta2 { * there is a limit on the maximum size of the Task. For more information, * see the CreateTask documentation. */ - headers?: any; + headers?: {[key: string]: string;}; /** * The HTTP method to use for the request. The default is POST. The * app's request handler for the task's target URL must be able to @@ -596,7 +596,7 @@ export namespace cloudtasks_v2beta2 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -605,7 +605,7 @@ export namespace cloudtasks_v2beta2 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -983,7 +983,7 @@ export namespace cloudtasks_v2beta2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 9f10d4929e4..49f793b0e51 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -208,7 +208,7 @@ export namespace cloudtasks_v2beta3 { * there is a limit on the maximum size of the Task. For more information, * see the CreateTask documentation. */ - headers?: any; + headers?: {[key: string]: string;}; /** * The HTTP method to use for the request. The default is POST. The * app's request handler for the task's target URL must be able to @@ -482,7 +482,7 @@ export namespace cloudtasks_v2beta3 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -491,7 +491,7 @@ export namespace cloudtasks_v2beta3 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -803,7 +803,7 @@ export namespace cloudtasks_v2beta3 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index d710af39c55..d17384ec2ec 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -207,7 +207,7 @@ export namespace cloudtrace_v1 { * `/http/status_code` * `/http/url` * `/http/user_agent` * `/pid` * * `/stacktrace` * `/tid` */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the span. Must be less than 128 bytes. The span name is sanitized * and displayed in the Stackdriver Trace tool in the Google Cloud Platform diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 3a282c66f82..60a118a45b0 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -146,7 +146,7 @@ export namespace cloudtrace_v2 { * "/http/request_bytes": 300 "abc.com/myattribute": * true */ - attributeMap?: any; + attributeMap?: {[key: string]: Schema$AttributeValue;}; /** * The number of attributes that were discarded. Attributes can be discarded * because their keys are too long or because there are too many attributes. @@ -466,7 +466,7 @@ export namespace cloudtrace_v2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index c2abb5106ea..5c5c8339aec 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -143,7 +143,7 @@ export namespace composer_v1 { * [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally * constrained to be <= 128 bytes in size. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The resource name of the environment, in the form: * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" @@ -332,7 +332,7 @@ export namespace composer_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -348,7 +348,7 @@ export namespace composer_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata describing an operation. @@ -402,7 +402,7 @@ export namespace composer_v1 { * [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), * and cannot be overridden. */ - airflowConfigOverrides?: any; + airflowConfigOverrides?: {[key: string]: string;}; /** * Optional. Additional environment variables to provide to the Apache * Airflow scheduler, worker, and webserver processes. Environment variable @@ -414,7 +414,7 @@ export namespace composer_v1 { * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` */ - envVariables?: any; + 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 @@ -435,7 +435,14 @@ export namespace composer_v1 { * "[devel]>=1.8.2, <1.9.2". To specify a package without * pinning it to a version specifier, use the empty string as the value. */ - pypiPackages?: any; + pypiPackages?: {[key: string]: string;}; + /** + * Optional. The major version of Python used to run the Apache Airflow + * scheduler, worker, and webserver processes. Can be set to '2' or + * '3'. If not specified, the default is '2'. Cannot be + * updated. + */ + pythonVersion?: string; } /** * The `Status` type defines a logical error model that is suitable for @@ -482,7 +489,7 @@ export namespace composer_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index aeb6f1e9648..3f2c951862e 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -143,7 +143,7 @@ export namespace composer_v1beta1 { * [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally * constrained to be <= 128 bytes in size. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The resource name of the environment, in the form: * "projects/{projectId}/locations/{locationId}/environments/{environmentId}" @@ -335,7 +335,7 @@ export namespace composer_v1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -351,7 +351,7 @@ export namespace composer_v1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Metadata describing an operation. @@ -405,7 +405,7 @@ export namespace composer_v1beta1 { * [blacklisted](/composer/docs/how-to/managing/setting-airflow-configurations#airflow_configuration_blacklists), * and cannot be overridden. */ - airflowConfigOverrides?: any; + airflowConfigOverrides?: {[key: string]: string;}; /** * Optional. Additional environment variables to provide to the Apache * Airflow scheduler, worker, and webserver processes. Environment variable @@ -417,7 +417,7 @@ export namespace composer_v1beta1 { * `GCS_BUCKET` * `GKE_CLUSTER_NAME` * `SQL_DATABASE` * `SQL_INSTANCE` * * `SQL_PASSWORD` * `SQL_PROJECT` * `SQL_REGION` * `SQL_USER` */ - envVariables?: any; + envVariables?: {[key: string]: string;}; /** * Immutable. The version of the software running in the environment. This * encapsulates both the version of Cloud Composer functionality and the @@ -450,7 +450,7 @@ export namespace composer_v1beta1 { * "[devel]>=1.8.2, <1.9.2". To specify a package without * pinning it to a version specifier, use the empty string as the value. */ - pypiPackages?: any; + pypiPackages?: {[key: string]: string;}; /** * Optional. The major version of Python used to run the Apache Airflow * scheduler, worker, and webserver processes. Can be set to '2' or @@ -504,7 +504,7 @@ export namespace composer_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 14a805f0c3c..6bfacda7fc3 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -308,7 +308,7 @@ export namespace compute_alpha { /** * A list of AcceleratorTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AcceleratorTypesScopedList;}; /** * [Output Only] Type of resource. Always * compute#acceleratorTypeAggregatedList for aggregated lists of accelerator @@ -330,7 +330,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of accelerator types. @@ -364,7 +368,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AcceleratorTypesScopedList { /** @@ -375,7 +383,11 @@ export namespace compute_alpha { * [Output Only] An informational warning that appears when the accelerator * types list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An access configuration attached to an instance's network interface. @@ -486,7 +498,7 @@ export namespace compute_alpha { * the setLabels method. Each label key/value must comply with RFC1035. * Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -555,7 +567,7 @@ export namespace compute_alpha { /** * A list of AddressesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AddressesScopedList;}; /** * [Output Only] Type of resource. Always compute#addressAggregatedList for * aggregated lists of addresses. @@ -576,7 +588,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AddressesScopedList { /** @@ -587,7 +603,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of addresses * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of addresses. @@ -621,7 +641,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An alias IP range attached to an instance's network interface. @@ -717,7 +741,7 @@ export namespace compute_alpha { /** * A list of Allocation resources. */ - items?: any; + items?: {[key: string]: Schema$AllocationsScopedList;}; /** * Type of resource. */ @@ -737,7 +761,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AllocationList { /** @@ -769,7 +797,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * This allocation type allows to pre allocate specific instance @@ -833,7 +865,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of allocations when the * list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AllocationsUpdateResourceShapeRequest { /** @@ -1003,7 +1039,7 @@ export namespace compute_alpha { * disks.setLabels method. This field is only applicable for persistent * disks. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The source image to create this disk. When creating a new instance, one * of initializeParams.sourceImage or disks.source is required except for @@ -1198,7 +1234,7 @@ export namespace compute_alpha { /** * A list of AutoscalersScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AutoscalersScopedList;}; /** * [Output Only] Type of resource. Always compute#autoscalerAggregatedList * for aggregated lists of autoscalers. @@ -1219,7 +1255,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Autoscaler resources. @@ -1253,7 +1293,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AutoscalersScopedList { /** @@ -1264,7 +1308,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of * autoscalers when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AutoscalerStatusDetails { /** @@ -1665,7 +1713,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A BackendService resource. This resource defines a group of backend virtual @@ -1825,7 +1877,7 @@ export namespace compute_alpha { /** * A list of BackendServicesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$BackendServicesScopedList;}; /** * Type of resource. */ @@ -1845,7 +1897,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Configuration of a App Engine backend. @@ -1937,7 +1993,7 @@ export namespace compute_alpha { /** * Metadata defined as annotations on the network endpoint group. */ - annotations?: any; + annotations?: {[key: string]: string;}; /** * Health state of the backend instances or endpoints in requested instance * or network endpoint group, determined based on configured health checks. @@ -2013,7 +2069,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$BackendServiceReference { backendService?: string; @@ -2027,7 +2087,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Associates `members` with a `role`. @@ -2202,7 +2266,7 @@ export namespace compute_alpha { /** * A list of CommitmentsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$CommitmentsScopedList;}; /** * [Output Only] Type of resource. Always compute#commitmentAggregatedList * for aggregated lists of commitments. @@ -2223,7 +2287,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Commitment resources. @@ -2257,7 +2325,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$CommitmentsScopedList { /** @@ -2268,7 +2340,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of * commitments when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A condition to be met. @@ -2444,7 +2520,7 @@ export namespace compute_alpha { * Labels to apply to this disk. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output Only] Last attach timestamp in RFC3339 text format. */ @@ -2596,7 +2672,7 @@ export namespace compute_alpha { /** * A list of DisksScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$DisksScopedList;}; /** * [Output Only] Type of resource. Always compute#diskAggregatedList for * aggregated lists of persistent disks. @@ -2617,7 +2693,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A specification of the desired way to instantiate a disk in the instance @@ -2686,7 +2766,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DiskMoveRequest { /** @@ -2731,7 +2815,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of disks when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for @@ -2798,7 +2886,7 @@ export namespace compute_alpha { /** * A list of DiskTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$DiskTypesScopedList;}; /** * [Output Only] Type of resource. Always compute#diskTypeAggregatedList. */ @@ -2818,7 +2906,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of disk types. @@ -2852,7 +2944,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DiskTypesScopedList { /** @@ -2863,7 +2959,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of disk types * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DistributionPolicy { /** @@ -2930,7 +3030,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents an expression text. Example: title: "User account @@ -2969,7 +3073,7 @@ export namespace compute_alpha { * The list of ALLOW rules specified by this firewall. Each rule specifies a * protocol and port-range tuple that describes a permitted connection. */ - allowed?: any[]; + allowed?: Array<{IPProtocol?: string; ports?: string[];}>; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -2978,7 +3082,7 @@ export namespace compute_alpha { * The list of DENY rules specified by this firewall. Each rule specifies a * protocol and port-range tuple that describes a denied connection. */ - denied?: any[]; + denied?: Array<{IPProtocol?: string; ports?: string[];}>; /** * An optional description of this resource. Provide this property when you * create the resource. @@ -3142,7 +3246,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Encapsulates numeric value that can be either absolute or relative. @@ -3284,7 +3392,7 @@ export namespace compute_alpha { * setLabels method. Each label key/value pair must comply with RFC1035. * Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * This signifies what the ForwardingRule will be used for and can only take * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The @@ -3396,7 +3504,7 @@ export namespace compute_alpha { /** * A list of ForwardingRulesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$ForwardingRulesScopedList;}; /** * [Output Only] Type of resource. Always * compute#forwardingRuleAggregatedList for lists of forwarding rules. @@ -3417,7 +3525,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of ForwardingRule resources. @@ -3450,7 +3562,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ForwardingRuleReference { forwardingRule?: string; @@ -3464,7 +3580,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of forwarding rules when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$GlobalSetLabelsRequest { /** @@ -3486,7 +3606,7 @@ export namespace compute_alpha { * "webserver-frontend": "images". A label value can * also be empty (e.g. "my-label": ""). */ - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$GlobalSetPolicyRequest { /** @@ -3679,7 +3799,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A full or valid partial URL to a health check. For example, the following @@ -3699,7 +3823,7 @@ export namespace compute_alpha { /** * A list of HealthChecksScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$HealthChecksScopedList;}; /** * Type of resource. */ @@ -3719,7 +3843,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$HealthChecksScopedList { /** @@ -3730,13 +3858,17 @@ export namespace compute_alpha { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$HealthStatus { /** * Metadata defined as annotations for network endpoint. */ - annotations?: any; + annotations?: {[key: string]: string;}; /** * Health state of the instance. */ @@ -3995,7 +4127,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$HTTPSHealthCheck { /** @@ -4148,7 +4284,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Image resource. (== resource_for beta.images ==) (== resource_for @@ -4222,7 +4362,7 @@ export namespace compute_alpha { * Labels to apply to this image. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Integer license codes indicating which licenses are attached to this * image. @@ -4245,7 +4385,7 @@ export namespace compute_alpha { /** * The parameters of the raw disk image. */ - rawDisk?: any; + rawDisk?: {containerType?: string; sha1Checksum?: string; source?: string;}; /** * [Output Only] Server-defined URL for the resource. */ @@ -4350,7 +4490,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Instance resource. (== resource_for beta.instances ==) (== resource_for @@ -4435,7 +4579,7 @@ export namespace compute_alpha { * Labels to apply to this instance. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Full or partial URL of the machine type resource to use for this * instance, in the format: zones/zone/machineTypes/machine-type. This is @@ -4549,7 +4693,7 @@ export namespace compute_alpha { /** * A list of InstancesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstancesScopedList;}; /** * [Output Only] Type of resource. Always compute#instanceAggregatedList for * aggregated lists of Instance resources. @@ -4570,7 +4714,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for @@ -4655,7 +4803,7 @@ export namespace compute_alpha { /** * A list of InstanceGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstanceGroupsScopedList;}; /** * [Output Only] The resource type, which is always * compute#instanceGroupAggregatedList for aggregated lists of instance @@ -4677,7 +4825,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A list of InstanceGroup resources. @@ -4711,7 +4863,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Instance Group Manager resource. (== resource_for @@ -4926,7 +5082,7 @@ export namespace compute_alpha { /** * A list of InstanceGroupManagersScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstanceGroupManagersScopedList;}; /** * [Output Only] The resource type, which is always * compute#instanceGroupManagerAggregatedList for an aggregated list of @@ -4948,7 +5104,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagerAutoHealingPolicy { /** @@ -5005,7 +5165,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagerPendingActionsSummary { /** @@ -5104,7 +5268,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagersRecreateInstancesRequest { /** @@ -5150,7 +5318,11 @@ export namespace compute_alpha { * [Output Only] The warning that replaces the list of managed instance * groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagersSetAutoHealingRequest { autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; @@ -5322,7 +5494,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupsListInstancesRequest { /** @@ -5348,7 +5524,11 @@ export namespace compute_alpha { * [Output Only] An informational warning that replaces the list of instance * groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** @@ -5397,7 +5577,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of instance referrers. @@ -5431,7 +5615,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceMoveRequest { /** @@ -5483,7 +5671,7 @@ export namespace compute_alpha { /** * Labels to apply to instances that are created from this template. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The machine type to use for instances that are created from this * template. @@ -5576,7 +5764,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of instances * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstancesSetLabelsRequest { /** @@ -5585,7 +5777,7 @@ export namespace compute_alpha { * request to add or change labels. */ labelFingerprint?: string; - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$InstancesSetMachineResourcesRequest { /** @@ -5724,7 +5916,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceWithNamedPorts { /** @@ -5821,7 +6017,7 @@ export namespace compute_alpha { * modified by the setLabels method. Each label key/value must comply with * RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Type of link requested. This field indicates speed of each of the links * in the bundle, not the entire bundle. Only 10G per link is allowed for a @@ -5972,7 +6168,7 @@ export namespace compute_alpha { * later modified by the setLabels method. Each label key/value must comply * with RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -6051,7 +6247,7 @@ export namespace compute_alpha { /** * A list of InterconnectAttachmentsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InterconnectAttachmentsScopedList;}; /** * [Output Only] Type of resource. Always * compute#interconnectAttachmentAggregatedList for aggregated lists of @@ -6073,7 +6269,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Response to the list request, and contains a list of interconnect @@ -6108,7 +6308,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Informational metadata about Partner attachments from Partners to display @@ -6154,7 +6358,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Describes a single physical circuit between the Customer and Google. @@ -6279,7 +6487,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents an InterconnectLocations resource. The InterconnectLocations @@ -6395,7 +6607,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Information about any potential InterconnectAttachments between an @@ -6531,7 +6747,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of IP owners. @@ -6565,7 +6785,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A license resource. @@ -6704,7 +6928,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Specifies what kind of log the caller must write @@ -6872,7 +7100,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Machine Type resource. (== resource_for v1.machineTypes ==) (== @@ -6946,7 +7178,7 @@ export namespace compute_alpha { /** * A list of MachineTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$MachineTypesScopedList;}; /** * [Output Only] Type of resource. Always compute#machineTypeAggregatedList * for aggregated lists of machine types. @@ -6967,7 +7199,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of machine types. @@ -7001,7 +7237,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$MachineTypesScopedList { /** @@ -7012,7 +7252,11 @@ export namespace compute_alpha { * [Output Only] An informational warning that appears when the machine * types list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Managed Instance resource. @@ -7099,7 +7343,9 @@ export namespace compute_alpha { * [Output Only] Encountered errors during the last attempt to create or * delete the instance. */ - errors?: any; + errors?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; } /** * Overrides of stateful properties for a given instance @@ -7116,7 +7362,7 @@ export namespace compute_alpha { * Metadata overrides defined for this instance. TODO(b/69785416) validate * the total length is <9 KB */ - metadata?: any[]; + metadata?: Array<{key?: string; value?: string;}>; /** * [Output Only] Indicates where does the override come from. */ @@ -7166,7 +7412,7 @@ export namespace compute_alpha { * Array of key/value pairs. The total size of all keys and values must be * less than 512 KB. */ - items?: any[]; + items?: Array<{key?: string; value?: string;}>; /** * [Output Only] Type of the resource. Always compute#metadata for metadata. */ @@ -7274,7 +7520,7 @@ export namespace compute_alpha { /** * Metadata defined as annotations on the network endpoint. */ - annotations?: any; + annotations?: {[key: string]: string;}; /** * The name for a specific VM instance that the IP address belongs to. This * is required for network endpoints of type GCE_VM_IP_PORT. The instance @@ -7304,7 +7550,7 @@ export namespace compute_alpha { /** * Metadata defined as annotations on the network endpoint group. */ - annotations?: any; + annotations?: {[key: string]: string;}; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -7386,7 +7632,7 @@ export namespace compute_alpha { /** * A list of NetworkEndpointGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList;}; /** * [Output Only] The resource type, which is always * compute#networkEndpointGroupAggregatedList for aggregated lists of @@ -7408,7 +7654,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Load balancing specific fields for network endpoint group. @@ -7465,7 +7715,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NetworkEndpointGroupsAttachEndpointsRequest { /** @@ -7513,7 +7767,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NetworkEndpointGroupsScopedList { /** @@ -7525,7 +7783,11 @@ export namespace compute_alpha { * [Output Only] An informational warning that replaces the list of network * endpoint groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NetworkEndpointWithHealthStatus { /** @@ -7632,7 +7894,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A network peering attached to a network resource. The message includes the @@ -7802,7 +8068,7 @@ export namespace compute_alpha { /** * A list of NodeGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeGroupsScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for * aggregated lists of node groups. @@ -7823,7 +8089,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of nodeGroups. @@ -7857,7 +8127,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupNode { /** @@ -7917,7 +8191,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupsScopedList { /** @@ -7928,7 +8206,11 @@ export namespace compute_alpha { * [Output Only] An informational warning that appears when the nodeGroup * list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** @@ -7974,7 +8256,7 @@ export namespace compute_alpha { * Labels to use for node affinity, which will be used in instance * scheduling. */ - nodeAffinityLabels?: any; + nodeAffinityLabels?: {[key: string]: string;}; /** * The node type to use for nodes group that are created from this template. */ @@ -8017,7 +8299,7 @@ export namespace compute_alpha { /** * A list of NodeTemplatesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeTemplatesScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList * for aggregated lists of node templates. @@ -8038,7 +8320,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of node templates. @@ -8072,7 +8358,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeTemplateNodeTypeFlexibility { cpus?: string; @@ -8088,7 +8378,11 @@ export namespace compute_alpha { * [Output Only] An informational warning that appears when the node * templates list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Node Type resource. @@ -8156,7 +8450,7 @@ export namespace compute_alpha { /** * A list of NodeTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeTypesScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for * aggregated lists of node types. @@ -8177,7 +8471,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of node types. @@ -8211,7 +8509,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeTypesScopedList { /** @@ -8222,7 +8524,11 @@ export namespace compute_alpha { * [Output Only] An informational warning that appears when the node types * list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Operation resource, used to manage asynchronous API requests. (== @@ -8255,7 +8561,9 @@ export namespace compute_alpha { * [Output Only] If errors are generated during processing of the operation, * this field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * [Output Only] If the operation fails, this field contains the HTTP error * message that was returned, such as NOT FOUND. @@ -8345,7 +8653,11 @@ export namespace compute_alpha { * [Output Only] If warning messages are generated during processing of the * operation, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; /** * [Output Only] The URL of the zone where the operation resides. Only * available when performing per-zone operations. You must specify this @@ -8363,7 +8675,7 @@ export namespace compute_alpha { /** * [Output Only] A map of scoped operation lists. */ - items?: any; + items?: {[key: string]: Schema$OperationsScopedList;}; /** * [Output Only] Type of resource. Always compute#operationAggregatedList * for aggregated lists of operations. @@ -8384,7 +8696,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Operation resources. @@ -8419,7 +8735,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$OperationsScopedList { /** @@ -8430,7 +8750,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of operations * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A matcher for the path portion of the URL. The BackendService from the @@ -8815,7 +9139,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionDisksAddResourcePoliciesRequest { /** @@ -8864,7 +9192,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of InstanceGroup resources. @@ -8897,7 +9229,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * RegionInstanceGroupManagers.deletePerInstanceConfigs @@ -8942,7 +9278,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionInstanceGroupManagersAbandonInstancesRequest { /** @@ -8994,7 +9334,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionInstanceGroupManagersListInstancesResponse { /** @@ -9079,7 +9423,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** @@ -9141,7 +9489,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionSetLabelsRequest { /** @@ -9156,7 +9508,7 @@ export namespace compute_alpha { /** * The labels to set for this resource. */ - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$RegionSetPolicyRequest { /** @@ -9230,7 +9582,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of resourcePolicies when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ResourcePolicy { /** @@ -9284,7 +9640,7 @@ export namespace compute_alpha { /** * A list of ResourcePolicy resources. */ - items?: any; + items?: {[key: string]: Schema$ResourcePoliciesScopedList;}; /** * Type of resource. */ @@ -9304,7 +9660,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A backup schedule policy specifies when and how frequently snapshots are to @@ -9369,7 +9729,7 @@ export namespace compute_alpha { * Labels to apply to scheduled snapshots. These can be later modified by * the setLabels method. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * GCS bucket storage location of the auto snapshot (regional or * multi-regional). @@ -9445,7 +9805,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ResourcePolicyVmMaintenancePolicy { /** @@ -9602,7 +9966,11 @@ export namespace compute_alpha { * [Output Only] If potential misconfigurations are detected for this route, * this field will be populated with warning messages. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * Contains a list of Route resources. @@ -9635,7 +10003,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Router resource. @@ -9728,7 +10100,7 @@ export namespace compute_alpha { /** * A list of Router resources. */ - items?: any; + items?: {[key: string]: Schema$RoutersScopedList;}; /** * Type of resource. */ @@ -9748,7 +10120,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RouterBgp { /** @@ -9905,7 +10281,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a Nat resource. It enables the VMs within the specified @@ -10026,7 +10406,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of routers when the list is * empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RouterStatus { /** @@ -10403,7 +10787,7 @@ export namespace compute_alpha { * modified by the setLabels method. Each label key/value must comply with * RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -10467,7 +10851,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SecurityPolicyReference { securityPolicy?: string; @@ -10753,7 +11141,7 @@ export namespace compute_alpha { * Labels to apply to this snapshot. These can be later modified by the * setLabels method. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output Only] Integer license codes indicating which licenses are * attached to this snapshot. @@ -10860,7 +11248,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A specification of the parameters to use when creating the instance @@ -10908,7 +11300,7 @@ export namespace compute_alpha { /** * Labels to apply to instances that are created from this machine image. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The machine type to use for instances that are created from this machine * image. @@ -11041,7 +11433,7 @@ export namespace compute_alpha { /** * A list of SslCertificatesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$SslCertificatesScopedList;}; /** * [Output Only] Type of resource. Always * compute#sslCertificateAggregatedList for lists of SSL Certificates. @@ -11062,7 +11454,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of SslCertificate resources. @@ -11095,7 +11491,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Configuration and status of a managed SSL certificate. @@ -11110,7 +11510,7 @@ export namespace compute_alpha { * [Output only] Detailed statuses of the domains specified for managed * certificate resource. */ - domainStatus?: any; + domainStatus?: {[key: string]: string;}; /** * [Output only] Status of the managed certificate resource. */ @@ -11141,7 +11541,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SSLHealthCheck { /** @@ -11213,7 +11617,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SslPoliciesListAvailableFeaturesResponse { features?: string[]; @@ -11292,7 +11700,11 @@ export namespace compute_alpha { * [Output Only] If potential misconfigurations are detected for this SSL * policy, this field will be populated with warning messages. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } export interface Schema$SslPolicyReference { /** @@ -11491,7 +11903,7 @@ export namespace compute_alpha { /** * A list of SubnetworksScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$SubnetworksScopedList;}; /** * [Output Only] Type of resource. Always compute#subnetworkAggregatedList * for aggregated lists of subnetworks. @@ -11512,7 +11924,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Subnetwork resources. @@ -11546,7 +11962,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a secondary IP range of a subnetwork. @@ -11585,7 +12005,11 @@ export namespace compute_alpha { * An informational warning that appears when the list of addresses is * empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { privateIpGoogleAccess?: boolean; @@ -11618,7 +12042,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A TargetHttpProxy resource. This resource defines an HTTP proxy. (== @@ -11678,7 +12106,7 @@ export namespace compute_alpha { /** * A list of TargetHttpProxiesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$TargetHttpProxiesScopedList;}; /** * [Output Only] Type of resource. Always * compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies. @@ -11699,7 +12127,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A list of TargetHttpProxy resources. @@ -11733,7 +12165,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetHttpsProxiesScopedList { /** @@ -11744,7 +12180,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { /** @@ -11844,7 +12284,7 @@ export namespace compute_alpha { /** * A list of TargetHttpsProxiesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$TargetHttpsProxiesScopedList;}; /** * [Output Only] Type of resource. Always * compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies. @@ -11865,7 +12305,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of TargetHttpsProxy resources. @@ -11899,7 +12343,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A TargetInstance resource. This resource defines an endpoint instance that @@ -11970,7 +12418,7 @@ export namespace compute_alpha { /** * A list of TargetInstance resources. */ - items?: any; + items?: {[key: string]: Schema$TargetInstancesScopedList;}; /** * Type of resource. */ @@ -11990,7 +12438,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of TargetInstance resources. @@ -12023,7 +12475,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetInstancesScopedList { /** @@ -12034,7 +12490,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A TargetPool resource. This resource defines a pool of instances, an @@ -12140,7 +12600,7 @@ export namespace compute_alpha { /** * A list of TargetPool resources. */ - items?: any; + items?: {[key: string]: Schema$TargetPoolsScopedList;}; /** * [Output Only] Type of resource. Always compute#targetPoolAggregatedList * for aggregated lists of target pools. @@ -12161,7 +12621,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; @@ -12203,7 +12667,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetPoolsAddHealthCheckRequest { /** @@ -12246,7 +12714,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetReference { target?: string; @@ -12363,7 +12835,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetTcpProxiesSetBackendServiceRequest { /** @@ -12458,7 +12934,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a Target VPN gateway resource. (== resource_for @@ -12505,7 +12985,7 @@ export namespace compute_alpha { * modified by the setLabels method. Each label key/value must comply with * RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -12550,7 +13030,7 @@ export namespace compute_alpha { /** * A list of TargetVpnGateway resources. */ - items?: any; + items?: {[key: string]: Schema$TargetVpnGatewaysScopedList;}; /** * [Output Only] Type of resource. Always compute#targetVpnGateway for * target VPN gateways. @@ -12571,7 +13051,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of TargetVpnGateway resources. @@ -12605,7 +13089,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetVpnGatewaysScopedList { /** @@ -12616,7 +13104,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of addresses * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TCPHealthCheck { /** @@ -12809,7 +13301,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$UrlMapReference { urlMap?: string; @@ -12822,7 +13318,7 @@ export namespace compute_alpha { /** * A list of UrlMapsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$UrlMapsScopedList;}; /** * Type of resource. */ @@ -12842,7 +13338,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$UrlMapsScopedList { /** @@ -12853,7 +13353,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$UrlMapsValidateRequest { /** @@ -12955,7 +13459,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Secondary IP range of a usable subnetwork. @@ -13066,7 +13574,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a VPN gateway resource. @@ -13105,7 +13617,7 @@ export namespace compute_alpha { * by the setLabels method. Each label key/value must comply with RFC1035. * Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -13142,7 +13654,7 @@ export namespace compute_alpha { /** * A list of VpnGateway resources. */ - items?: any; + items?: {[key: string]: Schema$VpnGatewaysScopedList;}; /** * [Output Only] Type of resource. Always compute#vpnGateway for VPN * gateways. @@ -13163,7 +13675,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of VpnGateway resources. @@ -13197,7 +13713,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$VpnGatewaysScopedList { /** @@ -13208,7 +13728,11 @@ export namespace compute_alpha { * [Output Only] Informational warning which replaces the list of addresses * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A VPN gateway interface. @@ -13269,7 +13793,7 @@ export namespace compute_alpha { * setLabels method. Each label key/value pair must comply with RFC1035. * Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Local traffic selector to use when establishing the VPN tunnel with peer * VPN gateway. The value should be a CIDR formatted string, for example: @@ -13350,7 +13874,7 @@ export namespace compute_alpha { /** * A list of VpnTunnelsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$VpnTunnelsScopedList;}; /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ @@ -13370,7 +13894,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of VpnTunnel resources. @@ -13403,7 +13931,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$VpnTunnelsScopedList { /** @@ -13414,7 +13946,11 @@ export namespace compute_alpha { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$WafExpressionSet { /** @@ -13473,7 +14009,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Service resource (a.k.a service project) ID. @@ -13568,7 +14108,11 @@ export namespace compute_alpha { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ZoneSetLabelsRequest { /** @@ -13583,7 +14127,7 @@ export namespace compute_alpha { /** * The labels to set for this resource. */ - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$ZoneSetPolicyRequest { /** diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 8946c89178d..ebe0c560c99 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -288,7 +288,7 @@ export namespace compute_beta { /** * A list of AcceleratorTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AcceleratorTypesScopedList;}; /** * [Output Only] Type of resource. Always * compute#acceleratorTypeAggregatedList for aggregated lists of accelerator @@ -310,7 +310,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of accelerator types. @@ -344,7 +348,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AcceleratorTypesScopedList { /** @@ -355,7 +363,11 @@ export namespace compute_beta { * [Output Only] An informational warning that appears when the accelerator * types list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An access configuration attached to an instance's network interface. @@ -457,7 +469,7 @@ export namespace compute_beta { * the setLabels method. Each label key/value must comply with RFC1035. * Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -526,7 +538,7 @@ export namespace compute_beta { /** * A list of AddressesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AddressesScopedList;}; /** * [Output Only] Type of resource. Always compute#addressAggregatedList for * aggregated lists of addresses. @@ -547,7 +559,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AddressesScopedList { /** @@ -558,7 +574,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of addresses * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of addresses. @@ -592,7 +612,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An alias IP range attached to an instance's network interface. @@ -753,7 +777,7 @@ export namespace compute_beta { * disks.setLabels method. This field is only applicable for persistent * disks. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The source image to create this disk. When creating a new instance, one * of initializeParams.sourceImage or disks.source is required except for @@ -927,7 +951,7 @@ export namespace compute_beta { /** * A list of AutoscalersScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AutoscalersScopedList;}; /** * [Output Only] Type of resource. Always compute#autoscalerAggregatedList * for aggregated lists of autoscalers. @@ -948,7 +972,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Autoscaler resources. @@ -982,7 +1010,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AutoscalersScopedList { /** @@ -993,7 +1025,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of * autoscalers when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AutoscalerStatusDetails { /** @@ -1337,7 +1373,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A BackendService resource. This resource defines a group of backend virtual @@ -1486,7 +1526,7 @@ export namespace compute_beta { /** * A list of BackendServicesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$BackendServicesScopedList;}; /** * Type of resource. */ @@ -1506,7 +1546,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Message containing Cloud CDN configuration for a backend service. @@ -1587,7 +1631,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$BackendServiceReference { backendService?: string; @@ -1601,7 +1649,11 @@ export namespace compute_beta { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Associates `members` with a `role`. @@ -1766,7 +1818,7 @@ export namespace compute_beta { /** * A list of CommitmentsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$CommitmentsScopedList;}; /** * [Output Only] Type of resource. Always compute#commitmentAggregatedList * for aggregated lists of commitments. @@ -1787,7 +1839,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Commitment resources. @@ -1821,7 +1877,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$CommitmentsScopedList { /** @@ -1832,7 +1892,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of * commitments when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A condition to be met. @@ -2008,7 +2072,7 @@ export namespace compute_beta { * Labels to apply to this disk. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output Only] Last attach timestamp in RFC3339 text format. */ @@ -2152,7 +2216,7 @@ export namespace compute_beta { /** * A list of DisksScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$DisksScopedList;}; /** * [Output Only] Type of resource. Always compute#diskAggregatedList for * aggregated lists of persistent disks. @@ -2173,7 +2237,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A specification of the desired way to instantiate a disk in the instance @@ -2242,7 +2310,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DiskMoveRequest { /** @@ -2287,7 +2359,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of disks when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for @@ -2354,7 +2430,7 @@ export namespace compute_beta { /** * A list of DiskTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$DiskTypesScopedList;}; /** * [Output Only] Type of resource. Always compute#diskTypeAggregatedList. */ @@ -2374,7 +2450,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of disk types. @@ -2408,7 +2488,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DiskTypesScopedList { /** @@ -2419,7 +2503,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of disk types * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DistributionPolicy { /** @@ -2472,7 +2560,7 @@ export namespace compute_beta { * The list of ALLOW rules specified by this firewall. Each rule specifies a * protocol and port-range tuple that describes a permitted connection. */ - allowed?: any[]; + allowed?: Array<{IPProtocol?: string; ports?: string[];}>; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -2481,7 +2569,7 @@ export namespace compute_beta { * The list of DENY rules specified by this firewall. Each rule specifies a * protocol and port-range tuple that describes a denied connection. */ - denied?: any[]; + denied?: Array<{IPProtocol?: string; ports?: string[];}>; /** * An optional description of this resource. Provide this property when you * create the resource. @@ -2645,7 +2733,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Encapsulates numeric value that can be either absolute or relative. @@ -2770,7 +2862,7 @@ export namespace compute_beta { * setLabels method. Each label key/value pair must comply with RFC1035. * Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * This signifies what the ForwardingRule will be used for and can only take * the following values: INTERNAL, INTERNAL_SELF_MANAGED, EXTERNAL. The @@ -2882,7 +2974,7 @@ export namespace compute_beta { /** * A list of ForwardingRulesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$ForwardingRulesScopedList;}; /** * [Output Only] Type of resource. Always * compute#forwardingRuleAggregatedList for lists of forwarding rules. @@ -2903,7 +2995,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of ForwardingRule resources. @@ -2936,7 +3032,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ForwardingRuleReference { forwardingRule?: string; @@ -2950,7 +3050,11 @@ export namespace compute_beta { * Informational warning which replaces the list of forwarding rules when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$GlobalSetLabelsRequest { /** @@ -2972,7 +3076,7 @@ export namespace compute_beta { * "webserver-frontend": "images". A label value can * also be empty (e.g. "my-label": ""). */ - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$GlobalSetPolicyRequest { /** @@ -3159,7 +3263,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A full or valid partial URL to a health check. For example, the following @@ -3430,7 +3538,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An HttpsHealthCheck resource. This resource defines a template for how @@ -3583,7 +3695,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Image resource. (== resource_for beta.images ==) (== resource_for @@ -3657,7 +3773,7 @@ export namespace compute_beta { * Labels to apply to this image. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Integer license codes indicating which licenses are attached to this * image. @@ -3680,7 +3796,7 @@ export namespace compute_beta { /** * The parameters of the raw disk image. */ - rawDisk?: any; + rawDisk?: {containerType?: string; sha1Checksum?: string; source?: string;}; /** * [Output Only] Server-defined URL for the resource. */ @@ -3785,7 +3901,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Instance resource. (== resource_for beta.instances ==) (== resource_for @@ -3850,7 +3970,7 @@ export namespace compute_beta { * Labels to apply to this instance. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Full or partial URL of the machine type resource to use for this * instance, in the format: zones/zone/machineTypes/machine-type. This is @@ -3951,7 +4071,7 @@ export namespace compute_beta { /** * A list of InstancesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstancesScopedList;}; /** * [Output Only] Type of resource. Always compute#instanceAggregatedList for * aggregated lists of Instance resources. @@ -3972,7 +4092,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for @@ -4057,7 +4181,7 @@ export namespace compute_beta { /** * A list of InstanceGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstanceGroupsScopedList;}; /** * [Output Only] The resource type, which is always * compute#instanceGroupAggregatedList for aggregated lists of instance @@ -4079,7 +4203,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A list of InstanceGroup resources. @@ -4113,7 +4241,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Instance Group Manager resource. (== resource_for @@ -4324,7 +4456,7 @@ export namespace compute_beta { /** * A list of InstanceGroupManagersScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstanceGroupManagersScopedList;}; /** * [Output Only] The resource type, which is always * compute#instanceGroupManagerAggregatedList for an aggregated list of @@ -4346,7 +4478,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagerAutoHealingPolicy { /** @@ -4395,7 +4531,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagerPendingActionsSummary { /** @@ -4491,7 +4631,11 @@ export namespace compute_beta { * [Output Only] The warning that replaces the list of managed instance * groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagersSetAutoHealingRequest { autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; @@ -4631,7 +4775,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupsListInstancesRequest { /** @@ -4657,7 +4805,11 @@ export namespace compute_beta { * [Output Only] An informational warning that replaces the list of instance * groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** @@ -4706,7 +4858,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of instance referrers. @@ -4740,7 +4896,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceMoveRequest { /** @@ -4787,7 +4947,7 @@ export namespace compute_beta { /** * Labels to apply to instances that are created from this template. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The machine type to use for instances that are created from this * template. @@ -4868,7 +5028,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of instances * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstancesSetLabelsRequest { /** @@ -4877,7 +5041,7 @@ export namespace compute_beta { * request to add or change labels. */ labelFingerprint?: string; - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$InstancesSetMachineResourcesRequest { /** @@ -5009,7 +5173,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceWithNamedPorts { /** @@ -5106,7 +5274,7 @@ export namespace compute_beta { * modified by the setLabels method. Each label key/value must comply with * RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Type of link requested. This field indicates speed of each of the links * in the bundle, not the entire bundle. Only 10G per link is allowed for a @@ -5257,7 +5425,7 @@ export namespace compute_beta { * later modified by the setLabels method. Each label key/value must comply * with RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -5336,7 +5504,7 @@ export namespace compute_beta { /** * A list of InterconnectAttachmentsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InterconnectAttachmentsScopedList;}; /** * [Output Only] Type of resource. Always * compute#interconnectAttachmentAggregatedList for aggregated lists of @@ -5358,7 +5526,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Response to the list request, and contains a list of interconnect @@ -5393,7 +5565,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Informational metadata about Partner attachments from Partners to display @@ -5439,7 +5615,11 @@ export namespace compute_beta { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Describes a single physical circuit between the Customer and Google. @@ -5564,7 +5744,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents an InterconnectLocations resource. The InterconnectLocations @@ -5674,7 +5858,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Information about any potential InterconnectAttachments between an @@ -5882,7 +6070,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Specifies what kind of log the caller must write @@ -6028,7 +6220,7 @@ export namespace compute_beta { /** * A list of MachineTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$MachineTypesScopedList;}; /** * [Output Only] Type of resource. Always compute#machineTypeAggregatedList * for aggregated lists of machine types. @@ -6049,7 +6241,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of machine types. @@ -6083,7 +6279,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$MachineTypesScopedList { /** @@ -6094,7 +6294,11 @@ export namespace compute_beta { * [Output Only] An informational warning that appears when the machine * types list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Managed Instance resource. @@ -6153,7 +6357,9 @@ export namespace compute_beta { * [Output Only] Encountered errors during the last attempt to create or * delete the instance. */ - errors?: any; + errors?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; } export interface Schema$ManagedInstanceVersion { /** @@ -6184,7 +6390,7 @@ export namespace compute_beta { * Array of key/value pairs. The total size of all keys and values must be * less than 512 KB. */ - items?: any[]; + items?: Array<{key?: string; value?: string;}>; /** * [Output Only] Type of the resource. Always compute#metadata for metadata. */ @@ -6383,7 +6589,7 @@ export namespace compute_beta { /** * A list of NetworkEndpointGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NetworkEndpointGroupsScopedList;}; /** * [Output Only] The resource type, which is always * compute#networkEndpointGroupAggregatedList for aggregated lists of @@ -6405,7 +6611,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Load balancing specific fields for network endpoint group. @@ -6462,7 +6672,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NetworkEndpointGroupsAttachEndpointsRequest { /** @@ -6510,7 +6724,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NetworkEndpointGroupsScopedList { /** @@ -6522,7 +6740,11 @@ export namespace compute_beta { * [Output Only] An informational warning that replaces the list of network * endpoint groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NetworkEndpointWithHealthStatus { /** @@ -6629,7 +6851,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A network peering attached to a network resource. The message includes the @@ -6768,7 +6994,7 @@ export namespace compute_beta { /** * A list of NodeGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeGroupsScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for * aggregated lists of node groups. @@ -6789,7 +7015,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of nodeGroups. @@ -6823,7 +7053,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupNode { /** @@ -6879,7 +7113,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupsScopedList { /** @@ -6890,7 +7128,11 @@ export namespace compute_beta { * [Output Only] An informational warning that appears when the nodeGroup * list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** @@ -6936,7 +7178,7 @@ export namespace compute_beta { * Labels to use for node affinity, which will be used in instance * scheduling. */ - nodeAffinityLabels?: any; + nodeAffinityLabels?: {[key: string]: string;}; /** * The node type to use for nodes group that are created from this template. */ @@ -6975,7 +7217,7 @@ export namespace compute_beta { /** * A list of NodeTemplatesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeTemplatesScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList * for aggregated lists of node templates. @@ -6996,7 +7238,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of node templates. @@ -7030,7 +7276,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeTemplateNodeTypeFlexibility { cpus?: string; @@ -7046,7 +7296,11 @@ export namespace compute_beta { * [Output Only] An informational warning that appears when the node * templates list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Node Type resource. @@ -7114,7 +7368,7 @@ export namespace compute_beta { /** * A list of NodeTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeTypesScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for * aggregated lists of node types. @@ -7135,7 +7389,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of node types. @@ -7169,7 +7427,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeTypesScopedList { /** @@ -7180,7 +7442,11 @@ export namespace compute_beta { * [Output Only] An informational warning that appears when the node types * list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Operation resource, used to manage asynchronous API requests. (== @@ -7213,7 +7479,9 @@ export namespace compute_beta { * [Output Only] If errors are generated during processing of the operation, * this field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * [Output Only] If the operation fails, this field contains the HTTP error * message that was returned, such as NOT FOUND. @@ -7303,7 +7571,11 @@ export namespace compute_beta { * [Output Only] If warning messages are generated during processing of the * operation, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; /** * [Output Only] The URL of the zone where the operation resides. Only * available when performing per-zone operations. You must specify this @@ -7321,7 +7593,7 @@ export namespace compute_beta { /** * [Output Only] A map of scoped operation lists. */ - items?: any; + items?: {[key: string]: Schema$OperationsScopedList;}; /** * [Output Only] Type of resource. Always compute#operationAggregatedList * for aggregated lists of operations. @@ -7342,7 +7614,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Operation resources. @@ -7377,7 +7653,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$OperationsScopedList { /** @@ -7388,7 +7668,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of operations * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A matcher for the path portion of the URL. The BackendService from the @@ -7750,7 +8034,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionDisksAddResourcePoliciesRequest { /** @@ -7799,7 +8087,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of InstanceGroup resources. @@ -7832,7 +8124,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of managed instance groups. @@ -7867,7 +8163,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionInstanceGroupManagersAbandonInstancesRequest { /** @@ -7956,7 +8256,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** @@ -8018,7 +8322,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionSetLabelsRequest { /** @@ -8033,7 +8341,7 @@ export namespace compute_beta { /** * The labels to set for this resource. */ - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$RegionSetPolicyRequest { /** @@ -8088,7 +8396,11 @@ export namespace compute_beta { * Informational warning which replaces the list of resourcePolicies when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ResourcePolicy { /** @@ -8138,7 +8450,7 @@ export namespace compute_beta { /** * A list of ResourcePolicy resources. */ - items?: any; + items?: {[key: string]: Schema$ResourcePoliciesScopedList;}; /** * Type of resource. */ @@ -8158,7 +8470,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A backup schedule policy specifies when and how frequently snapshots are to @@ -8218,7 +8534,7 @@ export namespace compute_beta { * Labels to apply to scheduled snapshots. These can be later modified by * the setLabels method. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; } /** * Time window specified for daily operations. @@ -8289,7 +8605,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Time window specified for weekly operations. @@ -8432,7 +8752,11 @@ export namespace compute_beta { * [Output Only] If potential misconfigurations are detected for this route, * this field will be populated with warning messages. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * Contains a list of Route resources. @@ -8465,7 +8789,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Router resource. @@ -8558,7 +8886,7 @@ export namespace compute_beta { /** * A list of Router resources. */ - items?: any; + items?: {[key: string]: Schema$RoutersScopedList;}; /** * Type of resource. */ @@ -8578,7 +8906,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RouterBgp { /** @@ -8735,7 +9067,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a Nat resource. It enables the VMs within the specified @@ -8838,7 +9174,11 @@ export namespace compute_beta { * Informational warning which replaces the list of routers when the list is * empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RouterStatus { /** @@ -9083,7 +9423,7 @@ export namespace compute_beta { * modified by the setLabels method. Each label key/value must comply with * RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -9131,7 +9471,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SecurityPolicyReference { securityPolicy?: string; @@ -9360,7 +9704,7 @@ export namespace compute_beta { * Labels to apply to this snapshot. These can be later modified by the * setLabels method. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output Only] Integer license codes indicating which licenses are * attached to this snapshot. @@ -9467,7 +9811,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A specification of the parameters to use when creating the instance @@ -9589,7 +9937,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Configuration and status of a managed SSL certificate. @@ -9604,7 +9956,7 @@ export namespace compute_beta { * [Output only] Detailed statuses of the domains specified for managed * certificate resource. */ - domainStatus?: any; + domainStatus?: {[key: string]: string;}; /** * [Output only] Status of the managed certificate resource. */ @@ -9696,7 +10048,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SslPoliciesListAvailableFeaturesResponse { features?: string[]; @@ -9775,7 +10131,11 @@ export namespace compute_beta { * [Output Only] If potential misconfigurations are detected for this SSL * policy, this field will be populated with warning messages. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } export interface Schema$SslPolicyReference { /** @@ -9898,7 +10258,7 @@ export namespace compute_beta { /** * A list of SubnetworksScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$SubnetworksScopedList;}; /** * [Output Only] Type of resource. Always compute#subnetworkAggregatedList * for aggregated lists of subnetworks. @@ -9919,7 +10279,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Subnetwork resources. @@ -9953,7 +10317,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a secondary IP range of a subnetwork. @@ -9992,7 +10360,11 @@ export namespace compute_beta { * An informational warning that appears when the list of addresses is * empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { privateIpGoogleAccess?: boolean; @@ -10093,7 +10465,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { /** @@ -10212,7 +10588,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A TargetInstance resource. This resource defines an endpoint instance that @@ -10283,7 +10663,7 @@ export namespace compute_beta { /** * A list of TargetInstance resources. */ - items?: any; + items?: {[key: string]: Schema$TargetInstancesScopedList;}; /** * Type of resource. */ @@ -10303,7 +10683,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of TargetInstance resources. @@ -10336,7 +10720,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetInstancesScopedList { /** @@ -10347,7 +10735,11 @@ export namespace compute_beta { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A TargetPool resource. This resource defines a pool of instances, an @@ -10453,7 +10845,7 @@ export namespace compute_beta { /** * A list of TargetPool resources. */ - items?: any; + items?: {[key: string]: Schema$TargetPoolsScopedList;}; /** * [Output Only] Type of resource. Always compute#targetPoolAggregatedList * for aggregated lists of target pools. @@ -10474,7 +10866,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; @@ -10516,7 +10912,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetPoolsAddHealthCheckRequest { /** @@ -10559,7 +10959,11 @@ export namespace compute_beta { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetReference { target?: string; @@ -10676,7 +11080,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetTcpProxiesSetBackendServiceRequest { /** @@ -10771,7 +11179,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a Target VPN gateway resource. (== resource_for @@ -10818,7 +11230,7 @@ export namespace compute_beta { * modified by the setLabels method. Each label key/value must comply with * RFC1035. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with RFC1035. @@ -10863,7 +11275,7 @@ export namespace compute_beta { /** * A list of TargetVpnGateway resources. */ - items?: any; + items?: {[key: string]: Schema$TargetVpnGatewaysScopedList;}; /** * [Output Only] Type of resource. Always compute#targetVpnGateway for * target VPN gateways. @@ -10884,7 +11296,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of TargetVpnGateway resources. @@ -10918,7 +11334,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetVpnGatewaysScopedList { /** @@ -10929,7 +11349,11 @@ export namespace compute_beta { * [Output Only] Informational warning which replaces the list of addresses * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TCPHealthCheck { /** @@ -11093,7 +11517,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$UrlMapReference { urlMap?: string; @@ -11198,7 +11626,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Secondary IP range of a usable subnetwork. @@ -11309,7 +11741,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for @@ -11357,7 +11793,7 @@ export namespace compute_beta { * setLabels method. Each label key/value pair must comply with RFC1035. * Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Local traffic selector to use when establishing the VPN tunnel with peer * VPN gateway. The value should be a CIDR formatted string, for example: @@ -11426,7 +11862,7 @@ export namespace compute_beta { /** * A list of VpnTunnelsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$VpnTunnelsScopedList;}; /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ @@ -11446,7 +11882,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of VpnTunnel resources. @@ -11479,7 +11919,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$VpnTunnelsScopedList { /** @@ -11490,7 +11934,11 @@ export namespace compute_beta { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$WafExpressionSet { /** @@ -11549,7 +11997,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Service resource (a.k.a service project) ID. @@ -11644,7 +12096,11 @@ export namespace compute_beta { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ZoneSetLabelsRequest { /** @@ -11659,7 +12115,7 @@ export namespace compute_beta { /** * The labels to set for this resource. */ - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$ZoneSetPolicyRequest { /** diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index faf19ea85e6..f63437df462 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -284,7 +284,7 @@ export namespace compute_v1 { /** * A list of AcceleratorTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AcceleratorTypesScopedList;}; /** * [Output Only] Type of resource. Always * compute#acceleratorTypeAggregatedList for aggregated lists of accelerator @@ -306,7 +306,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of accelerator types. @@ -340,7 +344,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AcceleratorTypesScopedList { /** @@ -351,7 +359,11 @@ export namespace compute_v1 { * [Output Only] An informational warning that appears when the accelerator * types list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An access configuration attached to an instance's network interface. @@ -494,7 +506,7 @@ export namespace compute_v1 { /** * A list of AddressesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AddressesScopedList;}; /** * [Output Only] Type of resource. Always compute#addressAggregatedList for * aggregated lists of addresses. @@ -515,7 +527,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AddressesScopedList { /** @@ -526,7 +542,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of addresses * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of addresses. @@ -560,7 +580,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An alias IP range attached to an instance's network interface. @@ -721,7 +745,7 @@ export namespace compute_v1 { * disks.setLabels method. This field is only applicable for persistent * disks. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The source image to create this disk. When creating a new instance, one * of initializeParams.sourceImage or disks.source is required except for @@ -831,7 +855,7 @@ export namespace compute_v1 { /** * A list of AutoscalersScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$AutoscalersScopedList;}; /** * [Output Only] Type of resource. Always compute#autoscalerAggregatedList * for aggregated lists of autoscalers. @@ -852,7 +876,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Autoscaler resources. @@ -886,7 +914,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AutoscalersScopedList { /** @@ -897,7 +929,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of * autoscalers when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$AutoscalerStatusDetails { /** @@ -1185,7 +1221,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A BackendService resource. This resource defines a group of backend virtual @@ -1330,7 +1370,7 @@ export namespace compute_v1 { /** * A list of BackendServicesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$BackendServicesScopedList;}; /** * Type of resource. */ @@ -1350,7 +1390,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Message containing Cloud CDN configuration for a backend service. @@ -1431,7 +1475,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$BackendServicesScopedList { /** @@ -1442,7 +1490,11 @@ export namespace compute_v1 { * Informational warning which replaces the list of backend services when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$CacheInvalidationRule { /** @@ -1574,7 +1626,7 @@ export namespace compute_v1 { /** * A list of CommitmentsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$CommitmentsScopedList;}; /** * [Output Only] Type of resource. Always compute#commitmentAggregatedList * for aggregated lists of commitments. @@ -1595,7 +1647,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Commitment resources. @@ -1629,7 +1685,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$CommitmentsScopedList { /** @@ -1640,7 +1700,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of * commitments when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Message containing connection draining configuration. @@ -1774,7 +1838,7 @@ export namespace compute_v1 { * Labels to apply to this disk. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output Only] Last attach timestamp in RFC3339 text format. */ @@ -1910,7 +1974,7 @@ export namespace compute_v1 { /** * A list of DisksScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$DisksScopedList;}; /** * [Output Only] Type of resource. Always compute#diskAggregatedList for * aggregated lists of persistent disks. @@ -1931,7 +1995,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A specification of the desired way to instantiate a disk in the instance @@ -2000,7 +2068,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DiskMoveRequest { /** @@ -2033,7 +2105,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of disks when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for @@ -2100,7 +2176,7 @@ export namespace compute_v1 { /** * A list of DiskTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$DiskTypesScopedList;}; /** * [Output Only] Type of resource. Always compute#diskTypeAggregatedList. */ @@ -2120,7 +2196,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of disk types. @@ -2154,7 +2234,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DiskTypesScopedList { /** @@ -2165,7 +2249,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of disk types * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$DistributionPolicy { /** @@ -2189,7 +2277,7 @@ export namespace compute_v1 { * The list of ALLOW rules specified by this firewall. Each rule specifies a * protocol and port-range tuple that describes a permitted connection. */ - allowed?: any[]; + allowed?: Array<{IPProtocol?: string; ports?: string[];}>; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -2198,7 +2286,7 @@ export namespace compute_v1 { * The list of DENY rules specified by this firewall. Each rule specifies a * protocol and port-range tuple that describes a denied connection. */ - denied?: any[]; + denied?: Array<{IPProtocol?: string; ports?: string[];}>; /** * An optional description of this resource. Provide this property when you * create the resource. @@ -2357,7 +2445,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A ForwardingRule resource. A ForwardingRule resource specifies which pool @@ -2528,7 +2620,7 @@ export namespace compute_v1 { /** * A list of ForwardingRulesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$ForwardingRulesScopedList;}; /** * [Output Only] Type of resource. Always * compute#forwardingRuleAggregatedList for lists of forwarding rules. @@ -2549,7 +2641,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of ForwardingRule resources. @@ -2582,7 +2678,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ForwardingRulesScopedList { /** @@ -2593,7 +2693,11 @@ export namespace compute_v1 { * Informational warning which replaces the list of forwarding rules when * the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$GlobalSetLabelsRequest { /** @@ -2615,7 +2719,7 @@ export namespace compute_v1 { * "webserver-frontend": "images". A label value can * also be empty (e.g. "my-label": ""). */ - labels?: any; + labels?: {[key: string]: string;}; } /** * Guest OS features. @@ -2728,7 +2832,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A full or valid partial URL to a health check. For example, the following @@ -2921,7 +3029,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An HttpsHealthCheck resource. This resource defines a template for how @@ -3063,7 +3175,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Image resource. (== resource_for beta.images ==) (== resource_for @@ -3137,7 +3253,7 @@ export namespace compute_v1 { * Labels to apply to this image. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Integer license codes indicating which licenses are attached to this * image. @@ -3160,7 +3276,7 @@ export namespace compute_v1 { /** * The parameters of the raw disk image. */ - rawDisk?: any; + rawDisk?: {containerType?: string; sha1Checksum?: string; source?: string;}; /** * [Output Only] Server-defined URL for the resource. */ @@ -3265,7 +3381,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Instance resource. (== resource_for beta.instances ==) (== resource_for @@ -3329,7 +3449,7 @@ export namespace compute_v1 { * Labels to apply to this instance. These can be later modified by the * setLabels method. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Full or partial URL of the machine type resource to use for this * instance, in the format: zones/zone/machineTypes/machine-type. This is @@ -3428,7 +3548,7 @@ export namespace compute_v1 { /** * A list of InstancesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstancesScopedList;}; /** * [Output Only] Type of resource. Always compute#instanceAggregatedList for * aggregated lists of Instance resources. @@ -3449,7 +3569,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for @@ -3534,7 +3658,7 @@ export namespace compute_v1 { /** * A list of InstanceGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstanceGroupsScopedList;}; /** * [Output Only] The resource type, which is always * compute#instanceGroupAggregatedList for aggregated lists of instance @@ -3556,7 +3680,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A list of InstanceGroup resources. @@ -3590,7 +3718,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Instance Group Manager resource. (== resource_for @@ -3760,7 +3892,7 @@ export namespace compute_v1 { /** * A list of InstanceGroupManagersScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InstanceGroupManagersScopedList;}; /** * [Output Only] The resource type, which is always * compute#instanceGroupManagerAggregatedList for an aggregated list of @@ -3782,7 +3914,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * [Output Only] A list of managed instance groups. @@ -3816,7 +3952,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** @@ -3855,7 +3995,11 @@ export namespace compute_v1 { * [Output Only] The warning that replaces the list of managed instance * groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupManagersSetInstanceTemplateRequest { /** @@ -3919,7 +4063,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupsListInstancesRequest { /** @@ -3945,7 +4093,11 @@ export namespace compute_v1 { * [Output Only] An informational warning that replaces the list of instance * groups when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceGroupsSetNamedPortsRequest { /** @@ -3994,7 +4146,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of instance referrers. @@ -4028,7 +4184,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceMoveRequest { /** @@ -4075,7 +4235,7 @@ export namespace compute_v1 { /** * Labels to apply to instances that are created from this template. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The machine type to use for instances that are created from this * template. @@ -4134,7 +4294,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of instances * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstancesSetLabelsRequest { /** @@ -4143,7 +4307,7 @@ export namespace compute_v1 { * request to add or change labels. */ labelFingerprint?: string; - labels?: any; + labels?: {[key: string]: string;}; } export interface Schema$InstancesSetMachineResourcesRequest { /** @@ -4275,7 +4439,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$InstanceWithNamedPorts { /** @@ -4571,7 +4739,7 @@ export namespace compute_v1 { /** * A list of InterconnectAttachmentsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$InterconnectAttachmentsScopedList;}; /** * [Output Only] Type of resource. Always * compute#interconnectAttachmentAggregatedList for aggregated lists of @@ -4593,7 +4761,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Response to the list request, and contains a list of interconnect @@ -4628,7 +4800,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Informational metadata about Partner attachments from Partners to display @@ -4674,7 +4850,11 @@ export namespace compute_v1 { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Describes a single physical circuit between the Customer and Google. @@ -4799,7 +4979,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents an InterconnectLocations resource. The InterconnectLocations @@ -4909,7 +5093,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Information about any potential InterconnectAttachments between an @@ -5117,7 +5305,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Machine Type resource. (== resource_for v1.machineTypes ==) (== @@ -5181,7 +5373,7 @@ export namespace compute_v1 { /** * [Output Only] A list of extended scratch disks assigned to the instance. */ - scratchDisks?: any[]; + scratchDisks?: Array<{diskGb?: number;}>; /** * [Output Only] Server-defined URL for the resource. */ @@ -5200,7 +5392,7 @@ export namespace compute_v1 { /** * A list of MachineTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$MachineTypesScopedList;}; /** * [Output Only] Type of resource. Always compute#machineTypeAggregatedList * for aggregated lists of machine types. @@ -5221,7 +5413,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of machine types. @@ -5255,7 +5451,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$MachineTypesScopedList { /** @@ -5266,7 +5466,11 @@ export namespace compute_v1 { * [Output Only] An informational warning that appears when the machine * types list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Managed Instance resource. @@ -5321,7 +5525,9 @@ export namespace compute_v1 { * [Output Only] Encountered errors during the last attempt to create or * delete the instance. */ - errors?: any; + errors?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; } /** * A metadata key/value entry. @@ -5341,7 +5547,7 @@ export namespace compute_v1 { * Array of key/value pairs. The total size of all keys and values must be * less than 512 KB. */ - items?: any[]; + items?: Array<{key?: string; value?: string;}>; /** * [Output Only] Type of the resource. Always compute#metadata for metadata. */ @@ -5529,7 +5735,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A network peering attached to a network resource. The message includes the @@ -5668,7 +5878,7 @@ export namespace compute_v1 { /** * A list of NodeGroupsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeGroupsScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for * aggregated lists of node groups. @@ -5689,7 +5899,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of nodeGroups. @@ -5723,7 +5937,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupNode { /** @@ -5779,7 +5997,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupsScopedList { /** @@ -5790,7 +6012,11 @@ export namespace compute_v1 { * [Output Only] An informational warning that appears when the nodeGroup * list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** @@ -5836,7 +6062,7 @@ export namespace compute_v1 { * Labels to use for node affinity, which will be used in instance * scheduling. */ - nodeAffinityLabels?: any; + nodeAffinityLabels?: {[key: string]: string;}; /** * The node type to use for nodes group that are created from this template. */ @@ -5875,7 +6101,7 @@ export namespace compute_v1 { /** * A list of NodeTemplatesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeTemplatesScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList * for aggregated lists of node templates. @@ -5896,7 +6122,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of node templates. @@ -5930,7 +6160,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeTemplateNodeTypeFlexibility { cpus?: string; @@ -5946,7 +6180,11 @@ export namespace compute_v1 { * [Output Only] An informational warning that appears when the node * templates list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A Node Type resource. @@ -6014,7 +6252,7 @@ export namespace compute_v1 { /** * A list of NodeTypesScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$NodeTypesScopedList;}; /** * [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for * aggregated lists of node types. @@ -6035,7 +6273,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of node types. @@ -6069,7 +6311,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$NodeTypesScopedList { /** @@ -6080,7 +6326,11 @@ export namespace compute_v1 { * [Output Only] An informational warning that appears when the node types * list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * An Operation resource, used to manage asynchronous API requests. (== @@ -6113,7 +6363,9 @@ export namespace compute_v1 { * [Output Only] If errors are generated during processing of the operation, * this field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * [Output Only] If the operation fails, this field contains the HTTP error * message that was returned, such as NOT FOUND. @@ -6203,7 +6455,11 @@ export namespace compute_v1 { * [Output Only] If warning messages are generated during processing of the * operation, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; /** * [Output Only] The URL of the zone where the operation resides. Only * available when performing per-zone operations. You must specify this @@ -6221,7 +6477,7 @@ export namespace compute_v1 { /** * [Output Only] A map of scoped operation lists. */ - items?: any; + items?: {[key: string]: Schema$OperationsScopedList;}; /** * [Output Only] Type of resource. Always compute#operationAggregatedList * for aggregated lists of operations. @@ -6242,7 +6498,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Operation resources. @@ -6277,7 +6537,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$OperationsScopedList { /** @@ -6288,7 +6552,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of operations * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A matcher for the path portion of the URL. The BackendService from the @@ -6587,7 +6855,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionDisksResizeRequest { /** @@ -6624,7 +6896,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of InstanceGroup resources. @@ -6657,7 +6933,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of managed instance groups. @@ -6692,7 +6972,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionInstanceGroupManagersAbandonInstancesRequest { /** @@ -6770,7 +7054,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionInstanceGroupsListInstancesRequest { /** @@ -6832,7 +7120,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RegionSetLabelsRequest { /** @@ -6847,7 +7139,7 @@ export namespace compute_v1 { /** * The labels to set for this resource. */ - labels?: any; + labels?: {[key: string]: string;}; } /** * Commitment for a particular resource (a Commitment is composed of one or @@ -6979,7 +7271,11 @@ export namespace compute_v1 { * [Output Only] If potential misconfigurations are detected for this route, * this field will be populated with warning messages. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * Contains a list of Route resources. @@ -7012,7 +7308,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Router resource. @@ -7105,7 +7405,7 @@ export namespace compute_v1 { /** * A list of Router resources. */ - items?: any; + items?: {[key: string]: Schema$RoutersScopedList;}; /** * Type of resource. */ @@ -7125,7 +7425,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RouterBgp { /** @@ -7282,7 +7586,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a Nat resource. It enables the VMs within the specified @@ -7385,7 +7693,11 @@ export namespace compute_v1 { * Informational warning which replaces the list of routers when the list is * empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$RouterStatus { /** @@ -7617,7 +7929,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SecurityPolicyReference { securityPolicy?: string; @@ -7788,7 +8104,7 @@ export namespace compute_v1 { * Labels to apply to this snapshot. These can be later modified by the * setLabels method. Label values may be empty. */ - labels?: any; + labels?: {[key: string]: string;}; /** * [Output Only] Integer license codes indicating which licenses are * attached to this snapshot. @@ -7891,7 +8207,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A specification of the parameters to use when creating the instance @@ -7989,7 +8309,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SSLHealthCheck { /** @@ -8050,7 +8374,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SslPoliciesListAvailableFeaturesResponse { features?: string[]; @@ -8129,7 +8457,11 @@ export namespace compute_v1 { * [Output Only] If potential misconfigurations are detected for this SSL * policy, this field will be populated with warning messages. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } export interface Schema$SslPolicyReference { /** @@ -8238,7 +8570,7 @@ export namespace compute_v1 { /** * A list of SubnetworksScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$SubnetworksScopedList;}; /** * [Output Only] Type of resource. Always compute#subnetworkAggregatedList * for aggregated lists of subnetworks. @@ -8259,7 +8591,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of Subnetwork resources. @@ -8293,7 +8629,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a secondary IP range of a subnetwork. @@ -8332,7 +8672,11 @@ export namespace compute_v1 { * An informational warning that appears when the list of addresses is * empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$SubnetworksSetPrivateIpGoogleAccessRequest { privateIpGoogleAccess?: boolean; @@ -8433,7 +8777,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetHttpsProxiesSetQuicOverrideRequest { /** @@ -8552,7 +8900,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A TargetInstance resource. This resource defines an endpoint instance that @@ -8623,7 +8975,7 @@ export namespace compute_v1 { /** * A list of TargetInstance resources. */ - items?: any; + items?: {[key: string]: Schema$TargetInstancesScopedList;}; /** * Type of resource. */ @@ -8643,7 +8995,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of TargetInstance resources. @@ -8676,7 +9032,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetInstancesScopedList { /** @@ -8687,7 +9047,11 @@ export namespace compute_v1 { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * A TargetPool resource. This resource defines a pool of instances, an @@ -8793,7 +9157,7 @@ export namespace compute_v1 { /** * A list of TargetPool resources. */ - items?: any; + items?: {[key: string]: Schema$TargetPoolsScopedList;}; /** * [Output Only] Type of resource. Always compute#targetPoolAggregatedList * for aggregated lists of target pools. @@ -8814,7 +9178,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetPoolInstanceHealth { healthStatus?: Schema$HealthStatus[]; @@ -8856,7 +9224,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetPoolsAddHealthCheckRequest { /** @@ -8899,7 +9271,11 @@ export namespace compute_v1 { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetReference { target?: string; @@ -9016,7 +9392,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetTcpProxiesSetBackendServiceRequest { /** @@ -9111,7 +9491,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Represents a Target VPN gateway resource. (== resource_for @@ -9187,7 +9571,7 @@ export namespace compute_v1 { /** * A list of TargetVpnGateway resources. */ - items?: any; + items?: {[key: string]: Schema$TargetVpnGatewaysScopedList;}; /** * [Output Only] Type of resource. Always compute#targetVpnGateway for * target VPN gateways. @@ -9208,7 +9592,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of TargetVpnGateway resources. @@ -9242,7 +9630,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TargetVpnGatewaysScopedList { /** @@ -9253,7 +9645,11 @@ export namespace compute_v1 { * [Output Only] Informational warning which replaces the list of addresses * when the list is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$TCPHealthCheck { /** @@ -9406,7 +9802,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$UrlMapReference { urlMap?: string; @@ -9511,7 +9911,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Secondary IP range of a usable subnetwork. @@ -9622,7 +10026,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for @@ -9724,7 +10132,7 @@ export namespace compute_v1 { /** * A list of VpnTunnelsScopedList resources. */ - items?: any; + items?: {[key: string]: Schema$VpnTunnelsScopedList;}; /** * [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. */ @@ -9744,7 +10152,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Contains a list of VpnTunnel resources. @@ -9777,7 +10189,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$VpnTunnelsScopedList { /** @@ -9788,7 +10204,11 @@ export namespace compute_v1 { * Informational warning which replaces the list of addresses when the list * is empty. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$XpnHostList { /** @@ -9819,7 +10239,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } /** * Service resource (a.k.a service project) ID. @@ -9914,7 +10338,11 @@ export namespace compute_v1 { /** * [Output Only] Informational warning message. */ - warning?: any; + warning?: { + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }; } export interface Schema$ZoneSetLabelsRequest { /** @@ -9929,7 +10357,7 @@ export namespace compute_v1 { /** * The labels to set for this resource. */ - labels?: any; + labels?: {[key: string]: string;}; } diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 00a390645dc..44be910e092 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -83,9 +83,8 @@ export namespace container_v1 { /** * Kubernetes Engine API * - * The Google Kubernetes Engine API is used for building and managing - * container based applications, powered by the open source Kubernetes - * technology. + * Builds and manages container-based applications, powered by the open source + * Kubernetes technology. * * @example * const {google} = require('googleapis'); @@ -239,6 +238,10 @@ export namespace container_v1 { * chosen or specify a `/14` block in `10.0.0.0/8`. */ clusterIpv4Cidr?: string; + /** + * Which conditions caused the current cluster state. + */ + conditions?: Schema$StatusCondition[]; /** * [Output only] The time the cluster was created, in * [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -249,7 +252,8 @@ export namespace container_v1 { */ currentMasterVersion?: string; /** - * [Output only] The number of nodes currently in the cluster. + * [Output only] The number of nodes currently in the cluster. Deprecated. + * Call Kubernetes API directly to retrieve node information. */ currentNodeCount?: number; /** @@ -334,9 +338,8 @@ export namespace container_v1 { */ location?: string; /** - * The list of Google Compute Engine - * [locations](/compute/docs/zones#available) in which the cluster's - * nodes should be located. + * The list of Google Compute Engine [zones](/compute/docs/zones#available) + * in which the cluster's nodes should be located. */ locations?: string[]; /** @@ -351,7 +354,11 @@ export namespace container_v1 { */ maintenancePolicy?: Schema$MaintenancePolicy; /** - * The authentication information for accessing the master endpoint. + * The authentication information for accessing the master endpoint. If + * unspecified, the defaults are used: For clusters before v1.12, if + * master_auth is unspecified, `username` will be set to "admin", + * a random password will be generated, and a client certificate will be + * issued. */ masterAuth?: Schema$MasterAuth; /** @@ -419,7 +426,7 @@ export namespace container_v1 { * The resource labels for the cluster to use to annotate any related Google * Compute Engine resources. */ - resourceLabels?: any; + resourceLabels?: {[key: string]: string;}; /** * [Output only] Server-defined URL for the resource. */ @@ -471,11 +478,11 @@ export namespace container_v1 { desiredImageType?: string; /** * The desired list of Google Compute Engine - * [locations](/compute/docs/zones#available) in which the cluster's - * nodes should be located. Changing the locations a cluster is in will - * result in nodes being either created or removed from the cluster, - * depending on whether locations are being added or removed. This list - * must always include the cluster's primary zone. + * [zones](/compute/docs/zones#available) in which the cluster's nodes + * should be located. Changing the locations a cluster is in will result in + * nodes being either created or removed from the cluster, depending on + * whether locations are being added or removed. This list must always + * include the cluster's primary zone. */ desiredLocations?: string[]; /** @@ -866,8 +873,8 @@ export namespace container_v1 { password?: string; /** * The username to use for HTTP basic authentication to the master endpoint. - * For clusters v1.6.0 and later, you can disable basic authentication by - * providing an empty username. + * For clusters v1.6.0 and later, basic authentication can be disabled by + * leaving username unspecified (or setting it to the empty string). */ username?: string; } @@ -967,7 +974,7 @@ export namespace container_v1 { * For more information, including usage and the valid values, see: * https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ */ - labels?: any; + labels?: {[key: string]: string;}; /** * The number of local SSD disks to be attached to the node. The limit for * this value is dependant upon the maximum number of disks available on a @@ -998,7 +1005,7 @@ export namespace container_v1 { * that each value's size must be less than or equal to 32 KB. The * total size of all keys and values must be less than 512 KB. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * Minimum CPU platform to be used by this instance. The instance may be * scheduled on the specified or newer CPU platform. Applicable values are @@ -1042,6 +1049,12 @@ export namespace container_v1 { * must comply with RFC1035. */ tags?: string[]; + /** + * List of kubernetes taints to be applied to each node. For more + * information, including usage and the valid values, see: + * https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + */ + taints?: Schema$NodeTaint[]; } /** * NodeManagement defines the set of node management services turned on for @@ -1080,6 +1093,10 @@ export namespace container_v1 { * a valid configuration is present. */ autoscaling?: Schema$NodePoolAutoscaling; + /** + * Which conditions caused the current node pool state. + */ + conditions?: Schema$StatusCondition[]; /** * The node configuration of the pool. */ @@ -1143,11 +1160,36 @@ export namespace container_v1 { */ minNodeCount?: number; } + /** + * Kubernetes taint is comprised of three fields: key, value, and effect. + * Effect can only be one of three types: NoSchedule, PreferNoSchedule or + * NoExecute. For more information, including usage and the valid values, + * see: + * https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + */ + export interface Schema$NodeTaint { + /** + * Effect for taint. + */ + effect?: string; + /** + * Key for taint. + */ + key?: string; + /** + * Value for taint. + */ + value?: string; + } /** * This operation resource represents operations that may have happened or are * happening on the cluster. All fields are output only. */ export interface Schema$Operation { + /** + * Which conditions caused the current cluster state. + */ + clusterConditions?: Schema$StatusCondition[]; /** * Detailed operation progress, if available. */ @@ -1168,6 +1210,10 @@ export namespace container_v1 { * The server-assigned ID for the operation. */ name?: string; + /** + * Which conditions caused the current node pool state. + */ + nodepoolConditions?: Schema$StatusCondition[]; /** * The operation type. */ @@ -1359,7 +1405,7 @@ export namespace container_v1 { /** * The labels to set for that cluster. */ - resourceLabels?: any; + resourceLabels?: {[key: string]: string;}; /** * Deprecated. The name of the Google Compute Engine * [zone](/compute/docs/zones#available) in which the cluster resides. This @@ -1411,11 +1457,11 @@ export namespace container_v1 { clusterId?: string; /** * The desired list of Google Compute Engine - * [locations](/compute/docs/zones#available) in which the cluster's - * nodes should be located. Changing the locations a cluster is in will - * result in nodes being either created or removed from the cluster, - * depending on whether locations are being added or removed. This list - * must always include the cluster's primary zone. + * [zones](/compute/docs/zones#available) in which the cluster's nodes + * should be located. Changing the locations a cluster is in will result in + * nodes being either created or removed from the cluster, depending on + * whether locations are being added or removed. This list must always + * include the cluster's primary zone. */ locations?: string[]; /** @@ -1746,6 +1792,20 @@ export namespace container_v1 { */ zone?: string; } + /** + * StatusCondition describes why a cluster or a node pool has a certain status + * (e.g., ERROR or DEGRADED). + */ + export interface Schema$StatusCondition { + /** + * Machine-friendly representation of the condition + */ + code?: string; + /** + * Human-friendly representation of the condition + */ + message?: string; + } /** * UpdateClusterRequest updates the settings of a cluster. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 809414d5d27..9863fc2140d 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -83,9 +83,8 @@ export namespace container_v1beta1 { /** * Kubernetes Engine API * - * The Google Kubernetes Engine API is used for building and managing - * container based applications, powered by the open source Kubernetes - * technology. + * Builds and manages container-based applications, powered by the open source + * Kubernetes technology. * * @example * const {google} = require('googleapis'); @@ -271,7 +270,8 @@ export namespace container_v1beta1 { */ currentMasterVersion?: string; /** - * [Output only] The number of nodes currently in the cluster. + * [Output only] The number of nodes currently in the cluster. Deprecated. + * Call Kubernetes API directly to retrieve node information. */ currentNodeCount?: number; /** @@ -366,9 +366,8 @@ export namespace container_v1beta1 { */ location?: string; /** - * The list of Google Compute Engine - * [locations](/compute/docs/zones#available) in which the cluster's - * nodes should be located. + * The list of Google Compute Engine [zones](/compute/docs/zones#available) + * in which the cluster's nodes should be located. */ locations?: string[]; /** @@ -383,7 +382,11 @@ export namespace container_v1beta1 { */ maintenancePolicy?: Schema$MaintenancePolicy; /** - * The authentication information for accessing the master endpoint. + * The authentication information for accessing the master endpoint. If + * unspecified, the defaults are used: For clusters before v1.12, if + * master_auth is unspecified, `username` will be set to "admin", + * a random password will be generated, and a client certificate will be + * issued. */ masterAuth?: Schema$MasterAuth; /** @@ -469,7 +472,7 @@ export namespace container_v1beta1 { * The resource labels for the cluster to use to annotate any related Google * Compute Engine resources. */ - resourceLabels?: any; + resourceLabels?: {[key: string]: string;}; /** * [Output only] Server-defined URL for the resource. */ @@ -503,6 +506,10 @@ export namespace container_v1beta1 { * notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string; + /** + * Cluster-level Vertical Pod Autoscaling configuration. + */ + verticalPodAutoscaling?: Schema$VerticalPodAutoscaling; /** * [Output only] The name of the Google Compute Engine * [zone](/compute/docs/zones#available) in which the cluster resides. This @@ -551,11 +558,11 @@ export namespace container_v1beta1 { desiredImageType?: string; /** * The desired list of Google Compute Engine - * [locations](/compute/docs/zones#available) in which the cluster's - * nodes should be located. Changing the locations a cluster is in will - * result in nodes being either created or removed from the cluster, - * depending on whether locations are being added or removed. This list - * must always include the cluster's primary zone. + * [zones](/compute/docs/zones#available) in which the cluster's nodes + * should be located. Changing the locations a cluster is in will result in + * nodes being either created or removed from the cluster, depending on + * whether locations are being added or removed. This list must always + * include the cluster's primary zone. */ desiredLocations?: string[]; /** @@ -621,6 +628,10 @@ export namespace container_v1beta1 { * The desired configuration options for the PodSecurityPolicy feature. */ desiredPodSecurityPolicyConfig?: Schema$PodSecurityPolicyConfig; + /** + * Cluster-level Vertical Pod Autoscaling configuration. + */ + desiredVerticalPodAutoscaling?: Schema$VerticalPodAutoscaling; } /** * CompleteIPRotationRequest moves the cluster master back into single-IP @@ -1040,8 +1051,8 @@ export namespace container_v1beta1 { password?: string; /** * The username to use for HTTP basic authentication to the master endpoint. - * For clusters v1.6.0 and later, you can disable basic authentication by - * providing an empty username. + * For clusters v1.6.0 and later, basic authentication can be disabled by + * leaving username unspecified (or setting it to the empty string). */ username?: string; } @@ -1172,7 +1183,7 @@ export namespace container_v1beta1 { * For more information, including usage and the valid values, see: * https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ */ - labels?: any; + labels?: {[key: string]: string;}; /** * The number of local SSD disks to be attached to the node. The limit for * this value is dependant upon the maximum number of disks available on a @@ -1203,7 +1214,7 @@ export namespace container_v1beta1 { * that each value's size must be less than or equal to 32 KB. The * total size of all keys and values must be less than 512 KB. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * Minimum CPU platform to be used by this instance. The instance may be * scheduled on the specified or newer CPU platform. Applicable values are @@ -1669,7 +1680,7 @@ export namespace container_v1beta1 { /** * The labels to set for that cluster. */ - resourceLabels?: any; + resourceLabels?: {[key: string]: string;}; /** * Deprecated. The name of the Google Compute Engine * [zone](/compute/docs/zones#available) in which the cluster resides. This @@ -1721,11 +1732,11 @@ export namespace container_v1beta1 { clusterId?: string; /** * The desired list of Google Compute Engine - * [locations](/compute/docs/zones#available) in which the cluster's - * nodes should be located. Changing the locations a cluster is in will - * result in nodes being either created or removed from the cluster, - * depending on whether locations are being added or removed. This list - * must always include the cluster's primary zone. + * [zones](/compute/docs/zones#available) in which the cluster's nodes + * should be located. Changing the locations a cluster is in will result in + * nodes being either created or removed from the cluster, depending on + * whether locations are being added or removed. This list must always + * include the cluster's primary zone. */ locations?: string[]; /** @@ -2236,6 +2247,17 @@ export namespace container_v1beta1 { */ status?: string; } + /** + * VerticalPodAutoscaling contains global, per-cluster information required by + * Vertical Pod Autoscaler to automatically adjust the resources of pods + * controlled by it. + */ + export interface Schema$VerticalPodAutoscaling { + /** + * Enables vertical pod autoscaling. + */ + enabled?: boolean; + } /** * WorkloadMetadataConfig defines the metadata configuration to expose to * workloads on the node pool. diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index b83925d628a..68313d0403c 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -3601,13 +3601,14 @@ export namespace content_v2 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. Acceptable values are: - + * The carrier handling the shipment. Acceptable values for US are: - * "gsx" - "ups" - "usps" - * "fedex" - "dhl" - "ecourier" - * "cxt" - "google" - "ontrac" - * "emsy" - "ont" - "deliv" - * "dynamex" - "lasership" - "mpx" - - * "uds" + * "uds" Acceptable values for FR are: - + * "colissimo" - "chronopost" */ carrier?: string; /** @@ -4936,8 +4937,7 @@ export namespace content_v2 { } export interface Schema$ProductShippingDimension { /** - * The unit of value. Acceptable values are: - "cm" - - * "in" + * The unit of value. */ unit?: string; /** @@ -6949,7 +6949,7 @@ export namespace content_v2 { * If set, only issues for the specified destinations are returned, * otherwise only issues for the Shopping destination. */ - destinations?: string; + destinations?: string[]; /** * The ID of the managing account. If this parameter is not the same as * accountId, then this account must be a multi-client account and accountId @@ -6968,7 +6968,7 @@ export namespace content_v2 { * If set, only issues for the specified destinations are returned, * otherwise only issues for the Shopping destination. */ - destinations?: string; + destinations?: string[]; /** * The maximum number of account statuses to return in the response, used * for paging. @@ -12907,7 +12907,7 @@ export namespace content_v2 { * completed is a shortcut for shipped , partiallyDelivered, delivered, * partiallyReturned, returned, and canceled. */ - statuses?: string; + statuses?: string[]; } export interface Params$Resource$Orders$Refund extends StandardParameters { /** @@ -14463,7 +14463,7 @@ export namespace content_v2 { * If set, only issues for the specified destinations are returned, * otherwise only issues for the Shopping destination. */ - destinations?: string; + destinations?: string[]; /** * Flag to include full product data in the result of this get request. The * default value is false. @@ -14490,7 +14490,7 @@ export namespace content_v2 { * If set, only issues for the specified destinations are returned, * otherwise only issues for the Shopping destination. */ - destinations?: string; + destinations?: string[]; /** * Flag to include full product data in the results of the list request. The * default value is false. diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index b804030ba79..42be1791b18 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -99,14 +99,16 @@ export namespace customsearch_v1 { } export interface Schema$Context { - facets?: any[][]; + facets?: Array< + Array<{anchor?: string; label?: string; label_with_op?: string;}>>; title?: string; } export interface Schema$Promotion { - bodyLines?: any[]; + bodyLines?: Array< + {htmlTitle?: string; link?: string; title?: string; url?: string;}>; displayLink?: string; htmlTitle?: string; - image?: any; + image?: {height?: number; source?: string; width?: number;}; link?: string; title?: string; } @@ -156,12 +158,21 @@ export namespace customsearch_v1 { htmlFormattedUrl?: string; htmlSnippet?: string; htmlTitle?: string; - image?: any; + image?: { + byteSize?: number; + contextLink?: string; + height?: number; + thumbnailHeight?: number; + thumbnailLink?: string; + thumbnailWidth?: number; + width?: number; + }; kind?: string; - labels?: any[]; + labels?: + Array<{displayName?: string; label_with_op?: string; name?: string;}>; link?: string; mime?: string; - pagemap?: any; + pagemap?: {[key: string]: Array<{[key: string]: any;}>;}; snippet?: string; title?: string; } @@ -170,10 +181,15 @@ export namespace customsearch_v1 { items?: Schema$Result[]; kind?: string; promotions?: Schema$Promotion[]; - queries?: any; - searchInformation?: any; - spelling?: any; - url?: any; + queries?: {[key: string]: Schema$Query[];}; + searchInformation?: { + formattedSearchTime?: string; + formattedTotalResults?: string; + searchTime?: number; + totalResults?: string; + }; + spelling?: {correctedQuery?: string; htmlCorrectedQuery?: string;}; + url?: {template?: string; type?: string;}; } diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 73fbe398eda..233992ada44 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -559,7 +559,7 @@ export namespace dataflow_v1b3 { /** * The runtime parameters to pass to the job. */ - parameters?: any; + parameters?: {[key: string]: string;}; } /** * Identifies the location of a custom souce. @@ -780,14 +780,14 @@ export namespace dataflow_v1b3 { /** * Experimental settings. */ - internalExperiments?: any; + internalExperiments?: {[key: string]: any;}; /** * The Cloud Dataflow SDK pipeline options specified by the user. These * options are passed through the service and are used to recreate the SDK * pipeline options on the worker in a language agnostic and platform * independent way. */ - sdkPipelineOptions?: any; + sdkPipelineOptions?: {[key: string]: any;}; /** * Identity to run virtual machines as. Defaults to the default account. */ @@ -806,12 +806,12 @@ export namespace dataflow_v1b3 { /** * A description of the process that generated the request. */ - userAgent?: any; + userAgent?: {[key: string]: any;}; /** * A structure describing which components and their versions of the service * are required in order to run the job. */ - version?: any; + version?: {[key: string]: any;}; /** * The worker pools. At least one "harness" worker pool must be * specified in order for the job to have workers. @@ -1007,7 +1007,7 @@ export namespace dataflow_v1b3 { /** * The codec to use to encode data being written via this output. */ - codec?: any; + codec?: {[key: string]: any;}; /** * The user-provided name of this output. */ @@ -1082,6 +1082,11 @@ export namespace dataflow_v1b3 { * that case, the service ignores it. */ clientRequestId?: string; + /** + * If this is specified, the job's initial state is populated from the + * given snapshot. + */ + createdFromSnapshotId?: string; /** * The timestamp when the job was initially created. Immutable and set by * the Cloud Dataflow service. @@ -1128,7 +1133,7 @@ export namespace dataflow_v1b3 { * [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally * constrained to be <= 128 bytes in size. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The location that contains this job. */ @@ -1188,9 +1193,14 @@ export namespace dataflow_v1b3 { */ startTime?: string; /** - * The top-level steps that constitute the entire job. + * Exactly one of step or steps_location should be specified. The top-level + * steps that constitute the entire job. */ steps?: Schema$Step[]; + /** + * The GCS location where the steps are stored. + */ + stepsLocation?: string; /** * A set of files the system should be aware of that are used for temporary * storage. These temporary files will be removed on job completion. No @@ -1204,7 +1214,7 @@ export namespace dataflow_v1b3 { * The map of transform name prefixes of the job to be replaced to the * corresponding name prefixes of the new job. */ - transformNameMapping?: any; + transformNameMapping?: {[key: string]: string;}; /** * The type of Cloud Dataflow job. */ @@ -1218,7 +1228,7 @@ export namespace dataflow_v1b3 { /** * A mapping from each stage to the information about that stage. */ - stages?: any; + stages?: {[key: string]: Schema$JobExecutionStageInfo;}; } /** * Contains information about how a particular google.dataflow.v1beta3.Step @@ -1372,7 +1382,7 @@ export namespace dataflow_v1b3 { /** * The runtime parameters to pass to the job. */ - parameters?: any; + parameters?: {[key: string]: string;}; } /** * Response to the request to launch a template. @@ -1512,7 +1522,7 @@ export namespace dataflow_v1b3 { * PCollections in the SDK will have context['pcollection'] = * <pcollection-name>. */ - context?: any; + context?: {[key: string]: string;}; /** * Worker-defined metric name. */ @@ -1754,7 +1764,7 @@ export namespace dataflow_v1b3 { /** * The user function to invoke. */ - userFn?: any; + userFn?: {[key: string]: any;}; } /** * An instruction that does a partial group-by-key. One input and one output. @@ -1767,7 +1777,7 @@ export namespace dataflow_v1b3 { /** * The codec to use for interpreting an element in the input PTable. */ - inputElementCodec?: any; + inputElementCodec?: {[key: string]: any;}; /** * If this instruction includes a combining function this is the name of the * intermediate store between the GBK and the CombineValues. @@ -1785,7 +1795,7 @@ export namespace dataflow_v1b3 { /** * The value combining function to invoke. */ - valueCombiningFn?: any; + valueCombiningFn?: {[key: string]: any;}; } /** * A descriptive representation of submitted pipeline as well as the executed @@ -2113,7 +2123,7 @@ export namespace dataflow_v1b3 { /** * The user function to invoke. */ - userFn?: any; + userFn?: {[key: string]: any;}; } /** * Information about an output of a SeqMapTask. @@ -2148,7 +2158,7 @@ export namespace dataflow_v1b3 { /** * How to interpret the source element(s) as a side input value. */ - kind?: any; + kind?: {[key: string]: any;}; /** * The source(s) to read element(s) from to get the value of this side * input. If more than one source, then the elements are taken from the @@ -2169,11 +2179,49 @@ export namespace dataflow_v1b3 { /** * The codec to use to encode data written to the sink. */ - codec?: any; + codec?: {[key: string]: any;}; /** * The sink to write to, plus its parameters. */ - spec?: any; + spec?: {[key: string]: any;}; + } + /** + * Represents a snapshot of a job. + */ + export interface Schema$Snapshot { + /** + * The time this snapshot was created. + */ + creationTime?: string; + /** + * The unique ID of this snapshot. + */ + id?: string; + /** + * The project this snapshot belongs to. + */ + projectId?: string; + /** + * The job this snapshot was created from. + */ + sourceJobId?: string; + /** + * The time after which this snapshot will be automatically deleted. + */ + ttl?: string; + } + /** + * Request to create a snapshot of a job. + */ + export interface Schema$SnapshotJobRequest { + /** + * The location that contains this job. + */ + location?: string; + /** + * TTL for the snapshot. + */ + ttl?: string; } /** * A source that records can be read and decoded from. @@ -2188,11 +2236,11 @@ export namespace dataflow_v1b3 { * order: base_specs (later items win), spec (overrides anything in * base_specs). */ - baseSpecs?: any[]; + baseSpecs?: Array<{[key: string]: any;}>; /** * The codec to use to decode data read from the source. */ - codec?: any; + codec?: {[key: string]: any;}; /** * Setting this value to true hints to the framework that the source * doesn't need splitting, and using SourceSplitRequest on it would @@ -2219,7 +2267,7 @@ export namespace dataflow_v1b3 { /** * The source to read from, plus its parameters. */ - spec?: any; + spec?: {[key: string]: any;}; } /** * DEPRECATED in favor of DynamicSourceSplit. @@ -2515,7 +2563,7 @@ export namespace dataflow_v1b3 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -2552,7 +2600,7 @@ export namespace dataflow_v1b3 { * has its own required set of properties. Must be provided on Create. Only * retrieved with JOB_VIEW_ALL. */ - properties?: any; + properties?: {[key: string]: any;}; } /** * Streaming appliance snapshot configuration. @@ -2631,7 +2679,7 @@ export namespace dataflow_v1b3 { /** * Map from user step names to state families. */ - userStepToStateFamilyNameMap?: any; + userStepToStateFamilyNameMap?: {[key: string]: string;}; /** * If present, the worker must use this endpoint to communicate with * Windmill Service dispatchers, otherwise the worker must continue to use @@ -2884,7 +2932,7 @@ export namespace dataflow_v1b3 { /** * Maps user stage names to stable computation names. */ - userStageToComputationNameMap?: any; + userStageToComputationNameMap?: {[key: string]: string;}; } /** * Description of the type, names/ids, and input/outputs for a transform. @@ -2927,7 +2975,7 @@ export namespace dataflow_v1b3 { * This field is used by the worker to send the status of the indvidual * containers running on each worker. */ - pods?: any[]; + pods?: Array<{[key: string]: any;}>; /** * The interval at which the worker is sending health reports. The default * value of 0 should be interpreted as the field is not being explicitly set @@ -2976,7 +3024,7 @@ export namespace dataflow_v1b3 { * Other stats that can accompany an event. E.g. { * "downloaded_bytes" : "123456" } */ - metadata?: any; + metadata?: {[key: string]: string;}; } /** * WorkerMessage provides information to the backend about a worker. @@ -2992,7 +3040,7 @@ export namespace dataflow_v1b3 { * of development other strings can be used as tags. LABEL_UNSPECIFIED * should not be used here. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The timestamp of the worker_message. */ @@ -3052,7 +3100,7 @@ export namespace dataflow_v1b3 { * other worker identifiers should almost always be passed as labels since * they will be included on most messages. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * A worker_message response allows the server to pass information to the @@ -3125,7 +3173,7 @@ export namespace dataflow_v1b3 { /** * Metadata to set on the Google Compute Engine VMs. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * Network to which VMs will be assigned. If empty or unspecified, the * service will use the network "default". @@ -3156,7 +3204,7 @@ export namespace dataflow_v1b3 { /** * Extra arguments for this worker pool. */ - poolArgs?: any; + poolArgs?: {[key: string]: any;}; /** * Subnetwork to which VMs will be assigned, if desired. Expected to be of * the form "regions/REGION/subnetworks/SUBNETWORK". @@ -3326,7 +3374,7 @@ export namespace dataflow_v1b3 { * Other data returned by the service, specific to the particular worker * harness. */ - harnessData?: any; + harnessData?: {[key: string]: any;}; /** * Time at which the current lease will expire. */ @@ -3952,6 +4000,75 @@ export namespace dataflow_v1b3 { } + /** + * dataflow.projects.jobs.snapshot + * @desc Snapshot the state of a streaming job. + * @alias dataflow.projects.jobs.snapshot + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.jobId The job to be snapshotted. + * @param {string} params.projectId The project which owns the job to be snapshotted. + * @param {().SnapshotJobRequest} 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 + */ + snapshot( + params?: Params$Resource$Projects$Jobs$Snapshot, + options?: MethodOptions): AxiosPromise; + snapshot( + params: Params$Resource$Projects$Jobs$Snapshot, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + snapshot( + params: Params$Resource$Projects$Jobs$Snapshot, + callback: BodyResponseCallback): void; + snapshot(callback: BodyResponseCallback): void; + snapshot( + paramsOrCallback?: Params$Resource$Projects$Jobs$Snapshot| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Projects$Jobs$Snapshot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Jobs$Snapshot; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + '/v1b3/projects/{projectId}/jobs/{jobId}:snapshot') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['projectId', 'jobId'], + pathParams: ['jobId', 'projectId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * dataflow.projects.jobs.update * @desc Updates the state of an existing Cloud Dataflow job. @@ -4171,6 +4288,27 @@ export namespace dataflow_v1b3 { */ view?: string; } + export interface Params$Resource$Projects$Jobs$Snapshot extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The job to be snapshotted. + */ + jobId?: string; + /** + * The project which owns the job to be snapshotted. + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SnapshotJobRequest; + } export interface Params$Resource$Projects$Jobs$Update extends StandardParameters { /** @@ -5156,6 +5294,77 @@ export namespace dataflow_v1b3 { } + /** + * dataflow.projects.locations.jobs.snapshot + * @desc Snapshot the state of a streaming job. + * @alias dataflow.projects.locations.jobs.snapshot + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.jobId The job to be snapshotted. + * @param {string} params.location The location that contains this job. + * @param {string} params.projectId The project which owns the job to be snapshotted. + * @param {().SnapshotJobRequest} 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 + */ + snapshot( + params?: Params$Resource$Projects$Locations$Jobs$Snapshot, + options?: MethodOptions): AxiosPromise; + snapshot( + params: Params$Resource$Projects$Locations$Jobs$Snapshot, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + snapshot( + params: Params$Resource$Projects$Locations$Jobs$Snapshot, + callback: BodyResponseCallback): void; + snapshot(callback: BodyResponseCallback): void; + snapshot( + paramsOrCallback?: Params$Resource$Projects$Locations$Jobs$Snapshot| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Jobs$Snapshot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Jobs$Snapshot; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: + (rootUrl + + '/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['projectId', 'location', 'jobId'], + pathParams: ['jobId', 'location', 'projectId'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * dataflow.projects.locations.jobs.update * @desc Updates the state of an existing Cloud Dataflow job. @@ -5341,6 +5550,31 @@ export namespace dataflow_v1b3 { */ view?: string; } + export interface Params$Resource$Projects$Locations$Jobs$Snapshot extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The job to be snapshotted. + */ + jobId?: string; + /** + * The location that contains this job. + */ + location?: string; + /** + * The project which owns the job to be snapshotted. + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SnapshotJobRequest; + } export interface Params$Resource$Projects$Locations$Jobs$Update extends StandardParameters { /** @@ -6028,7 +6262,7 @@ export namespace dataflow_v1b3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`. + * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. * @param {string} params.location The location to which to direct the request. * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. * @param {string=} params.view The view to retrieve. Defaults to METADATA_ONLY. @@ -6096,7 +6330,9 @@ export namespace dataflow_v1b3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * @param {string=} params.dynamicTemplate.gcsPath Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object. + * @param {string=} params.dynamicTemplate.stagingLocation Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`. + * @param {string=} params.gcsPath A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. * @param {string} params.location The location to which to direct the request. * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. * @param {boolean=} params.validateOnly If true, the request is validated but not actually executed. Defaults to false. @@ -6193,7 +6429,7 @@ export namespace dataflow_v1b3 { /** * Required. A Cloud Storage path to the template from which to create the - * job. Must be a valid Cloud Storage URL, beginning with `gs://`. + * job. Must be valid Cloud Storage URL, beginning with 'gs://'. */ gcsPath?: string; /** @@ -6217,8 +6453,18 @@ export namespace dataflow_v1b3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. A Cloud Storage path to the template from which to create the - * job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * Path to dynamic template spec file on GCS. The file must be a Json + * serialized DynamicTemplateFieSpec object. + */ + 'dynamicTemplate.gcsPath'?: string; + /** + * Cloud Storage path for staging dependencies. Must be a valid Cloud + * Storage URL, beginning with `gs://`. + */ + 'dynamicTemplate.stagingLocation'?: string; + /** + * A Cloud Storage path to the template from which to create the job. Must + * be valid Cloud Storage URL, beginning with 'gs://'. */ gcsPath?: string; /** @@ -6329,7 +6575,7 @@ export namespace dataflow_v1b3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be a valid Cloud Storage URL, beginning with `gs://`. + * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. * @param {string=} params.location The location to which to direct the request. * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. * @param {string=} params.view The view to retrieve. Defaults to METADATA_ONLY. @@ -6395,7 +6641,9 @@ export namespace dataflow_v1b3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.gcsPath Required. A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * @param {string=} params.dynamicTemplate.gcsPath Path to dynamic template spec file on GCS. The file must be a Json serialized DynamicTemplateFieSpec object. + * @param {string=} params.dynamicTemplate.stagingLocation Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL, beginning with `gs://`. + * @param {string=} params.gcsPath A Cloud Storage path to the template from which to create the job. Must be valid Cloud Storage URL, beginning with 'gs://'. * @param {string=} params.location The location to which to direct the request. * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. * @param {boolean=} params.validateOnly If true, the request is validated but not actually executed. Defaults to false. @@ -6486,7 +6734,7 @@ export namespace dataflow_v1b3 { /** * Required. A Cloud Storage path to the template from which to create the - * job. Must be a valid Cloud Storage URL, beginning with `gs://`. + * job. Must be valid Cloud Storage URL, beginning with 'gs://'. */ gcsPath?: string; /** @@ -6510,8 +6758,18 @@ export namespace dataflow_v1b3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * Required. A Cloud Storage path to the template from which to create the - * job. Must be valid Cloud Storage URL, beginning with 'gs://'. + * Path to dynamic template spec file on GCS. The file must be a Json + * serialized DynamicTemplateFieSpec object. + */ + 'dynamicTemplate.gcsPath'?: string; + /** + * Cloud Storage path for staging dependencies. Must be a valid Cloud + * Storage URL, beginning with `gs://`. + */ + 'dynamicTemplate.stagingLocation'?: string; + /** + * A Cloud Storage path to the template from which to create the job. Must + * be valid Cloud Storage URL, beginning with 'gs://'. */ gcsPath?: string; /** diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index eb6ab49e25c..395b8785d2a 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -200,7 +200,7 @@ export namespace dataproc_v1 { * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be * associated with a cluster. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: * This report is available for testing purposes only. It may be changed @@ -283,11 +283,11 @@ export namespace dataproc_v1 { /** * The HDFS metrics. */ - hdfsMetrics?: any; + hdfsMetrics?: {[key: string]: string;}; /** * The YARN metrics. */ - yarnMetrics?: any; + yarnMetrics?: {[key: string]: string;}; } /** * The cluster operation triggered by a workflow. @@ -325,7 +325,7 @@ export namespace dataproc_v1 { /** * Output only. Labels associated with the operation */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The operation type. */ @@ -371,7 +371,7 @@ export namespace dataproc_v1 { /** * Required. The cluster labels. Cluster must have all labels to match. */ - clusterLabels?: any; + clusterLabels?: {[key: string]: string;}; /** * Optional. The zone where workflow process executes. This parameter does * not affect the selection of the cluster.If unspecified, the zone of the @@ -504,7 +504,7 @@ export namespace dataproc_v1 { * and instance metadata * (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * Optional. The Compute Engine network to be used for machine * communications. Cannot be specified with subnetwork_uri. If neither @@ -619,7 +619,7 @@ export namespace dataproc_v1 { * API may be overwritten. Can include properties set in * /etc/hadoop/conf/*-site and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; } /** * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) @@ -643,7 +643,7 @@ export namespace dataproc_v1 { * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, * /etc/hive/conf/hive-site.xml, and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; /** * The HCFS URI of the script that contains Hive queries. */ @@ -656,7 +656,7 @@ export namespace dataproc_v1 { * Optional. Mapping of query variable names to values (equivalent to the * Hive command: SET name="value";). */ - scriptVariables?: any; + scriptVariables?: {[key: string]: string;}; } /** * Optional. The config settings for Compute Engine resources in an instance @@ -717,7 +717,7 @@ export namespace dataproc_v1 { * Optional. Map from parameter names to values that should be used for * those parameters. Values may not exceed 100 characters. */ - parameters?: any; + parameters?: {[key: string]: string;}; /** * Optional. A tag that prevents multiple concurrent workflow instances with * the same tag from running. This mitigates risk of concurrent instances @@ -772,7 +772,7 @@ export namespace dataproc_v1 { * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be * associated with a job. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Job is a Pig job. */ @@ -957,7 +957,7 @@ export namespace dataproc_v1 { * 'com.google = FATAL', 'root = INFO', 'org.apache = * DEBUG' */ - driverLogLevels?: any; + driverLogLevels?: {[key: string]: string;}; } /** * Cluster that is managed by the workflow. @@ -983,7 +983,7 @@ export namespace dataproc_v1 { * expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be * associated with a given cluster. */ - labels?: any; + labels?: {[key: string]: string;}; } /** * Specifies the resources used to actively manage an instance group. @@ -1037,7 +1037,7 @@ export namespace dataproc_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1053,7 +1053,7 @@ export namespace dataproc_v1 { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * A job executed by the workflow. @@ -1075,7 +1075,7 @@ export namespace dataproc_v1 { * \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a * given job. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Job is a Pig job. */ @@ -1150,7 +1150,7 @@ export namespace dataproc_v1 { * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, * /etc/pig/conf/pig.properties, and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; /** * The HCFS URI of the script that contains the Pig queries. */ @@ -1163,7 +1163,7 @@ export namespace dataproc_v1 { * Optional. Mapping of query variable names to values (equivalent to the * Pig command: name=[value]). */ - scriptVariables?: any; + scriptVariables?: {[key: string]: string;}; } /** * Defines an Identity and Access Management (IAM) policy. It is used to @@ -1250,7 +1250,7 @@ export namespace dataproc_v1 { * API may be overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; /** * Optional. HCFS file URIs of Python files to pass to the PySpark * framework. Supported file types: .py, .egg, and .zip. @@ -1316,7 +1316,7 @@ export namespace dataproc_v1 { * pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more * information, see Cluster properties. */ - properties?: any; + properties?: {[key: string]: string;}; } /** * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) @@ -1364,7 +1364,7 @@ export namespace dataproc_v1 { * overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; } /** * A Cloud Dataproc job for running Apache Spark SQL @@ -1384,7 +1384,7 @@ export namespace dataproc_v1 { * SQL's SparkConf. Properties that conflict with values set by the * Cloud Dataproc API may be overwritten. */ - properties?: any; + properties?: {[key: string]: string;}; /** * The HCFS URI of the script that contains SQL queries. */ @@ -1397,7 +1397,7 @@ export namespace dataproc_v1 { * Optional. Mapping of query variable names to values (equivalent to the * Spark SQL command: SET name="value";). */ - scriptVariables?: any; + scriptVariables?: {[key: string]: string;}; } /** * The Status type defines a logical error model that is suitable for @@ -1443,7 +1443,7 @@ export namespace dataproc_v1 { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1595,7 +1595,7 @@ export namespace dataproc_v1 { /** * Map from parameter names to values that were used for those parameters. */ - parameters?: any; + parameters?: {[key: string]: string;}; /** * Output only. Workflow start time. */ @@ -1666,7 +1666,7 @@ export namespace dataproc_v1 { * to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels * can be associated with a template. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The "resource name" of the template, as described * in https://cloud.google.com/apis/design/resource_names of the form diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 87e956b544e..a5a196e6c75 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -138,6 +138,20 @@ export namespace dataproc_v1beta2 { */ acceleratorTypeUri?: string; } + /** + * Allocation Affinity for consuming Zonal allocation. + */ + export interface Schema$AllocationAffinity { + consumeAllocationType?: string; + /** + * Corresponds to the label key of Allocation resource. + */ + key?: string; + /** + * Corresponds to the label values of allocation resource. + */ + values?: string[]; + } /** * Associates members with a role. */ @@ -202,7 +216,7 @@ export namespace dataproc_v1beta2 { * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be * associated with a cluster. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. Contains cluster daemon metrics such as HDFS and YARN * stats.Beta Feature: This report is available for testing purposes only. @@ -289,11 +303,11 @@ export namespace dataproc_v1beta2 { /** * The HDFS metrics. */ - hdfsMetrics?: any; + hdfsMetrics?: {[key: string]: string;}; /** * The YARN metrics. */ - yarnMetrics?: any; + yarnMetrics?: {[key: string]: string;}; } /** * The cluster operation triggered by a workflow. @@ -331,7 +345,7 @@ export namespace dataproc_v1beta2 { /** * Output only. Labels associated with the operation */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The operation type. */ @@ -377,7 +391,7 @@ export namespace dataproc_v1beta2 { /** * Required. The cluster labels. Cluster must have all labels to match. */ - clusterLabels?: any; + clusterLabels?: {[key: string]: string;}; /** * Optional. The zone where workflow process executes. This parameter does * not affect the selection of the cluster.If unspecified, the zone of the @@ -496,6 +510,10 @@ export namespace dataproc_v1beta2 { * applicable to all instances in the cluster. */ export interface Schema$GceClusterConfig { + /** + * Allocation Affinity for consuming Zonal allocation. + */ + allocationAffinity?: Schema$AllocationAffinity; /** * Optional. If true, all instances in the cluster will only have internal * IP addresses. By default, clusters are not restricted to internal IP @@ -510,7 +528,7 @@ export namespace dataproc_v1beta2 { * and instance metadata * (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * Optional. The Compute Engine network to be used for machine * communications. Cannot be specified with subnetwork_uri. If neither @@ -625,7 +643,7 @@ export namespace dataproc_v1beta2 { * API may be overwritten. Can include properties set in * /etc/hadoop/conf/*-site and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; } /** * A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) @@ -649,7 +667,7 @@ export namespace dataproc_v1beta2 { * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, * /etc/hive/conf/hive-site.xml, and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; /** * The HCFS URI of the script that contains Hive queries. */ @@ -662,7 +680,7 @@ export namespace dataproc_v1beta2 { * Optional. Mapping of query variable names to values (equivalent to the * Hive command: SET name="value";). */ - scriptVariables?: any; + scriptVariables?: {[key: string]: string;}; } /** * Optional. The config settings for Compute Engine resources in an instance @@ -732,7 +750,7 @@ export namespace dataproc_v1beta2 { * Optional. Map from parameter names to values that should be used for * those parameters. Values may not exceed 100 characters. */ - parameters?: any; + parameters?: {[key: string]: string;}; /** * Optional. A tag that prevents multiple concurrent workflow instances with * the same tag from running. This mitigates risk of concurrent instances @@ -787,7 +805,7 @@ export namespace dataproc_v1beta2 { * (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be * associated with a job. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Job is a Pig job. */ @@ -833,6 +851,12 @@ export namespace dataproc_v1beta2 { * Output only. The previous job status. */ statusHistory?: Schema$JobStatus[]; + /** + * Output only. The email address of the user submitting the job. For jobs + * submitted on the cluster, the address is + * <code>username@hostname</code>. + */ + submittedBy?: string; /** * Output only. The collection of YARN applications spun up by this job.Beta * Feature: This report is available for testing purposes only. It may be @@ -998,7 +1022,7 @@ export namespace dataproc_v1beta2 { * 'com.google = FATAL', 'root = INFO', 'org.apache = * DEBUG' */ - driverLogLevels?: any; + driverLogLevels?: {[key: string]: string;}; } /** * Cluster that is managed by the workflow. @@ -1024,7 +1048,7 @@ export namespace dataproc_v1beta2 { * expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be * associated with a given cluster. */ - labels?: any; + labels?: {[key: string]: string;}; } /** * Specifies the resources used to actively manage an instance group. @@ -1078,7 +1102,7 @@ export namespace dataproc_v1beta2 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1094,7 +1118,7 @@ export namespace dataproc_v1beta2 { * original method name. For example, if the original method name is * TakeSnapshot(), the inferred response type is TakeSnapshotResponse. */ - response?: any; + response?: {[key: string]: any;}; } /** * A job executed by the workflow. @@ -1116,7 +1140,7 @@ export namespace dataproc_v1beta2 { * \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a * given job. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Job is a Pig job. */ @@ -1191,7 +1215,7 @@ export namespace dataproc_v1beta2 { * overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, * /etc/pig/conf/pig.properties, and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; /** * The HCFS URI of the script that contains the Pig queries. */ @@ -1204,7 +1228,7 @@ export namespace dataproc_v1beta2 { * Optional. Mapping of query variable names to values (equivalent to the * Pig command: name=[value]). */ - scriptVariables?: any; + scriptVariables?: {[key: string]: string;}; } /** * Defines an Identity and Access Management (IAM) policy. It is used to @@ -1291,7 +1315,7 @@ export namespace dataproc_v1beta2 { * API may be overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; /** * Optional. HCFS file URIs of Python files to pass to the PySpark * framework. Supported file types: .py, .egg, and .zip. @@ -1361,7 +1385,7 @@ export namespace dataproc_v1beta2 { * pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more * information, see Cluster properties. */ - properties?: any; + properties?: {[key: string]: string;}; } /** * A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) @@ -1409,7 +1433,7 @@ export namespace dataproc_v1beta2 { * overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; } /** * A Cloud Dataproc job for running Apache SparkR @@ -1448,7 +1472,7 @@ export namespace dataproc_v1beta2 { * API may be overwritten. Can include properties set in * /etc/spark/conf/spark-defaults.conf and classes in user code. */ - properties?: any; + properties?: {[key: string]: string;}; } /** * A Cloud Dataproc job for running Apache Spark SQL @@ -1468,7 +1492,7 @@ export namespace dataproc_v1beta2 { * SQL's SparkConf. Properties that conflict with values set by the * Cloud Dataproc API may be overwritten. */ - properties?: any; + properties?: {[key: string]: string;}; /** * The HCFS URI of the script that contains SQL queries. */ @@ -1481,7 +1505,7 @@ export namespace dataproc_v1beta2 { * Optional. Mapping of query variable names to values (equivalent to the * Spark SQL command: SET name="value";). */ - scriptVariables?: any; + scriptVariables?: {[key: string]: string;}; } /** * The Status type defines a logical error model that is suitable for @@ -1527,7 +1551,7 @@ export namespace dataproc_v1beta2 { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1679,7 +1703,7 @@ export namespace dataproc_v1beta2 { /** * Map from parameter names to values that were used for those parameters. */ - parameters?: any; + parameters?: {[key: string]: string;}; /** * Output only. Workflow start time. */ @@ -1750,7 +1774,7 @@ export namespace dataproc_v1beta2 { * to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels * can be associated with a template. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The "resource name" of the template, as described * in https://cloud.google.com/apis/design/resource_names of the form diff --git a/src/apis/datastore/v1.ts b/src/apis/datastore/v1.ts index 256370af4e7..e670375e977 100644 --- a/src/apis/datastore/v1.ts +++ b/src/apis/datastore/v1.ts @@ -244,7 +244,7 @@ export namespace datastore_v1 { * name is forbidden in certain documented contexts. The name must not * contain more than 500 characters. The name cannot be `""`. */ - properties?: any; + properties?: {[key: string]: Schema$Value;}; } /** * The result of fetching an entity from Datastore. @@ -293,7 +293,7 @@ export namespace datastore_v1 { * The client-assigned labels which were provided when the operation was * created. May also include additional labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The type of the operation. Can be used as a filter in * ListOperationsRequest. @@ -430,7 +430,7 @@ export namespace datastore_v1 { * The client-assigned labels which were provided when the operation was * created. May also include additional labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The type of the operation. Can be used as a filter in * ListOperationsRequest. @@ -511,7 +511,7 @@ export namespace datastore_v1 { /** * Client-assigned labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Location for the export metadata and data files. The full resource URL * of the external storage location. Currently, only Google Cloud Storage is @@ -596,7 +596,7 @@ export namespace datastore_v1 { /** * Client-assigned labels. */ - labels?: any; + labels?: {[key: string]: string;}; } /** * A minimal index definition. Next tag: 8 @@ -722,7 +722,7 @@ export namespace datastore_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -738,7 +738,7 @@ export namespace datastore_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A [GQL @@ -758,7 +758,7 @@ export namespace datastore_v1 { * must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not * be `""`. */ - namedBindings?: any; + namedBindings?: {[key: string]: Schema$GqlQueryParameter;}; /** * Numbered binding site @1 references the first numbered parameter, * effectively using 1-based indexing, rather than the usual 0. For each @@ -1257,7 +1257,7 @@ export namespace datastore_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/datastore/v1beta1.ts b/src/apis/datastore/v1beta1.ts index 4c64f59d7a4..b4a3f76d2ba 100644 --- a/src/apis/datastore/v1beta1.ts +++ b/src/apis/datastore/v1beta1.ts @@ -128,7 +128,7 @@ export namespace datastore_v1beta1 { * The client-assigned labels which were provided when the operation was * created. May also include additional labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The type of the operation. Can be used as a filter in * ListOperationsRequest. @@ -210,7 +210,7 @@ export namespace datastore_v1beta1 { /** * Client-assigned labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Location for the export metadata and data files. The full resource URL * of the external storage location. Currently, only Google Cloud Storage is @@ -298,7 +298,7 @@ export namespace datastore_v1beta1 { /** * Client-assigned labels. */ - labels?: any; + labels?: {[key: string]: string;}; } /** * Measures the progress of a particular metric. @@ -327,7 +327,7 @@ export namespace datastore_v1beta1 { * The client-assigned labels which were provided when the operation was * created. May also include additional labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The type of the operation. Can be used as a filter in * ListOperationsRequest. @@ -488,7 +488,7 @@ export namespace datastore_v1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -504,7 +504,7 @@ export namespace datastore_v1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -551,7 +551,7 @@ export namespace datastore_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/datastore/v1beta3.ts b/src/apis/datastore/v1beta3.ts index 096044ed52c..e8ab928f00a 100644 --- a/src/apis/datastore/v1beta3.ts +++ b/src/apis/datastore/v1beta3.ts @@ -236,7 +236,7 @@ export namespace datastore_v1beta3 { * name is forbidden in certain documented contexts. The name must not * contain more than 500 characters. The name cannot be `""`. */ - properties?: any; + properties?: {[key: string]: Schema$Value;}; } /** * The result of fetching an entity from Datastore. @@ -285,7 +285,7 @@ export namespace datastore_v1beta3 { * The client-assigned labels which were provided when the operation was * created. May also include additional labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The type of the operation. Can be used as a filter in * ListOperationsRequest. @@ -422,7 +422,7 @@ export namespace datastore_v1beta3 { * The client-assigned labels which were provided when the operation was * created. May also include additional labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The type of the operation. Can be used as a filter in * ListOperationsRequest. @@ -580,7 +580,7 @@ export namespace datastore_v1beta3 { * must match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not * be `""`. */ - namedBindings?: any; + namedBindings?: {[key: string]: Schema$GqlQueryParameter;}; /** * Numbered binding site @1 references the first numbered parameter, * effectively using 1-based indexing, rather than the usual 0. For each diff --git a/src/apis/deploymentmanager/alpha.ts b/src/apis/deploymentmanager/alpha.ts index b7b3cc650b2..c1c7bf09a06 100644 --- a/src/apis/deploymentmanager/alpha.ts +++ b/src/apis/deploymentmanager/alpha.ts @@ -817,7 +817,9 @@ export namespace deploymentmanager_alpha { * [Output Only] If errors are generated during processing of the operation, * this field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * [Output Only] If the operation fails, this field contains the HTTP error * message that was returned, such as NOT FOUND. @@ -907,7 +909,11 @@ export namespace deploymentmanager_alpha { * [Output Only] If warning messages are generated during processing of the * operation, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; /** * [Output Only] The URL of the zone where the operation resides. Only * available when performing per-zone operations. You must specify this @@ -1100,7 +1106,11 @@ export namespace deploymentmanager_alpha { * Output only. If warning messages are generated during processing of this * resource, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * The access controls set on the resource. @@ -1140,7 +1150,9 @@ export namespace deploymentmanager_alpha { * Output only. If errors are generated during update of the resource, this * field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * Output only. The expanded properties of the resource with reference * values expanded. Returned as serialized YAML. @@ -1173,7 +1185,11 @@ export namespace deploymentmanager_alpha { * Output only. If warning messages are generated during processing of this * resource, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * A rule to be applied in a Policy. diff --git a/src/apis/deploymentmanager/v2.ts b/src/apis/deploymentmanager/v2.ts index 459a9c4551d..aa5745f7fa8 100644 --- a/src/apis/deploymentmanager/v2.ts +++ b/src/apis/deploymentmanager/v2.ts @@ -587,7 +587,9 @@ export namespace deploymentmanager_v2 { * [Output Only] If errors are generated during processing of the operation, * this field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * [Output Only] If the operation fails, this field contains the HTTP error * message that was returned, such as NOT FOUND. @@ -677,7 +679,11 @@ export namespace deploymentmanager_v2 { * [Output Only] If warning messages are generated during processing of the * operation, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; /** * [Output Only] The URL of the zone where the operation resides. Only * available when performing per-zone operations. You must specify this @@ -813,7 +819,11 @@ export namespace deploymentmanager_v2 { * Output only. If warning messages are generated during processing of this * resource, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * The access controls set on the resource. @@ -848,7 +858,9 @@ export namespace deploymentmanager_v2 { * Output only. If errors are generated during update of the resource, this * field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * Output only. The expanded properties of the resource with reference * values expanded. Returned as serialized YAML. @@ -876,7 +888,11 @@ export namespace deploymentmanager_v2 { * Output only. If warning messages are generated during processing of this * resource, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * A rule to be applied in a Policy. diff --git a/src/apis/deploymentmanager/v2beta.ts b/src/apis/deploymentmanager/v2beta.ts index b836a11f557..3db0345ba96 100644 --- a/src/apis/deploymentmanager/v2beta.ts +++ b/src/apis/deploymentmanager/v2beta.ts @@ -765,7 +765,9 @@ export namespace deploymentmanager_v2beta { * [Output Only] If errors are generated during processing of the operation, * this field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * [Output Only] If the operation fails, this field contains the HTTP error * message that was returned, such as NOT FOUND. @@ -855,7 +857,11 @@ export namespace deploymentmanager_v2beta { * [Output Only] If warning messages are generated during processing of the * operation, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; /** * [Output Only] The URL of the zone where the operation resides. Only * available when performing per-zone operations. You must specify this @@ -1042,7 +1048,11 @@ export namespace deploymentmanager_v2beta { * Output only. If warning messages are generated during processing of this * resource, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * The access controls set on the resource. @@ -1077,7 +1087,9 @@ export namespace deploymentmanager_v2beta { * Output only. If errors are generated during update of the resource, this * field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * Output only. The expanded properties of the resource with reference * values expanded. Returned as serialized YAML. @@ -1105,7 +1117,11 @@ export namespace deploymentmanager_v2beta { * Output only. If warning messages are generated during processing of this * resource, this field will be populated. */ - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; } /** * A rule to be applied in a Policy. diff --git a/src/apis/dfareporting/index.ts b/src/apis/dfareporting/index.ts index 07985b94034..0f49230d217 100644 --- a/src/apis/dfareporting/index.ts +++ b/src/apis/dfareporting/index.ts @@ -14,19 +14,14 @@ /*! THIS FILE IS AUTO-GENERATED */ import {getAPI, GoogleConfigurable} from 'googleapis-common'; -import {dfareporting_v3_0} from './v3.0'; import {dfareporting_v3_1} from './v3.1'; import {dfareporting_v3_2} from './v3.2'; export const VERSIONS = { - 'v3.0': dfareporting_v3_0.Dfareporting, 'v3.1': dfareporting_v3_1.Dfareporting, 'v3.2': dfareporting_v3_2.Dfareporting, }; -export function dfareporting(version: 'v3_0'): dfareporting_v3_0.Dfareporting; -export function dfareporting(options: dfareporting_v3_0.Options): - dfareporting_v3_0.Dfareporting; export function dfareporting(version: 'v3_1'): dfareporting_v3_1.Dfareporting; export function dfareporting(options: dfareporting_v3_1.Options): dfareporting_v3_1.Dfareporting; @@ -34,10 +29,9 @@ 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< - T = dfareporting_v3_0.Dfareporting | dfareporting_v3_1.Dfareporting | - dfareporting_v3_2.Dfareporting>( + T = dfareporting_v3_1.Dfareporting | dfareporting_v3_2.Dfareporting>( this: GoogleConfigurable, - versionOrOptions: 'v3_0'|dfareporting_v3_0.Options|'v3_1'| - dfareporting_v3_1.Options|'v3_2'|dfareporting_v3_2.Options) { + versionOrOptions: 'v3_1'|dfareporting_v3_1.Options|'v3_2'| + dfareporting_v3_2.Options) { return getAPI('dfareporting', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/dfareporting/v3.0.ts b/src/apis/dfareporting/v3.0.ts deleted file mode 100644 index 6ef499e5faf..00000000000 --- a/src/apis/dfareporting/v3.0.ts +++ /dev/null @@ -1,27863 +0,0 @@ -/** - * Copyright 2015 Google Inc. All Rights Reserved. - * - * 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 {AxiosPromise} from 'axios'; -import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; -import {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_0 { - export interface Options extends GlobalOptions { - version: 'v3_0'; - } - - 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.0'); - * - * @namespace dfareporting - * @type {Function} - * @version v3.0 - * @variation v3.0 - * @param {object=} options Options for Dfareporting - */ - export class Dfareporting { - _options: GlobalOptions; - google?: GoogleConfigurable; - root = this; - - 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; - directorySiteContacts: Resource$Directorysitecontacts; - 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; - 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) { - this._options = options || {}; - this.google = google; - this.getRoot.bind(this); - - this.accountActiveAdSummaries = - new Resource$Accountactiveadsummaries(this); - this.accountPermissionGroups = new Resource$Accountpermissiongroups(this); - this.accountPermissions = new Resource$Accountpermissions(this); - this.accounts = new Resource$Accounts(this); - this.accountUserProfiles = new Resource$Accountuserprofiles(this); - this.ads = new Resource$Ads(this); - this.advertiserGroups = new Resource$Advertisergroups(this); - this.advertiserLandingPages = new Resource$Advertiserlandingpages(this); - this.advertisers = new Resource$Advertisers(this); - this.browsers = new Resource$Browsers(this); - this.campaignCreativeAssociations = - new Resource$Campaigncreativeassociations(this); - this.campaigns = new Resource$Campaigns(this); - this.changeLogs = new Resource$Changelogs(this); - this.cities = new Resource$Cities(this); - this.connectionTypes = new Resource$Connectiontypes(this); - this.contentCategories = new Resource$Contentcategories(this); - this.conversions = new Resource$Conversions(this); - this.countries = new Resource$Countries(this); - this.creativeAssets = new Resource$Creativeassets(this); - this.creativeFields = new Resource$Creativefields(this); - this.creativeFieldValues = new Resource$Creativefieldvalues(this); - this.creativeGroups = new Resource$Creativegroups(this); - this.creatives = new Resource$Creatives(this); - this.dimensionValues = new Resource$Dimensionvalues(this); - this.directorySiteContacts = new Resource$Directorysitecontacts(this); - this.directorySites = new Resource$Directorysites(this); - this.dynamicTargetingKeys = new Resource$Dynamictargetingkeys(this); - this.eventTags = new Resource$Eventtags(this); - this.files = new Resource$Files(this); - this.floodlightActivities = new Resource$Floodlightactivities(this); - this.floodlightActivityGroups = - new Resource$Floodlightactivitygroups(this); - this.floodlightConfigurations = - new Resource$Floodlightconfigurations(this); - this.inventoryItems = new Resource$Inventoryitems(this); - this.languages = new Resource$Languages(this); - this.metros = new Resource$Metros(this); - this.mobileCarriers = new Resource$Mobilecarriers(this); - this.operatingSystems = new Resource$Operatingsystems(this); - this.operatingSystemVersions = new Resource$Operatingsystemversions(this); - this.orderDocuments = new Resource$Orderdocuments(this); - this.orders = new Resource$Orders(this); - this.placementGroups = new Resource$Placementgroups(this); - this.placements = new Resource$Placements(this); - this.placementStrategies = new Resource$Placementstrategies(this); - this.platformTypes = new Resource$Platformtypes(this); - this.postalCodes = new Resource$Postalcodes(this); - this.projects = new Resource$Projects(this); - this.regions = new Resource$Regions(this); - this.remarketingLists = new Resource$Remarketinglists(this); - this.remarketingListShares = new Resource$Remarketinglistshares(this); - this.reports = new Resource$Reports(this); - this.sites = new Resource$Sites(this); - this.sizes = new Resource$Sizes(this); - this.subaccounts = new Resource$Subaccounts(this); - this.targetableRemarketingLists = - new Resource$Targetableremarketinglists(this); - this.targetingTemplates = new Resource$Targetingtemplates(this); - this.userProfiles = new Resource$Userprofiles(this); - this.userRolePermissionGroups = - new Resource$Userrolepermissiongroups(this); - this.userRolePermissions = new Resource$Userrolepermissions(this); - this.userRoles = new Resource$Userroles(this); - this.videoFormats = new Resource$Videoformats(this); - } - - getRoot() { - return this.root; - } - } - - /** - * 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; - /** - * Lookback window settings for the campaign. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * 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 the conversion was directed toward children. - */ - 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; - /** - * 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; - /** - * 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; - /** - * 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 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. Applicable to all creative types. - * Acceptable values are: - "APP" - "APP_INTERSTITIAL" - - * "IN_STREAM_VIDEO" - "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; - /** - * 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; - /** - * The asset ID of the polite load image asset. Applicable to the creative - * type: DISPLAY. - */ - politeLoadAssetId?: 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 video creative events. Applicable - * to the following creative types: all INSTREAM_VIDEO 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_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; - /** - * Description of the video ad. Applicable to the following creative types: - * all INSTREAM_VIDEO and all VPAID. - */ - videoDescription?: string; - /** - * Creative video duration in seconds. This is a read-only field. Applicable - * to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all - * VPAID. - */ - videoDuration?: 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 asset is active. This is a read-only field for - * VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative - * types: INSTREAM_VIDEO and all VPAID. - */ - active?: boolean; - /** - * 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; - /** - * Exit event configured for the backup image. Applicable to the following - * creative types: all RICH_MEDIA. - */ - backupImageExit?: Schema$CreativeCustomEvent; - /** - * Detected bit-rate for video asset. This is a read-only field. Applicable - * to the following creative types: 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_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; - /** - * 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 MIME type for video asset. This is a read-only field. Applicable - * to the following creative types: 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; - /** - * 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. - */ - 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; - /** - * Detected video duration for video asset. This is a read-only field. - * Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - */ - videoDuration?: number; - /** - * 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 Settings - */ - export interface Schema$CreativeSettings { - /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. - */ - iFrameFooter?: string; - /** - * Header text for iFrames for this site. Must be less than or equal to 2000 - * characters long. - */ - iFrameHeader?: 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; - } - /** - * 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; - } - /** - * 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; - /** - * Directory site contacts. - */ - contactAssignments?: Schema$DirectorySiteContactAssignment[]; - /** - * Country ID of this directory site. This is a read-only field. - */ - countryId?: string; - /** - * Currency ID of this directory site. This is a read-only field. Possible - * 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; - /** - * Description of this directory site. This is a read-only field. - */ - description?: string; - /** - * 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; - /** - * Parent directory site ID. - */ - parentId?: string; - /** - * Directory site settings. - */ - settings?: Schema$DirectorySiteSettings; - /** - * URL of this directory site. - */ - url?: string; - } - /** - * Contains properties of a Site Directory contact. - */ - export interface Schema$DirectorySiteContact { - /** - * Address of this directory site contact. - */ - address?: string; - /** - * Email address of this directory site contact. - */ - email?: string; - /** - * First name of this directory site contact. - */ - firstName?: string; - /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. - */ - id?: string; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContact". - */ - kind?: string; - /** - * Last name of this directory site contact. - */ - lastName?: string; - /** - * Phone number of this directory site contact. - */ - phone?: string; - /** - * Directory site contact role. - */ - role?: string; - /** - * Title or designation of this directory site contact. - */ - title?: string; - /** - * Directory site contact type. - */ - type?: string; - } - /** - * Directory Site Contact Assignment - */ - export interface Schema$DirectorySiteContactAssignment { - /** - * ID of this directory site contact. This is a read-only, auto-generated - * field. - */ - contactId?: string; - /** - * Visibility of this directory site contact assignment. When set to PUBLIC - * this contact assignment is visible to all account and agency users; when - * set to PRIVATE it is visible only to the site. - */ - visibility?: string; - } - /** - * Directory Site Contact List Response - */ - export interface Schema$DirectorySiteContactsListResponse { - /** - * Directory site contact collection - */ - directorySiteContacts?: Schema$DirectorySiteContact[]; - /** - * Identifies what kind of resource this is. Value: the fixed string - * "dfareporting#directorySiteContactsListResponse". - */ - kind?: string; - /** - * Pagination token to be used for the next list operation. - */ - nextPageToken?: 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; - /** - * Whether this directory site has disabled Nielsen OCR reach ratings. - */ - nielsenOcrOptOut?: boolean; - /** - * Whether this directory site has disabled generation of Verification ins - * tags. - */ - verificationTagOptOut?: boolean; - /** - * Whether this directory site has disabled active view for in-stream video - * creatives. This is a read-only field. - */ - videoActiveViewOptOut?: 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?: any; - } - /** - * 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; - /** - * 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; - /** - * 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 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; - /** - * 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?: any; - /** - * The report criteria for a report of type - * "CROSS_DIMENSION_REACH". - */ - crossDimensionReachCriteria?: any; - /** - * The report's email delivery settings. - */ - delivery?: any; - /** - * 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?: any; - /** - * 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?: any; - /** - * The report criteria for a report of type "REACH". - */ - reachCriteria?: any; - /** - * 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?: any; - /** - * 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; - } - /** - * 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; - /** - * Site-wide creative settings. - */ - creativeSettings?: Schema$CreativeSettings; - /** - * Whether new cookies are disabled for this site. - */ - disableNewCookie?: boolean; - /** - * Lookback window settings for this site. - */ - lookbackConfiguration?: Schema$LookbackConfiguration; - /** - * 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; - } - /** - * 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[]; - } - /** - * 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 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_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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountActiveAdSummaries/{summaryAccountId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'summaryAccountId'], - pathParams: ['profileId', 'summaryAccountId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountPermissionGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountPermissionGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountPermissions/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountPermissions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accounts/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountUserProfiles/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/accountUserProfiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/ads/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/ads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserLandingPages/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserLandingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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.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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserLandingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserLandingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertiserLandingPages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertisers/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/advertisers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/browsers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/campaigns/{campaignId}/campaignCreativeAssociations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'campaignId'], - pathParams: ['campaignId', 'profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/campaigns/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/campaigns') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/changeLogs/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/changeLogs') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/cities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/connectionTypes/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/connectionTypes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/contentCategories/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/contentCategories/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/contentCategories') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/conversions/batchinsert') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/conversions/batchupdate') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/countries/{dartId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/countries') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - mediaUrl: - (rootUrl + - '/upload/dfareporting/v3.0/userprofiles/{profileId}/creativeAssets/{advertiserId}/creativeAssets') - .replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['advertiserId', 'profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId', 'id'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeFields/{creativeFieldId}/creativeFieldValues') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId', 'creativeFieldId'], - pathParams: ['creativeFieldId', 'profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creativeGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creatives/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/creatives') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/dimensionvalues/query') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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$Directorysitecontacts { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * dfareporting.directorySiteContacts.get - * @desc Gets one directory site contact by ID. - * @alias dfareporting.directorySiteContacts.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.id Directory site contact 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$Directorysitecontacts$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Directorysitecontacts$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Directorysitecontacts$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Directorysitecontacts$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Directorysitecontacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysitecontacts$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.0/userprofiles/{profileId}/directorySiteContacts/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * dfareporting.directorySiteContacts.list - * @desc Retrieves a list of directory site contacts, possibly filtered. - * This method supports paging. - * @alias dfareporting.directorySiteContacts.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.directorySiteIds Select only directory site contacts with these directory site IDs. This is a required field. - * @param {string=} params.ids Select only directory site contacts 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, "directory site contact*2015" will return objects with names like "directory site contact June 2015", "directory site contact April 2015", or simply "directory site contact 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 contact" will match objects with name "my directory site contact", "directory site contact 2015", or simply "directory site contact". - * @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$Directorysitecontacts$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Directorysitecontacts$List, - options: MethodOptions| - BodyResponseCallback, - callback: - BodyResponseCallback): - void; - list( - params: Params$Resource$Directorysitecontacts$List, - callback: - BodyResponseCallback): - void; - list(callback: - BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Directorysitecontacts$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: - BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Directorysitecontacts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Directorysitecontacts$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.0/userprofiles/{profileId}/directorySiteContacts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest( - parameters); - } - } - } - - export interface Params$Resource$Directorysitecontacts$Get extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Directory site contact ID. - */ - id?: string; - /** - * User profile ID associated with this request. - */ - profileId?: string; - } - export interface Params$Resource$Directorysitecontacts$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Select only directory site contacts with these directory site IDs. This - * is a required field. - */ - directorySiteIds?: string; - /** - * Select only directory site contacts 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, "directory site contact*2015" will return objects - * with names like "directory site contact June 2015", "directory site - * contact April 2015", or simply "directory site contact 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 contact" - * will match objects with name "my directory site contact", "directory site - * contact 2015", or simply "directory site contact". - */ - searchString?: string; - /** - * Field by which to sort the list. - */ - sortField?: string; - /** - * Order of sorted results. - */ - sortOrder?: string; - } - - - export class Resource$Directorysites { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/directorySites/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/directorySites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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.countryId Select only directory sites with this country ID. - * @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.parentId Select only directory sites with this parent ID. - * @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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/directorySites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 country ID. - */ - countryId?: string; - /** - * 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; - /** - * Select only directory sites with this parent ID. - */ - parentId?: 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/dynamicTargetingKeys/{objectId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'objectId', 'name', 'objectType'], - pathParams: ['objectId', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/dynamicTargetingKeys') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/dynamicTargetingKeys') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/eventTags/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/eventTags/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/eventTags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/reports/{reportId}/files/{fileId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['reportId', 'fileId'], - pathParams: ['fileId', 'reportId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/files') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivities/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivities/generatetag') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivities/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivities') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivityGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightActivityGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightConfigurations/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightConfigurations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightConfigurations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/floodlightConfigurations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects/{projectId}/inventoryItems/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects/{projectId}/inventoryItems') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/languages') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/metros') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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$Mobilecarriers { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/mobileCarriers/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/mobileCarriers') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/operatingSystems/{dartId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'dartId'], - pathParams: ['dartId', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/operatingSystems') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/operatingSystemVersions/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/operatingSystemVersions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects/{projectId}/orderDocuments') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects/{projectId}/orders/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId', 'id'], - pathParams: ['id', 'profileId', 'projectId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects/{projectId}/orders') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'projectId'], - pathParams: ['profileId', 'projectId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placements/generatetags') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placements/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placements') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementStrategies/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementStrategies/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/placementStrategies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/platformTypes/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/platformTypes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/postalCodes/{code}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'code'], - pathParams: ['code', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/postalCodes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/projects') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/regions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingLists/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingListShares/{remarketingListId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId', 'remarketingListId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingListShares') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'remarketingListId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/remarketingListShares') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - compatibleFields: Resource$Reports$Compatiblefields; - files: Resource$Reports$Files; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - this.compatibleFields = new Resource$Reports$Compatiblefields(root); - this.files = new Resource$Reports$Files(root); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/{reportId}/run') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/{reportId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/compatiblefields/query') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/{reportId}/files/{fileId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'reportId', 'fileId'], - pathParams: ['fileId', 'profileId', 'reportId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/reports/{reportId}/files') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'reportId'], - pathParams: ['profileId', 'reportId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sites/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sites') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sizes/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sizes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/sizes') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/subaccounts/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/subaccounts') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/targetableRemarketingLists/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/targetableRemarketingLists') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'advertiserId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/targetingTemplates/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/targetingTemplates') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRolePermissionGroups/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRolePermissionGroups') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRolePermissions/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRolePermissions') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRoles/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRoles/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/userRoles') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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 { - root: Dfareporting; - constructor(root: Dfareporting) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * 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): AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/videoFormats/{id}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId', 'id'], - pathParams: ['id', 'profileId'], - context: this.getRoot() - }; - 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): - AxiosPromise; - 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|AxiosPromise { - 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.0/userprofiles/{profileId}/videoFormats') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['profileId'], - pathParams: ['profileId'], - context: this.getRoot() - }; - 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/dfareporting/v3.1.ts b/src/apis/dfareporting/v3.1.ts index 246e5b4187c..adc5b8f1914 100644 --- a/src/apis/dfareporting/v3.1.ts +++ b/src/apis/dfareporting/v3.1.ts @@ -3961,7 +3961,7 @@ export namespace dfareporting_v3_1 { /** * The URLs where the completed report file can be downloaded. */ - urls?: any; + urls?: {apiUrl?: string; browserUrl?: string;}; } /** * Represents the list of File resources. @@ -6501,16 +6501,36 @@ export namespace dfareporting_v3_1 { /** * The report criteria for a report of type "STANDARD". */ - criteria?: any; + 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?: any; + 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?: any; + delivery?: { + emailOwner?: boolean; + emailOwnerDeliveryType?: string; + message?: string; + recipients?: Schema$Recipient[]; + }; /** * The eTag of this response for caching purposes. */ @@ -6522,7 +6542,19 @@ export namespace dfareporting_v3_1 { /** * The report criteria for a report of type "FLOODLIGHT". */ - floodlightCriteria?: any; + 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 @@ -6555,17 +6587,54 @@ export namespace dfareporting_v3_1 { /** * The report criteria for a report of type "PATH_TO_CONVERSION". */ - pathToConversionCriteria?: any; + 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?: any; + 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?: any; + 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. */ @@ -8431,7 +8500,7 @@ export namespace dfareporting_v3_1 { /** * Select only accounts with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -8925,7 +8994,7 @@ export namespace dfareporting_v3_1 { /** * Select only user profiles with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -9417,11 +9486,11 @@ export namespace dfareporting_v3_1 { /** * Select only ads with these audience segment IDs. */ - audienceSegmentIds?: string; + audienceSegmentIds?: string[]; /** * Select only ads with these campaign IDs. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select default ads with the specified compatibility. Applicable when type * is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to @@ -9434,11 +9503,11 @@ export namespace dfareporting_v3_1 { /** * Select only ads with these creative IDs assigned. */ - creativeIds?: string; + creativeIds?: string[]; /** * Select only ads with these creative optimization configuration IDs. */ - creativeOptimizationConfigurationIds?: string; + creativeOptimizationConfigurationIds?: string[]; /** * Select only dynamic click trackers. Applicable when type is * AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If @@ -9448,11 +9517,11 @@ export namespace dfareporting_v3_1 { /** * Select only ads with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only ads with these landing page IDs. */ - landingPageIds?: string; + landingPageIds?: string[]; /** * Maximum number of results to return. */ @@ -9468,7 +9537,7 @@ export namespace dfareporting_v3_1 { /** * Select only ads with these placement IDs assigned. */ - placementIds?: string; + placementIds?: string[]; /** * User profile ID associated with this request. */ @@ -9477,7 +9546,7 @@ export namespace dfareporting_v3_1 { * Select only ads whose list targeting expression use these remarketing * list IDs. */ - remarketingListIds?: string; + 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 @@ -9490,7 +9559,7 @@ export namespace dfareporting_v3_1 { /** * Select only ads with these size IDs. */ - sizeIds?: string; + sizeIds?: string[]; /** * Field by which to sort the list. */ @@ -9510,7 +9579,7 @@ export namespace dfareporting_v3_1 { /** * Select only ads with these types. */ - type?: string; + type?: string[]; } export interface Params$Resource$Ads$Patch extends StandardParameters { /** @@ -10050,7 +10119,7 @@ export namespace dfareporting_v3_1 { /** * Select only advertiser groups with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -10544,7 +10613,7 @@ export namespace dfareporting_v3_1 { /** * Select only landing pages that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived landing pages. Don't set this field to select both * archived and non-archived landing pages. @@ -10553,7 +10622,7 @@ export namespace dfareporting_v3_1 { /** * Select only landing pages with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -11035,15 +11104,15 @@ export namespace dfareporting_v3_1 { /** * Select only advertisers with these advertiser group IDs. */ - advertiserGroupIds?: string; + advertiserGroupIds?: string[]; /** * Select only advertisers with these floodlight configuration IDs. */ - floodlightConfigurationIds?: string; + floodlightConfigurationIds?: string[]; /** * Select only advertisers with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only advertisers which do not belong to any advertiser group. */ @@ -11845,11 +11914,11 @@ export namespace dfareporting_v3_1 { * Select only campaigns whose advertisers belong to these advertiser * groups. */ - advertiserGroupIds?: string; + advertiserGroupIds?: string[]; /** * Select only campaigns that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived campaigns. Don't set this field to select both * archived and non-archived campaigns. @@ -11862,11 +11931,11 @@ export namespace dfareporting_v3_1 { /** * Exclude campaigns with these IDs. */ - excludedIds?: string; + excludedIds?: string[]; /** * Select only campaigns with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -12126,7 +12195,7 @@ export namespace dfareporting_v3_1 { /** * Select only change logs with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only change logs whose change time is before the specified * maxChangeTime.The time should be formatted as an RFC3339 date/time @@ -12152,7 +12221,7 @@ export namespace dfareporting_v3_1 { /** * Select only change logs with these object IDs. */ - objectIds?: string; + objectIds?: string[]; /** * Select only change logs with the specified object type. */ @@ -12173,7 +12242,7 @@ export namespace dfareporting_v3_1 { /** * Select only change logs with these user profile IDs. */ - userProfileIds?: string; + userProfileIds?: string[]; } @@ -12268,11 +12337,11 @@ export namespace dfareporting_v3_1 { /** * Select only cities from these countries. */ - countryDartIds?: string; + countryDartIds?: string[]; /** * Select only cities with these DART IDs. */ - dartIds?: string; + dartIds?: string[]; /** * Select only cities with names starting with this prefix. */ @@ -12284,7 +12353,7 @@ export namespace dfareporting_v3_1 { /** * Select only cities from these regions. */ - regionDartIds?: string; + regionDartIds?: string[]; } @@ -12970,7 +13039,7 @@ export namespace dfareporting_v3_1 { /** * Select only content categories with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -14044,11 +14113,11 @@ export namespace dfareporting_v3_1 { /** * Select only creative fields that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only creative fields with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -14644,7 +14713,7 @@ export namespace dfareporting_v3_1 { /** * Select only creative field values with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -15134,7 +15203,7 @@ export namespace dfareporting_v3_1 { /** * Select only creative groups that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only creative groups that belong to this subgroup. */ @@ -15142,7 +15211,7 @@ export namespace dfareporting_v3_1 { /** * Select only creative groups with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -15631,15 +15700,15 @@ export namespace dfareporting_v3_1 { /** * Select only in-stream video creatives with these companion IDs. */ - companionCreativeIds?: string; + companionCreativeIds?: string[]; /** * Select only creatives with these creative field IDs. */ - creativeFieldIds?: string; + creativeFieldIds?: string[]; /** * Select only creatives with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -15655,7 +15724,7 @@ export namespace dfareporting_v3_1 { /** * Select only creatives with these rendering IDs. */ - renderingIds?: string; + renderingIds?: string[]; /** * Allows searching for objects by name or ID. Wildcards (*) are allowed. * For example, "creative*2015" will return objects with names like @@ -15669,7 +15738,7 @@ export namespace dfareporting_v3_1 { /** * Select only creatives with these size IDs. */ - sizeIds?: string; + sizeIds?: string[]; /** * Field by which to sort the list. */ @@ -15685,7 +15754,7 @@ export namespace dfareporting_v3_1 { /** * Select only creatives with these creative types. */ - types?: string; + types?: string[]; } export interface Params$Resource$Creatives$Patch extends StandardParameters { /** @@ -16030,11 +16099,11 @@ export namespace dfareporting_v3_1 { * Select only directory site contacts with these directory site IDs. This * is a required field. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only directory site contacts with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -16375,7 +16444,7 @@ export namespace dfareporting_v3_1 { /** * Select only directory sites with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -16711,7 +16780,7 @@ export namespace dfareporting_v3_1 { /** * Select only dynamic targeting keys exactly matching these names. */ - names?: string; + names?: string[]; /** * Select only dynamic targeting keys with this object ID. */ @@ -17235,11 +17304,11 @@ export namespace dfareporting_v3_1 { * third-party JavaScript URL, or a third-party click-through URL for either * impression or click tracking. */ - eventTagTypes?: string; + eventTagTypes?: string[]; /** * Select only event tags with these IDs. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -18107,7 +18176,7 @@ export namespace dfareporting_v3_1 { * Select only floodlight activities with the specified floodlight activity * group IDs. */ - floodlightActivityGroupIds?: string; + floodlightActivityGroupIds?: string[]; /** * Select only floodlight activities with the specified floodlight activity * group name. @@ -18134,7 +18203,7 @@ export namespace dfareporting_v3_1 { * either ids, advertiserId, or floodlightConfigurationId for a non-empty * result. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -18654,7 +18723,7 @@ export namespace dfareporting_v3_1 { * specify either advertiserId or floodlightConfigurationId for a non-empty * result. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -19064,7 +19133,7 @@ export namespace dfareporting_v3_1 { * Set of IDs of floodlight configurations to retrieve. Required field; * otherwise an empty list will be returned. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -19303,7 +19372,7 @@ export namespace dfareporting_v3_1 { /** * Select only inventory items with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only inventory items that are in plan. */ @@ -19315,7 +19384,7 @@ export namespace dfareporting_v3_1 { /** * Select only inventory items that belong to specified orders. */ - orderId?: string; + orderId?: string[]; /** * Value of the nextPageToken from the previous result page. */ @@ -19331,7 +19400,7 @@ export namespace dfareporting_v3_1 { /** * Select only inventory items that are associated with these sites. */ - siteId?: string; + siteId?: string[]; /** * Field by which to sort the list. */ @@ -19703,11 +19772,11 @@ export namespace dfareporting_v3_1 { /** * Select only apps from these directories. */ - directories?: string; + directories?: string[]; /** * Select only apps with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -20483,7 +20552,7 @@ export namespace dfareporting_v3_1 { /** * Select only order documents with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -20491,7 +20560,7 @@ export namespace dfareporting_v3_1 { /** * Select only order documents for specified orders. */ - orderId?: string; + orderId?: string[]; /** * Value of the nextPageToken from the previous result page. */ @@ -20517,7 +20586,7 @@ export namespace dfareporting_v3_1 { /** * Select only order documents that are associated with these sites. */ - siteId?: string; + siteId?: string[]; /** * Field by which to sort the list. */ @@ -20710,7 +20779,7 @@ export namespace dfareporting_v3_1 { /** * Select only orders with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -20739,7 +20808,7 @@ export namespace dfareporting_v3_1 { /** * Select only orders that are associated with these site IDs. */ - siteId?: string; + siteId?: string[]; /** * Field by which to sort the list. */ @@ -21178,7 +21247,7 @@ export namespace dfareporting_v3_1 { /** * Select only placement groups that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived placements. Don't set this field to select both * archived and non-archived placements. @@ -21187,21 +21256,21 @@ export namespace dfareporting_v3_1 { /** * Select only placement groups that belong to these campaigns. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select only placement groups that are associated with these content * categories. */ - contentCategoryIds?: string; + contentCategoryIds?: string[]; /** * Select only placement groups that are associated with these directory * sites. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only placement groups with these IDs. */ - ids?: string; + 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". @@ -21245,11 +21314,11 @@ export namespace dfareporting_v3_1 { * Select only placement groups that are associated with these placement * strategies. */ - placementStrategyIds?: string; + placementStrategyIds?: string[]; /** * Select only placement groups with these pricing types. */ - pricingTypes?: string; + pricingTypes?: string[]; /** * User profile ID associated with this request. */ @@ -21267,7 +21336,7 @@ export namespace dfareporting_v3_1 { /** * Select only placement groups that are associated with these sites. */ - siteIds?: string; + siteIds?: string[]; /** * Field by which to sort the list. */ @@ -21783,7 +21852,7 @@ export namespace dfareporting_v3_1 { /** * Generate tags for these placements. */ - placementIds?: string; + placementIds?: string[]; /** * User profile ID associated with this request. */ @@ -21792,7 +21861,7 @@ export namespace dfareporting_v3_1 { * Tag formats to generate for these placements. Note: * PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. */ - tagFormats?: string; + tagFormats?: string[]; } export interface Params$Resource$Placements$Get extends StandardParameters { /** @@ -21835,7 +21904,7 @@ export namespace dfareporting_v3_1 { /** * Select only placements that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived placements. Don't set this field to select both * archived and non-archived placements. @@ -21844,7 +21913,7 @@ export namespace dfareporting_v3_1 { /** * Select only placements that belong to these campaigns. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select only placements that are associated with these compatibilities. * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or @@ -21852,23 +21921,23 @@ export namespace dfareporting_v3_1 { * 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; + compatibilities?: string[]; /** * Select only placements that are associated with these content categories. */ - contentCategoryIds?: string; + contentCategoryIds?: string[]; /** * Select only placements that are associated with these directory sites. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only placements that belong to these placement groups. */ - groupIds?: string; + groupIds?: string[]; /** * Select only placements with these IDs. */ - ids?: string; + 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". @@ -21907,11 +21976,11 @@ export namespace dfareporting_v3_1 { * Select only placements that are associated with these placement * strategies. */ - placementStrategyIds?: string; + placementStrategyIds?: string[]; /** * Select only placements with these pricing types. */ - pricingTypes?: string; + pricingTypes?: string[]; /** * User profile ID associated with this request. */ @@ -21929,11 +21998,11 @@ export namespace dfareporting_v3_1 { /** * Select only placements that are associated with these sites. */ - siteIds?: string; + siteIds?: string[]; /** * Select only placements that are associated with these sizes. */ - sizeIds?: string; + sizeIds?: string[]; /** * Field by which to sort the list. */ @@ -22484,7 +22553,7 @@ export namespace dfareporting_v3_1 { /** * Select only placement strategies with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -23081,11 +23150,11 @@ export namespace dfareporting_v3_1 { /** * Select only projects with these advertiser IDs. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only projects with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -25333,15 +25402,15 @@ export namespace dfareporting_v3_1 { /** * Select only sites with these campaign IDs. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select only sites with these directory site IDs. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only sites with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -25680,7 +25749,7 @@ export namespace dfareporting_v3_1 { /** * Select only sizes with these IDs. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -26092,7 +26161,7 @@ export namespace dfareporting_v3_1 { /** * Select only subaccounts with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -26815,7 +26884,7 @@ export namespace dfareporting_v3_1 { /** * Select only targeting templates with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -27418,7 +27487,7 @@ export namespace dfareporting_v3_1 { /** * Select only user role permissions with these IDs. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -27904,7 +27973,7 @@ export namespace dfareporting_v3_1 { /** * Select only user roles with the specified IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ diff --git a/src/apis/dfareporting/v3.2.ts b/src/apis/dfareporting/v3.2.ts index 8b7867d3428..a97ecc84059 100644 --- a/src/apis/dfareporting/v3.2.ts +++ b/src/apis/dfareporting/v3.2.ts @@ -3985,7 +3985,7 @@ export namespace dfareporting_v3_2 { /** * The URLs where the completed report file can be downloaded. */ - urls?: any; + urls?: {apiUrl?: string; browserUrl?: string;}; } /** * Represents the list of File resources. @@ -6530,16 +6530,36 @@ export namespace dfareporting_v3_2 { /** * The report criteria for a report of type "STANDARD". */ - criteria?: any; + 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?: any; + 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?: any; + delivery?: { + emailOwner?: boolean; + emailOwnerDeliveryType?: string; + message?: string; + recipients?: Schema$Recipient[]; + }; /** * The eTag of this response for caching purposes. */ @@ -6551,7 +6571,19 @@ export namespace dfareporting_v3_2 { /** * The report criteria for a report of type "FLOODLIGHT". */ - floodlightCriteria?: any; + 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 @@ -6584,17 +6616,54 @@ export namespace dfareporting_v3_2 { /** * The report criteria for a report of type "PATH_TO_CONVERSION". */ - pathToConversionCriteria?: any; + 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?: any; + 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?: any; + 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. */ @@ -8460,7 +8529,7 @@ export namespace dfareporting_v3_2 { /** * Select only accounts with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -8954,7 +9023,7 @@ export namespace dfareporting_v3_2 { /** * Select only user profiles with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -9446,11 +9515,11 @@ export namespace dfareporting_v3_2 { /** * Select only ads with these audience segment IDs. */ - audienceSegmentIds?: string; + audienceSegmentIds?: string[]; /** * Select only ads with these campaign IDs. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select default ads with the specified compatibility. Applicable when type * is AD_SERVING_DEFAULT_AD. DISPLAY and DISPLAY_INTERSTITIAL refer to @@ -9463,11 +9532,11 @@ export namespace dfareporting_v3_2 { /** * Select only ads with these creative IDs assigned. */ - creativeIds?: string; + creativeIds?: string[]; /** * Select only ads with these creative optimization configuration IDs. */ - creativeOptimizationConfigurationIds?: string; + creativeOptimizationConfigurationIds?: string[]; /** * Select only dynamic click trackers. Applicable when type is * AD_SERVING_CLICK_TRACKER. If true, select dynamic click trackers. If @@ -9477,11 +9546,11 @@ export namespace dfareporting_v3_2 { /** * Select only ads with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only ads with these landing page IDs. */ - landingPageIds?: string; + landingPageIds?: string[]; /** * Maximum number of results to return. */ @@ -9497,7 +9566,7 @@ export namespace dfareporting_v3_2 { /** * Select only ads with these placement IDs assigned. */ - placementIds?: string; + placementIds?: string[]; /** * User profile ID associated with this request. */ @@ -9506,7 +9575,7 @@ export namespace dfareporting_v3_2 { * Select only ads whose list targeting expression use these remarketing * list IDs. */ - remarketingListIds?: string; + 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 @@ -9519,7 +9588,7 @@ export namespace dfareporting_v3_2 { /** * Select only ads with these size IDs. */ - sizeIds?: string; + sizeIds?: string[]; /** * Field by which to sort the list. */ @@ -9539,7 +9608,7 @@ export namespace dfareporting_v3_2 { /** * Select only ads with these types. */ - type?: string; + type?: string[]; } export interface Params$Resource$Ads$Patch extends StandardParameters { /** @@ -10079,7 +10148,7 @@ export namespace dfareporting_v3_2 { /** * Select only advertiser groups with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -10574,7 +10643,7 @@ export namespace dfareporting_v3_2 { /** * Select only landing pages that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived landing pages. Don't set this field to select both * archived and non-archived landing pages. @@ -10583,11 +10652,11 @@ export namespace dfareporting_v3_2 { /** * Select only landing pages that are associated with these campaigns. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select only landing pages with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -11069,15 +11138,15 @@ export namespace dfareporting_v3_2 { /** * Select only advertisers with these advertiser group IDs. */ - advertiserGroupIds?: string; + advertiserGroupIds?: string[]; /** * Select only advertisers with these floodlight configuration IDs. */ - floodlightConfigurationIds?: string; + floodlightConfigurationIds?: string[]; /** * Select only advertisers with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only advertisers which do not belong to any advertiser group. */ @@ -11879,11 +11948,11 @@ export namespace dfareporting_v3_2 { * Select only campaigns whose advertisers belong to these advertiser * groups. */ - advertiserGroupIds?: string; + advertiserGroupIds?: string[]; /** * Select only campaigns that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived campaigns. Don't set this field to select both * archived and non-archived campaigns. @@ -11896,11 +11965,11 @@ export namespace dfareporting_v3_2 { /** * Exclude campaigns with these IDs. */ - excludedIds?: string; + excludedIds?: string[]; /** * Select only campaigns with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -12160,7 +12229,7 @@ export namespace dfareporting_v3_2 { /** * Select only change logs with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only change logs whose change time is before the specified * maxChangeTime.The time should be formatted as an RFC3339 date/time @@ -12186,7 +12255,7 @@ export namespace dfareporting_v3_2 { /** * Select only change logs with these object IDs. */ - objectIds?: string; + objectIds?: string[]; /** * Select only change logs with the specified object type. */ @@ -12207,7 +12276,7 @@ export namespace dfareporting_v3_2 { /** * Select only change logs with these user profile IDs. */ - userProfileIds?: string; + userProfileIds?: string[]; } @@ -12302,11 +12371,11 @@ export namespace dfareporting_v3_2 { /** * Select only cities from these countries. */ - countryDartIds?: string; + countryDartIds?: string[]; /** * Select only cities with these DART IDs. */ - dartIds?: string; + dartIds?: string[]; /** * Select only cities with names starting with this prefix. */ @@ -12318,7 +12387,7 @@ export namespace dfareporting_v3_2 { /** * Select only cities from these regions. */ - regionDartIds?: string; + regionDartIds?: string[]; } @@ -13004,7 +13073,7 @@ export namespace dfareporting_v3_2 { /** * Select only content categories with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -14078,11 +14147,11 @@ export namespace dfareporting_v3_2 { /** * Select only creative fields that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only creative fields with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -14678,7 +14747,7 @@ export namespace dfareporting_v3_2 { /** * Select only creative field values with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -15168,7 +15237,7 @@ export namespace dfareporting_v3_2 { /** * Select only creative groups that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only creative groups that belong to this subgroup. */ @@ -15176,7 +15245,7 @@ export namespace dfareporting_v3_2 { /** * Select only creative groups with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -15665,15 +15734,15 @@ export namespace dfareporting_v3_2 { /** * Select only in-stream video creatives with these companion IDs. */ - companionCreativeIds?: string; + companionCreativeIds?: string[]; /** * Select only creatives with these creative field IDs. */ - creativeFieldIds?: string; + creativeFieldIds?: string[]; /** * Select only creatives with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -15689,7 +15758,7 @@ export namespace dfareporting_v3_2 { /** * Select only creatives with these rendering IDs. */ - renderingIds?: string; + renderingIds?: string[]; /** * Allows searching for objects by name or ID. Wildcards (*) are allowed. * For example, "creative*2015" will return objects with names like @@ -15703,7 +15772,7 @@ export namespace dfareporting_v3_2 { /** * Select only creatives with these size IDs. */ - sizeIds?: string; + sizeIds?: string[]; /** * Field by which to sort the list. */ @@ -15719,7 +15788,7 @@ export namespace dfareporting_v3_2 { /** * Select only creatives with these creative types. */ - types?: string; + types?: string[]; } export interface Params$Resource$Creatives$Patch extends StandardParameters { /** @@ -16064,11 +16133,11 @@ export namespace dfareporting_v3_2 { * Select only directory site contacts with these directory site IDs. This * is a required field. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only directory site contacts with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -16409,7 +16478,7 @@ export namespace dfareporting_v3_2 { /** * Select only directory sites with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -16745,7 +16814,7 @@ export namespace dfareporting_v3_2 { /** * Select only dynamic targeting keys exactly matching these names. */ - names?: string; + names?: string[]; /** * Select only dynamic targeting keys with this object ID. */ @@ -17269,11 +17338,11 @@ export namespace dfareporting_v3_2 { * third-party JavaScript URL, or a third-party click-through URL for either * impression or click tracking. */ - eventTagTypes?: string; + eventTagTypes?: string[]; /** * Select only event tags with these IDs. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -18141,7 +18210,7 @@ export namespace dfareporting_v3_2 { * Select only floodlight activities with the specified floodlight activity * group IDs. */ - floodlightActivityGroupIds?: string; + floodlightActivityGroupIds?: string[]; /** * Select only floodlight activities with the specified floodlight activity * group name. @@ -18168,7 +18237,7 @@ export namespace dfareporting_v3_2 { * either ids, advertiserId, or floodlightConfigurationId for a non-empty * result. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -18688,7 +18757,7 @@ export namespace dfareporting_v3_2 { * specify either advertiserId or floodlightConfigurationId for a non-empty * result. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -19098,7 +19167,7 @@ export namespace dfareporting_v3_2 { * Set of IDs of floodlight configurations to retrieve. Required field; * otherwise an empty list will be returned. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -19337,7 +19406,7 @@ export namespace dfareporting_v3_2 { /** * Select only inventory items with these IDs. */ - ids?: string; + ids?: string[]; /** * Select only inventory items that are in plan. */ @@ -19349,7 +19418,7 @@ export namespace dfareporting_v3_2 { /** * Select only inventory items that belong to specified orders. */ - orderId?: string; + orderId?: string[]; /** * Value of the nextPageToken from the previous result page. */ @@ -19365,7 +19434,7 @@ export namespace dfareporting_v3_2 { /** * Select only inventory items that are associated with these sites. */ - siteId?: string; + siteId?: string[]; /** * Field by which to sort the list. */ @@ -19737,11 +19806,11 @@ export namespace dfareporting_v3_2 { /** * Select only apps from these directories. */ - directories?: string; + directories?: string[]; /** * Select only apps with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -20517,7 +20586,7 @@ export namespace dfareporting_v3_2 { /** * Select only order documents with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -20525,7 +20594,7 @@ export namespace dfareporting_v3_2 { /** * Select only order documents for specified orders. */ - orderId?: string; + orderId?: string[]; /** * Value of the nextPageToken from the previous result page. */ @@ -20551,7 +20620,7 @@ export namespace dfareporting_v3_2 { /** * Select only order documents that are associated with these sites. */ - siteId?: string; + siteId?: string[]; /** * Field by which to sort the list. */ @@ -20744,7 +20813,7 @@ export namespace dfareporting_v3_2 { /** * Select only orders with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -20773,7 +20842,7 @@ export namespace dfareporting_v3_2 { /** * Select only orders that are associated with these site IDs. */ - siteId?: string; + siteId?: string[]; /** * Field by which to sort the list. */ @@ -21212,7 +21281,7 @@ export namespace dfareporting_v3_2 { /** * Select only placement groups that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived placements. Don't set this field to select both * archived and non-archived placements. @@ -21221,21 +21290,21 @@ export namespace dfareporting_v3_2 { /** * Select only placement groups that belong to these campaigns. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select only placement groups that are associated with these content * categories. */ - contentCategoryIds?: string; + contentCategoryIds?: string[]; /** * Select only placement groups that are associated with these directory * sites. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only placement groups with these IDs. */ - ids?: string; + 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". @@ -21279,11 +21348,11 @@ export namespace dfareporting_v3_2 { * Select only placement groups that are associated with these placement * strategies. */ - placementStrategyIds?: string; + placementStrategyIds?: string[]; /** * Select only placement groups with these pricing types. */ - pricingTypes?: string; + pricingTypes?: string[]; /** * User profile ID associated with this request. */ @@ -21301,7 +21370,7 @@ export namespace dfareporting_v3_2 { /** * Select only placement groups that are associated with these sites. */ - siteIds?: string; + siteIds?: string[]; /** * Field by which to sort the list. */ @@ -21817,7 +21886,7 @@ export namespace dfareporting_v3_2 { /** * Generate tags for these placements. */ - placementIds?: string; + placementIds?: string[]; /** * User profile ID associated with this request. */ @@ -21826,7 +21895,7 @@ export namespace dfareporting_v3_2 { * Tag formats to generate for these placements. Note: * PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. */ - tagFormats?: string; + tagFormats?: string[]; } export interface Params$Resource$Placements$Get extends StandardParameters { /** @@ -21869,7 +21938,7 @@ export namespace dfareporting_v3_2 { /** * Select only placements that belong to these advertisers. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only archived placements. Don't set this field to select both * archived and non-archived placements. @@ -21878,7 +21947,7 @@ export namespace dfareporting_v3_2 { /** * Select only placements that belong to these campaigns. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select only placements that are associated with these compatibilities. * DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or @@ -21886,23 +21955,23 @@ export namespace dfareporting_v3_2 { * 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; + compatibilities?: string[]; /** * Select only placements that are associated with these content categories. */ - contentCategoryIds?: string; + contentCategoryIds?: string[]; /** * Select only placements that are associated with these directory sites. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only placements that belong to these placement groups. */ - groupIds?: string; + groupIds?: string[]; /** * Select only placements with these IDs. */ - ids?: string; + 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". @@ -21941,11 +22010,11 @@ export namespace dfareporting_v3_2 { * Select only placements that are associated with these placement * strategies. */ - placementStrategyIds?: string; + placementStrategyIds?: string[]; /** * Select only placements with these pricing types. */ - pricingTypes?: string; + pricingTypes?: string[]; /** * User profile ID associated with this request. */ @@ -21963,11 +22032,11 @@ export namespace dfareporting_v3_2 { /** * Select only placements that are associated with these sites. */ - siteIds?: string; + siteIds?: string[]; /** * Select only placements that are associated with these sizes. */ - sizeIds?: string; + sizeIds?: string[]; /** * Field by which to sort the list. */ @@ -22518,7 +22587,7 @@ export namespace dfareporting_v3_2 { /** * Select only placement strategies with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -23115,11 +23184,11 @@ export namespace dfareporting_v3_2 { /** * Select only projects with these advertiser IDs. */ - advertiserIds?: string; + advertiserIds?: string[]; /** * Select only projects with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -25367,15 +25436,15 @@ export namespace dfareporting_v3_2 { /** * Select only sites with these campaign IDs. */ - campaignIds?: string; + campaignIds?: string[]; /** * Select only sites with these directory site IDs. */ - directorySiteIds?: string; + directorySiteIds?: string[]; /** * Select only sites with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -25714,7 +25783,7 @@ export namespace dfareporting_v3_2 { /** * Select only sizes with these IDs. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -26126,7 +26195,7 @@ export namespace dfareporting_v3_2 { /** * Select only subaccounts with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -26849,7 +26918,7 @@ export namespace dfareporting_v3_2 { /** * Select only targeting templates with these IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ @@ -27452,7 +27521,7 @@ export namespace dfareporting_v3_2 { /** * Select only user role permissions with these IDs. */ - ids?: string; + ids?: string[]; /** * User profile ID associated with this request. */ @@ -27938,7 +28007,7 @@ export namespace dfareporting_v3_2 { /** * Select only user roles with the specified IDs. */ - ids?: string; + ids?: string[]; /** * Maximum number of results to return. */ diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index f5a8416b95c..097ae402c32 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -362,10 +362,12 @@ export namespace dialogflow_v2 { * `projects/<Project ID>/agent/sessions/<Session * ID>/contexts/<Context ID>`, or `projects/<Project * ID>/agent/environments/<Environment ID>/users/<User - * ID>/sessions/<Session ID>/contexts/<Context ID>`. The - * `Context ID` is always converted to lowercase. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is - * not specified, we assume default '-' user. + * ID>/sessions/<Session ID>/contexts/<Context ID>`. The + * `Context ID` is always converted to lowercase, may only contain + * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + * `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' + * user. */ name?: string; /** @@ -373,7 +375,7 @@ export namespace dialogflow_v2 { * Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) * for syntax. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * Represents a notification sent to Cloud Pub/Sub subscribers for @@ -463,7 +465,7 @@ export namespace dialogflow_v2 { /** * Optional. The collection of parameters associated with the event. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * The response message for Agents.ExportAgent. @@ -605,7 +607,8 @@ export namespace dialogflow_v2 { parentFollowupIntentName?: string; /** * Optional. The priority of this intent. Higher numbers represent higher - * priorities. Zero or negative numbers mean that the intent is disabled. + * priorities. If this is zero or unspecified, we use the default priority + * 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** @@ -680,7 +683,7 @@ export namespace dialogflow_v2 { * the Intent.Message.Platform type for a description of the structure that * may be required for your platform. */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. The platform that this message is intended for. */ @@ -1201,7 +1204,7 @@ export namespace dialogflow_v2 { * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) * for Enterprise Edition agents. */ - payload?: any; + payload?: {[key: string]: any;}; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is * set by Dialogflow-owned servers. @@ -1232,7 +1235,7 @@ export namespace dialogflow_v2 { * The free-form diagnostic info. For example, this field could contain * webhook call latency. */ - diagnosticInfo?: any; + diagnosticInfo?: {[key: string]: any;}; /** * The collection of rich messages to present to the user. */ @@ -1275,7 +1278,7 @@ export namespace dialogflow_v2 { /** * The collection of extracted parameters. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The original conversational query text: - If natural language text was * provided as input, `query_text` contains a copy of the input. - If @@ -1305,7 +1308,7 @@ export namespace dialogflow_v2 { * If the query was fulfilled by a webhook call, this field is set to the * value of the `payload` field returned in the webhook response. */ - webhookPayload?: any; + webhookPayload?: {[key: string]: any;}; /** * If the query was fulfilled by a webhook call, this field is set to the * value of the `source` field returned in the webhook response. @@ -1415,7 +1418,7 @@ export namespace dialogflow_v2 { * "this is a simple response" } } ] } * } }</pre> */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. This value is passed directly to `QueryResult.webhook_source`. */ @@ -1435,7 +1438,9 @@ export namespace dialogflow_v2 { /** * Required. The unique identifier of the context. Format: * `projects/<Project ID>/agent/sessions/<Session - * ID>/contexts/<Context ID>`. + * ID>/contexts/<Context ID>`. The `Context ID` is always + * converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and + * may be at most 250 bytes long. */ name?: string; /** @@ -1443,7 +1448,7 @@ export namespace dialogflow_v2 { * Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) * for syntax. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * The request to detect user's intent. @@ -1562,7 +1567,7 @@ export namespace dialogflow_v2 { /** * Optional. The collection of parameters associated with the event. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * The request message for Agents.ExportAgent. @@ -1737,7 +1742,8 @@ export namespace dialogflow_v2 { parentFollowupIntentName?: string; /** * Optional. The priority of this intent. Higher numbers represent higher - * priorities. Zero or negative numbers mean that the intent is disabled. + * priorities. If this is zero or unspecified, we use the default priority + * 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** @@ -1820,7 +1826,7 @@ export namespace dialogflow_v2 { * the Intent.Message.Platform type for a description of the structure that * may be required for your platform. */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. The platform that this message is intended for. */ @@ -2280,7 +2286,7 @@ export namespace dialogflow_v2 { * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) * for Enterprise Edition agents. */ - payload?: any; + payload?: {[key: string]: any;}; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is * set by Dialogflow-owned servers. @@ -2329,7 +2335,7 @@ export namespace dialogflow_v2 { * Optional. This field can be used to pass custom data into the webhook * associated with the agent. Arbitrary JSON objects are supported. */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. Specifies whether to delete all contexts in the current session * before the new ones are activated. @@ -2368,7 +2374,7 @@ export namespace dialogflow_v2 { * The free-form diagnostic info. For example, this field could contain * webhook call latency. */ - diagnosticInfo?: any; + diagnosticInfo?: {[key: string]: any;}; /** * The collection of rich messages to present to the user. */ @@ -2406,7 +2412,7 @@ export namespace dialogflow_v2 { /** * The collection of extracted parameters. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The original conversational query text: - If natural language text was * provided as input, `query_text` contains a copy of the input. - If @@ -2430,7 +2436,7 @@ export namespace dialogflow_v2 { * If the query was fulfilled by a webhook call, this field is set to the * value of the `payload` field returned in the webhook response. */ - webhookPayload?: any; + webhookPayload?: {[key: string]: any;}; /** * If the query was fulfilled by a webhook call, this field is set to the * value of the `source` field returned in the webhook response. @@ -2587,7 +2593,7 @@ export namespace dialogflow_v2 { * "this is a simple response" } } ] } * } }</pre> */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. This value is passed directly to `QueryResult.webhook_source`. */ @@ -2614,7 +2620,7 @@ export namespace dialogflow_v2 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -2630,7 +2636,7 @@ export namespace dialogflow_v2 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A generic empty message that you can re-use to avoid defining duplicated @@ -2685,7 +2691,7 @@ export namespace dialogflow_v2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -5510,7 +5516,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`. + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5657,7 +5663,8 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall /** * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`. + * ID>`. The `Context ID` is always converted to lowercase, may only + * contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. */ name?: string; /** diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 1ecfd6b3502..dd21405094d 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -362,10 +362,12 @@ export namespace dialogflow_v2beta1 { * `projects/<Project ID>/agent/sessions/<Session * ID>/contexts/<Context ID>`, or `projects/<Project * ID>/agent/environments/<Environment ID>/users/<User - * ID>/sessions/<Session ID>/contexts/<Context ID>`. The - * `Context ID` is always converted to lowercase. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is - * not specified, we assume default '-' user. + * ID>/sessions/<Session ID>/contexts/<Context ID>`. The + * `Context ID` is always converted to lowercase, may only contain + * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + * `Environment ID` is not specified, we assume default 'draft' + * environment. If `User ID` is not specified, we assume default '-' + * user. */ name?: string; /** @@ -373,7 +375,7 @@ export namespace dialogflow_v2beta1 { * Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) * for syntax. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * Represents a notification sent to Cloud Pub/Sub subscribers for @@ -588,7 +590,7 @@ export namespace dialogflow_v2beta1 { /** * Optional. The collection of parameters associated with the event. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * The request message for Agents.ExportAgent. @@ -808,7 +810,8 @@ export namespace dialogflow_v2beta1 { parentFollowupIntentName?: string; /** * Optional. The priority of this intent. Higher numbers represent higher - * priorities. Zero or negative numbers mean that the intent is disabled. + * priorities. If this is zero or unspecified, we use the default priority + * 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** @@ -892,7 +895,7 @@ export namespace dialogflow_v2beta1 { * the Intent.Message.Platform type for a description of the structure that * may be required for your platform. */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. The platform that this message is intended for. */ @@ -1519,7 +1522,7 @@ export namespace dialogflow_v2beta1 { * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) * for Enterprise Edition agents. */ - payload?: any; + payload?: {[key: string]: any;}; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is * set by Dialogflow-owned servers. @@ -1596,7 +1599,7 @@ export namespace dialogflow_v2beta1 { * Optional. This field can be used to pass custom data into the webhook * associated with the agent. Arbitrary JSON objects are supported. */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. Specifies whether to delete all contexts in the current session * before the new ones are activated. @@ -1642,7 +1645,7 @@ export namespace dialogflow_v2beta1 { * The free-form diagnostic info. For example, this field could contain * webhook call latency. */ - diagnosticInfo?: any; + diagnosticInfo?: {[key: string]: any;}; /** * The collection of rich messages to present to the user. */ @@ -1685,7 +1688,7 @@ export namespace dialogflow_v2beta1 { /** * The collection of extracted parameters. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The original conversational query text: - If natural language text was * provided as input, `query_text` contains a copy of the input. - If @@ -1715,13 +1718,17 @@ export namespace dialogflow_v2beta1 { * If the query was fulfilled by a webhook call, this field is set to the * value of the `payload` field returned in the webhook response. */ - webhookPayload?: any; + webhookPayload?: {[key: string]: any;}; /** * If the query was fulfilled by a webhook call, this field is set to the * value of the `source` field returned in the webhook response. */ webhookSource?: string; } + /** + * Request message for Documents.ReloadDocument. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ReloadDocumentRequest {} /** * The request message for Agents.RestoreAgent. */ @@ -1983,7 +1990,7 @@ export namespace dialogflow_v2beta1 { * "this is a simple response" } } ] } * } }</pre> */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. This value is passed directly to `QueryResult.webhook_source`. */ @@ -2003,7 +2010,9 @@ export namespace dialogflow_v2beta1 { /** * Required. The unique identifier of the context. Format: * `projects/<Project ID>/agent/sessions/<Session - * ID>/contexts/<Context ID>`. + * ID>/contexts/<Context ID>`. The `Context ID` is always + * converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and + * may be at most 250 bytes long. */ name?: string; /** @@ -2011,7 +2020,7 @@ export namespace dialogflow_v2beta1 { * Refer to [this doc](https://dialogflow.com/docs/actions-and-parameters) * for syntax. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * Represents an entity type. Entity types serve as a tool for extracting @@ -2080,7 +2089,7 @@ export namespace dialogflow_v2beta1 { /** * Optional. The collection of parameters associated with the event. */ - parameters?: any; + parameters?: {[key: string]: any;}; } /** * The response message for Agents.ExportAgent. @@ -2189,7 +2198,8 @@ export namespace dialogflow_v2beta1 { parentFollowupIntentName?: string; /** * Optional. The priority of this intent. Higher numbers represent higher - * priorities. Zero or negative numbers mean that the intent is disabled. + * priorities. If this is zero or unspecified, we use the default priority + * 500000. Negative numbers mean that the intent is disabled. */ priority?: number; /** @@ -2263,7 +2273,7 @@ export namespace dialogflow_v2beta1 { * the Intent.Message.Platform type for a description of the structure that * may be required for your platform. */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. The platform that this message is intended for. */ @@ -2663,7 +2673,7 @@ export namespace dialogflow_v2beta1 { * with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) * for Enterprise Edition agents. */ - payload?: any; + payload?: {[key: string]: any;}; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is * set by Dialogflow-owned servers. @@ -2694,7 +2704,7 @@ export namespace dialogflow_v2beta1 { * The free-form diagnostic info. For example, this field could contain * webhook call latency. */ - diagnosticInfo?: any; + diagnosticInfo?: {[key: string]: any;}; /** * The collection of rich messages to present to the user. */ @@ -2732,7 +2742,7 @@ export namespace dialogflow_v2beta1 { /** * The collection of extracted parameters. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The original conversational query text: - If natural language text was * provided as input, `query_text` contains a copy of the input. - If @@ -2756,7 +2766,7 @@ export namespace dialogflow_v2beta1 { * If the query was fulfilled by a webhook call, this field is set to the * value of the `payload` field returned in the webhook response. */ - webhookPayload?: any; + webhookPayload?: {[key: string]: any;}; /** * If the query was fulfilled by a webhook call, this field is set to the * value of the `source` field returned in the webhook response. @@ -2829,7 +2839,7 @@ export namespace dialogflow_v2beta1 { * "this is a simple response" } } ] } * } }</pre> */ - payload?: any; + payload?: {[key: string]: any;}; /** * Optional. This value is passed directly to `QueryResult.webhook_source`. */ @@ -2856,7 +2866,7 @@ export namespace dialogflow_v2beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -2872,7 +2882,7 @@ export namespace dialogflow_v2beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A generic empty message that you can re-use to avoid defining duplicated @@ -2927,7 +2937,7 @@ export namespace dialogflow_v2beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -5137,7 +5147,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5306,10 +5316,11 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The - * `Context ID` is always converted to lowercase. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * ID>/users//sessions//contexts/`. The + * `Context ID` is always converted to lowercase, may only contain + * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + * `Environment ID` is not specified, we assume default 'draft' environment. + * If `User ID` is not specified, we assume default '-' user. */ name?: string; /** @@ -6896,6 +6907,82 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall parameters); } } + + + /** + * dialogflow.projects.agent.knowledgeBases.patch + * @desc Updates the specified knowledge base. + * @alias dialogflow.projects.agent.knowledgeBases.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//knowledgeBases/`. + * @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. + * @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} 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$Agent$Knowledgebases$Patch, + options?: MethodOptions): + AxiosPromise; + patch( + params: Params$Resource$Projects$Agent$Knowledgebases$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + patch( + params: Params$Resource$Projects$Agent$Knowledgebases$Patch, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + patch(callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Agent$Knowledgebases$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Agent$Knowledgebases$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Agent$Knowledgebases$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>(parameters); + } + } } export interface Params$Resource$Projects$Agent$Knowledgebases$Create extends @@ -6970,6 +7057,31 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } + export interface Params$Resource$Projects$Agent$Knowledgebases$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The knowledge base resource name. The name must be empty when creating a + * knowledge base. Format: `projects//knowledgeBases/`. + */ + name?: string; + /** + * Optional. Not specified means `update all`. Currently, only + * `display_name` can be updated, an InvalidArgument will be returned for + * attempting to update other fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase; + } export class Resource$Projects$Agent$Knowledgebases$Documents { root: Dialogflow; @@ -7290,6 +7402,164 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall parameters); } } + + + /** + * dialogflow.projects.agent.knowledgeBases.documents.patch + * @desc Updates the specified document. Operation + * @alias dialogflow.projects.agent.knowledgeBases.documents.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. + * @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. + * @param {().GoogleCloudDialogflowV2beta1Document} 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$Agent$Knowledgebases$Documents$Patch, + options?: MethodOptions): + AxiosPromise; + patch( + params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + patch( + params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch, + callback: BodyResponseCallback): + void; + patch(callback: BodyResponseCallback): + void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dialogflow.projects.agent.knowledgeBases.documents.reload + * @desc Reloads the specified document from its specified source, + * content_uri or content. The previously loaded content of the document + * will be deleted. Note: Even when the content of the document has not + * changed, there still may be side effects because of internal + * implementation changes. Operation + * @alias dialogflow.projects.agent.knowledgeBases.documents.reload + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * @param {().GoogleCloudDialogflowV2beta1ReloadDocumentRequest} 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 + */ + reload( + params?: Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload, + options?: MethodOptions): + AxiosPromise; + reload( + params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + reload( + params: Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload, + callback: BodyResponseCallback): + void; + reload(callback: BodyResponseCallback): + void; + reload( + paramsOrCallback?: + Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as + Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}:reload') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Create @@ -7359,6 +7629,49 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } + export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The document resource name. The name must be empty when creating a + * document. Format: `projects//knowledgeBases//documents/`. + */ + name?: string; + /** + * Optional. Not specified means `update all`. Currently, only + * `display_name` can be updated, an InvalidArgument will be returned for + * attempting to update other fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1Document; + } + export interface Params$Resource$Projects$Agent$Knowledgebases$Documents$Reload + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the document to reload. Format: `projects//knowledgeBases//documents/` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1ReloadDocumentRequest; + } @@ -7894,7 +8207,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8059,10 +8372,11 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The - * `Context ID` is always converted to lowercase. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * ID>/users//sessions//contexts/`. The + * `Context ID` is always converted to lowercase, may only contain + * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + * `Environment ID` is not specified, we assume default 'draft' environment. + * If `User ID` is not specified, we assume default '-' user. */ name?: string; /** @@ -9070,7 +9384,7 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. * @param {().GoogleCloudDialogflowV2beta1Context} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9239,10 +9553,11 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall * Required. The unique identifier of the context. Format: * `projects//agent/sessions//contexts/`, or `projects//agent/environments//users//sessions//contexts/`. The - * `Context ID` is always converted to lowercase. If `Environment ID` is not - * specified, we assume default 'draft' environment. If `User ID` is not - * specified, we assume default '-' user. + * ID>/users//sessions//contexts/`. The + * `Context ID` is always converted to lowercase, may only contain + * characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If + * `Environment ID` is not specified, we assume default 'draft' environment. + * If `User ID` is not specified, we assume default '-' user. */ name?: string; /** @@ -9567,6 +9882,82 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall parameters); } } + + + /** + * dialogflow.projects.knowledgeBases.patch + * @desc Updates the specified knowledge base. + * @alias dialogflow.projects.knowledgeBases.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The knowledge base resource name. The name must be empty when creating a knowledge base. Format: `projects//knowledgeBases/`. + * @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. + * @param {().GoogleCloudDialogflowV2beta1KnowledgeBase} 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$Knowledgebases$Patch, + options?: MethodOptions): + AxiosPromise; + patch( + params: Params$Resource$Projects$Knowledgebases$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + patch( + params: Params$Resource$Projects$Knowledgebases$Patch, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + patch(callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Knowledgebases$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Knowledgebases$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Knowledgebases$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudDialogflowV2beta1KnowledgeBase>(parameters); + } + } } export interface Params$Resource$Projects$Knowledgebases$Create extends @@ -9641,6 +10032,31 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } + export interface Params$Resource$Projects$Knowledgebases$Patch extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The knowledge base resource name. The name must be empty when creating a + * knowledge base. Format: `projects//knowledgeBases/`. + */ + name?: string; + /** + * Optional. Not specified means `update all`. Currently, only + * `display_name` can be updated, an InvalidArgument will be returned for + * attempting to update other fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1KnowledgeBase; + } export class Resource$Projects$Knowledgebases$Documents { root: Dialogflow; @@ -9957,6 +10373,162 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall parameters); } } + + + /** + * dialogflow.projects.knowledgeBases.documents.patch + * @desc Updates the specified document. Operation + * @alias dialogflow.projects.knowledgeBases.documents.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The document resource name. The name must be empty when creating a document. Format: `projects//knowledgeBases//documents/`. + * @param {string=} params.updateMask Optional. Not specified means `update all`. Currently, only `display_name` can be updated, an InvalidArgument will be returned for attempting to update other fields. + * @param {().GoogleCloudDialogflowV2beta1Document} 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$Knowledgebases$Documents$Patch, + options?: MethodOptions): + AxiosPromise; + patch( + params: Params$Resource$Projects$Knowledgebases$Documents$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + patch( + params: Params$Resource$Projects$Knowledgebases$Documents$Patch, + callback: BodyResponseCallback): + void; + patch(callback: BodyResponseCallback): + void; + patch( + paramsOrCallback?: + Params$Resource$Projects$Knowledgebases$Documents$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Knowledgebases$Documents$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Knowledgebases$Documents$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dialogflow.projects.knowledgeBases.documents.reload + * @desc Reloads the specified document from its specified source, + * content_uri or content. The previously loaded content of the document + * will be deleted. Note: Even when the content of the document has not + * changed, there still may be side effects because of internal + * implementation changes. Operation + * @alias dialogflow.projects.knowledgeBases.documents.reload + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the document to reload. Format: `projects//knowledgeBases//documents/` + * @param {().GoogleCloudDialogflowV2beta1ReloadDocumentRequest} 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 + */ + reload( + params?: Params$Resource$Projects$Knowledgebases$Documents$Reload, + options?: MethodOptions): + AxiosPromise; + reload( + params: Params$Resource$Projects$Knowledgebases$Documents$Reload, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + reload( + params: Params$Resource$Projects$Knowledgebases$Documents$Reload, + callback: BodyResponseCallback): + void; + reload(callback: BodyResponseCallback): + void; + reload( + paramsOrCallback?: + Params$Resource$Projects$Knowledgebases$Documents$Reload| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Knowledgebases$Documents$Reload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Knowledgebases$Documents$Reload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}:reload') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Knowledgebases$Documents$Create @@ -10026,6 +10598,49 @@ import(paramsOrCallback?: Params$Resource$Projects$Agent$Import|BodyResponseCall */ parent?: string; } + export interface Params$Resource$Projects$Knowledgebases$Documents$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The document resource name. The name must be empty when creating a + * document. Format: `projects//knowledgeBases//documents/`. + */ + name?: string; + /** + * Optional. Not specified means `update all`. Currently, only + * `display_name` can be updated, an InvalidArgument will be returned for + * attempting to update other fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1Document; + } + export interface Params$Resource$Projects$Knowledgebases$Documents$Reload + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The name of the document to reload. Format: `projects//knowledgeBases//documents/` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1ReloadDocumentRequest; + } diff --git a/src/apis/discovery/v1.ts b/src/apis/discovery/v1.ts index ab5663238ee..c7b1a47a4f7 100644 --- a/src/apis/discovery/v1.ts +++ b/src/apis/discovery/v1.ts @@ -107,7 +107,20 @@ export namespace discovery_v1 { /** * The individual directory entries. One entry per api/version pair. */ - items?: any[]; + items?: Array<{ + description?: string; + discoveryLink?: string; + discoveryRestUrl?: string; + documentationLink?: string; + icons?: {x16?: string; x32?: string;}; + id?: string; + kind?: string; + labels?: string[]; + name?: string; + preferred?: boolean; + title?: string; + version?: string; + }>; /** * The kind for this response. */ @@ -127,7 +140,7 @@ export namespace discovery_v1 { /** * Additional information about this property. */ - annotations?: any; + annotations?: {required?: string[];}; /** * The default value of this property (if one exists). */ @@ -182,7 +195,7 @@ export namespace discovery_v1 { * If this is a schema for an object, list the schema for each property of * this object. */ - properties?: any; + properties?: {[key: string]: Schema$JsonSchema;}; /** * The value is read-only, generated by the service. The value cannot be * modified by the client. If the value is included in a POST, PUT, or PATCH @@ -207,13 +220,16 @@ export namespace discovery_v1 { * how to interpret the entire entity. Its value must exist in a map of * descriminant values to schema names. */ - variant?: any; + variant?: { + discriminant?: string; + map?: Array<{$ref?: string; type_value?: string;}>; + }; } export interface Schema$RestDescription { /** * Authentication information. */ - auth?: any; + auth?: {oauth2?: {scopes?: {[key: string]: {description?: string;};};};}; /** * [DEPRECATED] The base path for REST requests. */ @@ -258,7 +274,7 @@ export namespace discovery_v1 { /** * Links to 16x16 and 32x32 icons representing the API. */ - icons?: any; + icons?: {x16?: string; x32?: string;}; /** * The ID of this API. */ @@ -274,7 +290,7 @@ export namespace discovery_v1 { /** * API-level methods for this API. */ - methods?: any; + methods?: {[key: string]: Schema$RestMethod;}; /** * The name of this API. */ @@ -296,7 +312,7 @@ export namespace discovery_v1 { /** * Common parameters that apply across all apis. */ - parameters?: any; + parameters?: {[key: string]: Schema$JsonSchema;}; /** * The protocol described by this document. */ @@ -304,7 +320,7 @@ export namespace discovery_v1 { /** * The resources in this API. */ - resources?: any; + resources?: {[key: string]: Schema$RestResource;}; /** * The version of this API. */ @@ -316,7 +332,7 @@ export namespace discovery_v1 { /** * The schemas for this API. */ - schemas?: any; + schemas?: {[key: string]: Schema$JsonSchema;}; /** * The base path for all REST requests. */ @@ -353,7 +369,14 @@ export namespace discovery_v1 { /** * Media upload parameters. */ - mediaUpload?: any; + mediaUpload?: { + accept?: string[]; + maxSize?: string; + protocols?: { + resumable?: {multipart?: boolean; path?: string;}; + simple?: {multipart?: boolean; path?: string;}; + }; + }; /** * Ordered list of required parameters, serves as a hint to clients on how * to structure their method signatures. The array is ordered such that the @@ -363,7 +386,7 @@ export namespace discovery_v1 { /** * Details for all parameters in this method. */ - parameters?: any; + parameters?: {[key: string]: Schema$JsonSchema;}; /** * The URI path of this REST method. Should be used in conjunction with the * basePath property at the api-level. @@ -372,11 +395,11 @@ export namespace discovery_v1 { /** * The schema for the request. */ - request?: any; + request?: {$ref?: string; parameterName?: string;}; /** * The schema for the response. */ - response?: any; + response?: {$ref?: string;}; /** * OAuth 2.0 scopes applicable to this method. */ @@ -404,11 +427,11 @@ export namespace discovery_v1 { /** * Methods on this resource. */ - methods?: any; + methods?: {[key: string]: Schema$RestMethod;}; /** * Sub-resources on this resource. */ - resources?: any; + resources?: {[key: string]: Schema$RestResource;}; } diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index f4696e73477..1485e52c425 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -3008,7 +3008,7 @@ export namespace dlp_v2 { */ fieldTransformations?: Schema$GooglePrivacyDlpV2FieldTransformation[]; /** - * Set if the transformation was limited to a specific info_type. + * Set if the transformation was limited to a specific InfoType. */ infoType?: Schema$GooglePrivacyDlpV2InfoType; /** @@ -3208,7 +3208,7 @@ export namespace dlp_v2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index a9f5ec4039c..80b3053f56e 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -339,7 +339,7 @@ export namespace dns_v1 { /** * User labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * User assigned name for this resource. Must be unique within the project. * The name must be 1-63 characters long, must begin with a letter, end with diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index 4de61fe2db3..c6759c334a3 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -87,6 +87,7 @@ export namespace dns_v1beta2 { dnsKeys: Resource$Dnskeys; managedZoneOperations: Resource$Managedzoneoperations; managedZones: Resource$Managedzones; + policies: Resource$Policies; projects: Resource$Projects; resourceRecordSets: Resource$Resourcerecordsets; @@ -99,6 +100,7 @@ export namespace dns_v1beta2 { this.dnsKeys = new Resource$Dnskeys(this); this.managedZoneOperations = new Resource$Managedzoneoperations(this); this.managedZones = new Resource$Managedzones(this); + this.policies = new Resource$Policies(this); this.projects = new Resource$Projects(this); this.resourceRecordSets = new Resource$Resourcerecordsets(this); } @@ -327,6 +329,12 @@ export namespace dns_v1beta2 { * DNSSEC configuration. */ dnssecConfig?: Schema$ManagedZoneDnsSecConfig; + /** + * The presence for this field indicates that outbound forwarding is enabled + * for this zone. The value of this field contains the set of destinations + * to forward to. + */ + forwardingConfig?: Schema$ManagedZoneForwardingConfig; /** * Unique identifier for the resource; defined by the server (output only) */ @@ -339,7 +347,7 @@ export namespace dns_v1beta2 { /** * User labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * User assigned name for this resource. Must be unique within the project. * The name must be 1-63 characters long, must begin with a letter, end with @@ -389,6 +397,29 @@ export namespace dns_v1beta2 { */ state?: string; } + export interface Schema$ManagedZoneForwardingConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZoneForwardingConfig". + */ + kind?: string; + /** + * List of target name servers to forward to. Cloud DNS will select the best + * available name server if more than one target is given. + */ + targetNameServers?: Schema$ManagedZoneForwardingConfigNameServerTarget[]; + } + export interface Schema$ManagedZoneForwardingConfigNameServerTarget { + /** + * IPv4 address of a target name server. + */ + ipv4Address?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#managedZoneForwardingConfigNameServerTarget". + */ + kind?: string; + } export interface Schema$ManagedZoneOperationsListResponse { header?: Schema$ResponseHeader; /** @@ -528,6 +559,120 @@ export namespace dns_v1beta2 { */ oldValue?: Schema$ManagedZone; } + export interface Schema$PoliciesListResponse { + header?: Schema$ResponseHeader; + /** + * Type of resource. + */ + kind?: string; + /** + * The presence of this field indicates that there exist more results + * following your last page of results in pagination order. To fetch them, + * make another list request using this value as your page token. In this + * way you can retrieve the complete contents of even very large collections + * one page at a time. However, if the contents of the collection change + * between the first and last paginated list request, the set of all + * elements returned will be an inconsistent view of the collection. There + * is no way to retrieve a consistent snapshot of a collection larger than + * the maximum page size. + */ + nextPageToken?: string; + /** + * The policy resources. + */ + policies?: Schema$Policy[]; + } + export interface Schema$PoliciesPatchResponse { + header?: Schema$ResponseHeader; + policy?: Schema$Policy; + } + export interface Schema$PoliciesUpdateResponse { + header?: Schema$ResponseHeader; + policy?: Schema$Policy; + } + /** + * A policy is a collection of rules applied to one or more networks that + * specify forwarding behavior for that network. + */ + export interface Schema$Policy { + /** + * Sets an alternative name server for the associated networks. When + * specified, all DNS queries are forwarded to a name server that you + * choose. Names such as .internal are not available when an alternative + * name server is specified. + */ + alternativeNameServerConfig?: Schema$PolicyAlternativeNameServerConfig; + /** + * A mutable string of at most 1024 characters associated with this resource + * for the user's convenience. Has no effect on the policy's + * function. + */ + description?: string; + /** + * Allows networks bound to this policy to receive DNS queries sent by VMs + * or applications over VPN connections. When enabled, a virtual IP address + * will be allocated from each of the sub-networks that are bound to this + * policy. + */ + enableInboundForwarding?: boolean; + /** + * Unique identifier for the resource; defined by the server (output only). + */ + id?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#policy". + */ + kind?: string; + /** + * User assigned name for this policy. + */ + name?: string; + /** + * List of network names specifying networks to which this policy is + * applied. + */ + networks?: Schema$PolicyNetwork[]; + } + export interface Schema$PolicyAlternativeNameServerConfig { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#policyAlternativeNameServerConfig". + */ + kind?: string; + /** + * Sets an alternative name server for the associated networks. When + * specified, all DNS queries are forwarded to a name server that you + * choose. Names such as .internal are not available when an alternative + * name server is specified. + */ + targetNameServers?: + Schema$PolicyAlternativeNameServerConfigTargetNameServer[]; + } + export interface Schema$PolicyAlternativeNameServerConfigTargetNameServer { + /** + * IPv4 address to forward to. + */ + ipv4Address?: string; + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#policyAlternativeNameServerConfigTargetNameServer". + */ + kind?: string; + } + export interface Schema$PolicyNetwork { + /** + * Identifies what kind of resource this is. Value: the fixed string + * "dns#policyNetwork". + */ + kind?: string; + /** + * The fully qualified URL of the GCE private network to bind to. This + * should be formatted like + * https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} + */ + networkUrl?: string; + } /** * A project resource. The project is a top level container for resources * including Cloud DNS ManagedZones. Projects can be created only in the APIs @@ -580,6 +725,14 @@ export namespace dns_v1beta2 { * be attached. */ networksPerManagedZone?: number; + /** + * Maximum allowed number of networks per policy. + */ + networksPerPolicy?: number; + /** + * Maximum allowed number of policies per project. + */ + policies?: number; /** * Maximum allowed number of ResourceRecords per ResourceRecordSet. */ @@ -598,6 +751,15 @@ export namespace dns_v1beta2 { * Maximum allowed number of ResourceRecordSets per zone in the project. */ rrsetsPerManagedZone?: number; + /** + * Maximum allowed number of target name servers per managed forwarding + * zone. + */ + targetNameServersPerManagedZone?: number; + /** + * Maximum allowed number of alternative target name servers per policy. + */ + targetNameServersPerPolicy?: number; /** * Maximum allowed size for total rrdata in one ChangesCreateRequest in * bytes. @@ -2003,6 +2165,562 @@ export namespace dns_v1beta2 { } + export class Resource$Policies { + root: Dns; + constructor(root: Dns) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * dns.policies.create + * @desc Create a new Policy + * @alias dns.policies.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} 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$Policies$Create, options?: MethodOptions): + AxiosPromise; + create( + params: Params$Resource$Policies$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Policies$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Policies$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dns/v1beta2/projects/{project}/policies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dns.policies.delete + * @desc Delete a previously created Policy. Will fail if the policy is + * still being referenced by a network. + * @alias dns.policies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by 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$Policies$Delete, options?: MethodOptions): + AxiosPromise; + delete( + params: Params$Resource$Policies$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Policies$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Policies$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dns/v1beta2/projects/{project}/policies/{policy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' + }, + options), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dns.policies.get + * @desc Fetch the representation of an existing Policy. + * @alias dns.policies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by 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$Policies$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Policies$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Policies$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Policies$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dns/v1beta2/projects/{project}/policies/{policy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dns.policies.list + * @desc Enumerate all Policies associated with a project. + * @alias dns.policies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults Optional. Maximum number of results to be returned. If unspecified, the server will decide how many results to return. + * @param {string=} params.pageToken Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request. + * @param {string} params.project Identifies the project addressed by 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$Policies$List, options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Policies$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Policies$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Policies$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/dns/v1beta2/projects/{project}/policies') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dns.policies.patch + * @desc Apply a partial update to an existing Policy. + * @alias dns.policies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} 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$Policies$Patch, options?: MethodOptions): + AxiosPromise; + patch( + params: Params$Resource$Policies$Patch, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Policies$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Policies$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dns/v1beta2/projects/{project}/policies/{policy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * dns.policies.update + * @desc Update an existing Policy. + * @alias dns.policies.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.clientOperationId For mutating operation requests only. An optional identifier specified by the client. Must be unique for operation resources in the Operations collection. + * @param {string} params.policy User given friendly name of the policy addressed by this request. + * @param {string} params.project Identifies the project addressed by this request. + * @param {().Policy} 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$Policies$Update, options?: MethodOptions): + AxiosPromise; + update( + params: Params$Resource$Policies$Update, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + update( + params: Params$Resource$Policies$Update, + callback: BodyResponseCallback): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: Params$Resource$Policies$Update| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Policies$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Policies$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + + '/dns/v1beta2/projects/{project}/policies/{policy}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT' + }, + options), + params, + requiredParams: ['project', 'policy'], + pathParams: ['policy', 'project'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Policies$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. + */ + clientOperationId?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Optional. Maximum number of results to be returned. If unspecified, the + * server will decide how many results to return. + */ + maxResults?: number; + /** + * Optional. A tag returned by a previous list request that was truncated. + * Use this parameter to continue a previous list request. + */ + pageToken?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + } + export interface Params$Resource$Policies$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + export interface Params$Resource$Policies$Update extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * For mutating operation requests only. An optional identifier specified by + * the client. Must be unique for operation resources in the Operations + * collection. + */ + clientOperationId?: string; + /** + * User given friendly name of the policy addressed by this request. + */ + policy?: string; + /** + * Identifies the project addressed by this request. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Policy; + } + + export class Resource$Projects { root: Dns; constructor(root: Dns) { diff --git a/src/apis/dns/v2beta1.ts b/src/apis/dns/v2beta1.ts index 522ad4795a2..875b88f33f9 100644 --- a/src/apis/dns/v2beta1.ts +++ b/src/apis/dns/v2beta1.ts @@ -339,7 +339,7 @@ export namespace dns_v2beta1 { /** * User labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * User assigned name for this resource. Must be unique within the project. * The name must be 1-63 characters long, must begin with a letter, end with diff --git a/src/apis/doubleclicksearch/v2.ts b/src/apis/doubleclicksearch/v2.ts index 428c26118bc..c8b67a685ff 100644 --- a/src/apis/doubleclicksearch/v2.ts +++ b/src/apis/doubleclicksearch/v2.ts @@ -348,7 +348,7 @@ export namespace doubleclicksearch_v2 { * Asynchronous report only. Contains a list of generated report files once * the report has succesfully completed. */ - files?: any[]; + files?: Array<{byteCount?: string; url?: string;}>; /** * Asynchronous report only. Id of the report. */ @@ -479,7 +479,10 @@ export namespace doubleclicksearch_v2 { * A list of filters to be applied to the report. The maximum number of * filters per request is 300. */ - filters?: any[]; + filters?: Array<{ + column?: Schema$ReportApiColumnSpec; operator?: string; + values?: any[]; + }>; /** * Determines if removed entities should be included in the report. Defaults * to false. Deprecated, please use includeRemovedEntities instead. @@ -501,13 +504,21 @@ export namespace doubleclicksearch_v2 { * sorting to be performed on the report rows. The maximum number of * orderings per request is 300. */ - orderBy?: any[]; + orderBy?: Array<{column?: Schema$ReportApiColumnSpec; sortOrder?: string;}>; /** * The reportScope is a set of IDs that are used to determine which subset * of entities will be returned in the report. The full lineage of IDs from * the lowest scoped level desired up through agency is required. */ - reportScope?: any; + reportScope?: { + adGroupId?: string; + adId?: string; + advertiserId?: string; + agencyId?: string; + campaignId?: string; + engineAccountId?: string; + keywordId?: string; + }; /** * Determines the type of rows that are returned in the report. For example, * if you specify reportType: keyword, each row in the report will contain @@ -538,7 +549,12 @@ export namespace doubleclicksearch_v2 { * If metrics are requested in a report, this argument will be used to * restrict the metrics to a specific time range. */ - timeRange?: any; + timeRange?: { + changedAttributesSinceTimestamp?: string; + changedMetricsSinceTimestamp?: string; + endDate?: string; + startDate?: string; + }; /** * If true, the report would only be created if all the requested stat data * are sourced from a single timezone. Defaults to false. diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 4c8d8ff7125..0331641c82d 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -133,7 +133,10 @@ export namespace drive_v2 { * Information about supported additional roles per file type. The most * specific type takes precedence. */ - additionalRoleInfo?: any[]; + additionalRoleInfo?: Array<{ + roleSets?: Array<{additionalRoles?: string[]; primaryRole?: string;}>; + type?: string; + }>; /** * Whether the user can create Team Drives. */ @@ -150,11 +153,11 @@ export namespace drive_v2 { /** * The allowable export formats. */ - exportFormats?: any[]; + exportFormats?: Array<{source?: string; targets?: string[];}>; /** * List of additional features enabled on this account. */ - features?: any[]; + features?: Array<{featureName?: string; featureRate?: number;}>; /** * The palette of allowable folder colors as RGB hex strings. */ @@ -162,7 +165,7 @@ export namespace drive_v2 { /** * The allowable import formats. */ - importFormats?: any[]; + importFormats?: Array<{source?: string; targets?: string[];}>; /** * A boolean indicating whether the authenticated app is installed by the * authenticated user. @@ -186,7 +189,7 @@ export namespace drive_v2 { * List of max upload sizes for each file type. The most specific type takes * precedence. */ - maxUploadSizes?: any[]; + maxUploadSizes?: Array<{size?: string; type?: string;}>; /** * The name of the current user. */ @@ -198,7 +201,7 @@ export namespace drive_v2 { /** * The amount of storage quota used by different Google services. */ - quotaBytesByService?: any[]; + quotaBytesByService?: Array<{bytesUsed?: string; serviceName?: string;}>; /** * The total number of quota bytes. */ @@ -235,7 +238,8 @@ export namespace drive_v2 { /** * A list of themes that are supported for Team Drives. */ - teamDriveThemes?: any[]; + teamDriveThemes?: + Array<{backgroundImageLink?: string; colorRgb?: string; id?: string;}>; /** * The authenticated user. */ @@ -269,7 +273,7 @@ export namespace drive_v2 { /** * The various icons for the app. */ - icons?: any[]; + icons?: Array<{category?: string; iconUrl?: string; size?: number;}>; /** * The ID of the app. */ @@ -494,7 +498,7 @@ export namespace drive_v2 { /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: any; + params?: {[key: string]: string;}; /** * A Boolean value to indicate whether payload is wanted. Optional. */ @@ -599,7 +603,7 @@ export namespace drive_v2 { /** * The context of the file which is being commented on. */ - context?: any; + context?: {type?: string; value?: string;}; /** * The date when this comment was first created. */ @@ -777,7 +781,32 @@ export namespace drive_v2 { * Capabilities the current user has on this file. Each capability * corresponds to a fine-grained action that a user may take. */ - capabilities?: any; + capabilities?: { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermission?: boolean; + canChangeRestrictedDownload?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDelete?: boolean; + canDeleteChildren?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canMoveChildrenOutOfTeamDrive?: boolean; + canMoveChildrenWithinTeamDrive?: boolean; + canMoveItemIntoTeamDrive?: boolean; + canMoveItemOutOfTeamDrive?: boolean; + canMoveItemWithinTeamDrive?: boolean; + canMoveTeamDriveItem?: boolean; + canReadRevisions?: boolean; + canReadTeamDrive?: boolean; + canRemoveChildren?: boolean; + canRename?: boolean; + canShare?: boolean; + canTrash?: boolean; + canTrashChildren?: boolean; + canUntrash?: boolean; + }; /** * Deprecated: use capabilities/canCopy. */ @@ -826,7 +855,7 @@ export namespace drive_v2 { /** * Links for exporting Google Docs to specific formats. */ - exportLinks?: any; + exportLinks?: {[key: string]: string;}; /** * The final component of fullFileExtension with trailing text that does not * appear to be part of the extension removed. This field is only populated @@ -886,11 +915,33 @@ export namespace drive_v2 { * and its contents will depend on what can be parsed from the image * content. */ - imageMediaMetadata?: any; + imageMediaMetadata?: { + aperture?: number; + cameraMake?: string; + cameraModel?: string; + colorSpace?: string; + date?: string; + exposureBias?: number; + exposureMode?: string; + exposureTime?: number; + flashUsed?: boolean; + focalLength?: number; + height?: number; + isoSpeed?: number; + lens?: string; + location?: {altitude?: number; latitude?: number; longitude?: number;}; + maxApertureValue?: number; + meteringMode?: string; + rotation?: number; + sensor?: string; + subjectDistance?: number; + whiteBalance?: string; + width?: number; + }; /** * Indexable text attributes for the file (can only be written) */ - indexableText?: any; + indexableText?: {text?: string;}; /** * Whether the file was created or opened by the requesting app. */ @@ -902,7 +953,14 @@ export namespace drive_v2 { /** * A group of labels for the file. */ - labels?: any; + labels?: { + hidden?: boolean; + modified?: boolean; + restricted?: boolean; + starred?: boolean; + trashed?: boolean; + viewed?: boolean; + }; /** * The last user to modify this file. */ @@ -949,7 +1007,7 @@ export namespace drive_v2 { * file with that app. Only populated when the drive.apps.readonly scope is * used. */ - openWithLinks?: any; + openWithLinks?: {[key: string]: string;}; /** * The original filename of the uploaded content if available, or else the * original value of the title field. This is only available for files with @@ -1029,7 +1087,7 @@ export namespace drive_v2 { * A thumbnail for the file. This will only be used if Drive cannot generate * a standard thumbnail. */ - thumbnail?: any; + thumbnail?: {image?: string; mimeType?: string;}; /** * A short-lived link to the file's thumbnail. Typically lasts on the * order of hours. Only populated when the requesting app can access the @@ -1069,7 +1127,8 @@ export namespace drive_v2 { /** * Metadata about video media. This will only be present for video types. */ - videoMediaMetadata?: any; + videoMediaMetadata?: + {durationMillis?: string; height?: number; width?: number;}; /** * A link for downloading the content of the file in a browser using cookie * based authentication. In cases where the content is shared publicly, the @@ -1270,7 +1329,13 @@ export namespace drive_v2 { * or directly on this item. This is an output-only field which is present * only for Team Drive items. */ - teamDrivePermissionDetails?: any[]; + teamDrivePermissionDetails?: Array<{ + additionalRoles?: string[]; + inherited?: boolean; + inheritedFrom?: string; + role?: string; + teamDrivePermissionType?: string; + }>; /** * The account type. Allowed values are: - user - group - domain - * anyone @@ -1402,7 +1467,7 @@ export namespace drive_v2 { /** * Links for exporting Google Docs to specific formats. */ - exportLinks?: any; + exportLinks?: {[key: string]: string;}; /** * The size of the revision in bytes. This will only be populated on files * with content stored in Drive. @@ -1524,7 +1589,12 @@ export namespace drive_v2 { * drive.teamdrives.update requests that don't set themeId. When * specified, all fields of the backgroundImageFile must be set. */ - backgroundImageFile?: any; + backgroundImageFile?: { + id?: string; + width?: number; + xCoordinate?: number; + yCoordinate?: number; + }; /** * A short-lived link to this Team Drive's background image. */ @@ -1532,7 +1602,27 @@ export namespace drive_v2 { /** * Capabilities the current user has on this Team Drive. */ - capabilities?: any; + capabilities?: { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermissionRestriction?: boolean; + canChangeDomainUsersOnlyRestriction?: boolean; + canChangeTeamDriveBackground?: boolean; + canChangeTeamMembersOnlyRestriction?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDeleteChildren?: boolean; + canDeleteTeamDrive?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canManageMembers?: boolean; + canReadRevisions?: boolean; + canRemoveChildren?: boolean; + canRename?: boolean; + canRenameTeamDrive?: boolean; + canShare?: boolean; + canTrashChildren?: boolean; + }; /** * The color of this Team Drive as an RGB hex string. It can only be set on * a drive.teamdrives.update request that does not set themeId. @@ -1559,7 +1649,12 @@ export namespace drive_v2 { * A set of restrictions that apply to this Team Drive or items inside this * Team Drive. */ - restrictions?: any; + restrictions?: { + adminManagedRestrictions?: boolean; + copyRequiresWriterPermission?: boolean; + domainUsersOnly?: boolean; + teamMembersOnly?: boolean; + }; /** * The ID of the theme from which the background image and color will be * set. The set of possible teamDriveThemes can be retrieved from a @@ -1615,7 +1710,7 @@ export namespace drive_v2 { /** * The user's profile picture. */ - picture?: any; + picture?: {url?: string;}; } diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 6957e4ee711..14c472a99f3 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -130,7 +130,7 @@ export namespace drive_v3 { /** * A map of source MIME type to possible targets for all supported exports. */ - exportFormats?: any; + exportFormats?: {[key: string]: string[];}; /** * The currently supported folder colors as RGB hex strings. */ @@ -138,7 +138,7 @@ export namespace drive_v3 { /** * A map of source MIME type to possible targets for all supported imports. */ - importFormats?: any; + importFormats?: {[key: string]: string[];}; /** * Identifies what kind of resource this is. Value: the fixed string * "drive#about". @@ -147,7 +147,7 @@ export namespace drive_v3 { /** * A map of maximum import sizes by MIME type, in bytes. */ - maxImportSizes?: any; + maxImportSizes?: {[key: string]: string;}; /** * The maximum upload size in bytes. */ @@ -156,11 +156,17 @@ export namespace drive_v3 { * The user's storage quota limits and usage. All fields are measured in * bytes. */ - storageQuota?: any; + storageQuota?: { + limit?: string; + usage?: string; + usageInDrive?: string; + usageInDriveTrash?: string; + }; /** * A list of themes that are supported for Team Drives. */ - teamDriveThemes?: any[]; + teamDriveThemes?: + Array<{backgroundImageLink?: string; colorRgb?: string; id?: string;}>; /** * The authenticated user. */ @@ -260,7 +266,7 @@ export namespace drive_v3 { /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: any; + params?: {[key: string]: string;}; /** * A Boolean value to indicate whether payload is wanted. Optional. */ @@ -334,7 +340,7 @@ export namespace drive_v3 { * region. For a text file, for example, this would be the text at the * location of the comment. */ - quotedFileContent?: any; + quotedFileContent?: {mimeType?: string; value?: string;}; /** * The full list of replies to the comment in chronological order. */ @@ -375,17 +381,45 @@ export namespace drive_v3 { * requesting app. Entries with null values are cleared in update and copy * requests. */ - appProperties?: any; + appProperties?: {[key: string]: string;}; /** * Capabilities the current user has on this file. Each capability * corresponds to a fine-grained action that a user may take. */ - capabilities?: any; + capabilities?: { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermission?: boolean; + canChangeViewersCanCopyContent?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDelete?: boolean; + canDeleteChildren?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canMoveChildrenOutOfTeamDrive?: boolean; + canMoveChildrenWithinTeamDrive?: boolean; + canMoveItemIntoTeamDrive?: boolean; + canMoveItemOutOfTeamDrive?: boolean; + canMoveItemWithinTeamDrive?: boolean; + canMoveTeamDriveItem?: boolean; + canReadRevisions?: boolean; + canReadTeamDrive?: boolean; + canRemoveChildren?: boolean; + canRename?: boolean; + canShare?: boolean; + canTrash?: boolean; + canTrashChildren?: boolean; + canUntrash?: boolean; + }; /** * Additional information about the content of the file. These fields are * never populated in responses. */ - contentHints?: any; + contentHints?: { + indexableText?: string; + thumbnail?: {image?: string; mimeType?: string;}; + }; /** * Whether the options to copy, print, or download this file, should be * disabled for readers and commenters. @@ -451,7 +485,29 @@ export namespace drive_v3 { /** * Additional metadata about image media, if available. */ - imageMediaMetadata?: any; + imageMediaMetadata?: { + aperture?: number; + cameraMake?: string; + cameraModel?: string; + colorSpace?: string; + exposureBias?: number; + exposureMode?: string; + exposureTime?: number; + flashUsed?: boolean; + focalLength?: number; + height?: number; + isoSpeed?: number; + lens?: string; + location?: {altitude?: number; latitude?: number; longitude?: number;}; + maxApertureValue?: number; + meteringMode?: string; + rotation?: number; + sensor?: string; + subjectDistance?: number; + time?: string; + whiteBalance?: string; + width?: number; + }; /** * Whether the file was created or opened by the requesting app. */ @@ -536,7 +592,7 @@ export namespace drive_v3 { * A collection of arbitrary key-value pairs which are visible to all apps. * Entries with null values are cleared in update and copy requests. */ - properties?: any; + properties?: {[key: string]: string;}; /** * The number of storage quota bytes used by the file. This includes the * head revision as well as previous revisions with keepForever enabled. @@ -609,7 +665,8 @@ export namespace drive_v3 { * Additional metadata about video media. This may not be available * immediately upon upload. */ - videoMediaMetadata?: any; + videoMediaMetadata?: + {durationMillis?: string; height?: number; width?: number;}; /** * Whether the file has been viewed by this user. */ @@ -747,7 +804,12 @@ export namespace drive_v3 { * or directly on this item. This is an output-only field which is present * only for Team Drive items. */ - teamDrivePermissionDetails?: any[]; + teamDrivePermissionDetails?: Array<{ + inherited?: boolean; + inheritedFrom?: string; + role?: string; + teamDrivePermissionType?: string; + }>; /** * The type of the grantee. Valid values are: - user - group - domain - * anyone @@ -950,7 +1012,12 @@ export namespace drive_v3 { * drive.teamdrives.update requests that don't set themeId. When * specified, all fields of the backgroundImageFile must be set. */ - backgroundImageFile?: any; + backgroundImageFile?: { + id?: string; + width?: number; + xCoordinate?: number; + yCoordinate?: number; + }; /** * A short-lived link to this Team Drive's background image. */ @@ -958,7 +1025,27 @@ export namespace drive_v3 { /** * Capabilities the current user has on this Team Drive. */ - capabilities?: any; + capabilities?: { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermissionRestriction?: boolean; + canChangeDomainUsersOnlyRestriction?: boolean; + canChangeTeamDriveBackground?: boolean; + canChangeTeamMembersOnlyRestriction?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDeleteChildren?: boolean; + canDeleteTeamDrive?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canManageMembers?: boolean; + canReadRevisions?: boolean; + canRemoveChildren?: boolean; + canRename?: boolean; + canRenameTeamDrive?: boolean; + canShare?: boolean; + canTrashChildren?: boolean; + }; /** * The color of this Team Drive as an RGB hex string. It can only be set on * a drive.teamdrives.update request that does not set themeId. @@ -986,7 +1073,12 @@ export namespace drive_v3 { * A set of restrictions that apply to this Team Drive or items inside this * Team Drive. */ - restrictions?: any; + restrictions?: { + adminManagedRestrictions?: boolean; + copyRequiresWriterPermission?: boolean; + domainUsersOnly?: boolean; + teamMembersOnly?: boolean; + }; /** * The ID of the theme from which the background image and color will be * set. The set of possible teamDriveThemes can be retrieved from a diff --git a/src/apis/driveactivity/README.md b/src/apis/driveactivity/README.md new file mode 100644 index 00000000000..b8068c8b029 --- /dev/null +++ b/src/apis/driveactivity/README.md @@ -0,0 +1,27 @@ +Google Inc. logo + +# @google/driveactivity + +> Provides a historical view of activity in Google Drive. + +## Installation + +```sh +$ npm install @google/driveactivity +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/google/google-api-nodejs-client). + +## License +This library is licensed under Apache 2.0. Full license text is available in [COPYING](https://github.com/google/google-api-nodejs-client/blob/master/COPYING). + +## 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/google/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/partners/index.ts b/src/apis/driveactivity/index.ts similarity index 60% rename from src/apis/partners/index.ts rename to src/apis/driveactivity/index.ts index 3c3d3a3fc76..0fd12644c5c 100644 --- a/src/apis/partners/index.ts +++ b/src/apis/driveactivity/index.ts @@ -14,15 +14,16 @@ /*! THIS FILE IS AUTO-GENERATED */ import {getAPI, GoogleConfigurable} from 'googleapis-common'; -import {partners_v2} from './v2'; +import {driveactivity_v2} from './v2'; export const VERSIONS = { - 'v2': partners_v2.Partners, + 'v2': driveactivity_v2.Driveactivity, }; -export function partners(version: 'v2'): partners_v2.Partners; -export function partners(options: partners_v2.Options): partners_v2.Partners; -export function partners( - this: GoogleConfigurable, versionOrOptions: 'v2'|partners_v2.Options) { - return getAPI('partners', versionOrOptions, VERSIONS, this); +export function driveactivity(version: 'v2'): driveactivity_v2.Driveactivity; +export function driveactivity(options: driveactivity_v2.Options): + driveactivity_v2.Driveactivity; +export function driveactivity( + this: GoogleConfigurable, versionOrOptions: 'v2'|driveactivity_v2.Options) { + return getAPI('driveactivity', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/partners/package.json b/src/apis/driveactivity/package.json similarity index 88% rename from src/apis/partners/package.json rename to src/apis/driveactivity/package.json index 980c628da2d..a3059129557 100644 --- a/src/apis/partners/package.json +++ b/src/apis/driveactivity/package.json @@ -1,7 +1,7 @@ { - "name": "@google/partners", + "name": "@google/driveactivity", "version": "0.1.0", - "description": "partners", + "description": "driveactivity", "main": "index.js", "types": "index.d.ts", "keywords": ["google"], diff --git a/src/apis/driveactivity/v2.ts b/src/apis/driveactivity/v2.ts new file mode 100644 index 00000000000..a18c64ade64 --- /dev/null +++ b/src/apis/driveactivity/v2.ts @@ -0,0 +1,945 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * 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 {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {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 driveactivity_v2 { + export interface Options extends GlobalOptions { + version: 'v2'; + } + + 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; + } + + /** + * Drive Activity API + * + * Provides a historical view of activity in Google Drive. + * + * @example + * const {google} = require('googleapis'); + * const driveactivity = google.driveactivity('v2'); + * + * @namespace driveactivity + * @type {Function} + * @version v2 + * @variation v2 + * @param {object=} options Options for Driveactivity + */ + export class Driveactivity { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + activity: Resource$Activity; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.activity = new Resource$Activity(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Information about the action. + */ + export interface Schema$Action { + /** + * The actor responsible for this action (or empty if all actors are + * responsible). + */ + actor?: Schema$Actor; + /** + * The type and detailed information about the action. + */ + detail?: Schema$ActionDetail; + /** + * The target this action affects (or empty if affecting all targets). This + * represents the state of the target immediately after this action + * occurred. + */ + target?: Schema$Target; + /** + * The action occurred over this time range. + */ + timeRange?: Schema$TimeRange; + /** + * The action occurred at this specific time. + */ + timestamp?: string; + } + /** + * Data describing the type and additional information of an action. + */ + export interface Schema$ActionDetail { + /** + * A change about comments was made. + */ + comment?: Schema$Comment; + /** + * An object was created. + */ + create?: Schema$Create; + /** + * An object was deleted. + */ + delete?: Schema$Delete; + /** + * A change happened in data leak prevention status. + */ + dlpChange?: Schema$DataLeakPreventionChange; + /** + * An object was edited. + */ + edit?: Schema$Edit; + /** + * An object was moved. + */ + move?: Schema$Move; + /** + * The permission on an object was changed. + */ + permissionChange?: Schema$PermissionChange; + /** + * An object was referenced in an application outside of Drive/Docs. + */ + reference?: Schema$ApplicationReference; + /** + * An object was renamed. + */ + rename?: Schema$Rename; + /** + * A deleted object was restored. + */ + restore?: Schema$Restore; + /** + * Settings were changed. + */ + settingsChange?: Schema$SettingsChange; + } + /** + * The actor of a Drive activity. + */ + export interface Schema$Actor { + /** + * An administrator. + */ + administrator?: Schema$Administrator; + /** + * An anonymous user. + */ + anonymous?: Schema$AnonymousUser; + /** + * An account acting on behalf of another. + */ + impersonation?: Schema$Impersonation; + /** + * A non-user actor (i.e. system triggered). + */ + system?: Schema$SystemEvent; + /** + * An end user. + */ + user?: Schema$User; + } + /** + * Empty message representing an administrator. + */ + export interface Schema$Administrator {} + /** + * Empty message representing an anonymous user or indicating the + * authenticated user should be anonymized. + */ + export interface Schema$AnonymousUser {} + /** + * Represents any user (including a logged out user). + */ + export interface Schema$Anyone {} + /** + * Activity in applications other than Drive. + */ + export interface Schema$ApplicationReference { + /** + * The reference type corresponding to this event. + */ + type?: string; + } + /** + * A comment with an assignment. + */ + export interface Schema$Assignment { + /** + * The sub-type of this event. + */ + subtype?: string; + } + /** + * A change about comments on an object. + */ + export interface Schema$Comment { + /** + * A change on an assignment. + */ + assignment?: Schema$Assignment; + /** + * Users who are mentioned in this comment. + */ + mentionedUsers?: Schema$User[]; + /** + * A change on a regular posted comment. + */ + post?: Schema$Post; + /** + * A change on a suggestion. + */ + suggestion?: Schema$Suggestion; + } + /** + * How the individual activities are consolidated. A set of activities may be + * consolidated into one combined activity if they are related in some way, + * such as one actor performing the same action on multiple targets, or + * multiple actors performing the same action on a single target. The strategy + * defines the rules for which activities are related. + */ + export interface Schema$ConsolidationStrategy { + /** + * The individual activities are consolidated using the legacy strategy. + */ + legacy?: Schema$Legacy; + /** + * The individual activities are not consolidated. + */ + none?: Schema$NoConsolidation; + } + /** + * An object was created by copying an existing object. + */ + export interface Schema$Copy { + /** + * The the original object. + */ + originalObject?: Schema$TargetReference; + } + /** + * An object was created. + */ + export interface Schema$Create { + /** + * If present, indicates the object was created by copying an existing Drive + * object. + */ + copy?: Schema$Copy; + /** + * If present, indicates the object was newly created (e.g. as a blank + * document), not derived from a Drive object or external object. + */ + new?: Schema$New; + /** + * If present, indicates the object originated externally and was uploaded + * to Drive. + */ + upload?: Schema$Upload; + } + /** + * A change in the object's data leak prevention status. + */ + export interface Schema$DataLeakPreventionChange { + /** + * The type of Data Leak Prevention (DLP) change. + */ + type?: string; + } + /** + * An object was deleted. + */ + export interface Schema$Delete { + /** + * The type of delete action taken. + */ + type?: string; + } + /** + * A user whose account has since been deleted. + */ + export interface Schema$DeletedUser {} + /** + * Information about a domain. + */ + export interface Schema$Domain { + /** + * An opaque string used to identify this domain. + */ + legacyId?: string; + /** + * The name of the domain, e.g. "google.com". + */ + name?: string; + } + /** + * A single Drive activity comprising one or more Actions by one or more + * Actors on one or more Targets. Some Action groupings occur spontaneously, + * such as moving an item into a shared folder triggering a permission change. + * Other groupings of related Actions, such as multiple Actors editing one + * item or moving multiple files into a new folder, are controlled by the + * selection of a ConsolidationStrategy in the QueryDriveActivityRequest. + */ + export interface Schema$DriveActivity { + /** + * Details on all actions in this activity. + */ + actions?: Schema$Action[]; + /** + * All actor(s) responsible for the activity. + */ + actors?: Schema$Actor[]; + /** + * Key information about the primary action for this activity. This is + * either representative, or the most important, of all actions in the + * activity, according to the ConsolidationStrategy in the request. + */ + primaryActionDetail?: Schema$ActionDetail; + /** + * All Drive objects this activity is about (e.g. file, folder, Team Drive). + * This represents the state of the target immediately after the actions + * occurred. + */ + targets?: Schema$Target[]; + /** + * The activity occurred over this time range. + */ + timeRange?: Schema$TimeRange; + /** + * The activity occurred at this specific time. + */ + timestamp?: string; + } + /** + * A Drive item, such as a file or folder. + */ + export interface Schema$DriveItem { + /** + * The Drive item is a file. + */ + file?: Schema$File; + /** + * The Drive item is a folder. + */ + folder?: Schema$Folder; + /** + * The MIME type of the Drive item. See + * https://developers.google.com/drive/v3/web/mime-types. + */ + mimeType?: string; + /** + * The target Drive item. The format is "items/ITEM_ID". + */ + name?: string; + /** + * Information about the owner of this Drive item. + */ + owner?: Schema$Owner; + /** + * The title of the Drive item. + */ + title?: string; + } + /** + * A lightweight reference to a Drive item, such as a file or folder. + */ + export interface Schema$DriveItemReference { + /** + * The Drive item is a file. + */ + file?: Schema$File; + /** + * The Drive item is a folder. + */ + folder?: Schema$Folder; + /** + * The target Drive item. The format is "items/ITEM_ID". + */ + name?: string; + /** + * The title of the Drive item. + */ + title?: string; + } + /** + * An empty message indicating an object was edited. + */ + export interface Schema$Edit {} + /** + * A Drive item which is a file. + */ + export interface Schema$File {} + /** + * A comment on a file. + */ + export interface Schema$FileComment { + /** + * The comment in the discussion thread. This identifier is an opaque string + * compatible with the Drive API; see + * https://developers.google.com/drive/v3/reference/comments/get + */ + legacyCommentId?: string; + /** + * The discussion thread to which the comment was added. This identifier is + * an opaque string compatible with the Drive API and references the first + * comment in a discussion; see + * https://developers.google.com/drive/v3/reference/comments/get + */ + legacyDiscussionId?: string; + /** + * The link to the discussion thread containing this comment, for example, + * "https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID". + */ + linkToDiscussion?: string; + /** + * The Drive item containing this comment. + */ + parent?: Schema$DriveItem; + } + /** + * A Drive item which is a folder. + */ + export interface Schema$Folder { + /** + * The type of Drive folder. + */ + type?: string; + } + /** + * Information about a group. + */ + export interface Schema$Group { + /** + * The email address of the group. + */ + email?: string; + /** + * The title of the group. + */ + title?: string; + } + /** + * Information about an impersonation, where an admin acts on behalf of an end + * user. Information about the acting admin is not currently available. + */ + export interface Schema$Impersonation { + /** + * The impersonated user. + */ + impersonatedUser?: Schema$User; + } + /** + * A known user. + */ + export interface Schema$KnownUser { + /** + * True if this is the user making the request. + */ + isCurrentUser?: boolean; + /** + * The identifier for this user that can be used with the People API to get + * more information. The format is "people/ACCOUNT_ID". See + * https://developers.google.com/people/. + */ + personName?: string; + } + /** + * A strategy which consolidates activities using the grouping rules from the + * legacy V1 Activity API. Similar actions occurring within a window of time + * can be grouped across multiple targets (such as moving a set of files at + * once) or multiple actors (such as several users editing the same item). + * Grouping rules for this strategy are specific to each type of action. + */ + export interface Schema$Legacy {} + /** + * An object was moved. + */ + export interface Schema$Move { + /** + * The added parent object(s). + */ + addedParents?: Schema$TargetReference[]; + /** + * The removed parent object(s). + */ + removedParents?: Schema$TargetReference[]; + } + /** + * An object was created from scratch. + */ + export interface Schema$New {} + /** + * A strategy which does no consolidation of individual activities. + */ + export interface Schema$NoConsolidation {} + /** + * Information about the owner of a Drive item. + */ + export interface Schema$Owner { + /** + * The domain of the Drive item owner. + */ + domain?: Schema$Domain; + /** + * The Team Drive that owns the Drive item. + */ + teamDrive?: Schema$TeamDriveReference; + /** + * The user that owns the Drive item. + */ + user?: Schema$User; + } + /** + * The permission setting of an object. + */ + export interface Schema$Permission { + /** + * If true, the item can be discovered (e.g. in the user's "Shared + * with me" collection) without needing a link to the item. + */ + allowDiscovery?: boolean; + /** + * If set, this permission applies to anyone, even logged out users. + */ + anyone?: Schema$Anyone; + /** + * The domain to whom this permission applies. + */ + domain?: Schema$Domain; + /** + * The group to whom this permission applies. + */ + group?: Schema$Group; + /** + * Indicates the <a + * href="/drive/web/manage-sharing#roles">Google Drive + * permissions role</a>. The role determines a user's ability to + * read, write, and comment on items. + */ + role?: string; + /** + * The user to whom this permission applies. + */ + user?: Schema$User; + } + /** + * A change of the permission setting on an item. + */ + export interface Schema$PermissionChange { + /** + * The set of permissions added by this change. + */ + addedPermissions?: Schema$Permission[]; + /** + * The set of permissions removed by this change. + */ + removedPermissions?: Schema$Permission[]; + } + /** + * A regular posted comment. + */ + export interface Schema$Post { + /** + * The sub-type of this event. + */ + subtype?: string; + } + /** + * The request message for querying Drive activity. + */ + export interface Schema$QueryDriveActivityRequest { + /** + * Return activities for this Drive folder and all children and descendants. + * The format is "items/ITEM_ID". + */ + ancestorName?: string; + /** + * Details on how to consolidate related actions that make up the activity. + * If not set, then related actions will not be consolidated. + */ + consolidationStrategy?: Schema$ConsolidationStrategy; + /** + * The filtering for items returned from this query request. The format of + * the filter string is a sequence of expressions, joined by an optional + * "AND", where each expression is of the form "field + * operator value". Supported fields: - <tt>time</tt>: + * Uses numerical operators on date values either in terms of + * milliseconds since Jan 1, 1970 or in RFC 3339 format. Examples: - + * <tt>time > 1452409200000 AND time <= 1492812924310</tt> + * - <tt>time >= "2016-01-10T01:02:03-05:00"</tt> + * - <tt>detail.action_detail_case</tt>: Uses the + * "has" operator (:) and either a singular value or a list of + * allowed action types enclosed in parentheses. Examples: - + * <tt>detail.action_detail_case: RENAME</tt> - + * <tt>detail.action_detail_case:(CREATE UPLOAD)</tt> - + * <tt>-detail.action_detail_case:MOVE</tt> + */ + filter?: string; + /** + * Return activities for this Drive item. The format is + * "items/ITEM_ID". + */ + itemName?: string; + /** + * The requested number of activity to return. If not set, a default value + * will be used. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous QueryDriveActivity + * request, if any. + */ + pageToken?: string; + } + /** + * Response message for querying Drive activity. + */ + export interface Schema$QueryDriveActivityResponse { + /** + * List of activity requested. + */ + activities?: Schema$DriveActivity[]; + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * An object was renamed. + */ + export interface Schema$Rename { + /** + * The new title of the drive object. + */ + newTitle?: string; + /** + * The previous title of the drive object. + */ + oldTitle?: string; + } + /** + * A deleted object was restored. + */ + export interface Schema$Restore { + /** + * The type of restore action taken. + */ + type?: string; + } + /** + * Information about restriction policy changes to a feature. + */ + export interface Schema$RestrictionChange { + /** + * The feature which had a change in restriction policy. + */ + feature?: string; + /** + * The restriction in place after the change. + */ + newRestriction?: string; + } + /** + * Information about settings changes. + */ + export interface Schema$SettingsChange { + /** + * The set of changes made to restrictions. + */ + restrictionChanges?: Schema$RestrictionChange[]; + } + /** + * A suggestion. + */ + export interface Schema$Suggestion { + /** + * The sub-type of this event. + */ + subtype?: string; + } + /** + * Event triggered by system operations instead of end users. + */ + export interface Schema$SystemEvent { + /** + * The type of the system event that may triggered activity. + */ + type?: string; + } + /** + * Information about the target of activity. + */ + export interface Schema$Target { + /** + * The target is a Drive item. + */ + driveItem?: Schema$DriveItem; + /** + * The target is a comment on a Drive file. + */ + fileComment?: Schema$FileComment; + /** + * The target is a Team Drive. + */ + teamDrive?: Schema$TeamDrive; + } + /** + * A lightweight reference to the target of activity. + */ + export interface Schema$TargetReference { + /** + * The target is a Drive item. + */ + driveItem?: Schema$DriveItemReference; + /** + * The target is a Team Drive. + */ + teamDrive?: Schema$TeamDriveReference; + } + /** + * Information about a Team Drive. + */ + export interface Schema$TeamDrive { + /** + * The resource name of the Team Drive. The format is + * "teamDrives/TEAM_DRIVE_ID". + */ + name?: string; + /** + * The root of this Team Drive. + */ + root?: Schema$DriveItem; + /** + * The title of the Team Drive. + */ + title?: string; + } + /** + * A lightweight reference to a Team Drive. + */ + export interface Schema$TeamDriveReference { + /** + * The resource name of the Team Drive. The format is + * "teamDrives/TEAM_DRIVE_ID". + */ + name?: string; + /** + * The title of the Team Drive. + */ + title?: string; + } + /** + * Information about time ranges. + */ + export interface Schema$TimeRange { + /** + * The end of the time range. + */ + endTime?: string; + /** + * The start of the time range. + */ + startTime?: string; + } + /** + * A user about whom nothing is currently known. + */ + export interface Schema$UnknownUser {} + /** + * An object was uploaded into Drive. + */ + export interface Schema$Upload {} + /** + * Information about an end user. + */ + export interface Schema$User { + /** + * A user whose account has since been deleted. + */ + deletedUser?: Schema$DeletedUser; + /** + * A known user. + */ + knownUser?: Schema$KnownUser; + /** + * A user about whom nothing is currently known. + */ + unknownUser?: Schema$UnknownUser; + } + + + export class Resource$Activity { + root: Driveactivity; + constructor(root: Driveactivity) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * driveactivity.activity.query + * @desc Query past activity in Google Drive. + * @alias driveactivity.activity.query + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().QueryDriveActivityRequest} 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$Activity$Query, options?: MethodOptions): + AxiosPromise; + query( + params: Params$Resource$Activity$Query, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + query( + params: Params$Resource$Activity$Query, + callback: BodyResponseCallback): + void; + query(callback: BodyResponseCallback): + void; + query( + paramsOrCallback?: Params$Resource$Activity$Query| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Activity$Query; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Activity$Query; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://driveactivity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/activity:query') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Activity$Query extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$QueryDriveActivityRequest; + } +} diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 068bcba0f28..88e662f9485 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -167,7 +167,7 @@ export namespace file_v1beta1 { /** * Resource labels to represent user provided metadata. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The resource name of the instance, in the format * projects/{project_id}/locations/{location_id}/instances/{instance_id}. @@ -254,7 +254,7 @@ export namespace file_v1beta1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -263,7 +263,7 @@ export namespace file_v1beta1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -322,7 +322,7 @@ export namespace file_v1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -338,7 +338,7 @@ export namespace file_v1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Represents the metadata of the long-running operation. @@ -422,7 +422,7 @@ export namespace file_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/firebasedynamiclinks/v1.ts b/src/apis/firebasedynamiclinks/v1.ts index bd500441576..fd710ff291f 100644 --- a/src/apis/firebasedynamiclinks/v1.ts +++ b/src/apis/firebasedynamiclinks/v1.ts @@ -333,14 +333,15 @@ export namespace firebasedynamiclinks_v1 { /** * E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps * More examples can be found in description of getNormalizedUriPrefix in - * j/c/g/firebase/dynamiclinks/uri/DdlDomain.java + * j/c/g/firebase/dynamiclinks/uri/DdlDomain.java Will fallback to + * dynamic_link_domain is this field is missing */ domainUriPrefix?: string; /** * Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl [Learn * more](https://firebase.google.com/docs/dynamic-links/android/receive) on * how to set up Dynamic Link domain associated with your Firebase project. - * Required. + * Required if missing domain_uri_prefix. */ dynamicLinkDomain?: string; /** @@ -640,6 +641,10 @@ export namespace firebasedynamiclinks_v1 { * If specified, this overrides the ios_fallback_link value on iPads. */ iosIpadFallbackLink?: string; + /** + * iOS minimum version. + */ + iosMinimumVersion?: string; } /** * Parameters for iTunes Connect App Analytics. diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index dc781f35e08..1af74544c46 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -83,7 +83,8 @@ export namespace firebasehosting_v1beta1 { /** * Firebase Hosting API * - * + * The Firebase Hosting REST API enables programmatic custom deployment for + * releasing versions of your Firebase hosted content and configuration files. * * @example * const {google} = require('googleapis'); @@ -252,20 +253,20 @@ export namespace firebasehosting_v1beta1 { */ export interface Schema$Empty {} /** - * A `Header` defines custom headers to add to a response should the request - * URL path match the pattern. + * A [`header`](/docs/hosting/full-config#headers) defines custom headers to + * add to a response should the request URL path match the pattern. */ export interface Schema$Header { /** * Required. The user-supplied [glob - * pattern](/docs/hosting/full-config#section-glob) to match against the - * request URL path. + * pattern](/docs/hosting/full-config#glob_pattern_matching) to match + * against the request URL path. */ glob?: string; /** * Required. The additional headers to add to the response. */ - headers?: any; + headers?: {[key: string]: string;}; } export interface Schema$ListDomainsResponse { /** @@ -307,7 +308,7 @@ export namespace firebasehosting_v1beta1 { * the path from the version. Calculate a hash by Gzipping the file then * taking the SHA256 hash of the newly compressed file. */ - files?: any; + files?: {[key: string]: string;}; } export interface Schema$PopulateVersionFilesResponse { /** @@ -324,23 +325,24 @@ export namespace firebasehosting_v1beta1 { uploadUrl?: string; } /** - * A `Redirect` represents the configuration for returning an HTTP redirect - * response given a matching request URL path. + * A [`redirect`](/docs/hosting/full-config#redirects) represents the + * configuration for returning an HTTP redirect response given a matching + * request URL path. */ export interface Schema$Redirect { /** * Required. The user-supplied [glob - * pattern](/docs/hosting/full-config#section-glob) to match against the - * request URL path. + * pattern](/docs/hosting/full-config#glob_pattern_matching) to match + * against the request URL path. */ glob?: string; /** * Required. The value to put in the HTTP location header of the response. * <br>The location can contain capture group values from the pattern - * using a `":"` prefix to identify the segment and an optional - * `"*"` to capture the rest of the URL. For example: - * <code>"glob": "/:capture*", - * <br>"statusCode": 301, <br>"location": + * using a `:` prefix to identify the segment and an optional `*` to capture + * the rest of the URL. For example: <code>"glob": + * "/:capture*", <br>"statusCode": 301, + * <br>"location": * "https://example.com/foo/:capture"</code> */ location?: string; @@ -386,9 +388,10 @@ export namespace firebasehosting_v1beta1 { version?: Schema$Version; } /** - * A `Rewrite` represents an internal content rewrite on the version. If the - * pattern matches, the request will be handled as if it were to the - * destination path specified in the configuration. + * A [`rewrite`](/docs/hosting/full-config#rewrites) represents an internal + * content rewrite on the version. If the pattern matches, the request will be + * handled as if it were to the destination path specified in the + * configuration. */ export interface Schema$Rewrite { /** @@ -402,8 +405,8 @@ export namespace firebasehosting_v1beta1 { function?: string; /** * Required. The user-supplied [glob - * pattern](/docs/hosting/full-config#section-glob) to match against the - * request URL path. + * pattern](/docs/hosting/full-config#glob_pattern_matching) to match + * against the request URL path. */ glob?: string; /** @@ -415,7 +418,7 @@ export namespace firebasehosting_v1beta1 { * The configuration for how incoming requests to a site should be routed and * processed before serving content. The patterns are matched and applied * according to a specific [priority - * order](/docs/hosting/url-redirects-rewrites#section-priorities). + * order](/docs/hosting/full-config#hosting_priority_order). */ export interface Schema$ServingConfig { /** @@ -446,6 +449,20 @@ export namespace firebasehosting_v1beta1 { */ trailingSlashBehavior?: string; } + /** + * A `SiteConfig` contains metadata associated with a specific site that + * controls Firebase Hosting serving behavior + */ + export interface Schema$SiteConfig { + /** + * The number of FINALIZED versions that will be held for a site before + * automatic deletion. When a new version is deployed, content for versions + * in storage in excess of this number will be deleted, and will no longer + * be billed for storage usage. Oldest versions will be deleted first; sites + * are created with an unlimited number of max_versions by default. + */ + maxVersions?: string; + } /** * A `Version` is the collection of configuration and [static * files](sites.versions.files) that determine how a site is displayed. @@ -488,7 +505,7 @@ export namespace firebasehosting_v1beta1 { /** * The labels used for extra metadata and/or filtering. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The unique identifier for a version, in the format: * <code>sites/<var>site-name</var>/versions/<var>versionID</var></code> @@ -552,8 +569,180 @@ export namespace firebasehosting_v1beta1 { getRoot() { return this.root; } + + + /** + * firebasehosting.sites.getConfig + * @desc Gets the Hosting metadata for a specific site. + * @alias firebasehosting.sites.getConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The site for which to get the SiteConfig, in the format: sites/site-name/config + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getConfig( + params?: Params$Resource$Sites$Getconfig, + options?: MethodOptions): AxiosPromise; + getConfig( + params: Params$Resource$Sites$Getconfig, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + getConfig( + params: Params$Resource$Sites$Getconfig, + callback: BodyResponseCallback): void; + getConfig(callback: BodyResponseCallback): void; + getConfig( + paramsOrCallback?: Params$Resource$Sites$Getconfig| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Sites$Getconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Getconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * firebasehosting.sites.updateConfig + * @desc Sets the Hosting metadata for a specific site. + * @alias firebasehosting.sites.updateConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The site for which to update the SiteConfig, in the format: sites/site-name/config + * @param {string=} params.updateMask A set of field names from your [site configuration](../sites.SiteConfig) that you want to update.
A field will be overwritten if, and only if, it's in the mask.
If a mask is not provided then a default mask of only [`max_versions`](../sites.SiteConfig.max_versions) will be used. + * @param {().SiteConfig} 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 + */ + updateConfig( + params?: Params$Resource$Sites$Updateconfig, + options?: MethodOptions): AxiosPromise; + updateConfig( + params: Params$Resource$Sites$Updateconfig, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + updateConfig( + params: Params$Resource$Sites$Updateconfig, + callback: BodyResponseCallback): void; + updateConfig(callback: BodyResponseCallback): void; + updateConfig( + paramsOrCallback?: Params$Resource$Sites$Updateconfig| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Sites$Updateconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Updateconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sites$Getconfig extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The site for which to get the SiteConfig, in the format: + * sites/site-name/config + */ + name?: string; } + export interface Params$Resource$Sites$Updateconfig extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. The site for which to update the SiteConfig, in the format: + * sites/site-name/config + */ + name?: string; + /** + * A set of field names from your [site configuration](../sites.SiteConfig) + * that you want to update.
A field will be overwritten if, and only if, + * it's in the mask.
If a mask is not provided then a default mask of + * only [`max_versions`](../sites.SiteConfig.max_versions) will be used. + */ + updateMask?: string; + /** + * Request body metadata + */ + requestBody?: Schema$SiteConfig; + } export class Resource$Sites$Domains { root: Firebasehosting; diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 1e4002f37d0..e3d83448aca 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -531,7 +531,7 @@ export namespace firestore_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -547,7 +547,7 @@ export namespace firestore_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The response message for Locations.ListLocations. @@ -575,7 +575,7 @@ export namespace firestore_v1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -584,7 +584,7 @@ export namespace firestore_v1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -636,7 +636,7 @@ export namespace firestore_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index d6196e3e7be..cf44d01e359 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -302,7 +302,7 @@ export namespace firestore_v1beta1 { * a `\`. For example, `` `x&y` `` represents `x&y` and `` * `bak\`tik` `` represents `` bak`tik ``. */ - fields?: any; + fields?: {[key: string]: Schema$Value;}; /** * The resource name of the document, for example * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -757,7 +757,7 @@ export namespace firestore_v1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -773,7 +773,7 @@ export namespace firestore_v1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * An object representing a latitude/longitude pair. This is expressed as a @@ -842,7 +842,7 @@ export namespace firestore_v1beta1 { /** * Labels associated with this target change. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The ID of a target to remove from this stream. */ @@ -886,7 +886,7 @@ export namespace firestore_v1beta1 { * names are forbidden except in certain documented contexts. The map keys, * represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. */ - fields?: any; + fields?: {[key: string]: Schema$Value;}; } /** * An order on a field. @@ -1068,7 +1068,7 @@ export namespace firestore_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -1325,7 +1325,7 @@ export namespace firestore_v1beta1 { /** * Labels associated with this write request. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The ID of the write stream to resume. This may only be set in the first * message. When left empty, a new write stream will be created. @@ -2619,7 +2619,7 @@ export namespace firestore_v1beta1 { * The list of field paths in the mask. See Document.fields for a field path * syntax reference. */ - 'mask.fieldPaths'?: string; + 'mask.fieldPaths'?: string[]; /** * The parent resource. For example: * `projects/{project_id}/databases/{database_id}/documents` or @@ -2666,7 +2666,7 @@ export namespace firestore_v1beta1 { * The list of field paths in the mask. See Document.fields for a field path * syntax reference. */ - 'mask.fieldPaths'?: string; + 'mask.fieldPaths'?: string[]; /** * The resource name of the Document to get. In the format: * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2698,7 +2698,7 @@ export namespace firestore_v1beta1 { * The list of field paths in the mask. See Document.fields for a field path * syntax reference. */ - 'mask.fieldPaths'?: string; + 'mask.fieldPaths'?: string[]; /** * The order to sort results by. For example: `priority desc, name`. */ @@ -2797,7 +2797,7 @@ export namespace firestore_v1beta1 { * The list of field paths in the mask. See Document.fields for a field path * syntax reference. */ - 'mask.fieldPaths'?: string; + 'mask.fieldPaths'?: string[]; /** * The resource name of the document, for example * `projects/{project_id}/databases/{database_id}/documents/{document_path}`. @@ -2807,7 +2807,7 @@ export namespace firestore_v1beta1 { * The list of field paths in the mask. See Document.fields for a field path * syntax reference. */ - 'updateMask.fieldPaths'?: string; + 'updateMask.fieldPaths'?: string[]; /** * Request body metadata diff --git a/src/apis/firestore/v1beta2.ts b/src/apis/firestore/v1beta2.ts index 5fa0454c5ff..97fee32bd8b 100644 --- a/src/apis/firestore/v1beta2.ts +++ b/src/apis/firestore/v1beta2.ts @@ -510,7 +510,7 @@ export namespace firestore_v1beta2 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -526,7 +526,7 @@ export namespace firestore_v1beta2 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -573,7 +573,7 @@ export namespace firestore_v1beta2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index 4a022b1a2f9..1b8055511d1 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -282,8 +282,7 @@ export namespace fitness_v1 { */ export interface Schema$DataPoint { /** - * Used for version checking during transformation; that is, a datapoint can - * only replace another datapoint that has an older computation time stamp. + * DO NOT USE THIS FIELD. It is ignored, and not stored. */ computationTimeMillis?: string; /** @@ -1277,7 +1276,7 @@ export namespace fitness_v1 { * The names of data types to include in the list. If not specified, all * data sources will be returned. */ - dataTypeName?: string; + dataTypeName?: string[]; /** * List data sources for the person identified. Use me to indicate the * authenticated user. Only me is supported at this time. @@ -1883,7 +1882,7 @@ export namespace fitness_v1 { * @param {object} params Parameters for request * @param {string=} params.endTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. * @param {boolean=} params.includeDeleted If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields. - * @param {string=} params.pageToken The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. + * @param {string=} params.pageToken The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. This token is treated as a timestamp (in millis since epoch). If specified, the API returns sessions modified since this time. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 7 days are returned. * @param {string=} params.startTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. * @param {string} params.userId List sessions for the person identified. Use me to indicate the authenticated user. Only me is supported at this time. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2054,9 +2053,13 @@ export namespace fitness_v1 { */ includeDeleted?: boolean; /** - * The continuation token, which is used to page through large result sets. - * To get the next page of results, set this parameter to the value of - * nextPageToken from the previous response. + * The continuation token, which is used for incremental syncing. To get the + * next batch of changes, set this parameter to the value of nextPageToken + * from the previous response. This token is treated as a timestamp (in + * millis since epoch). If specified, the API returns sessions modified + * since this time. The page token is ignored if either start or end time is + * specified. If none of start time, end time, and the page token is + * specified, sessions modified in the last 7 days are returned. */ pageToken?: string; /** diff --git a/src/apis/fusiontables/v1.ts b/src/apis/fusiontables/v1.ts index 324f7af9e1e..103a5d531c3 100644 --- a/src/apis/fusiontables/v1.ts +++ b/src/apis/fusiontables/v1.ts @@ -148,7 +148,7 @@ export namespace fusiontables_v1 { * Optional identifier of the base column. If present, this column is * derived from the specified base column. */ - baseColumn?: any; + baseColumn?: {columnId?: number; tableIndex?: number;}; /** * Identifier for the column. */ @@ -382,7 +382,11 @@ export namespace fusiontables_v1 { * Gradient function that interpolates a range of colors based on column * value. */ - gradient?: any; + gradient?: { + colors?: Array<{color?: string; opacity?: number;}>; + max?: number; + min?: number; + }; /** * Stylers can be one of three kinds: "fusiontables#fromColumn" if * the column value is to be used as is, i.e., the column values can have diff --git a/src/apis/fusiontables/v2.ts b/src/apis/fusiontables/v2.ts index fada2cf9c90..6b6d23e4ce4 100644 --- a/src/apis/fusiontables/v2.ts +++ b/src/apis/fusiontables/v2.ts @@ -148,7 +148,7 @@ export namespace fusiontables_v2 { * Identifier of the base column. If present, this column is derived from * the specified base column. */ - baseColumn?: any; + baseColumn?: {columnId?: number; tableIndex?: number;}; /** * Identifier for the column. */ @@ -430,7 +430,11 @@ export namespace fusiontables_v2 { * Gradient function that interpolates a range of colors based on column * value. */ - gradient?: any; + gradient?: { + colors?: Array<{color?: string; opacity?: number;}>; + max?: number; + min?: number; + }; /** * Stylers can be one of three kinds: "fusiontables#fromColumn if the * column value is to be used as is, i.e., the column values can have colors diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index 15ffd602eb0..22def906782 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -1330,7 +1330,7 @@ export namespace games_v1 { * An object representation of the individual components of the player's * name. For some players, these fields may not be present. */ - name?: any; + name?: {familyName?: string; givenName?: string;}; /** * The player ID that was used for this player the first time they signed * into the game in question. This is only populated for calls to player.get @@ -1735,7 +1735,7 @@ export namespace games_v1 { /** * A push token ID for iOS devices. */ - ios?: any; + ios?: {apns_device_token?: string; apns_environment?: string;}; /** * Uniquely identifies the type of this resource. Value is always the fixed * string games#pushTokenId. diff --git a/src/apis/gamesManagement/v1management.ts b/src/apis/gamesManagement/v1management.ts index 982c18d0024..e65deaf93af 100644 --- a/src/apis/gamesManagement/v1management.ts +++ b/src/apis/gamesManagement/v1management.ts @@ -311,7 +311,7 @@ export namespace gamesManagement_v1management { * An object representation of the individual components of the player's * name. For some players, these fields may not be present. */ - name?: any; + name?: {familyName?: string; givenName?: string;}; /** * The player ID that was used for this player the first time they signed * into the game in question. This is only populated for calls to player.get diff --git a/src/apis/genomics/v1.ts b/src/apis/genomics/v1.ts index 79f42d39704..7ad9779d90c 100644 --- a/src/apis/genomics/v1.ts +++ b/src/apis/genomics/v1.ts @@ -160,7 +160,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * The display name of this annotation. */ @@ -225,7 +225,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * The display name for this annotation set. */ @@ -321,7 +321,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * The call set name. */ @@ -444,7 +444,7 @@ export namespace genomics_v1 { * set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag * as well as any specified in the `Action` definition. */ - portMappings?: any; + portMappings?: {[key: string]: number;}; } /** * An event generated when a container exits. @@ -555,7 +555,7 @@ export namespace genomics_v1 { /** * Machine-readable details about the event. */ - details?: any; + details?: {[key: string]: any;}; /** * The time at which the event occurred. */ @@ -778,7 +778,7 @@ export namespace genomics_v1 { * performed on them. This is plumbed down to the MergeVariantRequests * generated by the resulting import job. */ - infoMergeConfig?: any; + infoMergeConfig?: {[key: string]: string;}; /** * Convert reference names to the canonical representation. hg19 haploytypes * (those reference names containing "_hap") are not modified in @@ -909,7 +909,7 @@ export namespace genomics_v1 { * A mapping between info field keys and the InfoMergeOperations to be * performed on them. */ - infoMergeConfig?: any; + infoMergeConfig?: {[key: string]: string;}; /** * The variants to be merged with existing variants. */ @@ -938,7 +938,7 @@ export namespace genomics_v1 { * An OperationMetadata or Metadata object. This will always be returned * with the Operation. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * The server-assigned name, which is only unique within the same service * that originally returns it. For example&#58; @@ -950,7 +950,7 @@ export namespace genomics_v1 { * If importing Variants, an ImportVariantsResponse is returned. For * pipelines and exports, an Empty response is returned. */ - response?: any; + response?: {[key: string]: any;}; } /** * An event that occurred during an Operation. @@ -998,7 +998,7 @@ export namespace genomics_v1 { * Optionally provided by the caller when submitting the request that * creates the operation. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The Google Cloud Project in which the job is scoped. */ @@ -1009,11 +1009,11 @@ export namespace genomics_v1 { * API and a GetOperation is performed on v1 API, a v1 request will be * returned. */ - request?: any; + request?: {[key: string]: any;}; /** * Runtime metadata on this Operation. */ - runtimeMetadata?: any; + runtimeMetadata?: {[key: string]: any;}; /** * The time at which the job began to run. */ @@ -1242,7 +1242,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * The mapping of the primary alignment of the `(readNumber+1)%numberReads` * read in the fragment. It replaces mate position and mate strand in SAM. @@ -1325,7 +1325,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * The read group name. This corresponds to the @RG ID field in the SAM * spec. @@ -1376,7 +1376,7 @@ export namespace genomics_v1 { /** * A map of additional read group set information. */ - info?: any; + info?: {[key: string]: any[];}; /** * The read group set name. By default this will be initialized to the * sample name of the sequenced data contained in this set. @@ -2006,7 +2006,7 @@ export namespace genomics_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -2136,7 +2136,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * Names for the variant, for example a RefSNP ID. */ @@ -2242,7 +2242,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * If this field is present, this variant call's genotype ordering * implies the phase of the bases and is consistent with any other variant @@ -2317,7 +2317,7 @@ export namespace genomics_v1 { * map<string, string[]> (string key mapping to a list of string * values). */ - info?: any; + info?: {[key: string]: any[];}; /** * The top-level key. */ diff --git a/src/apis/genomics/v1alpha2.ts b/src/apis/genomics/v1alpha2.ts index ad7e34e3015..7114b1b51af 100644 --- a/src/apis/genomics/v1alpha2.ts +++ b/src/apis/genomics/v1alpha2.ts @@ -174,7 +174,7 @@ export namespace genomics_v1alpha2 { * set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag * as well as any specified in the `Action` definition. */ - portMappings?: any; + portMappings?: {[key: string]: number;}; } /** * An event generated when a container exits. @@ -206,13 +206,13 @@ export namespace genomics_v1alpha2 { */ export interface Schema$ControllerConfig { cmd?: string; - disks?: any; + disks?: {[key: string]: string;}; gcsLogPath?: string; - gcsSinks?: any; - gcsSources?: any; + gcsSinks?: {[key: string]: Schema$RepeatedString;}; + gcsSources?: {[key: string]: Schema$RepeatedString;}; image?: string; machineType?: string; - vars?: any; + vars?: {[key: string]: string;}; } /** * An event generated whenever a resource limitation or transient error delays @@ -319,7 +319,7 @@ export namespace genomics_v1alpha2 { /** * Machine-readable details about the event. */ - details?: any; + details?: {[key: string]: any;}; /** * The time at which the event occurred. */ @@ -438,7 +438,7 @@ export namespace genomics_v1alpha2 { * An OperationMetadata or Metadata object. This will always be returned * with the Operation. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * The server-assigned name, which is only unique within the same service * that originally returns it. For example&#58; @@ -450,7 +450,7 @@ export namespace genomics_v1alpha2 { * If importing Variants, an ImportVariantsResponse is returned. For * pipelines and exports, an Empty response is returned. */ - response?: any; + response?: {[key: string]: any;}; } /** * An event that occurred during an Operation. @@ -498,7 +498,7 @@ export namespace genomics_v1alpha2 { * Optionally provided by the caller when submitting the request that * creates the operation. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The Google Cloud Project in which the job is scoped. */ @@ -509,11 +509,11 @@ export namespace genomics_v1alpha2 { * API and a GetOperation is performed on v1 API, a v1 request will be * returned. */ - request?: any; + request?: {[key: string]: any;}; /** * Runtime metadata on this Operation. */ - runtimeMetadata?: any; + runtimeMetadata?: {[key: string]: any;}; /** * The time at which the job began to run. */ @@ -739,7 +739,7 @@ export namespace genomics_v1alpha2 { * If parameters with defaults are specified here, the defaults will be * overridden. */ - inputs?: any; + inputs?: {[key: string]: string;}; /** * How long to keep the VM up after a failure (for example docker command * failed, copying input or output files failed, etc). While the VM is up, @@ -759,7 +759,7 @@ export namespace genomics_v1alpha2 { * lowercase letter, and all following characters must be a dash, lowercase * letter, or digit, except the last character, which cannot be a dash. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. Logging options. Used by the service to communicate results to * the user. @@ -771,7 +771,7 @@ export namespace genomics_v1alpha2 { * specified. If parameters with defaults are specified here, the defaults * will be overridden. */ - outputs?: any; + outputs?: {[key: string]: string;}; /** * Required. The project in which to run the pipeline. The caller must have * WRITER access to all Google Cloud services and resources (e.g. Google @@ -902,7 +902,7 @@ export namespace genomics_v1alpha2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/genomics/v2alpha1.ts b/src/apis/genomics/v2alpha1.ts index 306581606f7..ef44ccac4a0 100644 --- a/src/apis/genomics/v2alpha1.ts +++ b/src/apis/genomics/v2alpha1.ts @@ -175,7 +175,7 @@ export namespace genomics_v2alpha1 { * authors to determine whether an individual action has succeeded or * failed. */ - environment?: any; + environment?: {[key: string]: string;}; /** * The set of flags to apply to this action. */ @@ -194,7 +194,7 @@ export namespace genomics_v2alpha1 { * what sort of action they perform, such as localization or debugging). * They are returned in the operation metadata, but are otherwise ignored. */ - labels?: any; + labels?: {[key: string]: string;}; /** * A list of mounts to make available to the action. In addition to the * values specified here, every action has a special virtual disk mounted @@ -232,7 +232,7 @@ export namespace genomics_v2alpha1 { * determine the resulting port number, consult the `ContainerStartedEvent` * in the operation metadata. */ - portMappings?: any; + portMappings?: {[key: string]: number;}; /** * The maximum amount of time to give the action to complete. If the action * fails to complete before the timeout, it will be terminated and the exit @@ -256,7 +256,7 @@ export namespace genomics_v2alpha1 { /** * A workflow specific event occurred. */ - event?: any; + event?: {[key: string]: any;}; /** * The operation has finished with the given result. */ @@ -280,7 +280,7 @@ export namespace genomics_v2alpha1 { /** * The metadata that describes the operation assigned to the worker. */ - metadata?: any; + metadata?: {[key: string]: any;}; } /** * Describes a Compute Engine resource that is being managed by a running @@ -335,7 +335,7 @@ export namespace genomics_v2alpha1 { * set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag * as well as any specified in the `Action` definition. */ - portMappings?: any; + portMappings?: {[key: string]: number;}; } /** * An event generated when a container exits. @@ -443,7 +443,7 @@ export namespace genomics_v2alpha1 { /** * Machine-readable details about the event. */ - details?: any; + details?: {[key: string]: any;}; /** * The time at which the event occurred. */ @@ -515,7 +515,7 @@ export namespace genomics_v2alpha1 { /** * The user-defined labels associated with this operation. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The pipeline this operation represents. */ @@ -590,7 +590,7 @@ export namespace genomics_v2alpha1 { * An OperationMetadata or Metadata object. This will always be returned * with the Operation. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * The server-assigned name, which is only unique within the same service * that originally returns it. For example&#58; @@ -602,7 +602,7 @@ export namespace genomics_v2alpha1 { * If importing Variants, an ImportVariantsResponse is returned. For * pipelines and exports, an Empty response is returned. */ - response?: any; + response?: {[key: string]: any;}; } /** * An event that occurred during an Operation. @@ -650,7 +650,7 @@ export namespace genomics_v2alpha1 { * Optionally provided by the caller when submitting the request that * creates the operation. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The Google Cloud Project in which the job is scoped. */ @@ -661,11 +661,11 @@ export namespace genomics_v2alpha1 { * API and a GetOperation is performed on v1 API, a v1 request will be * returned. */ - request?: any; + request?: {[key: string]: any;}; /** * Runtime metadata on this Operation. */ - runtimeMetadata?: any; + runtimeMetadata?: {[key: string]: any;}; /** * The time at which the job began to run. */ @@ -684,7 +684,7 @@ export namespace genomics_v2alpha1 { * additional environment variables but cannot delete an entry from this map * (though they can overwrite it with a different value). */ - environment?: any; + environment?: {[key: string]: string;}; /** * The resources required for execution. */ @@ -753,7 +753,7 @@ export namespace genomics_v2alpha1 { * resources created while executing the operation, see the appropriate * resource message (for example, `VirtualMachine`). */ - labels?: any; + labels?: {[key: string]: string;}; /** * The description of the pipeline to run. */ @@ -852,7 +852,7 @@ export namespace genomics_v2alpha1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -924,11 +924,16 @@ export namespace genomics_v2alpha1 { * the VM. Applied on a best-effort basis to attached disk resources shortly * after VM creation. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The machine type of the virtual machine to create. Must be the short name * of a standard machine type (such as "n1-standard-1") or a - * custom machine type (such as "custom-1-4096"). + * custom machine type (such as "custom-1-4096", where + * "1" indicates the number of vCPUs and "4096" + * indicates the memory in MB). See [Creating an instance with a custom + * machine + * type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create) + * for more specifications on creating a custom machine type. */ machineType?: string; /** @@ -987,7 +992,7 @@ export namespace genomics_v2alpha1 { /** * Status of attached disks. */ - attachedDisks?: any; + attachedDisks?: {[key: string]: Schema$DiskStatus;}; /** * Status of the boot disk. */ diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index f419e87a129..a1f46a76fda 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -1918,7 +1918,7 @@ export namespace gmail_v1 { /** * History types to be returned by the function */ - historyTypes?: string; + historyTypes?: string[]; /** * Only return messages with a label matching the ID. */ @@ -3286,7 +3286,7 @@ import(paramsOrCallback?: Params$Resource$Users$Messages$Import|BodyResponseCall /** * When given and format is METADATA, only include headers specified. */ - metadataHeaders?: string; + metadataHeaders?: string[]; /** * The user's email address. The special value me can be used to indicate * the authenticated user. @@ -3402,7 +3402,7 @@ import(paramsOrCallback?: Params$Resource$Users$Messages$Import|BodyResponseCall * Only return messages with labels that match all of the specified label * IDs. */ - labelIds?: string; + labelIds?: string[]; /** * Maximum number of messages to return. */ @@ -6957,7 +6957,7 @@ import(paramsOrCallback?: Params$Resource$Users$Messages$Import|BodyResponseCall /** * When given and format is METADATA, only include headers specified. */ - metadataHeaders?: string; + metadataHeaders?: string[]; /** * The user's email address. The special value me can be used to indicate * the authenticated user. @@ -6979,7 +6979,7 @@ import(paramsOrCallback?: Params$Resource$Users$Messages$Import|BodyResponseCall * Only return threads with labels that match all of the specified label * IDs. */ - labelIds?: string; + labelIds?: string[]; /** * Maximum number of threads to return. */ diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 3bbff0905d7..1223718e3f1 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -362,7 +362,7 @@ export namespace iam_v1 { * field is non-operational and it will not be used during the lint * operation. */ - context?: any; + context?: {[key: string]: any;}; /** * The full resource name of the policy this lint request is about. The * name follows the Google Cloud Platform (GCP) resource format. For @@ -3567,7 +3567,7 @@ export namespace iam_v1 { * Duplicate key types are not allowed. If no key type is provided, all keys * are returned. */ - keyTypes?: string; + keyTypes?: string[]; /** * The resource name of the service account in the following format: * `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a diff --git a/src/apis/identitytoolkit/v3.ts b/src/apis/identitytoolkit/v3.ts index 5e7c0720b17..5d8327df042 100644 --- a/src/apis/identitytoolkit/v3.ts +++ b/src/apis/identitytoolkit/v3.ts @@ -313,7 +313,7 @@ export namespace identitytoolkit_v3 { * customized by clients: client_id, response_type, scope, redirect_uri, * state, oauth_token. */ - customParameter?: any; + customParameter?: {[key: string]: string;}; /** * The hosted domain to restrict sign-in to accounts at that domain for * Google Apps hosted accounts. @@ -1189,7 +1189,12 @@ export namespace identitytoolkit_v3 { /** * The user's profiles at the associated IdPs. */ - providerUserInfo?: any[]; + providerUserInfo?: Array<{ + displayName?: string; + federatedId?: string; + photoUrl?: string; + providerId?: string; + }>; /** * If idToken is STS id token, then this field will be refresh token. */ @@ -1237,7 +1242,7 @@ export namespace identitytoolkit_v3 { /** * The error encountered while processing the account info. */ - error?: any[]; + error?: Array<{index?: number; message?: string;}>; /** * The fixed string "identitytoolkit#UploadAccountResponse". */ @@ -1302,7 +1307,16 @@ export namespace identitytoolkit_v3 { /** * The IDP of the user. */ - providerUserInfo?: any[]; + providerUserInfo?: Array<{ + displayName?: string; + email?: string; + federatedId?: string; + phoneNumber?: string; + photoUrl?: string; + providerId?: string; + rawId?: string; + screenName?: string; + }>; /** * The user's plain text password. */ diff --git a/src/apis/index.ts b/src/apis/index.ts index e541475b1fa..f51e572afd0 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -51,6 +51,7 @@ import * as cloudiot from './cloudiot'; import * as cloudkms from './cloudkms'; import * as cloudprofiler from './cloudprofiler'; import * as cloudresourcemanager from './cloudresourcemanager'; +import * as cloudscheduler from './cloudscheduler'; import * as cloudsearch from './cloudsearch'; import * as cloudshell from './cloudshell'; import * as cloudtasks from './cloudtasks'; @@ -73,6 +74,7 @@ import * as dns from './dns'; import * as doubleclickbidmanager from './doubleclickbidmanager'; import * as doubleclicksearch from './doubleclicksearch'; import * as drive from './drive'; +import * as driveactivity from './driveactivity'; import * as file from './file'; import * as firebasedynamiclinks from './firebasedynamiclinks'; import * as firebasehosting from './firebasehosting'; @@ -104,7 +106,6 @@ import * as monitoring from './monitoring'; import * as oauth2 from './oauth2'; import * as oslogin from './oslogin'; import * as pagespeedonline from './pagespeedonline'; -import * as partners from './partners'; import * as people from './people'; import * as playcustomapp from './playcustomapp'; import * as plus from './plus'; @@ -199,6 +200,7 @@ export const APIS: APIList = { cloudkms: cloudkms.VERSIONS, cloudprofiler: cloudprofiler.VERSIONS, cloudresourcemanager: cloudresourcemanager.VERSIONS, + cloudscheduler: cloudscheduler.VERSIONS, cloudsearch: cloudsearch.VERSIONS, cloudshell: cloudshell.VERSIONS, cloudtasks: cloudtasks.VERSIONS, @@ -221,6 +223,7 @@ export const APIS: APIList = { doubleclickbidmanager: doubleclickbidmanager.VERSIONS, doubleclicksearch: doubleclicksearch.VERSIONS, drive: drive.VERSIONS, + driveactivity: driveactivity.VERSIONS, file: file.VERSIONS, firebasedynamiclinks: firebasedynamiclinks.VERSIONS, firebasehosting: firebasehosting.VERSIONS, @@ -252,7 +255,6 @@ export const APIS: APIList = { oauth2: oauth2.VERSIONS, oslogin: oslogin.VERSIONS, pagespeedonline: pagespeedonline.VERSIONS, - partners: partners.VERSIONS, people: people.VERSIONS, playcustomapp: playcustomapp.VERSIONS, plus: plus.VERSIONS, @@ -344,6 +346,7 @@ export class GeneratedAPIs { cloudkms = cloudkms.cloudkms; cloudprofiler = cloudprofiler.cloudprofiler; cloudresourcemanager = cloudresourcemanager.cloudresourcemanager; + cloudscheduler = cloudscheduler.cloudscheduler; cloudsearch = cloudsearch.cloudsearch; cloudshell = cloudshell.cloudshell; cloudtasks = cloudtasks.cloudtasks; @@ -366,6 +369,7 @@ export class GeneratedAPIs { doubleclickbidmanager = doubleclickbidmanager.doubleclickbidmanager; doubleclicksearch = doubleclicksearch.doubleclicksearch; drive = drive.drive; + driveactivity = driveactivity.driveactivity; file = file.file; firebasedynamiclinks = firebasedynamiclinks.firebasedynamiclinks; firebasehosting = firebasehosting.firebasehosting; @@ -397,7 +401,6 @@ export class GeneratedAPIs { oauth2 = oauth2.oauth2; oslogin = oslogin.oslogin; pagespeedonline = pagespeedonline.pagespeedonline; - partners = partners.partners; people = people.people; playcustomapp = playcustomapp.playcustomapp; plus = plus.plus; diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts index 28f36f4d6a3..bbd16c94e8e 100644 --- a/src/apis/jobs/v2.ts +++ b/src/apis/jobs/v2.ts @@ -199,7 +199,7 @@ export namespace jobs_v2 { */ method?: string; /** - * Optional. Specifies the traffic density to use when caculating commute + * Optional. Specifies the traffic density to use when calculating commute * time. Must not be present if departure_hour_local is specified. */ roadTraffic?: string; @@ -633,7 +633,7 @@ export namespace jobs_v2 { * Stores a map from the values of string custom field associated with `key` * to the number of jobs with that value in this histogram result. */ - stringValueHistogramResult?: any; + stringValueHistogramResult?: {[key: string]: number;}; } /** * Resource that represents the custom data not captured by the standard @@ -975,7 +975,7 @@ export namespace jobs_v2 { * companyName). Values: the count of jobs that match the filter for this * search. */ - values?: any; + values?: {[key: string]: number;}; } /** * Output only. Histogram results that matches HistogramFacets specified in @@ -1068,7 +1068,7 @@ export namespace jobs_v2 { * than 255 characters. For unfilterable `string_values`, the maximum total * size of `string_values` across all keys is 50KB. */ - customAttributes?: any; + customAttributes?: {[key: string]: Schema$CustomAttribute;}; /** * Optional. The department or functional area within the company with the * open position. The maximum number of allowed characters is 255. @@ -1186,7 +1186,7 @@ export namespace jobs_v2 { * between 1-20. If an invalid key is provided on job create or update, an * error is returned. */ - filterableCustomFields?: any; + filterableCustomFields?: {[key: string]: Schema$CustomField;}; /** * Optional. A description of bonus, commission, and other compensation * incentives associated with the job not including salary or pay. The @@ -1306,7 +1306,7 @@ export namespace jobs_v2 { * them, nor can the client use them to list jobs. The key of the map can * be any valid string. */ - unindexedCustomFields?: any; + unindexedCustomFields?: {[key: string]: Schema$CustomField;}; /** * Output only. The timestamp when this job was last updated. */ @@ -1385,7 +1385,7 @@ export namespace jobs_v2 { * to the desired custom field map value. If an invalid key is provided or * specified together with custom_attribute_filter, an error is thrown. */ - customFieldFilters?: any; + customFieldFilters?: {[key: string]: Schema$CustomFieldFilter;}; /** * Optional. This flag controls the spell-check feature. If false, the * service attempts to correct a misspelled query, for example, @@ -1422,12 +1422,11 @@ export namespace jobs_v2 { /** * Optional. The location filter specifies geo-regions containing the jobs * to search against. See LocationFilter for more information. If a - * location value is not specified, jobs are be retrieved from all - * locations. If multiple values are specified, jobs are retrieved from any - * of the specified locations, and, if different values are specified for - * the LocationFilter.distance_in_miles parameter, the maximum provided - * distance is used for all locations. At most 5 location filters are - * allowed. + * location value is not specified, jobs are retrieved from all locations. + * If multiple values are specified, jobs are retrieved from any of the + * specified locations. If different values are specified for the + * LocationFilter.distance_in_miles parameter, the maximum provided distance + * is used for all locations. At most 5 location filters are allowed. */ locationFilters?: Schema$LocationFilter[]; /** @@ -1589,7 +1588,7 @@ export namespace jobs_v2 { * location value isn't specified, jobs fitting the other search * criteria are retrieved regardless of where they're located. If * multiple values are specified, jobs are retrieved from any of the - * specified locations, and, if different values are specified for the + * specified locations. If different values are specified for the * LocationFilter.distance_in_miles parameter, the maximum provided distance * is used for all locations. At most 5 location filters are allowed. */ @@ -2007,8 +2006,7 @@ export namespace jobs_v2 { */ export interface Schema$SearchJobsRequest { /** - * Deprecated. Any value provided in this field is ignored. Optional. - * Controls whether to disable relevance thresholding. Relevance + * Optional. Controls whether to disable relevance thresholding. Relevance * thresholding removes jobs that have low relevance in search results, for * example, removing "Assistant to the CEO" positions from the * search results of a search for "CEO". Disabling relevance diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index e6ec50f8833..1671458de3c 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -208,7 +208,7 @@ export namespace jobs_v3 { */ departureTime?: Schema$TimeOfDay; /** - * Optional. Specifies the traffic density to use when caculating commute + * Optional. Specifies the traffic density to use when calculating commute * time. */ roadTraffic?: string; @@ -582,7 +582,7 @@ export namespace jobs_v3 { * Stores a map from the values of string custom field associated with `key` * to the number of jobs with that value in this histogram result. */ - stringValueHistogramResult?: any; + stringValueHistogramResult?: {[key: string]: number;}; } /** * Device information collected from the job seeker, candidate, or other @@ -645,7 +645,7 @@ export namespace jobs_v3 { * companyName). Values: the count of jobs that match the filter for this * search. */ - values?: any; + values?: {[key: string]: number;}; } /** * Output only. Histogram results that match HistogramFacets specified in @@ -719,7 +719,7 @@ export namespace jobs_v3 { * `string_values`, the maximum total size of `string_values` across all * keys is 50KB. */ - customAttributes?: any; + customAttributes?: {[key: string]: Schema$CustomAttribute;}; /** * Optional. The desired education degrees for the job, such as Bachelors, * Masters. @@ -1002,7 +1002,7 @@ export namespace jobs_v3 { * location value isn't specified, jobs fitting the other search * criteria are retrieved regardless of where they're located. If * multiple values are specified, jobs are retrieved from any of the - * specified locations, and, if different values are specified for the + * specified locations. If different values are specified for the * LocationFilter.distance_in_miles parameter, the maximum provided distance * is used for all locations. At most 5 location filters are allowed. */ @@ -1099,8 +1099,8 @@ export namespace jobs_v3 { /** * Radius in miles of the job location. This value is derived from the * location bounding box in which a circle with the specified radius - * centered from LatLng coves the area associated with the job location. For - * example, currently, "Mountain View, CA, USA" has a radius + * centered from LatLng covers the area associated with the job location. + * For example, currently, "Mountain View, CA, USA" has a radius * of 6.17 miles. */ radiusInMiles?: number; @@ -1590,7 +1590,7 @@ export namespace jobs_v3 { spellCorrection?: Schema$SpellingCorrection; /** * The precise result count, which is available only if the client set - * enable_precise_result_size to `true` or if the response is the last page + * enable_precise_result_size to `true`, or if the response is the last page * of results. Otherwise, the value is `-1`. */ totalSize?: number; @@ -1709,8 +1709,8 @@ export namespace jobs_v3 { * * @param {object} params Parameters for request * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". - * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. The maximum number of allowed characters is 255. - * @param {string=} params.languageCodes Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_codes are returned. For CompletionType.COMBINED type, only open jobs with same language_codes or companies having open jobs with same language_codes are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCodes Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. @@ -1795,26 +1795,26 @@ export namespace jobs_v3 { * query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". * For more information, see [Tags for Identifying * Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with same language_code are - * returned. For CompletionType.COMPANY_NAME type, only companies having - * open jobs with same language_code are returned. For - * CompletionType.COMBINED type, only open jobs with same language_code or - * companies having open jobs with same language_code are returned. The - * maximum number of allowed characters is 255. + * CompletionType.JOB_TITLE type, only open jobs with the same language_code + * are returned. For CompletionType.COMPANY_NAME type, only companies + * having open jobs with the same language_code are returned. For + * CompletionType.COMBINED type, only open jobs with the same language_code + * or companies having open jobs with the same language_code are returned. + * The maximum number of allowed characters is 255. */ languageCode?: string; /** * Optional. The list of languages of the query. This is the BCP-47 * language code, such as "en-US" or "sr-Latn". For more information, see * [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with same language_codes - * are returned. For CompletionType.COMPANY_NAME type, only companies - * having open jobs with same language_codes are returned. For - * CompletionType.COMBINED type, only open jobs with same language_codes or - * companies having open jobs with same language_codes are returned. The - * maximum number of allowed characters is 255. + * CompletionType.JOB_TITLE type, only open jobs with the same + * language_codes are returned. For CompletionType.COMPANY_NAME type, only + * companies having open jobs with the same language_codes are returned. For + * CompletionType.COMBINED type, only open jobs with the same language_codes + * or companies having open jobs with the same language_codes are returned. + * The maximum number of allowed characters is 255. */ - languageCodes?: string; + languageCodes?: string[]; /** * Required. Resource name of project the completion is performed within. * The format is "projects/{project_id}", for example, diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index bd31cbc7a10..9a3e815bb48 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -209,7 +209,7 @@ export namespace jobs_v3p1beta1 { * application specific context or details. At most 20 keys are supported. * The maximum total size of all keys and values is 2 KB. */ - extraInfo?: any; + extraInfo?: {[key: string]: string;}; /** * A event issued when a job seeker interacts with the application that * implements Cloud Talent Solution. @@ -253,7 +253,7 @@ export namespace jobs_v3p1beta1 { */ departureTime?: Schema$TimeOfDay; /** - * Optional. Specifies the traffic density to use when caculating commute + * Optional. Specifies the traffic density to use when calculating commute * time. */ roadTraffic?: string; @@ -637,7 +637,7 @@ export namespace jobs_v3p1beta1 { * Stores a map from the values of string custom field associated with `key` * to the number of jobs with that value in this histogram result. */ - stringValueHistogramResult?: any; + stringValueHistogramResult?: {[key: string]: number;}; } /** * Input only. Custom ranking information for SearchJobsRequest. @@ -797,7 +797,7 @@ export namespace jobs_v3p1beta1 { * `non-negative`. * (for anonymous numeric bucket) range formatted as * `<low>-<high>`, for example, `0-1000`, `MIN-0`, and `0-MAX`. */ - histogram?: any; + histogram?: {[key: string]: string;}; /** * Requested histogram expression. */ @@ -820,7 +820,7 @@ export namespace jobs_v3p1beta1 { * companyName). Values: the count of jobs that match the filter for this * search. */ - values?: any; + values?: {[key: string]: number;}; } /** * Output only. Histogram results that match HistogramFacets specified in @@ -894,7 +894,7 @@ export namespace jobs_v3p1beta1 { * `string_values`, the maximum total size of `string_values` across all * keys is 50KB. */ - customAttributes?: any; + customAttributes?: {[key: string]: Schema$CustomAttribute;}; /** * Optional. The desired education degrees for the job, such as Bachelors, * Masters. @@ -1199,7 +1199,7 @@ export namespace jobs_v3p1beta1 { * location value isn't specified, jobs fitting the other search * criteria are retrieved regardless of where they're located. If * multiple values are specified, jobs are retrieved from any of the - * specified locations, and, if different values are specified for the + * specified locations. If different values are specified for the * LocationFilter.distance_in_miles parameter, the maximum provided distance * is used for all locations. At most 5 location filters are allowed. */ @@ -1296,8 +1296,8 @@ export namespace jobs_v3p1beta1 { /** * Radius in miles of the job location. This value is derived from the * location bounding box in which a circle with the specified radius - * centered from LatLng coves the area associated with the job location. For - * example, currently, "Mountain View, CA, USA" has a radius + * centered from LatLng covers the area associated with the job location. + * For example, currently, "Mountain View, CA, USA" has a radius * of 6.17 miles. */ radiusInMiles?: number; @@ -1656,12 +1656,12 @@ export namespace jobs_v3p1beta1 { disableKeywordMatch?: boolean; /** * Optional. Controls whether highly similar jobs are returned next to each - * other in the search results. Jobs are determined to be highly similar - * based on their titles, job categories, and locations. Highly similar - * results will be clustered so that only one representative job of the - * cluster will be displayed to the job seeker higher up in the results, - * with the other jobs being displayed lower down in the results. Defaults - * to DiversificationLevel.SIMPLE if no value is specified. + * other in the search results. Jobs are identified as highly similar based + * on their titles, job categories, and locations. Highly similar results + * are clustered so that only one representative job of the cluster is + * displayed to the job seeker higher up in the results, with the other jobs + * being displayed lower down in the results. Defaults to + * DiversificationLevel.SIMPLE if no value is specified. */ diversificationLevel?: string; /** @@ -1816,7 +1816,7 @@ export namespace jobs_v3p1beta1 { spellCorrection?: Schema$SpellingCorrection; /** * The precise result count, which is available only if the client set - * enable_precise_result_size to `true` or if the response is the last page + * enable_precise_result_size to `true`, or if the response is the last page * of results. Otherwise, the value is `-1`. */ totalSize?: number; @@ -1937,8 +1937,8 @@ export namespace jobs_v3p1beta1 { * * @param {object} params Parameters for request * @param {string=} params.companyName Optional. If provided, restricts completion to specified company. The format is "projects/{project_id}/companies/{company_id}", for example, "projects/api-test-project/companies/foo". - * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned. The maximum number of allowed characters is 255. - * @param {string=} params.languageCodes Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_codes are returned. For CompletionType.COMBINED type, only open jobs with same language_codes or companies having open jobs with same language_codes are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCode Deprecated. Use language_codes instead. Optional. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_code are returned. For CompletionType.COMBINED type, only open jobs with the same language_code or companies having open jobs with the same language_code are returned. The maximum number of allowed characters is 255. + * @param {string=} params.languageCodes Optional. The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with the same language_codes are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with the same language_codes are returned. For CompletionType.COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned. The maximum number of allowed characters is 255. * @param {string} params.name Required. Resource name of project the completion is performed within. The format is "projects/{project_id}", for example, "projects/api-test-project". * @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10. * @param {string=} params.query Required. The query used to generate suggestions. The maximum number of allowed characters is 255. @@ -2023,26 +2023,26 @@ export namespace jobs_v3p1beta1 { * query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". * For more information, see [Tags for Identifying * Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with same language_code are - * returned. For CompletionType.COMPANY_NAME type, only companies having - * open jobs with same language_code are returned. For - * CompletionType.COMBINED type, only open jobs with same language_code or - * companies having open jobs with same language_code are returned. The - * maximum number of allowed characters is 255. + * CompletionType.JOB_TITLE type, only open jobs with the same language_code + * are returned. For CompletionType.COMPANY_NAME type, only companies + * having open jobs with the same language_code are returned. For + * CompletionType.COMBINED type, only open jobs with the same language_code + * or companies having open jobs with the same language_code are returned. + * The maximum number of allowed characters is 255. */ languageCode?: string; /** * Optional. The list of languages of the query. This is the BCP-47 * language code, such as "en-US" or "sr-Latn". For more information, see * [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For - * CompletionType.JOB_TITLE type, only open jobs with same language_codes - * are returned. For CompletionType.COMPANY_NAME type, only companies - * having open jobs with same language_codes are returned. For - * CompletionType.COMBINED type, only open jobs with same language_codes or - * companies having open jobs with same language_codes are returned. The - * maximum number of allowed characters is 255. + * CompletionType.JOB_TITLE type, only open jobs with the same + * language_codes are returned. For CompletionType.COMPANY_NAME type, only + * companies having open jobs with the same language_codes are returned. For + * CompletionType.COMBINED type, only open jobs with the same language_codes + * or companies having open jobs with the same language_codes are returned. + * The maximum number of allowed characters is 255. */ - languageCodes?: string; + languageCodes?: string[]; /** * Required. Resource name of project the completion is performed within. * The format is "projects/{project_id}", for example, diff --git a/src/apis/kgsearch/v1.ts b/src/apis/kgsearch/v1.ts index 3f7b29819fa..c9c42cae38c 100644 --- a/src/apis/kgsearch/v1.ts +++ b/src/apis/kgsearch/v1.ts @@ -232,7 +232,7 @@ export namespace kgsearch_v1 { * specify multiple ids in the HTTP request, repeat the parameter in the URL * as in ...?ids=A&ids=B */ - ids?: string; + ids?: string[]; /** * Enables indenting of json results. */ @@ -241,7 +241,7 @@ export namespace kgsearch_v1 { * The list of language codes (defined in ISO 693) to run the query with, * e.g. 'en'. */ - languages?: string; + languages?: string[]; /** * Limits the number of entities to be returned. */ @@ -259,6 +259,6 @@ export namespace kgsearch_v1 { * http://schema.org/Person). If multiple types are specified, returned * entities will contain one or more of these types. */ - types?: string; + types?: string[]; } } diff --git a/src/apis/language/v1.ts b/src/apis/language/v1.ts index ab4c7435f42..ec46c549fc8 100644 --- a/src/apis/language/v1.ts +++ b/src/apis/language/v1.ts @@ -393,7 +393,7 @@ export namespace language_v1 { * Knowledge Graph MIDs are provided, if available. The associated keys are * "wikipedia_url" and "mid", respectively. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * The representative name for the entity. */ @@ -595,7 +595,7 @@ export namespace language_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/language/v1beta1.ts b/src/apis/language/v1beta1.ts index 009ebf76db6..df7a5dcb4ac 100644 --- a/src/apis/language/v1beta1.ts +++ b/src/apis/language/v1beta1.ts @@ -327,7 +327,7 @@ export namespace language_v1beta1 { * Knowledge Graph MIDs are provided, if available. The associated keys are * "wikipedia_url" and "mid", respectively. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * The representative name for the entity. */ @@ -512,7 +512,7 @@ export namespace language_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/language/v1beta2.ts b/src/apis/language/v1beta2.ts index 1765de49c5e..5415b8d2721 100644 --- a/src/apis/language/v1beta2.ts +++ b/src/apis/language/v1beta2.ts @@ -392,7 +392,7 @@ export namespace language_v1beta2 { * Knowledge Graph MIDs are provided, if available. The associated keys are * "wikipedia_url" and "mid", respectively. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * The representative name for the entity. */ @@ -596,7 +596,7 @@ export namespace language_v1beta2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 803e3b5f813..c987b23d2a7 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -502,12 +502,12 @@ export namespace logging_v2 { * The log entry payload, represented as a structure that is expressed as a * JSON object. */ - jsonPayload?: any; + jsonPayload?: {[key: string]: any;}; /** * Optional. A set of user-defined (key, value) data that provides * additional information about the log entry. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. The resource name of the log to which this log entry belongs: * "projects/[PROJECT_ID]/logs/[LOG_ID]" @@ -543,7 +543,7 @@ export namespace logging_v2 { * The log entry payload, represented as a protocol buffer. Some Google * Cloud Platform services use this field for their log entry payloads. */ - protoPayload?: any; + protoPayload?: {[key: string]: any;}; /** * Output only. The time the log entry was received by Logging. */ @@ -754,7 +754,7 @@ export namespace logging_v2 { * there are upper bounds on the maximum number of labels and the number of * active time series that are allowed in a project. */ - labelExtractors?: any; + labelExtractors?: {[key: string]: string;}; /** * Optional. The metric descriptor associated with the logs-based metric. If * unspecified, it uses a default metric descriptor with a DELTA metric @@ -1000,7 +1000,7 @@ export namespace logging_v2 { * labels "project_id", "instance_id", and * "zone". */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. The monitored resource type. This field must match the type * field of a MonitoredResourceDescriptor object. For example, the type of a @@ -1072,11 +1072,11 @@ export namespace logging_v2 { * "security_group": ["a", "b", * "c"], "spot_instance": false } */ - systemLabels?: any; + systemLabels?: {[key: string]: any;}; /** * Output only. A map of user-defined metadata labels. */ - userLabels?: any; + userLabels?: {[key: string]: string;}; } /** * Complete log information about a single HTTP request to an App Engine @@ -1310,7 +1310,7 @@ export namespace logging_v2 { * as a label in this parameter, then the log entry's label is not * changed. See LogEntry. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Optional. A default log resource name that is assigned to all log entries * in entries that do not specify a value for log_name: diff --git a/src/apis/logging/v2beta1.ts b/src/apis/logging/v2beta1.ts index 45d5d6c6730..fbee305d199 100644 --- a/src/apis/logging/v2beta1.ts +++ b/src/apis/logging/v2beta1.ts @@ -458,12 +458,12 @@ export namespace logging_v2beta1 { * The log entry payload, represented as a structure that is expressed as a * JSON object. */ - jsonPayload?: any; + jsonPayload?: {[key: string]: any;}; /** * Optional. A set of user-defined (key, value) data that provides * additional information about the log entry. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. The resource name of the log to which this log entry belongs: * "projects/[PROJECT_ID]/logs/[LOG_ID]" @@ -499,7 +499,7 @@ export namespace logging_v2beta1 { * The log entry payload, represented as a protocol buffer. Some Google * Cloud Platform services use this field for their log entry payloads. */ - protoPayload?: any; + protoPayload?: {[key: string]: any;}; /** * Output only. The time the log entry was received by Logging. */ @@ -675,7 +675,7 @@ export namespace logging_v2beta1 { * there are upper bounds on the maximum number of labels and the number of * active time series that are allowed in a project. */ - labelExtractors?: any; + labelExtractors?: {[key: string]: string;}; /** * Optional. The metric descriptor associated with the logs-based metric. If * unspecified, it uses a default metric descriptor with a DELTA metric @@ -921,7 +921,7 @@ export namespace logging_v2beta1 { * labels "project_id", "instance_id", and * "zone". */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. The monitored resource type. This field must match the type * field of a MonitoredResourceDescriptor object. For example, the type of a @@ -993,11 +993,11 @@ export namespace logging_v2beta1 { * "security_group": ["a", "b", * "c"], "spot_instance": false } */ - systemLabels?: any; + systemLabels?: {[key: string]: any;}; /** * Output only. A map of user-defined metadata labels. */ - userLabels?: any; + userLabels?: {[key: string]: string;}; } /** * Complete log information about a single HTTP request to an App Engine @@ -1231,7 +1231,7 @@ export namespace logging_v2beta1 { * as a label in this parameter, then the log entry's label is not * changed. See LogEntry. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Optional. A default log resource name that is assigned to all log entries * in entries that do not specify a value for log_name: diff --git a/src/apis/manufacturers/v1.ts b/src/apis/manufacturers/v1.ts index 26dddbc9fc1..7c1ea9fe16e 100644 --- a/src/apis/manufacturers/v1.ts +++ b/src/apis/manufacturers/v1.ts @@ -862,7 +862,7 @@ export namespace manufacturers_v1 { * The information to be included in the response. Only sections listed here * will be returned. */ - include?: string; + include?: string[]; /** * Name in the format `{target_country}:{content_language}:{product_id}`. * `target_country` - The target country of the product as a CLDR @@ -890,7 +890,7 @@ export namespace manufacturers_v1 { * The information to be included in the response. Only sections listed here * will be returned. */ - include?: string; + include?: string[]; /** * Maximum number of product statuses to return in the response, used for * paging. diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index dd539b9b82b..9488f081bcd 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -148,7 +148,7 @@ export namespace ml_v1 { * Application specific response metadata. Must be set in the first response * for streaming APIs. */ - extensions?: any[]; + extensions?: Array<{[key: string]: any;}>; } /** * An observed value of a metric. @@ -256,7 +256,7 @@ export namespace ml_v1 { /** * The hyperparameters given to this trial. */ - hyperparameters?: any; + hyperparameters?: {[key: string]: string;}; /** * True if the trial is stopped early. */ @@ -359,7 +359,7 @@ export namespace ml_v1 { * href="/ml-engine/docs/tensorflow/resource-labels">using * labels</a>. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Input parameters to create a prediction job. */ @@ -492,7 +492,7 @@ export namespace ml_v1 { * href="/ml-engine/docs/tensorflow/resource-labels">using * labels</a>. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. The name specified for the model when it was created. The * model name must be unique within the project it is created in. @@ -536,7 +536,7 @@ export namespace ml_v1 { * The user labels, inherited from the model or the model version being * operated on. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Contains the name of the model associated with the operation. */ @@ -960,7 +960,7 @@ export namespace ml_v1 { * href="/ml-engine/docs/tensorflow/resource-labels">using * labels</a>. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The time the version was last used for prediction. */ @@ -1215,7 +1215,7 @@ export namespace ml_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1231,7 +1231,7 @@ export namespace ml_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A generic empty message that you can re-use to avoid defining duplicated @@ -1286,7 +1286,7 @@ export namespace ml_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 9dfa1b8e790..694def75bfb 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -102,10 +102,7 @@ export namespace monitoring_v3 { google?: GoogleConfigurable; root = this; - metricDescriptors: Resource$Metricdescriptors; - monitoredResourceDescriptors: Resource$Monitoredresourcedescriptors; projects: Resource$Projects; - timeSeries: Resource$Timeseries; uptimeCheckIps: Resource$Uptimecheckips; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -113,11 +110,7 @@ export namespace monitoring_v3 { this.google = google; this.getRoot.bind(this); - this.metricDescriptors = new Resource$Metricdescriptors(this); - this.monitoredResourceDescriptors = - new Resource$Monitoredresourcedescriptors(this); this.projects = new Resource$Projects(this); - this.timeSeries = new Resource$Timeseries(this); this.uptimeCheckIps = new Resource$Uptimecheckips(this); } @@ -261,7 +254,7 @@ export namespace monitoring_v3 { * smaller. Labels and values can contain only lowercase letters, numerals, * underscores, and dashes. Keys must begin with a letter. */ - userLabels?: any; + userLabels?: {[key: string]: string;}; } /** * A type of authentication to perform against the specified resource or URL @@ -320,7 +313,7 @@ export namespace monitoring_v3 { /** * The measurement metadata. Example: "process_id" -> 12345 */ - metadata?: any; + metadata?: {[key: string]: Schema$TypedValue;}; /** * The name of the plugin. Example: "disk". */ @@ -491,7 +484,8 @@ export namespace monitoring_v3 { * point to each of several time series. The new data point must be more * recent than any other point in its time series. Each TimeSeries value * must fully specify a unique time series by supplying all label values for - * the metric and the monitored resource. + * the metric and the monitored resource.The maximum number of TimeSeries + * objects per Create request is 200. */ timeSeries?: Schema$TimeSeries[]; } @@ -592,7 +586,7 @@ export namespace monitoring_v3 { /** * Map from label to its value, for all labels dropped in any aggregation. */ - label?: any; + label?: {[key: string]: string;}; } /** * A generic empty message that you can re-use to avoid defining duplicated @@ -618,7 +612,7 @@ export namespace monitoring_v3 { * may be only a single attachment of any given message type in a single * exemplar, and this is enforced by the system. */ - attachments?: any[]; + attachments?: Array<{[key: string]: any;}>; /** * The observation (sampling) time of the above value. */ @@ -820,7 +814,7 @@ export namespace monitoring_v3 { * to be overwritten by the second. The maximum number of headers allowed is * 100. */ - headers?: any; + headers?: {[key: string]: string;}; /** * Boolean specifiying whether to encrypt the header information. Encryption * should be specified for any headers related to authentication that you do @@ -1102,7 +1096,7 @@ export namespace monitoring_v3 { * The set of label values that uniquely identify this metric. All labels * listed in the MetricDescriptor must be assigned values. */ - labels?: any; + labels?: {[key: string]: string;}; /** * An existing metric type, see google.api.MetricDescriptor. For example, * custom.googleapis.com/invoice/paid/amount. @@ -1359,7 +1353,7 @@ export namespace monitoring_v3 { * labels "project_id", "instance_id", and * "zone". */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. The monitored resource type. This field must match the type * field of a MonitoredResourceDescriptor object. For example, the type of a @@ -1432,11 +1426,11 @@ export namespace monitoring_v3 { * "security_group": ["a", "b", * "c"], "spot_instance": false } */ - systemLabels?: any; + systemLabels?: {[key: string]: any;}; /** * Output only. A map of user-defined metadata labels. */ - userLabels?: any; + userLabels?: {[key: string]: string;}; } /** * Describes a change made to a configuration. @@ -1487,7 +1481,7 @@ export namespace monitoring_v3 { * NotificationChannelDescriptor.labels of the NotificationChannelDescriptor * corresponding to the type field. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The full REST resource name for this channel. The syntax is: * projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] @@ -1509,7 +1503,7 @@ export namespace monitoring_v3 { * letters, numerals, underscores, and dashes. Keys must begin with a * letter. */ - userLabels?: any; + userLabels?: {[key: string]: string;}; /** * Indicates whether this channel has been verified or not. On a * ListNotificationChannels or GetNotificationChannel operation, this field @@ -1585,7 +1579,7 @@ export namespace monitoring_v3 { * it should be stored as an int32 value using the * google.protobuf.Int32Value type. */ - value?: any; + value?: {[key: string]: any;}; } /** * A single data point in a time series. @@ -1711,7 +1705,7 @@ export namespace monitoring_v3 { * A list of messages that carry the error details. There is a common set of * message types for APIs to use. */ - details?: any[]; + 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 @@ -1731,9 +1725,13 @@ export namespace monitoring_v3 { port?: number; } /** - * A time interval extending just after a start time through an end time. If - * the start time is the same as the end time, then the interval represents a - * single point in time. + * A time interval extending just after a start time through an end time. The + * start time must not be later than the end time. The default start time is + * the end time, making the startTime value technically optional. Whether this + * is useful depends on the MetricKind. If the start and end times are the + * same, the interval represents a point in time. This is appropriate for + * GAUGE metrics, but not for DELTA and CUMULATIVE metrics, which cover a span + * of time. */ export interface Schema$TimeInterval { /** @@ -1996,7 +1994,43 @@ export namespace monitoring_v3 { } - export class Resource$Metricdescriptors { + export class Resource$Projects { + root: Monitoring; + alertPolicies: Resource$Projects$Alertpolicies; + collectdTimeSeries: Resource$Projects$Collectdtimeseries; + groups: Resource$Projects$Groups; + metricDescriptors: Resource$Projects$Metricdescriptors; + monitoredResourceDescriptors: + Resource$Projects$Monitoredresourcedescriptors; + notificationChannelDescriptors: + Resource$Projects$Notificationchanneldescriptors; + notificationChannels: Resource$Projects$Notificationchannels; + timeSeries: Resource$Projects$Timeseries; + uptimeCheckConfigs: Resource$Projects$Uptimecheckconfigs; + constructor(root: Monitoring) { + this.root = root; + this.getRoot.bind(this); + this.alertPolicies = new Resource$Projects$Alertpolicies(root); + this.collectdTimeSeries = new Resource$Projects$Collectdtimeseries(root); + this.groups = new Resource$Projects$Groups(root); + this.metricDescriptors = new Resource$Projects$Metricdescriptors(root); + this.monitoredResourceDescriptors = + new Resource$Projects$Monitoredresourcedescriptors(root); + this.notificationChannelDescriptors = + new Resource$Projects$Notificationchanneldescriptors(root); + this.notificationChannels = + new Resource$Projects$Notificationchannels(root); + this.timeSeries = new Resource$Projects$Timeseries(root); + this.uptimeCheckConfigs = new Resource$Projects$Uptimecheckconfigs(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Alertpolicies { root: Monitoring; constructor(root: Monitoring) { this.root = root; @@ -2009,44 +2043,43 @@ export namespace monitoring_v3 { /** - * monitoring.metricDescriptors.create - * @desc Creates a new metric descriptor. User-created metric descriptors - * define custom metrics. - * @alias monitoring.metricDescriptors.create + * monitoring.projects.alertPolicies.create + * @desc Creates a new alerting policy. + * @alias monitoring.projects.alertPolicies.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". - * @param {().MetricDescriptor} params.resource Request body data + * @param {string} params.name The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container. + * @param {().AlertPolicy} 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$Metricdescriptors$Create, - options?: MethodOptions): AxiosPromise; + params?: Params$Resource$Projects$Alertpolicies$Create, + options?: MethodOptions): AxiosPromise; create( - params: Params$Resource$Metricdescriptors$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; + params: Params$Resource$Projects$Alertpolicies$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; create( - params: Params$Resource$Metricdescriptors$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; + params: Params$Resource$Projects$Alertpolicies$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( - paramsOrCallback?: Params$Resource$Metricdescriptors$Create| - BodyResponseCallback, + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Create| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$Create; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metricdescriptors$Create; + params = {} as Params$Resource$Projects$Alertpolicies$Create; options = {}; } @@ -2059,7 +2092,7 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}/metricDescriptors') + url: (rootUrl + '/v3/{+name}/alertPolicies') .replace(/([^:]\/)\/+/g, '$1'), method: 'POST' }, @@ -2070,50 +2103,49 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * monitoring.metricDescriptors.delete - * @desc Deletes a metric descriptor. Only user-created custom metrics can - * be deleted. - * @alias monitoring.metricDescriptors.delete + * monitoring.projects.alertPolicies.delete + * @desc Deletes an alerting policy. + * @alias monitoring.projects.alertPolicies.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric". + * @param {string} params.name The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. * @param {object} [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$Metricdescriptors$Delete, + params?: Params$Resource$Projects$Alertpolicies$Delete, options?: MethodOptions): AxiosPromise; delete( - params: Params$Resource$Metricdescriptors$Delete, + params: Params$Resource$Projects$Alertpolicies$Delete, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; delete( - params: Params$Resource$Metricdescriptors$Delete, + params: Params$Resource$Projects$Alertpolicies$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; delete( - paramsOrCallback?: Params$Resource$Metricdescriptors$Delete| + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Delete| BodyResponseCallback, optionsOrCallback?: MethodOptions|BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$Delete; + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metricdescriptors$Delete; + params = {} as Params$Resource$Projects$Alertpolicies$Delete; options = {}; } @@ -2144,39 +2176,38 @@ export namespace monitoring_v3 { /** - * monitoring.metricDescriptors.get - * @desc Gets a single metric descriptor. This method does not require a - * Stackdriver account. - * @alias monitoring.metricDescriptors.get + * monitoring.projects.alertPolicies.get + * @desc Gets a single alerting policy. + * @alias monitoring.projects.alertPolicies.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count". + * @param {string} params.name The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_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$Metricdescriptors$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Metricdescriptors$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Metricdescriptors$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Metricdescriptors$Get| - BodyResponseCallback, + get(params?: Params$Resource$Projects$Alertpolicies$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Projects$Alertpolicies$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Projects$Alertpolicies$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Get| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$Get; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metricdescriptors$Get; + params = {} as Params$Resource$Projects$Alertpolicies$Get; options = {}; } @@ -2199,59 +2230,57 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * monitoring.metricDescriptors.list - * @desc Lists metric descriptors that match a filter. This method does not - * require a Stackdriver account. - * @alias monitoring.metricDescriptors.list + * monitoring.projects.alertPolicies.list + * @desc Lists the existing alerting policies for the project. + * @alias monitoring.projects.alertPolicies.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/") - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". - * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * @param {string=} params.filter If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering. + * @param {string} params.name The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. + * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering. + * @param {integer=} params.pageSize The maximum number of results to return in a single response. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. * @param {object} [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$Metricdescriptors$List, + params?: Params$Resource$Projects$Alertpolicies$List, options?: MethodOptions): - AxiosPromise; + AxiosPromise; list( - params: Params$Resource$Metricdescriptors$List, + params: Params$Resource$Projects$Alertpolicies$List, options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; + BodyResponseCallback, + callback: BodyResponseCallback): void; list( - params: Params$Resource$Metricdescriptors$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): + params: Params$Resource$Projects$Alertpolicies$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( - paramsOrCallback?: Params$Resource$Metricdescriptors$List| - BodyResponseCallback, + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$List| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Metricdescriptors$List; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metricdescriptors$List; + params = {} as Params$Resource$Projects$Alertpolicies$List; options = {}; } @@ -2264,7 +2293,7 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}/metricDescriptors') + url: (rootUrl + '/v3/{+name}/alertPolicies') .replace(/([^:]\/)\/+/g, '$1'), method: 'GET' }, @@ -2275,690 +2304,86 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback); } else { - return createAPIRequest( - parameters); + return createAPIRequest(parameters); + } + } + + + /** + * monitoring.projects.alertPolicies.patch + * @desc Updates an alerting policy. You can either replace the entire + * policy with a new one or replace only certain fields in the current + * alerting policy by specifying the fields to be updated via updateMask. + * Returns the updated alerting policy. + * @alias monitoring.projects.alertPolicies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. + * @param {string=} params.updateMask Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created. + * @param {().AlertPolicy} 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$Alertpolicies$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Alertpolicies$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Alertpolicies$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Alertpolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Alertpolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Metricdescriptors$Create extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$MetricDescriptor; - } - export interface Params$Resource$Metricdescriptors$Delete extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The metric descriptor on which to execute the request. The format is - * "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An - * example of {metric_id} is: "custom.googleapis.com/my_test_metric". - */ - name?: string; - } - export interface Params$Resource$Metricdescriptors$Get extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The metric descriptor on which to execute the request. The format is - * "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An - * example value of {metric_id} is - * "compute.googleapis.com/instance/disk/read_bytes_count". - */ - name?: string; - } - export interface Params$Resource$Metricdescriptors$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * If this field is empty, all custom and system-defined metric descriptors - * are returned. Otherwise, the filter specifies which metric descriptors - * are to be returned. For example, the following filter matches all custom - * metrics: metric.type = starts_with("custom.googleapis.com/") - */ - filter?: string; - /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". - */ - name?: string; - /** - * A positive number that is the maximum number of results to return. - */ - pageSize?: number; - /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. - */ - pageToken?: string; - } - - - export class Resource$Monitoredresourcedescriptors { - root: Monitoring; - constructor(root: Monitoring) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * monitoring.monitoredResourceDescriptors.get - * @desc Gets a single monitored resource descriptor. This method does not - * require a Stackdriver account. - * @alias monitoring.monitoredResourceDescriptors.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. - * @param {object} [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$Monitoredresourcedescriptors$Get, - options?: MethodOptions): - AxiosPromise; - get(params: Params$Resource$Monitoredresourcedescriptors$Get, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - get(params: Params$Resource$Monitoredresourcedescriptors$Get, - callback: BodyResponseCallback): - void; - get(callback: BodyResponseCallback): - void; - get(paramsOrCallback?: Params$Resource$Monitoredresourcedescriptors$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Monitoredresourcedescriptors$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Monitoredresourcedescriptors$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * monitoring.monitoredResourceDescriptors.list - * @desc Lists monitored resource descriptors that match a filter. This - * method does not require a Stackdriver account. - * @alias monitoring.monitoredResourceDescriptors.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". - * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - * @param {object} [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$Monitoredresourcedescriptors$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list(callback: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): void; - list( - paramsOrCallback?: Params$Resource$Monitoredresourcedescriptors$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$ListMonitoredResourceDescriptorsResponse>): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Monitoredresourcedescriptors$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Monitoredresourcedescriptors$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}/monitoredResourceDescriptors') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest< - Schema$ListMonitoredResourceDescriptorsResponse>(parameters); - } - } - } - - export interface Params$Resource$Monitoredresourcedescriptors$Get extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The monitored resource descriptor to get. The format is - * "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". - * The {resource_type} is a predefined type, such as cloudsql_database. - */ - name?: string; - } - export interface Params$Resource$Monitoredresourcedescriptors$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * An optional filter describing the descriptors to be returned. The filter - * can reference the descriptor's type and labels. For example, the - * following filter returns only Google Compute Engine descriptors that have - * an id label: resource.type = starts_with("gce_") AND resource.label:id - */ - filter?: string; - /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". - */ - name?: string; - /** - * A positive number that is the maximum number of results to return. - */ - pageSize?: number; - /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. - */ - pageToken?: string; - } - - - export class Resource$Projects { - root: Monitoring; - alertPolicies: Resource$Projects$Alertpolicies; - collectdTimeSeries: Resource$Projects$Collectdtimeseries; - groups: Resource$Projects$Groups; - metricDescriptors: Resource$Projects$Metricdescriptors; - monitoredResourceDescriptors: - Resource$Projects$Monitoredresourcedescriptors; - notificationChannelDescriptors: - Resource$Projects$Notificationchanneldescriptors; - notificationChannels: Resource$Projects$Notificationchannels; - timeSeries: Resource$Projects$Timeseries; - uptimeCheckConfigs: Resource$Projects$Uptimecheckconfigs; - constructor(root: Monitoring) { - this.root = root; - this.getRoot.bind(this); - this.alertPolicies = new Resource$Projects$Alertpolicies(root); - this.collectdTimeSeries = new Resource$Projects$Collectdtimeseries(root); - this.groups = new Resource$Projects$Groups(root); - this.metricDescriptors = new Resource$Projects$Metricdescriptors(root); - this.monitoredResourceDescriptors = - new Resource$Projects$Monitoredresourcedescriptors(root); - this.notificationChannelDescriptors = - new Resource$Projects$Notificationchanneldescriptors(root); - this.notificationChannels = - new Resource$Projects$Notificationchannels(root); - this.timeSeries = new Resource$Projects$Timeseries(root); - this.uptimeCheckConfigs = new Resource$Projects$Uptimecheckconfigs(root); - } - - getRoot() { - return this.root; - } - } - - - export class Resource$Projects$Alertpolicies { - root: Monitoring; - constructor(root: Monitoring) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * monitoring.projects.alertPolicies.create - * @desc Creates a new alerting policy. - * @alias monitoring.projects.alertPolicies.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container. - * @param {().AlertPolicy} 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$Alertpolicies$Create, - options?: MethodOptions): AxiosPromise; - create( - params: Params$Resource$Projects$Alertpolicies$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Alertpolicies$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}/alertPolicies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * monitoring.projects.alertPolicies.delete - * @desc Deletes an alerting policy. - * @alias monitoring.projects.alertPolicies.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. - * @param {object} [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$Alertpolicies$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Projects$Alertpolicies$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Alertpolicies$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * monitoring.projects.alertPolicies.get - * @desc Gets a single alerting policy. - * @alias monitoring.projects.alertPolicies.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_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$Alertpolicies$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Projects$Alertpolicies$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Alertpolicies$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * monitoring.projects.alertPolicies.list - * @desc Lists the existing alerting policies for the project. - * @alias monitoring.projects.alertPolicies.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering. - * @param {string} params.name The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. - * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering. - * @param {integer=} params.pageSize The maximum number of results to return in a single response. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - * @param {object} [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$Alertpolicies$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$Alertpolicies$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Projects$Alertpolicies$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}/alertPolicies') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * monitoring.projects.alertPolicies.patch - * @desc Updates an alerting policy. You can either replace the entire - * policy with a new one or replace only certain fields in the current - * alerting policy by specifying the fields to be updated via updateMask. - * Returns the updated alerting policy. - * @alias monitoring.projects.alertPolicies.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. - * @param {string=} params.updateMask Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created. - * @param {().AlertPolicy} 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$Alertpolicies$Patch, - options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Projects$Alertpolicies$Patch, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Alertpolicies$Patch, - callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Alertpolicies$Patch| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Alertpolicies$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Alertpolicies$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Alertpolicies$Create extends + export interface Params$Resource$Projects$Alertpolicies$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -6327,7 +5752,7 @@ export namespace monitoring_v3 { * into a single output time series. If crossSeriesReducer is not defined, * this field is ignored. */ - 'aggregation.groupByFields'?: string; + 'aggregation.groupByFields'?: string[]; /** * The approach to be used to align individual time series. Not all * alignment functions may be applied to all time series, depending on the @@ -6401,174 +5826,43 @@ export namespace monitoring_v3 { /** - * monitoring.projects.uptimeCheckConfigs.create - * @desc Creates a new uptime check configuration. - * @alias monitoring.projects.uptimeCheckConfigs.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The project in which to create the uptime check. The format is projects/[PROJECT_ID]. - * @param {().UptimeCheckConfig} 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$Uptimecheckconfigs$Create, - options?: MethodOptions): AxiosPromise; - create( - params: Params$Resource$Projects$Uptimecheckconfigs$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Projects$Uptimecheckconfigs$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Uptimecheckconfigs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Uptimecheckconfigs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+parent}/uptimeCheckConfigs') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * monitoring.projects.uptimeCheckConfigs.delete - * @desc Deletes an uptime check configuration. Note that this method will - * fail if the uptime check configuration is referenced by an alert policy - * or other dependent configs that would be rendered invalid by the - * deletion. - * @alias monitoring.projects.uptimeCheckConfigs.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_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$Uptimecheckconfigs$Delete, - options?: MethodOptions): AxiosPromise; - delete( - params: Params$Resource$Projects$Uptimecheckconfigs$Delete, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - delete( - params: Params$Resource$Projects$Uptimecheckconfigs$Delete, - callback: BodyResponseCallback): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Delete| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Uptimecheckconfigs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Uptimecheckconfigs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://monitoring.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * monitoring.projects.uptimeCheckConfigs.get - * @desc Gets a single uptime check configuration. - * @alias monitoring.projects.uptimeCheckConfigs.get + * monitoring.projects.uptimeCheckConfigs.create + * @desc Creates a new uptime check configuration. + * @alias monitoring.projects.uptimeCheckConfigs.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * @param {string} params.parent The project in which to create the uptime check. The format is projects/[PROJECT_ID]. + * @param {().UptimeCheckConfig} 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 */ - get(params?: Params$Resource$Projects$Uptimecheckconfigs$Get, + create( + params?: Params$Resource$Projects$Uptimecheckconfigs$Create, options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Projects$Uptimecheckconfigs$Get, + create( + params: Params$Resource$Projects$Uptimecheckconfigs$Create, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; - get(params: Params$Resource$Projects$Uptimecheckconfigs$Get, + create( + params: Params$Resource$Projects$Uptimecheckconfigs$Create, callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Get| + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Create| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Uptimecheckconfigs$Get; + Params$Resource$Projects$Uptimecheckconfigs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Uptimecheckconfigs$Get; + params = {} as Params$Resource$Projects$Uptimecheckconfigs$Create; options = {}; } @@ -6581,13 +5875,14 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + url: (rootUrl + '/v3/{+parent}/uptimeCheckConfigs') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' }, options), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.getRoot() }; if (callback) { @@ -6599,50 +5894,44 @@ export namespace monitoring_v3 { /** - * monitoring.projects.uptimeCheckConfigs.list - * @desc Lists the existing valid uptime check configurations for the - * project, leaving out any invalid configurations. - * @alias monitoring.projects.uptimeCheckConfigs.list + * monitoring.projects.uptimeCheckConfigs.delete + * @desc Deletes an uptime check configuration. Note that this method will + * fail if the uptime check configuration is referenced by an alert policy + * or other dependent configs that would be rendered invalid by the + * deletion. + * @alias monitoring.projects.uptimeCheckConfigs.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - * @param {string} params.parent The project whose uptime check configurations are listed. The format is projects/[PROJECT_ID]. + * @param {string} params.name The uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_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$Uptimecheckconfigs$List, - options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Projects$Uptimecheckconfigs$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): - void; - list( - params: Params$Resource$Projects$Uptimecheckconfigs$List, - callback: BodyResponseCallback): - void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { + delete( + params?: Params$Resource$Projects$Uptimecheckconfigs$Delete, + options?: MethodOptions): AxiosPromise; + delete( + params: Params$Resource$Projects$Uptimecheckconfigs$Delete, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + delete( + params: Params$Resource$Projects$Uptimecheckconfigs$Delete, + callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Delete| + BodyResponseCallback, + optionsOrCallback?: MethodOptions|BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Uptimecheckconfigs$List; + Params$Resource$Projects$Uptimecheckconfigs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Uptimecheckconfigs$List; + params = {} as Params$Resource$Projects$Uptimecheckconfigs$Delete; options = {}; } @@ -6655,68 +5944,56 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+parent}/uptimeCheckConfigs') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE' }, options), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.getRoot() }; if (callback) { - createAPIRequest( - parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters); + return createAPIRequest(parameters); } } /** - * monitoring.projects.uptimeCheckConfigs.patch - * @desc Updates an uptime check configuration. You can either replace the - * entire configuration with a new one or replace only certain fields in the - * current configuration by specifying the fields to be updated via - * "updateMask". Returns the updated configuration. - * @alias monitoring.projects.uptimeCheckConfigs.patch + * monitoring.projects.uptimeCheckConfigs.get + * @desc Gets a single uptime check configuration. + * @alias monitoring.projects.uptimeCheckConfigs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. - * @param {string=} params.updateMask Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. - * @param {().UptimeCheckConfig} params.resource Request body data + * @param {string} params.name The uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_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 */ - patch( - params?: Params$Resource$Projects$Uptimecheckconfigs$Patch, + get(params?: Params$Resource$Projects$Uptimecheckconfigs$Get, options?: MethodOptions): AxiosPromise; - patch( - params: Params$Resource$Projects$Uptimecheckconfigs$Patch, + get(params: Params$Resource$Projects$Uptimecheckconfigs$Get, options: MethodOptions|BodyResponseCallback, callback: BodyResponseCallback): void; - patch( - params: Params$Resource$Projects$Uptimecheckconfigs$Patch, + get(params: Params$Resource$Projects$Uptimecheckconfigs$Get, callback: BodyResponseCallback): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Patch| + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Get| BodyResponseCallback, optionsOrCallback?: MethodOptions| BodyResponseCallback, callback?: BodyResponseCallback): void|AxiosPromise { let params = (paramsOrCallback || {}) as - Params$Resource$Projects$Uptimecheckconfigs$Patch; + Params$Resource$Projects$Uptimecheckconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Uptimecheckconfigs$Patch; + params = {} as Params$Resource$Projects$Uptimecheckconfigs$Get; options = {}; } @@ -6730,7 +6007,7 @@ export namespace monitoring_v3 { options: Object.assign( { url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' + method: 'GET' }, options), params, @@ -6744,160 +6021,53 @@ export namespace monitoring_v3 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Uptimecheckconfigs$Create extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The project in which to create the uptime check. The format is - * projects/[PROJECT_ID]. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UptimeCheckConfig; - } - export interface Params$Resource$Projects$Uptimecheckconfigs$Delete extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The uptime check configuration to delete. The format is - * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - */ - name?: string; - } - export interface Params$Resource$Projects$Uptimecheckconfigs$Get extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The uptime check configuration to retrieve. The format is - * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. - */ - name?: string; - } - export interface Params$Resource$Projects$Uptimecheckconfigs$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The maximum number of results to return in a single response. The server - * may further constrain the maximum number of results returned in a single - * page. If the page_size is <=0, the server will decide the number of - * results to be returned. - */ - pageSize?: number; - /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return more results from the previous method call. - */ - pageToken?: string; - /** - * The project whose uptime check configurations are listed. The format is - * projects/[PROJECT_ID]. - */ - parent?: string; - } - export interface Params$Resource$Projects$Uptimecheckconfigs$Patch extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * A unique resource name for this UptimeCheckConfig. The format - * is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field - * should be omitted when creating the uptime check configuration; on - * create, the resource name is assigned by the server and included in the - * response. - */ - name?: string; - /** - * Optional. If present, only the listed fields in the current uptime check - * configuration are updated with values from the new configuration. If this - * field is empty, then the current configuration is completely replaced - * with the new configuration. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UptimeCheckConfig; - } - - - - export class Resource$Timeseries { - root: Monitoring; - constructor(root: Monitoring) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } /** - * monitoring.timeSeries.create - * @desc Creates or adds data to one or more time series. The response is - * empty if all time series in the request were written. If any time series - * could not be written, a corresponding failure message is included in the - * error response. - * @alias monitoring.timeSeries.create + * monitoring.projects.uptimeCheckConfigs.list + * @desc Lists the existing valid uptime check configurations for the + * project, leaving out any invalid configurations. + * @alias monitoring.projects.uptimeCheckConfigs.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". - * @param {().CreateTimeSeriesRequest} params.resource Request body data + * @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. + * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. + * @param {string} params.parent The project whose uptime check configurations are listed. The format is projects/[PROJECT_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 */ - create(params?: Params$Resource$Timeseries$Create, options?: MethodOptions): - AxiosPromise; - create( - params: Params$Resource$Timeseries$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Timeseries$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: Params$Resource$Timeseries$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Timeseries$Create; + list( + params?: Params$Resource$Projects$Uptimecheckconfigs$List, + options?: MethodOptions): + AxiosPromise; + list( + params: Params$Resource$Projects$Uptimecheckconfigs$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + list( + params: Params$Resource$Projects$Uptimecheckconfigs$List, + callback: BodyResponseCallback): + void; + list(callback: BodyResponseCallback): + void; + list( + paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Uptimecheckconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Timeseries$Create; + params = {} as Params$Resource$Projects$Uptimecheckconfigs$List; options = {}; } @@ -6910,72 +6080,68 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}/timeSeries') + url: (rootUrl + '/v3/{+parent}/uptimeCheckConfigs') .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' + method: 'GET' }, options), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters); } } /** - * monitoring.timeSeries.list - * @desc Lists time series that match a filter. This method does not require - * a Stackdriver account. - * @alias monitoring.timeSeries.list + * monitoring.projects.uptimeCheckConfigs.patch + * @desc Updates an uptime check configuration. You can either replace the + * entire configuration with a new one or replace only certain fields in the + * current configuration by specifying the fields to be updated via + * "updateMask". Returns the updated configuration. + * @alias monitoring.projects.uptimeCheckConfigs.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.aggregation.alignmentPeriod The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. - * @param {string=} params.aggregation.crossSeriesReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. - * @param {string=} params.aggregation.groupByFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. - * @param {string=} params.aggregation.perSeriesAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. - * @param {string=} params.filter A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name" - * @param {string=} params.interval.endTime Required. The end of the time interval. - * @param {string=} params.interval.startTime Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". - * @param {string=} params.orderBy Unsupported: must be left blank. The points in each time series are returned in reverse time order. - * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - * @param {string=} params.view Specifies which information is returned about the time series. + * @param {string} params.name A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * @param {string=} params.updateMask Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. + * @param {().UptimeCheckConfig} 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 */ - list(params?: Params$Resource$Timeseries$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Timeseries$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Timeseries$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Timeseries$List| - BodyResponseCallback, + patch( + params?: Params$Resource$Projects$Uptimecheckconfigs$Patch, + options?: MethodOptions): AxiosPromise; + patch( + params: Params$Resource$Projects$Uptimecheckconfigs$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Projects$Uptimecheckconfigs$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Projects$Uptimecheckconfigs$Patch| + BodyResponseCallback, optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Timeseries$List; + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Uptimecheckconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Timeseries$List; + params = {} as Params$Resource$Projects$Uptimecheckconfigs$Patch; options = {}; } @@ -6988,9 +6154,8 @@ export namespace monitoring_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/{+name}/timeSeries') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' }, options), params, @@ -6999,14 +6164,14 @@ export namespace monitoring_v3 { context: this.getRoot() }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Timeseries$Create extends + export interface Params$Resource$Projects$Uptimecheckconfigs$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -7014,118 +6179,99 @@ export namespace monitoring_v3 { auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". + * The project in which to create the uptime check. The format is + * projects/[PROJECT_ID]. */ - name?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$CreateTimeSeriesRequest; + requestBody?: Schema$UptimeCheckConfig; } - export interface Params$Resource$Timeseries$List extends StandardParameters { + export interface Params$Resource$Projects$Uptimecheckconfigs$Delete extends + StandardParameters { /** * Auth client or API Key for the request */ auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; /** - * The alignment period for per-time series alignment. If present, - * alignmentPeriod must be at least 60 seconds. After per-time series - * alignment, each time series will contain data points only on the period - * boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, - * then this field is ignored. If perSeriesAligner is specified and does not - * equal ALIGN_NONE, then this field must be defined; otherwise an error is - * returned. - */ - 'aggregation.alignmentPeriod'?: string; - /** - * The approach to be used to combine time series. Not all reducer functions - * may be applied to all time series, depending on the metric type and the - * value type of the original time series. Reduction may change the metric - * type of value type of the time series.Time series data must be aligned in - * order to perform cross-time series reduction. If crossSeriesReducer is - * specified, then perSeriesAligner must be specified and not equal - * ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is - * returned. + * The uptime check configuration to delete. The format is + * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. */ - 'aggregation.crossSeriesReducer'?: string; + name?: string; + } + export interface Params$Resource$Projects$Uptimecheckconfigs$Get extends + StandardParameters { /** - * The set of fields to preserve when crossSeriesReducer is specified. The - * groupByFields determine how the time series are partitioned into subsets - * prior to applying the aggregation function. Each subset contains time - * series that have the same value for each of the grouping fields. Each - * individual time series is a member of exactly one subset. The - * crossSeriesReducer is applied to each subset of time series. It is not - * possible to reduce across different resource types, so this field - * implicitly contains resource.type. Fields not specified in groupByFields - * are aggregated away. If groupByFields is not specified and all the time - * series have the same resource type, then the time series are aggregated - * into a single output time series. If crossSeriesReducer is not defined, - * this field is ignored. + * Auth client or API Key for the request */ - 'aggregation.groupByFields'?: string; + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** - * The approach to be used to align individual time series. Not all - * alignment functions may be applied to all time series, depending on the - * metric type and value type of the original time series. Alignment may - * change the metric type or the value type of the time series.Time series - * data must be aligned in order to perform cross-time series reduction. If - * crossSeriesReducer is specified, then perSeriesAligner must be specified - * and not equal ALIGN_NONE and alignmentPeriod must be specified; - * otherwise, an error is returned. + * The uptime check configuration to retrieve. The format is + * projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. */ - 'aggregation.perSeriesAligner'?: string; + name?: string; + } + export interface Params$Resource$Projects$Uptimecheckconfigs$List extends + StandardParameters { /** - * A monitoring filter that specifies which time series should be returned. - * The filter must specify a single metric type, and can additionally - * specify metric labels and other information. For example: metric.type = - * "compute.googleapis.com/instance/cpu/usage_time" AND - * metric.label.instance_name = "my-instance-name" + * Auth client or API Key for the request */ - filter?: string; + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** - * Required. The end of the time interval. + * The maximum number of results to return in a single response. The server + * may further constrain the maximum number of results returned in a single + * page. If the page_size is <=0, the server will decide the number of + * results to be returned. */ - 'interval.endTime'?: string; + pageSize?: number; /** - * Optional. The beginning of the time interval. The default value for the - * start time is the end time. The start time must not be later than the end - * time. + * If this field is not empty then it must contain the nextPageToken value + * returned by a previous call to this method. Using this field causes the + * method to return more results from the previous method call. */ - 'interval.startTime'?: string; + pageToken?: string; /** - * The project on which to execute the request. The format is - * "projects/{project_id_or_number}". + * The project whose uptime check configurations are listed. The format is + * projects/[PROJECT_ID]. */ - name?: string; + parent?: string; + } + export interface Params$Resource$Projects$Uptimecheckconfigs$Patch extends + StandardParameters { /** - * Unsupported: must be left blank. The points in each time series are - * returned in reverse time order. + * Auth client or API Key for the request */ - orderBy?: string; + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + /** - * A positive number that is the maximum number of results to return. If - * page_size is empty or more than 100,000 results, the effective page_size - * is 100,000 results. If view is set to FULL, this is the maximum number of - * Points returned. If view is set to HEADERS, this is the maximum number of - * TimeSeries returned. + * A unique resource name for this UptimeCheckConfig. The format + * is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field + * should be omitted when creating the uptime check configuration; on + * create, the resource name is assigned by the server and included in the + * response. */ - pageSize?: number; + name?: string; /** - * If this field is not empty then it must contain the nextPageToken value - * returned by a previous call to this method. Using this field causes the - * method to return additional results from the previous method call. + * Optional. If present, only the listed fields in the current uptime check + * configuration are updated with values from the new configuration. If this + * field is empty, then the current configuration is completely replaced + * with the new configuration. */ - pageToken?: string; + updateMask?: string; + /** - * Specifies which information is returned about the time series. + * Request body metadata */ - view?: string; + requestBody?: Schema$UptimeCheckConfig; } + export class Resource$Uptimecheckips { root: Monitoring; constructor(root: Monitoring) { diff --git a/src/apis/oauth2/v1.ts b/src/apis/oauth2/v1.ts index 083e195a6b2..963fe5a916c 100644 --- a/src/apis/oauth2/v1.ts +++ b/src/apis/oauth2/v1.ts @@ -482,10 +482,22 @@ export namespace oauth2_v1 { } export interface Schema$Jwk { - keys?: any[]; + keys?: Array<{ + alg?: string; + e?: string; + kid?: string; + kty?: string; + n?: string; + use?: string; + }>; } export interface Schema$Raw { - keyvalues?: any[]; + keyvalues?: Array<{ + algorithm?: string; + exponent?: string; + keyid?: string; + modulus?: string; + }>; } export interface Schema$Tokeninfo { /** diff --git a/src/apis/oauth2/v2.ts b/src/apis/oauth2/v2.ts index 7507b8c19dc..1291dc3b8c3 100644 --- a/src/apis/oauth2/v2.ts +++ b/src/apis/oauth2/v2.ts @@ -227,7 +227,14 @@ export namespace oauth2_v2 { } export interface Schema$Jwk { - keys?: any[]; + keys?: Array<{ + alg?: string; + e?: string; + kid?: string; + kty?: string; + n?: string; + use?: string; + }>; } export interface Schema$Tokeninfo { /** diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index 0e8d47d3b37..4835439cd33 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -148,7 +148,7 @@ export namespace oslogin_v1 { /** * A map from SSH public key fingerprint to the associated key object. */ - sshPublicKeys?: any; + sshPublicKeys?: {[key: string]: Schema$SshPublicKey;}; } /** * The POSIX account information associated with a Google account. diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index 6e3d324a194..12a7f74188c 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -148,7 +148,7 @@ export namespace oslogin_v1alpha { /** * A map from SSH public key fingerprint to the associated key object. */ - sshPublicKeys?: any; + sshPublicKeys?: {[key: string]: Schema$SshPublicKey;}; } /** * The POSIX account information associated with a Google account. diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 2cd9013592b..7988645ec4e 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -148,7 +148,7 @@ export namespace oslogin_v1beta { /** * A map from SSH public key fingerprint to the associated key object. */ - sshPublicKeys?: any; + sshPublicKeys?: {[key: string]: Schema$SshPublicKey;}; } /** * The POSIX account information associated with a Google account. diff --git a/src/apis/pagespeedonline/index.ts b/src/apis/pagespeedonline/index.ts index 6da2473da48..de1d83d807d 100644 --- a/src/apis/pagespeedonline/index.ts +++ b/src/apis/pagespeedonline/index.ts @@ -17,11 +17,13 @@ import {getAPI, GoogleConfigurable} from 'googleapis-common'; import {pagespeedonline_v1} from './v1'; import {pagespeedonline_v2} from './v2'; import {pagespeedonline_v4} from './v4'; +import {pagespeedonline_v5} from './v5'; export const VERSIONS = { 'v1': pagespeedonline_v1.Pagespeedonline, 'v2': pagespeedonline_v2.Pagespeedonline, 'v4': pagespeedonline_v4.Pagespeedonline, + 'v5': pagespeedonline_v5.Pagespeedonline, }; export function pagespeedonline(version: 'v1'): @@ -36,12 +38,18 @@ export function pagespeedonline(version: 'v4'): pagespeedonline_v4.Pagespeedonline; export function pagespeedonline(options: pagespeedonline_v4.Options): pagespeedonline_v4.Pagespeedonline; +export function pagespeedonline(version: 'v5'): + pagespeedonline_v5.Pagespeedonline; +export function pagespeedonline(options: pagespeedonline_v5.Options): + pagespeedonline_v5.Pagespeedonline; export function pagespeedonline< T = pagespeedonline_v1.Pagespeedonline | pagespeedonline_v2.Pagespeedonline | - pagespeedonline_v4.Pagespeedonline>( + pagespeedonline_v4.Pagespeedonline | + pagespeedonline_v5.Pagespeedonline>( this: GoogleConfigurable, versionOrOptions: 'v1'|pagespeedonline_v1.Options|'v2'| - pagespeedonline_v2.Options|'v4'|pagespeedonline_v4.Options) { + pagespeedonline_v2.Options|'v4'| + pagespeedonline_v4.Options|'v5'|pagespeedonline_v5.Options) { return getAPI('pagespeedonline', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/pagespeedonline/v1.ts b/src/apis/pagespeedonline/v1.ts index 452fe24fefa..d456b75fb94 100644 --- a/src/apis/pagespeedonline/v1.ts +++ b/src/apis/pagespeedonline/v1.ts @@ -108,7 +108,31 @@ export namespace pagespeedonline_v1 { * Localized PageSpeed results. Contains a ruleResults entry for each * PageSpeed rule instantiated and run by the server. */ - formattedResults?: any; + formattedResults?: { + locale?: string; + ruleResults?: { + [key: string]: { + localizedRuleName?: string; + ruleImpact?: number; + urlBlocks?: Array<{ + header?: { + args?: Array<{type?: string; value?: string;}>; + format?: string; + }; + urls?: Array<{ + details?: Array<{ + args?: Array<{type?: string; value?: string;}>; + format?: string; + }>; + result?: { + args?: Array<{type?: string; value?: string;}>; + format?: string; + }; + }>; + }>; + }; + }; + }; /** * Canonicalized and final URL for the document, after following page * redirects (if any). @@ -127,7 +151,21 @@ export namespace pagespeedonline_v1 { * Summary statistics for the page, such as number of JavaScript bytes, * number of HTML bytes, etc. */ - pageStats?: any; + pageStats?: { + cssResponseBytes?: string; + flashResponseBytes?: string; + htmlResponseBytes?: string; + imageResponseBytes?: string; + javascriptResponseBytes?: string; + numberCssResources?: number; + numberHosts?: number; + numberJsResources?: number; + numberResources?: number; + numberStaticResources?: number; + otherResponseBytes?: string; + textResponseBytes?: string; + totalRequestBytes?: string; + }; /** * Response code for the document. 200 indicates a normal page load. 4xx/5xx * indicates an error. @@ -142,7 +180,8 @@ export namespace pagespeedonline_v1 { /** * Base64-encoded screenshot of the page that was analyzed. */ - screenshot?: any; + screenshot?: + {data?: string; height?: number; mime_type?: string; width?: number;}; /** * Title of the page, as displayed in the browser's title bar. */ @@ -150,7 +189,7 @@ export namespace pagespeedonline_v1 { /** * The version of PageSpeed used to generate these results. */ - version?: any; + version?: {major?: number; minor?: number;}; } @@ -258,7 +297,7 @@ export namespace pagespeedonline_v1 { /** * A PageSpeed rule to run; if none are given, all rules are run */ - rule?: string; + rule?: string[]; /** * Indicates if binary data containing a screenshot should be included */ diff --git a/src/apis/pagespeedonline/v2.ts b/src/apis/pagespeedonline/v2.ts index 27e675ddfe3..deb9091ed60 100644 --- a/src/apis/pagespeedonline/v2.ts +++ b/src/apis/pagespeedonline/v2.ts @@ -103,7 +103,15 @@ export namespace pagespeedonline_v2 { /** * List of arguments for the format string. */ - args?: any[]; + args?: Array<{ + key?: string; + rects?: Array< + {height?: number; left?: number; top?: number; width?: number;}>; + secondary_rects?: Array< + {height?: number; left?: number; top?: number; width?: number;}>; + type?: string; + value?: string; + }>; /** * A localized format string with {{FOO}} placeholders, where 'FOO' * is the key of the argument whose value should be substituted. For @@ -133,7 +141,7 @@ export namespace pagespeedonline_v2 { * The region of the page that is captured by this image, with dimensions * measured in CSS pixels. */ - page_rect?: any; + page_rect?: {height?: number; left?: number; top?: number; width?: number;}; /** * Width of screenshot in pixels. */ @@ -148,7 +156,24 @@ export namespace pagespeedonline_v2 { * Localized PageSpeed results. Contains a ruleResults entry for each * PageSpeed rule instantiated and run by the server. */ - formattedResults?: any; + formattedResults?: { + locale?: string; + ruleResults?: { + [key: string]: { + groups?: string[]; + localizedRuleName?: string; + ruleImpact?: number; + summary?: Schema$PagespeedApiFormatStringV2; + urlBlocks?: Array<{ + header?: Schema$PagespeedApiFormatStringV2; + urls?: Array<{ + details?: Schema$PagespeedApiFormatStringV2[]; + result?: Schema$PagespeedApiFormatStringV2; + }>; + }>; + }; + }; + }; /** * Canonicalized and final URL for the document, after following page * redirects (if any). @@ -167,7 +192,21 @@ export namespace pagespeedonline_v2 { * Summary statistics for the page, such as number of JavaScript bytes, * number of HTML bytes, etc. */ - pageStats?: any; + pageStats?: { + cssResponseBytes?: string; + flashResponseBytes?: string; + htmlResponseBytes?: string; + imageResponseBytes?: string; + javascriptResponseBytes?: string; + numberCssResources?: number; + numberHosts?: number; + numberJsResources?: number; + numberResources?: number; + numberStaticResources?: number; + otherResponseBytes?: string; + textResponseBytes?: string; + totalRequestBytes?: string; + }; /** * Response code for the document. 200 indicates a normal page load. 4xx/5xx * indicates an error. @@ -176,7 +215,7 @@ export namespace pagespeedonline_v2 { /** * A map with one entry for each rule group in these results. */ - ruleGroups?: any; + ruleGroups?: {[key: string]: {score?: number;};}; /** * Base64-encoded screenshot of the page that was analyzed. */ @@ -188,7 +227,7 @@ export namespace pagespeedonline_v2 { /** * The version of PageSpeed used to generate these results. */ - version?: any; + version?: {major?: number; minor?: number;}; } @@ -296,7 +335,7 @@ export namespace pagespeedonline_v2 { /** * A PageSpeed rule to run; if none are given, all rules are run */ - rule?: string; + rule?: string[]; /** * Indicates if binary data containing a screenshot should be included */ diff --git a/src/apis/pagespeedonline/v4.ts b/src/apis/pagespeedonline/v4.ts index e0497e9e0f9..50044ccc2ae 100644 --- a/src/apis/pagespeedonline/v4.ts +++ b/src/apis/pagespeedonline/v4.ts @@ -103,7 +103,15 @@ export namespace pagespeedonline_v4 { /** * List of arguments for the format string. */ - args?: any[]; + args?: Array<{ + key?: string; + rects?: Array< + {height?: number; left?: number; top?: number; width?: number;}>; + secondary_rects?: Array< + {height?: number; left?: number; top?: number; width?: number;}>; + type?: string; + value?: string; + }>; /** * A localized format string with {{FOO}} placeholders, where 'FOO' * is the key of the argument whose value should be substituted. For @@ -129,7 +137,7 @@ export namespace pagespeedonline_v4 { * Mime type of image data (e.g. "image/jpeg"). */ mime_type?: string; - page_rect?: any; + page_rect?: {height?: number; left?: number; top?: number; width?: number;}; /** * Width of screenshot in pixels. */ @@ -144,7 +152,25 @@ export namespace pagespeedonline_v4 { * Localized PageSpeed results. Contains a ruleResults entry for each * PageSpeed rule instantiated and run by the server. */ - formattedResults?: any; + formattedResults?: { + locale?: string; + ruleResults?: { + [key: string]: { + beta?: boolean; + groups?: string[]; + localizedRuleName?: string; + ruleImpact?: number; + summary?: Schema$PagespeedApiFormatStringV4; + urlBlocks?: Array<{ + header?: Schema$PagespeedApiFormatStringV4; + urls?: Array<{ + details?: Schema$PagespeedApiFormatStringV4[]; + result?: Schema$PagespeedApiFormatStringV4; + }>; + }>; + }; + }; + }; /** * Canonicalized and final URL for the document, after following page * redirects (if any). @@ -162,12 +188,46 @@ export namespace pagespeedonline_v4 { /** * Metrics of end users' page loading experience. */ - loadingExperience?: any; + loadingExperience?: { + id?: string; + initial_url?: string; + metrics?: { + [key: string]: { + category?: string; + distributions?: + Array<{max?: number; min?: number; proportion?: number;}>; + median?: number; + }; + }; + overall_category?: string; + }; /** * Summary statistics for the page, such as number of JavaScript bytes, * number of HTML bytes, etc. */ - pageStats?: any; + pageStats?: { + cms?: string; + cssResponseBytes?: string; + flashResponseBytes?: string; + htmlResponseBytes?: string; + imageResponseBytes?: string; + javascriptResponseBytes?: string; + numRenderBlockingRoundTrips?: number; + numTotalRoundTrips?: number; + numberCssResources?: number; + numberHosts?: number; + numberJsResources?: number; + numberResources?: number; + numberRobotedResources?: number; + numberStaticResources?: number; + numberTransientFetchFailureResources?: number; + otherResponseBytes?: string; + overTheWireResponseBytes?: string; + robotedUrls?: string[]; + textResponseBytes?: string; + totalRequestBytes?: string; + transientFetchFailureUrls?: string[]; + }; /** * Response code for the document. 200 indicates a normal page load. 4xx/5xx * indicates an error. @@ -176,7 +236,7 @@ export namespace pagespeedonline_v4 { /** * A map with one entry for each rule group in these results. */ - ruleGroups?: any; + ruleGroups?: {[key: string]: {pass?: boolean; score?: number;};}; /** * Base64-encoded screenshot of the page that was analyzed. */ @@ -193,7 +253,7 @@ export namespace pagespeedonline_v4 { /** * The version of PageSpeed used to generate these results. */ - version?: any; + version?: {major?: number; minor?: number;}; } @@ -314,7 +374,7 @@ export namespace pagespeedonline_v4 { /** * A PageSpeed rule to run; if none are given, all rules are run */ - rule?: string; + rule?: string[]; /** * Indicates if binary data containing a screenshot should be included */ diff --git a/src/apis/pagespeedonline/v5.ts b/src/apis/pagespeedonline/v5.ts new file mode 100644 index 00000000000..5d0c9217500 --- /dev/null +++ b/src/apis/pagespeedonline/v5.ts @@ -0,0 +1,427 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * 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 {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {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 pagespeedonline_v5 { + export interface Options extends GlobalOptions { + version: 'v5'; + } + + 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; + } + + /** + * PageSpeed Insights API + * + * Analyzes the performance of a web page and provides tailored suggestions to + * make that page faster. + * + * @example + * const {google} = require('googleapis'); + * const pagespeedonline = google.pagespeedonline('v5'); + * + * @namespace pagespeedonline + * @type {Function} + * @version v5 + * @variation v5 + * @param {object=} options Options for Pagespeedonline + */ + export class Pagespeedonline { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + pagespeedapi: Resource$Pagespeedapi; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.pagespeedapi = new Resource$Pagespeedapi(this); + } + + getRoot() { + return this.root; + } + } + + export interface Schema$GoogleprotobufValue {} + export interface Schema$LighthouseAuditResultV5 { + /** + * The description of the audit. + */ + description?: string; + /** + * Freeform details section of the audit. + */ + details?: {[key: string]: any;}; + /** + * The value that should be displayed on the UI for this audit. + */ + displayValue?: string; + /** + * An error message from a thrown error inside the audit. + */ + errorMessage?: string; + /** + * An explanation of the errors in the audit. + */ + explanation?: string; + /** + * The audit's id. + */ + id?: string; + score?: any; + /** + * The enumerated score display mode. + */ + scoreDisplayMode?: string; + /** + * The human readable title. + */ + title?: string; + warnings?: any; + } + export interface Schema$LighthouseCategoryV5 { + /** + * An array of references to all the audit members of this category. + */ + auditRefs?: Array<{group?: string; id?: string; weight?: number;}>; + /** + * A more detailed description of the category and its importance. + */ + description?: string; + /** + * The string identifier of the category. + */ + id?: string; + /** + * A description for the manual audits in the category. + */ + manualDescription?: string; + score?: any; + /** + * The human-friendly name of the category. + */ + title?: string; + } + export interface Schema$LighthouseResultV5 { + /** + * Map of audits in the LHR. + */ + audits?: {[key: string]: Schema$LighthouseAuditResultV5;}; + /** + * Map of categories in the LHR. + */ + categories?: {[key: string]: Schema$LighthouseCategoryV5;}; + /** + * Map of category groups in the LHR. + */ + categoryGroups?: {[key: string]: {description?: string; title?: string;};}; + /** + * The configuration settings for this LHR. + */ + configSettings?: + {emulatedFormFactor?: string; locale?: string; onlyCategories?: any;}; + /** + * Environment settings that were used when making this LHR. + */ + environment?: { + benchmarkIndex?: number; + hostUserAgent?: string; + networkUserAgent?: string; + }; + /** + * The time that this run was fetched. + */ + fetchTime?: string; + /** + * The final resolved url that was audited. + */ + finalUrl?: string; + /** + * The internationalization strings that are required to render the LHR. + */ + i18n?: { + rendererFormattedStrings?: { + auditGroupExpandTooltip?: string; + crcInitialNavigation?: string; + crcLongestDurationLabel?: string; + errorLabel?: string; + errorMissingAuditInfo?: string; + labDataTitle?: string; + lsPerformanceCategoryDescription?: string; + manualAuditsGroupTitle?: string; + notApplicableAuditsGroupTitle?: string; + opportunityResourceColumnLabel?: string; + opportunitySavingsColumnLabel?: string; + passedAuditsGroupTitle?: string; + scorescaleLabel?: string; + toplevelWarningsMessage?: string; + varianceDisclaimer?: string; + warningHeader?: string; + }; + }; + /** + * The lighthouse version that was used to generate this LHR. + */ + lighthouseVersion?: string; + /** + * The original requested url. + */ + requestedUrl?: string; + /** + * A top-level error message that, if present, indicates a serious enough + * problem that this Lighthouse result may need to be discarded. + */ + runtimeError?: {code?: string; message?: string;}; + /** + * List of all run warnings in the LHR. Will always output to at least `[]`. + */ + runWarnings?: any[]; + /** + * Timing information for this LHR. + */ + timing?: {total?: number;}; + /** + * The user agent that was used to run this LHR. + */ + userAgent?: string; + } + export interface Schema$PagespeedApiLoadingExperienceV5 { + /** + * The url, pattern or origin which the metrics are on. + */ + id?: string; + initial_url?: string; + metrics?: { + [key: string]: { + category?: string; + distributions?: + Array<{max?: number; min?: number; proportion?: number;}>; + percentile?: number; + }; + }; + overall_category?: string; + } + export interface Schema$PagespeedApiPagespeedResponseV5 { + /** + * The UTC timestamp of this analysis. + */ + analysisUTCTimestamp?: string; + /** + * The captcha verify result + */ + captchaResult?: string; + /** + * Canonicalized and final URL for the document, after following page + * redirects (if any). + */ + id?: string; + /** + * Kind of result. + */ + kind?: string; + /** + * Lighthouse response for the audit url as an object. + */ + lighthouseResult?: Schema$LighthouseResultV5; + /** + * Metrics of end users' page loading experience. + */ + loadingExperience?: Schema$PagespeedApiLoadingExperienceV5; + /** + * Metrics of the aggregated page loading experience of the origin + */ + originLoadingExperience?: Schema$PagespeedApiLoadingExperienceV5; + /** + * The version of PageSpeed used to generate these results. + */ + version?: {major?: number; minor?: number;}; + } + + + export class Resource$Pagespeedapi { + root: Pagespeedonline; + constructor(root: Pagespeedonline) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * pagespeedonline.pagespeedapi.runpagespeed + * @desc Runs PageSpeed analysis on the page at the specified URL, and + * returns PageSpeed scores, a list of suggestions to make that page faster, + * and other information. + * @alias pagespeedonline.pagespeedapi.runpagespeed + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.category A Lighthouse category to run; if none are given, only Performance category will be run + * @param {string=} params.locale The locale used to localize formatted results + * @param {string=} params.strategy The analysis strategy (desktop or mobile) to use, and desktop is the default + * @param {string} params.url The URL to fetch and analyze + * @param {string=} params.utm_campaign Campaign name for analytics. + * @param {string=} params.utm_source Campaign source for analytics. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + runpagespeed( + params?: Params$Resource$Pagespeedapi$Runpagespeed, + options?: MethodOptions): + AxiosPromise; + runpagespeed( + params: Params$Resource$Pagespeedapi$Runpagespeed, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): + void; + runpagespeed( + params: Params$Resource$Pagespeedapi$Runpagespeed, + callback: BodyResponseCallback): + void; + runpagespeed( + callback: BodyResponseCallback): + void; + runpagespeed( + paramsOrCallback?: Params$Resource$Pagespeedapi$Runpagespeed| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: + BodyResponseCallback): + void|AxiosPromise { + let params = + (paramsOrCallback || {}) as Params$Resource$Pagespeedapi$Runpagespeed; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Pagespeedapi$Runpagespeed; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/pagespeedonline/v5/runPagespeed') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['url'], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest( + parameters, callback); + } else { + return createAPIRequest( + parameters); + } + } + } + + export interface Params$Resource$Pagespeedapi$Runpagespeed extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * A Lighthouse category to run; if none are given, only Performance + * category will be run + */ + category?: string[]; + /** + * The locale used to localize formatted results + */ + locale?: string; + /** + * The analysis strategy (desktop or mobile) to use, and desktop is the + * default + */ + strategy?: string; + /** + * The URL to fetch and analyze + */ + url?: string; + /** + * Campaign name for analytics. + */ + utm_campaign?: string; + /** + * Campaign source for analytics. + */ + utm_source?: string; + } +} diff --git a/src/apis/partners/v2.ts b/src/apis/partners/v2.ts deleted file mode 100644 index 18fe80aa420..00000000000 --- a/src/apis/partners/v2.ts +++ /dev/null @@ -1,3662 +0,0 @@ -/** - * Copyright 2015 Google Inc. All Rights Reserved. - * - * 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 {AxiosPromise} from 'axios'; -import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; -import {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 partners_v2 { - export interface Options extends GlobalOptions { - version: 'v2'; - } - - 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; - } - - /** - * Google Partners API - * - * Searches certified companies and creates contact leads with them, and also - * audits the usage of clients. - * - * @example - * const {google} = require('googleapis'); - * const partners = google.partners('v2'); - * - * @namespace partners - * @type {Function} - * @version v2 - * @variation v2 - * @param {object=} options Options for Partners - */ - export class Partners { - _options: GlobalOptions; - google?: GoogleConfigurable; - root = this; - - analytics: Resource$Analytics; - clientMessages: Resource$Clientmessages; - companies: Resource$Companies; - leads: Resource$Leads; - offers: Resource$Offers; - userEvents: Resource$Userevents; - users: Resource$Users; - userStates: Resource$Userstates; - v2: Resource$V2; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this._options = options || {}; - this.google = google; - this.getRoot.bind(this); - - this.analytics = new Resource$Analytics(this); - this.clientMessages = new Resource$Clientmessages(this); - this.companies = new Resource$Companies(this); - this.leads = new Resource$Leads(this); - this.offers = new Resource$Offers(this); - this.userEvents = new Resource$Userevents(this); - this.users = new Resource$Users(this); - this.userStates = new Resource$Userstates(this); - this.v2 = new Resource$V2(this); - } - - getRoot() { - return this.root; - } - } - - /** - * Information about a particular AdWords Manager Account. Read more at - * https://support.google.com/adwords/answer/6139186 - */ - export interface Schema$AdWordsManagerAccountInfo { - /** - * Name of the customer this account represents. - */ - customerName?: string; - /** - * The AdWords Manager Account id. - */ - id?: string; - } - /** - * Analytics data for a `Company` within a single day. - */ - export interface Schema$Analytics { - /** - * Instances of users contacting the `Company` on the specified date. - */ - contacts?: Schema$AnalyticsDataPoint; - /** - * Date on which these events occurred. - */ - eventDate?: Schema$Date; - /** - * Instances of users viewing the `Company` profile on the specified date. - */ - profileViews?: Schema$AnalyticsDataPoint; - /** - * Instances of users seeing the `Company` in Google Partners Search results - * on the specified date. - */ - searchViews?: Schema$AnalyticsDataPoint; - } - /** - * Details of the analytics events for a `Company` within a single day. - */ - export interface Schema$AnalyticsDataPoint { - /** - * Number of times the type of event occurred. Meaning depends on context - * (e.g. profile views, contacts, etc.). - */ - eventCount?: number; - /** - * Location information of where these events occurred. - */ - eventLocations?: Schema$LatLng[]; - } - /** - * Analytics aggregated data for a `Company` for a given date range. - */ - export interface Schema$AnalyticsSummary { - /** - * Aggregated number of times users contacted the `Company` for given date - * range. - */ - contactsCount?: number; - /** - * Aggregated number of profile views for the `Company` for given date - * range. - */ - profileViewsCount?: number; - /** - * Aggregated number of times users saw the `Company` in Google Partners - * Search results for given date range. - */ - searchViewsCount?: number; - } - /** - * Available Offers to be distributed. - */ - export interface Schema$AvailableOffer { - /** - * The number of codes for this offer that are available for distribution. - */ - available?: number; - /** - * Offer info by country. - */ - countryOfferInfos?: Schema$CountryOfferInfo[]; - /** - * Description of the offer. - */ - description?: string; - /** - * ID of this offer. - */ - id?: string; - /** - * The maximum age of an account [in days] to be eligible. - */ - maxAccountAge?: number; - /** - * Name of the offer. - */ - name?: string; - /** - * Level of this offer. - */ - offerLevel?: string; - /** - * Type of offer. - */ - offerType?: string; - /** - * Customers who qualify for this offer. - */ - qualifiedCustomer?: Schema$OfferCustomer[]; - /** - * Whether or not the list of qualified customers is definitely complete. - */ - qualifiedCustomersComplete?: boolean; - /** - * Should special text be shown on the offers page. - */ - showSpecialOfferCopy?: boolean; - /** - * Terms of the offer. - */ - terms?: string; - } - /** - * A user's information on a specific certification. - */ - export interface Schema$Certification { - /** - * Whether this certification has been achieved. - */ - achieved?: boolean; - /** - * The type of certification, the area of expertise. - */ - certificationType?: string; - /** - * Date this certification is due to expire. - */ - expiration?: string; - /** - * The date the user last achieved certification. - */ - lastAchieved?: string; - /** - * Whether this certification is in the state of warning. - */ - warning?: boolean; - } - /** - * Status for a Google Partners certification exam. - */ - export interface Schema$CertificationExamStatus { - /** - * The number of people who have passed the certification exam. - */ - numberUsersPass?: number; - /** - * The type of certification exam. - */ - type?: string; - } - /** - * Google Partners certification status. - */ - export interface Schema$CertificationStatus { - /** - * List of certification exam statuses. - */ - examStatuses?: Schema$CertificationExamStatus[]; - /** - * Whether certification is passing. - */ - isCertified?: boolean; - /** - * The type of the certification. - */ - type?: string; - /** - * Number of people who are certified, - */ - userCount?: number; - } - /** - * A company resource in the Google Partners API. Once certified, it qualifies - * for being searched by advertisers. - */ - export interface Schema$Company { - /** - * URL of the company's additional websites used to verify the dynamic - * badges. These are stored as full URLs as entered by the user, but only - * the TLD will be used for the actual verification. - */ - additionalWebsites?: string[]; - /** - * Email domains that allow users with a matching email address to get - * auto-approved for associating with this company. - */ - autoApprovalEmailDomains?: string[]; - /** - * Whether the company's badge authority is in AWN - */ - badgeAuthorityInAwn?: boolean; - /** - * Partner badge tier - */ - badgeTier?: string; - /** - * The list of Google Partners certification statuses for the company. - */ - certificationStatuses?: Schema$CertificationStatus[]; - /** - * Company type labels listed on the company's profile. - */ - companyTypes?: string[]; - /** - * The minimum monthly budget that the company accepts for partner business, - * converted to the requested currency code. - */ - convertedMinMonthlyBudget?: Schema$Money; - /** - * The ID of the company. - */ - id?: string; - /** - * Industries the company can help with. - */ - industries?: string[]; - /** - * The list of localized info for the company. - */ - localizedInfos?: Schema$LocalizedCompanyInfo[]; - /** - * The list of all company locations. If set, must include the - * primary_location in the list. - */ - locations?: Schema$Location[]; - /** - * The name of the company. - */ - name?: string; - /** - * The unconverted minimum monthly budget that the company accepts for - * partner business. - */ - originalMinMonthlyBudget?: Schema$Money; - /** - * The Primary AdWords Manager Account id. - */ - primaryAdwordsManagerAccountId?: string; - /** - * The primary language code of the company, as defined by <a - * href="https://tools.ietf.org/html/bcp47">BCP 47</a> - * (IETF BCP 47, "Tags for Identifying Languages"). - */ - primaryLanguageCode?: string; - /** - * The primary location of the company. - */ - primaryLocation?: Schema$Location; - /** - * The public viewability status of the company's profile. - */ - profileStatus?: string; - /** - * Basic information from the company's public profile. - */ - publicProfile?: Schema$PublicProfile; - /** - * Information related to the ranking of the company within the list of - * companies. - */ - ranks?: Schema$Rank[]; - /** - * Services the company can help with. - */ - services?: string[]; - /** - * The list of Google Partners specialization statuses for the company. - */ - specializationStatus?: Schema$SpecializationStatus[]; - /** - * URL of the company's website. - */ - websiteUrl?: string; - } - /** - * A CompanyRelation resource representing information about a user's - * affiliation and standing with a company in Partners. - */ - export interface Schema$CompanyRelation { - /** - * The primary address for this company. - */ - address?: string; - /** - * Whether the company is a Partner. - */ - badgeTier?: string; - /** - * Indicates if the user is an admin for this company. - */ - companyAdmin?: boolean; - /** - * The ID of the company. There may be no id if this is a pending company.5 - */ - companyId?: string; - /** - * The timestamp of when affiliation was requested. @OutputOnly - */ - creationTime?: string; - /** - * The internal company ID. Only available for a whitelisted set of api - * clients. - */ - internalCompanyId?: string; - /** - * The flag that indicates if the company is pending verification. - */ - isPending?: boolean; - /** - * A URL to a profile photo, e.g. a G+ profile photo. - */ - logoUrl?: string; - /** - * The AdWords manager account # associated this company. - */ - managerAccount?: string; - /** - * The name (in the company's primary language) for the company. - */ - name?: string; - /** - * The phone number for the company's primary address. - */ - phoneNumber?: string; - /** - * The primary location of the company. - */ - primaryAddress?: Schema$Location; - /** - * The primary country code of the company. - */ - primaryCountryCode?: string; - /** - * The primary language code of the company. - */ - primaryLanguageCode?: string; - /** - * The timestamp when the user was approved. @OutputOnly - */ - resolvedTimestamp?: string; - /** - * The segment the company is classified as. - */ - segment?: string[]; - /** - * The list of Google Partners specialization statuses for the company. - */ - specializationStatus?: Schema$SpecializationStatus[]; - /** - * The state of relationship, in terms of approvals. - */ - state?: string; - /** - * The website URL for this company. - */ - website?: string; - } - /** - * Offer info by country. - */ - export interface Schema$CountryOfferInfo { - /** - * (localized) Get Y amount for that country's offer. - */ - getYAmount?: string; - /** - * Country code for which offer codes may be requested. - */ - offerCountryCode?: string; - /** - * Type of offer country is eligible for. - */ - offerType?: string; - /** - * (localized) Spend X amount for that country's offer. - */ - spendXAmount?: string; - } - /** - * Request message for CreateLead. - */ - export interface Schema$CreateLeadRequest { - /** - * The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED` and - * either `email` or `phone_number` must be provided. - */ - lead?: Schema$Lead; - /** - * <a - * href="https://www.google.com/recaptcha/">reCaptcha</a> - * challenge info. - */ - recaptchaChallenge?: Schema$RecaptchaChallenge; - /** - * Current request metadata. - */ - requestMetadata?: Schema$RequestMetadata; - } - /** - * Response message for CreateLead. - */ - export interface Schema$CreateLeadResponse { - /** - * Lead that was created depending on the outcome of <a - * href="https://www.google.com/recaptcha/">reCaptcha</a> - * validation. - */ - lead?: Schema$Lead; - /** - * The outcome of <a - * href="https://www.google.com/recaptcha/">reCaptcha</a> - * validation. - */ - recaptchaStatus?: string; - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Represents a whole or partial calendar date, e.g. a birthday. The time of - * day and time zone are either specified elsewhere or are not significant. - * The date is relative to the Proleptic Gregorian Calendar. This can - * represent: * A full date, with non-zero year, month and day values * A - * month and day value, with a zero year, e.g. an anniversary * A year on its - * own, with zero month and day values * A year and month value, with a zero - * day, e.g. a credit card expiration date Related types are - * google.type.TimeOfDay and `google.protobuf.Timestamp`. - */ - export interface Schema$Date { - /** - * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 - * if specifying a year by itself or a year and month where the day is not - * significant. - */ - day?: number; - /** - * Month of year. Must be from 1 to 12, or 0 if specifying a year without a - * month and day. - */ - month?: number; - /** - * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a - * year. - */ - year?: number; - } - /** - * Debug information about this request. - */ - export interface Schema$DebugInfo { - /** - * Info about the server that serviced this request. - */ - serverInfo?: string; - /** - * Server-side debug stack trace. - */ - serverTraceInfo?: string; - /** - * URL of the service that handled this request. - */ - serviceUrl?: string; - } - /** - * 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 {} - /** - * Key value data pair for an event. - */ - export interface Schema$EventData { - /** - * Data type. - */ - key?: string; - /** - * Data values. - */ - values?: string[]; - } - /** - * A user's information on a specific exam. - */ - export interface Schema$ExamStatus { - /** - * The type of the exam. - */ - examType?: string; - /** - * Date this exam is due to expire. - */ - expiration?: string; - /** - * The date the user last passed this exam. - */ - lastPassed?: string; - /** - * Whether this exam has been passed and not expired. - */ - passed?: boolean; - /** - * The date the user last taken this exam. - */ - taken?: string; - /** - * Whether this exam is in the state of warning. - */ - warning?: boolean; - } - /** - * Response message for GetCompany. - */ - export interface Schema$GetCompanyResponse { - /** - * The company. - */ - company?: Schema$Company; - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Response message for GetPartnersStatus. - */ - export interface Schema$GetPartnersStatusResponse { - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Historical information about a Google Partners Offer. - */ - export interface Schema$HistoricalOffer { - /** - * Client's AdWords page URL. - */ - adwordsUrl?: string; - /** - * Email address for client. - */ - clientEmail?: string; - /** - * ID of client. - */ - clientId?: string; - /** - * Name of the client. - */ - clientName?: string; - /** - * Time offer was first created. - */ - creationTime?: string; - /** - * Time this offer expires. - */ - expirationTime?: string; - /** - * Time last action was taken. - */ - lastModifiedTime?: string; - /** - * Offer code. - */ - offerCode?: string; - /** - * Country Code for the offer country. - */ - offerCountryCode?: string; - /** - * Type of offer. - */ - offerType?: string; - /** - * Name (First + Last) of the partners user to whom the incentive is - * allocated. - */ - senderName?: string; - /** - * Status of the offer. - */ - status?: string; - } - /** - * An object representing a latitude/longitude pair. This is expressed as a - * pair of doubles representing degrees latitude and degrees longitude. Unless - * specified otherwise, this must conform to the <a - * href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 - * standard</a>. Values must be within normalized ranges. - */ - export interface Schema$LatLng { - /** - * The latitude in degrees. It must be in the range [-90.0, +90.0]. - */ - latitude?: number; - /** - * The longitude in degrees. It must be in the range [-180.0, +180.0]. - */ - longitude?: number; - } - /** - * A lead resource that represents an advertiser contact for a `Company`. - * These are usually generated via Google Partner Search (the advertiser - * portal). - */ - export interface Schema$Lead { - /** - * The AdWords Customer ID of the lead. - */ - adwordsCustomerId?: string; - /** - * Comments lead source gave. - */ - comments?: string; - /** - * Timestamp of when this lead was created. - */ - createTime?: string; - /** - * Email address of lead source. - */ - email?: string; - /** - * Last name of lead source. - */ - familyName?: string; - /** - * First name of lead source. - */ - givenName?: string; - /** - * List of reasons for using Google Partner Search and creating a lead. - */ - gpsMotivations?: string[]; - /** - * ID of the lead. - */ - id?: string; - /** - * Language code of the lead's language preference, as defined by <a - * href="https://tools.ietf.org/html/bcp47">BCP 47</a> - * (IETF BCP 47, "Tags for Identifying Languages"). - */ - languageCode?: string; - /** - * Whether or not the lead signed up for marketing emails - */ - marketingOptIn?: boolean; - /** - * The minimum monthly budget lead source is willing to spend. - */ - minMonthlyBudget?: Schema$Money; - /** - * Phone number of lead source. - */ - phoneNumber?: string; - /** - * The lead's state in relation to the company. - */ - state?: string; - /** - * Type of lead. - */ - type?: string; - /** - * Website URL of lead source. - */ - websiteUrl?: string; - } - /** - * Response message for ListAnalytics. - */ - export interface Schema$ListAnalyticsResponse { - /** - * The list of analytics. Sorted in ascending order of Analytics.event_date. - */ - analytics?: Schema$Analytics[]; - /** - * Aggregated information across the response's analytics. - */ - analyticsSummary?: Schema$AnalyticsSummary; - /** - * A token to retrieve next page of results. Pass this value in the - * `ListAnalyticsRequest.page_token` field in the subsequent call to - * ListAnalytics to retrieve the next page of results. - */ - nextPageToken?: string; - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Response message for ListCompanies. - */ - export interface Schema$ListCompaniesResponse { - /** - * The list of companies. - */ - companies?: Schema$Company[]; - /** - * A token to retrieve next page of results. Pass this value in the - * `ListCompaniesRequest.page_token` field in the subsequent call to - * ListCompanies to retrieve the next page of results. - */ - nextPageToken?: string; - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Response message for ListLeads. - */ - export interface Schema$ListLeadsResponse { - /** - * The list of leads. - */ - leads?: Schema$Lead[]; - /** - * A token to retrieve next page of results. Pass this value in the - * `ListLeadsRequest.page_token` field in the subsequent call to ListLeads - * to retrieve the next page of results. - */ - nextPageToken?: string; - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - /** - * The total count of leads for the given company. - */ - totalSize?: number; - } - /** - * Response for ListOfferHistory. - */ - export interface Schema$ListOffersHistoryResponse { - /** - * True if the user has the option to show entire company history. - */ - canShowEntireCompany?: boolean; - /** - * Supply this token in a ListOffersHistoryRequest to retrieve the next - * page. - */ - nextPageToken?: string; - /** - * Historical offers meeting request. - */ - offers?: Schema$HistoricalOffer[]; - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - /** - * True if this response is showing entire company history. - */ - showingEntireCompany?: boolean; - /** - * Number of results across all pages. - */ - totalResults?: number; - } - /** - * Response for ListOffer. - */ - export interface Schema$ListOffersResponse { - /** - * Available Offers to be distributed. - */ - availableOffers?: Schema$AvailableOffer[]; - /** - * Reason why no Offers are available. - */ - noOfferReason?: string; - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Response message for ListUserStates. - */ - export interface Schema$ListUserStatesResponse { - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - /** - * User's states. - */ - userStates?: string[]; - } - /** - * The localized company information. - */ - export interface Schema$LocalizedCompanyInfo { - /** - * List of country codes for the localized company info. - */ - countryCodes?: string[]; - /** - * Localized display name. - */ - displayName?: string; - /** - * Language code of the localized company info, as defined by <a - * href="https://tools.ietf.org/html/bcp47">BCP 47</a> - * (IETF BCP 47, "Tags for Identifying Languages"). - */ - languageCode?: string; - /** - * Localized brief description that the company uses to advertise - * themselves. - */ - overview?: string; - } - /** - * A location with address and geographic coordinates. May optionally contain - * a detailed (multi-field) version of the address. - */ - export interface Schema$Location { - /** - * The single string version of the address. - */ - address?: string; - /** - * The following address lines represent the most specific part of any - * address. - */ - addressLine?: string[]; - /** - * Top-level administrative subdivision of this country. - */ - administrativeArea?: string; - /** - * Dependent locality or sublocality. Used for UK dependent localities, or - * neighborhoods or boroughs in other locations. - */ - dependentLocality?: string; - /** - * Language code of the address. Should be in BCP 47 format. - */ - languageCode?: string; - /** - * The latitude and longitude of the location, in degrees. - */ - latLng?: Schema$LatLng; - /** - * Generally refers to the city/town portion of an address. - */ - locality?: string; - /** - * Values are frequently alphanumeric. - */ - postalCode?: string; - /** - * CLDR (Common Locale Data Repository) region code . - */ - regionCode?: string; - /** - * Use of this code is very country-specific, but will refer to a secondary - * classification code for sorting mail. - */ - sortingCode?: string; - } - /** - * Request message for LogClientMessage. - */ - export interface Schema$LogMessageRequest { - /** - * Map of client info, such as URL, browser navigator, browser platform, - * etc. - */ - clientInfo?: any; - /** - * Details about the client message. - */ - details?: string; - /** - * Message level of client message. - */ - level?: string; - /** - * Current request metadata. - */ - requestMetadata?: Schema$RequestMetadata; - } - /** - * Response message for LogClientMessage. - */ - export interface Schema$LogMessageResponse { - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Request message for LogUserEvent. - */ - export interface Schema$LogUserEventRequest { - /** - * The action that occurred. - */ - eventAction?: string; - /** - * The category the action belongs to. - */ - eventCategory?: string; - /** - * List of event data for the event. - */ - eventDatas?: Schema$EventData[]; - /** - * The scope of the event. - */ - eventScope?: string; - /** - * Advertiser lead information. - */ - lead?: Schema$Lead; - /** - * Current request metadata. - */ - requestMetadata?: Schema$RequestMetadata; - /** - * The URL where the event occurred. - */ - url?: string; - } - /** - * Response message for LogUserEvent. - */ - export interface Schema$LogUserEventResponse { - /** - * Current response metadata. - */ - responseMetadata?: Schema$ResponseMetadata; - } - /** - * Represents an amount of money with its currency type. - */ - export interface Schema$Money { - /** - * The 3-letter currency code defined in ISO 4217. - */ - currencyCode?: string; - /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. - */ - nanos?: number; - /** - * The whole units of the amount. For example if `currencyCode` is - * `"USD"`, then 1 unit is one US dollar. - */ - units?: string; - } - /** - * Customers qualified for an offer. - */ - export interface Schema$OfferCustomer { - /** - * URL to the customer's AdWords page. - */ - adwordsUrl?: string; - /** - * Country code of the customer. - */ - countryCode?: string; - /** - * Time the customer was created. - */ - creationTime?: string; - /** - * Days the customer is still eligible. - */ - eligibilityDaysLeft?: number; - /** - * External CID for the customer. - */ - externalCid?: string; - /** - * Formatted Get Y amount with currency code. - */ - getYAmount?: string; - /** - * Name of the customer. - */ - name?: string; - /** - * Type of the offer - */ - offerType?: string; - /** - * Formatted Spend X amount with currency code. - */ - spendXAmount?: string; - } - /** - * A set of opt-ins for a user. - */ - export interface Schema$OptIns { - /** - * An opt-in about receiving email from Partners marketing teams. Includes - * member-only events and special promotional offers for Google products. - */ - marketComm?: boolean; - /** - * An opt-in about receiving email with customized AdWords campaign - * management tips. - */ - performanceSuggestions?: boolean; - /** - * An opt-in to allow recieivng phone calls about their Partners account. - */ - phoneContact?: boolean; - /** - * An opt-in to receive special promotional gifts and material in the mail. - */ - physicalMail?: boolean; - /** - * An opt-in about receiving email regarding new features and products. - */ - specialOffers?: boolean; - } - /** - * Basic information from a public profile. - */ - export interface Schema$PublicProfile { - /** - * The URL to the main display image of the public profile. Being - * deprecated. - */ - displayImageUrl?: string; - /** - * The display name of the public profile. - */ - displayName?: string; - /** - * The ID which can be used to retrieve more details about the public - * profile. - */ - id?: string; - /** - * The URL to the main profile image of the public profile. - */ - profileImage?: string; - /** - * The URL of the public profile. - */ - url?: string; - } - /** - * Information related to ranking of results. - */ - export interface Schema$Rank { - /** - * The type of rank. - */ - type?: string; - /** - * The numerical value of the rank. - */ - value?: number; - } - /** - * <a - * href="https://www.google.com/recaptcha/">reCaptcha</a> - * challenge info. - */ - export interface Schema$RecaptchaChallenge { - /** - * The ID of the reCaptcha challenge. - */ - id?: string; - /** - * The response to the reCaptcha challenge. - */ - response?: string; - } - /** - * Common data that is in each API request. - */ - export interface Schema$RequestMetadata { - /** - * Experiment IDs the current request belongs to. - */ - experimentIds?: string[]; - /** - * Locale to use for the current request. - */ - locale?: string; - /** - * Google Partners session ID. - */ - partnersSessionId?: string; - /** - * Source of traffic for the current request. - */ - trafficSource?: Schema$TrafficSource; - /** - * Values to use instead of the user's respective defaults for the - * current request. These are only honored by whitelisted products. - */ - userOverrides?: Schema$UserOverrides; - } - /** - * Common data that is in each API response. - */ - export interface Schema$ResponseMetadata { - /** - * Debug information about this request. - */ - debugInfo?: Schema$DebugInfo; - } - /** - * Agency specialization status - */ - export interface Schema$SpecializationStatus { - /** - * The specialization this status is for. - */ - badgeSpecialization?: string; - /** - * State of agency specialization. - */ - badgeSpecializationState?: string; - } - /** - * Source of traffic for the current request. - */ - export interface Schema$TrafficSource { - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - trafficSourceId?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - trafficSubId?: string; - } - /** - * A resource representing a user of the Partners platform. - */ - export interface Schema$User { - /** - * Whether or not the user has opted to share their Academy for Ads info - * with Google Partners. - */ - afaInfoShared?: boolean; - /** - * This is the list of AdWords Manager Accounts the user has edit access to. - * If the user has edit access to multiple accounts, the user can choose the - * preferred account and we use this when a personal account is needed. Can - * be empty meaning the user has access to no accounts. @OutputOnly - */ - availableAdwordsManagerAccounts?: Schema$AdWordsManagerAccountInfo[]; - /** - * The list of achieved certifications. These are calculated based on exam - * results and other requirements. @OutputOnly - */ - certificationStatus?: Schema$Certification[]; - /** - * The company that the user is associated with. If not present, the user is - * not associated with any company. - */ - company?: Schema$CompanyRelation; - /** - * The email address used by the user used for company verification. - * @OutputOnly - */ - companyVerificationEmail?: string; - /** - * The list of exams the user ever taken. For each type of exam, only one - * entry is listed. - */ - examStatus?: Schema$ExamStatus[]; - /** - * The ID of the user. - */ - id?: string; - /** - * The internal user ID. Only available for a whitelisted set of api - * clients. - */ - internalId?: string; - /** - * The most recent time the user interacted with the Partners site. - * @OutputOnly - */ - lastAccessTime?: string; - /** - * The list of emails the user has access to/can select as primary. - * @OutputOnly - */ - primaryEmails?: string[]; - /** - * The profile information of a Partners user, contains all the directly - * editable user information. - */ - profile?: Schema$UserProfile; - /** - * Information about a user's external public profile outside Google - * Partners. - */ - publicProfile?: Schema$PublicProfile; - } - /** - * Values to use instead of the user's respective defaults. These are only - * honored by whitelisted products. - */ - export interface Schema$UserOverrides { - /** - * IP address to use instead of the user's geo-located IP address. - */ - ipAddress?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - userId?: string; - } - /** - * The profile information of a Partners user. - */ - export interface Schema$UserProfile { - /** - * The user's mailing address, contains multiple fields. - */ - address?: Schema$Location; - /** - * If the user has edit access to multiple accounts, the user can choose the - * preferred account and it is used when a personal account is needed. Can - * be empty. - */ - adwordsManagerAccount?: string; - /** - * A list of ids representing which channels the user selected they were in. - */ - channels?: string[]; - /** - * The email address the user has selected on the Partners site as primary. - */ - emailAddress?: string; - /** - * The list of opt-ins for the user, related to communication preferences. - */ - emailOptIns?: Schema$OptIns; - /** - * The user's family name. - */ - familyName?: string; - /** - * The user's given name. - */ - givenName?: string; - /** - * A list of ids representing which industries the user selected. - */ - industries?: string[]; - /** - * A list of ids represnting which job categories the user selected. - */ - jobFunctions?: string[]; - /** - * The list of languages this user understands. - */ - languages?: string[]; - /** - * A list of ids representing which markets the user was interested in. - */ - markets?: string[]; - /** - * Whether or not to migrate the user's exam data to Academy for Ads. - */ - migrateToAfa?: boolean; - /** - * The user's phone number. - */ - phoneNumber?: string; - /** - * The user's primary country, an ISO 2-character code. - */ - primaryCountryCode?: string; - /** - * Whether the user's public profile is visible to anyone with the URL. - */ - profilePublic?: boolean; - } - - - export class Resource$Analytics { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.analytics.list - * @desc Lists analytics data for a user's associated company. Should only - * be called within the context of an authorized logged in user. - * @alias partners.analytics.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Requested page size. Server may return fewer analytics than requested. If unspecified or set to 0, default value is 30. Specifies the number of days in the date range when querying analytics. The `page_token` represents the end date of the date range and the start date is calculated using the `page_size` as the number of days BEFORE the end date. Must be a non-negative integer. - * @param {string=} params.pageToken A token identifying a page of results that the server returns. Typically, this is the value of `ListAnalyticsResponse.next_page_token` returned from the previous call to ListAnalytics. Will be a date string in `YYYY-MM-DD` format representing the end date of the date range of results to return. If unspecified or set to "", default value is the current date. - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's 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$Analytics$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Analytics$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Analytics$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Analytics$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Analytics$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Analytics$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/analytics').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Analytics$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Requested page size. Server may return fewer analytics than requested. If - * unspecified or set to 0, default value is 30. Specifies the number of - * days in the date range when querying analytics. The `page_token` - * represents the end date of the date range and the start date is - * calculated using the `page_size` as the number of days BEFORE the end - * date. Must be a non-negative integer. - */ - pageSize?: number; - /** - * A token identifying a page of results that the server returns. Typically, - * this is the value of `ListAnalyticsResponse.next_page_token` returned - * from the previous call to ListAnalytics. Will be a date string in - * `YYYY-MM-DD` format representing the end date of the date range of - * results to return. If unspecified or set to "", default value is the - * current date. - */ - pageToken?: string; - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - } - - - export class Resource$Clientmessages { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.clientMessages.log - * @desc Logs a generic message from the client, such as `Failed to render - * component`, `Profile page is running slow`, `More than 500 users have - * accessed this result.`, etc. - * @alias partners.clientMessages.log - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().LogMessageRequest} 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 - */ - log(params?: Params$Resource$Clientmessages$Log, - options?: MethodOptions): AxiosPromise; - log(params: Params$Resource$Clientmessages$Log, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - log(params: Params$Resource$Clientmessages$Log, - callback: BodyResponseCallback): void; - log(callback: BodyResponseCallback): void; - log(paramsOrCallback?: Params$Resource$Clientmessages$Log| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Clientmessages$Log; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Clientmessages$Log; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/clientMessages:log') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Clientmessages$Log extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - - /** - * Request body metadata - */ - requestBody?: Schema$LogMessageRequest; - } - - - export class Resource$Companies { - root: Partners; - leads: Resource$Companies$Leads; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - this.leads = new Resource$Companies$Leads(root); - } - - getRoot() { - return this.root; - } - - - /** - * partners.companies.get - * @desc Gets a company. - * @alias partners.companies.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.address The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set. - * @param {string} params.companyId The ID of the company to retrieve. - * @param {string=} params.currencyCode If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code. - * @param {string=} params.orderBy How to order addresses within the returned company. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively. - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {string=} params.view The view of `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`. - * @param {object} [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$Companies$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Companies$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Companies$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Companies$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Companies$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Companies$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/companies/{companyId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['companyId'], - pathParams: ['companyId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * partners.companies.list - * @desc Lists companies. - * @alias partners.companies.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.address The address to use when searching for companies. If not given, the geo-located address of the request is used. - * @param {string=} params.companyName Company name to search for. - * @param {string=} params.gpsMotivations List of reasons for using Google Partner Search to get companies. - * @param {string=} params.industries List of industries the company can help with. - * @param {string=} params.languageCodes List of language codes that company can support. Only primary language subtags are accepted as defined by BCP 47 (IETF BCP 47, "Tags for Identifying Languages"). - * @param {string=} params.maxMonthlyBudget.currencyCode The 3-letter currency code defined in ISO 4217. - * @param {integer=} params.maxMonthlyBudget.nanos Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - * @param {string=} params.maxMonthlyBudget.units The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - * @param {string=} params.minMonthlyBudget.currencyCode The 3-letter currency code defined in ISO 4217. - * @param {integer=} params.minMonthlyBudget.nanos Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. - * @param {string=} params.minMonthlyBudget.units The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. - * @param {string=} params.orderBy How to order addresses within the returned companies. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively. - * @param {integer=} params.pageSize Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to ListCompanies. - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {string=} params.services List of services that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these services, or one of the specializations in the "specializations" field. - * @param {string=} params.specializations List of specializations that the returned agencies should provide. If this is not empty, any returned agency must have at least one of these specializations, or one of the services in the "services" field. - * @param {string=} params.view The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`. - * @param {string=} params.websiteUrl Website URL that will help to find a better matched company. . - * @param {object} [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$Companies$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Companies$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Companies$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Companies$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Companies$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Companies$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/companies').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Companies$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The address to use for sorting the company's addresses by proximity. If - * not given, the geo-located address of the request is used. Used when - * order_by is set. - */ - address?: string; - /** - * The ID of the company to retrieve. - */ - companyId?: string; - /** - * If the company's budget is in a different currency code than this one, - * then the converted budget is converted to this currency code. - */ - currencyCode?: string; - /** - * How to order addresses within the returned company. Currently, only - * `address` and `address desc` is supported which will sorted by closest to - * farthest in distance from given address and farthest to closest distance - * from given address respectively. - */ - orderBy?: string; - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - /** - * The view of `Company` resource to be returned. This must not be - * `COMPANY_VIEW_UNSPECIFIED`. - */ - view?: string; - } - export interface Params$Resource$Companies$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The address to use when searching for companies. If not given, the - * geo-located address of the request is used. - */ - address?: string; - /** - * Company name to search for. - */ - companyName?: string; - /** - * List of reasons for using Google Partner Search to get companies. - */ - gpsMotivations?: string; - /** - * List of industries the company can help with. - */ - industries?: string; - /** - * List of language codes that company can support. Only primary language - * subtags are accepted as defined by BCP 47 (IETF BCP 47, "Tags - * for Identifying Languages"). - */ - languageCodes?: string; - /** - * The 3-letter currency code defined in ISO 4217. - */ - 'maxMonthlyBudget.currencyCode'?: string; - /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. - */ - 'maxMonthlyBudget.nanos'?: number; - /** - * The whole units of the amount. For example if `currencyCode` is `"USD"`, - * then 1 unit is one US dollar. - */ - 'maxMonthlyBudget.units'?: string; - /** - * The 3-letter currency code defined in ISO 4217. - */ - 'minMonthlyBudget.currencyCode'?: string; - /** - * Number of nano (10^-9) units of the amount. The value must be between - * -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` - * must be positive or zero. If `units` is zero, `nanos` can be positive, - * zero, or negative. If `units` is negative, `nanos` must be negative or - * zero. For example $-1.75 is represented as `units`=-1 and - * `nanos`=-750,000,000. - */ - 'minMonthlyBudget.nanos'?: number; - /** - * The whole units of the amount. For example if `currencyCode` is `"USD"`, - * then 1 unit is one US dollar. - */ - 'minMonthlyBudget.units'?: string; - /** - * How to order addresses within the returned companies. Currently, only - * `address` and `address desc` is supported which will sorted by closest to - * farthest in distance from given address and farthest to closest distance - * from given address respectively. - */ - orderBy?: string; - /** - * Requested page size. Server may return fewer companies than requested. If - * unspecified, server picks an appropriate default. - */ - pageSize?: number; - /** - * A token identifying a page of results that the server returns. Typically, - * this is the value of `ListCompaniesResponse.next_page_token` returned - * from the previous call to ListCompanies. - */ - pageToken?: string; - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - /** - * List of services that the returned agencies should provide. If this is - * not empty, any returned agency must have at least one of these services, - * or one of the specializations in the "specializations" field. - */ - services?: string; - /** - * List of specializations that the returned agencies should provide. If - * this is not empty, any returned agency must have at least one of these - * specializations, or one of the services in the "services" field. - */ - specializations?: string; - /** - * The view of the `Company` resource to be returned. This must not be - * `COMPANY_VIEW_UNSPECIFIED`. - */ - view?: string; - /** - * Website URL that will help to find a better matched company. . - */ - websiteUrl?: string; - } - - export class Resource$Companies$Leads { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.companies.leads.create - * @desc Creates an advertiser lead for the given company ID. - * @alias partners.companies.leads.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.companyId The ID of the company to contact. - * @param {().CreateLeadRequest} 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$Companies$Leads$Create, - options?: MethodOptions): AxiosPromise; - create( - params: Params$Resource$Companies$Leads$Create, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - create( - params: Params$Resource$Companies$Leads$Create, - callback: BodyResponseCallback): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: Params$Resource$Companies$Leads$Create| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Companies$Leads$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Companies$Leads$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/companies/{companyId}/leads') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: ['companyId'], - pathParams: ['companyId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Companies$Leads$Create extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * The ID of the company to contact. - */ - companyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CreateLeadRequest; - } - - - - export class Resource$Leads { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.leads.list - * @desc Lists advertiser leads for a user's associated company. Should only - * be called within the context of an authorized logged in user. - * @alias partners.leads.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.orderBy How to order Leads. Currently, only `create_time` and `create_time desc` are supported - * @param {integer=} params.pageSize Requested page size. Server may return fewer leads than requested. If unspecified, server picks an appropriate default. - * @param {string=} params.pageToken A token identifying a page of results that the server returns. Typically, this is the value of `ListLeadsResponse.next_page_token` returned from the previous call to ListLeads. - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's 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$Leads$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Leads$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Leads$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Leads$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Leads$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Leads$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/leads').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Leads$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * How to order Leads. Currently, only `create_time` and `create_time desc` - * are supported - */ - orderBy?: string; - /** - * Requested page size. Server may return fewer leads than requested. If - * unspecified, server picks an appropriate default. - */ - pageSize?: number; - /** - * A token identifying a page of results that the server returns. Typically, - * this is the value of `ListLeadsResponse.next_page_token` returned from - * the previous call to ListLeads. - */ - pageToken?: string; - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - } - - - export class Resource$Offers { - root: Partners; - history: Resource$Offers$History; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - this.history = new Resource$Offers$History(root); - } - - getRoot() { - return this.root; - } - - - /** - * partners.offers.list - * @desc Lists the Offers available for the current user - * @alias partners.offers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's 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$Offers$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Offers$List, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Offers$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Offers$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Offers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Offers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/offers').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Offers$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - } - - export class Resource$Offers$History { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.offers.history.list - * @desc Lists the Historical Offers for the current user (or user's entire - * company) - * @alias partners.offers.history.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.entireCompany if true, show history for the entire company. Requires user to be admin. - * @param {string=} params.orderBy Comma-separated list of fields to order by, e.g.: "foo,bar,baz". Use "foo desc" to sort descending. List of valid field names is: name, offer_code, expiration_time, status, last_modified_time, sender_name, creation_time, country_code, offer_type. - * @param {integer=} params.pageSize Maximum number of rows to return per page. - * @param {string=} params.pageToken Token to retrieve a specific page. - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's 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$Offers$History$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Offers$History$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Offers$History$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): - void; - list( - paramsOrCallback?: Params$Resource$Offers$History$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Offers$History$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Offers$History$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/offers/history') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Offers$History$List extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * if true, show history for the entire company. Requires user to be admin. - */ - entireCompany?: boolean; - /** - * Comma-separated list of fields to order by, e.g.: "foo,bar,baz". Use "foo - * desc" to sort descending. List of valid field names is: name, offer_code, - * expiration_time, status, last_modified_time, sender_name, - * creation_time, country_code, offer_type. - */ - orderBy?: string; - /** - * Maximum number of rows to return per page. - */ - pageSize?: number; - /** - * Token to retrieve a specific page. - */ - pageToken?: string; - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - } - - - - export class Resource$Userevents { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.userEvents.log - * @desc Logs a user event. - * @alias partners.userEvents.log - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().LogUserEventRequest} 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 - */ - log(params?: Params$Resource$Userevents$Log, - options?: MethodOptions): AxiosPromise; - log(params: Params$Resource$Userevents$Log, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - log(params: Params$Resource$Userevents$Log, - callback: BodyResponseCallback): void; - log(callback: BodyResponseCallback): void; - log(paramsOrCallback?: Params$Resource$Userevents$Log| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userevents$Log; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userevents$Log; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/userEvents:log') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Userevents$Log extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - - /** - * Request body metadata - */ - requestBody?: Schema$LogUserEventRequest; - } - - - export class Resource$Users { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.users.createCompanyRelation - * @desc Creates a user's company relation. Affiliates the user to a - * company. - * @alias partners.users.createCompanyRelation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {string} params.userId The ID of the user. Can be set to me to mean the currently authenticated user. - * @param {().CompanyRelation} 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 - */ - createCompanyRelation( - params?: Params$Resource$Users$Createcompanyrelation, - options?: MethodOptions): AxiosPromise; - createCompanyRelation( - params: Params$Resource$Users$Createcompanyrelation, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - createCompanyRelation( - params: Params$Resource$Users$Createcompanyrelation, - callback: BodyResponseCallback): void; - createCompanyRelation( - callback: BodyResponseCallback): void; - createCompanyRelation( - paramsOrCallback?: Params$Resource$Users$Createcompanyrelation| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Users$Createcompanyrelation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Users$Createcompanyrelation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/users/{userId}/companyRelation') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT' - }, - options), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * partners.users.deleteCompanyRelation - * @desc Deletes a user's company relation. Unaffiliaites the user from a - * company. - * @alias partners.users.deleteCompanyRelation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {string} params.userId The ID of the user. Can be set to me to mean the currently authenticated user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - deleteCompanyRelation( - params?: Params$Resource$Users$Deletecompanyrelation, - options?: MethodOptions): AxiosPromise; - deleteCompanyRelation( - params: Params$Resource$Users$Deletecompanyrelation, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - deleteCompanyRelation( - params: Params$Resource$Users$Deletecompanyrelation, - callback: BodyResponseCallback): void; - deleteCompanyRelation(callback: BodyResponseCallback): void; - deleteCompanyRelation( - paramsOrCallback?: Params$Resource$Users$Deletecompanyrelation| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as - Params$Resource$Users$Deletecompanyrelation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Users$Deletecompanyrelation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/users/{userId}/companyRelation') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE' - }, - options), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * partners.users.get - * @desc Gets a user. - * @alias partners.users.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {string} params.userId Identifier of the user. Can be set to me to mean the currently authenticated user. - * @param {string=} params.userView Specifies what parts of the user information to return. - * @param {object} [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$Users$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Users$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Users$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Users$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Users$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Users$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/users/{userId}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * partners.users.updateProfile - * @desc Updates a user's profile. A user can only update their own profile - * and should only be called within the context of a logged in user. - * @alias partners.users.updateProfile - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {().UserProfile} 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 - */ - updateProfile( - params?: Params$Resource$Users$Updateprofile, - options?: MethodOptions): AxiosPromise; - updateProfile( - params: Params$Resource$Users$Updateprofile, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - updateProfile( - params: Params$Resource$Users$Updateprofile, - callback: BodyResponseCallback): void; - updateProfile(callback: BodyResponseCallback): void; - updateProfile( - paramsOrCallback?: Params$Resource$Users$Updateprofile| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Users$Updateprofile; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Users$Updateprofile; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: - (rootUrl + '/v2/users/profile').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Users$Createcompanyrelation extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - /** - * The ID of the user. Can be set to me to mean the currently - * authenticated user. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CompanyRelation; - } - export interface Params$Resource$Users$Deletecompanyrelation extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - /** - * The ID of the user. Can be set to me to mean the currently - * authenticated user. - */ - userId?: string; - } - export interface Params$Resource$Users$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - /** - * Identifier of the user. Can be set to me to mean the - * currently authenticated user. - */ - userId?: string; - /** - * Specifies what parts of the user information to return. - */ - userView?: string; - } - export interface Params$Resource$Users$Updateprofile extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UserProfile; - } - - - export class Resource$Userstates { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.userStates.list - * @desc Lists states for current user. - * @alias partners.userStates.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's 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$Userstates$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Userstates$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Userstates$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Userstates$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Userstates$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userstates$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/userStates').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Userstates$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - } - - - export class Resource$V2 { - root: Partners; - constructor(root: Partners) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * partners.getPartnersstatus - * @desc Gets Partners Status of the logged in user's agency. Should only be - * called if the logged in user is the admin of the agency. - * @alias partners.getPartnersstatus - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's 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 - */ - getPartnersstatus( - params?: Params$Resource$V2$Getpartnersstatus, options?: MethodOptions): - AxiosPromise; - getPartnersstatus( - params: Params$Resource$V2$Getpartnersstatus, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - getPartnersstatus( - params: Params$Resource$V2$Getpartnersstatus, - callback: BodyResponseCallback): void; - getPartnersstatus( - callback: BodyResponseCallback): void; - getPartnersstatus( - paramsOrCallback?: Params$Resource$V2$Getpartnersstatus| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$V2$Getpartnersstatus; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V2$Getpartnersstatus; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/partnersstatus') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest( - parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * partners.updateCompanies - * @desc Update company. Should only be called within the context of an - * authorized logged in user. - * @alias partners.updateCompanies - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths. - * @param {().Company} 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 - */ - updateCompanies( - params?: Params$Resource$V2$Updatecompanies, - options?: MethodOptions): AxiosPromise; - updateCompanies( - params: Params$Resource$V2$Updatecompanies, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - updateCompanies( - params: Params$Resource$V2$Updatecompanies, - callback: BodyResponseCallback): void; - updateCompanies(callback: BodyResponseCallback): void; - updateCompanies( - paramsOrCallback?: Params$Resource$V2$Updatecompanies| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$V2$Updatecompanies; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V2$Updatecompanies; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/companies').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * partners.updateLeads - * @desc Updates the specified lead. - * @alias partners.updateLeads - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.requestMetadata.experimentIds Experiment IDs the current request belongs to. - * @param {string=} params.requestMetadata.locale Locale to use for the current request. - * @param {string=} params.requestMetadata.partnersSessionId Google Partners session ID. - * @param {string=} params.requestMetadata.trafficSource.trafficSourceId Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.trafficSource.trafficSubId Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us. - * @param {string=} params.requestMetadata.userOverrides.ipAddress IP address to use instead of the user's geo-located IP address. - * @param {string=} params.requestMetadata.userOverrides.userId Logged-in user ID to impersonate instead of the user's ID. - * @param {string=} params.updateMask Standard field mask for the set of fields to be updated. Required with at least 1 value in FieldMask's paths. Only `state` and `adwords_customer_id` are currently supported. - * @param {().Lead} 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 - */ - updateLeads( - params?: Params$Resource$V2$Updateleads, - options?: MethodOptions): AxiosPromise; - updateLeads( - params: Params$Resource$V2$Updateleads, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - updateLeads( - params: Params$Resource$V2$Updateleads, - callback: BodyResponseCallback): void; - updateLeads(callback: BodyResponseCallback): void; - updateLeads( - paramsOrCallback?: Params$Resource$V2$Updateleads| - BodyResponseCallback, - optionsOrCallback?: MethodOptions|BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$V2$Updateleads; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V2$Updateleads; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://partners.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/leads').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$V2$Getpartnersstatus extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - } - export interface Params$Resource$V2$Updatecompanies extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - /** - * Standard field mask for the set of fields to be updated. Required with at - * least 1 value in FieldMask's paths. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Company; - } - export interface Params$Resource$V2$Updateleads extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - /** - * Experiment IDs the current request belongs to. - */ - 'requestMetadata.experimentIds'?: string; - /** - * Locale to use for the current request. - */ - 'requestMetadata.locale'?: string; - /** - * Google Partners session ID. - */ - 'requestMetadata.partnersSessionId'?: string; - /** - * Identifier to indicate where the traffic comes from. An identifier has - * multiple letters created by a team which redirected the traffic to us. - */ - 'requestMetadata.trafficSource.trafficSourceId'?: string; - /** - * Second level identifier to indicate where the traffic comes from. An - * identifier has multiple letters created by a team which redirected the - * traffic to us. - */ - 'requestMetadata.trafficSource.trafficSubId'?: string; - /** - * IP address to use instead of the user's geo-located IP address. - */ - 'requestMetadata.userOverrides.ipAddress'?: string; - /** - * Logged-in user ID to impersonate instead of the user's ID. - */ - 'requestMetadata.userOverrides.userId'?: string; - /** - * Standard field mask for the set of fields to be updated. Required with at - * least 1 value in FieldMask's paths. Only `state` and - * `adwords_customer_id` are currently supported. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Lead; - } -} diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index cc35f6b74c3..cf38ecac601 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -1279,7 +1279,7 @@ export namespace people_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -1800,7 +1800,7 @@ export namespace people_v1 { /** * The resource names of the contact groups to get. */ - resourceNames?: string; + resourceNames?: string[]; } export interface Params$Resource$Contactgroups$Create extends StandardParameters { @@ -2457,7 +2457,7 @@ export namespace people_v1 { * [`people.connections.list`](/people/api/rest/v1/people.connections/list). * You can include up to 50 resource names in one request. */ - resourceNames?: string; + resourceNames?: string[]; } export interface Params$Resource$People$Updatecontact extends StandardParameters { diff --git a/src/apis/plus/v1.ts b/src/apis/plus/v1.ts index 831be891934..af06c9d09ba 100644 --- a/src/apis/plus/v1.ts +++ b/src/apis/plus/v1.ts @@ -125,7 +125,15 @@ export namespace plus_v1 { /** * The person who performed this activity. */ - actor?: any; + actor?: { + clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string;};}; + displayName?: string; + id?: string; + image?: {url?: string;}; + name?: {familyName?: string; givenName?: string;}; + url?: string; + verification?: {adHocVerified?: string;}; + }; /** * Street address where this activity occurred. */ @@ -165,7 +173,41 @@ export namespace plus_v1 { /** * The object of this activity. */ - object?: any; + object?: { + actor?: { + clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string;};}; + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + verification?: {adHocVerified?: string;}; + }; + attachments?: Array<{ + content?: string; + displayName?: string; + embed?: {type?: string; url?: string;}; + fullImage?: + {height?: number; type?: string; url?: string; width?: number;}; + id?: string; + image?: {height?: number; type?: string; url?: string; width?: number;}; + objectType?: string; + thumbnails?: Array<{ + description?: string; + image?: + {height?: number; type?: string; url?: string; width?: number;}; + url?: string; + }>; + url?: string; + }>; + content?: string; + id?: string; + objectType?: string; + originalContent?: string; + plusoners?: {selfLink?: string; totalItems?: number;}; + replies?: {selfLink?: string; totalItems?: number;}; + resharers?: {selfLink?: string; totalItems?: number;}; + url?: string; + }; /** * ID of the place where this activity occurred. */ @@ -177,7 +219,7 @@ export namespace plus_v1 { /** * The service provider that initially published this activity. */ - provider?: any; + provider?: {title?: string;}; /** * The time at which this activity was initially published. Formatted as an * RFC 3339 timestamp. @@ -256,7 +298,14 @@ export namespace plus_v1 { /** * The person who posted this comment. */ - actor?: any; + actor?: { + clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string;};}; + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + verification?: {adHocVerified?: string;}; + }; /** * ETag of this response for caching purposes. */ @@ -268,7 +317,7 @@ export namespace plus_v1 { /** * The activity this comment replied to. */ - inReplyTo?: any[]; + inReplyTo?: Array<{id?: string; url?: string;}>; /** * Identifies this resource as a comment. Value: "plus#comment". */ @@ -276,11 +325,11 @@ export namespace plus_v1 { /** * The object of this comment. */ - object?: any; + object?: {content?: string; objectType?: string; originalContent?: string;}; /** * People who +1'd this comment. */ - plusoners?: any; + plusoners?: {totalItems?: number;}; /** * The time at which this comment was initially published. Formatted as an * RFC 3339 timestamp. @@ -386,7 +435,7 @@ export namespace plus_v1 { * and 21 or older. Age is determined from the user's birthday using * Western age reckoning. */ - ageRange?: any; + ageRange?: {max?: number; min?: number;}; /** * The person's date of birth, represented as YYYY-MM-DD. */ @@ -403,7 +452,11 @@ export namespace plus_v1 { /** * The cover photo content. */ - cover?: any; + cover?: { + coverInfo?: {leftImageOffset?: number; topImageOffset?: number;}; + coverPhoto?: {height?: number; url?: string; width?: number;}; + layout?: string; + }; /** * (this field is not currently used) */ @@ -425,7 +478,7 @@ export namespace plus_v1 { * these email addresses, or the email scope can be used to retrieve just * the Google account email address. */ - emails?: any[]; + emails?: Array<{type?: string; value?: string;}>; /** * ETag of this response for caching purposes. */ @@ -443,7 +496,7 @@ export namespace plus_v1 { /** * The representation of the person's profile photo. */ - image?: any; + image?: {isDefault?: boolean; url?: string;}; /** * Whether this user has signed up for Google+. */ @@ -460,7 +513,14 @@ export namespace plus_v1 { * An object representation of the individual components of a person's * name. */ - name?: any; + name?: { + familyName?: string; + formatted?: string; + givenName?: string; + honorificPrefix?: string; + honorificSuffix?: string; + middleName?: string; + }; /** * The nickname of this person. */ @@ -479,11 +539,21 @@ export namespace plus_v1 { * A list of current or past organizations with which this person is * associated. */ - organizations?: any[]; + organizations?: Array<{ + department?: string; + description?: string; + endDate?: string; + location?: string; + name?: string; + primary?: boolean; + startDate?: string; + title?: string; + type?: string; + }>; /** * A list of places where this person has lived. */ - placesLived?: any[]; + placesLived?: Array<{primary?: boolean; value?: string;}>; /** * If a Google+ Page, the number of people who have +1'd this page. */ @@ -515,7 +585,7 @@ export namespace plus_v1 { /** * A list of URLs for this person. */ - urls?: any[]; + urls?: Array<{label?: string; type?: string; value?: string;}>; /** * Whether the person or Google+ Page has been verified. */ @@ -525,7 +595,7 @@ export namespace plus_v1 { /** * The physical address of the place. */ - address?: any; + address?: {formatted?: string;}; /** * The display name of the place. */ @@ -541,7 +611,7 @@ export namespace plus_v1 { /** * The position of the place. */ - position?: any; + position?: {latitude?: number; longitude?: number;}; } export interface Schema$PlusAclentryResource { /** diff --git a/src/apis/plusDomains/v1.ts b/src/apis/plusDomains/v1.ts index dad9f2f5a52..507c7e32609 100644 --- a/src/apis/plusDomains/v1.ts +++ b/src/apis/plusDomains/v1.ts @@ -135,7 +135,15 @@ export namespace plusDomains_v1 { /** * The person who performed this activity. */ - actor?: any; + actor?: { + clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string;};}; + displayName?: string; + id?: string; + image?: {url?: string;}; + name?: {familyName?: string; givenName?: string;}; + url?: string; + verification?: {adHocVerified?: string;}; + }; /** * Street address where this activity occurred. */ @@ -175,7 +183,49 @@ export namespace plusDomains_v1 { /** * The object of this activity. */ - object?: any; + object?: { + actor?: { + clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string;};}; + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + verification?: {adHocVerified?: string;}; + }; + attachments?: Array<{ + content?: string; + displayName?: string; + embed?: {type?: string; url?: string;}; + fullImage?: + {height?: number; type?: string; url?: string; width?: number;}; + id?: string; + image?: {height?: number; type?: string; url?: string; width?: number;}; + objectType?: string; + previewThumbnails?: Array<{url?: string;}>; + thumbnails?: Array<{ + description?: string; + image?: + {height?: number; type?: string; url?: string; width?: number;}; + url?: string; + }>; + url?: string; + }>; + content?: string; + id?: string; + objectType?: string; + originalContent?: string; + plusoners?: {selfLink?: string; totalItems?: number;}; + replies?: {selfLink?: string; totalItems?: number;}; + resharers?: {selfLink?: string; totalItems?: number;}; + statusForViewer?: { + canComment?: boolean; + canPlusone?: boolean; + canUpdate?: boolean; + isPlusOned?: boolean; + resharingDisabled?: boolean; + }; + url?: string; + }; /** * ID of the place where this activity occurred. */ @@ -187,7 +237,7 @@ export namespace plusDomains_v1 { /** * The service provider that initially published this activity. */ - provider?: any; + provider?: {title?: string;}; /** * The time at which this activity was initially published. Formatted as an * RFC 3339 timestamp. @@ -341,7 +391,7 @@ export namespace plusDomains_v1 { /** * The people in this circle. */ - people?: any; + people?: {totalItems?: number;}; /** * Link to this circle resource */ @@ -389,7 +439,14 @@ export namespace plusDomains_v1 { /** * The person who posted this comment. */ - actor?: any; + actor?: { + clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string;};}; + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + verification?: {adHocVerified?: string;}; + }; /** * ETag of this response for caching purposes. */ @@ -401,7 +458,7 @@ export namespace plusDomains_v1 { /** * The activity this comment replied to. */ - inReplyTo?: any[]; + inReplyTo?: Array<{id?: string; url?: string;}>; /** * Identifies this resource as a comment. Value: "plus#comment". */ @@ -409,11 +466,11 @@ export namespace plusDomains_v1 { /** * The object of this comment. */ - object?: any; + object?: {content?: string; objectType?: string; originalContent?: string;}; /** * People who +1'd this comment. */ - plusoners?: any; + plusoners?: {totalItems?: number;}; /** * The time at which this comment was initially published. Formatted as an * RFC 3339 timestamp. @@ -476,7 +533,12 @@ export namespace plusDomains_v1 { /** * The person who uploaded this media. */ - author?: any; + author?: { + displayName?: string; + id?: string; + image?: {url?: string;}; + url?: string; + }; /** * The display name for this media. */ @@ -488,7 +550,7 @@ export namespace plusDomains_v1 { /** * Exif information of the media item. */ - exif?: any; + exif?: {time?: string;}; /** * The height in pixels of the original image. */ @@ -613,7 +675,11 @@ export namespace plusDomains_v1 { /** * The cover photo content. */ - cover?: any; + cover?: { + coverInfo?: {leftImageOffset?: number; topImageOffset?: number;}; + coverPhoto?: {height?: number; url?: string; width?: number;}; + layout?: string; + }; /** * (this field is not currently used) */ @@ -635,7 +701,7 @@ export namespace plusDomains_v1 { * these email addresses, or the email scope can be used to retrieve just * the Google account email address. */ - emails?: any[]; + emails?: Array<{type?: string; value?: string;}>; /** * ETag of this response for caching purposes. */ @@ -653,7 +719,7 @@ export namespace plusDomains_v1 { /** * The representation of the person's profile photo. */ - image?: any; + image?: {isDefault?: boolean; url?: string;}; /** * Whether this user has signed up for Google+. */ @@ -666,7 +732,14 @@ export namespace plusDomains_v1 { * An object representation of the individual components of a person's * name. */ - name?: any; + name?: { + familyName?: string; + formatted?: string; + givenName?: string; + honorificPrefix?: string; + honorificSuffix?: string; + middleName?: string; + }; /** * The nickname of this person. */ @@ -685,11 +758,21 @@ export namespace plusDomains_v1 { * A list of current or past organizations with which this person is * associated. */ - organizations?: any[]; + organizations?: Array<{ + department?: string; + description?: string; + endDate?: string; + location?: string; + name?: string; + primary?: boolean; + startDate?: string; + title?: string; + type?: string; + }>; /** * A list of places where this person has lived. */ - placesLived?: any[]; + placesLived?: Array<{primary?: boolean; value?: string;}>; /** * If a Google+ Page, the number of people who have +1'd this page. */ @@ -721,7 +804,7 @@ export namespace plusDomains_v1 { /** * A list of URLs for this person. */ - urls?: any[]; + urls?: Array<{label?: string; type?: string; value?: string;}>; /** * Whether the person or Google+ Page has been verified. */ @@ -731,7 +814,7 @@ export namespace plusDomains_v1 { /** * The physical address of the place. */ - address?: any; + address?: {formatted?: string;}; /** * The display name of the place. */ @@ -747,7 +830,7 @@ export namespace plusDomains_v1 { /** * The position of the place. */ - position?: any; + position?: {latitude?: number; longitude?: number;}; } export interface Schema$PlusDomainsAclentryResource { /** @@ -1721,11 +1804,11 @@ export namespace plusDomains_v1 { /** * Email of the people to add to the circle. Optional, can be repeated. */ - email?: string; + email?: string[]; /** * IDs of the people to add to the circle. Optional, can be repeated. */ - userId?: string; + userId?: string[]; } export interface Params$Resource$Circles$Get extends StandardParameters { /** @@ -1820,11 +1903,11 @@ export namespace plusDomains_v1 { /** * Email of the people to add to the circle. Optional, can be repeated. */ - email?: string; + email?: string[]; /** * IDs of the people to remove from the circle. Optional, can be repeated. */ - userId?: string; + userId?: string[]; } export interface Params$Resource$Circles$Update extends StandardParameters { /** diff --git a/src/apis/proximitybeacon/v1beta1.ts b/src/apis/proximitybeacon/v1beta1.ts index 3285641f1c7..e57acc96c8f 100644 --- a/src/apis/proximitybeacon/v1beta1.ts +++ b/src/apis/proximitybeacon/v1beta1.ts @@ -231,7 +231,7 @@ export namespace proximitybeacon_v1beta1 { * Properties of the beacon device, for example battery type or firmware * version. Optional. */ - properties?: any; + properties?: {[key: string]: string;}; /** * Some beacons may require a user to provide an authorization key before * changing any of its configuration (e.g. broadcast frames, transmit diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 61572bf850a..4a20da4d748 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -167,10 +167,11 @@ export namespace pubsub_v1 { */ export interface Schema$CreateSnapshotRequest { /** - * See <a href="/pubsub/docs/labels"> Creating and managing - * labels</a>. + * See <a + * href="https://cloud.google.com/pubsub/docs/labels"> Creating + * and managing labels</a>. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The subscription whose backlog the snapshot retains. Specifically, the * created snapshot is guaranteed to retain: (a) The existing backlog on @@ -191,6 +192,21 @@ export namespace pubsub_v1 { * representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * A policy that specifies the conditions for resource expiration (i.e., + * automatic resource deletion). + */ + export interface Schema$ExpirationPolicy { + /** + * Specifies the "time-to-live" duration for an associated + * resource. The resource expires if it is not active for a period of `ttl`. + * The definition of "activity" depends on the type of the + * associated resource. The minimum and maximum allowed values for `ttl` + * depend on the type of the associated resource, as well. If `ttl` is not + * set, the associated resource never expires. + */ + ttl?: string; + } /** * Represents an expression text. Example: title: "User account * presence" description: "Determines whether the request has a @@ -396,13 +412,18 @@ export namespace pubsub_v1 { /** * A message that is published by publishers and consumed by subscribers. The * message must contain either a non-empty data field or at least one - * attribute. + * attribute. Note that client libraries represent this object differently + * depending on the language. See the corresponding <a + * href="https://cloud.google.com/pubsub/docs/reference/libraries">client + * library documentation</a> for more information. See <a + * href="https://cloud.google.com/pubsub/quotas">Quotas and + * limits</a> for more information about message limits. */ export interface Schema$PubsubMessage { /** * Optional attributes for this message. */ - attributes?: any; + attributes?: {[key: string]: string;}; /** * The message data field. If this field is empty, the message must contain * at least one attribute. @@ -472,7 +493,7 @@ export namespace pubsub_v1 { * v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses the push format defined in * the v1 Pub/Sub API. */ - attributes?: any; + attributes?: {[key: string]: string;}; /** * A URL locating the endpoint to which messages should be pushed. For * example, a Webhook endpoint might use @@ -538,13 +559,13 @@ export namespace pubsub_v1 { } /** * A snapshot resource. Snapshots are used in <a - * href="/pubsub/docs/replay-overview">Seek</a> operations, - * which allow you to manage message acknowledgments in bulk. That is, you can - * set the acknowledgment state of messages in an existing subscription to the - * state captured by a snapshot.<br><br> <b>BETA:</b> - * This feature is part of a beta release. This API might be changed in - * backward-incompatible ways and is not recommended for production use. It is - * not subject to any SLA or deprecation policy. + * href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> + * operations, which allow you to manage message acknowledgments in bulk. That + * is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot.<br><br> + * <b>BETA:</b> This feature is part of a beta release. This API + * might be changed in backward-incompatible ways and is not recommended for + * production use. It is not subject to any SLA or deprecation policy. */ export interface Schema$Snapshot { /** @@ -561,10 +582,11 @@ export namespace pubsub_v1 { */ expireTime?: string; /** - * See <a href="/pubsub/docs/labels"> Creating and managing - * labels</a>. + * See <a + * href="https://cloud.google.com/pubsub/docs/labels"> Creating + * and managing labels</a>. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The name of the snapshot. */ @@ -579,16 +601,17 @@ export namespace pubsub_v1 { */ export interface Schema$Subscription { /** - * This value is the maximum time after a subscriber receives a message - * before the subscriber should acknowledge the message. After message - * delivery but before the ack deadline expires and before the message is - * acknowledged, it is an outstanding message and will not be delivered - * again during that time (on a best-effort basis). For pull subscriptions, - * this value is used as the initial value for the ack deadline. To override - * this value for a given message, call `ModifyAckDeadline` with the - * corresponding `ack_id` if using non-streaming pull or send the `ack_id` - * in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The - * minimum custom deadline you can specify is 10 seconds. The maximum custom + * The approximate amount of time (on a best-effort basis) Pub/Sub waits for + * the subscriber to acknowledge receipt before resending the message. In + * the interval after the message is delivered and before it is + * acknowledged, it is considered to be <i>outstanding</i>. + * During that time period, the message will not be redelivered (on a + * best-effort basis). For pull subscriptions, this value is used as the + * initial value for the ack deadline. To override this value for a given + * message, call `ModifyAckDeadline` with the corresponding `ack_id` if + * using non-streaming pull or send the `ack_id` in a + * `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum + * custom deadline you can specify is 10 seconds. The maximum custom * deadline you can specify is 600 seconds (10 minutes). If this parameter * is 0, a default value of 10 seconds is used. For push delivery, this * value is also used to set the request timeout for the call to the push @@ -597,10 +620,23 @@ export namespace pubsub_v1 { */ ackDeadlineSeconds?: number; /** - * See <a href="/pubsub/docs/labels"> Creating and managing - * labels</a>. + * A policy that specifies the conditions for this subscription's + * expiration. A subscription is considered active as long as any connected + * subscriber is successfully consuming messages from the subscription or is + * issuing operations on the subscription. If `expiration_policy` is not + * set, a *default policy* with `ttl` of 31 days will be used. The minimum + * allowed value for `expiration_policy.ttl` is 1 day. + * <b>BETA:</b> This feature is part of a beta release. This API + * might be changed in backward-incompatible ways and is not recommended for + * production use. It is not subject to any SLA or deprecation policy. */ - labels?: any; + expirationPolicy?: Schema$ExpirationPolicy; + /** + * See <a + * href="https://cloud.google.com/pubsub/docs/labels"> Creating + * and managing labels</a>. + */ + labels?: {[key: string]: string;}; /** * How long to retain unacknowledged messages in the subscription's * backlog, from the moment a message is published. If @@ -634,11 +670,11 @@ export namespace pubsub_v1 { * are not expunged from the subscription's backlog, even if they are * acknowledged, until they fall out of the `message_retention_duration` * window. This must be true if you would like to <a - * href="/pubsub/docs/replay-overview#seek_to_a_time">Seek to a - * timestamp</a>. <br><br> <b>BETA:</b> This - * feature is part of a beta release. This API might be changed in - * backward-incompatible ways and is not recommended for production use. It - * is not subject to any SLA or deprecation policy. + * href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> + * Seek to a timestamp</a>. <br><br> + * <b>BETA:</b> This feature is part of a beta release. This API + * might be changed in backward-incompatible ways and is not recommended for + * production use. It is not subject to any SLA or deprecation policy. */ retainAckedMessages?: boolean; /** @@ -675,10 +711,11 @@ export namespace pubsub_v1 { */ export interface Schema$Topic { /** - * See <a href="/pubsub/docs/labels"> Creating and managing - * labels</a>. + * See <a + * href="https://cloud.google.com/pubsub/docs/labels"> Creating + * and managing labels</a>. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The name of the topic. It must have the format * `"projects/{project}/topics/{topic}"`. `{topic}` must start @@ -773,20 +810,21 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.create * @desc Creates a snapshot from the requested subscription. Snapshots are - * used in Seek operations, which - * allow you to manage message acknowledgments in bulk. That is, you can set - * the acknowledgment state of messages in an existing subscription to the - * state captured by a snapshot.

BETA: This feature is part - * of a beta release. This API might be changed in backward-incompatible - * ways and is not recommended for production use. It is not subject to any - * SLA or deprecation policy.

If the snapshot already exists, - * returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, - * returns `NOT_FOUND`. If the backlog in the subscription is too old -- and - * the resulting snapshot would expire in less than 1 hour -- then - * `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` - * field. If the name is not provided in the request, the server will assign - * a random name for this snapshot on the same project as the subscription, - * conforming to the [resource name + * used in Seek + * operations, which allow you to manage message acknowledgments in bulk. + * That is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot.

BETA: + * This feature is part of a beta release. This API might be changed in + * backward-incompatible ways and is not recommended for production use. It + * is not subject to any SLA or deprecation policy.

If the snapshot + * already exists, returns `ALREADY_EXISTS`. If the requested subscription + * doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is + * too old -- and the resulting snapshot would expire in less than 1 hour -- + * then `FAILED_PRECONDITION` is returned. See also the + * `Snapshot.expire_time` field. If the name is not provided in the request, + * the server will assign a random name for this snapshot on the same + * project as the subscription, conforming to the [resource name * format](https://cloud.google.com/pubsub/docs/overview#names). The * generated name is populated in the returned Snapshot object. Note that * for REST API requests, you must specify a name in the request. @@ -794,7 +832,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Optional user-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. + * @param {string} params.name Optional user-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. * @param {().CreateSnapshotRequest} 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. @@ -856,17 +894,17 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.delete * @desc Removes an existing snapshot. Snapshots are used in Seek operations, which allow you - * to manage message acknowledgments in bulk. That is, you can set the - * acknowledgment state of messages in an existing subscription to the state - * captured by a snapshot.

BETA: This feature is part of a - * beta release. This API might be changed in backward-incompatible ways and - * is not recommended for production use. It is not subject to any SLA or - * deprecation policy. When the snapshot is deleted, all messages retained - * in the snapshot are immediately dropped. After a snapshot is deleted, a - * new one may be created with the same name, but the new one has no - * association with the old snapshot or its subscription, unless the same - * subscription is specified. + * href="https://cloud.google.com/pubsub/docs/replay-overview">Seek + * operations, which allow you to manage message acknowledgments in bulk. + * That is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot.

BETA: + * This feature is part of a beta release. This API might be changed in + * backward-incompatible ways and is not recommended for production use. It + * is not subject to any SLA or deprecation policy. When the snapshot is + * deleted, all messages retained in the snapshot are immediately dropped. + * After a snapshot is deleted, a new one may be created with the same name, + * but the new one has no association with the old snapshot or its + * subscription, unless the same subscription is specified. * @alias pubsub.projects.snapshots.delete * @memberOf! () * @@ -932,13 +970,13 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.get * @desc Gets the configuration details of a snapshot. Snapshots are used in - * Seek operations, which allow - * you to manage message acknowledgments in bulk. That is, you can set the - * acknowledgment state of messages in an existing subscription to the state - * captured by a snapshot.

BETA: This feature is part of a - * beta release. This API might be changed in backward-incompatible ways and - * is not recommended for production use. It is not subject to any SLA or - * deprecation policy. + * Seek + * operations, which allow you to manage message acknowledgments in bulk. + * That is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot.

BETA: + * This feature is part of a beta release. This API might be changed in + * backward-incompatible ways and is not recommended for production use. It + * is not subject to any SLA or deprecation policy. * @alias pubsub.projects.snapshots.get * @memberOf! () * @@ -1120,13 +1158,13 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.list * @desc Lists the existing snapshots. Snapshots are used in Seek operations, which allow you - * to manage message acknowledgments in bulk. That is, you can set the - * acknowledgment state of messages in an existing subscription to the state - * captured by a snapshot.

BETA: This feature is part of a - * beta release. This API might be changed in backward-incompatible ways and - * is not recommended for production use. It is not subject to any SLA or - * deprecation policy. + * href="https://cloud.google.com/pubsub/docs/replay-overview">Seek + * operations, which allow you to manage message acknowledgments in bulk. + * That is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot.

BETA: + * This feature is part of a beta release. This API might be changed in + * backward-incompatible ways and is not recommended for production use. It + * is not subject to any SLA or deprecation policy. * @alias pubsub.projects.snapshots.list * @memberOf! () * @@ -1197,14 +1235,14 @@ export namespace pubsub_v1 { /** * pubsub.projects.snapshots.patch * @desc Updates an existing snapshot. Snapshots are used in Seek operations, which allow you - * to manage message acknowledgments in bulk. That is, you can set the - * acknowledgment state of messages in an existing subscription to the state - * captured by a snapshot.

BETA: This feature is part of a - * beta release. This API might be changed in backward-incompatible ways and - * is not recommended for production use. It is not subject to any SLA or - * deprecation policy. Note that certain properties of a snapshot are not - * modifiable. + * href="https://cloud.google.com/pubsub/docs/replay-overview">Seek + * operations, which allow you to manage message acknowledgments in bulk. + * That is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot.

BETA: + * This feature is part of a beta release. This API might be changed in + * backward-incompatible ways and is not recommended for production use. It + * is not subject to any SLA or deprecation policy. Note that certain + * properties of a snapshot are not modifiable. * @alias pubsub.projects.snapshots.patch * @memberOf! () * @@ -1543,8 +1581,8 @@ export namespace pubsub_v1 { * provided in the request, the server will assign a random name for this * snapshot on the same project as the subscription. Note that for REST API * requests, you must specify a name. See the resource name rules. Format - * is `projects/{project}/snapshots/{snap}`. + * href="https://cloud.google.com/pubsub/docs/admin#resource_names"> + * resource name rules. Format is `projects/{project}/snapshots/{snap}`. */ name?: string; @@ -1812,12 +1850,12 @@ export namespace pubsub_v1 { /** * pubsub.projects.subscriptions.create * @desc Creates a subscription to a given topic. See the resource name rules. If the - * subscription already exists, returns `ALREADY_EXISTS`. If the - * corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is - * not provided in the request, the server will assign a random name for - * this subscription on the same project as the topic, conforming to the - * [resource name + * href="https://cloud.google.com/pubsub/docs/admin#resource_names"> + * resource name rules. If the subscription already exists, returns + * `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns + * `NOT_FOUND`. If the name is not provided in the request, the server will + * assign a random name for this subscription on the same project as the + * topic, conforming to the [resource name * format](https://cloud.google.com/pubsub/docs/overview#names). The * generated name is populated in the returned Subscription object. Note * that for REST API requests, you must specify a name in the request. @@ -2910,14 +2948,14 @@ export namespace pubsub_v1 { * pubsub.projects.subscriptions.seek * @desc Seeks an existing subscription to a point in time or to a given * snapshot, whichever is provided in the request. Snapshots are used in Seek operations, which allow you - * to manage message acknowledgments in bulk. That is, you can set the - * acknowledgment state of messages in an existing subscription to the state - * captured by a snapshot. Note that both the subscription and the snapshot - * must be on the same topic.

BETA: This feature is part of a - * beta release. This API might be changed in backward-incompatible ways and - * is not recommended for production use. It is not subject to any SLA or - * deprecation policy. + * href="https://cloud.google.com/pubsub/docs/replay-overview">Seek + * operations, which allow you to manage message acknowledgments in bulk. + * That is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot. Note that both the + * subscription and the snapshot must be on the same topic.

+ * BETA: This feature is part of a beta release. This API might be + * changed in backward-incompatible ways and is not recommended for + * production use. It is not subject to any SLA or deprecation policy. * @alias pubsub.projects.subscriptions.seek * @memberOf! () * @@ -3499,7 +3537,8 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.create * @desc Creates the given topic with the given name. See the resource name rules. + * href="https://cloud.google.com/pubsub/docs/admin#resource_names"> + * resource name rules. * @example * * // BEFORE RUNNING: * // --------------- @@ -4763,13 +4802,14 @@ export namespace pubsub_v1 { /** * pubsub.projects.topics.snapshots.list * @desc Lists the names of the snapshots on this topic. Snapshots are used - * in Seek operations, which - * allow you to manage message acknowledgments in bulk. That is, you can set - * the acknowledgment state of messages in an existing subscription to the - * state captured by a snapshot.

BETA: This feature is part - * of a beta release. This API might be changed in backward-incompatible - * ways and is not recommended for production use. It is not subject to any - * SLA or deprecation policy. + * in Seek + * operations, which allow you to manage message acknowledgments in bulk. + * That is, you can set the acknowledgment state of messages in an existing + * subscription to the state captured by a snapshot.

BETA: + * This feature is part of a beta release. This API might be changed in + * backward-incompatible ways and is not recommended for production use. It + * is not subject to any SLA or deprecation policy. * @alias pubsub.projects.topics.snapshots.list * @memberOf! () * diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index 10e5c2535ee..a331184249d 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -345,7 +345,7 @@ export namespace pubsub_v1beta2 { /** * Optional attributes for this message. */ - attributes?: any; + attributes?: {[key: string]: string;}; /** * The message payload. For JSON requests, the value of this field must be * [base64-encoded](https://tools.ietf.org/html/rfc4648). @@ -416,7 +416,7 @@ export namespace pubsub_v1beta2 { * API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub * API. */ - attributes?: any; + attributes?: {[key: string]: string;}; /** * A URL locating the endpoint to which messages should be pushed. For * example, a Webhook endpoint might use diff --git a/src/apis/redis/README.md b/src/apis/redis/README.md index 5e7e8d13790..72eb222393c 100644 --- a/src/apis/redis/README.md +++ b/src/apis/redis/README.md @@ -2,7 +2,7 @@ # @google/redis -> The Google Cloud Memorystore for Redis API is used for creating and managing Redis instances on the Google Cloud Platform. +> Creates and manages Redis instances on the Google Cloud Platform. ## Installation diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index ab49eef1ccb..604ad8bf1f6 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -137,7 +137,7 @@ export namespace redis_v1 { * specified in `location_id` or `alternative_location_id` fields when * creating a Redis instance. */ - availableZones?: any; + availableZones?: {[key: string]: Schema$GoogleCloudRedisV1ZoneMetadata;}; } /** * Represents the v1 metadata of the long-running operation. @@ -218,7 +218,7 @@ export namespace redis_v1 { /** * Resource labels to represent user provided metadata */ - labels?: any; + labels?: {[key: string]: string;}; /** * Optional. The zone where the instance will be provisioned. If not * provided, the service will choose a zone for the instance. For @@ -251,7 +251,7 @@ export namespace redis_v1 { * http://redis.io/topics/config. Currently, the only supported parameters * are: * maxmemory-policy * notify-keyspace-events */ - redisConfigs?: any; + redisConfigs?: {[key: string]: string;}; /** * Optional. The version of Redis software. If not provided, latest * supported version will be used. Updating the version will perform an @@ -345,7 +345,7 @@ export namespace redis_v1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * Resource ID for the region. For example: "us-east1". */ @@ -356,7 +356,7 @@ export namespace redis_v1 { * keys can be specified in `location_id` or `alternative_location_id` * fields when creating a Redis instance. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Full resource name for the region. For example: * "projects/example-project/locations/us-east1". @@ -389,7 +389,7 @@ export namespace redis_v1 { * corresponding to `Code.CANCELLED`. `apiVersion`: API version used to * start the operation. } */ - metadata?: 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 @@ -405,7 +405,7 @@ export namespace redis_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -452,7 +452,7 @@ export namespace redis_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index e6609e19375..22dba47334a 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -174,7 +174,8 @@ export namespace redis_v1beta1 { * specified in `location_id` or `alternative_location_id` fields when * creating a Redis instance. */ - availableZones?: any; + availableZones?: + {[key: string]: Schema$GoogleCloudRedisV1beta1ZoneMetadata;}; } /** * Defines specific information for a particular zone. Currently empty and @@ -222,7 +223,7 @@ export namespace redis_v1beta1 { /** * Resource labels to represent user provided metadata */ - labels?: any; + labels?: {[key: string]: string;}; /** * Optional. The zone where the instance will be provisioned. If not * provided, the service will choose a zone for the instance. For @@ -263,7 +264,7 @@ export namespace redis_v1beta1 { * http://redis.io/topics/config. Currently, the only supported parameters * are: * maxmemory-policy * notify-keyspace-events */ - redisConfigs?: any; + redisConfigs?: {[key: string]: string;}; /** * Optional. The version of Redis software. If not provided, latest * supported version will be used. Updating the version will perform an @@ -357,7 +358,7 @@ export namespace redis_v1beta1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * Resource ID for the region. For example: "us-east1". */ @@ -368,7 +369,7 @@ export namespace redis_v1beta1 { * keys can be specified in `location_id` or `alternative_location_id` * fields when creating a Redis instance. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Full resource name for the region. For example: * "projects/example-project/locations/us-east1". @@ -401,7 +402,7 @@ export namespace redis_v1beta1 { * corresponding to `Code.CANCELLED`. `apiVersion`: API version used to * start the operation. } */ - metadata?: 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 @@ -417,7 +418,7 @@ export namespace redis_v1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -464,7 +465,7 @@ export namespace redis_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/replicapoolupdater/v1beta1.ts b/src/apis/replicapoolupdater/v1beta1.ts index 5bc16cff488..70b6287af77 100644 --- a/src/apis/replicapoolupdater/v1beta1.ts +++ b/src/apis/replicapoolupdater/v1beta1.ts @@ -109,7 +109,9 @@ export namespace replicapoolupdater_v1beta1 { /** * Errors that occurred during the instance update. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * Fully-qualified URL of the instance being updated. */ @@ -164,7 +166,9 @@ export namespace replicapoolupdater_v1beta1 { * [Output Only] If errors occurred during processing of this operation, * this field will be populated. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; httpErrorMessage?: string; httpErrorStatusCode?: number; /** @@ -220,7 +224,11 @@ export namespace replicapoolupdater_v1beta1 { */ targetLink?: string; user?: string; - warnings?: any[]; + warnings?: Array<{ + code?: string; + data?: Array<{key?: string; value?: string;}>; + message?: string; + }>; /** * [Output Only] URL of the zone where the operation resides. */ @@ -277,7 +285,9 @@ export namespace replicapoolupdater_v1beta1 { /** * [Output Only] Errors that occurred during the rolling update. */ - error?: any; + error?: { + errors?: Array<{code?: string; location?: string; message?: string;}>; + }; /** * [Output Only] Unique identifier for the resource; defined by the server. */ @@ -308,7 +318,13 @@ export namespace replicapoolupdater_v1beta1 { /** * Parameters of the update process. */ - policy?: any; + policy?: { + autoPauseAfterInstances?: number; + instanceStartupTimeoutSec?: number; + maxNumConcurrentInstances?: number; + maxNumFailedInstances?: number; + minInstanceUpdateTimeSec?: number; + }; /** * [Output Only] An optional progress indicator that ranges from 0 to 100. * There is no requirement that this be linear or support any granularity of diff --git a/src/apis/reseller/v1.ts b/src/apis/reseller/v1.ts index 157a9234a94..a0e108a42b6 100644 --- a/src/apis/reseller/v1.ts +++ b/src/apis/reseller/v1.ts @@ -375,7 +375,11 @@ export namespace reseller_v1 { * trial plan. For more information about the API"s payment plans, see * the API concepts. */ - plan?: any; + plan?: { + commitmentInterval?: {endTime?: string; startTime?: string;}; + isCommitmentPlan?: boolean; + planName?: string; + }; /** * This is an optional property. This purchase order (PO) information is for * resellers to use for their company tracking usage. If a purchaseOrderId @@ -445,12 +449,15 @@ export namespace reseller_v1 { * Read-only transfer related information for the subscription. For more * information, see retrieve transferable subscriptions for a customer. */ - transferInfo?: any; + transferInfo?: { + minimumTransferableSeats?: number; + transferabilityExpirationTime?: string; + }; /** * The G Suite annual commitment and flexible payment plans can be in a * 30-day free trial. For more information, see the API concepts. */ - trialSettings?: any; + trialSettings?: {isInTrial?: boolean; trialEndTime?: string;}; } /** * JSON template for a subscription list. diff --git a/src/apis/runtimeconfig/v1.ts b/src/apis/runtimeconfig/v1.ts index c5470f8fb4d..67cde54d06d 100644 --- a/src/apis/runtimeconfig/v1.ts +++ b/src/apis/runtimeconfig/v1.ts @@ -164,7 +164,7 @@ export namespace runtimeconfig_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -180,7 +180,7 @@ export namespace runtimeconfig_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -227,7 +227,7 @@ export namespace runtimeconfig_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index 121cd64f303..319b2b314de 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -296,7 +296,7 @@ export namespace runtimeconfig_v1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -312,7 +312,7 @@ export namespace runtimeconfig_v1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Defines an Identity and Access Management (IAM) policy. It is used to @@ -436,7 +436,7 @@ export namespace runtimeconfig_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index 97dd6383917..4f9145cfb3a 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -625,7 +625,7 @@ export namespace script_v1 { * If the script function returns successfully, this field contains an * ExecutionResponse object with the function's return value. */ - response?: any; + response?: {[key: string]: any;}; } /** * The script project resource. @@ -692,7 +692,7 @@ export namespace script_v1 { * An array that contains a single ExecutionError object that provides * information about the nature of the error. */ - details?: any[]; + details?: Array<{[key: string]: any;}>; /** * A developer-facing error message, which is in English. Any user-facing * error message is localized and sent in the details field, or localized by @@ -960,17 +960,17 @@ export namespace script_v1 { * Optional field used to limit returned processes to those having one of * the specified process statuses. */ - 'userProcessFilter.statuses'?: string; + 'userProcessFilter.statuses'?: string[]; /** * Optional field used to limit returned processes to those having one of * the specified process types. */ - 'userProcessFilter.types'?: string; + 'userProcessFilter.types'?: string[]; /** * Optional field used to limit returned processes to those having one of * the specified user access levels. */ - 'userProcessFilter.userAccessLevels'?: string; + 'userProcessFilter.userAccessLevels'?: string[]; } export interface Params$Resource$Processes$Listscriptprocesses extends StandardParameters { @@ -1017,17 +1017,17 @@ export namespace script_v1 { * Optional field used to limit returned processes to those having one of * the specified process statuses. */ - 'scriptProcessFilter.statuses'?: string; + 'scriptProcessFilter.statuses'?: string[]; /** * Optional field used to limit returned processes to those having one of * the specified process types. */ - 'scriptProcessFilter.types'?: string; + 'scriptProcessFilter.types'?: string[]; /** * Optional field used to limit returned processes to those having one of * the specified user access levels. */ - 'scriptProcessFilter.userAccessLevels'?: string; + 'scriptProcessFilter.userAccessLevels'?: string[]; } diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts index 62b09e96b8c..f8607903e21 100644 --- a/src/apis/servicebroker/v1alpha1.ts +++ b/src/apis/servicebroker/v1alpha1.ts @@ -132,7 +132,7 @@ export namespace servicebroker_v1alpha1 { * A JSON object that contains data for platform resources associated with * the binding to be created. */ - bind_resource?: any; + bind_resource?: {[key: string]: any;}; /** * Output only. Timestamp for when the binding was created. */ @@ -140,7 +140,7 @@ export namespace servicebroker_v1alpha1 { /** * Configuration options for the service binding. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The ID of the plan. See `Service` and `Plan` resources for details. * Maximum length is 64, GUID recommended. Required. @@ -160,7 +160,7 @@ export namespace servicebroker_v1alpha1 { /** * Credentials to use the binding. */ - credentials?: any; + credentials?: {[key: string]: any;}; /** * Used to communicate description of the response. Usually for non-standard * error codes. @@ -185,7 +185,7 @@ export namespace servicebroker_v1alpha1 { /** * An array of configuration for mounting volumes. */ - volume_mounts?: any[]; + volume_mounts?: Array<{[key: string]: any;}>; } /** * Response for the `CreateServiceInstance()` method. @@ -261,7 +261,7 @@ export namespace servicebroker_v1alpha1 { /** * Credentials to use the binding. */ - credentials?: any; + credentials?: {[key: string]: any;}; /** * Used to communicate description of the response. Usually for non-standard * error codes. @@ -280,7 +280,7 @@ export namespace servicebroker_v1alpha1 { /** * An array of configuration for mounting volumes. */ - volume_mounts?: any[]; + volume_mounts?: Array<{[key: string]: any;}>; } /** * The response for the `ListBindings()` method. @@ -391,7 +391,7 @@ export namespace servicebroker_v1alpha1 { * A list of metadata for a service offering. Metadata is an arbitrary JSON * object. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * User friendly name of the plan. The name must be globally unique within * GCP project. Note, which is different from ("This must be globally @@ -401,7 +401,7 @@ export namespace servicebroker_v1alpha1 { /** * Schema definitions for service instances and bindings for the plan. */ - schemas?: any; + schemas?: {[key: string]: any;}; } /** * The resource model mostly follows the Open Service Broker API, as described @@ -440,7 +440,7 @@ export namespace servicebroker_v1alpha1 { * A list of metadata for a service offering. Metadata is an arbitrary JSON * object. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * User friendly service name. Name must match [a-z0-9]+ regexp. The name * must be globally unique within GCP project. Note, which is different from @@ -473,7 +473,7 @@ export namespace servicebroker_v1alpha1 { * can also contain anything. Currently only used for logging context * information. */ - context?: any; + context?: {[key: string]: any;}; /** * Output only. Timestamp for when the instance was created. */ @@ -497,7 +497,7 @@ export namespace servicebroker_v1alpha1 { * Configuration options for the service instance. Parameters is JSON object * serialized to string. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The ID of the plan. See `Service` and `Plan` resources for details. * Maximum length is 64, GUID recommended. Required. @@ -507,7 +507,7 @@ export namespace servicebroker_v1alpha1 { * Used only in UpdateServiceInstance request to optionally specify previous * fields. */ - previous_values?: any; + previous_values?: {[key: string]: any;}; /** * Output only. The resource name of the instance, e.g. * projects/project_id/brokers/broker_id/service_instances/instance_id diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts index 13424e6b865..926b0ec96bc 100644 --- a/src/apis/servicebroker/v1beta1.ts +++ b/src/apis/servicebroker/v1beta1.ts @@ -132,7 +132,7 @@ export namespace servicebroker_v1beta1 { * A JSON object that contains data for platform resources associated with * the binding to be created. */ - bind_resource?: any; + bind_resource?: {[key: string]: any;}; /** * Output only. Timestamp for when the binding was created. */ @@ -145,7 +145,7 @@ export namespace servicebroker_v1beta1 { /** * Configuration options for the service binding. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The ID of the plan. See `Service` and `Plan` resources for details. * Maximum length is 64, GUID recommended. Required. @@ -197,7 +197,7 @@ export namespace servicebroker_v1beta1 { /** * Credentials to use the binding. */ - credentials?: any; + credentials?: {[key: string]: any;}; /** * Used to communicate description of the response. Usually for non-standard * error codes. @@ -222,7 +222,7 @@ export namespace servicebroker_v1beta1 { /** * An array of configuration for mounting volumes. */ - volume_mounts?: any[]; + volume_mounts?: Array<{[key: string]: any;}>; } /** * Response for the `CreateServiceInstance()` method. @@ -298,7 +298,7 @@ export namespace servicebroker_v1beta1 { /** * Credentials to use the binding. */ - credentials?: any; + credentials?: {[key: string]: any;}; /** * String containing the Deployment Manager deployment name that was created * for this binding, @@ -327,7 +327,7 @@ export namespace servicebroker_v1beta1 { /** * An array of configurations for mounting volumes. */ - volume_mounts?: any[]; + volume_mounts?: Array<{[key: string]: any;}>; } /** * The response for the `ListBindings()` method. @@ -455,7 +455,7 @@ export namespace servicebroker_v1beta1 { * A list of metadata for a service offering. Metadata is an arbitrary JSON * object. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * User friendly name of the plan. The name must be globally unique within * GCP project. Note, which is different from ("This must be globally @@ -465,7 +465,7 @@ export namespace servicebroker_v1beta1 { /** * Schema definitions for service instances and bindings for the plan. */ - schemas?: any; + schemas?: {[key: string]: any;}; } /** * The resource model mostly follows the Open Service Broker API, as described @@ -508,7 +508,7 @@ export namespace servicebroker_v1beta1 { * A list of metadata for a service offering. Metadata is an arbitrary JSON * object. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * User friendly service name. Name must match [a-z0-9]+ regexp. The name * must be globally unique within GCP project. Note, which is different from @@ -541,7 +541,7 @@ export namespace servicebroker_v1beta1 { * can also contain anything. Currently only used for logging context * information. */ - context?: any; + context?: {[key: string]: any;}; /** * Output only. Timestamp for when the instance was created. */ @@ -570,7 +570,7 @@ export namespace servicebroker_v1beta1 { * Configuration options for the service instance. Parameters is JSON object * serialized to string. */ - parameters?: any; + parameters?: {[key: string]: any;}; /** * The ID of the plan. See `Service` and `Plan` resources for details. * Maximum length is 64, GUID recommended. Required. @@ -580,7 +580,7 @@ export namespace servicebroker_v1beta1 { * Used only in UpdateServiceInstance request to optionally specify previous * fields. */ - previous_values?: any; + previous_values?: {[key: string]: any;}; /** * Output only. The resource name of the instance, e.g. * projects/project_id/brokers/broker_id/service_instances/instance_id diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 56983cc4d73..937f1079a6c 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -188,6 +188,41 @@ export namespace serviceconsumermanagement_v1 { */ version?: string; } + /** + * Request to apply configuration to an existing tenant project. + */ + export interface Schema$ApplyTenantProjectConfigRequest { + /** + * Configuration that should be applied to the existing tenant project. + */ + projectConfig?: Schema$TenantProjectConfig; + /** + * Tag of the project. Must be less than 128 characters. Required. + */ + tag?: string; + } + /** + * Request to attach an existing project to the tenancy unit as a new tenant + * resource. + */ + export interface Schema$AttachTenantProjectRequest { + /** + * When attaching an external project, this is in the format of + * `projects/{project_number}’. + */ + externalResource?: string; + /** + * When attaching a reserved project already in Tenancy Units, this is the + * tag of tenant resource under the tenancy unit for the service's + * producer project. The reserved tenant resource must be in active state. + */ + reservedResource?: string; + /** + * Tag of the tenant resource after attachment. Must be less than 128 + * characters. Required. + */ + tag?: string; + } /** * `Authentication` defines the authentication configuration for an API. * Example for an API targeted for external use: name: @@ -1292,7 +1327,7 @@ export namespace serviceconsumermanagement_v1 { * name, and the values are the amount increased for the metric against * which the quota limits are defined. The value must not be negative. */ - metricCosts?: any; + metricCosts?: {[key: string]: string;}; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -1493,7 +1528,7 @@ export namespace serviceconsumermanagement_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1509,7 +1544,7 @@ export namespace serviceconsumermanagement_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A protocol buffer option, which can be attached to a message, field, @@ -1530,7 +1565,7 @@ export namespace serviceconsumermanagement_v1 { * it should be stored as an int32 value using the * google.protobuf.Int32Value type. */ - value?: any; + value?: {[key: string]: any;}; } /** * Represents a documentation page. A page can contain subpages to represent @@ -1696,7 +1731,7 @@ export namespace serviceconsumermanagement_v1 { * integer value that is the maximum number of requests allowed for the * specified unit. Currently only STANDARD is supported. */ - values?: any; + values?: {[key: string]: string;}; } /** * Request message to remove tenant project resource from the tenancy unit. @@ -1909,7 +1944,7 @@ export namespace serviceconsumermanagement_v1 { /** * All files used during config generation. */ - sourceFiles?: any[]; + sourceFiles?: Array<{[key: string]: any;}>; } /** * The `Status` type defines a logical error model that is suitable for @@ -1956,7 +1991,7 @@ export namespace serviceconsumermanagement_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -2080,7 +2115,7 @@ export namespace serviceconsumermanagement_v1 { /** * Labels that will be applied to this project. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Configuration for IAM service account on tenant project. */ @@ -2795,6 +2830,163 @@ export namespace serviceconsumermanagement_v1 { } + /** + * serviceconsumermanagement.services.tenancyUnits.applyProjectConfig + * @desc Apply configuration to an existing tenant project. This project + * must exist in active state and have the original owner account. Caller + * must have the permission to add a project to the given tenancy unit. + * Configuration will be applied, but any existing settings on the project + * will not be modified. Specified policy bindings will be applied. Existing + * binding will not be modified. Specified services will be activated. No + * service will be deactivated. New billing configuration will be applied if + * specified. Omit billing configuration to keep the existing one. Service + * account in the project will be created if previously non existing. + * Operation fails if any of the steps fail, but no rollback of already + * applied configuration changes is attempted. Operation. + * @alias serviceconsumermanagement.services.tenancyUnits.applyProjectConfig + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the tenancy unit. + * @param {().ApplyTenantProjectConfigRequest} 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 + */ + applyProjectConfig( + params?: Params$Resource$Services$Tenancyunits$Applyprojectconfig, + options?: MethodOptions): AxiosPromise; + applyProjectConfig( + params: Params$Resource$Services$Tenancyunits$Applyprojectconfig, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + applyProjectConfig( + params: Params$Resource$Services$Tenancyunits$Applyprojectconfig, + callback: BodyResponseCallback): void; + applyProjectConfig(callback: BodyResponseCallback): void; + applyProjectConfig( + paramsOrCallback?: + Params$Resource$Services$Tenancyunits$Applyprojectconfig| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Services$Tenancyunits$Applyprojectconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Tenancyunits$Applyprojectconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || + 'https://serviceconsumermanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:applyProjectConfig') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * serviceconsumermanagement.services.tenancyUnits.attachProject + * @desc Attach an existing project to the tenancy unit as a new tenant + * resource. The project could be either the tenant project reserved by + * calling AddTenantProject under tenancy unit for the producer project of + * service, or from outside. Caller will be checked against the permission + * as if calling AddTenantProject on the same consumer. To trigger the + * attachement, the targeted tenant project must be in a folder. Please also + * make sure ServiceConsumerManagement service account is the owner of that + * project. Note that these two requirements are already met if the project + * is reserved through AddTenantProject. Operation. + * @alias serviceconsumermanagement.services.tenancyUnits.attachProject + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the tenancy unit that project will be attached to. + * @param {().AttachTenantProjectRequest} 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 + */ + attachProject( + params?: Params$Resource$Services$Tenancyunits$Attachproject, + options?: MethodOptions): AxiosPromise; + attachProject( + params: Params$Resource$Services$Tenancyunits$Attachproject, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + attachProject( + params: Params$Resource$Services$Tenancyunits$Attachproject, + callback: BodyResponseCallback): void; + attachProject(callback: BodyResponseCallback): void; + attachProject( + paramsOrCallback?: Params$Resource$Services$Tenancyunits$Attachproject| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Services$Tenancyunits$Attachproject; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Tenancyunits$Attachproject; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || + 'https://serviceconsumermanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:attachProject') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** * serviceconsumermanagement.services.tenancyUnits.create * @desc Creates a tenancy unit with no tenant resources. @@ -3096,6 +3288,40 @@ export namespace serviceconsumermanagement_v1 { */ requestBody?: Schema$AddTenantProjectRequest; } + export interface Params$Resource$Services$Tenancyunits$Applyprojectconfig + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the tenancy unit. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ApplyTenantProjectConfigRequest; + } + export interface Params$Resource$Services$Tenancyunits$Attachproject extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Name of the tenancy unit that project will be attached to. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AttachTenantProjectRequest; + } export interface Params$Resource$Services$Tenancyunits$Create extends StandardParameters { /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 712a035ae1a..1a6774bad8a 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -191,7 +191,7 @@ export namespace servicecontrol_v1 { * Other service-specific data about the request, response, and other * information associated with the current audited event. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * The name of the service method or operation. For API calls, this should * be the name of the API method. For example, @@ -211,7 +211,7 @@ export namespace servicecontrol_v1 { * file contents. When the JSON object represented here has a proto * equivalent, the proto name will be indicated in the `@type` property. */ - request?: any; + request?: {[key: string]: any;}; /** * Metadata about the operation. */ @@ -235,7 +235,7 @@ export namespace servicecontrol_v1 { * `service_data` fields. When the JSON object represented here has a proto * equivalent, the proto name will be indicated in the `@type` property. */ - resourceOriginalState?: any; + resourceOriginalState?: {[key: string]: any;}; /** * The operation response. This may not include all response elements, such * as those that are too large, privacy-sensitive, or duplicated elsewhere @@ -243,12 +243,12 @@ export namespace servicecontrol_v1 { * file contents. When the JSON object represented here has a proto * equivalent, the proto name will be indicated in the `@type` property. */ - response?: any; + response?: {[key: string]: any;}; /** * Deprecated, use `metadata` field instead. Other service-specific data * about the request, response, and other activities. */ - serviceData?: any; + serviceData?: {[key: string]: any;}; /** * The name of the API service performing the operation. For example, * `"datastore.googleapis.com"`. @@ -300,7 +300,7 @@ export namespace servicecontrol_v1 { * 'exp': 1353604926} SAML assertions are similarly specified, but * with an identity provider dependent structure. */ - claims?: any; + claims?: {[key: string]: any;}; /** * The authorized presenter of the credential. Reflects the optional * Authorized Presenter (`azp`) claim within a JWT or the OAuth client id. @@ -338,7 +338,7 @@ export namespace servicecontrol_v1 { * the request. When the JSON object represented here has a proto * equivalent, the proto name will be indicated in the `@type` property. */ - thirdPartyPrincipal?: any; + thirdPartyPrincipal?: {[key: string]: any;}; } /** * Authorization information for the operation. @@ -696,7 +696,7 @@ export namespace servicecontrol_v1 { * A set of user-defined (key, value) data that provides additional * information about the log entry. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. The log to which this log entry belongs. Examples: * `"syslog"`, `"book_log"`. @@ -711,7 +711,7 @@ export namespace servicecontrol_v1 { * The log entry payload, represented as a protocol buffer that is expressed * as a JSON object. The only accepted type currently is AuditLog. */ - protoPayload?: any; + protoPayload?: {[key: string]: any;}; /** * The severity of the log entry. The default value is * `LogSeverity.DEFAULT`. @@ -721,7 +721,7 @@ export namespace servicecontrol_v1 { * The log entry payload, represented as a structure that is expressed as a * JSON object. */ - structPayload?: any; + structPayload?: {[key: string]: any;}; /** * The log entry payload, represented as a Unicode string (UTF-8). */ @@ -797,7 +797,7 @@ export namespace servicecontrol_v1 { * google.api.servicecontrol.v1.Operation.labels for the overriding * relationship. */ - labels?: any; + labels?: {[key: string]: string;}; /** * A money value. */ @@ -889,7 +889,7 @@ export namespace servicecontrol_v1 { * the API is served, such as App Engine, Compute Engine, or Kubernetes * Engine. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Represents information to be logged. */ @@ -947,7 +947,7 @@ export namespace servicecontrol_v1 { * with. Only a combination of 1000 user labels per consumer project are * allowed. */ - userLabels?: any; + userLabels?: {[key: string]: string;}; } /** * This message defines attributes for a node that handles a network request. @@ -963,7 +963,7 @@ export namespace servicecontrol_v1 { /** * The labels associated with the peer. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The network port of the peer. */ @@ -1026,7 +1026,7 @@ export namespace servicecontrol_v1 { * Castor (that scales quota usage) and 'quota_metrics' for * SuperQuota (that doesn't scale quota usage). */ - quotaConsumed?: any; + quotaConsumed?: {[key: string]: number;}; /** * Quota metrics to indicate the usage. Depending on the check request, one * or more of the following metrics will be included: 1. For rate quota, @@ -1056,7 +1056,7 @@ export namespace servicecontrol_v1 { /** * Labels describing the operation. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Fully qualified name of the API method for which this quota operation is * requested. This name is used for matching quota rules or metric rules and @@ -1200,7 +1200,7 @@ export namespace servicecontrol_v1 { * must be merged according to the HTTP spec. All header keys must be * lowercased, because HTTP header keys are case-insensitive. */ - headers?: any; + headers?: {[key: string]: string;}; /** * The HTTP request `Host` header value. */ @@ -1313,7 +1313,7 @@ export namespace servicecontrol_v1 { * The labels or tags on the resource, such as AWS resource tags and * Kubernetes resource labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The stable identifier (name) of a resource on the `service`. A resource * can be logically identified as @@ -1424,7 +1424,7 @@ export namespace servicecontrol_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 3b8b3843815..f1268887203 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -1022,14 +1022,14 @@ export namespace servicemanagement_v1 { * google.api.servicemanagement.v1.ConfigRef, * google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ - newConfig?: any; + newConfig?: {[key: string]: any;}; /** * Service configuration against which the comparison will be done. For this * version of API, the supported types are * google.api.servicemanagement.v1.ConfigRef, * google.api.servicemanagement.v1.ConfigSource, and google.api.Service */ - oldConfig?: any; + oldConfig?: {[key: string]: any;}; } /** * Response message for GenerateConfigReport method. @@ -1601,7 +1601,7 @@ export namespace servicemanagement_v1 { * name, and the values are the amount increased for the metric against * which the quota limits are defined. The value must not be negative. */ - metricCosts?: any; + metricCosts?: {[key: string]: string;}; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -1802,7 +1802,7 @@ export namespace servicemanagement_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1818,7 +1818,7 @@ export namespace servicemanagement_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The metadata associated with a long running operation resource. @@ -1861,7 +1861,7 @@ export namespace servicemanagement_v1 { * it should be stored as an int32 value using the * google.protobuf.Int32Value type. */ - value?: any; + value?: {[key: string]: any;}; } /** * Represents a documentation page. A page can contain subpages to represent @@ -2058,7 +2058,7 @@ export namespace servicemanagement_v1 { * integer value that is the maximum number of requests allowed for the * specified unit. Currently only STANDARD is supported. */ - values?: any; + values?: {[key: string]: string;}; } /** * A rollout resource that defines how service configuration versions are @@ -2295,7 +2295,7 @@ export namespace servicemanagement_v1 { /** * All files used during config generation. */ - sourceFiles?: any[]; + sourceFiles?: Array<{[key: string]: any;}>; } /** * The `Status` type defines a logical error model that is suitable for @@ -2342,7 +2342,7 @@ export namespace servicemanagement_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -2494,7 +2494,7 @@ export namespace servicemanagement_v1 { * Key is the service configuration ID, Value is the traffic percentage * which must be greater than 0.0 and the sum must equal to 100.0. */ - percentages?: any; + percentages?: {[key: string]: number;}; } /** * A protocol buffer message type. diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index dbbe35c2f29..eabad16b2d1 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -464,6 +464,11 @@ export namespace servicenetworking_v1beta { * service producer subnetworks. */ reservedPeeringRanges?: string[]; + /** + * Output only. Name of the peering service associated with this connection. + * "services/{service name} + */ + service?: string; } /** * `Context` defines which contexts an API requests. Example: context: @@ -1303,7 +1308,7 @@ export namespace servicenetworking_v1beta { * name, and the values are the amount increased for the metric against * which the quota limits are defined. The value must not be negative. */ - metricCosts?: any; + metricCosts?: {[key: string]: string;}; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -1504,7 +1509,7 @@ export namespace servicenetworking_v1beta { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1520,7 +1525,7 @@ export namespace servicenetworking_v1beta { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A protocol buffer option, which can be attached to a message, field, @@ -1541,7 +1546,7 @@ export namespace servicenetworking_v1beta { * it should be stored as an int32 value using the * google.protobuf.Int32Value type. */ - value?: any; + value?: {[key: string]: any;}; } /** * Represents a documentation page. A page can contain subpages to represent @@ -1691,7 +1696,7 @@ export namespace servicenetworking_v1beta { * integer value that is the maximum number of requests allowed for the * specified unit. Currently only STANDARD is supported. */ - values?: any; + values?: {[key: string]: string;}; } /** * `Service` is the root object of Google service configuration schema. It @@ -1864,7 +1869,7 @@ export namespace servicenetworking_v1beta { /** * All files used during config generation. */ - sourceFiles?: any[]; + sourceFiles?: Array<{[key: string]: any;}>; } /** * The `Status` type defines a logical error model that is suitable for @@ -1911,7 +1916,7 @@ export namespace servicenetworking_v1beta { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -2268,6 +2273,75 @@ export namespace servicenetworking_v1beta { return createAPIRequest(parameters); } } + + + /** + * servicenetworking.services.patch + * @desc Allocated ranges specified for the connection may be updated. + * Operation. + * @alias servicenetworking.services.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.force If a previously defined allocated range is removed, force flag must be set to true. + * @param {string} params.name Provider peering service that is managing peering connectivity for a service provider organization. For Google services that support this functionality it is 'services/servicenetworking.googleapis.com'. + * @param {string=} params.updateMask The update mask. If this is omitted, it defaults to "*". Only reserved peering ranges list may be updated. + * @param {().Connection} 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$Services$Patch, options?: MethodOptions): + AxiosPromise; + patch( + params: Params$Resource$Services$Patch, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + patch( + params: Params$Resource$Services$Patch, + callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: Params$Resource$Services$Patch| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Services$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Services$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://servicenetworking.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Services$Addsubnetwork extends @@ -2293,6 +2367,34 @@ export namespace servicenetworking_v1beta { */ requestBody?: Schema$AddSubnetworkRequest; } + export interface Params$Resource$Services$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If a previously defined allocated range is removed, force flag must be + * set to true. + */ + force?: boolean; + /** + * Provider peering service that is managing peering connectivity for a + * service provider organization. For Google services that support this + * functionality it is 'services/servicenetworking.googleapis.com'. + */ + name?: string; + /** + * The update mask. If this is omitted, it defaults to "*". Only reserved + * peering ranges list may be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Connection; + } export class Resource$Services$Connections { root: Servicenetworking; @@ -2391,7 +2493,7 @@ export namespace servicenetworking_v1beta { * * @param {object} params Parameters for request * @param {string=} params.network Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/{project}/global/networks/{network}'. {project} is a project number, as in '12345' {network} is network name. - * @param {string} params.parent Provider peering service that is managing peering connectivity for a service provider organization. For Google services that support this functionality it is 'services/servicenetworking.googleapis.com'. + * @param {string} params.parent Provider peering service that is managing peering connectivity for a service provider organization. For Google services that support this functionality it is 'services/servicenetworking.googleapis.com'. For "-" all configured public peering services will be queried. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2489,7 +2591,8 @@ export namespace servicenetworking_v1beta { /** * Provider peering service that is managing peering connectivity for a * service provider organization. For Google services that support this - * functionality it is 'services/servicenetworking.googleapis.com'. + * functionality it is 'services/servicenetworking.googleapis.com'. For "-" + * all configured public peering services will be queried. */ parent?: string; } diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index 2859369f618..01f4f38bc75 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -1565,7 +1565,7 @@ export namespace serviceusage_v1 { * name, and the values are the amount increased for the metric against * which the quota limits are defined. The value must not be negative. */ - metricCosts?: any; + metricCosts?: {[key: string]: string;}; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -1766,7 +1766,7 @@ export namespace serviceusage_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1782,7 +1782,7 @@ export namespace serviceusage_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The operation metadata returned for the batchend services operation. @@ -1813,7 +1813,7 @@ export namespace serviceusage_v1 { * it should be stored as an int32 value using the * google.protobuf.Int32Value type. */ - value?: any; + value?: {[key: string]: any;}; } /** * Represents a documentation page. A page can contain subpages to represent @@ -1963,7 +1963,7 @@ export namespace serviceusage_v1 { * integer value that is the maximum number of requests allowed for the * specified unit. Currently only STANDARD is supported. */ - values?: any; + values?: {[key: string]: string;}; } /** * `SourceContext` represents information about the source of a protobuf @@ -1984,7 +1984,7 @@ export namespace serviceusage_v1 { /** * All files used during config generation. */ - sourceFiles?: any[]; + sourceFiles?: Array<{[key: string]: any;}>; } /** * The `Status` type defines a logical error model that is suitable for @@ -2031,7 +2031,7 @@ export namespace serviceusage_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 08ed60e4a73..caf1bd40738 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -1552,7 +1552,7 @@ export namespace serviceusage_v1beta1 { * name, and the values are the amount increased for the metric against * which the quota limits are defined. The value must not be negative. */ - metricCosts?: any; + metricCosts?: {[key: string]: string;}; /** * Selects the methods to which this rule applies. Refer to selector for * syntax details. @@ -1753,7 +1753,7 @@ export namespace serviceusage_v1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1769,7 +1769,7 @@ export namespace serviceusage_v1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The operation metadata returned for the batchend services operation. @@ -1800,7 +1800,7 @@ export namespace serviceusage_v1beta1 { * it should be stored as an int32 value using the * google.protobuf.Int32Value type. */ - value?: any; + value?: {[key: string]: any;}; } /** * Represents a documentation page. A page can contain subpages to represent @@ -1950,7 +1950,7 @@ export namespace serviceusage_v1beta1 { * integer value that is the maximum number of requests allowed for the * specified unit. Currently only STANDARD is supported. */ - values?: any; + values?: {[key: string]: string;}; } /** * A service that is available for use by the consumer. @@ -2037,7 +2037,7 @@ export namespace serviceusage_v1beta1 { /** * All files used during config generation. */ - sourceFiles?: any[]; + sourceFiles?: Array<{[key: string]: any;}>; } /** * The `Status` type defines a logical error model that is suitable for @@ -2084,7 +2084,7 @@ export namespace serviceusage_v1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 0d3713b1db4..a3b0da98e9b 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -576,7 +576,7 @@ export namespace sheets_v4 { * The criteria for showing/hiding values per column. The map's key is * the column index, and the value is the criteria for that column. */ - criteria?: any; + criteria?: {[key: string]: Schema$FilterCriteria;}; /** * The range the filter covers. */ @@ -2113,7 +2113,7 @@ export namespace sheets_v4 { * The criteria for showing/hiding values per column. The map's key is * the column index, and the value is the criteria for that column. */ - criteria?: any; + criteria?: {[key: string]: Schema$FilterCriteria;}; /** * The ID of the filter view. */ @@ -2970,7 +2970,7 @@ export namespace sheets_v4 { * `C10:E15`, a key of `0` will have the filter for column `C`, whereas the * key `1` is for column `D`. */ - criteria?: any; + criteria?: {[key: string]: Schema$PivotFilterCriteria;}; /** * Each row grouping in the pivot table. */ @@ -5033,7 +5033,7 @@ export namespace sheets_v4 { /** * The ranges to retrieve from the spreadsheet. */ - ranges?: string; + ranges?: string[]; /** * The spreadsheet to request. */ @@ -7043,7 +7043,7 @@ export namespace sheets_v4 { /** * The A1 notation of the values to retrieve. */ - ranges?: string; + ranges?: string[]; /** * The ID of the spreadsheet to retrieve data from. */ diff --git a/src/apis/siteVerification/v1.ts b/src/apis/siteVerification/v1.ts index b3e1af39487..49ce3373729 100644 --- a/src/apis/siteVerification/v1.ts +++ b/src/apis/siteVerification/v1.ts @@ -102,7 +102,7 @@ export namespace siteVerification_v1 { /** * The site for which a verification token will be generated. */ - site?: any; + site?: {identifier?: string; type?: string;}; /** * The verification method that will be used to verify this site. For sites, * 'FILE' or 'META' methods may be used. For domains, only @@ -145,7 +145,7 @@ export namespace siteVerification_v1 { /** * The address and type of a site that is verified or will be verified. */ - site?: any; + site?: {identifier?: string; type?: string;}; } diff --git a/src/apis/slides/README.md b/src/apis/slides/README.md index 70a20df6c94..97043b93fba 100644 --- a/src/apis/slides/README.md +++ b/src/apis/slides/README.md @@ -2,7 +2,7 @@ # @google/slides -> An API for creating and editing Google Slides presentations. +> Reads and writes Google Slides presentations. ## Installation diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index 6e15d6e3912..9f53a2d06e1 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -299,12 +299,26 @@ export namespace slides_v1 { * Creates a line. */ export interface Schema$CreateLineRequest { + /** + * The category of the line to be created. The exact line type created is + * determined based on the category and how it's routed to connect to + * other page elements. If you specify both a `category` and a + * `line_category`, the `category` takes precedence. If you do not specify + * a value for `category`, but specify a value for `line_category`, then the + * specified `line_category` value is used. If you do not specify either, + * then STRAIGHT is used. + */ + category?: string; /** * The element properties for the line. */ elementProperties?: Schema$PageElementProperties; /** - * The category of line to be created. + * The category of the line to be created. <b>Deprecated</b>: + * use `category` instead. The exact line type created is determined based + * on the category and how it's routed to connect to other page + * elements. If you specify both a `category` and a `line_category`, the + * `category` takes precedence. */ lineCategory?: string; /** @@ -751,7 +765,7 @@ export namespace slides_v1 { * a new random ID will be assigned. If the map is empty or unset, all * duplicate objects will receive a new random ID. */ - objectIds?: any; + objectIds?: {[key: string]: string;}; } /** * The response of duplicating an object. @@ -1021,6 +1035,11 @@ export namespace slides_v1 { * curved connector, or bent connector. */ export interface Schema$Line { + /** + * The category of the line. It matches the `category` specified in + * CreateLineRequest, and can be updated with UpdateLineCategoryRequest. + */ + lineCategory?: string; /** * The properties of the line. */ @@ -1030,6 +1049,30 @@ export namespace slides_v1 { */ lineType?: string; } + /** + * The properties for one end of a Line connection. + */ + export interface Schema$LineConnection { + /** + * The object ID of the connected page element. Some page elements, such as + * groups, tables, and lines do not have connection sites and therefore + * cannot be connected to a connector line. + */ + connectedObjectId?: string; + /** + * The index of the connection site on the connected page element. In most + * cases, it corresponds to the predefined connection site index from the + * ECMA-376 standard. More information on those connection sites can be + * found in the description of the "cnx" attribute in + * section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text + * Geometries" of "Office Open XML File Formats-Fundamentals and + * Markup Language Reference", part 1 of [ECMA-376 5th edition] + * (http://www.ecma-international.org/publications/standards/Ecma-376.htm). + * The position of each connection site can also be viewed from Slides + * editor. + */ + connectionSiteIndex?: number; + } /** * The fill of the line. */ @@ -1052,6 +1095,12 @@ export namespace slides_v1 { * The style of the arrow at the end of the line. */ endArrow?: string; + /** + * The connection at the end of the line. If unset, there is no connection. + * Only lines with a Type indicating it is a "connector" can have + * an `end_connection`. + */ + endConnection?: Schema$LineConnection; /** * The fill of the line. The default line fill matches the defaults for new * lines created in the Slides editor. @@ -1065,6 +1114,12 @@ export namespace slides_v1 { * The style of the arrow at the beginning of the line. */ startArrow?: string; + /** + * The connection at the beginning of the line. If unset, there is no + * connection. Only lines with a Type indicating it is a + * "connector" can have a `start_connection`. + */ + startConnection?: Schema$LineConnection; /** * The thickness of the line. */ @@ -1109,7 +1164,7 @@ export namespace slides_v1 { * level. A list has at most nine levels of nesting, so the possible values * for the keys of this map are 0 through 8, inclusive. */ - nestingLevel?: any; + nestingLevel?: {[key: string]: Schema$NestingLevel;}; } /** * The properties of Page that are only relevant for pages with page_type @@ -1650,9 +1705,10 @@ export namespace slides_v1 { */ pageObjectIds?: string[]; /** - * The replace method. Deprecated: use `image_replace_method` instead. If - * you specify both a `replace_method` and an `image_replace_method`, the - * `image_replace_method` takes precedence. + * The replace method. <b>Deprecated</b>: use + * `image_replace_method` instead. If you specify both a `replace_method` + * and an `image_replace_method`, the `image_replace_method` takes + * precedence. */ replaceMethod?: string; } @@ -1861,6 +1917,11 @@ export namespace slides_v1 { * Replaces an existing image with a new image. */ replaceImage?: Schema$ReplaceImageRequest; + /** + * Reroutes a line such that it's connected at the two closest + * connection sites on the connected page elements. + */ + rerouteLine?: Schema$RerouteLineRequest; /** * Ungroups objects, such as groups. */ @@ -1873,6 +1934,10 @@ export namespace slides_v1 { * Updates the properties of an Image. */ updateImageProperties?: Schema$UpdateImagePropertiesRequest; + /** + * Updates the category of a line. + */ + updateLineCategory?: Schema$UpdateLineCategoryRequest; /** * Updates the properties of a Line. */ @@ -1881,6 +1946,10 @@ export namespace slides_v1 { * Updates the alt text title and/or description of a page element. */ updatePageElementAltText?: Schema$UpdatePageElementAltTextRequest; + /** + * Updates the Z-order of page elements. + */ + updatePageElementsZOrder?: Schema$UpdatePageElementsZOrderRequest; /** * Updates the transform of a page element. */ @@ -1926,6 +1995,18 @@ export namespace slides_v1 { */ updateVideoProperties?: Schema$UpdateVideoPropertiesRequest; } + /** + * Reroutes a line such that it's connected at the two closest connection + * sites on the connected page elements. + */ + export interface Schema$RerouteLineRequest { + /** + * The object ID of the line to reroute. Only a line with a category + * indicating it is a "connector" can be rerouted. The start and + * end connections of the line must be on different page elements. + */ + objectId?: string; + } /** * A single response from an update. */ @@ -2487,7 +2568,7 @@ export namespace slides_v1 { /** * The bulleted lists contained in this text, keyed by list ID. */ - lists?: any; + lists?: {[key: string]: Schema$List;}; /** * The text contents broken down into its component parts, including styling * information. This property is read-only. @@ -2745,6 +2826,23 @@ export namespace slides_v1 { */ objectId?: string; } + /** + * Updates the category of a line. + */ + export interface Schema$UpdateLineCategoryRequest { + /** + * The line category to update to. The exact line type is determined based + * on the category to update to and how it's routed to connect to other + * page elements. + */ + lineCategory?: string; + /** + * The object ID of the line the update is applied to. Only a line with a + * category indicating it is a "connector" can be updated. The + * line may be rerouted after updating its category. + */ + objectId?: string; + } /** * Updates the properties of a Line. */ @@ -2791,6 +2889,24 @@ export namespace slides_v1 { */ title?: string; } + /** + * Updates the Z-order of page elements. Z-order is an ordering of the + * elements on the page from back to front. The page element in the front may + * cover the elements that are behind it. + */ + export interface Schema$UpdatePageElementsZOrderRequest { + /** + * The Z-order operation to apply on the page elements. When applying the + * operation on multiple page elements, the relative Z-orders within these + * page elements before the operation is maintained. + */ + operation?: string; + /** + * The object IDs of the page elements to update. All the page elements + * must be on the same page and must not be grouped. + */ + pageElementObjectIds?: string[]; + } /** * Updates the transform of a page element. Updating the transform of a group * will change the absolute transform of the page elements in that group, @@ -3299,9 +3415,10 @@ export namespace slides_v1 { /** * slides.presentations.create - * @desc Creates a new presentation using the title given in the request. If - * a presentationId is provided, uses it as the ID of the new presentation. - * Otherwise, a new presentationId is generated. Returns the created + * @desc Creates a blank presentation using the title given in the request. + * If a `presentationId` is provided, it is used as the ID of the new + * presentation. Otherwise, a new ID is generated. Other fields in the + * request, including any provided content, are ignored. Returns the created * presentation. * @alias slides.presentations.create * @memberOf! () diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index efa58f55cfb..da8b73f22f3 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -83,7 +83,7 @@ export namespace sourcerepo_v1 { /** * Cloud Source Repositories API * - * Access source code repositories hosted by Google. + * Accesses source code repositories hosted by Google. * * @example * const {google} = require('googleapis'); @@ -342,7 +342,7 @@ export namespace sourcerepo_v1 { * How this project publishes a change in the repositories through Cloud * Pub/Sub. Keyed by the topic names. */ - pubsubConfigs?: any; + pubsubConfigs?: {[key: string]: Schema$PubsubConfig;}; } /** * Configuration to publish a Cloud Pub/Sub message. @@ -387,7 +387,7 @@ export namespace sourcerepo_v1 { * How this repository publishes a change in the repository through Cloud * Pub/Sub. Keyed by the topic names. */ - pubsubConfigs?: any; + pubsubConfigs?: {[key: string]: Schema$PubsubConfig;}; /** * The disk usage of the repo, in bytes. Read-only field. Size is only * returned by GetRepo. diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index b28b95eabe1..ea717dc1fbc 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -350,7 +350,7 @@ export namespace spanner_v1 { * whose keys are parameter names, and whose values are the corresponding * parameter values. */ - params?: any; + params?: {[key: string]: any;}; /** * It is not always possible for Cloud Spanner to infer the right SQL type * from a JSON value. For example, values of type `BYTES` and values of @@ -359,7 +359,7 @@ export namespace spanner_v1 { * of the SQL statement parameters. See the definition of Type for more * information about SQL types. */ - paramTypes?: any; + paramTypes?: {[key: string]: Schema$Type;}; /** * If present, results will be restricted to the specified partition * previously created using PartitionQuery(). There must be an exact match @@ -506,7 +506,7 @@ export namespace spanner_v1 { * as the string: name + "_" + value would prove problematic if * we were to allow "_" in a future release. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Required. A unique identifier for the instance, which cannot be changed * after the instance is created. Values are of the form @@ -759,7 +759,7 @@ export namespace spanner_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -775,7 +775,7 @@ export namespace spanner_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Partial results from a streaming read or SQL query. Streaming reads and SQL @@ -913,7 +913,7 @@ export namespace spanner_v1 { * are parameter names, and whose values are the corresponding parameter * values. */ - params?: any; + params?: {[key: string]: any;}; /** * It is not always possible for Cloud Spanner to infer the right SQL type * from a JSON value. For example, values of type `BYTES` and values of @@ -922,7 +922,7 @@ export namespace spanner_v1 { * of the SQL query parameters. See the definition of Type for more * information about SQL types. */ - paramTypes?: any; + paramTypes?: {[key: string]: Schema$Type;}; /** * Additional options that affect how many partitions are created. */ @@ -1011,7 +1011,7 @@ export namespace spanner_v1 { * a profile query. For example, number of executions, number of rows/time * per execution etc. */ - executionStats?: any; + executionStats?: {[key: string]: any;}; /** * The `PlanNode`'s index in node list. */ @@ -1029,7 +1029,7 @@ export namespace spanner_v1 { * information in its metadata: { "parameter_reference": * "param1", "parameter_type": "array" } */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Condensed representation for SCALAR nodes. */ @@ -1269,7 +1269,7 @@ export namespace spanner_v1 { * "elapsed_time": "1.22 secs", "cpu_time": * "1.19 secs" } */ - queryStats?: any; + queryStats?: {[key: string]: any;}; /** * Standard DML returns an exact count of rows that were modified. */ @@ -1311,7 +1311,7 @@ export namespace spanner_v1 { * associated with a given session. See https://goo.gl/xmQnxf for more * information on and examples of labels. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The name of the session. This is always system-assigned; values provided * when creating a session are ignored. @@ -1346,7 +1346,7 @@ export namespace spanner_v1 { * referenced `SCALAR` subquery may not necessarily be a direct child of * this node. */ - subqueries?: any; + subqueries?: {[key: string]: number;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -1393,7 +1393,7 @@ export namespace spanner_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/speech/index.ts b/src/apis/speech/index.ts index 9299011c85a..a098ac47bf1 100644 --- a/src/apis/speech/index.ts +++ b/src/apis/speech/index.ts @@ -15,19 +15,21 @@ import {getAPI, GoogleConfigurable} from 'googleapis-common'; import {speech_v1} from './v1'; -import {speech_v1beta1} from './v1beta1'; +import {speech_v1p1beta1} from './v1p1beta1'; export const VERSIONS = { 'v1': speech_v1.Speech, - 'v1beta1': speech_v1beta1.Speech, + 'v1p1beta1': speech_v1p1beta1.Speech, }; export function speech(version: 'v1'): speech_v1.Speech; export function speech(options: speech_v1.Options): speech_v1.Speech; -export function speech(version: 'v1beta1'): speech_v1beta1.Speech; -export function speech(options: speech_v1beta1.Options): speech_v1beta1.Speech; -export function speech( +export function speech(version: 'v1p1beta1'): speech_v1p1beta1.Speech; +export function speech(options: speech_v1p1beta1.Options): + speech_v1p1beta1.Speech; +export function speech( this: GoogleConfigurable, - versionOrOptions: 'v1'|speech_v1.Options|'v1beta1'|speech_v1beta1.Options) { + versionOrOptions: 'v1'|speech_v1.Options|'v1p1beta1'| + speech_v1p1beta1.Options) { return getAPI('speech', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index 07f396cb659..0883b6d3471 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -166,7 +166,7 @@ export namespace speech_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -182,7 +182,7 @@ export namespace speech_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Contains audio data in the encoding specified in the `RecognitionConfig`. @@ -439,7 +439,7 @@ export namespace speech_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/speech/v1beta1.ts b/src/apis/speech/v1beta1.ts deleted file mode 100644 index 851cd19df6b..00000000000 --- a/src/apis/speech/v1beta1.ts +++ /dev/null @@ -1,750 +0,0 @@ -/** - * Copyright 2015 Google Inc. All Rights Reserved. - * - * 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 {AxiosPromise} from 'axios'; -import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; -import {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 speech_v1beta1 { - export interface Options extends GlobalOptions { - version: 'v1beta1'; - } - - 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 Speech API - * - * Converts audio to text by applying powerful neural network models. - * - * @example - * const {google} = require('googleapis'); - * const speech = google.speech('v1beta1'); - * - * @namespace speech - * @type {Function} - * @version v1beta1 - * @variation v1beta1 - * @param {object=} options Options for Speech - */ - export class Speech { - _options: GlobalOptions; - google?: GoogleConfigurable; - root = this; - - operations: Resource$Operations; - speech: Resource$Speech; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this._options = options || {}; - this.google = google; - this.getRoot.bind(this); - - this.operations = new Resource$Operations(this); - this.speech = new Resource$Speech(this); - } - - getRoot() { - return this.root; - } - } - - /** - * The top-level message sent by the client for the `AsyncRecognize` method. - */ - export interface Schema$AsyncRecognizeRequest { - /** - * *Required* The audio data to be recognized. - */ - audio?: Schema$RecognitionAudio; - /** - * *Required* Provides information to the recognizer that specifies how to - * process the request. - */ - config?: Schema$RecognitionConfig; - } - /** - * 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[]; - } - /** - * 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?: 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?: any; - } - /** - * Contains audio data in the encoding specified in the `RecognitionConfig`. - * Either `content` or `uri` must be supplied. Supplying both or neither - * returns google.rpc.Code.INVALID_ARGUMENT. See [audio - * limits](https://cloud.google.com/speech/limits#content). - */ - export interface Schema$RecognitionAudio { - /** - * The audio data bytes encoded as specified in `RecognitionConfig`. Note: - * as with all bytes fields, protobuffers use a pure binary representation, - * whereas JSON representations use base64. - */ - content?: string; - /** - * URI that points to a file that contains audio data bytes as specified in - * `RecognitionConfig`. Currently, only Google Cloud Storage URIs are - * supported, which must be specified in the following format: - * `gs://bucket_name/object_name` (other URI formats return - * google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request - * URIs](https://cloud.google.com/storage/docs/reference-uris). - */ - uri?: string; - } - /** - * Provides information to the recognizer that specifies how to process the - * request. - */ - export interface Schema$RecognitionConfig { - /** - * *Required* Encoding of audio data sent in all `RecognitionAudio` - * messages. - */ - encoding?: string; - /** - * *Optional* The language of the supplied audio as a BCP-47 language tag. - * Example: "en-GB" https://www.rfc-editor.org/rfc/bcp/bcp47.txt - * If omitted, defaults to "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 `SpeechRecognitionResult`. 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* 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. - */ - profanityFilter?: boolean; - /** - * *Required* Sample rate in Hertz of the audio data sent in all - * `RecognitionAudio` 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). - */ - sampleRate?: number; - /** - * *Optional* A means to provide context to assist the speech recognition. - */ - speechContext?: Schema$SpeechContext; - } - /** - * Provides "hints" to the speech recognizer to favor specific words - * and phrases in the results. - */ - export interface Schema$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$SpeechRecognitionAlternative { - /** - * *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 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 even - * set, in any of the results. The default of 0.0 is a sentinel value - * indicating `confidence` was not set. - */ - confidence?: number; - /** - * *Output-only* Transcript text representing the words that the user spoke. - */ - transcript?: string; - } - /** - * A speech recognition result corresponding to a portion of the audio. - */ - export interface Schema$SpeechRecognitionResult { - /** - * *Output-only* May contain one or more recognition hypotheses (up to the - * maximum specified in `max_alternatives`). - */ - alternatives?: Schema$SpeechRecognitionAlternative[]; - } - /** - * 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?: 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; - } - /** - * The top-level message sent by the client for the `SyncRecognize` method. - */ - export interface Schema$SyncRecognizeRequest { - /** - * *Required* The audio data to be recognized. - */ - audio?: Schema$RecognitionAudio; - /** - * *Required* Provides information to the recognizer that specifies how to - * process the request. - */ - config?: Schema$RecognitionConfig; - } - /** - * The only message returned to the client by `SyncRecognize`. method. It - * contains the result as zero or more sequential `SpeechRecognitionResult` - * messages. - */ - export interface Schema$SyncRecognizeResponse { - /** - * *Output-only* Sequential list of transcription results corresponding to - * sequential portions of audio. - */ - results?: Schema$SpeechRecognitionResult[]; - } - - - export class Resource$Operations { - root: Speech; - constructor(root: Speech) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * speech.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 speech.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$Operations$Get, - options?: MethodOptions): AxiosPromise; - get(params: Params$Resource$Operations$Get, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - get(params: Params$Resource$Operations$Get, - callback: BodyResponseCallback): void; - get(callback: BodyResponseCallback): void; - get(paramsOrCallback?: Params$Resource$Operations$Get| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/operations/{+name}') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * speech.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 speech.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$Operations$List, options?: MethodOptions): - AxiosPromise; - list( - params: Params$Resource$Operations$List, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - list( - params: Params$Resource$Operations$List, - callback: BodyResponseCallback): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: Params$Resource$Operations$List| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/operations') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'GET' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$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$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; - } - - - export class Resource$Speech { - root: Speech; - constructor(root: Speech) { - this.root = root; - this.getRoot.bind(this); - } - - getRoot() { - return this.root; - } - - - /** - * speech.speech.asyncrecognize - * @desc Performs asynchronous speech recognition: receive results via the - * [google.longrunning.Operations] - * (/speech/reference/rest/v1beta1/operations#Operation) interface. Returns - * either an `Operation.error` or an `Operation.response` which contains an - * `AsyncRecognizeResponse` message. - * @alias speech.speech.asyncrecognize - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().AsyncRecognizeRequest} 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 - */ - asyncrecognize( - params?: Params$Resource$Speech$Asyncrecognize, - options?: MethodOptions): AxiosPromise; - asyncrecognize( - params: Params$Resource$Speech$Asyncrecognize, - options: MethodOptions|BodyResponseCallback, - callback: BodyResponseCallback): void; - asyncrecognize( - params: Params$Resource$Speech$Asyncrecognize, - callback: BodyResponseCallback): void; - asyncrecognize(callback: BodyResponseCallback): void; - asyncrecognize( - paramsOrCallback?: Params$Resource$Speech$Asyncrecognize| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Speech$Asyncrecognize; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Speech$Asyncrecognize; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/speech:asyncrecognize') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - - /** - * speech.speech.syncrecognize - * @desc Performs synchronous speech recognition: receive results after all - * audio has been sent and processed. - * @alias speech.speech.syncrecognize - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {().SyncRecognizeRequest} 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 - */ - syncrecognize( - params?: Params$Resource$Speech$Syncrecognize, - options?: MethodOptions): AxiosPromise; - syncrecognize( - params: Params$Resource$Speech$Syncrecognize, - options: MethodOptions| - BodyResponseCallback, - callback: BodyResponseCallback): void; - syncrecognize( - params: Params$Resource$Speech$Syncrecognize, - callback: BodyResponseCallback): void; - syncrecognize(callback: BodyResponseCallback): - void; - syncrecognize( - paramsOrCallback?: Params$Resource$Speech$Syncrecognize| - BodyResponseCallback, - optionsOrCallback?: MethodOptions| - BodyResponseCallback, - callback?: BodyResponseCallback): - void|AxiosPromise { - let params = - (paramsOrCallback || {}) as Params$Resource$Speech$Syncrecognize; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Speech$Syncrecognize; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/speech:syncrecognize') - .replace(/([^:]\/)\/+/g, '$1'), - method: 'POST' - }, - options), - params, - requiredParams: [], - pathParams: [], - context: this.getRoot() - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Speech$Asyncrecognize extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - - /** - * Request body metadata - */ - requestBody?: Schema$AsyncRecognizeRequest; - } - export interface Params$Resource$Speech$Syncrecognize extends - StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; - - - /** - * Request body metadata - */ - requestBody?: Schema$SyncRecognizeRequest; - } -} diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts new file mode 100644 index 00000000000..9e287f97d7d --- /dev/null +++ b/src/apis/speech/v1p1beta1.ts @@ -0,0 +1,2044 @@ +/** + * Copyright 2015 Google Inc. All Rights Reserved. + * + * 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 {AxiosPromise} from 'axios'; +import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library'; +import {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 speech_v1p1beta1 { + export interface Options extends GlobalOptions { + version: 'v1p1beta1'; + } + + 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 Speech API + * + * Converts audio to text by applying powerful neural network models. + * + * @example + * const {google} = require('googleapis'); + * const speech = google.speech('v1p1beta1'); + * + * @namespace speech + * @type {Function} + * @version v1p1beta1 + * @variation v1p1beta1 + * @param {object=} options Options for Speech + */ + export class Speech { + _options: GlobalOptions; + google?: GoogleConfigurable; + root = this; + + operations: Resource$Operations; + projects: Resource$Projects; + speech: Resource$Speech; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this._options = options || {}; + this.google = google; + this.getRoot.bind(this); + + this.operations = new Resource$Operations(this); + this.projects = new Resource$Projects(this); + this.speech = new Resource$Speech(this); + } + + getRoot() { + return this.root; + } + } + + /** + * Different types of dataset errors and the stats associated with each error. + */ + export interface Schema$DataErrors { + /** + * Number of records having errors associated with the enum. + */ + count?: number; + /** + * Type of the error. + */ + errorType?: string; + } + /** + * Specifies the parameters needed for creating a dataset. In addition this is + * also the message returned to the client by the `CreateDataset` method. It + * is included in the `result.response` field of the `Operation` returned by + * the `GetOperation` call of the `google::longrunning::Operations` service. + */ + export interface Schema$Dataset { + /** + * Output only. All the blocking operations associated with this dataset. + * Like (pre-processing, training-model, testing-model) + */ + blockingOperationIds?: string[]; + /** + * If set, the log data to be used in this dataset is restricted to the + * bucket specified. This field is only applicable if use_logged_data is + * true. If use_logged_data is true, but this field is not set, then all + * logs will be used for training the models. See: RecognitionMetadata for + * information on setting up data logs. + */ + bucketName?: string; + /** + * Output only. The timestamp this dataset is created. + */ + createTime?: string; + /** + * Location where the data should be processed. If not specified then we + * will pick a location on behalf of the user for storing and processing the + * data. Currently only us-central is supported. + */ + dataProcessingRegion?: string; + /** + * Output only. Stats assoiated with the data. + */ + dataStats?: Schema$DataStats; + /** + * Required. Name of the data set for display. + */ + displayName?: string; + /** + * Output only. True if the data is sufficient to create custom models. + */ + hasSufficientData?: 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](/speech-to-text/docs/languages) for a list of the currently + * supported language codes. + */ + languageCode?: string; + /** + * All the models (including models pending training) built using the + * dataset. + */ + models?: Schema$Model[]; + /** + * Output only. Resource name of the dataset. Form :- + * '/projects/{project_number}/locations/{location_id}/datasets/{dataset_id}' + */ + name?: string; + /** + * Output only. The timestamp this dataset is last updated. + */ + updateTime?: string; + /** + * URI that points to a file in csv file where each row has following + * format. + * <gs_path_to_audio>,<gs_path_to_transcript>,<label> + * label can be HUMAN_TRANSCRIBED or MACHINE_TRANSCRIBED. To be valid, rows + * must do the following: 1. Each row must have at least a label and + * <gs_path_to_transcript> 2. If a row is marked HUMAN_TRANSCRIBED, + * then you must specify both <gs_path_to_audio> and + * <gs_path_to_transcript>. Only WAV file formats which encode linear + * 16-bit pulse-code modulation (PCM) audio format are supported. The + * maximum audio file size is 50 MB. Also note that the audio has to be + * single channel audio. 3. There has to be at least 500 rows labelled + * HUMAN_TRANSCRIBED covering at least ~10K words in order to get reliable + * word error rate results. 4. To create a language model, you should + * provide at least 100,000 words in your transcriptions as training data if + * you have conversational and captions type of data. You should provide at + * least 10,000 words if you have short utterances like voice commands and + * search type of use cases. Currently, only Google Cloud Storage URIs are + * supported, which must be specified in the following format: + * `gs://bucket_name/object_name` (other URI formats will be ignored). For + * more information, see [Request URIs](/storage/docs/reference-uris). + */ + uri?: string; + /** + * If this is true, then use the previously logged data (for the project) + * The logs data for this project will be preprocessed and prepared for + * downstream pipelines (like training) + */ + useLoggedData?: boolean; + } + /** + * Contains stats about the data which was uploaded and preprocessed to be use + * by downstream pipelines like training, evals pipelines. + */ + export interface Schema$DataStats { + /** + * Different types of data errors and the counts associated with them. + */ + dataErrors?: Schema$DataErrors[]; + /** + * The number of examples used for testing. + */ + testExampleCount?: number; + /** + * The number of examples used for training. + */ + trainingExampleCount?: number; + } + /** + * Message sent by the client for the `DeployModel` method. + */ + export interface Schema$DeployModelRequest {} + /** + * Message sent by the client for the `EvaluateModel` method. + */ + export interface Schema$EvaluateModelRequest {} + /** + * The only message returned to the client by the `EvaluateModel` method. This + * is also returned as part of the Dataset message returned to the client by + * the CreateDataset method. It is included in the `result.response` field of + * the `Operation` returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$EvaluateModelResponse { + /** + * If true then it means we are referring to the results of an enhanced + * version of the model_type. Currently only PHONE_CALL model_type has an + * enhanced version. + */ + isEnhancedModel?: boolean; + /** + * Required. The type of model used in this evaluation. + */ + modelType?: string; + /** + * Number of words used in the word_error_rate computation. + */ + wordCount?: number; + /** + * Word error rate metric computed on the test set using the AutoML model. + */ + wordErrorRate?: number; + } + export interface Schema$ListDatasetsResponse { + /** + * Repeated list of data sets containing details about each data set. + */ + datasets?: Schema$Dataset[]; + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * Message received by the client for the `ListLogDataStats` method. + */ + export interface Schema$ListLogDataStatsResponse { + /** + * Output only. True if user has opted in for log data collection. + */ + logDataEnabled?: boolean; + /** + * The stats for each bucket. + */ + logDataStats?: Schema$LogBucketStats[]; + /** + * The overall count for log data (including all bucket data). + */ + totalCount?: number; + } + export interface Schema$ListModelsResponse { + /** + * Repeated list of models containing details about each model. + */ + models?: Schema$Model[]; + /** + * Token to retrieve the next page of results, or empty if there are no more + * results in the list. + */ + nextPageToken?: string; + } + /** + * Stats for log data within a bucket. + */ + export interface Schema$LogBucketStats { + /** + * The display name for the bucket in which logs are collected. + */ + bucketName?: string; + /** + * Number of audio samples that have been collected in this bucket. + */ + count?: number; + } + /** + * The top-level message sent by the client for the `LongRunningRecognize` + * method. + */ + export interface Schema$LongRunningRecognizeRequest { + /** + * *Required* The audio data to be recognized. + */ + audio?: Schema$RecognitionAudio; + /** + * *Required* Provides information to the recognizer that specifies how to + * process the request. + */ + config?: Schema$RecognitionConfig; + } + /** + * Specifies the model parameters needed for training a model. In addition + * this is also the message returned to the client by the `CreateModel` + * method. It is included in the `result.response` field of the `Operation` + * returned by the `GetOperation` call of the + * `google::longrunning::Operations` service. + */ + export interface Schema$Model { + /** + * Output only. Timestamp when this model was created. + */ + createTime?: string; + /** + * Required. Display name of the model to be trained. + */ + displayName?: string; + /** + * Output only. Evaluation results associated with this model. A model can + * contain multiple sub-models in which case the evaluation results for all + * of those are available. If there are no sub models then there would be + * just a single EvaluateModelResponse. + */ + evaluateModelResponses?: Schema$EvaluateModelResponse[]; + /** + * Output only. Resource name of the model. Format: + * "projects/{project_id}/locations/{location_id}/models/{model_id}" + */ + name?: string; + /** + * Required. Type of the training to perform. + */ + trainingType?: 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;}; + } + /** + * Contains audio data in the encoding specified in the `RecognitionConfig`. + * Either `content` or `uri` must be supplied. Supplying both or neither + * returns google.rpc.Code.INVALID_ARGUMENT. See [content + * limits](/speech-to-text/quotas#content). + */ + export interface Schema$RecognitionAudio { + /** + * The audio data bytes encoded as specified in `RecognitionConfig`. Note: + * as with all bytes fields, protobuffers use a pure binary representation, + * whereas JSON representations use base64. + */ + content?: string; + /** + * URI that points to a file that contains audio data bytes as specified in + * `RecognitionConfig`. The file must not be compressed (for example, gzip). + * Currently, only Google Cloud Storage URIs are supported, which must be + * specified in the following format: `gs://bucket_name/object_name` (other + * URI formats return google.rpc.Code.INVALID_ARGUMENT). For more + * information, see [Request + * URIs](https://cloud.google.com/storage/docs/reference-uris). + */ + uri?: string; + } + /** + * Provides information to the recognizer that specifies how to process the + * request. + */ + export interface Schema$RecognitionConfig { + /** + * *Optional* A list of up to 3 additional + * [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags, + * listing possible alternative languages of the supplied audio. See + * [Language Support](/speech-to-text/docs/languages) for a list of the + * currently supported language codes. If alternative languages are listed, + * recognition result will contain recognition in the most likely language + * detected including the main language_code. The recognition result will + * include the language tag of the language detected in the audio. Note: + * This feature is only supported for Voice Command and Voice Search use + * cases and performance may vary for other use cases (e.g., phone call + * transcription). + */ + alternativeLanguageCodes?: string[]; + /** + * *Optional* The number of channels in the input audio data. ONLY set this + * for MULTI-CHANNEL recognition. Valid values for LINEAR16 and FLAC are + * `1`-`8`. Valid values for OGG_OPUS are '1'-'254'. Valid + * value for MULAW, AMR, AMR_WB and SPEEX_WITH_HEADER_BYTE is only `1`. If + * `0` or omitted, defaults to one channel (mono). Note: We only recognize + * the first channel by default. To perform independent recognition on each + * channel set `enable_separate_recognition_per_channel` to 'true'. + */ + audioChannelCount?: 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; + /** + * This needs to be set to ‘true’ explicitly and `audio_channel_count` > + * 1 to get each channel recognized separately. The recognition result will + * contain a `channel_tag` field to state which channel that result belongs + * to. If this is not true, we will only recognize the first channel. The + * request is billed cumulatively for all channels recognized: + * `audio_channel_count` multiplied by the length of the audio. + */ + enableSeparateRecognitionPerChannel?: 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 STREAMING responses. This is done in order to improve + * our speaker tags as our models learn to identify the speakers in the + * conversation over time. For non-streaming requests, the diarization + * results will be provided only in the top alternative of the FINAL + * SpeechRecognitionResult. + */ + 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 `true`, the top result includes a list of words and the + * start and end time offsets (timestamps) for those words. If `false`, no + * word-level time offset information is returned. The default is `false`. + */ + enableWordTimeOffsets?: boolean; + /** + * Encoding of audio data sent in all `RecognitionAudio` messages. This + * field is optional for `FLAC` and `WAV` audio files and required for all + * other audio formats. For details, see AudioEncoding. + */ + encoding?: string; + /** + * *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](/speech-to-text/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 `SpeechRecognitionResult`. 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* Metadata regarding this request. + */ + metadata?: Schema$RecognitionMetadata; + /** + * *Optional* Which model to select for the given request. Select the model + * best suited to your domain to get best results. If a model is not + * explicitly specified, then we auto-select a model based on the parameters + * in the RecognitionConfig. <table> <tr> + * <td><b>Model</b></td> + * <td><b>Description</b></td> </tr> + * <tr> + * <td><code>command_and_search</code></td> + * <td>Best for short queries such as voice commands or voice + * search.</td> </tr> <tr> + * <td><code>phone_call</code></td> <td>Best + * for audio that originated from a phone call (typically recorded at an + * 8khz sampling rate).</td> </tr> <tr> + * <td><code>video</code></td> <td>Best + * for audio that originated from from video or includes multiple speakers. + * Ideally the audio is recorded at a 16khz or greater sampling + * rate. This is a premium model that costs more than the standard + * rate.</td> </tr> <tr> + * <td><code>default</code></td> <td>Best + * for audio that is not one of the specific audio models. For + * example, long-form audio. Ideally the audio is high-fidelity, recorded at + * a 16khz or greater sampling rate.</td> </tr> </table> + */ + model?: string; + /** + * *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. + */ + profanityFilter?: boolean; + /** + * Sample rate in Hertz of the audio data sent in all `RecognitionAudio` + * 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. + */ + sampleRateHertz?: number; + /** + * *Optional* array of SpeechContext. A means to provide context to assist + * the speech recognition. For more information, see [Phrase + * Hints](/speech-to-text/docs/basics#phrase-hints). + */ + speechContexts?: Schema$SpeechContext[]; + /** + * *Optional* Set to true to use an enhanced model for speech recognition. + * If `use_enhanced` is set to true and the `model` field is not set, then + * an appropriate enhanced model is chosen if: 1. project is eligible for + * requesting enhanced models 2. an enhanced model exists for the audio If + * `use_enhanced` is true and an enhanced version of the specified model + * does not exist, then the speech is recognized using the standard version + * of the specified model. Enhanced speech models require that you opt-in + * to data logging using instructions in the + * [documentation](/speech-to-text/docs/enable-data-logging). If you set + * `use_enhanced` to true and you have not enabled audio logging, then you + * will receive an error. + */ + useEnhanced?: boolean; + } + /** + * Description of audio data to be recognized. + */ + export interface Schema$RecognitionMetadata { + /** + * Description of the content. Eg. "Recordings of federal supreme court + * hearings from 2012". + */ + audioTopic?: string; + /** + * The industry vertical to which this speech recognition request most + * closely applies. This is most indicative of the topics contained in the + * audio. Use the 6-digit NAICS code to identify the industry vertical - + * see https://www.naics.com/search/. + */ + industryNaicsCodeOfAudio?: number; + /** + * The use case most closely describing the audio content to be recognized. + */ + interactionType?: string; + /** + * The audio type that most closely describes the audio being recognized. + */ + microphoneDistance?: string; + /** + * Obfuscated (privacy-protected) ID of the user, to identify number of + * unique users using the service. + */ + obfuscatedId?: string; + /** + * The original media the speech was recorded on. + */ + originalMediaType?: string; + /** + * Mime type of the original audio file. For example `audio/m4a`, + * `audio/x-alaw-basic`, `audio/mp3`, `audio/3gpp`. A list of possible audio + * mime types is maintained at + * http://www.iana.org/assignments/media-types/media-types.xhtml#audio + */ + originalMimeType?: string; + /** + * The device used to make the recording. Examples 'Nexus 5X' or + * 'Polycom SoundStation IP 6000' or 'POTS' or + * 'VoIP' or 'Cardioid Microphone'. + */ + recordingDeviceName?: string; + /** + * The type of device the speech was recorded with. + */ + recordingDeviceType?: string; + /** + * A freeform field to tag this input sample with. This can be used for + * grouping the logs into separate buckets. This enables selective purging + * of data based on the tags, and also for training models in AutoML. + */ + tags?: string[]; + } + /** + * The top-level message sent by the client for the `Recognize` method. + */ + export interface Schema$RecognizeRequest { + /** + * *Required* The audio data to be recognized. + */ + audio?: Schema$RecognitionAudio; + /** + * *Required* Provides information to the recognizer that specifies how to + * process the request. + */ + config?: Schema$RecognitionConfig; + } + /** + * The only message returned to the client by the `Recognize` method. It + * contains the result as zero or more sequential `SpeechRecognitionResult` + * messages. + */ + export interface Schema$RecognizeResponse { + /** + * Output only. Sequential list of transcription results corresponding to + * sequential portions of audio. + */ + results?: Schema$SpeechRecognitionResult[]; + } + /** + * Message sent by the client to refresh data in a existing dataset. + */ + export interface Schema$RefreshDataRequest { + /** + * URI that points to a file in csv file where each row has following + * format. + * <gs_path_to_audio>,<gs_path_to_transcript>,<label> + * label can be HUMAN_TRANSCRIBED or MACHINE_TRANSCRIBED. Few rules for a + * row to be considered valid are :- 1. Each row must have at least a label + * and <gs_path_to_transcript> 2. If a row is marked + * HUMAN_TRANSCRIBED, then both <gs_path_to_audio> and + * <gs_path_to_transcript> needs to be specified. 3. There has to be + * minimum 500 number of rows labelled HUMAN_TRANSCRIBED if evaluation stats + * are required. 4. If use_logged_data_for_training is set to true, then we + * ignore the rows labelled as MACHINE_TRANSCRIBED. 5. There has to be + * minimum 100,000 words in the transcripts in order to provide sufficient + * textual training data for the language model. Currently, only Google + * Cloud Storage URIs are supported, which must be specified in the + * following format: `gs://bucket_name/object_name` (other URI formats will + * be ignored). For more information, see [Request + * URIs](https://cloud.google.com/storage/docs/reference-uris). + */ + uri?: string; + } + /** + * Provides "hints" to the speech recognizer to favor specific words + * and phrases in the results. + */ + export interface Schema$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](/speech-to-text/quotas#content). + */ + phrases?: string[]; + /** + * Hint strength to use (high, medium or low). If you use a high strength + * then you are more likely to see those phrases in the results. If strength + * is not specified then by default medium strength will be used. If + * you'd like different phrases to have different strengths, you can + * specify multiple speech_contexts. + */ + strength?: string; + } + /** + * Alternative hypotheses (a.k.a. n-best list). + */ + export interface Schema$SpeechRecognitionAlternative { + /** + * 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 of a + * non-streaming result or, of a streaming result where `is_final=true`. + * 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; + /** + * Output only. Transcript text representing the words that the user spoke. + */ + transcript?: string; + /** + * Output only. A list of word-specific information for each recognized + * word. Note: When `enable_speaker_diarization` is true, you will see all + * the words from the beginning of the audio. + */ + words?: Schema$WordInfo[]; + } + /** + * A speech recognition result corresponding to a portion of the audio. + */ + export interface Schema$SpeechRecognitionResult { + /** + * Output only. 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$SpeechRecognitionAlternative[]; + /** + * For multi-channel audio, this is the channel number corresponding to the + * recognized result for the audio from that channel. For + * audio_channel_count = N, its output values can range from '1' to + * 'N'. + */ + channelTag?: number; + /** + * 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; + } + /** + * 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; + } + /** + * Word-specific information for recognized words. + */ + export interface Schema$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 of a + * non-streaming result or, of a streaming result where `is_final=true`. + * 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; + /** + * Output only. 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' to + * diarization_speaker_count. speaker_tag is set if + * enable_speaker_diarization = 'true' and only in the top + * alternative. + */ + speakerTag?: number; + /** + * Output only. 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; + /** + * Output only. The word corresponding to this set of information. + */ + word?: string; + } + + + export class Resource$Operations { + root: Speech; + constructor(root: Speech) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * speech.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 speech.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$Operations$Get, + options?: MethodOptions): AxiosPromise; + get(params: Params$Resource$Operations$Get, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + get(params: Params$Resource$Operations$Get, + callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; + get(paramsOrCallback?: Params$Resource$Operations$Get| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/operations/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$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$Projects { + root: Speech; + locations: Resource$Projects$Locations; + constructor(root: Speech) { + this.root = root; + this.getRoot.bind(this); + this.locations = new Resource$Projects$Locations(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Locations { + root: Speech; + datasets: Resource$Projects$Locations$Datasets; + log_data_stats: Resource$Projects$Locations$Log_data_stats; + models: Resource$Projects$Locations$Models; + constructor(root: Speech) { + this.root = root; + this.getRoot.bind(this); + this.datasets = new Resource$Projects$Locations$Datasets(root); + this.log_data_stats = + new Resource$Projects$Locations$Log_data_stats(root); + this.models = new Resource$Projects$Locations$Models(root); + } + + getRoot() { + return this.root; + } + } + + + export class Resource$Projects$Locations$Datasets { + root: Speech; + constructor(root: Speech) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * speech.projects.locations.datasets.create + * @desc Performs asynchronous data upload for AutoML: receive results via + * the google.longrunning.Operations interface. Returns either an + * `Operation.error` or an `Operation.response` which contains a `Dataset` + * message. + * @alias speech.projects.locations.datasets.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Resource name of the parent. Has the format :- "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): AxiosPromise; + 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|AxiosPromise { + 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://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/datasets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * speech.projects.locations.datasets.get + * @desc Get the dataset associated with the dataset resource. + * @alias speech.projects.locations.datasets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.includeModelInfo If true then also include information about the models built using this dataset. + * @param {string} params.name The resource name of the dataset to retrieve. Form :- '/projects/{project_number}/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): AxiosPromise; + 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|AxiosPromise { + 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://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * speech.projects.locations.datasets.list + * @desc Fetch the list of dataset associated with this project. + * @alias speech.projects.locations.datasets.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Filter the response based on display_name of the dataset. For e.g display_name=Foo The filter string is case sensitive + * @param {boolean=} params.includeModelInfo If true then also include information about the models built using the datasets. + * @param {integer=} params.pageSize The maximum number of items to return. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {string} params.parent Required. Resource name of the parent. Has the format :- "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): AxiosPromise; + 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|AxiosPromise { + 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://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/datasets') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * speech.projects.locations.datasets.refreshData + * @desc Refresh data for a dataset. + * @alias speech.projects.locations.datasets.refreshData + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the destination dataset. + * @param {().RefreshDataRequest} 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 + */ + refreshData( + params?: Params$Resource$Projects$Locations$Datasets$Refreshdata, + options?: MethodOptions): AxiosPromise; + refreshData( + params: Params$Resource$Projects$Locations$Datasets$Refreshdata, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + refreshData( + params: Params$Resource$Projects$Locations$Datasets$Refreshdata, + callback: BodyResponseCallback): void; + refreshData(callback: BodyResponseCallback): void; + refreshData( + paramsOrCallback?: + Params$Resource$Projects$Locations$Datasets$Refreshdata| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Datasets$Refreshdata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Refreshdata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}:refreshData') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + 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; + + /** + * Required. Resource name of the parent. Has the format :- + * "projects/{project_id}/locations/{location_id}" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Get extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * If true then also include information about the models built using this + * dataset. + */ + includeModelInfo?: boolean; + /** + * The resource name of the dataset to retrieve. Form :- + * '/projects/{project_number}/locations/{location_id}/datasets/{dataset_id}' + */ + name?: 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; + + /** + * Filter the response based on display_name of the dataset. For e.g + * display_name=Foo The filter string is case sensitive + */ + filter?: string; + /** + * If true then also include information about the models built using the + * datasets. + */ + includeModelInfo?: boolean; + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * Required. Resource name of the parent. Has the format :- + * "projects/{project_id}/locations/{location_id}" + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Refreshdata + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * The resource name of the destination dataset. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RefreshDataRequest; + } + + + export class Resource$Projects$Locations$Log_data_stats { + root: Speech; + constructor(root: Speech) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * speech.projects.locations.log_data_stats.list + * @desc List all log data stats associated with this project. + * @alias speech.projects.locations.log_data_stats.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Resource name of the parent. Has the format :- "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$Log_data_stats$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Projects$Locations$Log_data_stats$List, + options: MethodOptions| + BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Log_data_stats$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + Params$Resource$Projects$Locations$Log_data_stats$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Log_data_stats$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Log_data_stats$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/log_data_stats') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Log_data_stats$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. Resource name of the parent. Has the format :- + * "projects/{project_id}/locations/{location_id}" + */ + parent?: string; + } + + + export class Resource$Projects$Locations$Models { + root: Speech; + constructor(root: Speech) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * speech.projects.locations.models.create + * @desc Performs asynchronous model training for AutoML: receive results + * via the google.longrunning.Operations interface. Returns either an + * `Operation.error` or an `Operation.response` which contains a `Model` + * message. + * @alias speech.projects.locations.models.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.name Required. Resource name of the dataset being used to create the model. '/projects/{project_id}/locations/{location_id}/datasets/{dataset_id}' + * @param {string} params.parent Required. Resource name of the parent. Has the format :- "projects/{project_id}/locations/{location_id}" + * @param {().Model} 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$Models$Create, + options?: MethodOptions): AxiosPromise; + create( + params: Params$Resource$Projects$Locations$Models$Create, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + create( + params: Params$Resource$Projects$Locations$Models$Create, + callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: Params$Resource$Projects$Locations$Models$Create| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Models$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/models') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * speech.projects.locations.models.deploy + * @desc Performs asynchronous model deployment of the model: receive + * results via the google.longrunning.Operations interface. After the + * operation is completed this returns either an `Operation.error` in case + * of error or a `google.protobuf.Empty` if the deployment was successful. + * @alias speech.projects.locations.models.deploy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of the model. Format: "projects/{project_id}/locations/{location_id}/models/{model_id}" + * @param {().DeployModelRequest} 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 + */ + deploy( + params?: Params$Resource$Projects$Locations$Models$Deploy, + options?: MethodOptions): AxiosPromise; + deploy( + params: Params$Resource$Projects$Locations$Models$Deploy, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + deploy( + params: Params$Resource$Projects$Locations$Models$Deploy, + callback: BodyResponseCallback): void; + deploy(callback: BodyResponseCallback): void; + deploy( + paramsOrCallback?: Params$Resource$Projects$Locations$Models$Deploy| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Models$Deploy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$Deploy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}:deploy') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * speech.projects.locations.models.evaluate + * @desc Performs asynchronous evaluation of the model: receive results via + * the google.longrunning.Operations interface. After the operation is + * completed this returns either an `Operation.error` in case of error or a + * `EvaluateModelResponse` with the evaluation results. + * @alias speech.projects.locations.models.evaluate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of the model. Format: "projects/{project_id}/locations/{location_id}/models/{model_id}" + * @param {().EvaluateModelRequest} 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 + */ + evaluate( + params?: Params$Resource$Projects$Locations$Models$Evaluate, + options?: MethodOptions): AxiosPromise; + evaluate( + params: Params$Resource$Projects$Locations$Models$Evaluate, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + evaluate( + params: Params$Resource$Projects$Locations$Models$Evaluate, + callback: BodyResponseCallback): void; + evaluate(callback: BodyResponseCallback): void; + evaluate( + paramsOrCallback?: Params$Resource$Projects$Locations$Models$Evaluate| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Models$Evaluate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$Evaluate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}:evaluate') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * speech.projects.locations.models.list + * @desc Fetch the list of models associated with this project. + * @alias speech.projects.locations.models.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Filter the response based on display_name of the model. For e.g display_name=Foo The filter string is case sensitive + * @param {integer=} params.pageSize The maximum number of items to return. + * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. + * @param {string} params.parent Required. Resource name of the parent. Has the format :- "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$Models$List, + options?: MethodOptions): AxiosPromise; + list( + params: Params$Resource$Projects$Locations$Models$List, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + list( + params: Params$Resource$Projects$Locations$Models$List, + callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: Params$Resource$Projects$Locations$Models$List| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Projects$Locations$Models$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/models') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'GET' + }, + options), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Models$Create extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Required. Resource name of the dataset being used to create the model. + * '/projects/{project_id}/locations/{location_id}/datasets/{dataset_id}' + */ + name?: string; + /** + * Required. Resource name of the parent. Has the format :- + * "projects/{project_id}/locations/{location_id}" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Model; + } + export interface Params$Resource$Projects$Locations$Models$Deploy extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of the model. Format: + * "projects/{project_id}/locations/{location_id}/models/{model_id}" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeployModelRequest; + } + export interface Params$Resource$Projects$Locations$Models$Evaluate extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Resource name of the model. Format: + * "projects/{project_id}/locations/{location_id}/models/{model_id}" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EvaluateModelRequest; + } + export interface Params$Resource$Projects$Locations$Models$List extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + /** + * Filter the response based on display_name of the model. For e.g + * display_name=Foo The filter string is case sensitive + */ + filter?: string; + /** + * The maximum number of items to return. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous List request, if any. + */ + pageToken?: string; + /** + * Required. Resource name of the parent. Has the format :- + * "projects/{project_id}/locations/{location_id}" + */ + parent?: string; + } + + + + export class Resource$Speech { + root: Speech; + constructor(root: Speech) { + this.root = root; + this.getRoot.bind(this); + } + + getRoot() { + return this.root; + } + + + /** + * speech.speech.longrunningrecognize + * @desc Performs asynchronous speech recognition: receive results via the + * google.longrunning.Operations interface. Returns either an + * `Operation.error` or an `Operation.response` which contains a + * `LongRunningRecognizeResponse` message. + * @alias speech.speech.longrunningrecognize + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().LongRunningRecognizeRequest} 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 + */ + longrunningrecognize( + params?: Params$Resource$Speech$Longrunningrecognize, + options?: MethodOptions): AxiosPromise; + longrunningrecognize( + params: Params$Resource$Speech$Longrunningrecognize, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + longrunningrecognize( + params: Params$Resource$Speech$Longrunningrecognize, + callback: BodyResponseCallback): void; + longrunningrecognize(callback: BodyResponseCallback): + void; + longrunningrecognize( + paramsOrCallback?: Params$Resource$Speech$Longrunningrecognize| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as + Params$Resource$Speech$Longrunningrecognize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Speech$Longrunningrecognize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/speech:longrunningrecognize') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + + /** + * speech.speech.recognize + * @desc Performs synchronous speech recognition: receive results after all + * audio has been sent and processed. + * @alias speech.speech.recognize + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().RecognizeRequest} 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 + */ + recognize( + params?: Params$Resource$Speech$Recognize, + options?: MethodOptions): AxiosPromise; + recognize( + params: Params$Resource$Speech$Recognize, + options: MethodOptions|BodyResponseCallback, + callback: BodyResponseCallback): void; + recognize( + params: Params$Resource$Speech$Recognize, + callback: BodyResponseCallback): void; + recognize(callback: BodyResponseCallback): void; + recognize( + paramsOrCallback?: Params$Resource$Speech$Recognize| + BodyResponseCallback, + optionsOrCallback?: MethodOptions| + BodyResponseCallback, + callback?: BodyResponseCallback): + void|AxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Speech$Recognize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Speech$Recognize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://speech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/speech:recognize') + .replace(/([^:]\/)\/+/g, '$1'), + method: 'POST' + }, + options), + params, + requiredParams: [], + pathParams: [], + context: this.getRoot() + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Speech$Longrunningrecognize extends + StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$LongRunningRecognizeRequest; + } + export interface Params$Resource$Speech$Recognize extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string|OAuth2Client|JWT|Compute|UserRefreshClient; + + + /** + * Request body metadata + */ + requestBody?: Schema$RecognizeRequest; + } +} diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 7c86d52631c..cd38e1a6f3c 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -390,7 +390,7 @@ export namespace sqladmin_v1beta4 { * The name and status of the failover replica. This property is applicable * only to Second Generation instances. */ - failoverReplica?: any; + failoverReplica?: {available?: boolean; name?: string;}; /** * The Compute Engine zone that the instance is currently serving from. This * value could be different from the zone that was specified when the @@ -586,7 +586,7 @@ export namespace sqladmin_v1beta4 { * Options for exporting data as CSV. Exporting in CSV format using the * Cloud SQL Admin API is not supported for PostgreSQL instances. */ - csvExportOptions?: any; + csvExportOptions?: {selectQuery?: string;}; /** * Databases to be exported. MySQL instances: If fileType is SQL and no * database is specified, all databases are exported, except for the mysql @@ -610,7 +610,11 @@ export namespace sqladmin_v1beta4 { /** * Options for exporting data as SQL statements. */ - sqlExportOptions?: any; + sqlExportOptions?: { + mysqlExportOptions?: {masterData?: number;}; + schemaOnly?: boolean; + tables?: string[]; + }; /** * The path to the file in Google Cloud Storage where the export will be * stored. The URI is in the form gs://bucketName/fileName. If the file @@ -698,7 +702,7 @@ export namespace sqladmin_v1beta4 { * Options for importing data as CSV. Importing CSV data using the Cloud SQL * Admin API is not supported for PostgreSQL instances. */ - csvImportOptions?: any; + csvImportOptions?: {columns?: string[]; table?: string;}; /** * The target database for the import. If fileType is SQL, this field is * required only if the import file does not specify a database, and is @@ -1302,7 +1306,7 @@ export namespace sqladmin_v1beta4 { * User-provided labels, represented as a dictionary where each label is a * single key value pair. */ - userLabels?: any; + userLabels?: {[key: string]: string;}; } /** * SslCerts Resource diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 3d158d45459..2a91b9943de 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -124,11 +124,16 @@ export namespace storage_v1 { /** * The bucket's billing configuration. */ - billing?: any; + billing?: {requesterPays?: boolean;}; /** * The bucket's Cross-Origin Resource Sharing (CORS) configuration. */ - cors?: any[]; + cors?: Array<{ + maxAgeSeconds?: number; + method?: string[]; + origin?: string[]; + responseHeader?: string[]; + }>; /** * The default value for event-based hold on newly created objects in this * bucket. Event-based hold is a way to retain objects indefinitely until an @@ -152,11 +157,16 @@ export namespace storage_v1 { /** * Encryption configuration for a bucket. */ - encryption?: any; + encryption?: {defaultKmsKeyName?: string;}; /** * HTTP 1.1 Entity tag for the bucket. */ etag?: string; + /** + * The bucket's IAM configuration. + */ + iamConfiguration?: + {bucketPolicyOnly?: {enabled?: boolean; lockedTime?: string;};}; /** * The ID of the bucket. For buckets, the id and name properties are the * same. @@ -169,12 +179,24 @@ export namespace storage_v1 { /** * User-provided labels, in key/value pairs. */ - labels?: any; + labels?: {[key: string]: string;}; /** * The bucket's lifecycle configuration. See lifecycle management for * more information. */ - lifecycle?: any; + lifecycle?: { + rule?: Array<{ + action?: {storageClass?: string; type?: string;}; + condition?: { + age?: number; + createdBefore?: string; + isLive?: boolean; + matchesPattern?: string; + matchesStorageClass?: string[]; + numNewerVersions?: number; + }; + }>; + }; /** * The location of the bucket. Object data for objects in the bucket resides * in physical storage within this region. Defaults to US. See the @@ -185,7 +207,7 @@ export namespace storage_v1 { * The bucket's logging configuration, which defines the destination * bucket and optional name prefix for the current bucket's logs. */ - logging?: any; + logging?: {logBucket?: string; logObjectPrefix?: string;}; /** * The metadata generation of this bucket. */ @@ -198,7 +220,7 @@ export namespace storage_v1 { * The owner of the bucket. This is always the project team's owner * group. */ - owner?: any; + owner?: {entity?: string; entityId?: string;}; /** * The project number of the project the bucket belongs to. */ @@ -214,7 +236,8 @@ export namespace storage_v1 { * Attempting to remove or decrease period of a locked retention policy will * result in a PERMISSION_DENIED error. */ - retentionPolicy?: any; + retentionPolicy?: + {effectiveTime?: string; isLocked?: boolean; retentionPeriod?: string;}; /** * The URI of this bucket. */ @@ -240,13 +263,13 @@ export namespace storage_v1 { /** * The bucket's versioning configuration. */ - versioning?: any; + versioning?: {enabled?: boolean;}; /** * The bucket's website configuration, controlling how the service * behaves when accessing bucket contents as a web site. See the Static * Website Examples for more information. */ - website?: any; + website?: {mainPageSuffix?: string; notFoundPage?: string;}; } /** * An access-control entry. @@ -295,7 +318,7 @@ export namespace storage_v1 { /** * The project team associated with the entity, if any. */ - projectTeam?: any; + projectTeam?: {projectNumber?: string; team?: string;}; /** * The access permission for the entity. */ @@ -363,7 +386,7 @@ export namespace storage_v1 { /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: any; + params?: {[key: string]: string;}; /** * A Boolean value to indicate whether payload is wanted. Optional. */ @@ -403,7 +426,11 @@ export namespace storage_v1 { * The list of source objects that will be concatenated into a single * object. */ - sourceObjects?: any[]; + sourceObjects?: Array<{ + generation?: string; + name?: string; + objectPreconditions?: {ifGenerationMatch?: string;}; + }>; } /** * A subscription to receive Google PubSub notifications. @@ -413,7 +440,7 @@ export namespace storage_v1 { * An optional list of additional attributes to attach to each Cloud PubSub * message published for this notification subscription. */ - custom_attributes?: any; + custom_attributes?: {[key: string]: string;}; /** * HTTP 1.1 Entity tag for this subscription notification. */ @@ -516,7 +543,7 @@ export namespace storage_v1 { * Metadata of customer-supplied encryption key, if the object is encrypted * by such a key. */ - customerEncryption?: any; + customerEncryption?: {encryptionAlgorithm?: string; keySha256?: string;}; /** * HTTP 1.1 Entity tag for the object. */ @@ -566,7 +593,7 @@ export namespace storage_v1 { /** * User-provided metadata, in key/value pairs. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * The version of the metadata for this object at this generation. Used for * preconditions and for detecting changes in metadata. A metageneration @@ -581,7 +608,7 @@ export namespace storage_v1 { /** * The owner of the object. This will always be the uploader of the object. */ - owner?: any; + owner?: {entity?: string; entityId?: string;}; /** * A server-determined value that specifies the earliest time that the * object's retention period expires. This value is in RFC 3339 format. @@ -687,7 +714,7 @@ export namespace storage_v1 { /** * The project team associated with the entity, if any. */ - projectTeam?: any; + projectTeam?: {projectNumber?: string; team?: string;}; /** * The access permission for the entity. */ @@ -743,7 +770,7 @@ export namespace storage_v1 { * An association between a role, which comes with a set of permissions, and * members who may assume that role. */ - bindings?: any[]; + bindings?: Array<{condition?: any; members?: string[]; role?: string;}>; /** * HTTP 1.1 Entity tag for the policy. */ @@ -3212,7 +3239,7 @@ export namespace storage_v1 { /** * Permissions to test. */ - permissions?: string; + permissions?: string[]; /** * The project to be billed for this request. Required for Requester Pays * buckets. @@ -8413,7 +8440,7 @@ export namespace storage_v1 { /** * Permissions to test. */ - permissions?: string; + permissions?: string[]; /** * The project to be billed for this request. Required for Requester Pays * buckets. diff --git a/src/apis/storage/v1beta1.ts b/src/apis/storage/v1beta1.ts index 479dfa50f95..ae43d1518e3 100644 --- a/src/apis/storage/v1beta1.ts +++ b/src/apis/storage/v1beta1.ts @@ -133,7 +133,7 @@ export namespace storage_v1beta1 { * The owner of the bucket. This will always be the project team's owner * group. */ - owner?: any; + owner?: {entity?: string; entityId?: string;}; /** * The project the bucket belongs to. */ @@ -149,7 +149,7 @@ export namespace storage_v1beta1 { /** * The bucket's website configuration. */ - website?: any; + website?: {mainPageSuffix?: string; notFoundPage?: string;}; } /** * An access-control entry. @@ -272,11 +272,19 @@ export namespace storage_v1beta1 { * Object media data. Provided on your behalf when uploading raw media or * multipart/related with an auxiliary media part. */ - media?: any; + media?: { + algorithm?: string; + contentType?: string; + data?: string; + hash?: string; + length?: string; + link?: string; + timeCreated?: string; + }; /** * User-provided metadata, in key/value pairs. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * The name of this object. Required if not specified by URL parameter. */ @@ -284,7 +292,7 @@ export namespace storage_v1beta1 { /** * The owner of the object. This will always be the uploader of the object. */ - owner?: any; + owner?: {entity?: string; entityId?: string;}; /** * The link to this object. */ diff --git a/src/apis/storage/v1beta2.ts b/src/apis/storage/v1beta2.ts index 03a76903025..7afc88adef9 100644 --- a/src/apis/storage/v1beta2.ts +++ b/src/apis/storage/v1beta2.ts @@ -120,7 +120,12 @@ export namespace storage_v1beta2 { /** * The bucket's Cross-Origin Resource Sharing (CORS) configuration. */ - cors?: any[]; + cors?: Array<{ + maxAgeSeconds?: number; + method?: string[]; + origin?: string[]; + responseHeader?: string[]; + }>; /** * Default access controls to apply to new objects when no ACL is provided. */ @@ -141,7 +146,17 @@ export namespace storage_v1beta2 { * The bucket's lifecycle configuration. See object lifecycle management * for more information. */ - lifecycle?: any; + lifecycle?: { + rule?: Array<{ + action?: {type?: string;}; + condition?: { + age?: number; + createdBefore?: string; + isLive?: boolean; + numNewerVersions?: number; + }; + }>; + }; /** * The location of the bucket. Object data for objects in the bucket resides * in physical storage within this region. Typical values are US and EU. @@ -152,7 +167,7 @@ export namespace storage_v1beta2 { * The bucket's logging configuration, which defines the destination * bucket and optional name prefix for the current bucket's logs. */ - logging?: any; + logging?: {logBucket?: string; logObjectPrefix?: string;}; /** * The metadata generation of this bucket. */ @@ -165,7 +180,7 @@ export namespace storage_v1beta2 { * The owner of the bucket. This is always the project team's owner * group. */ - owner?: any; + owner?: {entity?: string; entityId?: string;}; /** * The URI of this bucket. */ @@ -184,11 +199,11 @@ export namespace storage_v1beta2 { /** * The bucket's versioning configuration. */ - versioning?: any; + versioning?: {enabled?: boolean;}; /** * The bucket's website configuration. */ - website?: any; + website?: {mainPageSuffix?: string; notFoundPage?: string;}; } /** * An access-control entry. @@ -300,7 +315,7 @@ export namespace storage_v1beta2 { /** * Additional parameters controlling delivery channel behavior. Optional. */ - params?: any; + params?: {[key: string]: string;}; /** * A Boolean value to indicate whether payload is wanted. Optional. */ @@ -340,7 +355,11 @@ export namespace storage_v1beta2 { * The list of source objects that will be concatenated into a single * object. */ - sourceObjects?: any[]; + sourceObjects?: Array<{ + generation?: string; + name?: string; + objectPreconditions?: {ifGenerationMatch?: string;}; + }>; } /** * An object. @@ -411,7 +430,7 @@ export namespace storage_v1beta2 { /** * User-provided metadata, in key/value pairs. */ - metadata?: any; + metadata?: {[key: string]: string;}; /** * The generation of the metadata for this object at this generation. Used * for metadata versioning. Has no meaning outside of the context of this @@ -425,7 +444,7 @@ export namespace storage_v1beta2 { /** * The owner of the object. This will always be the uploader of the object. */ - owner?: any; + owner?: {entity?: string; entityId?: string;}; /** * The link to this object. */ diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index 189228b29e0..fc4867bef9e 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -375,7 +375,7 @@ export namespace storagetransfer_v1 { /** * Represents the transfer operation object. */ - metadata?: 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 @@ -391,7 +391,7 @@ export namespace storagetransfer_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Request passed to PauseTransferOperation. @@ -472,7 +472,7 @@ export namespace storagetransfer_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index df440b402df..349ef3c9714 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -258,7 +258,7 @@ export namespace streetviewpublish_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -274,7 +274,7 @@ export namespace streetviewpublish_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Photo is used to store 360 photos along with photo metadata. @@ -295,6 +295,11 @@ export namespace streetviewpublish_v1 { * when GetPhotoRequest.view is set to PhotoView.INCLUDE_DOWNLOAD_URL. */ downloadUrl?: string; + /** + * Output only. Status in Google Maps, whether this photo was published, or + * rejected for a possibly specified reason. + */ + mapsPublishStatus?: string; /** * Required when updating a photo. Output only when creating a photo. * Identifier for the photo, which is unique among all photos in Google. @@ -316,6 +321,10 @@ export namespace streetviewpublish_v1 { * Output only. The thumbnail URL for showing a preview of the given photo. */ thumbnailUrl?: string; + /** + * Output only. Status of rights transfer on this photo. + */ + transferStatus?: string; /** * Required when creating a photo. Input only. The resource URL where the * photo bytes are uploaded to. @@ -465,7 +474,7 @@ export namespace streetviewpublish_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -1332,7 +1341,7 @@ export namespace streetviewpublish_v1 { * Required. IDs of the Photos. For HTTP GET requests, the URL query * parameter should be `photoIds=&photoIds=&...`. */ - photoIds?: string; + photoIds?: string[]; /** * Specifies if a download URL for the photo bytes should be returned in the * Photo response. diff --git a/src/apis/tagmanager/v1.ts b/src/apis/tagmanager/v1.ts index b98fccc7864..303502cd66e 100644 --- a/src/apis/tagmanager/v1.ts +++ b/src/apis/tagmanager/v1.ts @@ -3017,15 +3017,15 @@ export namespace tagmanager_v1 { /** * The tags to be moved to the folder. */ - tagId?: string; + tagId?: string[]; /** * The triggers to be moved to the folder. */ - triggerId?: string; + triggerId?: string[]; /** * The variables to be moved to the folder. */ - variableId?: string; + variableId?: string[]; /** * Request body metadata diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 5c2a09930db..cb890f7fbd2 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -5155,7 +5155,7 @@ export namespace tagmanager_v2 { /** * The types of built-in variables to enable. */ - type?: string; + type?: string[]; } export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$Delete extends StandardParameters { @@ -5172,7 +5172,7 @@ export namespace tagmanager_v2 { /** * The types of built-in variables to delete. */ - type?: string; + type?: string[]; } export interface Params$Resource$Accounts$Containers$Workspaces$Built_in_variables$List extends StandardParameters { @@ -5872,15 +5872,15 @@ export namespace tagmanager_v2 { /** * The tags to be moved to the folder. */ - tagId?: string; + tagId?: string[]; /** * The triggers to be moved to the folder. */ - triggerId?: string; + triggerId?: string[]; /** * The variables to be moved to the folder. */ - variableId?: string; + variableId?: string[]; /** * Request body metadata diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index 80b31107e5c..eb12f83c85b 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -135,7 +135,7 @@ export namespace tasks_v1 { /** * Collection of links. This collection is read-only. */ - links?: any[]; + links?: Array<{description?: string; link?: string; type?: string;}>; /** * Notes describing the task. Optional. */ diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 841aa8a5ede..dfa2a5cc159 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -197,6 +197,10 @@ export namespace testing_v1 { * The APK for the application under test. */ appApk?: Schema$FileReference; + /** + * A multi-apk app bundle for the application under test. + */ + appBundle?: Schema$AppBundle; /** * The java package for the application under test. Optional, default is * determined by examining the application's manifest. @@ -349,6 +353,10 @@ export namespace testing_v1 { * The APK for the application under test. */ appApk?: Schema$FileReference; + /** + * A multi-apk app bundle for the application under test. + */ + appBundle?: Schema$AppBundle; /** * The initial activity that should be used to start the app. Optional */ @@ -410,6 +418,10 @@ export namespace testing_v1 { * The APK for the application under test. */ appApk?: Schema$FileReference; + /** + * A multi-apk app bundle for the application under test. + */ + appBundle?: Schema$AppBundle; /** * The java package for the application under test. Optional, default is * determined by examining the application's manifest. @@ -514,6 +526,18 @@ export namespace testing_v1 { */ packageName?: string; } + /** + * An Android App Bundle file format, containing a BundleConfig.pb file, a + * base module directory, zero or more dynamic feature module directories. + * <p>See https://developer.android.com/guide/app-bundle/build for + * guidance on building App Bundles. + */ + export interface Schema$AppBundle { + /** + * .aab file representing the app bundle under test. + */ + bundleLocation?: Schema$FileReference; + } /** * Response containing the current state of the specified test matrix. */ diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 744b94c8cbc..700b08a1622 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -1260,19 +1260,20 @@ export namespace toolresults_v1beta3 { } /** * A Timestamp represents a point in time independent of any time zone or - * calendar, represented as seconds and fractions of seconds at nanosecond - * resolution in UTC Epoch time. It is encoded using the Proleptic Gregorian - * Calendar which extends the Gregorian calendar backwards to year one. It is - * encoded assuming all minutes are 60 seconds long, i.e. leap seconds are - * "smeared" so that no leap second table is needed for - * interpretation. Range is from 0001-01-01T00:00:00Z to - * 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure - * that we can convert to and from RFC 3339 date strings. See - * [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). - * # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp - * timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); - * Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval - * tv; gettimeofday(&tv, NULL); Timestamp timestamp; + * local calendar, encoded as a count of seconds and fractions of seconds at + * nanosecond resolution. The count is relative to an epoch at UTC midnight on + * January 1, 1970, in the proleptic Gregorian calendar which extends the + * Gregorian calendar backwards to year one. All minutes are 60 seconds long. + * Leap seconds are "smeared" so that no leap second table is needed + * for interpretation, using a [24-hour linear + * smear](https://developers.google.com/time/smear). The range is from + * 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to + * that range, we ensure that we can convert to and from [RFC + * 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples + * Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; + * timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: + * Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; + * gettimeofday(&tv, NULL); Timestamp timestamp; * timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); * Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. * FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = @@ -3670,7 +3671,7 @@ export namespace toolresults_v1beta3 { * Specify one or more PerfMetricType values such as CPU to filter the * result */ - filter?: string; + filter?: string[]; /** * A tool results history ID. */ diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index 1903afd169e..7271b2f91e3 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -218,7 +218,7 @@ export namespace tpu_v1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -227,7 +227,7 @@ export namespace tpu_v1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -291,7 +291,7 @@ export namespace tpu_v1 { /** * Resource labels to represent user-provided metadata. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The immutable name of the TPU */ @@ -352,7 +352,7 @@ export namespace tpu_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -368,7 +368,7 @@ export namespace tpu_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Represents the metadata of the long-running operation. @@ -468,7 +468,7 @@ export namespace tpu_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index 7d3caad2c5b..fe6ea737f54 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -218,7 +218,7 @@ export namespace tpu_v1alpha1 { * Cross-service attributes for the location. For example * {"cloud.googleapis.com/region": "us-east1"} */ - labels?: any; + labels?: {[key: string]: string;}; /** * The canonical id for this location. For example: `"us-east1"`. */ @@ -227,7 +227,7 @@ export namespace tpu_v1alpha1 { * Service-specific metadata. For example the available capacity at the * given location. */ - metadata?: any; + metadata?: {[key: string]: any;}; /** * Resource name for the location, which may vary between implementations. * For example: `"projects/example-project/locations/us-east1"` @@ -291,7 +291,7 @@ export namespace tpu_v1alpha1 { /** * Resource labels to represent user-provided metadata. */ - labels?: any; + labels?: {[key: string]: string;}; /** * Output only. The immutable name of the TPU */ @@ -352,7 +352,7 @@ export namespace tpu_v1alpha1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -368,7 +368,7 @@ export namespace tpu_v1alpha1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Represents the metadata of the long-running operation. @@ -468,7 +468,7 @@ export namespace tpu_v1alpha1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/translate/v2.ts b/src/apis/translate/v2.ts index 6d65b8d684f..aaa80386236 100644 --- a/src/apis/translate/v2.ts +++ b/src/apis/translate/v2.ts @@ -413,7 +413,7 @@ export namespace translate_v2 { * The input text upon which to perform language detection. Repeat this * parameter to perform language detection on multiple text inputs. */ - q?: string; + q?: string[]; } @@ -677,7 +677,7 @@ export namespace translate_v2 { /** * The customization id for translate */ - cid?: string; + cid?: string[]; /** * The format of the source text, in either HTML (default) or plain-text. A * value of "html" indicates HTML and a value of "text" indicates @@ -693,7 +693,7 @@ export namespace translate_v2 { * The input text to translate. Repeat this parameter to perform translation * operations on multiple text inputs. */ - q?: string; + q?: string[]; /** * The language of the source text, set to one of the language codes listed * in Language Support. If the source language is not specified, the API diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 04563ae161f..4767f017e38 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -347,6 +347,10 @@ export namespace vault_v1 { * Option available for mail export. */ mailOptions?: Schema$MailExportOptions; + /** + * The requested export location. + */ + region?: string; } /** * Stats of an export. @@ -599,10 +603,6 @@ export namespace vault_v1 { * The export file format. */ exportFormat?: string; - /** - * Set to true to export confidential mode content - */ - showConfidentialModeContent?: boolean; } /** * Mail search advanced options @@ -854,7 +854,7 @@ export namespace vault_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/videointelligence/README.md b/src/apis/videointelligence/README.md index f36737e9ea7..c7cc170d619 100644 --- a/src/apis/videointelligence/README.md +++ b/src/apis/videointelligence/README.md @@ -2,7 +2,7 @@ # @google/videointelligence -> 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. ## Installation diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 2b4b781fcb3..886c9f60b42 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -1656,7 +1656,7 @@ export namespace videointelligence_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1672,7 +1672,7 @@ export namespace videointelligence_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * A generic empty message that you can re-use to avoid defining duplicated @@ -1727,7 +1727,7 @@ export namespace videointelligence_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index d655e2c4263..7f6fe26e333 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -1637,7 +1637,7 @@ export namespace videointelligence_v1beta2 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1653,7 +1653,7 @@ export namespace videointelligence_v1beta2 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -1700,7 +1700,7 @@ export namespace videointelligence_v1beta2 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index 7a1d1e99027..946df26f8d3 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -1638,7 +1638,7 @@ export namespace videointelligence_v1p1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -1654,7 +1654,7 @@ export namespace videointelligence_v1p1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * The `Status` type defines a logical error model that is suitable for @@ -1701,7 +1701,7 @@ export namespace videointelligence_v1p1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 93577b438cd..6712009dac2 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -338,7 +338,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -865,7 +865,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -885,6 +885,10 @@ export namespace vision_v1 { * A bounding polygon for the detected image annotation. */ export interface Schema$GoogleCloudVisionV1p1beta1BoundingPoly { + /** + * The bounding polygon normalized vertices. + */ + normalizedVertices?: Schema$GoogleCloudVisionV1p1beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ @@ -1199,6 +1203,20 @@ export namespace vision_v1 { */ latLng?: Schema$LatLng; } + /** + * 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$GoogleCloudVisionV1p1beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } /** * Contains metadata for the BatchAnnotateImages operation. */ @@ -1275,7 +1293,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1695,7 +1713,7 @@ export namespace vision_v1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1832,7 +1850,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2260,7 +2278,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2680,7 +2698,7 @@ export namespace vision_v1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2837,7 +2855,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3283,7 +3301,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3729,7 +3747,7 @@ export namespace vision_v1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -4156,7 +4174,7 @@ export namespace vision_v1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -4172,7 +4190,7 @@ export namespace vision_v1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -4250,7 +4268,7 @@ export namespace vision_v1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4553,7 +4571,7 @@ export namespace vision_v1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -4763,7 +4781,7 @@ export namespace vision_v1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 8c43b03ca8e..4ce0f76b897 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -255,7 +255,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -801,7 +801,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -821,6 +821,10 @@ export namespace vision_v1p1beta1 { * A bounding polygon for the detected image annotation. */ export interface Schema$GoogleCloudVisionV1p1beta1BoundingPoly { + /** + * The bounding polygon normalized vertices. + */ + normalizedVertices?: Schema$GoogleCloudVisionV1p1beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ @@ -1261,6 +1265,20 @@ export namespace vision_v1p1beta1 { */ latLng?: Schema$LatLng; } + /** + * 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$GoogleCloudVisionV1p1beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } /** * Contains metadata for the BatchAnnotateImages operation. */ @@ -1337,7 +1355,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1797,7 +1815,7 @@ export namespace vision_v1p1beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1934,7 +1952,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2362,7 +2380,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2782,7 +2800,7 @@ export namespace vision_v1p1beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2939,7 +2957,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3385,7 +3403,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3831,7 +3849,7 @@ export namespace vision_v1p1beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -4034,7 +4052,7 @@ export namespace vision_v1p1beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -4050,7 +4068,7 @@ export namespace vision_v1p1beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -4128,7 +4146,7 @@ export namespace vision_v1p1beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4360,7 +4378,7 @@ export namespace vision_v1p1beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -4561,7 +4579,7 @@ export namespace vision_v1p1beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index 3dbeca466bd..37d690e882e 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -255,7 +255,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -734,7 +734,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -754,6 +754,10 @@ export namespace vision_v1p2beta1 { * A bounding polygon for the detected image annotation. */ export interface Schema$GoogleCloudVisionV1p1beta1BoundingPoly { + /** + * The bounding polygon normalized vertices. + */ + normalizedVertices?: Schema$GoogleCloudVisionV1p1beta1NormalizedVertex[]; /** * The bounding polygon vertices. */ @@ -1068,6 +1072,20 @@ export namespace vision_v1p2beta1 { */ latLng?: Schema$LatLng; } + /** + * 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$GoogleCloudVisionV1p1beta1NormalizedVertex { + /** + * X coordinate. + */ + x?: number; + /** + * Y coordinate. + */ + y?: number; + } /** * Contains metadata for the BatchAnnotateImages operation. */ @@ -1144,7 +1162,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1564,7 +1582,7 @@ export namespace vision_v1p2beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p1beta1BoundingPoly; /** @@ -1768,7 +1786,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2322,7 +2340,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2782,7 +2800,7 @@ export namespace vision_v1p2beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p2beta1BoundingPoly; /** @@ -2939,7 +2957,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's * rotated 180 degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3385,7 +3403,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -3831,7 +3849,7 @@ export namespace vision_v1p2beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$GoogleCloudVisionV1p3beta1BoundingPoly; /** @@ -4034,7 +4052,7 @@ export namespace vision_v1p2beta1 { * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ - metadata?: 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 @@ -4050,7 +4068,7 @@ export namespace vision_v1p2beta1 { * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: any; + response?: {[key: string]: any;}; } /** * Contains metadata for the BatchAnnotateImages operation. @@ -4128,7 +4146,7 @@ export namespace vision_v1p2beta1 { * orientation. For example: * when the text is horizontal it might look * like: 0----1 | | 3----2 * when it's rotated 180 * degrees around the top-left corner it becomes: 2----3 | | - * 1----0 and the vertice order will still be (0, 1, 2, 3). + * 1----0 and the vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** @@ -4360,7 +4378,7 @@ export namespace vision_v1p2beta1 { * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ - details?: any[]; + 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 @@ -4561,7 +4579,7 @@ export namespace vision_v1p2beta1 { * example: * when the text is horizontal it might look like: 0----1 * | | 3----2 * when it's rotated 180 degrees around the * top-left corner it becomes: 2----3 | | 1----0 and the - * vertice order will still be (0, 1, 2, 3). + * vertex order will still be (0, 1, 2, 3). */ boundingBox?: Schema$BoundingPoly; /** diff --git a/src/apis/webfonts/v1.ts b/src/apis/webfonts/v1.ts index 52dc31f308f..2a4c07ed5d5 100644 --- a/src/apis/webfonts/v1.ts +++ b/src/apis/webfonts/v1.ts @@ -113,7 +113,7 @@ export namespace webfonts_v1 { * The font files (with all supported scripts) for each one of the available * variants, as a key : value map. */ - files?: any; + files?: {[key: string]: string;}; /** * This kind represents a webfont object in the webfonts service. */ diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index fa7d957df7b..f799dc93476 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -730,7 +730,7 @@ export namespace youtube_v3 { /** * Localizations for different languages */ - localizations?: any; + localizations?: {[key: string]: Schema$ChannelLocalization;}; /** * The snippet object contains basic details about the channel, such as its * title, description, and thumbnail images. @@ -820,7 +820,13 @@ export namespace youtube_v3 { * Details about the content of a channel. */ export interface Schema$ChannelContentDetails { - relatedPlaylists?: any; + relatedPlaylists?: { + favorites?: string; + likes?: string; + uploads?: string; + watchHistory?: string; + watchLater?: string; + }; } /** * The contentOwnerDetails object encapsulates channel data that is relevant @@ -959,7 +965,7 @@ export namespace youtube_v3 { /** * Localizations for different languages */ - localizations?: any; + localizations?: {[key: string]: Schema$ChannelSectionLocalization;}; /** * The snippet object contains basic details about the channel section, such * as its type, style and title. @@ -3113,7 +3119,7 @@ export namespace youtube_v3 { /** * Localizations for different languages */ - localizations?: any; + localizations?: {[key: string]: Schema$PlaylistLocalization;}; /** * The player object contains information that you would use to play the * playlist in an embedded player. @@ -4046,7 +4052,7 @@ export namespace youtube_v3 { /** * List with all localizations. */ - localizations?: any; + localizations?: {[key: string]: Schema$VideoLocalization;}; /** * The monetizationDetails object encapsulates information about the * monetization status of the video. diff --git a/src/apis/youtubeAnalytics/v1.ts b/src/apis/youtubeAnalytics/v1.ts index 0accfc05f5b..687214f6930 100644 --- a/src/apis/youtubeAnalytics/v1.ts +++ b/src/apis/youtubeAnalytics/v1.ts @@ -103,18 +103,18 @@ export namespace youtubeAnalytics_v1 { } export interface Schema$Group { - contentDetails?: any; + contentDetails?: {itemCount?: string; itemType?: string;}; etag?: string; id?: string; kind?: string; - snippet?: any; + snippet?: {publishedAt?: string; title?: string;}; } export interface Schema$GroupItem { etag?: string; groupId?: string; id?: string; kind?: string; - resource?: any; + resource?: {id?: string; kind?: string;}; } /** * A paginated list of grouList resources returned in response to a @@ -154,7 +154,8 @@ export namespace youtubeAnalytics_v1 { * API response will return columns in this order: * ageGroup,gender,viewerPercentage. */ - columnHeaders?: any[]; + columnHeaders?: + Array<{columnType?: string; dataType?: string; name?: string;}>; /** * This value specifies the type of data included in the API response. For * the query method, the kind property value will be diff --git a/src/apis/youtubeAnalytics/v1beta1.ts b/src/apis/youtubeAnalytics/v1beta1.ts index 2638fb6e573..8a500acb055 100644 --- a/src/apis/youtubeAnalytics/v1beta1.ts +++ b/src/apis/youtubeAnalytics/v1beta1.ts @@ -103,18 +103,18 @@ export namespace youtubeAnalytics_v1beta1 { } export interface Schema$Group { - contentDetails?: any; + contentDetails?: {itemCount?: string; itemType?: string;}; etag?: string; id?: string; kind?: string; - snippet?: any; + snippet?: {publishedAt?: string; title?: string;}; } export interface Schema$GroupItem { etag?: string; groupId?: string; id?: string; kind?: string; - resource?: any; + resource?: {id?: string; kind?: string;}; } /** * A paginated list of grouList resources returned in response to a @@ -154,7 +154,8 @@ export namespace youtubeAnalytics_v1beta1 { * API response will return columns in this order: * ageGroup,gender,viewerPercentage. */ - columnHeaders?: any[]; + columnHeaders?: + Array<{columnType?: string; dataType?: string; name?: string;}>; /** * This value specifies the type of data included in the API response. For * the query method, the kind property value will be diff --git a/src/index.ts b/src/index.ts index d3ee29d63f7..b7e97060c45 100644 --- a/src/index.ts +++ b/src/index.ts @@ -75,6 +75,7 @@ export {cloudresourcemanager_v1} from './apis/cloudresourcemanager/v1'; export {cloudresourcemanager_v1beta1} from './apis/cloudresourcemanager/v1beta1'; export {cloudresourcemanager_v2} from './apis/cloudresourcemanager/v2'; export {cloudresourcemanager_v2beta1} from './apis/cloudresourcemanager/v2beta1'; +export {cloudscheduler_v1beta1} from './apis/cloudscheduler/v1beta1'; export {cloudsearch_v1} from './apis/cloudsearch/v1'; export {cloudshell_v1} from './apis/cloudshell/v1'; export {cloudshell_v1alpha1} from './apis/cloudshell/v1alpha1'; @@ -100,7 +101,6 @@ export {datastore_v1beta3} from './apis/datastore/v1beta3'; export {deploymentmanager_alpha} from './apis/deploymentmanager/alpha'; export {deploymentmanager_v2} from './apis/deploymentmanager/v2'; export {deploymentmanager_v2beta} from './apis/deploymentmanager/v2beta'; -export {dfareporting_v3_0} from './apis/dfareporting/v3.0'; export {dfareporting_v3_1} from './apis/dfareporting/v3.1'; export {dfareporting_v3_2} from './apis/dfareporting/v3.2'; export {dialogflow_v2} from './apis/dialogflow/v2'; @@ -115,6 +115,7 @@ export {doubleclickbidmanager_v1} from './apis/doubleclickbidmanager/v1'; export {doubleclicksearch_v2} from './apis/doubleclicksearch/v2'; export {drive_v2} from './apis/drive/v2'; export {drive_v3} from './apis/drive/v3'; +export {driveactivity_v2} from './apis/driveactivity/v2'; export {file_v1beta1} from './apis/file/v1beta1'; export {firebasedynamiclinks_v1} from './apis/firebasedynamiclinks/v1'; export {firebasehosting_v1beta1} from './apis/firebasehosting/v1beta1'; @@ -161,7 +162,7 @@ export {oslogin_v1beta} from './apis/oslogin/v1beta'; export {pagespeedonline_v1} from './apis/pagespeedonline/v1'; export {pagespeedonline_v2} from './apis/pagespeedonline/v2'; export {pagespeedonline_v4} from './apis/pagespeedonline/v4'; -export {partners_v2} from './apis/partners/v2'; +export {pagespeedonline_v5} from './apis/pagespeedonline/v5'; export {people_v1} from './apis/people/v1'; export {playcustomapp_v1} from './apis/playcustomapp/v1'; export {plus_v1} from './apis/plus/v1'; @@ -196,7 +197,7 @@ export {slides_v1} from './apis/slides/v1'; export {sourcerepo_v1} from './apis/sourcerepo/v1'; export {spanner_v1} from './apis/spanner/v1'; export {speech_v1} from './apis/speech/v1'; -export {speech_v1beta1} from './apis/speech/v1beta1'; +export {speech_v1p1beta1} from './apis/speech/v1p1beta1'; export {sqladmin_v1beta4} from './apis/sqladmin/v1beta4'; export {storage_v1} from './apis/storage/v1'; export {storage_v1beta1} from './apis/storage/v1beta1';