diff --git a/samples/test/test.samples.blog.js b/samples/test/test.samples.blog.js index 45f0b62e65b..147829c21ca 100644 --- a/samples/test/test.samples.blog.js +++ b/samples/test/test.samples.blog.js @@ -23,7 +23,7 @@ const samples = { post: require('../blogger/insert'), }; -const baseUrl = 'https://www.googleapis.com'; +const baseUrl = 'https://blogger.googleapis.com'; for (const p in samples) { if (samples[p]) { @@ -38,7 +38,7 @@ describe('blogger samples', () => { it('should insert a blog post', async () => { const scope = nock(baseUrl) - .post(`/blogger/v3/blogs/4340475495955554224/posts`) + .post(`/v3/blogs/4340475495955554224/posts`) .reply(200, {}); const data = await samples.post.runSample(); assert(data); diff --git a/src/apis/adsense/v1.4.ts b/src/apis/adsense/v1.4.ts index c363198b0fa..36b2040ebe4 100644 --- a/src/apis/adsense/v1.4.ts +++ b/src/apis/adsense/v1.4.ts @@ -232,7 +232,7 @@ export namespace adsense_v1_4 { /** * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. */ - headers?: Array<{type?: string; currency?: string; name?: string}> | null; + headers?: Array<{name?: string; type?: string; currency?: string}> | null; /** * Kind this is, in this case adsense#report. */ @@ -263,11 +263,11 @@ export namespace adsense_v1_4 { * The colors which are included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. */ colors?: { + text?: string; background?: string; url?: string; title?: string; border?: string; - text?: string; } | null; /** * The style of the corners in the ad (deprecated: never populated, ignored). @@ -292,7 +292,7 @@ export namespace adsense_v1_4 { */ contentAdsSettings?: { type?: string; - backupOption?: {color?: string; type?: string; url?: string}; + backupOption?: {type?: string; url?: string; color?: string}; size?: string; } | null; /** @@ -303,10 +303,10 @@ export namespace adsense_v1_4 { * Settings specific to feed ads (AFF) - deprecated. */ feedAdsSettings?: { - frequency?: number; - minimumWordCount?: number; type?: string; adPosition?: string; + frequency?: number; + minimumWordCount?: number; } | null; /** * 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. @@ -413,10 +413,10 @@ export namespace adsense_v1_4 { * The targeting information of this custom channel, if activated. */ targetingInfo?: { - siteLanguage?: string; adsAppearOn?: string; description?: string; location?: string; + siteLanguage?: string; } | null; } export interface Schema$CustomChannels { diff --git a/src/apis/adsensehost/v4.1.ts b/src/apis/adsensehost/v4.1.ts index 8c84fea45c8..ffc22f1c2fb 100644 --- a/src/apis/adsensehost/v4.1.ts +++ b/src/apis/adsensehost/v4.1.ts @@ -196,11 +196,11 @@ export namespace adsensehost_v4_1 { * The colors included in the style. These are represented as six hexadecimal characters, similar to HTML color codes, but without the leading hash. */ colors?: { + url?: string; title?: string; border?: string; text?: string; background?: string; - url?: string; } | null; /** * The style of the corners in the ad (deprecated: never populated, ignored). @@ -224,9 +224,9 @@ export namespace adsensehost_v4_1 { * Settings specific to content ads (AFC) and highend mobile content ads (AFMC - deprecated). */ contentAdsSettings?: { + backupOption?: {color?: string; type?: string; url?: string}; size?: string; type?: string; - backupOption?: {url?: string; color?: string; type?: string}; } | null; /** * Custom style information specific to this ad unit. @@ -358,7 +358,7 @@ export namespace adsensehost_v4_1 { /** * The header information of the columns requested in the report. This is a list of headers; one for each dimension in the request, followed by one for each metric in the request. */ - headers?: Array<{currency?: string; name?: string; type?: string}> | null; + headers?: Array<{name?: string; type?: string; currency?: string}> | null; /** * Kind this is, in this case adsensehost#report. */ diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts index 59f489c492d..9f64228736a 100644 --- a/src/apis/analytics/v3.ts +++ b/src/apis/analytics/v3.ts @@ -408,7 +408,7 @@ export namespace analytics_v3 { * Account ID to which this custom data source belongs. */ accountId?: string | null; - childLink?: {type?: string; href?: string} | null; + childLink?: {href?: string; type?: string} | null; /** * Time this custom data source was created. */ @@ -433,7 +433,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?: {href?: string; type?: string} | null; + parentLink?: {type?: string; href?: string} | null; /** * IDs of views (profiles) linked to the custom data source. */ @@ -535,7 +535,7 @@ export namespace analytics_v3 { /** * Parent link for the custom dimension. Points to the property to which the custom dimension belongs. */ - parentLink?: {type?: string; href?: string} | null; + parentLink?: {href?: string; type?: string} | null; /** * Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. */ @@ -883,7 +883,7 @@ export namespace analytics_v3 { /** * Parent link for an experiment. Points to the view (profile) to which this experiment belongs. */ - parentLink?: {href?: string; type?: string} | null; + parentLink?: {type?: string; href?: string} | null; /** * View (Profile) ID to which this experiment belongs. This field is read-only. */ @@ -928,11 +928,11 @@ export namespace analytics_v3 { * Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING. */ variations?: Array<{ + name?: string; + weight?: number; url?: string; won?: boolean; status?: string; - name?: string; - weight?: number; }> | null; /** * Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only. @@ -996,19 +996,19 @@ export namespace analytics_v3 { * Details for the filter of the type ADVANCED. */ advancedDetails?: { + overrideOutputField?: boolean; + fieldBIndex?: number; outputConstructor?: string; fieldBRequired?: boolean; fieldAIndex?: number; extractA?: string; fieldA?: string; outputToFieldIndex?: number; - fieldB?: string; fieldARequired?: boolean; + fieldB?: string; caseSensitive?: boolean; outputToField?: string; extractB?: string; - overrideOutputField?: boolean; - fieldBIndex?: number; } | null; /** * Time this filter was created. @@ -1046,11 +1046,11 @@ export namespace analytics_v3 { * Details for the filter of the type SEARCH_AND_REPLACE. */ searchAndReplaceDetails?: { - replaceString?: string; - caseSensitive?: boolean; field?: string; searchString?: string; fieldIndex?: number; + replaceString?: string; + caseSensitive?: boolean; } | null; /** * Link for this filter. @@ -1181,7 +1181,7 @@ export namespace analytics_v3 { */ dataLastRefreshed?: string | null; dataTable?: { - cols?: Array<{type?: string; id?: string; label?: string}>; + cols?: Array<{id?: string; label?: string; type?: string}>; rows?: Array<{c?: Array<{v?: string}>}>; } | null; /** @@ -1219,17 +1219,17 @@ export namespace analytics_v3 { * Analytics data request query parameters. */ query?: { + dimensions?: string; + 'end-date'?: string; filters?: string; sort?: string[]; 'max-results'?: number; metrics?: string[]; segment?: string; - 'start-index'?: number; 'start-date'?: string; + 'start-index'?: number; ids?: string; samplingLevel?: string; - dimensions?: string; - 'end-date'?: string; } | null; /** * 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. @@ -1304,7 +1304,7 @@ export namespace analytics_v3 { /** * Parent link for a goal. Points to the view (profile) to which this goal belongs. */ - parentLink?: {type?: string; href?: string} | null; + parentLink?: {href?: string; type?: string} | null; /** * View (Profile) ID to which this goal belongs. */ @@ -1329,7 +1329,7 @@ export namespace analytics_v3 { matchType?: string; caseSensitive?: boolean; firstStepRequired?: boolean; - steps?: Array<{name?: string; number?: number; url?: string}>; + steps?: Array<{number?: number; url?: string; name?: string}>; } | null; /** * Goal value. @@ -1486,9 +1486,9 @@ 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?: Array<{ - dataType?: string; columnType?: string; name?: string; + dataType?: string; }> | null; /** * Determines if the Analytics data contains sampled data. @@ -1518,17 +1518,18 @@ export namespace analytics_v3 { * Information for the view (profile), for which the Analytics data was requested. */ profileInfo?: { - profileName?: string; webPropertyId?: string; accountId?: string; profileId?: string; internalWebPropertyId?: string; tableId?: string; + profileName?: string; } | null; /** * Analytics data request query parameters. */ query?: { + samplingLevel?: string; dimensions?: string; 'end-date'?: string; filters?: string; @@ -1539,7 +1540,6 @@ export namespace analytics_v3 { 'start-date'?: string; segment?: string; ids?: string; - samplingLevel?: string; } | null; /** * 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. @@ -1589,7 +1589,7 @@ export namespace analytics_v3 { /** * Child link for this view (profile). Points to the list of goals for this view (profile). */ - childLink?: {href?: string; type?: string} | null; + childLink?: {type?: string; href?: string} | null; /** * Time this view (profile) was created. */ @@ -1633,7 +1633,7 @@ export namespace analytics_v3 { /** * Parent link for this view (profile). Points to the web property to which this view (profile) belongs. */ - parentLink?: {href?: string; type?: string} | null; + parentLink?: {type?: string; href?: string} | null; /** * Permissions the user has for this view (profile). */ @@ -1868,23 +1868,23 @@ export namespace analytics_v3 { * Information for the view (profile), for which the real time data was requested. */ profileInfo?: { - tableId?: string; - profileName?: string; webPropertyId?: string; accountId?: string; profileId?: string; internalWebPropertyId?: string; + tableId?: string; + profileName?: string; } | null; /** * Real time data request query parameters. */ query?: { - ids?: string; - dimensions?: string; - filters?: string; sort?: string[]; 'max-results'?: number; metrics?: string[]; + ids?: string; + dimensions?: string; + filters?: string; } | null; /** * 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 same as specified in the request. @@ -1956,7 +1956,7 @@ export namespace analytics_v3 { */ stateBasedAudienceDefinition?: { includeConditions?: Schema$IncludeConditions; - excludeConditions?: {segment?: string; exclusionDuration?: string}; + excludeConditions?: {exclusionDuration?: string; segment?: string}; } | null; /** * Time this remarketing audience was last modified. @@ -2093,7 +2093,7 @@ export namespace analytics_v3 { /** * Download details for a file stored in Google Cloud Storage. */ - cloudStorageDownloadDetails?: {bucketId?: string; objectId?: string} | null; + cloudStorageDownloadDetails?: {objectId?: string; bucketId?: string} | null; /** * Time this unsampled report was created. */ @@ -2357,7 +2357,7 @@ export namespace analytics_v3 { /** * Child link for this web property. Points to the list of views (profiles) for this web property. */ - childLink?: {type?: string; href?: string} | null; + childLink?: {href?: string; type?: string} | null; /** * Time this web property was created. */ @@ -2401,7 +2401,7 @@ export namespace analytics_v3 { /** * Parent link for this web property. Points to the account to which this web property belongs. */ - parentLink?: {href?: string; type?: string} | null; + parentLink?: {type?: string; href?: string} | null; /** * Permissions the user has for this web property. */ diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index d746c95af1f..4fc084c2dae 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -2457,7 +2457,7 @@ export namespace androidpublisher_v2 { /** * androidpublisher.edits.deobfuscationfiles.upload - * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced. + * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation or symbolication file already exists, it will be replaced. See https://developer.android.com/studio/build/shrink-code to learn more about deobfuscation files. * @alias androidpublisher.edits.deobfuscationfiles.upload * @memberOf! () * @@ -2465,7 +2465,7 @@ export namespace androidpublisher_v2 { * @param {integer} params.apkVersionCode The version code of the APK whose deobfuscation file is being uploaded. * @param {string} params.deobfuscationFileType * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -2579,7 +2579,7 @@ export namespace androidpublisher_v2 { */ editId?: string; /** - * Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". + * Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, "com.spiffygame". */ packageName?: string; diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index d11dc1e1205..122ab9e22b9 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -884,7 +884,7 @@ export namespace androidpublisher_v3 { controls?: Schema$Control[]; countryTargeting?: Schema$CountryTargeting; /** - * In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 0. See https://developer.android.com/guide/playcore/in-app-updates. + * In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 0. in_app_update_priority can not be updated once the release is rolled out. See https://developer.android.com/guide/playcore/in-app-updates. */ inAppUpdatePriority?: number | null; /** @@ -2036,7 +2036,7 @@ export namespace androidpublisher_v3 { /** * androidpublisher.edits.deobfuscationfiles.upload - * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation file already exists, it will be replaced. + * @desc Uploads the deobfuscation file of the specified APK. If a deobfuscation or symbolication file already exists, it will be replaced. See https://developer.android.com/studio/build/shrink-code to learn more about deobfuscation files. * @alias androidpublisher.edits.deobfuscationfiles.upload * @memberOf! () * @@ -2044,7 +2044,7 @@ export namespace androidpublisher_v3 { * @param {integer} params.apkVersionCode The version code of the APK whose deobfuscation file is being uploaded. * @param {string} params.deobfuscationFileType * @param {string} params.editId Unique identifier for this edit. - * @param {string} params.packageName Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". + * @param {string} params.packageName Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, "com.spiffygame". * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents @@ -2158,7 +2158,7 @@ export namespace androidpublisher_v3 { */ editId?: string; /** - * Unique identifier of the Android app for which the deobfuscatiuon files are being uploaded; for example, "com.spiffygame". + * Unique identifier of the Android app for which the deobfuscation files are being uploaded; for example, "com.spiffygame". */ packageName?: string; diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 0c850b54778..cd3dee90d96 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -187,15 +187,15 @@ export namespace bigquery_v2 { */ export interface Schema$ArimaFittingMetrics { /** - * AIC + * AIC. */ aic?: number | null; /** - * log-likelihood + * Log-likelihood. */ logLikelihood?: number | null; /** - * variance. + * Variance. */ variance?: number | null; } @@ -211,10 +211,22 @@ export namespace bigquery_v2 { * Arima fitting metrics. */ arimaFittingMetrics?: Schema$ArimaFittingMetrics; + /** + * Whether Arima model fitted with drift or not. It is always false when d is not 1. + */ + hasDrift?: boolean | null; /** * Non-seasonal order. */ nonSeasonalOrder?: Schema$ArimaOrder; + /** + * Seasonal periods. Repeated because multiple periods are supported for one time series. + */ + seasonalPeriods?: string[] | null; + /** + * The id to indicate different time series. + */ + timeSeriesId?: string | null; } /** * Arima order, can be used for both non-seasonal and seasonal parts. @@ -519,6 +531,16 @@ export namespace bigquery_v2 { */ rows?: Schema$Row[]; } + export interface Schema$ConnectionProperty { + /** + * [Required] Name of the connection property to set. + */ + key?: string | null; + /** + * [Required] Value of the connection property. + */ + value?: string | null; + } export interface Schema$CsvOptions { /** * [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. @@ -550,13 +572,13 @@ export namespace bigquery_v2 { * [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; */ access?: Array<{ + specialGroup?: string; role?: string; view?: Schema$TableReference; groupByEmail?: string; - userByEmail?: string; domain?: string; + userByEmail?: string; iamMember?: string; - specialGroup?: string; }> | null; /** * [Output-only] The time when this dataset was created, in milliseconds since the epoch. @@ -617,12 +639,12 @@ export namespace bigquery_v2 { * An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project. */ datasets?: Array<{ - id?: string; - location?: string; - friendlyName?: string; kind?: string; labels?: {[key: string]: string}; datasetReference?: Schema$DatasetReference; + id?: string; + location?: string; + friendlyName?: string; }> | null; /** * A hash value of the results page. You can use this property to determine if the page has changed since the last request. @@ -889,10 +911,6 @@ export namespace bigquery_v2 { * [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. */ googleSheetsOptions?: Schema$GoogleSheetsOptions; - /** - * [Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead. - */ - hivePartitioningMode?: string | null; /** * [Optional, Trusted Tester] Options to configure hive partitioning support. */ @@ -1206,10 +1224,6 @@ export namespace bigquery_v2 { * [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). */ fieldDelimiter?: string | null; - /** - * [Optional, Trusted Tester] Deprecated, do not use. Please set hivePartitioningOptions instead. - */ - hivePartitioningMode?: string | null; /** * [Optional, Trusted Tester] Options to configure hive partitioning support. */ @@ -1291,7 +1305,7 @@ export namespace bigquery_v2 { /** * Connection properties. */ - connectionProperties?: any[] | null; + connectionProperties?: Schema$ConnectionProperty[]; /** * [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. */ @@ -1481,7 +1495,7 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{slotMs?: string; name?: string}> | null; + reservationUsage?: Array<{name?: string; slotMs?: string}> | null; /** * [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. */ @@ -1571,7 +1585,7 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{slotMs?: string; name?: string}> | null; + reservationUsage?: Array<{name?: string; slotMs?: string}> | null; /** * [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. */ @@ -1770,9 +1784,9 @@ export namespace bigquery_v2 { * [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query. */ modelOptions?: { + modelType?: string; labels?: string[]; lossType?: string; - modelType?: string; } | null; /** * [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query. @@ -1823,11 +1837,11 @@ export namespace bigquery_v2 { * Projects to which you have at least READ access. */ projects?: Array<{ - id?: string; - projectReference?: Schema$ProjectReference; friendlyName?: string; numericId?: string; kind?: string; + id?: string; + projectReference?: Schema$ProjectReference; }> | null; /** * The total number of projects in the list. @@ -1863,9 +1877,9 @@ export namespace bigquery_v2 { * [Optional] The types of the fields of this struct, in order, if this is a struct. */ structTypes?: Array<{ - type?: Schema$QueryParameterType; name?: string; description?: string; + type?: Schema$QueryParameterType; }> | null; /** * [Required] The top level type of this field. @@ -1890,7 +1904,7 @@ export namespace bigquery_v2 { /** * Connection properties. */ - connectionProperties?: any[] | null; + connectionProperties?: Schema$ConnectionProperty[]; /** * [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'. */ @@ -2462,18 +2476,18 @@ export namespace bigquery_v2 { * Tables in the requested dataset. */ tables?: Array<{ + view?: {useLegacySql?: boolean}; + creationTime?: string; + rangePartitioning?: Schema$RangePartitioning; id?: string; tableReference?: Schema$TableReference; - friendlyName?: string; timePartitioning?: Schema$TimePartitioning; + friendlyName?: string; labels?: {[key: string]: string}; - clustering?: Schema$Clustering; type?: string; + clustering?: Schema$Clustering; expirationTime?: string; kind?: string; - view?: {useLegacySql?: boolean}; - creationTime?: string; - rangePartitioning?: Schema$RangePartitioning; }> | null; /** * The total number of tables in the dataset. diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index 967cd5cf4bb..5fb99022afc 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -156,7 +156,7 @@ export namespace bigqueryreservation_v1 { updateTime?: string | null; } /** - * Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Monthly and annual commitments renew by default. Only flex commitments can be removed. In order to remove monthly or annual commitments, their plan needs to be changed to flex first. A capacity commitment resource exists as a child resource of the admin project. + * Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. */ export interface Schema$CapacityCommitment { /** diff --git a/src/apis/bigqueryreservation/v1beta1.ts b/src/apis/bigqueryreservation/v1beta1.ts index 593b302fcc5..be8f0e6879f 100644 --- a/src/apis/bigqueryreservation/v1beta1.ts +++ b/src/apis/bigqueryreservation/v1beta1.ts @@ -167,7 +167,7 @@ export namespace bigqueryreservation_v1beta1 { updateTime?: string | null; } /** - * Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Monthly and annual commitments renew by default. Only flex commitments can be removed. In order to remove monthly or annual commitments, their plan needs to be changed to flex first. A capacity commitment resource exists as a child resource of the admin project. + * Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project. */ export interface Schema$CapacityCommitment { /** diff --git a/src/apis/blogger/v2.ts b/src/apis/blogger/v2.ts index 04f48958620..291fa8585fa 100644 --- a/src/apis/blogger/v2.ts +++ b/src/apis/blogger/v2.ts @@ -41,9 +41,21 @@ export namespace blogger_v2 { interface StandardParameters { /** - * Data format for the response. + * 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. */ @@ -61,19 +73,23 @@ export namespace blogger_v2 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * 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; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** - * Blogger API + * Blogger API v3 * - * API for access to the data within Blogger. + * The Blogger API provides access to posts, comments and pages of a Blogger blog. * * @example * const {google} = require('googleapis'); @@ -108,6 +124,10 @@ export namespace blogger_v2 { } export interface Schema$Blog { + /** + * The JSON custom meta-data for the Blog. + */ + customMetaData?: string | null; /** * The description of this blog. This is displayed underneath the title. */ @@ -117,7 +137,7 @@ export namespace blogger_v2 { */ id?: string | null; /** - * The kind of this entry. Always blogger#blog + * The kind of this entry. Always blogger#blog. */ kind?: string | null; /** @@ -131,11 +151,15 @@ export namespace blogger_v2 { /** * The container of pages in this blog. */ - pages?: {selfLink?: string; totalItems?: number} | null; + pages?: {totalItems?: number; selfLink?: string} | null; /** * The container of posts in this blog. */ - posts?: {selfLink?: string; totalItems?: number} | null; + posts?: { + items?: Schema$Post[]; + selfLink?: string; + totalItems?: number; + } | null; /** * RFC 3339 date-time when this blog was published. */ @@ -144,6 +168,10 @@ export namespace blogger_v2 { * The API REST URL to fetch this resource from. */ selfLink?: string | null; + /** + * The status of the blog. + */ + status?: string | null; /** * RFC 3339 date-time when this blog was last updated. */ @@ -154,12 +182,56 @@ export namespace blogger_v2 { url?: string | null; } export interface Schema$BlogList { + /** + * Admin level list of blog per-user information. + */ + blogUserInfos?: Schema$BlogUserInfo[]; /** * The list of Blogs this user has Authorship or Admin rights over. */ items?: Schema$Blog[]; /** - * The kind of this entity. Always blogger#blogList + * The kind of this entity. Always blogger#blogList. + */ + kind?: string | null; + } + export interface Schema$BlogPerUserInfo { + /** + * ID of the Blog resource. + */ + blogId?: string | null; + /** + * True if the user has Admin level access to the blog. + */ + hasAdminAccess?: boolean | null; + /** + * The kind of this entity. Always blogger#blogPerUserInfo. + */ + kind?: string | null; + /** + * The Photo Album Key for the user when adding photos to the blog. + */ + photosAlbumKey?: string | null; + /** + * Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER). + */ + role?: string | null; + /** + * ID of the User. + */ + userId?: string | null; + } + export interface Schema$BlogUserInfo { + /** + * The Blog resource. + */ + blog?: Schema$Blog; + /** + * Information about a User for the Blog. + */ + blog_user_info?: Schema$BlogPerUserInfo; + /** + * The kind of this entity. Always blogger#blogUserInfo. */ kind?: string | null; } @@ -168,10 +240,10 @@ export namespace blogger_v2 { * The author of this Comment. */ author?: { - displayName?: string; - id?: string; image?: {url?: string}; + displayName?: string; url?: string; + id?: string; } | null; /** * Data about the blog containing this comment. @@ -190,7 +262,7 @@ export namespace blogger_v2 { */ inReplyTo?: {id?: string} | null; /** - * The kind of this entry. Always blogger#comment + * The kind of this entry. Always blogger#comment. */ kind?: string | null; /** @@ -205,18 +277,26 @@ export namespace blogger_v2 { * The API REST URL to fetch this resource from. */ selfLink?: string | null; + /** + * The status of the comment (only populated for admin users). + */ + status?: string | null; /** * RFC 3339 date-time when this comment was last updated. */ updated?: string | null; } export interface Schema$CommentList { + /** + * Etag of the response. + */ + etag?: string | null; /** * The List of Comments for a Post. */ items?: Schema$Comment[]; /** - * The kind of this entry. Always blogger#commentList + * The kind of this entry. Always blogger#commentList. */ kind?: string | null; /** @@ -234,9 +314,9 @@ export namespace blogger_v2 { */ author?: { displayName?: string; + url?: string; id?: string; image?: {url?: string}; - url?: string; } | null; /** * Data about the blog containing this Page. @@ -246,12 +326,16 @@ export namespace blogger_v2 { * The body content of this Page, in HTML. */ content?: string | null; + /** + * Etag of the resource. + */ + etag?: string | null; /** * The identifier for this resource. */ id?: string | null; /** - * The kind of this entity. Always blogger#page + * The kind of this entity. Always blogger#page. */ kind?: string | null; /** @@ -262,6 +346,10 @@ export namespace blogger_v2 { * The API REST URL to fetch this resource from. */ selfLink?: string | null; + /** + * The status of the page for admin resources (either LIVE or DRAFT). + */ + status?: string | null; /** * The title of this entity. This is the name displayed in the Admin user interface. */ @@ -276,14 +364,22 @@ export namespace blogger_v2 { url?: string | null; } export interface Schema$PageList { + /** + * Etag of the response. + */ + etag?: string | null; /** * The list of Pages for a Blog. */ items?: Schema$Page[]; /** - * The kind of this entity. Always blogger#pageList + * The kind of this entity. Always blogger#pageList. */ kind?: string | null; + /** + * Pagination token to fetch the next page, if one exists. + */ + nextPageToken?: string | null; } export interface Schema$Post { /** @@ -291,9 +387,9 @@ export namespace blogger_v2 { */ author?: { displayName?: string; + url?: string; id?: string; image?: {url?: string}; - url?: string; } | null; /** * Data about the blog containing this Post. @@ -303,34 +399,71 @@ export namespace blogger_v2 { * The content of the Post. May contain HTML markup. */ content?: string | null; + /** + * The JSON meta-data for the Post. + */ + customMetaData?: string | null; + /** + * Etag of the resource. + */ + etag?: string | null; /** * The identifier of this Post. */ id?: string | null; /** - * The kind of this entity. Always blogger#post + * Display image for the Post. + */ + images?: Array<{url?: string}> | null; + /** + * The kind of this entity. Always blogger#post. */ kind?: string | null; /** * The list of labels this Post was tagged with. */ labels?: string[] | null; + /** + * The location for geotagged posts. + */ + location?: { + lng?: number; + name?: string; + span?: string; + lat?: number; + } | null; /** * RFC 3339 date-time when this Post was published. */ published?: string | null; + /** + * Comment control and display setting for readers of this post. + */ + readerComments?: string | null; /** * The container of comments on this Post. */ - replies?: {selfLink?: string; totalItems?: string} | null; + replies?: { + totalItems?: string; + items?: Schema$Comment[]; + selfLink?: string; + } | null; /** * The API REST URL to fetch this resource from. */ selfLink?: string | null; + /** + * Status of the post. Only set for admin-level requests. + */ + status?: string | null; /** * The title of the Post. */ title?: string | null; + /** + * The title link URL, similar to atom's related link. + */ + titleLink?: string | null; /** * RFC 3339 date-time when this Post was last updated. */ @@ -341,12 +474,16 @@ export namespace blogger_v2 { url?: string | null; } export interface Schema$PostList { + /** + * Etag of the response. + */ + etag?: string | null; /** * The list of Posts for this Blog. */ items?: Schema$Post[]; /** - * The kind of this entity. Always blogger#postList + * The kind of this entity. Always blogger#postList. */ kind?: string | null; /** @@ -380,7 +517,7 @@ export namespace blogger_v2 { */ id?: string | null; /** - * The kind of this entity. Always blogger#user + * The kind of this entity. Always blogger#user. */ kind?: string | null; /** @@ -405,12 +542,12 @@ export namespace blogger_v2 { /** * blogger.blogs.get - * @desc Gets one blog by id. + * @desc Gets a blog by id. * @alias blogger.blogs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the blog to get. + * @param {string} params.blogId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -450,14 +587,11 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v2/blogs/{blogId}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v2/blogs/{blogId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -473,6 +607,77 @@ export namespace blogger_v2 { return createAPIRequest(parameters); } } + + /** + * blogger.blogs.list + * @desc Lists blogs by user id, possibly filtered. + * @alias blogger.blogs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.userId + * @param {object} [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$Blogs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Blogs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Blogs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Blogs$List + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Blogs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Blogs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/users/{userId}/blogs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Blogs$Get extends StandardParameters { @@ -482,10 +687,21 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the blog to get. + * */ blogId?: string; } + export interface Params$Resource$Blogs$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * + */ + userId?: string; + } export class Resource$Comments { context: APIRequestContext; @@ -495,14 +711,14 @@ export namespace blogger_v2 { /** * blogger.comments.get - * @desc Gets one comment by id. + * @desc Gets a comment by blog id, post id and comment id. * @alias blogger.comments.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to containing the comment. - * @param {string} params.commentId The ID of the comment to get. - * @param {string} params.postId ID of the post to fetch posts from. + * @param {string} params.blogId + * @param {string} params.commentId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -542,13 +758,12 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + - '/blogger/v2/blogs/{blogId}/posts/{postId}/comments/{commentId}' + rootUrl + '/v2/blogs/{blogId}/posts/{postId}/comments/{commentId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -568,17 +783,17 @@ export namespace blogger_v2 { /** * blogger.comments.list - * @desc Retrieves the comments for a blog, possibly filtered. + * @desc Lists comments. * @alias blogger.comments.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch comments from. - * @param {boolean=} params.fetchBodies Whether the body content of the comments is included. - * @param {integer=} params.maxResults Maximum number of comments to include in the result. - * @param {string=} params.pageToken Continuation token if request is paged. - * @param {string} params.postId ID of the post to fetch posts from. - * @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * @param {string} params.blogId + * @param {boolean=} params.fetchBodies + * @param {integer=} params.maxResults + * @param {string=} params.pageToken + * @param {string} params.postId + * @param {string=} params.startDate * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -620,12 +835,12 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + '/blogger/v2/blogs/{blogId}/posts/{postId}/comments' + rootUrl + '/v2/blogs/{blogId}/posts/{postId}/comments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -651,15 +866,15 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to containing the comment. + * */ blogId?: string; /** - * The ID of the comment to get. + * */ commentId?: string; /** - * ID of the post to fetch posts from. + * */ postId?: string; } @@ -670,27 +885,27 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch comments from. + * */ blogId?: string; /** - * Whether the body content of the comments is included. + * */ fetchBodies?: boolean; /** - * Maximum number of comments to include in the result. + * */ maxResults?: number; /** - * Continuation token if request is paged. + * */ pageToken?: string; /** - * ID of the post to fetch posts from. + * */ postId?: string; /** - * Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * */ startDate?: string; } @@ -703,13 +918,13 @@ export namespace blogger_v2 { /** * blogger.pages.get - * @desc Gets one blog page by id. + * @desc Gets a page by blog id and page id. * @alias blogger.pages.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog containing the page. - * @param {string} params.pageId The ID of the page to get. + * @param {string} params.blogId + * @param {string} params.pageId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -749,13 +964,14 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v2/blogs/{blogId}/pages/{pageId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/blogs/{blogId}/pages/{pageId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -774,13 +990,13 @@ export namespace blogger_v2 { /** * blogger.pages.list - * @desc Retrieves pages for a blog, possibly filtered. + * @desc Lists pages. * @alias blogger.pages.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch pages from. - * @param {boolean=} params.fetchBodies Whether to retrieve the Page bodies. + * @param {string} params.blogId + * @param {boolean=} params.fetchBodies * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -820,11 +1036,11 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v2/blogs/{blogId}/pages').replace( + url: (rootUrl + '/v2/blogs/{blogId}/pages').replace( /([^:]\/)\/+/g, '$1' ), @@ -852,11 +1068,11 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog containing the page. + * */ blogId?: string; /** - * The ID of the page to get. + * */ pageId?: string; } @@ -867,11 +1083,11 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch pages from. + * */ blogId?: string; /** - * Whether to retrieve the Page bodies. + * */ fetchBodies?: boolean; } @@ -884,13 +1100,13 @@ export namespace blogger_v2 { /** * blogger.posts.get - * @desc Get a post by id. + * @desc Gets a post by blog id and post id * @alias blogger.posts.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch the post from. - * @param {string} params.postId The ID of the post + * @param {string} params.blogId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -930,13 +1146,14 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v2/blogs/{blogId}/posts/{postId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/blogs/{blogId}/posts/{postId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -955,16 +1172,16 @@ export namespace blogger_v2 { /** * blogger.posts.list - * @desc Retrieves a list of posts, possibly filtered. + * @desc Lists posts. * @alias blogger.posts.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch posts from. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included. - * @param {integer=} params.maxResults Maximum number of posts to fetch. - * @param {string=} params.pageToken Continuation token if the request is paged. - * @param {string=} params.startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. + * @param {string} params.blogId + * @param {boolean=} params.fetchBodies + * @param {integer=} params.maxResults + * @param {string=} params.pageToken + * @param {string=} params.startDate * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1004,11 +1221,11 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v2/blogs/{blogId}/posts').replace( + url: (rootUrl + '/v2/blogs/{blogId}/posts').replace( /([^:]\/)\/+/g, '$1' ), @@ -1036,11 +1253,11 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch the post from. + * */ blogId?: string; /** - * The ID of the post + * */ postId?: string; } @@ -1051,43 +1268,41 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch posts from. + * */ blogId?: string; /** - * Whether the body content of posts is included. + * */ fetchBodies?: boolean; /** - * Maximum number of posts to fetch. + * */ maxResults?: number; /** - * Continuation token if the request is paged. + * */ pageToken?: string; /** - * Earliest post date to fetch, a date-time with RFC 3339 formatting. + * */ startDate?: string; } export class Resource$Users { context: APIRequestContext; - blogs: Resource$Users$Blogs; constructor(context: APIRequestContext) { this.context = context; - this.blogs = new Resource$Users$Blogs(this.context); } /** * blogger.users.get - * @desc Gets one user by id. + * @desc Gets a user by user id. * @alias blogger.users.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The ID of the user to get. + * @param {string} params.userId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1127,14 +1342,11 @@ export namespace blogger_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v2/users/{userId}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v2/users/{userId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -1159,97 +1371,7 @@ export namespace blogger_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the user to get. - */ - userId?: string; - } - - export class Resource$Users$Blogs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * blogger.users.blogs.list - * @desc Retrieves a list of blogs, possibly filtered. - * @alias blogger.users.blogs.list - * @memberOf! () * - * @param {object} params Parameters for request - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. - * @param {object} [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$Users$Blogs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Users$Blogs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Users$Blogs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Users$Blogs$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Users$Blogs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Users$Blogs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/blogger/v2/users/{userId}/blogs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Users$Blogs$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * ID of the user whose blogs are to be fetched. Either the word 'self' (sans quote marks) or the user's profile identifier. */ userId?: string; } diff --git a/src/apis/blogger/v3.ts b/src/apis/blogger/v3.ts index a3e16a45e7e..43770e8aa2d 100644 --- a/src/apis/blogger/v3.ts +++ b/src/apis/blogger/v3.ts @@ -41,9 +41,21 @@ export namespace blogger_v3 { interface StandardParameters { /** - * Data format for the response. + * 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. */ @@ -61,19 +73,23 @@ export namespace blogger_v3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * 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; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** - * Blogger API + * Blogger API v3 * - * API for access to the data within Blogger. + * The Blogger API provides access to posts, comments and pages of a Blogger blog. * * @example * const {google} = require('googleapis'); @@ -115,7 +131,7 @@ export namespace blogger_v3 { export interface Schema$Blog { /** - * The JSON custom meta-data for the Blog + * The JSON custom meta-data for the Blog. */ customMetaData?: string | null; /** @@ -127,7 +143,7 @@ export namespace blogger_v3 { */ id?: string | null; /** - * The kind of this entry. Always blogger#blog + * The kind of this entry. Always blogger#blog. */ kind?: string | null; /** @@ -141,14 +157,14 @@ export namespace blogger_v3 { /** * The container of pages in this blog. */ - pages?: {selfLink?: string; totalItems?: number} | null; + pages?: {totalItems?: number; selfLink?: string} | null; /** * The container of posts in this blog. */ posts?: { + totalItems?: number; items?: Schema$Post[]; selfLink?: string; - totalItems?: number; } | null; /** * RFC 3339 date-time when this blog was published. @@ -173,7 +189,7 @@ export namespace blogger_v3 { } export interface Schema$BlogList { /** - * Admin level list of blog per-user information + * Admin level list of blog per-user information. */ blogUserInfos?: Schema$BlogUserInfo[]; /** @@ -181,13 +197,13 @@ export namespace blogger_v3 { */ items?: Schema$Blog[]; /** - * The kind of this entity. Always blogger#blogList + * The kind of this entity. Always blogger#blogList. */ kind?: string | null; } export interface Schema$BlogPerUserInfo { /** - * ID of the Blog resource + * ID of the Blog resource. */ blogId?: string | null; /** @@ -195,11 +211,11 @@ export namespace blogger_v3 { */ hasAdminAccess?: boolean | null; /** - * The kind of this entity. Always blogger#blogPerUserInfo + * The kind of this entity. Always blogger#blogPerUserInfo. */ kind?: string | null; /** - * The Photo Album Key for the user when adding photos to the blog + * The Photo Album Key for the user when adding photos to the blog. */ photosAlbumKey?: string | null; /** @@ -207,7 +223,7 @@ export namespace blogger_v3 { */ role?: string | null; /** - * ID of the User + * ID of the User. */ userId?: string | null; } @@ -221,7 +237,7 @@ export namespace blogger_v3 { */ blog_user_info?: Schema$BlogPerUserInfo; /** - * The kind of this entity. Always blogger#blogUserInfo + * The kind of this entity. Always blogger#blogUserInfo. */ kind?: string | null; } @@ -231,9 +247,9 @@ export namespace blogger_v3 { */ author?: { displayName?: string; + url?: string; id?: string; image?: {url?: string}; - url?: string; } | null; /** * Data about the blog containing this comment. @@ -252,7 +268,7 @@ export namespace blogger_v3 { */ inReplyTo?: {id?: string} | null; /** - * The kind of this entry. Always blogger#comment + * The kind of this entry. Always blogger#comment. */ kind?: string | null; /** @@ -268,7 +284,7 @@ export namespace blogger_v3 { */ selfLink?: string | null; /** - * The status of the comment (only populated for admin users) + * The status of the comment (only populated for admin users). */ status?: string | null; /** @@ -286,7 +302,7 @@ export namespace blogger_v3 { */ items?: Schema$Comment[]; /** - * The kind of this entry. Always blogger#commentList + * The kind of this entry. Always blogger#commentList. */ kind?: string | null; /** @@ -303,10 +319,10 @@ export namespace blogger_v3 { * The author of this Page. */ author?: { - displayName?: string; + url?: string; id?: string; image?: {url?: string}; - url?: string; + displayName?: string; } | null; /** * Data about the blog containing this Page. @@ -325,7 +341,7 @@ export namespace blogger_v3 { */ id?: string | null; /** - * The kind of this entity. Always blogger#page + * The kind of this entity. Always blogger#page. */ kind?: string | null; /** @@ -363,7 +379,7 @@ export namespace blogger_v3 { */ items?: Schema$Page[]; /** - * The kind of this entity. Always blogger#pageList + * The kind of this entity. Always blogger#pageList. */ kind?: string | null; /** @@ -373,7 +389,7 @@ export namespace blogger_v3 { } export interface Schema$Pageviews { /** - * Blog Id + * Blog Id. */ blogId?: string | null; /** @@ -381,7 +397,7 @@ export namespace blogger_v3 { */ counts?: Array<{count?: string; timeRange?: string}> | null; /** - * The kind of this entry. Always blogger#page_views + * The kind of this entry. Always blogger#page_views. */ kind?: string | null; } @@ -390,10 +406,10 @@ export namespace blogger_v3 { * The author of this Post. */ author?: { - displayName?: string; + url?: string; id?: string; image?: {url?: string}; - url?: string; + displayName?: string; } | null; /** * Data about the blog containing this Post. @@ -420,7 +436,7 @@ export namespace blogger_v3 { */ images?: Array<{url?: string}> | null; /** - * The kind of this entity. Always blogger#post + * The kind of this entity. Always blogger#post. */ kind?: string | null; /** @@ -431,10 +447,10 @@ export namespace blogger_v3 { * The location for geotagged posts. */ location?: { - lat?: number; - lng?: number; name?: string; span?: string; + lat?: number; + lng?: number; } | null; /** * RFC 3339 date-time when this Post was published. @@ -457,7 +473,7 @@ export namespace blogger_v3 { */ selfLink?: string | null; /** - * Status of the post. Only set for admin-level requests + * Status of the post. Only set for admin-level requests. */ status?: string | null; /** @@ -487,13 +503,17 @@ export namespace blogger_v3 { */ items?: Schema$Post[]; /** - * The kind of this entity. Always blogger#postList + * The kind of this entity. Always blogger#postList. */ kind?: string | null; /** * Pagination token to fetch the next page, if one exists. */ nextPageToken?: string | null; + /** + * Pagination token to fetch the previous page, if one exists. + */ + prevPageToken?: string | null; } export interface Schema$PostPerUserInfo { /** @@ -505,7 +525,7 @@ export namespace blogger_v3 { */ hasEditAccess?: boolean | null; /** - * The kind of this entity. Always blogger#postPerUserInfo + * The kind of this entity. Always blogger#postPerUserInfo. */ kind?: string | null; /** @@ -519,7 +539,7 @@ export namespace blogger_v3 { } export interface Schema$PostUserInfo { /** - * The kind of this entity. Always blogger#postUserInfo + * The kind of this entity. Always blogger#postUserInfo. */ kind?: string | null; /** @@ -537,7 +557,7 @@ export namespace blogger_v3 { */ items?: Schema$PostUserInfo[]; /** - * The kind of this entity. Always blogger#postList + * The kind of this entity. Always blogger#postList. */ kind?: string | null; /** @@ -567,7 +587,7 @@ export namespace blogger_v3 { */ id?: string | null; /** - * The kind of this entity. Always blogger#user + * The kind of this entity. Always blogger#user. */ kind?: string | null; /** @@ -592,14 +612,14 @@ export namespace blogger_v3 { /** * blogger.blogs.get - * @desc Gets one blog by ID. + * @desc Gets a blog by id. * @alias blogger.blogs.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the blog to get. - * @param {integer=} params.maxPosts Maximum number of posts to pull back with the blog. - * @param {string=} params.view Access level with which to view the blog. Note that some fields require elevated access. + * @param {string} params.blogId + * @param {integer=} params.maxPosts + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -639,14 +659,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v3/blogs/{blogId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -665,13 +682,13 @@ export namespace blogger_v3 { /** * blogger.blogs.getByUrl - * @desc Retrieve a Blog by URL. + * @desc Gets a blog by url. * @alias blogger.blogs.getByUrl * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.url The URL of the blog to retrieve. - * @param {string=} params.view Access level with which to view the blog. Note that some fields require elevated access. + * @param {string} params.url + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -711,14 +728,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/byurl').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v3/blogs/byurl').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -737,16 +751,16 @@ export namespace blogger_v3 { /** * blogger.blogs.listByUser - * @desc Retrieves a list of blogs, possibly filtered. + * @desc Lists blogs by user. * @alias blogger.blogs.listByUser * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.fetchUserInfo Whether the response is a list of blogs with per-user information instead of just blogs. - * @param {string=} params.role User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. - * @param {string=} params.status Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. - * @param {string=} params.view Access level with which to view the blogs. Note that some fields require elevated access. + * @param {boolean=} params.fetchUserInfo + * @param {string=} params.role + * @param {string=} params.status Default value of status is LIVE. + * @param {string} params.userId + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -786,11 +800,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/users/{userId}/blogs').replace( + url: (rootUrl + '/v3/users/{userId}/blogs').replace( /([^:]\/)\/+/g, '$1' ), @@ -818,15 +832,15 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the blog to get. + * */ blogId?: string; /** - * Maximum number of posts to pull back with the blog. + * */ maxPosts?: number; /** - * Access level with which to view the blog. Note that some fields require elevated access. + * */ view?: string; } @@ -837,11 +851,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The URL of the blog to retrieve. + * */ url?: string; /** - * Access level with which to view the blog. Note that some fields require elevated access. + * */ view?: string; } @@ -852,23 +866,23 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Whether the response is a list of blogs with per-user information instead of just blogs. + * */ fetchUserInfo?: boolean; /** - * User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles. + * */ role?: string[]; /** - * Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs. + * Default value of status is LIVE. */ status?: string[]; /** - * ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. + * */ userId?: string; /** - * Access level with which to view the blogs. Note that some fields require elevated access. + * */ view?: string; } @@ -881,14 +895,14 @@ export namespace blogger_v3 { /** * blogger.blogUserInfos.get - * @desc Gets one blog and user info pair by blogId and userId. + * @desc Gets one blog and user info pair by blog id and user id. * @alias blogger.blogUserInfos.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the blog to get. - * @param {integer=} params.maxPosts Maximum number of posts to pull back with the blog. - * @param {string} params.userId ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. + * @param {string} params.blogId + * @param {integer=} params.maxPosts + * @param {string} params.userId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -931,13 +945,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/users/{userId}/blogs/{blogId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/users/{userId}/blogs/{blogId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -963,15 +978,15 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the blog to get. + * */ blogId?: string; /** - * Maximum number of posts to pull back with the blog. + * */ maxPosts?: number; /** - * ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier. + * */ userId?: string; } @@ -984,14 +999,14 @@ export namespace blogger_v3 { /** * blogger.comments.approve - * @desc Marks a comment as not spam. + * @desc Marks a comment as not spam by blog id, post id and comment id. * @alias blogger.comments.approve * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.commentId The ID of the comment to mark as not spam. - * @param {string} params.postId The ID of the Post. + * @param {string} params.blogId + * @param {string} params.commentId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1031,13 +1046,13 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/blogger/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve' + '/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -1057,14 +1072,14 @@ export namespace blogger_v3 { /** * blogger.comments.delete - * @desc Delete a comment by ID. + * @desc Deletes a comment by blog id, post id and comment id. * @alias blogger.comments.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.commentId The ID of the comment to delete. - * @param {string} params.postId The ID of the Post. + * @param {string} params.blogId + * @param {string} params.commentId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1104,13 +1119,12 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + - '/blogger/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}' + rootUrl + '/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, @@ -1130,15 +1144,15 @@ export namespace blogger_v3 { /** * blogger.comments.get - * @desc Gets one comment by ID. + * @desc Gets a comment by id. * @alias blogger.comments.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to containing the comment. - * @param {string} params.commentId The ID of the comment to get. - * @param {string} params.postId ID of the post to fetch posts from. - * @param {string=} params.view Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation. + * @param {string} params.blogId + * @param {string} params.commentId + * @param {string} params.postId + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1178,13 +1192,12 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + - '/blogger/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}' + rootUrl + '/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -1204,20 +1217,20 @@ export namespace blogger_v3 { /** * blogger.comments.list - * @desc Retrieves the comments for a post, possibly filtered. + * @desc Lists comments. * @alias blogger.comments.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch comments from. - * @param {string=} params.endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of the comments is included. - * @param {integer=} params.maxResults Maximum number of comments to include in the result. - * @param {string=} params.pageToken Continuation token if request is paged. - * @param {string} params.postId ID of the post to fetch posts from. - * @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * @param {string} params.blogId + * @param {string=} params.endDate + * @param {boolean=} params.fetchBodies + * @param {integer=} params.maxResults + * @param {string=} params.pageToken + * @param {string} params.postId + * @param {string=} params.startDate * @param {string=} params.status - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1259,12 +1272,12 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/posts/{postId}/comments' + rootUrl + '/v3/blogs/{blogId}/posts/{postId}/comments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -1284,17 +1297,17 @@ export namespace blogger_v3 { /** * blogger.comments.listByBlog - * @desc Retrieves the comments for a blog, across all posts, possibly filtered. + * @desc Lists comments by blog. * @alias blogger.comments.listByBlog * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch comments from. - * @param {string=} params.endDate Latest date of comment to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of the comments is included. - * @param {integer=} params.maxResults Maximum number of comments to include in the result. - * @param {string=} params.pageToken Continuation token if request is paged. - * @param {string=} params.startDate Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * @param {string} params.blogId + * @param {string=} params.endDate + * @param {boolean=} params.fetchBodies + * @param {integer=} params.maxResults + * @param {string=} params.pageToken + * @param {string=} params.startDate * @param {string=} params.status * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1338,11 +1351,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/comments').replace( + url: (rootUrl + '/v3/blogs/{blogId}/comments').replace( /([^:]\/)\/+/g, '$1' ), @@ -1364,14 +1377,14 @@ export namespace blogger_v3 { /** * blogger.comments.markAsSpam - * @desc Marks a comment as spam. + * @desc Marks a comment as spam by blog id, post id and comment id. * @alias blogger.comments.markAsSpam * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.commentId The ID of the comment to mark as spam. - * @param {string} params.postId The ID of the Post. + * @param {string} params.blogId + * @param {string} params.commentId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1412,13 +1425,13 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/blogger/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam' + '/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -1438,14 +1451,14 @@ export namespace blogger_v3 { /** * blogger.comments.removeContent - * @desc Removes the content of a comment. + * @desc Removes the content of a comment by blog id, post id and comment id. * @alias blogger.comments.removeContent * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.commentId The ID of the comment to delete content from. - * @param {string} params.postId The ID of the Post. + * @param {string} params.blogId + * @param {string} params.commentId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1486,13 +1499,13 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( rootUrl + - '/blogger/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent' + '/v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -1518,15 +1531,15 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the comment to mark as not spam. + * */ commentId?: string; /** - * The ID of the Post. + * */ postId?: string; } @@ -1537,15 +1550,15 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the comment to delete. + * */ commentId?: string; /** - * The ID of the Post. + * */ postId?: string; } @@ -1556,19 +1569,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to containing the comment. + * */ blogId?: string; /** - * The ID of the comment to get. + * */ commentId?: string; /** - * ID of the post to fetch posts from. + * */ postId?: string; /** - * Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation. + * */ view?: string; } @@ -1579,39 +1592,39 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch comments from. + * */ blogId?: string; /** - * Latest date of comment to fetch, a date-time with RFC 3339 formatting. + * */ endDate?: string; /** - * Whether the body content of the comments is included. + * */ fetchBodies?: boolean; /** - * Maximum number of comments to include in the result. + * */ maxResults?: number; /** - * Continuation token if request is paged. + * */ pageToken?: string; /** - * ID of the post to fetch posts from. + * */ postId?: string; /** - * Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * */ startDate?: string; /** * */ - status?: string[]; + status?: string; /** - * Access level with which to view the returned result. Note that some fields require elevated access. + * */ view?: string; } @@ -1623,27 +1636,27 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch comments from. + * */ blogId?: string; /** - * Latest date of comment to fetch, a date-time with RFC 3339 formatting. + * */ endDate?: string; /** - * Whether the body content of the comments is included. + * */ fetchBodies?: boolean; /** - * Maximum number of comments to include in the result. + * */ maxResults?: number; /** - * Continuation token if request is paged. + * */ pageToken?: string; /** - * Earliest date of comment to fetch, a date-time with RFC 3339 formatting. + * */ startDate?: string; /** @@ -1659,15 +1672,15 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the comment to mark as spam. + * */ commentId?: string; /** - * The ID of the Post. + * */ postId?: string; } @@ -1679,15 +1692,15 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the comment to delete content from. + * */ commentId?: string; /** - * The ID of the Post. + * */ postId?: string; } @@ -1700,13 +1713,13 @@ export namespace blogger_v3 { /** * blogger.pages.delete - * @desc Delete a page by ID. + * @desc Deletes a page by blog id and page id. * @alias blogger.pages.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.pageId The ID of the Page. + * @param {string} params.blogId + * @param {string} params.pageId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1746,13 +1759,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/pages/{pageId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/pages/{pageId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'DELETE', }, options @@ -1771,13 +1785,13 @@ export namespace blogger_v3 { /** * blogger.pages.get - * @desc Gets one blog page by ID. + * @desc Gets a page by blog id and page id. * @alias blogger.pages.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog containing the page. - * @param {string} params.pageId The ID of the page to get. + * @param {string} params.blogId + * @param {string} params.pageId * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1818,13 +1832,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/pages/{pageId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/pages/{pageId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -1843,13 +1858,13 @@ export namespace blogger_v3 { /** * blogger.pages.insert - * @desc Add a page. + * @desc Inserts a page. * @alias blogger.pages.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to add the page to. - * @param {boolean=} params.isDraft Whether to create the page as a draft (default: false). + * @param {string} params.blogId + * @param {boolean=} params.isDraft * @param {().Page} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1890,11 +1905,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/pages').replace( + url: (rootUrl + '/v3/blogs/{blogId}/pages').replace( /([^:]\/)\/+/g, '$1' ), @@ -1916,17 +1931,17 @@ export namespace blogger_v3 { /** * blogger.pages.list - * @desc Retrieves the pages for a blog, optionally including non-LIVE statuses. + * @desc Lists pages. * @alias blogger.pages.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch Pages from. - * @param {boolean=} params.fetchBodies Whether to retrieve the Page bodies. - * @param {integer=} params.maxResults Maximum number of Pages to fetch. - * @param {string=} params.pageToken Continuation token if the request is paged. + * @param {string} params.blogId + * @param {boolean=} params.fetchBodies + * @param {integer=} params.maxResults + * @param {string=} params.pageToken * @param {string=} params.status - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1966,11 +1981,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/pages').replace( + url: (rootUrl + '/v3/blogs/{blogId}/pages').replace( /([^:]\/)\/+/g, '$1' ), @@ -1992,15 +2007,15 @@ export namespace blogger_v3 { /** * blogger.pages.patch - * @desc Update a page. This method supports patch semantics. + * @desc Patches a page. * @alias blogger.pages.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.pageId The ID of the Page. - * @param {boolean=} params.publish Whether a publish action should be performed when the page is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the page is updated (default: false). + * @param {string} params.blogId + * @param {string} params.pageId + * @param {boolean=} params.publish + * @param {boolean=} params.revert * @param {().Page} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2041,13 +2056,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/pages/{pageId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/pages/{pageId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'PATCH', }, options @@ -2066,13 +2082,13 @@ export namespace blogger_v3 { /** * blogger.pages.publish - * @desc Publishes a draft page. + * @desc Publishes a page. * @alias blogger.pages.publish * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the blog. - * @param {string} params.pageId The ID of the page. + * @param {string} params.blogId + * @param {string} params.pageId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2112,12 +2128,12 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/pages/{pageId}/publish' + rootUrl + '/v3/blogs/{blogId}/pages/{pageId}/publish' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -2137,13 +2153,13 @@ export namespace blogger_v3 { /** * blogger.pages.revert - * @desc Revert a published or scheduled page to draft state. + * @desc Reverts a published or scheduled page to draft state. * @alias blogger.pages.revert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the blog. - * @param {string} params.pageId The ID of the page. + * @param {string} params.blogId + * @param {string} params.pageId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2183,13 +2199,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/pages/{pageId}/revert' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/pages/{pageId}/revert').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options @@ -2208,15 +2225,15 @@ export namespace blogger_v3 { /** * blogger.pages.update - * @desc Update a page. + * @desc Updates a page by blog id and page id. * @alias blogger.pages.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.pageId The ID of the Page. - * @param {boolean=} params.publish Whether a publish action should be performed when the page is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the page is updated (default: false). + * @param {string} params.blogId + * @param {string} params.pageId + * @param {boolean=} params.publish + * @param {boolean=} params.revert * @param {().Page} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2257,13 +2274,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/pages/{pageId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/pages/{pageId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'PUT', }, options @@ -2288,11 +2306,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the Page. + * */ pageId?: string; } @@ -2303,11 +2321,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog containing the page. + * */ blogId?: string; /** - * The ID of the page to get. + * */ pageId?: string; /** @@ -2322,11 +2340,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to add the page to. + * */ blogId?: string; /** - * Whether to create the page as a draft (default: false). + * */ isDraft?: boolean; @@ -2342,19 +2360,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch Pages from. + * */ blogId?: string; /** - * Whether to retrieve the Page bodies. + * */ fetchBodies?: boolean; /** - * Maximum number of Pages to fetch. + * */ maxResults?: number; /** - * Continuation token if the request is paged. + * */ pageToken?: string; /** @@ -2362,7 +2380,7 @@ export namespace blogger_v3 { */ status?: string[]; /** - * Access level with which to view the returned result. Note that some fields require elevated access. + * */ view?: string; } @@ -2373,19 +2391,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the Page. + * */ pageId?: string; /** - * Whether a publish action should be performed when the page is updated (default: false). + * */ publish?: boolean; /** - * Whether a revert action should be performed when the page is updated (default: false). + * */ revert?: boolean; @@ -2401,11 +2419,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the blog. + * */ blogId?: string; /** - * The ID of the page. + * */ pageId?: string; } @@ -2416,11 +2434,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the blog. + * */ blogId?: string; /** - * The ID of the page. + * */ pageId?: string; } @@ -2431,19 +2449,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the Page. + * */ pageId?: string; /** - * Whether a publish action should be performed when the page is updated (default: false). + * */ publish?: boolean; /** - * Whether a revert action should be performed when the page is updated (default: false). + * */ revert?: boolean; @@ -2461,12 +2479,12 @@ export namespace blogger_v3 { /** * blogger.pageViews.get - * @desc Retrieve pageview stats for a Blog. + * @desc Gets page views by blog id. * @alias blogger.pageViews.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the blog to get. + * @param {string} params.blogId * @param {string=} params.range * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2509,11 +2527,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/pageviews').replace( + url: (rootUrl + '/v3/blogs/{blogId}/pageviews').replace( /([^:]\/)\/+/g, '$1' ), @@ -2541,7 +2559,7 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the blog to get. + * */ blogId?: string; /** @@ -2558,13 +2576,13 @@ export namespace blogger_v3 { /** * blogger.posts.delete - * @desc Delete a post by ID. + * @desc Deletes a post by blog id and post id. * @alias blogger.posts.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.postId The ID of the Post. + * @param {string} params.blogId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2604,13 +2622,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/posts/{postId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/posts/{postId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'DELETE', }, options @@ -2629,17 +2648,17 @@ export namespace blogger_v3 { /** * blogger.posts.get - * @desc Get a post by ID. + * @desc Gets a post by blog id and post id * @alias blogger.posts.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch the post from. - * @param {boolean=} params.fetchBody Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included (default: false). - * @param {integer=} params.maxComments Maximum number of comments to pull back on a post. - * @param {string} params.postId The ID of the post - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. + * @param {string} params.blogId + * @param {boolean=} params.fetchBody + * @param {boolean=} params.fetchImages + * @param {integer=} params.maxComments + * @param {string} params.postId + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2679,13 +2698,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/posts/{postId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/posts/{postId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -2704,15 +2724,15 @@ export namespace blogger_v3 { /** * blogger.posts.getByPath - * @desc Retrieve a Post by Path. + * @desc Gets a post by path. * @alias blogger.posts.getByPath * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch the post from. - * @param {integer=} params.maxComments Maximum number of comments to pull back on a post. - * @param {string} params.path Path of the Post to retrieve. - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. + * @param {string} params.blogId + * @param {integer=} params.maxComments + * @param {string} params.path + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2752,11 +2772,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/posts/bypath').replace( + url: (rootUrl + '/v3/blogs/{blogId}/posts/bypath').replace( /([^:]\/)\/+/g, '$1' ), @@ -2778,15 +2798,15 @@ export namespace blogger_v3 { /** * blogger.posts.insert - * @desc Add a post. + * @desc Inserts a post. * @alias blogger.posts.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to add the post to. - * @param {boolean=} params.fetchBody Whether the body content of the post is included with the result (default: true). - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included in the returned result (default: false). - * @param {boolean=} params.isDraft Whether to create the post as a draft (default: false). + * @param {string} params.blogId + * @param {boolean=} params.fetchBody + * @param {boolean=} params.fetchImages + * @param {boolean=} params.isDraft * @param {().Post} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2827,11 +2847,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/posts').replace( + url: (rootUrl + '/v3/blogs/{blogId}/posts').replace( /([^:]\/)\/+/g, '$1' ), @@ -2853,22 +2873,22 @@ export namespace blogger_v3 { /** * blogger.posts.list - * @desc Retrieves a list of posts, possibly filtered. + * @desc Lists posts. * @alias blogger.posts.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch posts from. - * @param {string=} params.endDate Latest post date to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included. - * @param {string=} params.labels Comma-separated list of labels to search for. - * @param {integer=} params.maxResults Maximum number of posts to fetch. - * @param {string=} params.orderBy Sort search results - * @param {string=} params.pageToken Continuation token if the request is paged. - * @param {string=} params.startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. - * @param {string=} params.status Statuses to include in the results. - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require escalated access. + * @param {string} params.blogId + * @param {string=} params.endDate + * @param {boolean=} params.fetchBodies + * @param {boolean=} params.fetchImages + * @param {string=} params.labels + * @param {integer=} params.maxResults + * @param {string=} params.orderBy + * @param {string=} params.pageToken + * @param {string=} params.startDate + * @param {string=} params.status + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2908,11 +2928,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/posts').replace( + url: (rootUrl + '/v3/blogs/{blogId}/posts').replace( /([^:]\/)\/+/g, '$1' ), @@ -2934,18 +2954,18 @@ export namespace blogger_v3 { /** * blogger.posts.patch - * @desc Update a post. This method supports patch semantics. + * @desc Patches a post. * @alias blogger.posts.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {boolean=} params.fetchBody Whether the body content of the post is included with the result (default: true). - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included in the returned result (default: false). - * @param {integer=} params.maxComments Maximum number of comments to retrieve with the returned post. - * @param {string} params.postId The ID of the Post. - * @param {boolean=} params.publish Whether a publish action should be performed when the post is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the post is updated (default: false). + * @param {string} params.blogId + * @param {boolean=} params.fetchBody + * @param {boolean=} params.fetchImages + * @param {integer=} params.maxComments + * @param {string} params.postId + * @param {boolean=} params.publish + * @param {boolean=} params.revert * @param {().Post} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2986,13 +3006,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/posts/{postId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/posts/{postId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'PATCH', }, options @@ -3011,14 +3032,14 @@ export namespace blogger_v3 { /** * blogger.posts.publish - * @desc Publishes a draft post, optionally at the specific time of the given publishDate parameter. + * @desc Publishes a post. * @alias blogger.posts.publish * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.postId The ID of the Post. - * @param {string=} params.publishDate Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published. + * @param {string} params.blogId + * @param {string} params.postId + * @param {string=} params.publishDate * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3058,12 +3079,12 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/posts/{postId}/publish' + rootUrl + '/v3/blogs/{blogId}/posts/{postId}/publish' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -3083,13 +3104,13 @@ export namespace blogger_v3 { /** * blogger.posts.revert - * @desc Revert a published or scheduled post to draft state. + * @desc Reverts a published or scheduled post to draft state. * @alias blogger.posts.revert * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {string} params.postId The ID of the Post. + * @param {string} params.blogId + * @param {string} params.postId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3129,13 +3150,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/posts/{postId}/revert' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/posts/{postId}/revert').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options @@ -3154,15 +3176,15 @@ export namespace blogger_v3 { /** * blogger.posts.search - * @desc Search for a post. + * @desc Searches for posts matching given query terms in the specified blog. * @alias blogger.posts.search * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch the post from. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. - * @param {string=} params.orderBy Sort search results - * @param {string} params.q Query terms to search this blog for matching posts. + * @param {string} params.blogId + * @param {boolean=} params.fetchBodies + * @param {string=} params.orderBy + * @param {string} params.q * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3202,11 +3224,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/blogs/{blogId}/posts/search').replace( + url: (rootUrl + '/v3/blogs/{blogId}/posts/search').replace( /([^:]\/)\/+/g, '$1' ), @@ -3228,18 +3250,18 @@ export namespace blogger_v3 { /** * blogger.posts.update - * @desc Update a post. + * @desc Updates a post by blog id and post id. * @alias blogger.posts.update * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the Blog. - * @param {boolean=} params.fetchBody Whether the body content of the post is included with the result (default: true). - * @param {boolean=} params.fetchImages Whether image URL metadata for each post is included in the returned result (default: false). - * @param {integer=} params.maxComments Maximum number of comments to retrieve with the returned post. - * @param {string} params.postId The ID of the Post. - * @param {boolean=} params.publish Whether a publish action should be performed when the post is updated (default: false). - * @param {boolean=} params.revert Whether a revert action should be performed when the post is updated (default: false). + * @param {string} params.blogId + * @param {boolean=} params.fetchBody + * @param {boolean=} params.fetchImages + * @param {integer=} params.maxComments + * @param {string} params.postId + * @param {boolean=} params.publish + * @param {boolean=} params.revert * @param {().Post} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3280,13 +3302,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/blogs/{blogId}/posts/{postId}' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/blogs/{blogId}/posts/{postId}').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'PUT', }, options @@ -3311,11 +3334,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the Post. + * */ postId?: string; } @@ -3326,27 +3349,27 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch the post from. + * */ blogId?: string; /** - * Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. + * */ fetchBody?: boolean; /** - * Whether image URL metadata for each post is included (default: false). + * */ fetchImages?: boolean; /** - * Maximum number of comments to pull back on a post. + * */ maxComments?: number; /** - * The ID of the post + * */ postId?: string; /** - * Access level with which to view the returned result. Note that some fields require elevated access. + * */ view?: string; } @@ -3357,19 +3380,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch the post from. + * */ blogId?: string; /** - * Maximum number of comments to pull back on a post. + * */ maxComments?: number; /** - * Path of the Post to retrieve. + * */ path?: string; /** - * Access level with which to view the returned result. Note that some fields require elevated access. + * */ view?: string; } @@ -3380,19 +3403,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to add the post to. + * */ blogId?: string; /** - * Whether the body content of the post is included with the result (default: true). + * */ fetchBody?: boolean; /** - * Whether image URL metadata for each post is included in the returned result (default: false). + * */ fetchImages?: boolean; /** - * Whether to create the post as a draft (default: false). + * */ isDraft?: boolean; @@ -3408,47 +3431,47 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch posts from. + * */ blogId?: string; /** - * Latest post date to fetch, a date-time with RFC 3339 formatting. + * */ endDate?: string; /** - * Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. + * */ fetchBodies?: boolean; /** - * Whether image URL metadata for each post is included. + * */ fetchImages?: boolean; /** - * Comma-separated list of labels to search for. + * */ labels?: string; /** - * Maximum number of posts to fetch. + * */ maxResults?: number; /** - * Sort search results + * */ orderBy?: string; /** - * Continuation token if the request is paged. + * */ pageToken?: string; /** - * Earliest post date to fetch, a date-time with RFC 3339 formatting. + * */ startDate?: string; /** - * Statuses to include in the results. + * */ status?: string[]; /** - * Access level with which to view the returned result. Note that some fields require escalated access. + * */ view?: string; } @@ -3459,31 +3482,31 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * Whether the body content of the post is included with the result (default: true). + * */ fetchBody?: boolean; /** - * Whether image URL metadata for each post is included in the returned result (default: false). + * */ fetchImages?: boolean; /** - * Maximum number of comments to retrieve with the returned post. + * */ maxComments?: number; /** - * The ID of the Post. + * */ postId?: string; /** - * Whether a publish action should be performed when the post is updated (default: false). + * */ publish?: boolean; /** - * Whether a revert action should be performed when the post is updated (default: false). + * */ revert?: boolean; @@ -3499,15 +3522,15 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the Post. + * */ postId?: string; /** - * Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published. + * */ publishDate?: string; } @@ -3518,11 +3541,11 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * The ID of the Post. + * */ postId?: string; } @@ -3533,19 +3556,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch the post from. + * */ blogId?: string; /** - * Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic. + * */ fetchBodies?: boolean; /** - * Sort search results + * */ orderBy?: string; /** - * Query terms to search this blog for matching posts. + * */ q?: string; } @@ -3556,31 +3579,31 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the Blog. + * */ blogId?: string; /** - * Whether the body content of the post is included with the result (default: true). + * */ fetchBody?: boolean; /** - * Whether image URL metadata for each post is included in the returned result (default: false). + * */ fetchImages?: boolean; /** - * Maximum number of comments to retrieve with the returned post. + * */ maxComments?: number; /** - * The ID of the Post. + * */ postId?: string; /** - * Whether a publish action should be performed when the post is updated (default: false). + * */ publish?: boolean; /** - * Whether a revert action should be performed when the post is updated (default: false). + * */ revert?: boolean; @@ -3598,15 +3621,15 @@ export namespace blogger_v3 { /** * blogger.postUserInfos.get - * @desc Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user. + * @desc Gets one post and user info pair, by post_id and user_id. * @alias blogger.postUserInfos.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId The ID of the blog. - * @param {integer=} params.maxComments Maximum number of comments to pull back on a post. - * @param {string} params.postId The ID of the post to get. - * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. + * @param {string} params.blogId + * @param {integer=} params.maxComments + * @param {string} params.postId + * @param {string} params.userId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3649,13 +3672,12 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { url: ( - rootUrl + - '/blogger/v3/users/{userId}/blogs/{blogId}/posts/{postId}' + rootUrl + '/v3/users/{userId}/blogs/{blogId}/posts/{postId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3675,22 +3697,22 @@ export namespace blogger_v3 { /** * blogger.postUserInfos.list - * @desc Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user. + * @desc Lists post and user info pairs. * @alias blogger.postUserInfos.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.blogId ID of the blog to fetch posts from. - * @param {string=} params.endDate Latest post date to fetch, a date-time with RFC 3339 formatting. - * @param {boolean=} params.fetchBodies Whether the body content of posts is included. Default is false. - * @param {string=} params.labels Comma-separated list of labels to search for. - * @param {integer=} params.maxResults Maximum number of posts to fetch. - * @param {string=} params.orderBy Sort order applied to search results. Default is published. - * @param {string=} params.pageToken Continuation token if the request is paged. - * @param {string=} params.startDate Earliest post date to fetch, a date-time with RFC 3339 formatting. + * @param {string} params.blogId + * @param {string=} params.endDate + * @param {boolean=} params.fetchBodies + * @param {string=} params.labels + * @param {integer=} params.maxResults + * @param {string=} params.orderBy + * @param {string=} params.pageToken + * @param {string=} params.startDate * @param {string=} params.status - * @param {string} params.userId ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. - * @param {string=} params.view Access level with which to view the returned result. Note that some fields require elevated access. + * @param {string} params.userId + * @param {string=} params.view * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3733,13 +3755,14 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: ( - rootUrl + '/blogger/v3/users/{userId}/blogs/{blogId}/posts' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v3/users/{userId}/blogs/{blogId}/posts').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -3765,19 +3788,19 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the blog. + * */ blogId?: string; /** - * Maximum number of comments to pull back on a post. + * */ maxComments?: number; /** - * The ID of the post to get. + * */ postId?: string; /** - * ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. + * */ userId?: string; } @@ -3789,35 +3812,35 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * ID of the blog to fetch posts from. + * */ blogId?: string; /** - * Latest post date to fetch, a date-time with RFC 3339 formatting. + * */ endDate?: string; /** - * Whether the body content of posts is included. Default is false. + * */ fetchBodies?: boolean; /** - * Comma-separated list of labels to search for. + * */ labels?: string; /** - * Maximum number of posts to fetch. + * */ maxResults?: number; /** - * Sort order applied to search results. Default is published. + * */ orderBy?: string; /** - * Continuation token if the request is paged. + * */ pageToken?: string; /** - * Earliest post date to fetch, a date-time with RFC 3339 formatting. + * */ startDate?: string; /** @@ -3825,11 +3848,11 @@ export namespace blogger_v3 { */ status?: string[]; /** - * ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier. + * */ userId?: string; /** - * Access level with which to view the returned result. Note that some fields require elevated access. + * */ view?: string; } @@ -3842,12 +3865,12 @@ export namespace blogger_v3 { /** * blogger.users.get - * @desc Gets one user by ID. + * @desc Gets one user by user_id. * @alias blogger.users.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The ID of the user to get. + * @param {string} params.userId * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3887,14 +3910,11 @@ export namespace blogger_v3 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://blogger.googleapis.com/'; const parameters = { options: Object.assign( { - url: (rootUrl + '/blogger/v3/users/{userId}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v3/users/{userId}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -3919,7 +3939,7 @@ export namespace blogger_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the user to get. + * */ userId?: string; } diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index f0358ddbdf4..16cc17243d9 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -379,7 +379,7 @@ export namespace calendar_v3 { */ conferenceId?: string | null; /** - * The conference solution, such as Hangouts or Hangouts Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required. + * The conference solution, such as Hangouts or Google Meet. Unset for a conference with a failed create request. Either conferenceSolution and at least one entryPoint, or createRequest is required. */ conferenceSolution?: Schema$ConferenceSolution; /** @@ -446,7 +446,7 @@ export namespace calendar_v3 { } export interface Schema$CreateConferenceRequest { /** - * The conference solution, such as Hangouts or Hangouts Meet. + * The conference solution, such as Hangouts or Google Meet. */ conferenceSolutionKey?: Schema$ConferenceSolutionKey; /** @@ -532,7 +532,7 @@ export namespace calendar_v3 { */ colorId?: string | null; /** - * The conference-related information, such as details of a Hangouts Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. + * The conference-related information, such as details of a Google Meet conference. To create new conference details use the createRequest field. To persist your changes, remember to set the conferenceDataVersion request parameter to 1 for all event modification requests. */ conferenceData?: Schema$ConferenceData; /** diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index f9f62770526..c88843f383e 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -150,7 +150,7 @@ export namespace classroom_v1 { */ id?: string | null; /** - * Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be able to see the announcement. + * Identifiers of students with access to the announcement. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the announcement. */ individualStudentsOptions?: Schema$IndividualStudentsOptions; /** @@ -188,7 +188,7 @@ export namespace classroom_v1 { */ export interface Schema$AssignmentSubmission { /** - * Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (e.g. title) may not be. + * Attachments added by the student. Drive files that correspond to materials with a share mode of STUDENT_COPY may not exist yet if the student has not accessed the assignment in Classroom. Some attachment metadata is only populated if the requesting user has permission to access it. Identifier and alternate_link fields are always available, but others (for example, title) may not be. */ attachments?: Schema$Attachment[]; } @@ -368,7 +368,7 @@ export namespace classroom_v1 { */ assignment?: Schema$Assignment; /** - * Whether this course work item is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only. + * Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. */ associatedWithDeveloper?: boolean | null; /** @@ -400,7 +400,7 @@ export namespace classroom_v1 { */ id?: string | null; /** - * Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field will be assigned the coursework. + * Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. */ individualStudentsOptions?: Schema$IndividualStudentsOptions; /** @@ -833,7 +833,7 @@ export namespace classroom_v1 { */ form?: Schema$Form; /** - * Link material. On creation, will be upgraded to a more appropriate type if possible, and this will be reflected in the response. + * Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. */ link?: Schema$Link; /** @@ -846,7 +846,7 @@ export namespace classroom_v1 { */ export interface Schema$ModifyAnnouncementAssigneesRequest { /** - * Mode of the announcement describing whether it will be accessible by all students or specified individual students. + * Mode of the announcement describing whether it is accessible by all students or specified individual students. */ assigneeMode?: string | null; /** @@ -881,11 +881,11 @@ export namespace classroom_v1 { */ export interface Schema$ModifyIndividualStudentsOptions { /** - * Ids of students to be added as having access to this coursework/announcement. + * IDs of students to be added as having access to this coursework/announcement. */ addStudentIds?: string[] | null; /** - * Ids of students to be removed from having access to this coursework/announcement. + * IDs of students to be removed from having access to this coursework/announcement. */ removeStudentIds?: string[] | null; } @@ -980,7 +980,7 @@ export namespace classroom_v1 { */ export interface Schema$StateHistory { /** - * The teacher or student who made the change + * The teacher or student who made the change. */ actorUserId?: string | null; /** @@ -1022,15 +1022,15 @@ export namespace classroom_v1 { */ alternateLink?: string | null; /** - * Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This may be modified only by course teachers. + * Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This may be modified only by course teachers. */ assignedGrade?: number | null; /** - * Submission content when course_work_type is ASSIGNMENT. Students can modify this content using google.classroom.Work.ModifyAttachments. + * Submission content when course_work_type is ASSIGNMENT. Students can modify this content using ModifyAttachments. */ assignmentSubmission?: Schema$AssignmentSubmission; /** - * Whether this student submission is associated with the Developer Console project making the request. See google.classroom.Work.CreateCourseWork for more details. Read-only. + * Whether this student submission is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. */ associatedWithDeveloper?: boolean | null; /** @@ -1050,7 +1050,7 @@ export namespace classroom_v1 { */ creationTime?: string | null; /** - * Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places. This is only visible to and modifiable by course teachers. + * Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (that is, non-integer) values are allowed, but are rounded to two decimal places. This is only visible to and modifiable by course teachers. */ draftGrade?: number | null; /** @@ -1146,7 +1146,7 @@ export namespace classroom_v1 { */ courseId?: string | null; /** - * The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters. + * The name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters. */ name?: string | null; /** @@ -1187,7 +1187,7 @@ export namespace classroom_v1 { */ photoUrl?: string | null; /** - * Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field will always be false. Read-only + * Represents whether a G Suite for Education user's domain administrator has explicitly verified them as being a teacher. If the user is not a member of a G Suite for Education domain, than this field is always false. Read-only */ verifiedTeacher?: boolean | null; } @@ -2435,7 +2435,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.id Identifier of the announcement. - * @param {string=} params.updateMask Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` + * @param {string=} params.updateMask Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` * @param {().Announcement} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2617,7 +2617,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` + * Mask that identifies which fields on the announcement to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Announcement object. If a field that does not support empty values is included in the update mask and not set in the Announcement object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `text` * `state` * `scheduled_time` */ updateMask?: string; @@ -3024,7 +3024,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.id Identifier of the course work. - * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` + * @param {string=} params.updateMask Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * @param {().CourseWork} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3207,7 +3207,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` + * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the CourseWork object. If a field that does not support empty values is included in the update mask and not set in the CourseWork object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` */ updateMask?: string; @@ -5020,7 +5020,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.courseId Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. * @param {string} params.id Identifier of the topic. - * @param {string=} params.updateMask Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified: * `name` + * @param {string=} params.updateMask Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name` * @param {().Topic} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5172,7 +5172,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error will be returned. The following fields may be specified: * `name` + * Mask that identifies which fields on the topic to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the Topic object. If a field that does not support empty values is included in the update mask and not set in the Topic object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified: * `name` */ updateMask?: string; @@ -6058,10 +6058,10 @@ export namespace classroom_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.invitedEmailAddress If specified, only results with the specified `invited_email_address` will be returned. + * @param {string=} params.invitedEmailAddress If specified, only results with the specified `invited_email_address` are returned. * @param {integer=} params.pageSize Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. * @param {string=} params.pageToken nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. - * @param {string=} params.states If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned. + * @param {string=} params.states If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. * @param {string} params.studentId The ID of the student whose guardian invitations are to be returned. The identifier can be one of the following: * the numeric identifier for the user * the email address of the user * the string literal `"me"`, indicating the requesting user * the string literal `"-"`, indicating that results should be returned for all students that the requesting user is permitted to view guardian invitations. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6146,7 +6146,7 @@ export namespace classroom_v1 { * @param {object} params Parameters for request * @param {string} params.invitationId The `id` field of the `GuardianInvitation` to be modified. * @param {string} params.studentId The ID of the student whose guardian invitation is to be modified. - * @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` + * @param {string=} params.updateMask Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` * @param {().GuardianInvitation} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6256,7 +6256,7 @@ export namespace classroom_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If specified, only results with the specified `invited_email_address` will be returned. + * If specified, only results with the specified `invited_email_address` are returned. */ invitedEmailAddress?: string; /** @@ -6268,7 +6268,7 @@ export namespace classroom_v1 { */ pageToken?: string; /** - * If specified, only results with the specified `state` values will be returned. Otherwise, results with a `state` of `PENDING` will be returned. + * If specified, only results with the specified `state` values are returned. Otherwise, results with a `state` of `PENDING` are returned. */ states?: string[]; /** @@ -6292,7 +6292,7 @@ export namespace classroom_v1 { */ studentId?: string; /** - * Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` + * Mask that identifies which fields on the course to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields are valid: * `state` When set in a query parameter, this field should be specified as `updateMask=,,...` */ updateMask?: string; diff --git a/src/apis/cloudasset/index.ts b/src/apis/cloudasset/index.ts index 3dd53753bfc..27a39da92b0 100644 --- a/src/apis/cloudasset/index.ts +++ b/src/apis/cloudasset/index.ts @@ -17,11 +17,13 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {cloudasset_v1} from './v1'; import {cloudasset_v1beta1} from './v1beta1'; import {cloudasset_v1p1beta1} from './v1p1beta1'; +import {cloudasset_v1p4beta1} from './v1p4beta1'; export const VERSIONS = { v1: cloudasset_v1.Cloudasset, v1beta1: cloudasset_v1beta1.Cloudasset, v1p1beta1: cloudasset_v1p1beta1.Cloudasset, + v1p4beta1: cloudasset_v1p4beta1.Cloudasset, }; export function cloudasset(version: 'v1'): cloudasset_v1.Cloudasset; @@ -38,11 +40,18 @@ export function cloudasset( export function cloudasset( options: cloudasset_v1p1beta1.Options ): cloudasset_v1p1beta1.Cloudasset; +export function cloudasset( + version: 'v1p4beta1' +): cloudasset_v1p4beta1.Cloudasset; +export function cloudasset( + options: cloudasset_v1p4beta1.Options +): cloudasset_v1p4beta1.Cloudasset; export function cloudasset< T = | cloudasset_v1.Cloudasset | cloudasset_v1beta1.Cloudasset | cloudasset_v1p1beta1.Cloudasset + | cloudasset_v1p4beta1.Cloudasset >( this: GoogleConfigurable, versionOrOptions: @@ -52,6 +61,8 @@ export function cloudasset< | cloudasset_v1beta1.Options | 'v1p1beta1' | cloudasset_v1p1beta1.Options + | 'v1p4beta1' + | cloudasset_v1p4beta1.Options ) { return getAPI('cloudasset', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/cloudasset/v1p1beta1.ts b/src/apis/cloudasset/v1p1beta1.ts index 0f5e50066dd..c10da10bcb0 100644 --- a/src/apis/cloudasset/v1p1beta1.ts +++ b/src/apis/cloudasset/v1p1beta1.ts @@ -317,7 +317,7 @@ export namespace cloudasset_v1p1beta1 { * @param {integer=} params.pageSize Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as `next_page_token` is returned. * @param {string=} params.pageToken Optional. If present, retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters must be identical to those in the previous call. * @param {string=} params.query Optional. The query statement. Examples: * "policy:myuser@mydomain.com" * "policy:(myuser@mydomain.com viewer)" - * @param {string} params.scope Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") + * @param {string} params.scope Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") * Project id (such as "projects/abc") * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -413,7 +413,7 @@ export namespace cloudasset_v1p1beta1 { */ query?: string; /** - * Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") + * Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") * Project id (such as "projects/abc") */ scope?: string; } @@ -436,7 +436,7 @@ export namespace cloudasset_v1p1beta1 { * @param {integer=} params.pageSize Optional. The page size for search result pagination. Page size is capped at 500 even if a larger value is given. If set to zero, server will pick an appropriate default. Returned results may be fewer than requested. When this happens, there could be more results as long as `next_page_token` is returned. * @param {string=} params.pageToken Optional. If present, then retrieve the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of all other method parameters, must be identical to those in the previous call. * @param {string=} params.query Optional. The query statement. - * @param {string} params.scope Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") + * @param {string} params.scope Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") * Project id (such as "projects/abc") * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -539,7 +539,7 @@ export namespace cloudasset_v1p1beta1 { */ query?: string; /** - * Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") + * Required. The relative name of an asset. The search is limited to the resources within the `scope`. The allowed value must be: * Organization number (such as "organizations/123") * Folder number(such as "folders/1234") * Project number (such as "projects/12345") * Project id (such as "projects/abc") */ scope?: string; } diff --git a/src/apis/cloudasset/v1p4beta1.ts b/src/apis/cloudasset/v1p4beta1.ts new file mode 100644 index 00000000000..a492b9ccbad --- /dev/null +++ b/src/apis/cloudasset/v1p4beta1.ts @@ -0,0 +1,719 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace cloudasset_v1p4beta1 { + export interface Options extends GlobalOptions { + version: 'v1p4beta1'; + } + + 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 Asset API + * + * The cloud asset API manages the history and inventory of cloud resources. + * + * @example + * const {google} = require('googleapis'); + * const cloudasset = google.cloudasset('v1p4beta1'); + * + * @namespace cloudasset + * @type {Function} + * @version v1p4beta1 + * @variation v1p4beta1 + * @param {object=} options Options for Cloudasset + */ + export class Cloudasset { + context: APIRequestContext; + v1p4beta1: Resource$V1p4beta1; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.v1p4beta1 = new Resource$V1p4beta1(this.context); + } + } + + /** + * Specifies roles and/or permissions to analyze, to determine both the identities possessing them and the resources they control. If multiple values are specified, results will include identities and resources matching any of them. + */ + export interface Schema$AccessSelector { + /** + * Optional. The permissions to appear in result. + */ + permissions?: string[] | null; + /** + * Optional. The roles to appear in result. + */ + roles?: string[] | null; + } + /** + * A response message for AssetService.AnalyzeIamPolicy. + */ + export interface Schema$AnalyzeIamPolicyResponse { + /** + * Represents whether all entries in the main_analysis and service_account_impersonation_analysis have been fully explored to answer the query in the request. + */ + fullyExplored?: boolean | null; + /** + * The main analysis that matches the original request. + */ + mainAnalysis?: Schema$IamPolicyAnalysis; + /** + * A list of non-critical errors happened during the request handling to explain why `fully_explored` is false, or empty if no error happened. + */ + nonCriticalErrors?: Schema$GoogleCloudAssetV1p4beta1AnalysisState[]; + /** + * The service account impersonation analysis if AnalyzeIamPolicyRequest.analyze_service_account_impersonation is enabled. + */ + serviceAccountImpersonationAnalysis?: Schema$IamPolicyAnalysis[]; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[] | null; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } + /** + * A request message for AssetService.ExportIamPolicyAnalysis. + */ + export interface Schema$ExportIamPolicyAnalysisRequest { + /** + * Required. The request query. + */ + analysisQuery?: Schema$IamPolicyAnalysisQuery; + /** + * Optional. The request options. + */ + options?: Schema$Options; + /** + * Required. Output configuration indicating where the results will be output to. + */ + outputConfig?: Schema$IamPolicyAnalysisOutputConfig; + } + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + /** + * A Cloud Storage location. + */ + export interface Schema$GcsDestination { + /** + * Required. The uri of the Cloud Storage object. It's the same uri that is used by gsutil. For example: "gs://bucket_name/object_name". See [Viewing and Editing Object Metadata](https://cloud.google.com/storage/docs/viewing-editing-metadata) for more information. + */ + uri?: string | null; + } + /** + * A role or permission that appears in an access control list. + */ + export interface Schema$GoogleCloudAssetV1p4beta1Access { + /** + * The analysis state of this access node. + */ + analysisState?: Schema$GoogleCloudAssetV1p4beta1AnalysisState; + /** + * The permission. + */ + permission?: string | null; + /** + * The role. + */ + role?: string | null; + } + /** + * An access control list, derived from the above IAM policy binding, which contains a set of resources and accesses. May include one item from each set to compose an access control entry. NOTICE that there could be multiple access control lists for one IAM policy binding. The access control lists are created based on resource and access combinations. For example, assume we have the following cases in one IAM policy binding: - Permission P1 and P2 apply to resource R1 and R2; - Permission P3 applies to resource R2 and R3; This will result in the following access control lists: - AccessControlList 1: [R1, R2], [P1, P2] - AccessControlList 2: [R2, R3], [P3] + */ + export interface Schema$GoogleCloudAssetV1p4beta1AccessControlList { + /** + * The accesses that match one of the following conditions: - The access_selector, if it is specified in request; - Otherwise, access specifiers reachable from the policy binding's role. + */ + accesses?: Schema$GoogleCloudAssetV1p4beta1Access[]; + /** + * Resource edges of the graph starting from the policy attached resource to any descendant resources. The Edge.source_node contains the full resource name of a parent resource and Edge.target_node contains the full resource name of a child resource. This field is present only if the output_resource_edges option is enabled in request. + */ + resourceEdges?: Schema$GoogleCloudAssetV1p4beta1Edge[]; + /** + * The resources that match one of the following conditions: - The resource_selector, if it is specified in request; - Otherwise, resources reachable from the policy attached resource. + */ + resources?: Schema$GoogleCloudAssetV1p4beta1Resource[]; + } + /** + * Represents analysis state of each node in the result graph or non-critical errors in the response. + */ + export interface Schema$GoogleCloudAssetV1p4beta1AnalysisState { + /** + * The human-readable description of the cause of failure. + */ + cause?: string | null; + /** + * The Google standard error code that best describes the state. For example: - OK means the node has been successfully explored; - PERMISSION_DENIED means an access denied error is encountered; - DEADLINE_EXCEEDED means the node hasn't been explored in time; + */ + code?: string | null; + } + /** + * A directional edge. + */ + export interface Schema$GoogleCloudAssetV1p4beta1Edge { + /** + * The source node of the edge. + */ + sourceNode?: string | null; + /** + * The target node of the edge. + */ + targetNode?: string | null; + } + /** + * An identity that appears in an access control list. + */ + export interface Schema$GoogleCloudAssetV1p4beta1Identity { + /** + * The analysis state of this identity node. + */ + analysisState?: Schema$GoogleCloudAssetV1p4beta1AnalysisState; + /** + * The identity name in any form of members appear in [IAM policy binding](https://cloud.google.com/iam/reference/rest/v1/Binding), such as: - user:foo@google.com - group:group1@google.com - serviceAccount:s1@prj1.iam.gserviceaccount.com - projectOwner:some_project_id - domain:google.com - allUsers - etc. + */ + name?: string | null; + } + export interface Schema$GoogleCloudAssetV1p4beta1IdentityList { + /** + * Group identity edges of the graph starting from the binding's group members to any node of the identities. The Edge.source_node contains a group, such as "group:parent@google.com". The Edge.target_node contains a member of the group, such as "group:child@google.com" or "user:foo@google.com". This field is present only if the output_group_edges option is enabled in request. + */ + groupEdges?: Schema$GoogleCloudAssetV1p4beta1Edge[]; + /** + * Only the identities that match one of the following conditions will be presented: - The identity_selector, if it is specified in request; - Otherwise, identities reachable from the policy binding's members. + */ + identities?: Schema$GoogleCloudAssetV1p4beta1Identity[]; + } + /** + * A GCP resource that appears in an access control list. + */ + export interface Schema$GoogleCloudAssetV1p4beta1Resource { + /** + * The analysis state of this resource node. + */ + analysisState?: Schema$GoogleCloudAssetV1p4beta1AnalysisState; + /** + * The [full resource name](https://aip.dev/122#full-resource-names). + */ + fullResourceName?: string | null; + } + /** + * An analysis message to group the query and results. + */ + export interface Schema$IamPolicyAnalysis { + /** + * The analysis query. + */ + analysisQuery?: Schema$IamPolicyAnalysisQuery; + /** + * A list of IamPolicyAnalysisResult that matches the analysis query, or empty if no result is found. + */ + analysisResults?: Schema$IamPolicyAnalysisResult[]; + /** + * Represents whether all entries in the analysis_results have been fully explored to answer the query. + */ + fullyExplored?: boolean | null; + } + /** + * Output configuration for export IAM policy analysis destination. + */ + export interface Schema$IamPolicyAnalysisOutputConfig { + /** + * Destination on Cloud Storage. + */ + gcsDestination?: Schema$GcsDestination; + } + /** + * IAM policy analysis query message. + */ + export interface Schema$IamPolicyAnalysisQuery { + /** + * Optional. Specifies roles or permissions for analysis. Leaving it empty means ANY. + */ + accessSelector?: Schema$AccessSelector; + /** + * Optional. Specifies an identity for analysis. Leaving it empty means ANY. + */ + identitySelector?: Schema$IdentitySelector; + /** + * Required. The relative name of the root asset. Only resources and IAM policies within the parent will be analyzed. This can only be an organization number (such as "organizations/123") or a folder number (such as "folders/123"). + */ + parent?: string | null; + /** + * Optional. Specifies a resource for analysis. Leaving it empty means ANY. + */ + resourceSelector?: Schema$ResourceSelector; + } + /** + * IAM Policy analysis result, consisting of one IAM policy binding and derived access control lists. + */ + export interface Schema$IamPolicyAnalysisResult { + /** + * The access control lists derived from the iam_binding that match or potentially match resource and access selectors specified in the request. + */ + accessControlLists?: Schema$GoogleCloudAssetV1p4beta1AccessControlList[]; + /** + * The full name of the resource to which the iam_binding policy attaches. + */ + attachedResourceFullName?: string | null; + /** + * Represents whether all nodes in the transitive closure of the iam_binding node have been explored. + */ + fullyExplored?: boolean | null; + /** + * The Cloud IAM policy binding under analysis. + */ + iamBinding?: Schema$Binding; + /** + * The identity list derived from members of the iam_binding that match or potentially match identity selector specified in the request. + */ + identityList?: Schema$GoogleCloudAssetV1p4beta1IdentityList; + } + /** + * Specifies an identity for which to determine resource access, based on roles assigned either directly to them or to the groups they belong to, directly or indirectly. + */ + export interface Schema$IdentitySelector { + /** + * Required. The identity appear in the form of members in [IAM policy binding](https://cloud.google.com/iam/reference/rest/v1/Binding). + */ + identity?: string | null; + } + /** + * 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 | null; + /** + * 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} | null; + /** + * 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 be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * 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} | null; + } + /** + * Contains request options. + */ + export interface Schema$Options { + /** + * Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another example, if the request analyzes for who has permission P to a GCP folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Default is false. + */ + analyzeServiceAccountImpersonation?: boolean | null; + /** + * Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If identity_selector is specified, the identity in the result will be determined by the selector, and this flag will have no effect. Default is false. + */ + expandGroups?: boolean | null; + /** + * Optional. If true, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy. For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P. If resource_selector is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false. + */ + expandResources?: boolean | null; + /** + * Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If access_selector is specified, the access section of the result will be determined by the selector, and this flag will have no effect. Default is false. + */ + expandRoles?: boolean | null; + /** + * Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false. + */ + outputGroupEdges?: boolean | null; + /** + * Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false. + */ + outputResourceEdges?: boolean | null; + } + /** + * Specifies the resource to analyze for access policies, which may be set directly on the resource, or on ancestors such as organizations, folders or projects. At least one of ResourceSelector, IdentitySelector or AccessSelector must be specified in a request. + */ + export interface Schema$ResourceSelector { + /** + * Required. The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) . + */ + fullResourceName?: string | null; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * 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}> | null; + /** + * 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 | null; + } + + export class Resource$V1p4beta1 { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudasset.analyzeIamPolicy + * @desc Analyzes IAM policies based on the specified request. Returns a list of IamPolicyAnalysisResult matching the request. + * @alias cloudasset.analyzeIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.analysisQuery.accessSelector.permissions Optional. The permissions to appear in result. + * @param {string=} params.analysisQuery.accessSelector.roles Optional. The roles to appear in result. + * @param {string=} params.analysisQuery.identitySelector.identity Required. The identity appear in the form of members in [IAM policy binding](https://cloud.google.com/iam/reference/rest/v1/Binding). + * @param {string=} params.analysisQuery.resourceSelector.fullResourceName Required. The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) . + * @param {boolean=} params.options.analyzeServiceAccountImpersonation Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. We highly recommend you use ExportIamPolicyAnalysis rpc instead. For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another example, if the request analyzes for who has permission P to a GCP folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Default is false. + * @param {string=} params.options.executionTimeout Optional. Amount of time executable has to complete. See JSON representation of [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json). If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty. + * @param {boolean=} params.options.expandGroups Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If identity_selector is specified, the identity in the result will be determined by the selector, and this flag will have no effect. Default is false. + * @param {boolean=} params.options.expandResources Optional. If true, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy. For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P. If resource_selector is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false. + * @param {boolean=} params.options.expandRoles Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If access_selector is specified, the access section of the result will be determined by the selector, and this flag will have no effect. Default is false. + * @param {boolean=} params.options.outputGroupEdges Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false. + * @param {boolean=} params.options.outputResourceEdges Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false. + * @param {string} params.parent Required. The relative name of the root asset. Only resources and IAM policies within the parent will be analyzed. This can only be an organization number (such as "organizations/123") or a folder number (such as "folders/123"). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + analyzeIamPolicy( + params?: Params$Resource$V1p4beta1$Analyzeiampolicy, + options?: MethodOptions + ): GaxiosPromise; + analyzeIamPolicy( + params: Params$Resource$V1p4beta1$Analyzeiampolicy, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + analyzeIamPolicy( + params: Params$Resource$V1p4beta1$Analyzeiampolicy, + callback: BodyResponseCallback + ): void; + analyzeIamPolicy( + callback: BodyResponseCallback + ): void; + analyzeIamPolicy( + paramsOrCallback?: + | Params$Resource$V1p4beta1$Analyzeiampolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$V1p4beta1$Analyzeiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V1p4beta1$Analyzeiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p4beta1/{+parent}:analyzeIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudasset.exportIamPolicyAnalysis + * @desc Exports IAM policy analysis based on the specified request. This API implements the google.longrunning.Operation API allowing you to keep track of the export. The metadata contains the request to help callers to map responses to requests. + * @alias cloudasset.exportIamPolicyAnalysis + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The relative name of the root asset. Only resources and IAM policies within the parent will be analyzed. This can only be an organization number (such as "organizations/123") or a folder number (such as "folders/123"). + * @param {().ExportIamPolicyAnalysisRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + exportIamPolicyAnalysis( + params?: Params$Resource$V1p4beta1$Exportiampolicyanalysis, + options?: MethodOptions + ): GaxiosPromise; + exportIamPolicyAnalysis( + params: Params$Resource$V1p4beta1$Exportiampolicyanalysis, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportIamPolicyAnalysis( + params: Params$Resource$V1p4beta1$Exportiampolicyanalysis, + callback: BodyResponseCallback + ): void; + exportIamPolicyAnalysis( + callback: BodyResponseCallback + ): void; + exportIamPolicyAnalysis( + paramsOrCallback?: + | Params$Resource$V1p4beta1$Exportiampolicyanalysis + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$V1p4beta1$Exportiampolicyanalysis; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V1p4beta1$Exportiampolicyanalysis; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudasset.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1p4beta1/{+parent}:exportIamPolicyAnalysis' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$V1p4beta1$Analyzeiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The permissions to appear in result. + */ + 'analysisQuery.accessSelector.permissions'?: string[]; + /** + * Optional. The roles to appear in result. + */ + 'analysisQuery.accessSelector.roles'?: string[]; + /** + * Required. The identity appear in the form of members in [IAM policy binding](https://cloud.google.com/iam/reference/rest/v1/Binding). + */ + 'analysisQuery.identitySelector.identity'?: string; + /** + * Required. The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) . + */ + 'analysisQuery.resourceSelector.fullResourceName'?: string; + /** + * Optional. If true, the response will include access analysis from identities to resources via service account impersonation. This is a very expensive operation, because many derived queries will be executed. We highly recommend you use ExportIamPolicyAnalysis rpc instead. For example, if the request analyzes for which resources user A has permission P, and there's an IAM policy states user A has iam.serviceAccounts.getAccessToken permission to a service account SA, and there's another IAM policy states service account SA has permission P to a GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Another example, if the request analyzes for who has permission P to a GCP folder F, and there's an IAM policy states user A has iam.serviceAccounts.actAs permission to a service account SA, and there's another IAM policy states service account SA has permission P to the GCP folder F, then user A potentially has access to the GCP folder F. And those advanced analysis results will be included in AnalyzeIamPolicyResponse.service_account_impersonation_analysis. Default is false. + */ + 'options.analyzeServiceAccountImpersonation'?: boolean; + /** + * Optional. Amount of time executable has to complete. See JSON representation of [Duration](https://developers.google.com/protocol-buffers/docs/proto3#json). If this field is set with a value less than the RPC deadline, and the execution of your query hasn't finished in the specified execution timeout, you will get a response with partial result. Otherwise, your query's execution will continue until the RPC deadline. If it's not finished until then, you will get a DEADLINE_EXCEEDED error. Default is empty. + */ + 'options.executionTimeout'?: string; + /** + * Optional. If true, the identities section of the result will expand any Google groups appearing in an IAM policy binding. If identity_selector is specified, the identity in the result will be determined by the selector, and this flag will have no effect. Default is false. + */ + 'options.expandGroups'?: boolean; + /** + * Optional. If true, the resource section of the result will expand any resource attached to an IAM policy to include resources lower in the resource hierarchy. For example, if the request analyzes for which resources user A has permission P, and the results include an IAM policy with P on a GCP folder, the results will also include resources in that folder with permission P. If resource_selector is specified, the resource section of the result will be determined by the selector, and this flag will have no effect. Default is false. + */ + 'options.expandResources'?: boolean; + /** + * Optional. If true, the access section of result will expand any roles appearing in IAM policy bindings to include their permissions. If access_selector is specified, the access section of the result will be determined by the selector, and this flag will have no effect. Default is false. + */ + 'options.expandRoles'?: boolean; + /** + * Optional. If true, the result will output group identity edges, starting from the binding's group members, to any expanded identities. Default is false. + */ + 'options.outputGroupEdges'?: boolean; + /** + * Optional. If true, the result will output resource edges, starting from the policy attached resource, to any expanded resources. Default is false. + */ + 'options.outputResourceEdges'?: boolean; + /** + * Required. The relative name of the root asset. Only resources and IAM policies within the parent will be analyzed. This can only be an organization number (such as "organizations/123") or a folder number (such as "folders/123"). + */ + parent?: string; + } + export interface Params$Resource$V1p4beta1$Exportiampolicyanalysis + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The relative name of the root asset. Only resources and IAM policies within the parent will be analyzed. This can only be an organization number (such as "organizations/123") or a folder number (such as "folders/123"). + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExportIamPolicyAnalysisRequest; + } +} diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index 63455e2fde7..3904c297c70 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -435,7 +435,7 @@ export namespace cloudbilling_v1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } diff --git a/src/apis/clouddebugger/v2.ts b/src/apis/clouddebugger/v2.ts index 44d8f845b44..920071aafe1 100644 --- a/src/apis/clouddebugger/v2.ts +++ b/src/apis/clouddebugger/v2.ts @@ -138,6 +138,10 @@ export namespace clouddebugger_v2 { * Action that the agent should perform when the code at the breakpoint location is hit. */ action?: string | null; + /** + * The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state. + */ + canaryExpireTime?: string | null; /** * Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. */ @@ -186,6 +190,10 @@ export namespace clouddebugger_v2 { * The stack at breakpoint time, where stack_frames[0] represents the most recently entered function. */ stackFrames?: Schema$StackFrame[]; + /** + * The current state of the breakpoint. + */ + state?: string | null; /** * Breakpoint status. The status includes an error flag and a human readable message. This field is usually unset. The message can be either informational or an error message. Regardless, clients should always display the text message back to the user. Error status indicates complete failure of the breakpoint. Example (non-final state): `Still loading symbols...` Examples (final state): * `Invalid line number` referring to location * `Field f not found in class C` referring to condition */ @@ -254,6 +262,10 @@ export namespace clouddebugger_v2 { * Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`). */ agentVersion?: string | null; + /** + * Used when setting breakpoint canary for this debuggee. + */ + canaryMode?: string | null; /** * Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. */ @@ -437,6 +449,10 @@ export namespace clouddebugger_v2 { * Response for registering a debuggee. */ export interface Schema$RegisterDebuggeeResponse { + /** + * A unique ID generated for the agent. Each RegisterDebuggee request will generate a new agent ID. + */ + agentId?: string | null; /** * 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 `RegisterDebuggee` until reenabled. */ @@ -801,6 +817,7 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.agentId Identifies the agent. This is the ID returned in the RegisterDebuggee response. * @param {string} params.debuggeeId Required. Identifies the debuggee. * @param {boolean=} params.successOnTimeout If set to `true` (recommended), returns `google.rpc.Code.OK` status and sets the `wait_expired` response field to `true` when the server-selected timeout has expired. If set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status when the server-selected timeout has expired. * @param {string=} params.waitToken A token that, if specified, blocks the method call until the list of active breakpoints has changed, or a server-selected timeout has expired. The value should be set from the `next_wait_token` field in the last response. The initial value should be set to `"init"`. @@ -1026,6 +1043,10 @@ export namespace clouddebugger_v2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Identifies the agent. This is the ID returned in the RegisterDebuggee response. + */ + agentId?: string; /** * Required. Identifies the debuggee. */ @@ -1664,6 +1685,7 @@ export namespace clouddebugger_v2 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.canaryOption The canary option set by the user upon setting breakpoint. * @param {string=} params.clientVersion Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). * @param {string} params.debuggeeId Required. ID of the debuggee where the breakpoint is to be set. * @param {().Breakpoint} params.requestBody Request body data @@ -1819,6 +1841,10 @@ export namespace clouddebugger_v2 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * The canary option set by the user upon setting breakpoint. + */ + canaryOption?: string; /** * Required. The client version making the call. Schema: `domain/type/version` (e.g., `google.com/intellij/v1`). */ diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 688d3efbc82..9ca7c3e289d 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -119,46 +119,10 @@ export namespace cloudidentity_v1beta1 { * Resource representing the Android specific attributes of a Device. */ export interface Schema$AndroidAttributes { - /** - * Baseband version of Android device. - */ - basebandVersion?: string | null; - /** - * Device bootloader version. Example: 0.6.7. - */ - bootloaderVersion?: string | null; - /** - * Build number of Android device. - */ - buildNumber?: string | null; - /** - * Whether developer options is enabled on device. - */ - enabledDeveloperOptions?: boolean | null; /** * Whether applications from unknown sources can be installed on device. */ enabledUnknownSources?: boolean | null; - /** - * Whether adb (USB debugging) is enabled on device. - */ - enabledUsbDebugging?: boolean | null; - /** - * Device encryption state. - */ - encryptionState?: string | null; - /** - * Device hardware. Example: Sprout. - */ - hardware?: string | null; - /** - * Kernel version of Android device. - */ - kernelVersion?: string | null; - /** - * Domain name for Google accounts on device. Type for other accounts on device. Will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com". - */ - otherAccounts?: string[] | null; /** * Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles. */ @@ -167,10 +131,6 @@ export namespace cloudidentity_v1beta1 { * Ownership privileges on device. */ ownershipPrivilege?: string | null; - /** - * OS security patch update time on device. - */ - securityPatchTime?: string | null; /** * Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy. */ @@ -212,6 +172,76 @@ export namespace cloudidentity_v1beta1 { */ deviceUser?: Schema$DeviceUser; } + /** + * Resource representing ClientState and supports updates from API users + */ + export interface Schema$ClientState { + /** + * The caller can specify asset tags for this resource + */ + assetTags?: string[] | null; + /** + * The compliance state of the resource as specified by the API client. + */ + complianceState?: string | null; + /** + * Output only. The time the client state data was created. + */ + createTime?: string | null; + /** + * This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. + */ + customId?: string | null; + /** + * The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest + */ + etag?: string | null; + /** + * The Health score of the resource + */ + healthScore?: string | null; + /** + * The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map. + */ + keyValuePairs?: {[key: string]: Schema$CustomAttributeValue} | null; + /** + * Output only. The time the client state data was last updated. + */ + lastUpdateTime?: string | null; + /** + * The management state of the resource as specified by the API client. + */ + managed?: string | null; + /** + * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}`, where partner_id corresponds to the partner storing the data. + */ + name?: string | null; + /** + * The owner of the ClientState + */ + ownerType?: string | null; + /** + * A descriptive cause of the health score. + */ + scoreReason?: string | null; + } + /** + * Additional custom attribute values may be one of these types + */ + export interface Schema$CustomAttributeValue { + /** + * Represents a boolean value. + */ + boolValue?: boolean | null; + /** + * Represents a double value. + */ + numberValue?: number | null; + /** + * Represents a string value. + */ + stringValue?: string | null; + } /** * Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user. */ @@ -224,10 +254,22 @@ export namespace cloudidentity_v1beta1 { * Asset tag of the device. */ assetTag?: string | null; + /** + * Output only. Baseband version of the device. + */ + basebandVersion?: string | null; + /** + * Output only. Device bootloader version. Example: 0.6.7. + */ + bootloaderVersion?: string | null; /** * Output only. Device brand. Example: Samsung. */ brand?: string | null; + /** + * Output only. Build number of the device. + */ + buildNumber?: string | null; /** * Output only. Represents whether the Device is compromised. */ @@ -240,10 +282,26 @@ export namespace cloudidentity_v1beta1 { * Output only. Type of device. */ deviceType?: string | null; + /** + * Output only. Whether developer options is enabled on device. + */ + enabledDeveloperOptions?: boolean | null; + /** + * Output only. Whether USB debugging is enabled on device. + */ + enabledUsbDebugging?: boolean | null; + /** + * Output only. Device encryption state. + */ + encryptionState?: string | null; /** * Output only. IMEI number of device if GSM device; empty otherwise. */ imei?: string | null; + /** + * Output only. Kernel version of the device. + */ + kernelVersion?: string | null; /** * Most recent time when device synced with this service. */ @@ -276,6 +334,10 @@ export namespace cloudidentity_v1beta1 { * Output only. OS version of the device. Example: Android 8.1.0. */ osVersion?: string | null; + /** + * Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com". + */ + otherAccounts?: string[] | null; /** * Whether the device is owned by the company or an individual */ @@ -284,6 +346,10 @@ export namespace cloudidentity_v1beta1 { * Output only. OS release version. Example: 6.0. */ releaseVersion?: string | null; + /** + * Output only. OS security patch update time on device. + */ + securityPatchTime?: string | null; /** * Serial Number of device. Example: HT82V1A01076. */ diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 7f743fb49c8..1af27998540 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -316,7 +316,7 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -702,7 +702,7 @@ export namespace cloudresourcemanager_v1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 25dae0d3d6a..4835ed9374e 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -242,7 +242,7 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -412,7 +412,7 @@ export namespace cloudresourcemanager_v1beta1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 7ba5d72b023..17a800d9bef 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -241,7 +241,7 @@ export namespace cloudresourcemanager_v2 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -378,7 +378,7 @@ export namespace cloudresourcemanager_v2 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index f2a11deb4e7..3c1ebb1f21a 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -241,7 +241,7 @@ export namespace cloudresourcemanager_v2beta1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -378,7 +378,7 @@ export namespace cloudresourcemanager_v2beta1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index d768f54b905..17d308ccf32 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -387,7 +387,7 @@ export namespace cloudscheduler_v1 { */ maxBackoffDuration?: string | null; /** - * 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. + * 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 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 | null; /** diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index 35a7ee79b6e..5ff30c49edc 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -387,7 +387,7 @@ export namespace cloudscheduler_v1beta1 { */ maxBackoffDuration?: string | null; /** - * 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. + * 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 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 | null; /** diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index d1cf6b67c53..47132aacedf 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -3688,7 +3688,7 @@ export namespace cloudsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. + * @param {string} params.name Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. The maximum length is 1536 bytes. * @param {().StartUploadItemRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3930,7 +3930,7 @@ export namespace cloudsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. + * Name of the Item to start a resumable upload. Format: datasources/{source_id}/items/{item_id}. The maximum length is 1536 bytes. */ name?: string; diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index de4727bd30e..d064215c272 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -116,11 +116,11 @@ export namespace cloudtasks_v2 { } /** - * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. */ export interface Schema$AppEngineHttpRequest { /** - * Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. + * Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. */ appEngineRouting?: Schema$AppEngineRouting; /** @@ -132,7 +132,7 @@ export namespace cloudtasks_v2 { */ headers?: {[key: string]: string} | null; /** - * 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 handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + * 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 handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled). */ httpMethod?: string | null; /** @@ -242,7 +242,7 @@ export namespace cloudtasks_v2 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -466,7 +466,7 @@ export namespace cloudtasks_v2 { */ maxBackoff?: string | null; /** - * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxDoublings?: number | null; /** diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index fbdc8cc0047..cc0e1a54481 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -125,7 +125,7 @@ export namespace cloudtasks_v2beta2 { scheduleTime?: string | null; } /** - * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. This proto can only be used for tasks in a queue which has app_engine_http_target set. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_url Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. */ export interface Schema$AppEngineHttpRequest { /** @@ -137,7 +137,7 @@ export namespace cloudtasks_v2beta2 { */ headers?: {[key: string]: string} | null; /** - * 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 handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + * 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 handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled). */ httpMethod?: string | null; /** @@ -273,7 +273,7 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -506,7 +506,7 @@ export namespace cloudtasks_v2beta2 { */ maxBackoff?: string | null; /** - * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field is output only for pull queues. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxDoublings?: number | null; /** diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index 2fe8568f01d..ab269b200da 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -125,7 +125,7 @@ export namespace cloudtasks_v2beta3 { appEngineRoutingOverride?: Schema$AppEngineRouting; } /** - * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. + * App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If set, app_engine_routing_override is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. */ export interface Schema$AppEngineHttpRequest { /** @@ -141,7 +141,7 @@ export namespace cloudtasks_v2beta3 { */ headers?: {[key: string]: string} | null; /** - * 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 handle HTTP requests with this http_method, otherwise the task attempt will fail with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the documentation for the request handlers in the language your app is written in e.g. [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + * 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 handle HTTP requests with this http_method, otherwise the task attempt fails with error code 405 (Method Not Allowed). See [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled). */ httpMethod?: string | null; /** @@ -251,7 +251,7 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -475,7 +475,7 @@ export namespace cloudtasks_v2beta3 { */ maxBackoff?: string | null; /** - * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). */ maxDoublings?: number | null; /** diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 92cbdddb3eb..54a8bab51b3 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -133,7 +133,7 @@ export namespace cloudtrace_v2 { */ export interface Schema$Attributes { /** - * The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true + * The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": { "string_value": { "value": "my-instance" } } "/http/request_bytes": { "int_value": 300 } "abc.com/myattribute": { "bool_value": false } */ attributeMap?: {[key: string]: Schema$AttributeValue} | null; /** diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index a921e231801..bedf9ba31ec 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -141,7 +141,7 @@ export namespace container_v1beta1 { */ dnsCacheConfig?: Schema$DnsCacheConfig; /** - * Configuration for the GCP Compute Persistent Disk CSI driver. + * Configuration for the Compute Engine Persistent Disk CSI driver. */ gcePersistentDiskCsiDriverConfig?: Schema$GcePersistentDiskCsiDriverConfig; /** @@ -1539,6 +1539,10 @@ export namespace container_v1beta1 { * Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. */ enablePrivateNodes?: boolean | null; + /** + * Controls master global access settings. + */ + masterGlobalAccessConfig?: Schema$PrivateClusterMasterGlobalAccessConfig; /** * The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network. */ @@ -1556,6 +1560,15 @@ export namespace container_v1beta1 { */ publicEndpoint?: string | null; } + /** + * Configuration for controlling master global access settings. + */ + export interface Schema$PrivateClusterMasterGlobalAccessConfig { + /** + * Whenever master is accessible globally or not. + */ + enabled?: boolean | null; + } /** * Represents an arbitrary window of time that recurs. */ diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 9e701feddd0..0f9575143f1 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -558,7 +558,7 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 109c19b760e..0584ee61b46 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -145,6 +145,18 @@ export namespace containeranalysis_v1beta1 { */ names?: string[] | null; } + /** + * Defines a hash object for use in Materials and Products. + */ + export interface Schema$ArtifactHashes { + sha256?: string | null; + } + /** + * Defines an object to declare an in-toto artifact rule + */ + export interface Schema$ArtifactRule { + artifactRule?: string[] | null; + } /** * Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for look-up (how to find this attestation if you already know the authority and artifact to be verified) and intent (which authority was this attestation intended to sign for). */ @@ -321,6 +333,12 @@ export namespace containeranalysis_v1beta1 { */ signature?: string | null; } + /** + * Defines an object for the byproducts field in in-toto links. The suggested fields are "stderr", "stdout", and "return-value". + */ + export interface Schema$ByProducts { + customValues?: {[key: string]: string} | null; + } /** * A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo. */ @@ -569,6 +587,12 @@ export namespace containeranalysis_v1beta1 { * 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 {} + /** + * Defines an object for the environment field in in-toto links. The suggested fields are "variables", "filesystem", and "workdir". + */ + export interface Schema$Environment { + customValues?: {[key: string]: string} | null; + } /** * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ @@ -680,7 +704,7 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -759,6 +783,24 @@ export namespace containeranalysis_v1beta1 { */ derivedImage?: Schema$Derived; } + export interface Schema$GrafeasV1beta1IntotoArtifact { + hashes?: Schema$ArtifactHashes; + resourceUri?: string | null; + } + /** + * This corresponds to a signed in-toto link - it is made up of one or more signatures and the in-toto link itself. This is used for occurrences of a Grafeas in-toto note. + */ + export interface Schema$GrafeasV1beta1IntotoDetails { + signatures?: Schema$GrafeasV1beta1IntotoSignature[]; + signed?: Schema$Link; + } + /** + * A signature object consists of the KeyID used and the signature itself. + */ + export interface Schema$GrafeasV1beta1IntotoSignature { + keyid?: string | null; + sig?: string | null; + } /** * Details of a package occurrence. */ @@ -840,6 +882,32 @@ export namespace containeranalysis_v1beta1 { */ name?: string | null; } + /** + * This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. + */ + export interface Schema$InToto { + /** + * This field contains the expected command used to perform the step. + */ + expectedCommand?: string[] | null; + /** + * The following fields contain in-toto artifact rules identifying the artifacts that enter this supply chain step, and exit the supply chain step, i.e. materials and products of the step. + */ + expectedMaterials?: Schema$ArtifactRule[]; + expectedProducts?: Schema$ArtifactRule[]; + /** + * This field contains the public keys that can be used to verify the signatures on the step metadata. + */ + signingKeys?: Schema$SigningKey[]; + /** + * This field identifies the name of the step in the supply chain. + */ + stepName?: string | null; + /** + * This field contains a value that indicates the minimum number of keys that need to be used to sign the step's in-toto link. + */ + threshold?: string | null; + } export interface Schema$KnowledgeBase { /** * The KB name (generally of the form KB[0-9]+ i.e. KB123456). @@ -863,6 +931,31 @@ export namespace containeranalysis_v1beta1 { */ directive?: string | null; } + /** + * This corresponds to an in-toto link. + */ + export interface Schema$Link { + /** + * ByProducts are data generated as part of a software supply chain step, but are not the actual result of the step. + */ + byproducts?: Schema$ByProducts; + /** + * This field contains the full command executed for the step. This can also be empty if links are generated for operations that aren't directly mapped to a specific command. Each term in the command is an independent string in the list. An example of a command in the in-toto metadata field is: "command": ["git", "clone", "https://github.com/in-toto/demo-project.git"] + */ + command?: string[] | null; + /** + * This is a field that can be used to capture information about the environment. It is suggested for this field to contain information that details environment variables, filesystem information, and the present working directory. The recommended structure of this field is: "environment": { "custom_values": { "variables": "<ENV>", "filesystem": "<FS>", "workdir": "<CWD>", "<ANY OTHER RELEVANT FIELDS>": "..." } } + */ + environment?: Schema$Environment; + /** + * Materials are the supply chain artifacts that go into the step and are used for the operation performed. The key of the map is the path of the artifact and the structure contains the recorded hash information. An example is: "materials": [ { "resource_uri": "foo/bar", "hashes": { "sha256": "ebebf...", <OTHER HASH ALGORITHMS>: <HASH VALUE> } } ] + */ + materials?: Schema$GrafeasV1beta1IntotoArtifact[]; + /** + * Products are the supply chain artifacts generated as a result of the step. The structure is identical to that of materials. + */ + products?: Schema$GrafeasV1beta1IntotoArtifact[]; + } /** * Response for listing occurrences for a note. */ @@ -964,6 +1057,10 @@ export namespace containeranalysis_v1beta1 { * Time of expiration for this note. Empty if note does not expire. */ expirationTime?: string | null; + /** + * A note describing an in-toto link. + */ + intoto?: Schema$InToto; /** * Output only. The type of analysis. This field can be used as a filter in list requests. */ @@ -1033,6 +1130,10 @@ export namespace containeranalysis_v1beta1 { * Describes the installation of a package on the linked resource. */ installation?: Schema$GrafeasV1beta1PackageDetails; + /** + * Describes a specific in-toto link. + */ + intoto?: Schema$GrafeasV1beta1IntotoDetails; /** * Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. */ @@ -1229,6 +1330,27 @@ export namespace containeranalysis_v1beta1 { */ signature?: string | null; } + /** + * This defines the format used to record keys used in the software supply chain. An in-toto link is attested using one or more keys defined in the in-toto layout. An example of this is: { "key_id": "776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----x/MIIBojANBgkqhkiG9w0B...", "key_scheme": "rsassa-pss-sha256" } The format for in-toto's key definition can be found in section 4.2 of the in-toto specification. + */ + export interface Schema$SigningKey { + /** + * key_id is an identifier for the signing key. + */ + keyId?: string | null; + /** + * This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256". + */ + keyScheme?: string | null; + /** + * This field identifies the specific signing method. Eg: "rsa", "ed25519", and "ecdsa". + */ + keyType?: string | null; + /** + * This field contains the actual public key. + */ + publicKeyValue?: string | null; + } /** * Source describes the location of the source used for the build. */ diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index a005b6069e6..3119de119b6 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -105,6 +105,8 @@ export namespace content_v2_1 { regionalinventory: Resource$Regionalinventory; returnaddress: Resource$Returnaddress; returnpolicy: Resource$Returnpolicy; + settlementreports: Resource$Settlementreports; + settlementtransactions: Resource$Settlementtransactions; shippingsettings: Resource$Shippingsettings; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -133,6 +135,10 @@ export namespace content_v2_1 { this.regionalinventory = new Resource$Regionalinventory(this.context); this.returnaddress = new Resource$Returnaddress(this.context); this.returnpolicy = new Resource$Returnpolicy(this.context); + this.settlementreports = new Resource$Settlementreports(this.context); + this.settlementtransactions = new Resource$Settlementtransactions( + this.context + ); this.shippingsettings = new Resource$Shippingsettings(this.context); } } @@ -142,7 +148,7 @@ export namespace content_v2_1 { */ export interface Schema$Account { /** - * List of linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. + * List of linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. */ adsLinks?: Schema$AccountAdsLink[]; /** @@ -162,7 +168,7 @@ export namespace content_v2_1 { */ id?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#account". + * Identifies what kind of resource this is. Value: the fixed string "`content#account`" */ kind?: string | null; /** @@ -182,7 +188,7 @@ export namespace content_v2_1 { */ websiteUrl?: string | null; /** - * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. + * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. */ youtubeChannelLinks?: Schema$AccountYouTubeChannelLink[]; } @@ -214,7 +220,7 @@ export namespace content_v2_1 { */ adsId?: string | null; /** - * Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google Ads or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "active" - "pending" + * Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`" */ status?: string | null; } @@ -252,7 +258,7 @@ export namespace content_v2_1 { */ gmbEmail?: string | null; /** - * Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "active" - "pending" + * Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`" */ status?: string | null; } @@ -293,11 +299,11 @@ export namespace content_v2_1 { */ export interface Schema$AccountsCustomBatchRequestEntry { /** - * The account to create or update. Only defined if the method is insert or update. + * The account to create or update. Only defined if the method is `insert` or `update`. */ account?: Schema$Account; /** - * The ID of the targeted account. Only defined if the method is not insert. + * The ID of the targeted account. Only defined if the method is not `insert`. */ accountId?: string | null; /** @@ -305,11 +311,11 @@ export namespace content_v2_1 { */ batchId?: number | null; /** - * Whether the account should be deleted if the account has offers. Only applicable if the method is delete. + * Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`. */ force?: boolean | null; /** - * Details about the link request. + * Details about the `link` request. */ linkRequest?: Schema$AccountsCustomBatchRequestEntryLinkRequest; /** @@ -317,17 +323,17 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "claimWebsite" - "delete" - "get" - "insert" - "link" - "update" + * The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`" */ method?: string | null; /** - * Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict. + * Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict. */ overwrite?: boolean | null; } export interface Schema$AccountsCustomBatchRequestEntryLinkRequest { /** - * Action to perform for this link. The "request" action is only available to select merchants. Acceptable values are: - "approve" - "remove" - "request" + * Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`" */ action?: string | null; /** @@ -335,7 +341,7 @@ export namespace content_v2_1 { */ linkedAccountId?: string | null; /** - * Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform" + * Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" */ linkType?: string | null; /** @@ -358,7 +364,7 @@ export namespace content_v2_1 { */ export interface Schema$AccountsCustomBatchResponseEntry { /** - * The retrieved, created, or updated account. Not defined if the method was delete, claimwebsite or link. + * The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`. */ account?: Schema$Account; /** @@ -370,13 +376,13 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`" */ kind?: string | null; } export interface Schema$AccountsLinkRequest { /** - * Action to perform for this link. The "request" action is only available to select merchants. Acceptable values are: - "approve" - "remove" - "request" + * Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`" */ action?: string | null; /** @@ -384,7 +390,7 @@ export namespace content_v2_1 { */ linkedAccountId?: string | null; /** - * Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform" + * Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" */ linkType?: string | null; /** @@ -436,7 +442,7 @@ export namespace content_v2_1 { */ accountLevelIssues?: Schema$AccountStatusAccountLevelIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". + * Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" */ kind?: string | null; /** @@ -470,7 +476,7 @@ export namespace content_v2_1 { */ id?: string | null; /** - * Severity of the issue. Acceptable values are: - "critical" - "error" - "suggestion" + * Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" */ severity?: string | null; /** @@ -505,7 +511,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" + * The method of the batch entry. Acceptable values are: - "`get`" */ method?: string | null; } @@ -583,7 +589,7 @@ export namespace content_v2_1 { } export interface Schema$AccountStatusProducts { /** - * The channel the data applies to. Acceptable values are: - "local" - "online" + * The channel the data applies to. Acceptable values are: - "`local`" - "`online`" */ channel?: string | null; /** @@ -653,7 +659,7 @@ export namespace content_v2_1 { */ accountId?: string | null; /** - * The account tax settings to update. Only defined if the method is update. + * The account tax settings to update. Only defined if the method is `update`. */ accountTax?: Schema$AccountTax; /** @@ -665,7 +671,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" - "update" + * The method of the batch entry. Acceptable values are: - "`get`" - "`update`" */ method?: string | null; } @@ -696,7 +702,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#accounttaxCustomBatchResponseEntry`" */ kind?: string | null; } @@ -764,7 +770,7 @@ export namespace content_v2_1 { */ channelId?: string | null; /** - * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. + * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ status?: string | null; } @@ -786,15 +792,15 @@ export namespace content_v2_1 { } export interface Schema$CarrierRate { /** - * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. + * Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required. */ carrierName?: string | null; /** - * Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. + * Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required. */ carrierService?: string | null; /** - * Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional. + * Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional. */ flatAdjustment?: Schema$Price; /** @@ -806,7 +812,7 @@ export namespace content_v2_1 { */ originPostalCode?: string | null; /** - * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional. + * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional. */ percentageAdjustment?: string | null; } @@ -816,11 +822,11 @@ export namespace content_v2_1 { */ country?: string | null; /** - * The name of the carrier (e.g., "UPS"). Always present. + * The name of the carrier (e.g., `"UPS"`). Always present. */ name?: string | null; /** - * A list of supported services (e.g., "ground") for that carrier. Contains at least one service. + * A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service. */ services?: string[] | null; } @@ -844,7 +850,7 @@ export namespace content_v2_1 { */ description?: string | null; /** - * Code of the return reason. Acceptable values are: - "betterPriceFound" - "changedMind" - "damagedOrDefectiveItem" - "didNotMatchDescription" - "doesNotFit" - "expiredItem" - "incorrectItemReceived" - "noLongerNeeded" - "notSpecified" - "orderedWrongItem" - "other" - "qualityNotExpected" - "receivedTooLate" - "undeliverable" + * Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`" */ reasonCode?: string | null; } @@ -871,7 +877,7 @@ export namespace content_v2_1 { */ attributeLanguage?: string | null; /** - * Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "local products" - "product inventory" - "products" + * Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`" */ contentType?: string | null; /** @@ -891,7 +897,7 @@ export namespace content_v2_1 { */ id?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#datafeed". + * Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`" */ kind?: string | null; /** @@ -940,21 +946,21 @@ export namespace content_v2_1 { */ username?: string | null; /** - * The day of the week the feed file should be fetched. Acceptable values are: - "monday" - "tuesday" - "wednesday" - "thursday" - "friday" - "saturday" - "sunday" + * The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`" */ weekday?: string | null; } export interface Schema$DatafeedFormat { /** - * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "pipe" - "tab" - "tilde" + * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`" */ columnDelimiter?: string | null; /** - * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "latin-1" - "utf-16be" - "utf-16le" - "utf-8" - "windows-1252" + * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`" */ fileEncoding?: string | null; /** - * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "normal character" - "value quoting" + * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`" */ quotingMode?: string | null; } @@ -985,7 +991,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "delete" - "fetchNow" - "get" - "insert" - "update" + * The method of the batch entry. Acceptable values are: - "`delete`" - "`fetchNow`" - "`get`" - "`insert`" - "`update`" */ method?: string | null; } @@ -1058,7 +1064,7 @@ export namespace content_v2_1 { */ itemsValid?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". + * Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`" */ kind?: string | null; /** @@ -1070,7 +1076,7 @@ export namespace content_v2_1 { */ lastUploadDate?: string | null; /** - * The processing status of the feed. Acceptable values are: - ""failure": The feed could not be processed or all items had errors." - "in progress": The feed is being processed. - "none": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "success": The feed was processed successfully, though some items might have had errors. + * The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors. */ processingStatus?: string | null; /** @@ -1130,7 +1136,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" + * The method of the batch entry. Acceptable values are: - "`get`" */ method?: string | null; } @@ -1199,11 +1205,11 @@ export namespace content_v2_1 { */ excludedDestinations?: string[] | null; /** - * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle */ includedDestinations?: string[] | null; /** - * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. + * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`. */ language?: string | null; } @@ -1221,11 +1227,11 @@ export namespace content_v2_1 { */ holidayCutoffs?: Schema$HolidayCutoff[]; /** - * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays. + * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`. */ maxHandlingTimeInDays?: number | null; /** - * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. + * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`. */ maxTransitTimeInDays?: number | null; /** @@ -1233,7 +1239,7 @@ export namespace content_v2_1 { */ minHandlingTimeInDays?: number | null; /** - * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both. + * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both. */ minTransitTimeInDays?: number | null; /** @@ -1241,7 +1247,7 @@ export namespace content_v2_1 { */ transitBusinessDayConfig?: Schema$BusinessDayConfig; /** - * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both. + * Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both. */ transitTimeTable?: Schema$TransitTable; } @@ -1267,7 +1273,7 @@ export namespace content_v2_1 { */ export interface Schema$Errors { /** - * The HTTP status of the first error in errors. + * The HTTP status of the first error in `errors`. */ code?: number | null; /** @@ -1275,7 +1281,7 @@ export namespace content_v2_1 { */ errors?: Schema$Error[]; /** - * The message of the first error in errors. + * The message of the first error in `errors`. */ message?: string | null; } @@ -1308,7 +1314,7 @@ export namespace content_v2_1 { type?: string | null; } /** - * A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. + * A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. */ export interface Schema$Headers { /** @@ -1316,19 +1322,19 @@ export namespace content_v2_1 { */ locations?: Schema$LocationIdSet[]; /** - * A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. + * A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. */ numberOfItems?: string[] | null; /** - * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. + * A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. */ postalCodeGroupNames?: string[] | null; /** - * A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. + * A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. */ prices?: Schema$Price[]; /** - * A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set. + * A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set. */ weights?: Schema$Weight[]; } @@ -1376,7 +1382,7 @@ export namespace content_v2_1 { */ id?: string | null; /** - * The holiday type. Always present. Acceptable values are: - "Christmas" - "Easter" - "Father's Day" - "Halloween" - "Independence Day (USA)" - "Mother's Day" - "Thanksgiving" - "Valentine's Day" + * The holiday type. Always present. Acceptable values are: - "`Christmas`" - "`Easter`" - "`Father's Day`" - "`Halloween`" - "`Independence Day (USA)`" - "`Mother's Day`" - "`Thanksgiving`" - "`Valentine's Day`" */ type?: string | null; } @@ -1406,13 +1412,13 @@ export namespace content_v2_1 { */ totalAmount?: Schema$Amount; /** - * [required] Type of the additional charge. Acceptable values are: - "shipping" + * [required] Type of the additional charge. Acceptable values are: - "`shipping`" */ type?: string | null; } export interface Schema$LiaAboutPageSettings { /** - * The status of the verification process for the About page. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ status?: string | null; /** @@ -1460,11 +1466,11 @@ export namespace content_v2_1 { */ inventoryVerificationContactName?: string | null; /** - * The status of the verification contact. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ inventoryVerificationContactStatus?: string | null; /** - * The status of the inventory verification process. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ status?: string | null; } @@ -1474,7 +1480,7 @@ export namespace content_v2_1 { */ shippingCostPolicyUrl?: string | null; /** - * The status of the ?On display to order? feature. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ status?: string | null; } @@ -1501,7 +1507,7 @@ export namespace content_v2_1 { */ countrySettings?: Schema$LiaCountrySettings[]; /** - * Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". + * Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`" */ kind?: string | null; } @@ -1537,7 +1543,7 @@ export namespace content_v2_1 { */ gmbEmail?: string | null; /** - * The account Lia settings to update. Only defined if the method is update. + * The account Lia settings to update. Only defined if the method is `update`. */ liaSettings?: Schema$LiaSettings; /** @@ -1545,7 +1551,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" - "getAccessibleGmbAccounts" - "requestGmbAccess" - "requestInventoryVerification" - "setInventoryVerificationContact" - "update" + * The method of the batch entry. Acceptable values are: - "`get`" - "`getAccessibleGmbAccounts`" - "`requestGmbAccess`" - "`requestInventoryVerification`" - "`setInventoryVerificationContact`" - "`update`" */ method?: string | null; /** @@ -1581,7 +1587,7 @@ export namespace content_v2_1 { */ gmbAccounts?: Schema$GmbAccounts; /** - * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -1664,11 +1670,11 @@ export namespace content_v2_1 { } export interface Schema$LinkService { /** - * Service provided to or by the linked account. Acceptable values are: - "shoppingActionsOrderManagement" - "shoppingActionsProductManagement" - "shoppingAdsProductManagement" + * Service provided to or by the linked account. Acceptable values are: - "`shoppingActionsOrderManagement`" - "`shoppingActionsProductManagement`" - "`shoppingAdsProductManagement`" */ service?: string | null; /** - * Status of the link Acceptable values are: - "active" - "inactive" - "pending" + * Status of the link Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ status?: string | null; } @@ -1685,15 +1691,15 @@ export namespace content_v2_1 { */ instoreProductLocation?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#localInventory". + * Identifies what kind of resource this is. Value: the fixed string "`content#localInventory`" */ kind?: string | null; /** - * Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla. + * Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with `pickupSla`. */ pickupMethod?: string | null; /** - * Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod. + * Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. */ pickupSla?: string | null; /** @@ -1705,7 +1711,7 @@ export namespace content_v2_1 { */ quantity?: number | null; /** - * Sale price of the product. Mandatory if sale_price_effective_date is defined. + * Sale price of the product. Mandatory if `sale_price_effective_date` is defined. */ salePrice?: Schema$Price; /** @@ -1740,7 +1746,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * Method of the batch request entry. Acceptable values are: - "insert" + * Method of the batch request entry. Acceptable values are: - "`insert`" */ method?: string | null; /** @@ -1771,7 +1777,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#localinventoryCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#localinventoryCustomBatchResponseEntry`" */ kind?: string | null; } @@ -1846,12 +1852,28 @@ export namespace content_v2_1 { */ returnShipmentIds?: string[] | null; /** - * State of the item. Acceptable values are: - "canceled" - "new" - "received" - "refunded" - "rejected" + * State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`" */ state?: string | null; } + export interface Schema$MinimumOrderValueTable { + storeCodeSetWithMovs?: Schema$MinimumOrderValueTableStoreCodeSetWithMov[]; + } /** - * Order. Production access (all methods) requires the order manager role. Sandbox access does not. + * A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency. + */ + export interface Schema$MinimumOrderValueTableStoreCodeSetWithMov { + /** + * A list of unique store codes or empty for the catch all. + */ + storeCodes?: string[] | null; + /** + * The minimum order value for the given stores. + */ + value?: Schema$Price; + } + /** + * Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==) */ export interface Schema$Order { /** @@ -1867,7 +1889,7 @@ export namespace content_v2_1 { */ customer?: Schema$OrderCustomer; /** - * Delivery details for shipments of type delivery. + * Delivery details for shipments of type `delivery`. */ deliveryDetails?: Schema$OrderDeliveryDetails; /** @@ -1875,7 +1897,7 @@ export namespace content_v2_1 { */ id?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#order". + * Identifies what kind of resource this is. Value: the fixed string "`content#order`" */ kind?: string | null; /** @@ -1892,15 +1914,15 @@ export namespace content_v2_1 { */ netPriceAmount?: Schema$Price; /** - * The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment netTaxAmount might not match to a sum of tax field across all lineItems and refunds. + * The net amount for the order (tax part). Note that in certain cases due to taxable base adjustment `netTaxAmount` might not match to a sum of tax field across all lineItems and refunds. */ netTaxAmount?: Schema$Price; /** - * The status of the payment. Acceptable values are: - "paymentCaptured" - "paymentRejected" - "paymentSecured" - "pendingAuthorization" + * The status of the payment. Acceptable values are: - "`paymentCaptured`" - "`paymentRejected`" - "`paymentSecured`" - "`pendingAuthorization`" */ paymentStatus?: string | null; /** - * Pickup details for shipments of type pickup. + * Pickup details for shipments of type `pickup`. */ pickupDetails?: Schema$OrderPickupDetails; /** @@ -1908,7 +1930,7 @@ export namespace content_v2_1 { */ placedDate?: string | null; /** - * Promotions associated with the order. To determine which promotions apply to which products, check the Promotions[].appliedItems[].lineItemId field against the LineItems[].id field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: - To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the LineItems[].adjustments[].priceAdjustment.value amount from the LineItems[].Price.value. - To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the LineItems[].adjustments[].priceAdjustment.value by the quantity of products then subtract the resulting value from the LineItems[].Product.Price.value for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here. + * Promotions associated with the order. To determine which promotions apply to which products, check the `Promotions[].appliedItems[].lineItemId` field against the `LineItems[].id` field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: - To calculate price paid by the customer for a single line item including the discount: For each promotion, subtract the `LineItems[].adjustments[].priceAdjustment.value` amount from the `LineItems[].Price.value`. - To calculate price paid by the customer for a single line item including the discount in case of multiple quantity: For each promotion, divide the `LineItems[].adjustments[].priceAdjustment.value` by the quantity of products then subtract the resulting value from the `LineItems[].Product.Price.value` for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here. */ promotions?: Schema$OrderPromotion[]; /** @@ -1928,11 +1950,11 @@ export namespace content_v2_1 { */ shippingCostTax?: Schema$Price; /** - * The status of the order. Acceptable values are: - "canceled" - "delivered" - "inProgress" - "partiallyDelivered" - "partiallyReturned" - "partiallyShipped" - "pendingShipment" - "returned" - "shipped" + * The status of the order. Acceptable values are: - "`canceled`" - "`delivered`" - "`inProgress`" - "`partiallyDelivered`" - "`partiallyReturned`" - "`partiallyShipped`" - "`pendingShipment`" - "`returned`" - "`shipped`" */ status?: string | null; /** - * The party responsible for collecting and remitting taxes. Acceptable values are: - "marketplaceFacilitator" - "merchant" + * The party responsible for collecting and remitting taxes. Acceptable values are: - "`marketplaceFacilitator`" - "`merchant`" */ taxCollector?: string | null; } @@ -1972,7 +1994,7 @@ export namespace content_v2_1 { } export interface Schema$OrderCancellation { /** - * The actor that created the cancellation. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant" + * The actor that created the cancellation. Acceptable values are: - "`customer`" - "`googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`" */ actor?: string | null; /** @@ -1984,7 +2006,7 @@ export namespace content_v2_1 { */ quantity?: number | null; /** - * The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "customerCanceled" - "customerInitiatedCancel" - "customerSupportRequested" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "invalidCoupon" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceError" - "returnRefundAbuse" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`customerCanceled`" - "`customerInitiatedCancel`" - "`customerSupportRequested`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceError`" - "`returnRefundAbuse`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -1997,9 +2019,6 @@ export namespace content_v2_1 { * Full name of the customer. */ fullName?: string | null; - /** - * Email address for the merchant to send value-added tax or invoice documentation of the order. This documentation is made available to the customer. - */ invoiceReceivingEmail?: string | null; /** * Loyalty program information. @@ -2022,7 +2041,7 @@ export namespace content_v2_1 { } export interface Schema$OrderCustomerMarketingRightsInfo { /** - * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - "denied" - "granted" + * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - "`denied`" - "`granted`" */ explicitMarketingPreference?: string | null; /** @@ -2030,7 +2049,7 @@ export namespace content_v2_1 { */ lastUpdatedTimestamp?: string | null; /** - * Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account. + * Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account. */ marketingEmailAddress?: string | null; } @@ -2062,7 +2081,7 @@ export namespace content_v2_1 { */ operationId?: string | null; /** - * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string | null; } @@ -2086,11 +2105,11 @@ export namespace content_v2_1 { */ operationId?: string | null; /** - * Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided. + * Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided. */ refundOnlyOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; /** - * Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of refundOnlyOption or returnOption must be provided. + * Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided. */ returnOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; /** @@ -2114,7 +2133,7 @@ export namespace content_v2_1 { */ description?: string | null; /** - * [required] Reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * [required] Reason for the refund. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; } @@ -2124,7 +2143,7 @@ export namespace content_v2_1 { */ description?: string | null; /** - * [required] Reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * [required] Reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; } @@ -2212,7 +2231,7 @@ export namespace content_v2_1 { */ taxAdjustment?: Schema$Price; /** - * Type of this adjustment. Acceptable values are: - "promotion" + * Type of this adjustment. Acceptable values are: - "`promotion`" */ type?: string | null; } @@ -2222,7 +2241,7 @@ export namespace content_v2_1 { */ brand?: string | null; /** - * Condition or state of the item. Acceptable values are: - "new" - "refurbished" - "used" + * Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`" */ condition?: string | null; /** @@ -2326,13 +2345,13 @@ export namespace content_v2_1 { */ shipByDate?: string | null; /** - * Type of shipment. Indicates whether deliveryDetails or pickupDetails is applicable for this shipment. Acceptable values are: - "delivery" - "pickup" + * Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - "`delivery`" - "`pickup`" */ type?: string | null; } export interface Schema$OrderLineItemShippingDetailsMethod { /** - * The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values. + * The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values. */ carrier?: string | null; /** @@ -2360,7 +2379,7 @@ export namespace content_v2_1 { } export interface Schema$OrderPickupDetails { /** - * Address of the pickup location where the shipment should be sent. Note that recipientName in the address is the name of the business at the pickup location. + * Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location. */ address?: Schema$OrderAddress; /** @@ -2388,7 +2407,7 @@ export namespace content_v2_1 { */ applicableItems?: Schema$OrderPromotionItem[]; /** - * Items which this promotion have been applied to. Do not provide for orders.createtestorder. + * Items which this promotion have been applied to. Do not provide for `orders.createtestorder`. */ appliedItems?: Schema$OrderPromotionItem[]; /** @@ -2396,7 +2415,7 @@ export namespace content_v2_1 { */ endTime?: string | null; /** - * Required. The party funding the promotion. Only merchant is supported for orders.createtestorder. Acceptable values are: - "google" - "merchant" + * Required. The party funding the promotion. Only `merchant` is supported for `orders.createtestorder`. Acceptable values are: - "`google`" - "`merchant`" */ funder?: string | null; /** @@ -2408,7 +2427,7 @@ export namespace content_v2_1 { */ priceValue?: Schema$Price; /** - * A short title of the promotion to be shown on the checkout page. Do not provide for orders.createtestorder. + * A short title of the promotion to be shown on the checkout page. Do not provide for `orders.createtestorder`. */ shortTitle?: string | null; /** @@ -2416,11 +2435,11 @@ export namespace content_v2_1 { */ startTime?: string | null; /** - * Required. The category of the promotion. Only moneyOff is supported for orders.createtestorder. Acceptable values are: - "buyMGetMoneyOff" - "buyMGetNMoneyOff" - "buyMGetNPercentOff" - "buyMGetPercentOff" - "freeGift" - "freeGiftWithItemId" - "freeGiftWithValue" - "freeShippingOvernight" - "freeShippingStandard" - "freeShippingTwoDay" - "moneyOff" - "percentOff" - "rewardPoints" - "salePrice" + * Required. The category of the promotion. Only `moneyOff` is supported for `orders.createtestorder`. Acceptable values are: - "`buyMGetMoneyOff`" - "`buyMGetNMoneyOff`" - "`buyMGetNPercentOff`" - "`buyMGetPercentOff`" - "`freeGift`" - "`freeGiftWithItemId`" - "`freeGiftWithValue`" - "`freeShippingOvernight`" - "`freeShippingStandard`" - "`freeShippingTwoDay`" - "`moneyOff`" - "`percentOff`" - "`rewardPoints`" - "`salePrice`" */ subtype?: string | null; /** - * Estimated discount applied to tax (if allowed by law). Do not provide for orders.createtestorder. + * Estimated discount applied to tax (if allowed by law). Do not provide for `orders.createtestorder`. */ taxValue?: Schema$Price; /** @@ -2428,31 +2447,31 @@ export namespace content_v2_1 { */ title?: string | null; /** - * Required. The scope of the promotion. Only product is supported for orders.createtestorder. Acceptable values are: - "product" - "shipping" + * Required. The scope of the promotion. Only `product` is supported for `orders.createtestorder`. Acceptable values are: - "`product`" - "`shipping`" */ type?: string | null; } export interface Schema$OrderPromotionItem { /** - * The line item ID of a product. Do not provide for orders.createtestorder. + * The line item ID of a product. Do not provide for `orders.createtestorder`. */ lineItemId?: string | null; /** - * Required. Offer ID of a product. Only for orders.createtestorder. + * Required. Offer ID of a product. Only for `orders.createtestorder`. */ offerId?: string | null; /** - * orders.createtestorder. + * `orders.createtestorder`. */ productId?: string | null; /** - * The quantity of the associated product. Do not provide for orders.createtestorder. + * The quantity of the associated product. Do not provide for `orders.createtestorder`. */ quantity?: number | null; } export interface Schema$OrderRefund { /** - * The actor that created the refund. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant" + * The actor that created the refund. Acceptable values are: - "`customer`" - "`googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`" */ actor?: string | null; /** @@ -2464,7 +2483,7 @@ export namespace content_v2_1 { */ creationDate?: string | null; /** - * The reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the refund. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -2473,7 +2492,7 @@ export namespace content_v2_1 { reasonText?: string | null; } /** - * Order disbursement. All methods require the payment analyst role. + * Order disbursement. All methods require the payment analyst role. (== resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==) */ export interface Schema$OrderReportDisbursement { /** @@ -2565,7 +2584,7 @@ export namespace content_v2_1 { } export interface Schema$OrderReturn { /** - * The actor that created the refund. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant" + * The actor that created the refund. Acceptable values are: - "`customer`" - "`googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`" */ actor?: string | null; /** @@ -2577,7 +2596,7 @@ export namespace content_v2_1 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -2636,7 +2655,7 @@ export namespace content_v2_1 { */ quantity?: number | null; /** - * The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -2660,7 +2679,7 @@ export namespace content_v2_1 { */ operationId?: string | null; /** - * The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -2680,7 +2699,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersCancelTestOrderByCustomerRequest { /** - * The reason for the cancellation. Acceptable values are: - "changedMind" - "orderedWrongItem" - "other" + * The reason for the cancellation. Acceptable values are: - "`changedMind`" - "`orderedWrongItem`" - "`other`" */ reason?: string | null; } @@ -2692,11 +2711,11 @@ export namespace content_v2_1 { } export interface Schema$OrdersCreateTestOrderRequest { /** - * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order. Acceptable values are: - "US" - "FR" Defaults to US. + * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - "`US`" - "`FR`" Defaults to `US`. */ country?: string | null; /** - * The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - "template1" - "template1a" - "template1b" - "template2" - "template3" + * The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - "`template1`" - "`template1a`" - "`template1b`" - "`template2`" - "`template3`" */ templateName?: string | null; /** @@ -2742,7 +2761,7 @@ export namespace content_v2_1 { } export interface Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { /** - * The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. + * The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. */ carrier?: string | null; /** @@ -2776,7 +2795,7 @@ export namespace content_v2_1 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) - "db schenker" (DB Schenker) - "aramex" (Aramex) + * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "`ups`" (United Parcel Service) automatic status updates - "`usps`" (United States Postal Service) automatic status updates - "`fedex`" (FedEx) automatic status updates - "`dhl`" (DHL eCommerce) automatic status updates (US only) - "`ontrac`" (OnTrac) automatic status updates - "`dhl express`" (DHL Express) - "`deliv`" (Deliv) - "`dynamex`" (TForce) - "`lasership`" (LaserShip) - "`mpx`" (Military Parcel Xpress) - "`uds`" (United Delivery Service) - "`efw`" (Estes Forwarding Worldwide) - "`jd logistics`" (JD Logistics) - "`yunexpress`" (YunExpress) - "`china post`" (China Post) - "`china ems`" (China Post Express Mail Service) - "`singapore post`" (Singapore Post) - "`pos malaysia`" (Pos Malaysia) - "`postnl`" (PostNL) - "`ptt`" (PTT Turkish Post) - "`eub`" (ePacket) - "`chukou1`" (Chukou1 Logistics) Supported carriers for FR are: - "`la poste`" (La Poste) automatic status updates - "`colissimo`" (Colissimo by La Poste) automatic status updates - "`ups`" (United Parcel Service) automatic status updates - "`chronopost`" (Chronopost by La Poste) - "`gls`" (General Logistics Systems France) - "`dpd`" (DPD Group by GeoPost) - "`bpost`" (Belgian Post Group) - "`colis prive`" (Colis Privé) - "`boxtal`" (Boxtal) - "`geodis`" (GEODIS) - "`tnt`" (TNT) - "`db schenker`" (DB Schenker) - "`aramex`" (Aramex) */ carrier?: string | null; /** @@ -2784,7 +2803,7 @@ export namespace content_v2_1 { */ creationDate?: string | null; /** - * Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered + * Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered` */ deliveryDate?: string | null; /** @@ -2800,7 +2819,7 @@ export namespace content_v2_1 { */ shipmentGroupId?: string | null; /** - * The status of the shipment. Acceptable values are: - "delivered" - "readyForPickup" - "shipped" - "undeliverable" + * The status of the shipment. Acceptable values are: - "`delivered`" - "`readyForPickup`" - "`shipped`" - "`undeliverable`" */ status?: string | null; /** @@ -2844,7 +2863,7 @@ export namespace content_v2_1 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -2895,7 +2914,7 @@ export namespace content_v2_1 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "damagedOrUsed" - "missingComponent" - "notEligible" - "other" - "outOfReturnWindow" + * The reason for the return. Acceptable values are: - "`damagedOrUsed`" - "`missingComponent`" - "`notEligible`" - "`other`" - "`outOfReturnWindow`" */ reason?: string | null; /** @@ -2935,7 +2954,7 @@ export namespace content_v2_1 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3064,11 +3083,11 @@ export namespace content_v2_1 { } export interface Schema$OrdersUpdateShipmentRequest { /** - * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. + * The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. */ carrier?: string | null; /** - * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. + * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`. */ deliveryDate?: string | null; /** @@ -3080,7 +3099,7 @@ export namespace content_v2_1 { */ shipmentId?: string | null; /** - * New status for the shipment. Not updated if missing. Acceptable values are: - "delivered" - "undeliverable" + * New status for the shipment. Not updated if missing. Acceptable values are: - "`delivered`" - "`undeliverable`" */ status?: string | null; /** @@ -3100,17 +3119,17 @@ export namespace content_v2_1 { } export interface Schema$PickupCarrierService { /** - * The name of the pickup carrier (e.g., "UPS"). Required. + * The name of the pickup carrier (e.g., `"UPS"`). Required. */ carrierName?: string | null; /** - * The name of the pickup service (e.g., "Access point"). Required. + * The name of the pickup service (e.g., `"Access point"`). Required. */ serviceName?: string | null; } export interface Schema$PickupServicesPickupService { /** - * The name of the carrier (e.g., "UPS"). Always present. + * The name of the carrier (e.g., `"UPS"`). Always present. */ carrierName?: string | null; /** @@ -3118,7 +3137,7 @@ export namespace content_v2_1 { */ country?: string | null; /** - * The name of the pickup service (e.g., "Access point"). Always present. + * The name of the pickup service (e.g., `"Access point"`). Always present. */ serviceName?: string | null; } @@ -3134,7 +3153,7 @@ export namespace content_v2_1 { */ batchId?: number | null; /** - * The inventory to submit. Set this only if the method is inventory. + * The inventory to submit. Set this only if the method is `inventory`. */ inventory?: Schema$PosInventory; /** @@ -3142,19 +3161,19 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "delete" - "get" - "insert" - "inventory" - "sale" + * The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`inventory`" - "`sale`" */ method?: string | null; /** - * The sale information to submit. Set this only if the method is sale. + * The sale information to submit. Set this only if the method is `sale`. */ sale?: Schema$PosSale; /** - * The store information to submit. Set this only if the method is insert. + * The store information to submit. Set this only if the method is `insert`. */ store?: Schema$PosStore; /** - * The store code. Set this only if the method is delete or get. + * The store code. Set this only if the method is `delete` or `get`. */ storeCode?: string | null; /** @@ -3186,7 +3205,7 @@ export namespace content_v2_1 { */ inventory?: Schema$PosInventory; /** - * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -3239,7 +3258,7 @@ export namespace content_v2_1 { */ itemId?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#posInventory". + * Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`" */ kind?: string | null; /** @@ -3251,7 +3270,7 @@ export namespace content_v2_1 { */ quantity?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3285,7 +3304,7 @@ export namespace content_v2_1 { */ quantity?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3323,7 +3342,7 @@ export namespace content_v2_1 { */ quantity?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3359,7 +3378,7 @@ export namespace content_v2_1 { */ itemId?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#posSale". + * Identifies what kind of resource this is. Value: the fixed string "`content#posSale`" */ kind?: string | null; /** @@ -3375,7 +3394,7 @@ export namespace content_v2_1 { */ saleId?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3413,7 +3432,7 @@ export namespace content_v2_1 { */ saleId?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3455,7 +3474,7 @@ export namespace content_v2_1 { */ saleId?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3472,7 +3491,7 @@ export namespace content_v2_1 { */ export interface Schema$PosStore { /** - * Identifies what kind of resource this is. Value: the fixed string "content#posStore". + * Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" */ kind?: string | null; /** @@ -3500,11 +3519,11 @@ export namespace content_v2_1 { } export interface Schema$PostalCodeRange { /** - * A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required. + * A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required. */ postalCodeRangeBegin?: string | null; /** - * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. + * A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`. */ postalCodeRangeEnd?: string | null; } @@ -3519,7 +3538,7 @@ export namespace content_v2_1 { value?: string | null; } /** - * Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. + * Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. */ export interface Schema$Product { /** @@ -3559,7 +3578,7 @@ export namespace content_v2_1 { */ brand?: string | null; /** - * Required. The item's channel (online or local). Acceptable values are: - "local" - "online" + * Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`" */ channel?: string | null; /** @@ -3579,7 +3598,7 @@ export namespace content_v2_1 { */ costOfGoodsSold?: Schema$Price; /** - * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Shopping Actions. + * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Shopping Actions. */ customAttributes?: Schema$CustomAttribute[]; /** @@ -3635,7 +3654,7 @@ export namespace content_v2_1 { */ excludedDestinations?: string[] | null; /** - * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. + * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. */ expirationDate?: string | null; /** @@ -3651,7 +3670,7 @@ export namespace content_v2_1 { */ gtin?: string | null; /** - * The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. + * The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. */ id?: string | null; /** @@ -3663,7 +3682,7 @@ export namespace content_v2_1 { */ imageLink?: string | null; /** - * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. */ includedDestinations?: string[] | null; /** @@ -3679,7 +3698,7 @@ export namespace content_v2_1 { */ itemGroupId?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#product". + * Identifies what kind of resource this is. Value: the fixed string "`content#product`" */ kind?: string | null; /** @@ -3779,7 +3798,7 @@ export namespace content_v2_1 { */ shippingWidth?: Schema$ProductShippingDimension; /** - * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value (see size definition). + * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). */ sizes?: string[] | null; /** @@ -3791,7 +3810,7 @@ export namespace content_v2_1 { */ sizeType?: string | null; /** - * The source of the offer, i.e., how the offer was created. Acceptable values are: - "api" - "crawl" - "feed" + * The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" */ source?: string | null; /** @@ -3860,15 +3879,15 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "delete" - "get" - "insert" + * The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" */ method?: string | null; /** - * The product to insert. Only required if the method is insert. + * The product to insert. Only required if the method is `insert`. */ product?: Schema$Product; /** - * The ID of the product to get or delete. Only defined if the method is get or delete. + * The ID of the product to get or delete. Only defined if the method is `get` or `delete`. */ productId?: string | null; } @@ -3895,11 +3914,11 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#productsCustomBatchResponseEntry`" */ kind?: string | null; /** - * The inserted product. Only defined if the method is insert and if the request was successful. + * The inserted product. Only defined if the method is `insert` and if the request was successful. */ product?: Schema$Product; } @@ -3985,7 +4004,7 @@ export namespace content_v2_1 { */ itemLevelIssues?: Schema$ProductStatusItemLevelIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string "content#productStatus". + * Identifies what kind of resource this is. Value: the fixed string "`content#productStatus`" */ kind?: string | null; /** @@ -4036,7 +4055,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" + * The method of the batch entry. Acceptable values are: - "`get`" */ method?: string | null; /** @@ -4067,7 +4086,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#productstatusesCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -4167,7 +4186,7 @@ export namespace content_v2_1 { value?: number | null; } /** - * Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account. + * Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account. (== resource_for v2.1.pubsubnotificationsettings ==) */ export interface Schema$PubsubNotificationSettings { /** @@ -4175,11 +4194,11 @@ export namespace content_v2_1 { */ cloudTopicName?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#pubsubNotificationSettings". + * Identifies what kind of resource this is. Value: the fixed string "`content#pubsubNotificationSettings`" */ kind?: string | null; /** - * List of event types. Supported event types: orderPendingShipment. + * List of event types. Acceptable values are: - "`orderPendingShipment`" */ registeredEvents?: string[] | null; } @@ -4189,11 +4208,11 @@ export namespace content_v2_1 { */ applicableShippingLabels?: string[] | null; /** - * A list of carrier rates that can be referred to by mainTable or singleValue. + * A list of carrier rates that can be referred to by `mainTable` or `singleValue`. */ carrierRates?: Schema$CarrierRate[]; /** - * A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set. + * A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set. */ mainTable?: Schema$Table; /** @@ -4201,11 +4220,11 @@ export namespace content_v2_1 { */ name?: string | null; /** - * The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set. + * The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set. */ singleValue?: Schema$Value; /** - * A list of subtables referred to by mainTable. Can only be set if mainTable is set. + * A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set. */ subtables?: Schema$Table[]; } @@ -4215,7 +4234,7 @@ export namespace content_v2_1 { */ description?: string | null; /** - * Code of the refund reason. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * Code of the refund reason. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reasonCode?: string | null; } @@ -4244,7 +4263,7 @@ export namespace content_v2_1 { */ regionId?: string | null; /** - * The sale price of the product. Mandatory if sale_price_effective_date is defined. + * The sale price of the product. Mandatory if `sale_price_effective_date` is defined. */ salePrice?: Schema$Price; /** @@ -4271,7 +4290,7 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * Method of the batch request entry. Acceptable values are: - "insert" + * Method of the batch request entry. Acceptable values are: - "`insert`" */ method?: string | null; /** @@ -4327,7 +4346,7 @@ export namespace content_v2_1 { */ country?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#returnAddress". + * Identifies what kind of resource this is. Value: the fixed string "`content#returnAddress`" */ kind?: string | null; /** @@ -4385,15 +4404,15 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * Method of the batch request entry. Acceptable values are: - "delete" - "get" - "insert" + * Method of the batch request entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" */ method?: string | null; /** - * The return address to submit. Set this only if the method is insert. + * The return address to submit. Set this only if the method is `insert`. */ returnAddress?: Schema$ReturnAddress; /** - * The return address ID. Set this only if the method is delete or get. + * The return address ID. Set this only if the method is `delete` or `get`. */ returnAddressId?: string | null; } @@ -4417,7 +4436,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#returnaddressCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#returnaddressCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -4445,7 +4464,7 @@ export namespace content_v2_1 { */ country?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#returnPolicy". + * Identifies what kind of resource this is. Value: the fixed string "`content#returnPolicy`" */ kind?: string | null; /** @@ -4489,15 +4508,15 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * Method of the batch request entry. Acceptable values are: - "delete" - "get" - "insert" + * Method of the batch request entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" */ method?: string | null; /** - * The return policy to submit. Set this only if the method is insert. + * The return policy to submit. Set this only if the method is `insert`. */ returnPolicy?: Schema$ReturnPolicy; /** - * The return policy ID. Set this only if the method is delete or get. + * The return policy ID. Set this only if the method is `delete` or `get`. */ returnPolicyId?: string | null; } @@ -4521,7 +4540,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#returnpolicyCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#returnpolicyCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -4546,7 +4565,7 @@ export namespace content_v2_1 { */ numberOfDays?: string | null; /** - * Policy type. Use "lastReturnDate" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items. Acceptable values are: - "lastReturnDate" - "lifetimeReturns" - "noReturns" - "numberOfDaysAfterDelivery" + * Policy type. Use "lastReturnDate" for seasonal overrides only. Note that for most items a minimum of 30 days is required for returns. Exceptions may be made for electronics or non-returnable items such as food, perishables, and living things. A policy of less than 30 days can only be applied to those items. Acceptable values are: - "`lastReturnDate`" - "`lifetimeReturns`" - "`noReturns`" - "`numberOfDaysAfterDelivery`" */ type?: string | null; } @@ -4578,7 +4597,7 @@ export namespace content_v2_1 { */ deliveryDate?: string | null; /** - * Type of the return method. Acceptable values are: - "byMail" - "contactCustomerSupport" - "returnless" + * Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" */ returnMethodType?: string | null; /** @@ -4594,13 +4613,13 @@ export namespace content_v2_1 { */ shippingDate?: string | null; /** - * State of the shipment. Acceptable values are: - "completed" - "new" - "shipped" - "undeliverable" + * State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" */ state?: string | null; } export interface Schema$Row { /** - * The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required. + * The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required. */ cells?: Schema$Value[]; } @@ -4622,30 +4641,171 @@ export namespace content_v2_1 { */ deliveryTime?: Schema$DeliveryTime; /** - * Eligibility for this service. Acceptable values are: - "All scenarios" - "All scenarios except Shopping Actions" - "Shopping Actions" + * Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" */ eligibility?: string | null; /** - * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. + * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. */ minimumOrderValue?: Schema$Price; + /** + * Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value. + */ + minimumOrderValueTable?: Schema$MinimumOrderValueTable; /** * Free-form name of the service. Must be unique within target account. Required. */ name?: string | null; /** - * The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the getSupportedPickupServices method. Required if and only if the service delivery type is pickup. + * The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`. */ pickupService?: Schema$PickupCarrierService; /** - * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. + * Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap. */ rateGroups?: Schema$RateGroup[]; /** - * Type of locations this service ships orders to. Acceptable values are: - "delivery" - "pickup" + * Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`" */ shipmentType?: string | null; } + /** + * Settlement reports detail order-level and item-level credits and debits between you and Google. + */ + export interface Schema$SettlementReport { + /** + * The end date on which all transactions are included in the report, in ISO 8601 format. + */ + endDate?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "`content#settlementReport`" + */ + kind?: string | null; + /** + * The residual amount from the previous invoice. This is set only if the previous invoices are not paid because of negative balance. + */ + previousBalance?: Schema$Price; + /** + * The ID of the settlement report. + */ + settlementId?: string | null; + /** + * The start date on which all transactions are included in the report, in ISO 8601 format. + */ + startDate?: string | null; + /** + * The money due to the merchant. + */ + transferAmount?: Schema$Price; + /** + * Date on which transfer for this payment was initiated by Google, in ISO 8601 format. + */ + transferDate?: string | null; + /** + * The list of bank identifiers used for the transfer. e.g. Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID. + */ + transferIds?: string[] | null; + } + export interface Schema$SettlementreportsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "content#settlementreportsListResponse". + */ + kind?: string | null; + /** + * The token for the retrieval of the next page of returns. + */ + nextPageToken?: string | null; + resources?: Schema$SettlementReport[]; + } + /** + * Settlement transactions give a detailed breakdown of the settlement report. + */ + export interface Schema$SettlementTransaction { + /** + * The amount for the transaction. + */ + amount?: Schema$SettlementTransactionAmount; + /** + * Identifiers of the transaction. + */ + identifiers?: Schema$SettlementTransactionIdentifiers; + /** + * Identifies what kind of resource this is. Value: the fixed string "`content#settlementTransaction`" + */ + kind?: string | null; + /** + * Details of the transaction. + */ + transaction?: Schema$SettlementTransactionTransaction; + } + export interface Schema$SettlementTransactionAmount { + commission?: Schema$SettlementTransactionAmountCommission; + /** + * The description of the event. Acceptable values are: - "`taxWithhold`" - "`principal`" - "`principalAdjustment`" - "`shippingFee`" - "`merchantRemittedSalesTax`" - "`googleRemittedSalesTax`" - "`merchantCoupon`" - "`merchantCouponTax`" - "`merchantRemittedDisposalTax`" - "`googleRemittedDisposalTax`" - "`merchantRemittedRedemptionFee`" - "`googleRemittedRedemptionFee`" - "`eeeEcoFee`" - "`furnitureEcoFee`" - "`copyPrivateFee`" - "`eeeEcoFeeCommission`" - "`furnitureEcoFeeCommission`" - "`copyPrivateFeeCommission`" - "`principalRefund`" - "`principalRefundTax`" - "`itemCommission`" - "`adjustmentCommission`" - "`shippingFeeCommission`" - "`commissionRefund`" - "`damaged`" - "`damagedOrDefectiveItem`" - "`expiredItem`" - "`faultyItem`" - "`incorrectItemReceived`" - "`itemMissing`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`storePackageMissing`" - "`transitPackageMissing`" - "`unsuccessfulDeliveryUndeliverable`" - "`wrongChargeInStore`" - "`wrongItem`" - "`returns`" - "`undeliverable`" - "`refundFromMerchant`" - "`returnLabelShippingFee`" + */ + description?: string | null; + /** + * The amount that contributes to the line item price. + */ + transactionAmount?: Schema$Price; + /** + * The type of the amount. Acceptable values are: - "`itemPrice`" - "`orderPrice`" - "`refund`" - "`earlyRefund`" - "`courtesyRefund`" - "`returnRefund`" - "`returnLabelShippingFeeAmount`" + */ + type?: string | null; + } + export interface Schema$SettlementTransactionAmountCommission { + /** + * The category of the commission. Acceptable values are: - "`animalsAndPetSupplies`" - "`dogCatFoodAndCatLitter`" - "`apparelAndAccessories`" - "`shoesHandbagsAndSunglasses`" - "`costumesAndAccessories`" - "`jewelry`" - "`watches`" - "`hobbiesArtsAndCrafts`" - "`homeAndGarden`" - "`entertainmentCollectibles`" - "`collectibleCoins`" - "`sportsCollectibles`" - "`sportingGoods`" - "`toysAndGames`" - "`musicalInstruments`" - "`giftCards`" - "`babyAndToddler`" - "`babyFoodWipesAndDiapers`" - "`businessAndIndustrial`" - "`camerasOpticsAndPhotography`" - "`consumerElectronics`" - "`electronicsAccessories`" - "`personalComputers`" - "`videoGameConsoles`" - "`foodAndGrocery`" - "`beverages`" - "`tobaccoProducts`" - "`furniture`" - "`hardware`" - "`buildingMaterials`" - "`tools`" - "`healthAndPersonalCare`" - "`beauty`" - "`householdSupplies`" - "`kitchenAndDining`" - "`majorAppliances`" - "`luggageAndBags`" - "`media`" - "`officeSupplies`" - "`softwareAndVideoGames`" - "`vehiclePartsAndAccessories`" - "`vehicleTiresAndWheels`" - "`vehicles`" - "`everythingElse`" + */ + category?: string | null; + /** + * Rate of the commission in percentage. + */ + rate?: string | null; + } + export interface Schema$SettlementTransactionIdentifiers { + /** + * The identifier of the adjustments, if it is available. + */ + adjustmentId?: string | null; + /** + * The merchant provided order ID. + */ + merchantOrderId?: string | null; + /** + * The unique ID of the settlement transaction entry. + */ + settlementEntryId?: string | null; + /** + * The shipment ids for the item. + */ + shipmentIds?: string[] | null; + /** + * The Google transaction ID. + */ + transactionId?: string | null; + } + export interface Schema$SettlementtransactionsListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "content#settlementtransactionsListResponse". + */ + kind?: string | null; + /** + * The token for the retrieval of the next page of returns. + */ + nextPageToken?: string | null; + resources?: Schema$SettlementTransaction[]; + } + export interface Schema$SettlementTransactionTransaction { + /** + * The time on which the event occurred in ISO 8601 format. + */ + postDate?: string | null; + /** + * The type of the transaction that occurred. Acceptable values are: - "`order`" - "`reversal`" - "`orderRefund`" - "`reversalRefund`" - "`issueRelatedRefundAndReplacement`" - "`returnLabelShippingFeeTransaction`" - "`reversalIssueRelatedRefundAndReplacement`" - "`reversalReturnLabelShippingFeeTransaction`" + */ + type?: string | null; + } export interface Schema$ShipmentInvoice { /** * [required] Invoice summary. @@ -4656,7 +4816,7 @@ export namespace content_v2_1 { */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string | null; } @@ -4680,7 +4840,7 @@ export namespace content_v2_1 { } export interface Schema$ShipmentTrackingInfo { /** - * The shipping carrier that handles the package. Acceptable values are: - "boxtal" - "bpost" - "chronopost" - "colisPrive" - "colissimo" - "cxt" - "deliv" - "dhl" - "dpd" - "dynamex" - "eCourier" - "easypost" - "efw" - "fedex" - "fedexSmartpost" - "geodis" - "gls" - "googleCourier" - "gsx" - "jdLogistics" - "laPoste" - "lasership" - "manual" - "mpx" - "onTrac" - "other" - "tnt" - "uds" - "ups" - "usps" + * The shipping carrier that handles the package. Acceptable values are: - "`boxtal`" - "`bpost`" - "`chronopost`" - "`colisPrive`" - "`colissimo`" - "`cxt`" - "`deliv`" - "`dhl`" - "`dpd`" - "`dynamex`" - "`eCourier`" - "`easypost`" - "`efw`" - "`fedex`" - "`fedexSmartpost`" - "`geodis`" - "`gls`" - "`googleCourier`" - "`gsx`" - "`jdLogistics`" - "`laPoste`" - "`lasership`" - "`manual`" - "`mpx`" - "`onTrac`" - "`other`" - "`tnt`" - "`uds`" - "`ups`" - "`usps`" */ carrier?: string | null; /** @@ -4697,7 +4857,7 @@ export namespace content_v2_1 { */ accountId?: string | null; /** - * A list of postal code groups that can be referred to in services. Optional. + * A list of postal code groups that can be referred to in `services`. Optional. */ postalCodeGroups?: Schema$PostalCodeGroup[]; /** @@ -4728,11 +4888,11 @@ export namespace content_v2_1 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" - "update" + * The method of the batch entry. Acceptable values are: - "`get`" - "`update`" */ method?: string | null; /** - * The account shipping settings to update. Only defined if the method is update. + * The account shipping settings to update. Only defined if the method is `update`. */ shippingSettings?: Schema$ShippingSettings; } @@ -4759,7 +4919,7 @@ export namespace content_v2_1 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#shippingsettingsCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -4822,7 +4982,7 @@ export namespace content_v2_1 { */ rowHeaders?: Schema$Headers; /** - * The list of rows that constitute the table. Must have the same length as rowHeaders. Required. + * The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required. */ rows?: Schema$Row[]; } @@ -4832,7 +4992,7 @@ export namespace content_v2_1 { */ enableOrderinvoices?: boolean | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#testOrder". + * Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`" */ kind?: string | null; /** @@ -4840,23 +5000,23 @@ export namespace content_v2_1 { */ lineItems?: Schema$TestOrderLineItem[]; /** - * Determines if test order must be pulled by merchant or pushed to merchant via push integration. Acceptable values are: - "checkoutIntegration" - "merchantPull" + * Restricted. Do not use. */ notificationMode?: string | null; /** - * Required. The billing address. Acceptable values are: - "dwight" - "jim" - "pam" + * Required. The billing address. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" */ predefinedBillingAddress?: string | null; /** - * Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - "dwight" - "jim" - "pam" + * Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" */ predefinedDeliveryAddress?: string | null; /** - * Required. Email address of the customer. Acceptable values are: - "pog.dwight.schrute@gmail.com" - "pog.jim.halpert@gmail.com" - "penpog.pam.beesly@gmail.comding" + * Required. Email address of the customer. Acceptable values are: - "`pog.dwight.schrute@gmail.com`" - "`pog.jim.halpert@gmail.com`" - "`penpog.pam.beesly@gmail.comding`" */ predefinedEmail?: string | null; /** - * Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup. Acceptable values are: - "dwight" - "jim" - "pam" + * Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" */ predefinedPickupDetails?: string | null; /** @@ -4868,7 +5028,7 @@ export namespace content_v2_1 { */ shippingCost?: Schema$Price; /** - * Required. The requested shipping option. Acceptable values are: - "economy" - "expedited" - "oneDay" - "sameDay" - "standard" - "twoDay" + * Required. The requested shipping option. Acceptable values are: - "`economy`" - "`expedited`" - "`oneDay`" - "`sameDay`" - "`standard`" - "`twoDay`" */ shippingOption?: string | null; } @@ -4896,11 +5056,11 @@ export namespace content_v2_1 { */ brand?: string | null; /** - * Required. Condition or state of the item. Acceptable values are: - "new" + * Required. Condition or state of the item. Acceptable values are: - "`new`" */ condition?: string | null; /** - * Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - "en" - "fr" + * Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - "`en`" - "`fr`" */ contentLanguage?: string | null; /** @@ -4946,12 +5106,12 @@ export namespace content_v2_1 { } export interface Schema$TransitTable { /** - * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. + * A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. */ postalCodeGroupNames?: string[] | null; rows?: Schema$TransitTableTransitTimeRow[]; /** - * A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"]. + * A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`. */ transitTimeLabels?: string[] | null; } @@ -4960,7 +5120,7 @@ export namespace content_v2_1 { } export interface Schema$TransitTableTransitTimeRowTransitTimeValue { /** - * Must be greater than or equal to minTransitTimeInDays. + * Must be greater than or equal to `minTransitTimeInDays`. */ maxTransitTimeInDays?: number | null; /** @@ -4988,7 +5148,7 @@ export namespace content_v2_1 { */ additionalChargeAmount?: Schema$Amount; /** - * [required] Type of the additional charge. Acceptable values are: - "shipping" + * [required] Type of the additional charge. Acceptable values are: - "`shipping`" */ type?: string | null; } @@ -4998,16 +5158,16 @@ export namespace content_v2_1 { */ taxAmount?: Schema$Price; /** - * Optional name of the tax type. This should only be provided if taxType is otherFeeTax. + * Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`. */ taxName?: string | null; /** - * [required] Type of the tax. Acceptable values are: - "otherFee" - "otherFeeTax" - "sales" + * [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`" */ taxType?: string | null; } /** - * The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. + * The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. */ export interface Schema$Value { /** @@ -5023,7 +5183,7 @@ export namespace content_v2_1 { */ noShipping?: boolean | null; /** - * A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set. + * A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set. */ pricePercentage?: string | null; /** @@ -5033,7 +5193,7 @@ export namespace content_v2_1 { } export interface Schema$Weight { /** - * Required. The weight unit. Acceptable values are: - "kg" - "lb" + * Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`" */ unit?: string | null; /** @@ -14417,6 +14577,342 @@ export namespace content_v2_1 { merchantId?: string; } + export class Resource$Settlementreports { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * content.settlementreports.get + * @desc Retrieves a settlement report from your Merchant Center account. + * @alias content.settlementreports.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.merchantId The Merchant Center account of the settlement report. + * @param {string} params.settlementId The Google-provided ID of the settlement. + * @param {object} [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$Settlementreports$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Settlementreports$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Settlementreports$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Settlementreports$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Settlementreports$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settlementreports$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/content/v2.1/{merchantId}/settlementreports/{settlementId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['merchantId', 'settlementId'], + pathParams: ['merchantId', 'settlementId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * content.settlementreports.list + * @desc Retrieves a list of settlement reports from your Merchant Center account. + * @alias content.settlementreports.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page. + * @param {string} params.merchantId The Merchant Center account to list settlements for. + * @param {string=} params.pageToken The token returned by the previous request. + * @param {string=} params.transferEndDate Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format. + * @param {string=} params.transferStartDate Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format. + * @param {object} [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$Settlementreports$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Settlementreports$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Settlementreports$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Settlementreports$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Settlementreports$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settlementreports$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/content/v2.1/{merchantId}/settlementreports' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['merchantId'], + pathParams: ['merchantId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Settlementreports$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The Merchant Center account of the settlement report. + */ + merchantId?: string; + /** + * The Google-provided ID of the settlement. + */ + settlementId?: string; + } + export interface Params$Resource$Settlementreports$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of settlements to return in the response, used for paging. The default value is 200 returns per page, and the maximum allowed value is 5000 returns per page. + */ + maxResults?: number; + /** + * The Merchant Center account to list settlements for. + */ + merchantId?: string; + /** + * The token returned by the previous request. + */ + pageToken?: string; + /** + * Obtains settlements which have transactions before this date (inclusively), in ISO 8601 format. + */ + transferEndDate?: string; + /** + * Obtains settlements which have transactions after this date (inclusively), in ISO 8601 format. + */ + transferStartDate?: string; + } + + export class Resource$Settlementtransactions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * content.settlementtransactions.list + * @desc Retrieves a list of transactions for the settlement. + * @alias content.settlementtransactions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.maxResults The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page. + * @param {string} params.merchantId The Merchant Center account to list transactions for. + * @param {string=} params.pageToken The token returned by the previous request. + * @param {string} params.settlementId The Google-provided ID of the settlement. + * @param {string=} params.transactionIds The list of transactions to return. If not set, all transactions will be returned. + * @param {object} [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$Settlementtransactions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Settlementtransactions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Settlementtransactions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Settlementtransactions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Settlementtransactions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Settlementtransactions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/content/v2.1/{merchantId}/settlementreports/{settlementId}/transactions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['merchantId', 'settlementId'], + pathParams: ['merchantId', 'settlementId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Settlementtransactions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of transactions to return in the response, used for paging. The default value is 200 transactions per page, and the maximum allowed value is 5000 transactions per page. + */ + maxResults?: number; + /** + * The Merchant Center account to list transactions for. + */ + merchantId?: string; + /** + * The token returned by the previous request. + */ + pageToken?: string; + /** + * The Google-provided ID of the settlement. + */ + settlementId?: string; + /** + * The list of transactions to return. If not set, all transactions will be returned. + */ + transactionIds?: string[]; + } + export class Resource$Shippingsettings { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 091d0aa74a0..745fadbe73e 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -136,7 +136,7 @@ export namespace content_v2 { */ adultContent?: boolean | null; /** - * List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. + * List of linked AdWords accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the AdWords interface or through the AdWords API. To delete an active link, or to cancel a link request, remove it from the list. */ adwordsLinks?: Schema$AccountAdwordsLink[]; /** @@ -152,7 +152,7 @@ export namespace content_v2 { */ id?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#account". + * Identifies what kind of resource this is. Value: the fixed string "`content#account`" */ kind?: string | null; /** @@ -176,7 +176,7 @@ export namespace content_v2 { */ websiteUrl?: string | null; /** - * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status active to the list. It will remain in a pending state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. + * List of linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list. */ youtubeChannelLinks?: Schema$AccountYouTubeChannelLink[]; } @@ -208,7 +208,7 @@ export namespace content_v2 { */ adwordsId?: string | null; /** - * Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in Google AdWords or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "active" - "pending" + * Status of the link between this Merchant Center account and the AdWords account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google AdWords or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - "`active`" - "`pending`" */ status?: string | null; } @@ -246,7 +246,7 @@ export namespace content_v2 { */ gmbEmail?: string | null; /** - * Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "active" - "pending" + * Status of the link between this Merchant Center account and the GMB account. Acceptable values are: - "`active`" - "`pending`" */ status?: string | null; } @@ -287,11 +287,11 @@ export namespace content_v2 { */ export interface Schema$AccountsCustomBatchRequestEntry { /** - * The account to create or update. Only defined if the method is insert or update. + * The account to create or update. Only defined if the method is `insert` or `update`. */ account?: Schema$Account; /** - * The ID of the targeted account. Only defined if the method is not insert. + * The ID of the targeted account. Only defined if the method is not `insert`. */ accountId?: string | null; /** @@ -299,11 +299,11 @@ export namespace content_v2 { */ batchId?: number | null; /** - * Whether the account should be deleted if the account has offers. Only applicable if the method is delete. + * Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`. */ force?: boolean | null; /** - * Details about the link request. + * Details about the `link` request. */ linkRequest?: Schema$AccountsCustomBatchRequestEntryLinkRequest; /** @@ -311,17 +311,17 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "claimWebsite" - "delete" - "get" - "insert" - "link" - "update" + * The method of the batch entry. Acceptable values are: - "`claimWebsite`" - "`delete`" - "`get`" - "`insert`" - "`link`" - "`update`" */ method?: string | null; /** - * Only applicable if the method is claimwebsite. Indicates whether or not to take the claim from another account in case there is a conflict. + * Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict. */ overwrite?: boolean | null; } export interface Schema$AccountsCustomBatchRequestEntryLinkRequest { /** - * Action to perform for this link. The "request" action is only available to select merchants. Acceptable values are: - "approve" - "remove" - "request" + * Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`" */ action?: string | null; /** @@ -329,7 +329,7 @@ export namespace content_v2 { */ linkedAccountId?: string | null; /** - * Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform" + * Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" */ linkType?: string | null; } @@ -348,7 +348,7 @@ export namespace content_v2 { */ export interface Schema$AccountsCustomBatchResponseEntry { /** - * The retrieved, created, or updated account. Not defined if the method was delete, claimwebsite or link. + * The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`. */ account?: Schema$Account; /** @@ -360,17 +360,17 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#accountsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#accountsCustomBatchResponseEntry`" */ kind?: string | null; /** - * Deprecated. This field is never set. Acceptable values are: - "active" - "inactive" - "pending" + * Deprecated. This field is never set. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ linkStatus?: string | null; } export interface Schema$AccountsLinkRequest { /** - * Action to perform for this link. The "request" action is only available to select merchants. Acceptable values are: - "approve" - "remove" - "request" + * Action to perform for this link. The `"request"` action is only available to select merchants. Acceptable values are: - "`approve`" - "`remove`" - "`request`" */ action?: string | null; /** @@ -378,7 +378,7 @@ export namespace content_v2 { */ linkedAccountId?: string | null; /** - * Type of the link between the two accounts. Acceptable values are: - "channelPartner" - "eCommercePlatform" + * Type of the link between the two accounts. Acceptable values are: - "`channelPartner`" - "`eCommercePlatform`" */ linkType?: string | null; } @@ -416,7 +416,7 @@ export namespace content_v2 { */ dataQualityIssues?: Schema$AccountStatusDataQualityIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string "content#accountStatus". + * Identifies what kind of resource this is. Value: the fixed string "`content#accountStatus`" */ kind?: string | null; /** @@ -450,7 +450,7 @@ export namespace content_v2 { */ id?: string | null; /** - * Severity of the issue. Acceptable values are: - "critical" - "error" - "suggestion" + * Severity of the issue. Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" */ severity?: string | null; /** @@ -469,7 +469,7 @@ export namespace content_v2 { location?: string | null; numItems?: number | null; /** - * Acceptable values are: - "critical" - "error" - "suggestion" + * Acceptable values are: - "`critical`" - "`error`" - "`suggestion`" */ severity?: string | null; submittedValue?: string | null; @@ -501,7 +501,7 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" + * The method of the batch entry. Acceptable values are: - "`get`" */ method?: string | null; } @@ -586,7 +586,7 @@ export namespace content_v2 { } export interface Schema$AccountStatusProducts { /** - * The channel the data applies to. Acceptable values are: - "local" - "online" + * The channel the data applies to. Acceptable values are: - "`local`" - "`online`" */ channel?: string | null; /** @@ -656,7 +656,7 @@ export namespace content_v2 { */ accountId?: string | null; /** - * The account tax settings to update. Only defined if the method is update. + * The account tax settings to update. Only defined if the method is `update`. */ accountTax?: Schema$AccountTax; /** @@ -668,7 +668,7 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" - "update" + * The method of the batch entry. Acceptable values are: - "`get`" - "`update`" */ method?: string | null; } @@ -699,7 +699,7 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#accounttaxCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#accounttaxCustomBatchResponseEntry`" */ kind?: string | null; } @@ -767,7 +767,7 @@ export namespace content_v2 { */ channelId?: string | null; /** - * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either active if it was approved in YT Creator Studio or pending if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status active when it's still pending or with status pending when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status inactive is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. + * Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the intended status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. */ status?: string | null; } @@ -789,15 +789,15 @@ export namespace content_v2 { } export interface Schema$CarrierRate { /** - * Carrier service, such as "UPS" or "Fedex". The list of supported carriers can be retrieved via the getSupportedCarriers method. Required. + * Carrier service, such as `"UPS"` or `"Fedex"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required. */ carrierName?: string | null; /** - * Carrier service, such as "ground" or "2 days". The list of supported services for a carrier can be retrieved via the getSupportedCarriers method. Required. + * Carrier service, such as `"ground"` or `"2 days"`. The list of supported services for a carrier can be retrieved via the `getSupportedCarriers` method. Required. */ carrierService?: string | null; /** - * Additive shipping rate modifier. Can be negative. For example { "value": "1", "currency" : "USD" } adds $1 to the rate, { "value": "-3", "currency" : "USD" } removes $3 from the rate. Optional. + * Additive shipping rate modifier. Can be negative. For example `{ "value": "1", "currency" : "USD" }` adds $1 to the rate, `{ "value": "-3", "currency" : "USD" }` removes $3 from the rate. Optional. */ flatAdjustment?: Schema$Price; /** @@ -809,7 +809,7 @@ export namespace content_v2 { */ originPostalCode?: string | null; /** - * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example "5.4" increases the rate by 5.4%, "-3" decreases the rate by 3%. Optional. + * Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%. Optional. */ percentageAdjustment?: string | null; } @@ -819,11 +819,11 @@ export namespace content_v2 { */ country?: string | null; /** - * The name of the carrier (e.g., "UPS"). Always present. + * The name of the carrier (e.g., `"UPS"`). Always present. */ name?: string | null; /** - * A list of supported services (e.g., "ground") for that carrier. Contains at least one service. + * A list of supported services (e.g., `"ground"`) for that carrier. Contains at least one service. */ services?: string[] | null; } @@ -833,7 +833,7 @@ export namespace content_v2 { */ name?: string | null; /** - * The type of the attribute. Acceptable values are: - "boolean" - "datetimerange" - "float" - "group" - "int" - "price" - "text" - "time" - "url" + * The type of the attribute. Acceptable values are: - "`boolean`" - "`datetimerange`" - "`float`" - "`group`" - "`int`" - "`price`" - "`text`" - "`time`" - "`url`" */ type?: string | null; /** @@ -851,7 +851,7 @@ export namespace content_v2 { */ description?: string | null; /** - * Code of the return reason. Acceptable values are: - "betterPriceFound" - "changedMind" - "damagedOrDefectiveItem" - "didNotMatchDescription" - "doesNotFit" - "expiredItem" - "incorrectItemReceived" - "noLongerNeeded" - "notSpecified" - "orderedWrongItem" - "other" - "qualityNotExpected" - "receivedTooLate" - "undeliverable" + * Code of the return reason. Acceptable values are: - "`betterPriceFound`" - "`changedMind`" - "`damagedOrDefectiveItem`" - "`didNotMatchDescription`" - "`doesNotFit`" - "`expiredItem`" - "`incorrectItemReceived`" - "`noLongerNeeded`" - "`notSpecified`" - "`orderedWrongItem`" - "`other`" - "`qualityNotExpected`" - "`receivedTooLate`" - "`undeliverable`" */ reasonCode?: string | null; } @@ -888,11 +888,11 @@ export namespace content_v2 { */ attributeLanguage?: string | null; /** - * [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targetCountry. + * [DEPRECATED] Please use targets[].language instead. The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targetCountry`. */ contentLanguage?: string | null; /** - * Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "local products" - "product inventory" - "products" + * Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - "`local products`" - "`product inventory`" - "`products`" */ contentType?: string | null; /** @@ -916,7 +916,7 @@ export namespace content_v2 { */ intendedDestinations?: string[] | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#datafeed". + * Identifies what kind of resource this is. Value: the fixed string "`content#datafeed`" */ kind?: string | null; /** @@ -969,21 +969,21 @@ export namespace content_v2 { */ username?: string | null; /** - * The day of the week the feed file should be fetched. Acceptable values are: - "monday" - "tuesday" - "wednesday" - "thursday" - "friday" - "saturday" - "sunday" + * The day of the week the feed file should be fetched. Acceptable values are: - "`monday`" - "`tuesday`" - "`wednesday`" - "`thursday`" - "`friday`" - "`saturday`" - "`sunday`" */ weekday?: string | null; } export interface Schema$DatafeedFormat { /** - * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "pipe" - "tab" - "tilde" + * Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`pipe`" - "`tab`" - "`tilde`" */ columnDelimiter?: string | null; /** - * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "latin-1" - "utf-16be" - "utf-16le" - "utf-8" - "windows-1252" + * Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - "`latin-1`" - "`utf-16be`" - "`utf-16le`" - "`utf-8`" - "`windows-1252`" */ fileEncoding?: string | null; /** - * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "normal character" - "value quoting" + * Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - "`normal character`" - "`value quoting`" */ quotingMode?: string | null; } @@ -1014,7 +1014,7 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "delete" - "fetchNow" - "get" - "insert" - "update" + * The method of the batch entry. Acceptable values are: - "`delete`" - "`fetchNow`" - "`get`" - "`insert`" - "`update`" */ method?: string | null; } @@ -1087,7 +1087,7 @@ export namespace content_v2 { */ itemsValid?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#datafeedStatus". + * Identifies what kind of resource this is. Value: the fixed string "`content#datafeedStatus`" */ kind?: string | null; /** @@ -1099,7 +1099,7 @@ export namespace content_v2 { */ lastUploadDate?: string | null; /** - * The processing status of the feed. Acceptable values are: - ""failure": The feed could not be processed or all items had errors." - "in progress": The feed is being processed. - "none": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "success": The feed was processed successfully, though some items might have had errors. + * The processing status of the feed. Acceptable values are: - "`"`failure`": The feed could not be processed or all items had errors.`" - "`in progress`": The feed is being processed. - "`none`": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - "`success`": The feed was processed successfully, though some items might have had errors. */ processingStatus?: string | null; /** @@ -1159,7 +1159,7 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" + * The method of the batch entry. Acceptable values are: - "`get`" */ method?: string | null; } @@ -1228,11 +1228,11 @@ export namespace content_v2 { */ excludedDestinations?: string[] | null; /** - * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. List of supported destinations (if available to the account): - DisplayAds - Shopping - ShoppingActions - SurfacesAcrossGoogle */ includedDestinations?: string[] | null; /** - * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for targets[].country. + * The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`. */ language?: string | null; } @@ -1250,11 +1250,11 @@ export namespace content_v2 { */ holidayCutoffs?: Schema$HolidayCutoff[]; /** - * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to minHandlingTimeInDays. + * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`. */ maxHandlingTimeInDays?: number | null; /** - * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to minTransitTimeInDays. + * Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`. */ maxTransitTimeInDays?: number | null; /** @@ -1262,7 +1262,7 @@ export namespace content_v2 { */ minHandlingTimeInDays?: number | null; /** - * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either {min,max}TransitTimeInDays or transitTimeTable must be set, but not both. + * Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both. */ minTransitTimeInDays?: number | null; /** @@ -1270,7 +1270,7 @@ export namespace content_v2 { */ transitBusinessDayConfig?: Schema$BusinessDayConfig; /** - * Transit time table, number of business days spent in transit based on row and column dimensions. Either {min,max}TransitTimeInDays or transitTimeTable can be set, but not both. + * Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both. */ transitTimeTable?: Schema$TransitTable; } @@ -1296,7 +1296,7 @@ export namespace content_v2 { */ export interface Schema$Errors { /** - * The HTTP status of the first error in errors. + * The HTTP status of the first error in `errors`. */ code?: number | null; /** @@ -1304,7 +1304,7 @@ export namespace content_v2 { */ errors?: Schema$Error[]; /** - * The message of the first error in errors. + * The message of the first error in `errors`. */ message?: string | null; } @@ -1337,7 +1337,7 @@ export namespace content_v2 { type?: string | null; } /** - * A non-empty list of row or column headers for a table. Exactly one of prices, weights, numItems, postalCodeGroupNames, or location must be set. + * A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set. */ export interface Schema$Headers { /** @@ -1345,19 +1345,19 @@ export namespace content_v2 { */ locations?: Schema$LocationIdSet[]; /** - * A list of inclusive number of items upper bounds. The last value can be "infinity". For example ["10", "50", "infinity"] represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. + * A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", " 50 items". Must be non-empty. Can only be set if all other fields are not set. */ numberOfItems?: string[] | null; /** - * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. + * A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set. */ postalCodeGroupNames?: string[] | null; /** - * A list of inclusive order price upper bounds. The last price's value can be "infinity". For example [{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}] represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. + * A list of inclusive order price upper bounds. The last price's value can be `"infinity"`. For example `[{"value": "10", "currency": "USD"}, {"value": "500", "currency": "USD"}, {"value": "infinity", "currency": "USD"}]` represents the headers "<= $10", " $500". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set. */ prices?: Schema$Price[]; /** - * A list of inclusive order weight upper bounds. The last weight's value can be "infinity". For example [{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}] represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set. + * A list of inclusive order weight upper bounds. The last weight's value can be `"infinity"`. For example `[{"value": "10", "unit": "kg"}, {"value": "50", "unit": "kg"}, {"value": "infinity", "unit": "kg"}]` represents the headers "<= 10kg", " 50kg". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set. */ weights?: Schema$Weight[]; } @@ -1405,7 +1405,7 @@ export namespace content_v2 { */ id?: string | null; /** - * The holiday type. Always present. Acceptable values are: - "Christmas" - "Easter" - "Father's Day" - "Halloween" - "Independence Day (USA)" - "Mother's Day" - "Thanksgiving" - "Valentine's Day" + * The holiday type. Always present. Acceptable values are: - "`Christmas`" - "`Easter`" - "`Father's Day`" - "`Halloween`" - "`Independence Day (USA)`" - "`Mother's Day`" - "`Thanksgiving`" - "`Valentine's Day`" */ type?: string | null; } @@ -1419,9 +1419,12 @@ export namespace content_v2 { */ months?: string | null; } + /** + * (== resource_for v2.inventory ==) + */ export interface Schema$Inventory { /** - * The availability of the product. Acceptable values are: - "in stock" - "out of stock" - "preorder" + * The availability of the product. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`" */ availability?: string | null; /** @@ -1453,7 +1456,7 @@ export namespace content_v2 { */ instoreProductLocation?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#inventory". + * Identifies what kind of resource this is. Value: the fixed string "`content#inventory`" */ kind?: string | null; /** @@ -1461,7 +1464,7 @@ export namespace content_v2 { */ loyaltyPoints?: Schema$LoyaltyPoints; /** - * Store pickup information. Only supported for local inventory. Not setting pickup means "don't update" while setting it to the empty value ({} in JSON) means "delete". Otherwise, pickupMethod and pickupSla must be set together, unless pickupMethod is "not supported". + * Store pickup information. Only supported for local inventory. Not setting `pickup` means "don't update" while setting it to the empty value (`{}` in JSON) means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set together, unless `pickupMethod` is "not supported". */ pickup?: Schema$InventoryPickup; /** @@ -1473,7 +1476,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The sale price of the product. Mandatory if sale_price_effective_date is defined. + * The sale price of the product. Mandatory if `sale_price_effective_date` is defined. */ salePrice?: Schema$Price; /** @@ -1512,7 +1515,7 @@ export namespace content_v2 { */ productId?: string | null; /** - * The code of the store for which to update price and availability. Use online to update price and availability of an online product. + * The code of the store for which to update price and availability. Use `online` to update price and availability of an online product. */ storeCode?: string | null; } @@ -1539,23 +1542,23 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#inventoryCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#inventoryCustomBatchResponseEntry`" */ kind?: string | null; } export interface Schema$InventoryPickup { /** - * Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with pickupSla. Acceptable values are: - "buy" - "not supported" - "reserve" - "ship to store" + * Whether store pickup is available for this offer and whether the pickup option should be shown as buy, reserve, or not supported. Only supported for local inventory. Unless the value is "not supported", must be submitted together with `pickupSla`. Acceptable values are: - "`buy`" - "`not supported`" - "`reserve`" - "`ship to store`" */ pickupMethod?: string | null; /** - * The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with pickupMethod. Acceptable values are: - "five day" - "four day" - "multi day" - "multi week" - "next day" - "same day" - "seven day" - "six day" - "three day" - "two day" + * The expected date that an order will be ready for pickup, relative to when the order is placed. Only supported for local inventory. Must be submitted together with `pickupMethod`. Acceptable values are: - "`five day`" - "`four day`" - "`multi day`" - "`multi week`" - "`next day`" - "`same day`" - "`seven day`" - "`six day`" - "`three day`" - "`two day`" */ pickupSla?: string | null; } export interface Schema$InventorySetRequest { /** - * The availability of the product. Acceptable values are: - "in stock" - "out of stock" - "preorder" + * The availability of the product. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`" */ availability?: string | null; /** @@ -1591,7 +1594,7 @@ export namespace content_v2 { */ loyaltyPoints?: Schema$LoyaltyPoints; /** - * Store pickup information. Only supported for local inventory. Not setting pickup means "don't update" while setting it to the empty value ({} in JSON) means "delete". Otherwise, pickupMethod and pickupSla must be set together, unless pickupMethod is "not supported". + * Store pickup information. Only supported for local inventory. Not setting `pickup` means "don't update" while setting it to the empty value (`{}` in JSON) means "delete". Otherwise, `pickupMethod` and `pickupSla` must be set together, unless `pickupMethod` is "not supported". */ pickup?: Schema$InventoryPickup; /** @@ -1603,7 +1606,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The sale price of the product. Mandatory if sale_price_effective_date is defined. + * The sale price of the product. Mandatory if `sale_price_effective_date` is defined. */ salePrice?: Schema$Price; /** @@ -1653,13 +1656,13 @@ export namespace content_v2 { */ totalAmount?: Schema$Amount; /** - * [required] Type of the additional charge. Acceptable values are: - "shipping" + * [required] Type of the additional charge. Acceptable values are: - "`shipping`" */ type?: string | null; } export interface Schema$LiaAboutPageSettings { /** - * The status of the verification process for the About page. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the verification process for the About page. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ status?: string | null; /** @@ -1707,11 +1710,11 @@ export namespace content_v2 { */ inventoryVerificationContactName?: string | null; /** - * The status of the verification contact. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the verification contact. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ inventoryVerificationContactStatus?: string | null; /** - * The status of the inventory verification process. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the inventory verification process. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ status?: string | null; } @@ -1721,7 +1724,7 @@ export namespace content_v2 { */ shippingCostPolicyUrl?: string | null; /** - * The status of the ?On display to order? feature. Acceptable values are: - "active" - "inactive" - "pending" + * The status of the ?On display to order? feature. Acceptable values are: - "`active`" - "`inactive`" - "`pending`" */ status?: string | null; } @@ -1748,7 +1751,7 @@ export namespace content_v2 { */ countrySettings?: Schema$LiaCountrySettings[]; /** - * Identifies what kind of resource this is. Value: the fixed string "content#liaSettings". + * Identifies what kind of resource this is. Value: the fixed string "`content#liaSettings`" */ kind?: string | null; } @@ -1784,7 +1787,7 @@ export namespace content_v2 { */ gmbEmail?: string | null; /** - * The account Lia settings to update. Only defined if the method is update. + * The account Lia settings to update. Only defined if the method is `update`. */ liaSettings?: Schema$LiaSettings; /** @@ -1792,7 +1795,7 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" - "getAccessibleGmbAccounts" - "requestGmbAccess" - "requestInventoryVerification" - "setInventoryVerificationContact" - "update" + * The method of the batch entry. Acceptable values are: - "`get`" - "`getAccessibleGmbAccounts`" - "`requestGmbAccess`" - "`requestInventoryVerification`" - "`setInventoryVerificationContact`" - "`update`" */ method?: string | null; /** @@ -1828,7 +1831,7 @@ export namespace content_v2 { */ gmbAccounts?: Schema$GmbAccounts; /** - * Identifies what kind of resource this is. Value: the fixed string "content#liasettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#liasettingsCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -1970,12 +1973,28 @@ export namespace content_v2 { */ returnShipmentIds?: string[] | null; /** - * State of the item. Acceptable values are: - "canceled" - "new" - "received" - "refunded" - "rejected" + * State of the item. Acceptable values are: - "`canceled`" - "`new`" - "`received`" - "`refunded`" - "`rejected`" */ state?: string | null; } + export interface Schema$MinimumOrderValueTable { + storeCodeSetWithMovs?: Schema$MinimumOrderValueTableStoreCodeSetWithMov[]; + } /** - * Order. Production access (all methods) requires the order manager role. Sandbox access does not. + * A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency. + */ + export interface Schema$MinimumOrderValueTableStoreCodeSetWithMov { + /** + * A list of unique store codes or empty for the catch all. + */ + storeCodes?: string[] | null; + /** + * The minimum order value for the given stores. + */ + value?: Schema$Price; + } + /** + * Order. Production access (all methods) requires the order manager role. Sandbox access does not. (== resource_for v2.orders ==) (== resource_for v2.1.orders ==) */ export interface Schema$Order { /** @@ -1983,7 +2002,7 @@ export namespace content_v2 { */ acknowledged?: boolean | null; /** - * Deprecated. Acceptable values are: - "googleExpress" - "purchasesOnGoogle" + * Deprecated. Acceptable values are: - "`googleExpress`" - "`purchasesOnGoogle`" */ channelType?: string | null; /** @@ -1991,7 +2010,7 @@ export namespace content_v2 { */ customer?: Schema$OrderCustomer; /** - * Delivery details for shipments of type delivery. + * Delivery details for shipments of type `delivery`. */ deliveryDetails?: Schema$OrderDeliveryDetails; /** @@ -1999,7 +2018,7 @@ export namespace content_v2 { */ id?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#order". + * Identifies what kind of resource this is. Value: the fixed string "`content#order`" */ kind?: string | null; /** @@ -2020,11 +2039,11 @@ export namespace content_v2 { */ paymentMethod?: Schema$OrderPaymentMethod; /** - * The status of the payment. Acceptable values are: - "paymentCaptured" - "paymentRejected" - "paymentSecured" - "pendingAuthorization" + * The status of the payment. Acceptable values are: - "`paymentCaptured`" - "`paymentRejected`" - "`paymentSecured`" - "`pendingAuthorization`" */ paymentStatus?: string | null; /** - * Pickup details for shipments of type pickup. + * Pickup details for shipments of type `pickup`. */ pickupDetails?: Schema$OrderPickupDetails; /** @@ -2032,7 +2051,7 @@ export namespace content_v2 { */ placedDate?: string | null; /** - * The details of the merchant provided promotions applied to the order. To determine which promotions apply to which products, check the Promotions[].Benefits[].OfferIds field against the LineItems[].Product.OfferId field for each promotion. If a promotion is applied to more than 1 offerId, divide the discount value by the number of affected offers to determine how much discount to apply to each offerId. Examples: - To calculate the line item level discount for a single specific item: For each promotion, subtract the Promotions[].Benefits[].Discount.value amount from the LineItems[].Price.value. - To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the Promotions[].Benefits[].Discount.value by the quantity of products and substract it from LineItems[].Product.Price.value for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here. + * The details of the merchant provided promotions applied to the order. To determine which promotions apply to which products, check the `Promotions[].Benefits[].OfferIds` field against the `LineItems[].Product.OfferId` field for each promotion. If a promotion is applied to more than 1 `offerId`, divide the discount value by the number of affected offers to determine how much discount to apply to each `offerId`. Examples: - To calculate the line item level discount for a single specific item: For each promotion, subtract the `Promotions[].Benefits[].Discount.value` amount from the `LineItems[].Price.value`. - To calculate the line item level discount for multiple quantity of a specific item: For each promotion, divide the `Promotions[].Benefits[].Discount.value` by the quantity of products and substract it from `LineItems[].Product.Price.value` for each quantity item. Only 1 promotion can be applied to an offerId in a given order. To refund an item which had a promotion applied to it, make sure to refund the amount after first subtracting the promotion discount from the item price. More details about the program are here. */ promotions?: Schema$OrderLegacyPromotion[]; /** @@ -2052,15 +2071,15 @@ export namespace content_v2 { */ shippingCostTax?: Schema$Price; /** - * Deprecated. Shipping details are provided with line items instead. Acceptable values are: - "economy" - "expedited" - "oneDay" - "sameDay" - "standard" - "twoDay" + * Deprecated. Shipping details are provided with line items instead. Acceptable values are: - "`economy`" - "`expedited`" - "`oneDay`" - "`sameDay`" - "`standard`" - "`twoDay`" */ shippingOption?: string | null; /** - * The status of the order. Acceptable values are: - "canceled" - "delivered" - "inProgress" - "partiallyDelivered" - "partiallyReturned" - "partiallyShipped" - "pendingShipment" - "returned" - "shipped" + * The status of the order. Acceptable values are: - "`canceled`" - "`delivered`" - "`inProgress`" - "`partiallyDelivered`" - "`partiallyReturned`" - "`partiallyShipped`" - "`pendingShipment`" - "`returned`" - "`shipped`" */ status?: string | null; /** - * The party responsible for collecting and remitting taxes. Acceptable values are: - "marketplaceFacilitator" - "merchant" + * The party responsible for collecting and remitting taxes. Acceptable values are: - "`marketplaceFacilitator`" - "`merchant`" */ taxCollector?: string | null; } @@ -2100,7 +2119,7 @@ export namespace content_v2 { } export interface Schema$OrderCancellation { /** - * The actor that created the cancellation. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant" + * The actor that created the cancellation. Acceptable values are: - "`customer`" - "`googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`" */ actor?: string | null; /** @@ -2112,7 +2131,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "customerCanceled" - "customerInitiatedCancel" - "customerSupportRequested" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "invalidCoupon" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceError" - "returnRefundAbuse" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Shopping Actions until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`customerCanceled`" - "`customerInitiatedCancel`" - "`customerSupportRequested`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceError`" - "`returnRefundAbuse`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -2133,9 +2152,6 @@ export namespace content_v2 { * Full name of the customer. */ fullName?: string | null; - /** - * Email address for the merchant to send value-added tax or invoice documentation of the order. This documentation is made available to the customer. - */ invoiceReceivingEmail?: string | null; /** * Customer's marketing preferences. Contains the marketing opt-in information that is current at the time that the merchant call. User preference selections can change from one order to the next so preferences must be checked with every order. @@ -2144,7 +2160,7 @@ export namespace content_v2 { } export interface Schema$OrderCustomerMarketingRightsInfo { /** - * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected granted in their most recent order, they can be subscribed to marketing emails. Customers who have chosen denied must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - "denied" - "granted" + * Last known customer selection regarding marketing preferences. In certain cases this selection might not be known, so this field would be empty. If a customer selected `granted` in their most recent order, they can be subscribed to marketing emails. Customers who have chosen `denied` must not be subscribed, or must be unsubscribed if already opted-in. Acceptable values are: - "`denied`" - "`granted`" */ explicitMarketingPreference?: string | null; /** @@ -2152,7 +2168,7 @@ export namespace content_v2 { */ lastUpdatedTimestamp?: string | null; /** - * Email address that can be used for marketing purposes. The field may be empty even if explicitMarketingPreference is 'granted'. This happens when retrieving an old order from the customer who deleted their account. + * Email address that can be used for marketing purposes. The field may be empty even if `explicitMarketingPreference` is 'granted'. This happens when retrieving an old order from the customer who deleted their account. */ marketingEmailAddress?: string | null; } @@ -2184,7 +2200,7 @@ export namespace content_v2 { */ operationId?: string | null; /** - * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string | null; } @@ -2208,11 +2224,11 @@ export namespace content_v2 { */ operationId?: string | null; /** - * Option to create a refund-only invoice. Exactly one of refundOnlyOption or returnOption must be provided. + * Option to create a refund-only invoice. Exactly one of `refundOnlyOption` or `returnOption` must be provided. */ refundOnlyOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; /** - * Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of refundOnlyOption or returnOption must be provided. + * Option to create an invoice for a refund and mark all items within the invoice as returned. Exactly one of `refundOnlyOption` or `returnOption` must be provided. */ returnOption?: Schema$OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; /** @@ -2236,7 +2252,7 @@ export namespace content_v2 { */ description?: string | null; /** - * [required] Reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * [required] Reason for the refund. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; } @@ -2246,7 +2262,7 @@ export namespace content_v2 { */ description?: string | null; /** - * [required] Reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * [required] Reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; } @@ -2269,11 +2285,11 @@ export namespace content_v2 { */ longTitle?: string | null; /** - * Whether the promotion is applicable to all products or only specific products. Acceptable values are: - "allProducts" - "specificProducts" + * Whether the promotion is applicable to all products or only specific products. Acceptable values are: - "`allProducts`" - "`specificProducts`" */ productApplicability?: string | null; /** - * Indicates that the promotion is valid online. Acceptable values are: - "online" + * Indicates that the promotion is valid online. Acceptable values are: - "`online`" */ redemptionChannel?: string | null; } @@ -2287,7 +2303,7 @@ export namespace content_v2 { */ offerIds?: string[] | null; /** - * Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. Acceptable values are: - "buyMGetMoneyOff" - "buyMGetNMoneyOff" - "buyMGetNPercentOff" - "buyMGetPercentOff" - "freeGift" - "freeGiftWithItemId" - "freeGiftWithValue" - "freeOvernightShipping" - "freeShipping" - "freeTwoDayShipping" - "moneyOff" - "percentageOff" - "rewardPoints" - "salePrice" + * Further describes the benefit of the promotion. Note that we will expand on this enumeration as we support new promotion sub-types. Acceptable values are: - "`buyMGetMoneyOff`" - "`buyMGetNMoneyOff`" - "`buyMGetNPercentOff`" - "`buyMGetPercentOff`" - "`freeGift`" - "`freeGiftWithItemId`" - "`freeGiftWithValue`" - "`freeOvernightShipping`" - "`freeShipping`" - "`freeTwoDayShipping`" - "`moneyOff`" - "`percentageOff`" - "`rewardPoints`" - "`salePrice`" */ subType?: string | null; /** @@ -2295,7 +2311,7 @@ export namespace content_v2 { */ taxImpact?: Schema$Price; /** - * Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Acceptable values are: - "product" - "shipping" + * Describes whether the promotion applies to products (e.g. 20% off) or to shipping (e.g. Free Shipping). Acceptable values are: - "`product`" - "`shipping`" */ type?: string | null; } @@ -2371,11 +2387,11 @@ export namespace content_v2 { */ brand?: string | null; /** - * The item's channel (online or local). Acceptable values are: - "local" - "online" + * The item's channel (online or local). Acceptable values are: - "`local`" - "`online`" */ channel?: string | null; /** - * Condition or state of the item. Acceptable values are: - "new" - "refurbished" - "used" + * Condition or state of the item. Acceptable values are: - "`new`" - "`refurbished`" - "`used`" */ condition?: string | null; /** @@ -2479,13 +2495,13 @@ export namespace content_v2 { */ shipByDate?: string | null; /** - * Type of shipment. Indicates whether deliveryDetails or pickupDetails is applicable for this shipment. Acceptable values are: - "delivery" - "pickup" + * Type of shipment. Indicates whether `deliveryDetails` or `pickupDetails` is applicable for this shipment. Acceptable values are: - "`delivery`" - "`pickup`" */ type?: string | null; } export interface Schema$OrderLineItemShippingDetailsMethod { /** - * The carrier for the shipping. Optional. See shipments[].carrier for a list of acceptable values. + * The carrier for the shipping. Optional. See `shipments[].carrier` for a list of acceptable values. */ carrier?: string | null; /** @@ -2533,13 +2549,13 @@ export namespace content_v2 { */ phoneNumber?: string | null; /** - * The type of instrument. Acceptable values are: - "AMEX" - "DISCOVER" - "JCB" - "MASTERCARD" - "UNIONPAY" - "VISA" - "" + * The type of instrument. Acceptable values are: - "`AMEX`" - "`DISCOVER`" - "`JCB`" - "`MASTERCARD`" - "`UNIONPAY`" - "`VISA`" - "``" */ type?: string | null; } export interface Schema$OrderPickupDetails { /** - * Address of the pickup location where the shipment should be sent. Note that recipientName in the address is the name of the business at the pickup location. + * Address of the pickup location where the shipment should be sent. Note that `recipientName` in the address is the name of the business at the pickup location. */ address?: Schema$OrderAddress; /** @@ -2563,7 +2579,7 @@ export namespace content_v2 { } export interface Schema$OrderRefund { /** - * The actor that created the refund. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant" + * The actor that created the refund. Acceptable values are: - "`customer`" - "`googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`" */ actor?: string | null; /** @@ -2575,7 +2591,7 @@ export namespace content_v2 { */ creationDate?: string | null; /** - * The reason for the refund. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the refund. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -2584,7 +2600,7 @@ export namespace content_v2 { reasonText?: string | null; } /** - * Order disbursement. All methods require the payment analyst role. + * Order disbursement. All methods require the payment analyst role. (== resource_for v2.orderreports ==) (== resource_for v2.1.orderreports ==) */ export interface Schema$OrderReportDisbursement { /** @@ -2680,7 +2696,7 @@ export namespace content_v2 { } export interface Schema$OrderReturn { /** - * The actor that created the refund. Acceptable values are: - "customer" - "googleBot" - "googleCustomerService" - "googlePayments" - "googleSabre" - "merchant" + * The actor that created the refund. Acceptable values are: - "`customer`" - "`googleBot`" - "`googleCustomerService`" - "`googlePayments`" - "`googleSabre`" - "`merchant`" */ actor?: string | null; /** @@ -2692,7 +2708,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -2763,7 +2779,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -2787,7 +2803,7 @@ export namespace content_v2 { */ operationId?: string | null; /** - * The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -2807,7 +2823,7 @@ export namespace content_v2 { } export interface Schema$OrdersCancelTestOrderByCustomerRequest { /** - * The reason for the cancellation. Acceptable values are: - "changedMind" - "orderedWrongItem" - "other" + * The reason for the cancellation. Acceptable values are: - "`changedMind`" - "`orderedWrongItem`" - "`other`" */ reason?: string | null; } @@ -2819,11 +2835,11 @@ export namespace content_v2 { } export interface Schema$OrdersCreateTestOrderRequest { /** - * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via template_name, or the addresses of orders created via test_order. Acceptable values are: - "US" - "FR" Defaults to US. + * The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - "`US`" - "`FR`" Defaults to `US`. */ country?: string | null; /** - * The test order template to use. Specify as an alternative to testOrder as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - "template1" - "template1a" - "template1b" - "template2" - "template3" + * The test order template to use. Specify as an alternative to `testOrder` as a shortcut for retrieving a template and then creating an order using that template. Acceptable values are: - "`template1`" - "`template1a`" - "`template1b`" - "`template2`" - "`template3`" */ templateName?: string | null; /** @@ -2869,15 +2885,15 @@ export namespace content_v2 { */ batchId?: number | null; /** - * Required for cancel method. + * Required for `cancel` method. */ cancel?: Schema$OrdersCustomBatchRequestEntryCancel; /** - * Required for cancelLineItem method. + * Required for `cancelLineItem` method. */ cancelLineItem?: Schema$OrdersCustomBatchRequestEntryCancelLineItem; /** - * Required for inStoreReturnLineItem method. + * Required for `inStoreReturnLineItem` method. */ inStoreRefundLineItem?: Schema$OrdersCustomBatchRequestEntryInStoreRefundLineItem; /** @@ -2885,57 +2901,57 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The merchant order ID. Required for updateMerchantOrderId and getByMerchantOrderId methods. + * The merchant order ID. Required for `updateMerchantOrderId` and `getByMerchantOrderId` methods. */ merchantOrderId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "acknowledge" - "cancel" - "cancelLineItem" - "get" - "getByMerchantOrderId" - "inStoreRefundLineItem" - "refund" - "rejectReturnLineItem" - "returnLineItem" - "returnRefundLineItem" - "setLineItemMetadata" - "shipLineItems" - "updateLineItemShippingDetails" - "updateMerchantOrderId" - "updateShipment" + * The method of the batch entry. Acceptable values are: - "`acknowledge`" - "`cancel`" - "`cancelLineItem`" - "`get`" - "`getByMerchantOrderId`" - "`inStoreRefundLineItem`" - "`refund`" - "`rejectReturnLineItem`" - "`returnLineItem`" - "`returnRefundLineItem`" - "`setLineItemMetadata`" - "`shipLineItems`" - "`updateLineItemShippingDetails`" - "`updateMerchantOrderId`" - "`updateShipment`" */ method?: string | null; /** - * The ID of the operation. Unique across all operations for a given order. Required for all methods beside get and getByMerchantOrderId. + * The ID of the operation. Unique across all operations for a given order. Required for all methods beside `get` and `getByMerchantOrderId`. */ operationId?: string | null; /** - * The ID of the order. Required for all methods beside getByMerchantOrderId. + * The ID of the order. Required for all methods beside `getByMerchantOrderId`. */ orderId?: string | null; /** - * Required for refund method. + * Required for `refund` method. */ refund?: Schema$OrdersCustomBatchRequestEntryRefund; /** - * Required for rejectReturnLineItem method. + * Required for `rejectReturnLineItem` method. */ rejectReturnLineItem?: Schema$OrdersCustomBatchRequestEntryRejectReturnLineItem; /** - * Required for returnLineItem method. + * Required for `returnLineItem` method. */ returnLineItem?: Schema$OrdersCustomBatchRequestEntryReturnLineItem; /** - * Required for returnRefundLineItem method. + * Required for `returnRefundLineItem` method. */ returnRefundLineItem?: Schema$OrdersCustomBatchRequestEntryReturnRefundLineItem; /** - * Required for setLineItemMetadata method. + * Required for `setLineItemMetadata` method. */ setLineItemMetadata?: Schema$OrdersCustomBatchRequestEntrySetLineItemMetadata; /** - * Required for shipLineItems method. + * Required for `shipLineItems` method. */ shipLineItems?: Schema$OrdersCustomBatchRequestEntryShipLineItems; /** - * Required for updateLineItemShippingDate method. + * Required for `updateLineItemShippingDate` method. */ updateLineItemShippingDetails?: Schema$OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails; /** - * Required for updateShipment method. + * Required for `updateShipment` method. */ updateShipment?: Schema$OrdersCustomBatchRequestEntryUpdateShipment; } export interface Schema$OrdersCustomBatchRequestEntryCancel { /** - * The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -2969,7 +2985,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the cancellation. Acceptable values are: - "customerInitiatedCancel" - "invalidCoupon" - "malformedShippingAddress" - "noInventory" - "other" - "priceError" - "shippingPriceError" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" + * The reason for the cancellation. Acceptable values are: - "`customerInitiatedCancel`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`noInventory`" - "`other`" - "`priceError`" - "`shippingPriceError`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" */ reason?: string | null; /** @@ -3009,7 +3025,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3031,7 +3047,7 @@ export namespace content_v2 { */ amountTax?: Schema$Price; /** - * The reason for the refund. Acceptable values are: - "adjustment" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "deliveredLateByCarrier" - "feeAdjustment" - "lateShipmentCredit" - "noInventory" - "other" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "shippingCostAdjustment" - "taxAdjustment" - "undeliverableShippingAddress" - "wrongProductShipped" + * The reason for the refund. Acceptable values are: - "`adjustment`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`deliveredLateByCarrier`" - "`feeAdjustment`" - "`lateShipmentCredit`" - "`noInventory`" - "`other`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`shippingCostAdjustment`" - "`taxAdjustment`" - "`undeliverableShippingAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3053,7 +3069,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "damagedOrUsed" - "missingComponent" - "notEligible" - "other" - "outOfReturnWindow" + * The reason for the return. Acceptable values are: - "`damagedOrUsed`" - "`missingComponent`" - "`notEligible`" - "`other`" - "`outOfReturnWindow`" */ reason?: string | null; /** @@ -3075,7 +3091,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3105,7 +3121,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3126,7 +3142,7 @@ export namespace content_v2 { } export interface Schema$OrdersCustomBatchRequestEntryShipLineItems { /** - * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. + * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. */ carrier?: string | null; /** @@ -3152,7 +3168,7 @@ export namespace content_v2 { } export interface Schema$OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { /** - * The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. + * The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. */ carrier?: string | null; /** @@ -3184,11 +3200,11 @@ export namespace content_v2 { } export interface Schema$OrdersCustomBatchRequestEntryUpdateShipment { /** - * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. + * The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. */ carrier?: string | null; /** - * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. + * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`. */ deliveryDate?: string | null; /** @@ -3196,7 +3212,7 @@ export namespace content_v2 { */ shipmentId?: string | null; /** - * New status for the shipment. Not updated if missing. Acceptable values are: - "delivered" - "undeliverable" + * New status for the shipment. Not updated if missing. Acceptable values are: - "`delivered`" - "`undeliverable`" */ status?: string | null; /** @@ -3224,15 +3240,15 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * The status of the execution. Only defined if - the request was successful; and - the method is not get, getByMerchantOrderId, or one of the test methods. Acceptable values are: - "duplicate" - "executed" + * The status of the execution. Only defined if - the request was successful; and - the method is not `get`, `getByMerchantOrderId`, or one of the test methods. Acceptable values are: - "`duplicate`" - "`executed`" */ executionStatus?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#ordersCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#ordersCustomBatchResponseEntry`" */ kind?: string | null; /** - * The retrieved order. Only defined if the method is get and if the request was successful. + * The retrieved order. Only defined if the method is `get` and if the request was successful. */ order?: Schema$Order; } @@ -3258,7 +3274,7 @@ export namespace content_v2 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) - "db schenker" (DB Schenker) - "aramex" (Aramex) + * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "`ups`" (United Parcel Service) automatic status updates - "`usps`" (United States Postal Service) automatic status updates - "`fedex`" (FedEx) automatic status updates - "`dhl`" (DHL eCommerce) automatic status updates (US only) - "`ontrac`" (OnTrac) automatic status updates - "`dhl express`" (DHL Express) - "`deliv`" (Deliv) - "`dynamex`" (TForce) - "`lasership`" (LaserShip) - "`mpx`" (Military Parcel Xpress) - "`uds`" (United Delivery Service) - "`efw`" (Estes Forwarding Worldwide) - "`jd logistics`" (JD Logistics) - "`yunexpress`" (YunExpress) - "`china post`" (China Post) - "`china ems`" (China Post Express Mail Service) - "`singapore post`" (Singapore Post) - "`pos malaysia`" (Pos Malaysia) - "`postnl`" (PostNL) - "`ptt`" (PTT Turkish Post) - "`eub`" (ePacket) - "`chukou1`" (Chukou1 Logistics) Supported carriers for FR are: - "`la poste`" (La Poste) automatic status updates - "`colissimo`" (Colissimo by La Poste) automatic status updates - "`ups`" (United Parcel Service) automatic status updates - "`chronopost`" (Chronopost by La Poste) - "`gls`" (General Logistics Systems France) - "`dpd`" (DPD Group by GeoPost) - "`bpost`" (Belgian Post Group) - "`colis prive`" (Colis Privé) - "`boxtal`" (Boxtal) - "`geodis`" (GEODIS) - "`tnt`" (TNT) - "`db schenker`" (DB Schenker) - "`aramex`" (Aramex) */ carrier?: string | null; /** @@ -3266,7 +3282,7 @@ export namespace content_v2 { */ creationDate?: string | null; /** - * Date on which the shipment has been delivered, in ISO 8601 format. Present only if status is delivered + * Date on which the shipment has been delivered, in ISO 8601 format. Present only if `status` is `delivered` */ deliveryDate?: string | null; /** @@ -3278,7 +3294,7 @@ export namespace content_v2 { */ lineItems?: Schema$OrderShipmentLineItemShipment[]; /** - * The status of the shipment. Acceptable values are: - "delivered" - "readyForPickup" - "shipped" - "undeliverable" + * The status of the shipment. Acceptable values are: - "`delivered`" - "`readyForPickup`" - "`shipped`" - "`undeliverable`" */ status?: string | null; /** @@ -3326,7 +3342,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3373,7 +3389,7 @@ export namespace content_v2 { */ operationId?: string | null; /** - * The reason for the refund. Acceptable values are: - "adjustment" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "deliveredLateByCarrier" - "feeAdjustment" - "lateShipmentCredit" - "noInventory" - "other" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "shippingCostAdjustment" - "taxAdjustment" - "undeliverableShippingAddress" - "wrongProductShipped" + * The reason for the refund. Acceptable values are: - "`adjustment`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`deliveredLateByCarrier`" - "`feeAdjustment`" - "`lateShipmentCredit`" - "`noInventory`" - "`other`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`shippingCostAdjustment`" - "`taxAdjustment`" - "`undeliverableShippingAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3409,7 +3425,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "damagedOrUsed" - "missingComponent" - "notEligible" - "other" - "outOfReturnWindow" + * The reason for the return. Acceptable values are: - "`damagedOrUsed`" - "`missingComponent`" - "`notEligible`" - "`other`" - "`outOfReturnWindow`" */ reason?: string | null; /** @@ -3445,7 +3461,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3489,7 +3505,7 @@ export namespace content_v2 { */ quantity?: number | null; /** - * The reason for the return. Acceptable values are: - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "deliveredTooLate" - "expiredItem" - "invalidCoupon" - "malformedShippingAddress" - "other" - "productArrivedDamaged" - "productNotAsDescribed" - "qualityNotAsExpected" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * The reason for the return. Acceptable values are: - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`deliveredTooLate`" - "`expiredItem`" - "`invalidCoupon`" - "`malformedShippingAddress`" - "`other`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`qualityNotAsExpected`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reason?: string | null; /** @@ -3534,7 +3550,7 @@ export namespace content_v2 { } export interface Schema$OrdersShipLineItemsRequest { /** - * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See shipments[].carrier in the Orders resource representation for a list of acceptable values. + * Deprecated. Please use shipmentInfo instead. The carrier handling the shipment. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. */ carrier?: string | null; /** @@ -3626,11 +3642,11 @@ export namespace content_v2 { } export interface Schema$OrdersUpdateShipmentRequest { /** - * The carrier handling the shipment. Not updated if missing. See shipments[].carrier in the Orders resource representation for a list of acceptable values. + * The carrier handling the shipment. Not updated if missing. See `shipments[].carrier` in the Orders resource representation for a list of acceptable values. */ carrier?: string | null; /** - * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if status is delivered. + * Date on which the shipment has been delivered, in ISO 8601 format. Optional and can be provided only if `status` is `delivered`. */ deliveryDate?: string | null; /** @@ -3642,7 +3658,7 @@ export namespace content_v2 { */ shipmentId?: string | null; /** - * New status for the shipment. Not updated if missing. Acceptable values are: - "delivered" - "undeliverable" + * New status for the shipment. Not updated if missing. Acceptable values are: - "`delivered`" - "`undeliverable`" */ status?: string | null; /** @@ -3662,17 +3678,17 @@ export namespace content_v2 { } export interface Schema$PickupCarrierService { /** - * The name of the pickup carrier (e.g., "UPS"). Required. + * The name of the pickup carrier (e.g., `"UPS"`). Required. */ carrierName?: string | null; /** - * The name of the pickup service (e.g., "Access point"). Required. + * The name of the pickup service (e.g., `"Access point"`). Required. */ serviceName?: string | null; } export interface Schema$PickupServicesPickupService { /** - * The name of the carrier (e.g., "UPS"). Always present. + * The name of the carrier (e.g., `"UPS"`). Always present. */ carrierName?: string | null; /** @@ -3680,7 +3696,7 @@ export namespace content_v2 { */ country?: string | null; /** - * The name of the pickup service (e.g., "Access point"). Always present. + * The name of the pickup service (e.g., `"Access point"`). Always present. */ serviceName?: string | null; } @@ -3696,7 +3712,7 @@ export namespace content_v2 { */ batchId?: number | null; /** - * The inventory to submit. Set this only if the method is inventory. + * The inventory to submit. Set this only if the method is `inventory`. */ inventory?: Schema$PosInventory; /** @@ -3704,19 +3720,19 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "delete" - "get" - "insert" - "inventory" - "sale" + * The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" - "`inventory`" - "`sale`" */ method?: string | null; /** - * The sale information to submit. Set this only if the method is sale. + * The sale information to submit. Set this only if the method is `sale`. */ sale?: Schema$PosSale; /** - * The store information to submit. Set this only if the method is insert. + * The store information to submit. Set this only if the method is `insert`. */ store?: Schema$PosStore; /** - * The store code. Set this only if the method is delete or get. + * The store code. Set this only if the method is `delete` or `get`. */ storeCode?: string | null; /** @@ -3748,7 +3764,7 @@ export namespace content_v2 { */ inventory?: Schema$PosInventory; /** - * Identifies what kind of resource this is. Value: the fixed string "content#posCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#posCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -3801,7 +3817,7 @@ export namespace content_v2 { */ itemId?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#posInventory". + * Identifies what kind of resource this is. Value: the fixed string "`content#posInventory`" */ kind?: string | null; /** @@ -3813,7 +3829,7 @@ export namespace content_v2 { */ quantity?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3847,7 +3863,7 @@ export namespace content_v2 { */ quantity?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3885,7 +3901,7 @@ export namespace content_v2 { */ quantity?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3921,7 +3937,7 @@ export namespace content_v2 { */ itemId?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#posSale". + * Identifies what kind of resource this is. Value: the fixed string "`content#posSale`" */ kind?: string | null; /** @@ -3937,7 +3953,7 @@ export namespace content_v2 { */ saleId?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -3975,7 +3991,7 @@ export namespace content_v2 { */ saleId?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -4017,7 +4033,7 @@ export namespace content_v2 { */ saleId?: string | null; /** - * Required. The identifier of the merchant's store. Either a storeCode inserted via the API or the code of the store in Google My Business. + * Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in Google My Business. */ storeCode?: string | null; /** @@ -4034,7 +4050,7 @@ export namespace content_v2 { */ export interface Schema$PosStore { /** - * Identifies what kind of resource this is. Value: the fixed string "content#posStore". + * Identifies what kind of resource this is. Value: the fixed string "`content#posStore`" */ kind?: string | null; /** @@ -4062,11 +4078,11 @@ export namespace content_v2 { } export interface Schema$PostalCodeRange { /** - * A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: "94108", "9410*", "9*". Required. + * A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `"94108"`, `"9410*"`, `"9*"`. Required. */ postalCodeRangeBegin?: string | null; /** - * A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin. + * A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`. */ postalCodeRangeEnd?: string | null; } @@ -4081,7 +4097,7 @@ export namespace content_v2 { value?: string | null; } /** - * Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. + * Required product attributes are primarily defined by the products data specification. See the Products Data Specification Help Center article for information. Some attributes are country-specific, so make sure you select the appropriate country in the drop-down selector at the top of the page. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. */ export interface Schema$Product { /** @@ -4109,7 +4125,7 @@ export namespace content_v2 { */ adwordsRedirect?: string | null; /** - * Target age group of the item. Acceptable values are: - "adult" - "infant" - "kids" - "newborn" - "toddler" - "youngAdult" + * Target age group of the item. Acceptable values are: - "`adult`" - "`infant`" - "`kids`" - "`newborn`" - "`toddler`" - "`youngAdult`" */ ageGroup?: string | null; /** @@ -4117,7 +4133,7 @@ export namespace content_v2 { */ aspects?: Schema$ProductAspect[]; /** - * Availability status of the item. Acceptable values are: - "in stock" - "out of stock" - "preorder" + * Availability status of the item. Acceptable values are: - "`in stock`" - "`out of stock`" - "`preorder`" */ availability?: string | null; /** @@ -4129,7 +4145,7 @@ export namespace content_v2 { */ brand?: string | null; /** - * Required. The item's channel (online or local). Acceptable values are: - "local" - "online" + * Required. The item's channel (online or local). Acceptable values are: - "`local`" - "`online`" */ channel?: string | null; /** @@ -4137,7 +4153,7 @@ export namespace content_v2 { */ color?: string | null; /** - * Condition or state of the item. Acceptable values are: - "local" - "online" + * Condition or state of the item. Acceptable values are: - "`local`" - "`online`" */ condition?: string | null; /** @@ -4149,7 +4165,7 @@ export namespace content_v2 { */ costOfGoodsSold?: Schema$Price; /** - * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., { "name": "size type", "value": "regular" }). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Shopping Actions. + * A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (e.g., `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Shopping Actions. */ customAttributes?: Schema$CustomAttribute[]; /** @@ -4205,15 +4221,15 @@ export namespace content_v2 { */ displayAdsValue?: number | null; /** - * The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "A" - "A+" - "A++" - "A+++" - "B" - "C" - "D" - "E" - "F" - "G" + * The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`" */ energyEfficiencyClass?: string | null; /** - * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. + * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future. */ expirationDate?: string | null; /** - * Target gender of the item. Acceptable values are: - "female" - "male" - "unisex" + * Target gender of the item. Acceptable values are: - "`female`" - "`male`" - "`unisex`" */ gender?: string | null; /** @@ -4225,7 +4241,7 @@ export namespace content_v2 { */ gtin?: string | null; /** - * The REST ID of the product. Content API methods that operate on products take this as their productId parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. + * The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product is of the form channel:contentLanguage:targetCountry:offerId. */ id?: string | null; /** @@ -4249,7 +4265,7 @@ export namespace content_v2 { */ itemGroupId?: string | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#product". + * Identifies what kind of resource this is. Value: the fixed string "`content#product`" */ kind?: string | null; /** @@ -4265,7 +4281,7 @@ export namespace content_v2 { */ material?: string | null; /** - * The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "A" - "A+" - "A++" - "A+++" - "B" - "C" - "D" - "E" - "F" - "G" + * The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`" */ maxEnergyEfficiencyClass?: string | null; /** @@ -4273,7 +4289,7 @@ export namespace content_v2 { */ maxHandlingTime?: string | null; /** - * The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "A" - "A+" - "A++" - "A+++" - "B" - "C" - "D" - "E" - "F" - "G" + * The energy efficiency class as defined in EU directive 2010/30/EU. Acceptable values are: - "`A`" - "`A+`" - "`A++`" - "`A+++`" - "`B`" - "`C`" - "`D`" - "`E`" - "`F`" - "`G`" */ minEnergyEfficiencyClass?: string | null; /** @@ -4297,7 +4313,7 @@ export namespace content_v2 { */ offerId?: string | null; /** - * Deprecated. Whether an item is available for purchase only online. + * Deprecated. */ onlineOnly?: boolean | null; /** @@ -4353,19 +4369,19 @@ export namespace content_v2 { */ shippingWidth?: Schema$ProductShippingDimension; /** - * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value (see size definition). + * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). */ sizes?: string[] | null; /** - * System in which the size is specified. Recommended for apparel items. Acceptable values are: - "AU" - "BR" - "CN" - "DE" - "EU" - "FR" - "IT" - "JP" - "MEX" - "UK" - "US" + * System in which the size is specified. Recommended for apparel items. Acceptable values are: - "`AU`" - "`BR`" - "`CN`" - "`DE`" - "`EU`" - "`FR`" - "`IT`" - "`JP`" - "`MEX`" - "`UK`" - "`US`" */ sizeSystem?: string | null; /** - * The cut of the item. Recommended for apparel items. Acceptable values are: - "big and tall" - "maternity" - "oversize" - "petite" - "plus" - "regular" + * The cut of the item. Recommended for apparel items. Acceptable values are: - "`big and tall`" - "`maternity`" - "`oversize`" - "`petite`" - "`plus`" - "`regular`" */ sizeType?: string | null; /** - * The source of the offer, i.e., how the offer was created. Acceptable values are: - "api" - "crawl" - "feed" + * The source of the offer, i.e., how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" */ source?: string | null; /** @@ -4413,15 +4429,15 @@ export namespace content_v2 { } export interface Schema$ProductAspect { /** - * The name of the aspect. + * Deprecated. */ aspectName?: string | null; /** - * The name of the destination. Leave out to apply to all destinations. + * Deprecated. */ destinationName?: string | null; /** - * Whether the aspect is required, excluded or should be validated. + * Deprecated. */ intention?: string | null; } @@ -4431,7 +4447,7 @@ export namespace content_v2 { */ destinationName?: string | null; /** - * Whether the destination is required, excluded or should be validated. Acceptable values are: - "default" - "excluded" - "optional" - "required" + * Whether the destination is required, excluded or should be validated. Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`" */ intention?: string | null; } @@ -4454,15 +4470,15 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "delete" - "get" - "insert" + * The method of the batch entry. Acceptable values are: - "`delete`" - "`get`" - "`insert`" */ method?: string | null; /** - * The product to insert. Only required if the method is insert. + * The product to insert. Only required if the method is `insert`. */ product?: Schema$Product; /** - * The ID of the product to get or delete. Only defined if the method is get or delete. + * The ID of the product to get or delete. Only defined if the method is `get` or `delete`. */ productId?: string | null; } @@ -4489,11 +4505,11 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#productsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#productsCustomBatchResponseEntry`" */ kind?: string | null; /** - * The inserted product. Only defined if the method is insert and if the request was successful. + * The inserted product. Only defined if the method is `insert` and if the request was successful. */ product?: Schema$Product; } @@ -4583,7 +4599,7 @@ export namespace content_v2 { */ itemLevelIssues?: Schema$ProductStatusItemLevelIssue[]; /** - * Identifies what kind of resource this is. Value: the fixed string "content#productStatus". + * Identifies what kind of resource this is. Value: the fixed string "`content#productStatus`" */ kind?: string | null; /** @@ -4624,7 +4640,7 @@ export namespace content_v2 { */ approvalPending?: boolean | null; /** - * The destination's approval status. Acceptable values are: - "approved" - "disapproved" + * The destination's approval status. Acceptable values are: - "`approved`" - "`disapproved`" */ approvalStatus?: string | null; /** @@ -4632,7 +4648,7 @@ export namespace content_v2 { */ destination?: string | null; /** - * Provided for backward compatibility only. Always set to "required". Acceptable values are: - "default" - "excluded" - "optional" - "required" + * Provided for backward compatibility only. Always set to "required". Acceptable values are: - "`default`" - "`excluded`" - "`optional`" - "`required`" */ intention?: string | null; } @@ -4660,7 +4676,7 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" + * The method of the batch entry. Acceptable values are: - "`get`" */ method?: string | null; /** @@ -4691,7 +4707,7 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#productstatusesCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#productstatusesCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -4806,11 +4822,11 @@ export namespace content_v2 { */ applicableShippingLabels?: string[] | null; /** - * A list of carrier rates that can be referred to by mainTable or singleValue. + * A list of carrier rates that can be referred to by `mainTable` or `singleValue`. */ carrierRates?: Schema$CarrierRate[]; /** - * A table defining the rate group, when singleValue is not expressive enough. Can only be set if singleValue is not set. + * A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set. */ mainTable?: Schema$Table; /** @@ -4818,11 +4834,11 @@ export namespace content_v2 { */ name?: string | null; /** - * The value of the rate group (e.g. flat rate $10). Can only be set if mainTable and subtables are not set. + * The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set. */ singleValue?: Schema$Value; /** - * A list of subtables referred to by mainTable. Can only be set if mainTable is set. + * A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set. */ subtables?: Schema$Table[]; } @@ -4832,7 +4848,7 @@ export namespace content_v2 { */ description?: string | null; /** - * Code of the refund reason. Acceptable values are: - "adjustment" - "autoPostInternal" - "autoPostInvalidBillingAddress" - "autoPostNoInventory" - "autoPostPriceError" - "autoPostUndeliverableShippingAddress" - "couponAbuse" - "courtesyAdjustment" - "customerCanceled" - "customerDiscretionaryReturn" - "customerInitiatedMerchantCancel" - "customerSupportRequested" - "deliveredLateByCarrier" - "deliveredTooLate" - "expiredItem" - "failToPushOrderGoogleError" - "failToPushOrderMerchantError" - "failToPushOrderMerchantFulfillmentError" - "failToPushOrderToMerchant" - "failToPushOrderToMerchantOutOfStock" - "feeAdjustment" - "invalidCoupon" - "lateShipmentCredit" - "malformedShippingAddress" - "merchantDidNotShipOnTime" - "noInventory" - "orderTimeout" - "other" - "paymentAbuse" - "paymentDeclined" - "priceAdjustment" - "priceError" - "productArrivedDamaged" - "productNotAsDescribed" - "promoReallocation" - "qualityNotAsExpected" - "returnRefundAbuse" - "shippingCostAdjustment" - "shippingPriceError" - "taxAdjustment" - "taxError" - "undeliverableShippingAddress" - "unsupportedPoBoxAddress" - "wrongProductShipped" + * Code of the refund reason. Acceptable values are: - "`adjustment`" - "`autoPostInternal`" - "`autoPostInvalidBillingAddress`" - "`autoPostNoInventory`" - "`autoPostPriceError`" - "`autoPostUndeliverableShippingAddress`" - "`couponAbuse`" - "`courtesyAdjustment`" - "`customerCanceled`" - "`customerDiscretionaryReturn`" - "`customerInitiatedMerchantCancel`" - "`customerSupportRequested`" - "`deliveredLateByCarrier`" - "`deliveredTooLate`" - "`expiredItem`" - "`failToPushOrderGoogleError`" - "`failToPushOrderMerchantError`" - "`failToPushOrderMerchantFulfillmentError`" - "`failToPushOrderToMerchant`" - "`failToPushOrderToMerchantOutOfStock`" - "`feeAdjustment`" - "`invalidCoupon`" - "`lateShipmentCredit`" - "`malformedShippingAddress`" - "`merchantDidNotShipOnTime`" - "`noInventory`" - "`orderTimeout`" - "`other`" - "`paymentAbuse`" - "`paymentDeclined`" - "`priceAdjustment`" - "`priceError`" - "`productArrivedDamaged`" - "`productNotAsDescribed`" - "`promoReallocation`" - "`qualityNotAsExpected`" - "`returnRefundAbuse`" - "`shippingCostAdjustment`" - "`shippingPriceError`" - "`taxAdjustment`" - "`taxError`" - "`undeliverableShippingAddress`" - "`unsupportedPoBoxAddress`" - "`wrongProductShipped`" */ reasonCode?: string | null; } @@ -4846,7 +4862,7 @@ export namespace content_v2 { */ deliveryDate?: string | null; /** - * Type of the return method. Acceptable values are: - "byMail" - "contactCustomerSupport" - "returnless" + * Type of the return method. Acceptable values are: - "`byMail`" - "`contactCustomerSupport`" - "`returnless`" */ returnMethodType?: string | null; /** @@ -4862,13 +4878,13 @@ export namespace content_v2 { */ shippingDate?: string | null; /** - * State of the shipment. Acceptable values are: - "completed" - "new" - "shipped" - "undeliverable" + * State of the shipment. Acceptable values are: - "`completed`" - "`new`" - "`shipped`" - "`undeliverable`" */ state?: string | null; } export interface Schema$Row { /** - * The list of cells that constitute the row. Must have the same length as columnHeaders for two-dimensional tables, a length of 1 for one-dimensional tables. Required. + * The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required. */ cells?: Schema$Value[]; } @@ -4890,27 +4906,31 @@ export namespace content_v2 { */ deliveryTime?: Schema$DeliveryTime; /** - * Eligibility for this service. Acceptable values are: - "All scenarios" - "All scenarios except Shopping Actions" - "Shopping Actions" + * Eligibility for this service. Acceptable values are: - "`All scenarios`" - "`All scenarios except Shopping Actions`" - "`Shopping Actions`" */ eligibility?: string | null; /** - * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. + * Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table. */ minimumOrderValue?: Schema$Price; + /** + * Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value. + */ + minimumOrderValueTable?: Schema$MinimumOrderValueTable; /** * Free-form name of the service. Must be unique within target account. Required. */ name?: string | null; /** - * The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the getSupportedPickupServices method. Required if and only if the service delivery type is pickup. + * The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`. */ pickupService?: Schema$PickupCarrierService; /** - * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. + * Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means "everything else". The other `applicableShippingLabels` must not overlap. */ rateGroups?: Schema$RateGroup[]; /** - * Type of locations this service ships orders to. Acceptable values are: - "delivery" - "pickup" + * Type of locations this service ships orders to. Acceptable values are: - "`delivery`" - "`pickup`" */ shipmentType?: string | null; } @@ -4924,7 +4944,7 @@ export namespace content_v2 { */ lineItemInvoices?: Schema$ShipmentInvoiceLineItemInvoice[]; /** - * [required] ID of the shipment group. It is assigned by the merchant in the shipLineItems method and is used to group multiple line items that have the same kind of shipping charges. + * [required] ID of the shipment group. It is assigned by the merchant in the `shipLineItems` method and is used to group multiple line items that have the same kind of shipping charges. */ shipmentGroupId?: string | null; } @@ -4948,7 +4968,7 @@ export namespace content_v2 { } export interface Schema$ShipmentTrackingInfo { /** - * The shipping carrier that handles the package. Acceptable values are: - "boxtal" - "bpost" - "chronopost" - "colisPrive" - "colissimo" - "cxt" - "deliv" - "dhl" - "dpd" - "dynamex" - "eCourier" - "easypost" - "efw" - "fedex" - "fedexSmartpost" - "geodis" - "gls" - "googleCourier" - "gsx" - "jdLogistics" - "laPoste" - "lasership" - "manual" - "mpx" - "onTrac" - "other" - "tnt" - "uds" - "ups" - "usps" + * The shipping carrier that handles the package. Acceptable values are: - "`boxtal`" - "`bpost`" - "`chronopost`" - "`colisPrive`" - "`colissimo`" - "`cxt`" - "`deliv`" - "`dhl`" - "`dpd`" - "`dynamex`" - "`eCourier`" - "`easypost`" - "`efw`" - "`fedex`" - "`fedexSmartpost`" - "`geodis`" - "`gls`" - "`googleCourier`" - "`gsx`" - "`jdLogistics`" - "`laPoste`" - "`lasership`" - "`manual`" - "`mpx`" - "`onTrac`" - "`other`" - "`tnt`" - "`uds`" - "`ups`" - "`usps`" */ carrier?: string | null; /** @@ -4965,7 +4985,7 @@ export namespace content_v2 { */ accountId?: string | null; /** - * A list of postal code groups that can be referred to in services. Optional. + * A list of postal code groups that can be referred to in `services`. Optional. */ postalCodeGroups?: Schema$PostalCodeGroup[]; /** @@ -4996,11 +5016,11 @@ export namespace content_v2 { */ merchantId?: string | null; /** - * The method of the batch entry. Acceptable values are: - "get" - "update" + * The method of the batch entry. Acceptable values are: - "`get`" - "`update`" */ method?: string | null; /** - * The account shipping settings to update. Only defined if the method is update. + * The account shipping settings to update. Only defined if the method is `update`. */ shippingSettings?: Schema$ShippingSettings; } @@ -5027,7 +5047,7 @@ export namespace content_v2 { */ errors?: Schema$Errors; /** - * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsCustomBatchResponseEntry". + * Identifies what kind of resource this is. Value: the fixed string "`content#shippingsettingsCustomBatchResponseEntry`" */ kind?: string | null; /** @@ -5090,7 +5110,7 @@ export namespace content_v2 { */ rowHeaders?: Schema$Headers; /** - * The list of rows that constitute the table. Must have the same length as rowHeaders. Required. + * The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required. */ rows?: Schema$Row[]; } @@ -5104,7 +5124,7 @@ export namespace content_v2 { */ enableOrderinvoices?: boolean | null; /** - * Identifies what kind of resource this is. Value: the fixed string "content#testOrder". + * Identifies what kind of resource this is. Value: the fixed string "`content#testOrder`" */ kind?: string | null; /** @@ -5112,7 +5132,7 @@ export namespace content_v2 { */ lineItems?: Schema$TestOrderLineItem[]; /** - * Determines if test order must be pulled by merchant or pushed to merchant via push integration. Acceptable values are: - "checkoutIntegration" - "merchantPull" + * Restricted. Do not use. */ notificationMode?: string | null; /** @@ -5120,11 +5140,11 @@ export namespace content_v2 { */ paymentMethod?: Schema$TestOrderPaymentMethod; /** - * Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - "dwight" - "jim" - "pam" + * Required. Identifier of one of the predefined delivery addresses for the delivery. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" */ predefinedDeliveryAddress?: string | null; /** - * Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type pickup. Acceptable values are: - "dwight" - "jim" - "pam" + * Identifier of one of the predefined pickup details. Required for orders containing line items with shipping type `pickup`. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" */ predefinedPickupDetails?: string | null; /** @@ -5140,13 +5160,13 @@ export namespace content_v2 { */ shippingCostTax?: Schema$Price; /** - * Required. The requested shipping option. Acceptable values are: - "economy" - "expedited" - "oneDay" - "sameDay" - "standard" - "twoDay" + * Required. The requested shipping option. Acceptable values are: - "`economy`" - "`expedited`" - "`oneDay`" - "`sameDay`" - "`standard`" - "`twoDay`" */ shippingOption?: string | null; } export interface Schema$TestOrderCustomer { /** - * Required. Email address of the customer. Acceptable values are: - "pog.dwight.schrute@gmail.com" - "pog.jim.halpert@gmail.com" - "penpog.pam.beesly@gmail.comding" + * Required. Email address of the customer. Acceptable values are: - "`pog.dwight.schrute@gmail.com`" - "`pog.jim.halpert@gmail.com`" - "`penpog.pam.beesly@gmail.comding`" */ email?: string | null; /** @@ -5164,7 +5184,7 @@ export namespace content_v2 { } export interface Schema$TestOrderCustomerMarketingRightsInfo { /** - * Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. Acceptable values are: - "denied" - "granted" + * Last know user use selection regards marketing preferences. In certain cases selection might not be known, so this field would be empty. Acceptable values are: - "`denied`" - "`granted`" */ explicitMarketingPreference?: string | null; /** @@ -5200,15 +5220,15 @@ export namespace content_v2 { */ brand?: string | null; /** - * Deprecated. Acceptable values are: - "online" + * Deprecated. Acceptable values are: - "`online`" */ channel?: string | null; /** - * Required. Condition or state of the item. Acceptable values are: - "new" + * Required. Condition or state of the item. Acceptable values are: - "`new`" */ condition?: string | null; /** - * Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - "en" - "fr" + * Required. The two-letter ISO 639-1 language code for the item. Acceptable values are: - "`en`" - "`fr`" */ contentLanguage?: string | null; /** @@ -5266,22 +5286,22 @@ export namespace content_v2 { */ lastFourDigits?: string | null; /** - * The billing address. Acceptable values are: - "dwight" - "jim" - "pam" + * The billing address. Acceptable values are: - "`dwight`" - "`jim`" - "`pam`" */ predefinedBillingAddress?: string | null; /** - * The type of instrument. Note that real orders might have different values than the four values accepted by createTestOrder. Acceptable values are: - "AMEX" - "DISCOVER" - "MASTERCARD" - "VISA" + * The type of instrument. Note that real orders might have different values than the four values accepted by `createTestOrder`. Acceptable values are: - "`AMEX`" - "`DISCOVER`" - "`MASTERCARD`" - "`VISA`" */ type?: string | null; } export interface Schema$TransitTable { /** - * A list of postal group names. The last value can be "all other locations". Example: ["zone 1", "zone 2", "all other locations"]. The referred postal code groups must match the delivery country of the service. + * A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. */ postalCodeGroupNames?: string[] | null; rows?: Schema$TransitTableTransitTimeRow[]; /** - * A list of transit time labels. The last value can be "all other labels". Example: ["food", "electronics", "all other labels"]. + * A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`. */ transitTimeLabels?: string[] | null; } @@ -5290,7 +5310,7 @@ export namespace content_v2 { } export interface Schema$TransitTableTransitTimeRowTransitTimeValue { /** - * Must be greater than or equal to minTransitTimeInDays. + * Must be greater than or equal to `minTransitTimeInDays`. */ maxTransitTimeInDays?: number | null; /** @@ -5326,7 +5346,7 @@ export namespace content_v2 { */ additionalChargePromotions?: Schema$Promotion[]; /** - * [required] Type of the additional charge. Acceptable values are: - "shipping" + * [required] Type of the additional charge. Acceptable values are: - "`shipping`" */ type?: string | null; } @@ -5336,16 +5356,16 @@ export namespace content_v2 { */ taxAmount?: Schema$Price; /** - * Optional name of the tax type. This should only be provided if taxType is otherFeeTax. + * Optional name of the tax type. This should only be provided if `taxType` is `otherFeeTax`. */ taxName?: string | null; /** - * [required] Type of the tax. Acceptable values are: - "otherFee" - "otherFeeTax" - "sales" + * [required] Type of the tax. Acceptable values are: - "`otherFee`" - "`otherFeeTax`" - "`sales`" */ taxType?: string | null; } /** - * The single value of a rate group or the value of a rate group table's cell. Exactly one of noShipping, flatRate, pricePercentage, carrierRateName, subtableName must be set. + * The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set. */ export interface Schema$Value { /** @@ -5361,7 +5381,7 @@ export namespace content_v2 { */ noShipping?: boolean | null; /** - * A percentage of the price represented as a number in decimal notation (e.g., "5.4"). Can only be set if all other fields are not set. + * A percentage of the price represented as a number in decimal notation (e.g., `"5.4"`). Can only be set if all other fields are not set. */ pricePercentage?: string | null; /** @@ -5371,7 +5391,7 @@ export namespace content_v2 { } export interface Schema$Weight { /** - * Required. The weight unit. Acceptable values are: - "kg" - "lb" + * Required. The weight unit. Acceptable values are: - "`kg`" - "`lb`" */ unit?: string | null; /** diff --git a/src/apis/customsearch/v1.ts b/src/apis/customsearch/v1.ts index 960b0187ccc..fbc6109e5f4 100644 --- a/src/apis/customsearch/v1.ts +++ b/src/apis/customsearch/v1.ts @@ -122,13 +122,13 @@ export namespace customsearch_v1 { */ export interface Schema$Promotion { /** - * An array of block objects for this promotion. See Google WebSearch Protocol reference for more information. + * An array of block objects for this promotion. See [Google WebSearch Protocol reference](https://developers.google.com/custom-search/docs/xml_results) for more information. */ bodyLines?: Array<{ - title?: string; - htmlTitle?: string; url?: string; link?: string; + title?: string; + htmlTitle?: string; }> | null; /** * An abridged version of this search's result URL, e.g. www.example.com. @@ -196,11 +196,11 @@ export namespace customsearch_v1 { thumbnailHeight?: number; } | null; /** - * A unique identifier for the type of current object. For this API, it is customsearch#result. + * A unique identifier for the type of current object. For this API, it is `customsearch#result.` */ kind?: string | null; /** - * Encapsulates all information about refinement labels. + * Encapsulates all information about [refinement labels](https://developers.google.com/custom-search/docs/xml_results). */ labels?: Array<{ name?: string; @@ -216,7 +216,7 @@ export namespace customsearch_v1 { */ mime?: string | null; /** - * Contains PageMap information for this search result. + * Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result. */ pagemap?: {[key: string]: any} | null; /** @@ -233,7 +233,7 @@ export namespace customsearch_v1 { */ export interface Schema$Search { /** - * Metadata and refinements associated with the given search engine. + * Metadata and refinements associated with the given search engine, including: * The name of the search engine that was used for the query. * A set of [facet objects](https://developers.google.com/custom-search/docs/refinements#create) (refinements) you can use for refining a search. */ context?: {[key: string]: any} | null; /** @@ -245,59 +245,56 @@ export namespace customsearch_v1 { */ kind?: string | null; /** - * The set of promotions. Present only if the custom search engine's configuration files define any promotions for the given query. + * The set of [promotions](https://developers.google.com/custom-search/docs/promotions). Present only if the custom search engine's configuration files define any promotions for the given query. */ promotions?: Schema$Promotion[]; /** * Query metadata for the previous, current, and next pages of results. */ queries?: { - request?: Array<{ + previousPage?: Array<{ + cx?: string; + lowRange?: string; + inputEncoding?: string; + imgDominantColor?: string; + imgColorType?: string; + safe?: string; + language?: string; + siteSearchFilter?: string; + outputEncoding?: string; + sort?: string; + linkSite?: string; + searchTerms?: string; + hq?: string; + fileType?: string; + searchType?: string; + googleHost?: string; relatedSite?: string; siteSearch?: string; excludeTerms?: string; exactTerms?: string; - imgType?: string; totalResults?: string; + imgType?: string; filter?: string; startIndex?: number; highRange?: string; - hl?: string; gl?: string; - cr?: string; - startPage?: number; + hl?: string; imgSize?: string; + startPage?: number; + cr?: string; disableCnTwTranslation?: string; title?: string; orTerms?: string; count?: number; dateRestrict?: string; rights?: string; - cx?: string; - lowRange?: string; - inputEncoding?: string; - imgDominantColor?: string; - imgColorType?: string; - language?: string; - safe?: string; - siteSearchFilter?: string; - outputEncoding?: string; - sort?: string; - linkSite?: string; - searchTerms?: string; - hq?: string; - searchType?: string; - fileType?: string; - googleHost?: string; }>; - nextPage?: Array<{ - cx?: string; - lowRange?: string; - inputEncoding?: string; - imgDominantColor?: string; + request?: Array<{ imgColorType?: string; - safe?: string; + imgDominantColor?: string; language?: string; + safe?: string; siteSearchFilter?: string; outputEncoding?: string; sort?: string; @@ -316,55 +313,58 @@ export namespace customsearch_v1 { filter?: string; startIndex?: number; highRange?: string; - hl?: string; gl?: string; - cr?: string; - startPage?: number; + hl?: string; imgSize?: string; + startPage?: number; + cr?: string; disableCnTwTranslation?: string; title?: string; orTerms?: string; count?: number; dateRestrict?: string; rights?: string; + cx?: string; + lowRange?: string; + inputEncoding?: string; }>; - previousPage?: Array<{ + nextPage?: Array<{ + searchTerms?: string; + hq?: string; + searchType?: string; + fileType?: string; + googleHost?: string; + relatedSite?: string; + siteSearch?: string; excludeTerms?: string; exactTerms?: string; - totalResults?: string; imgType?: string; + totalResults?: string; filter?: string; startIndex?: number; highRange?: string; - gl?: string; hl?: string; + gl?: string; cr?: string; startPage?: number; imgSize?: string; disableCnTwTranslation?: string; title?: string; orTerms?: string; - dateRestrict?: string; count?: number; + dateRestrict?: string; rights?: string; cx?: string; lowRange?: string; inputEncoding?: string; imgDominantColor?: string; imgColorType?: string; - safe?: string; language?: string; + safe?: string; siteSearchFilter?: string; outputEncoding?: string; sort?: string; linkSite?: string; - searchTerms?: string; - hq?: string; - fileType?: string; - searchType?: string; - googleHost?: string; - relatedSite?: string; - siteSearch?: string; }>; } | null; /** @@ -383,7 +383,7 @@ export namespace customsearch_v1 { /** * OpenSearch template and URL. */ - url?: {type?: string; template?: string} | null; + url?: {template?: string; type?: string} | null; } export class Resource$Cse { @@ -399,37 +399,37 @@ export namespace customsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.c2coff Turns off the translation between zh-CN and zh-TW. - * @param {string=} params.cr Country restrict(s). - * @param {string=} params.cx The custom search engine ID to scope this search query - * @param {string=} params.dateRestrict Specifies all search results are from a time period - * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain - * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results - * @param {string=} params.fileType Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... - * @param {string=} params.filter Controls turning on (1) or off (0) the duplicate content filter. - * @param {string=} params.gl Geolocation of end user. - * @param {string=} params.googlehost The local Google domain to use to perform the search. - * @param {string=} params.highRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.hl Sets the user interface language. - * @param {string=} params.hq Appends the extra hidden query terms to the query. - * @param {string=} params.imgColorType Returns black and white, grayscale, transparent-background or color images: mono, gray, trans, and color. - * @param {string=} params.imgDominantColor Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. - * @param {string=} params.imgSize Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. - * @param {string=} params.imgType Returns images of a type, which can be one of: clipart, face, lineart, stock, photo, and animated. - * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL - * @param {string=} params.lowRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.lr The language restriction for the search results - * @param {integer=} params.num Number of search results to return - * @param {string=} params.orTerms Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms + * @param {string=} params.c2coff Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) + * @param {string=} params.cr Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. + * @param {string=} params.cx The custom search engine ID to use for this request. + * @param {string=} params.dateRestrict Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. + * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain. + * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results. + * @param {string=} params.fileType Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). + * @param {string=} params.filter Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. + * @param {string=} params.gl Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. + * @param {string=} params.googlehost **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. + * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.hl Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. + * @param {string=} params.hq Appends the specified query terms to the query, as if they were combined with a logical AND operator. + * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL. + * @param {string=} params.lowRange Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.lr Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) + * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * @param {string=} params.orTerms Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. * @param {string=} params.q Query - * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL - * @param {string=} params.rights Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See https://wiki.creativecommons.org/wiki/CC_Search_integration for typical combinations. - * @param {string=} params.safe Search safety level (active, off) (high, medium are same as active) - * @param {string=} params.searchType Specifies the search type: image. - * @param {string=} params.siteSearch Specifies all search results should be pages from a given site - * @param {string=} params.siteSearchFilter Controls whether to include (i) or exclude (e) results from the site named in the siteSearch parameter - * @param {string=} params.sort The sort expression to apply to the results - * @param {integer=} params.start The index of the first result to return + * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL. + * @param {string=} params.rights Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * @param {string=} params.siteSearch Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). + * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * @param {string=} params.sort The sort expression to apply to the results. + * @param {integer=} params.start The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -498,91 +498,91 @@ export namespace customsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Turns off the translation between zh-CN and zh-TW. + * Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) */ c2coff?: string; /** - * Country restrict(s). + * Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. */ cr?: string; /** - * The custom search engine ID to scope this search query + * The custom search engine ID to use for this request. */ cx?: string; /** - * Specifies all search results are from a time period + * Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. */ dateRestrict?: string; /** - * Identifies a phrase that all documents in the search results must contain + * Identifies a phrase that all documents in the search results must contain. */ exactTerms?: string; /** - * Identifies a word or phrase that should not appear in any documents in the search results + * Identifies a word or phrase that should not appear in any documents in the search results. */ excludeTerms?: string; /** - * Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... + * Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). */ fileType?: string; /** - * Controls turning on (1) or off (0) the duplicate content filter. + * Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. */ filter?: string; /** - * Geolocation of end user. + * Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. */ gl?: string; /** - * The local Google domain to use to perform the search. + * **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. */ googlehost?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ highRange?: string; /** - * Sets the user interface language. + * Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. */ hl?: string; /** - * Appends the extra hidden query terms to the query. + * Appends the specified query terms to the query, as if they were combined with a logical AND operator. */ hq?: string; /** - * Returns black and white, grayscale, transparent-background or color images: mono, gray, trans, and color. + * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */ imgColorType?: string; /** - * Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. + * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */ imgDominantColor?: string; /** - * Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. + * Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */ imgSize?: string; /** - * Returns images of a type, which can be one of: clipart, face, lineart, stock, photo, and animated. + * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */ imgType?: string; /** - * Specifies that all search results should contain a link to a particular URL + * Specifies that all search results should contain a link to a particular URL. */ linkSite?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ lowRange?: string; /** - * The language restriction for the search results + * Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) */ lr?: string; /** - * Number of search results to return + * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */ num?: number; /** - * Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms + * Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. */ orTerms?: string; /** @@ -590,35 +590,35 @@ export namespace customsearch_v1 { */ q?: string; /** - * Specifies that all search results should be pages that are related to the specified URL + * Specifies that all search results should be pages that are related to the specified URL. */ relatedSite?: string; /** - * Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See https://wiki.creativecommons.org/wiki/CC_Search_integration for typical combinations. + * Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). */ rights?: string; /** - * Search safety level (active, off) (high, medium are same as active) + * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */ safe?: string; /** - * Specifies the search type: image. + * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */ searchType?: string; /** - * Specifies all search results should be pages from a given site + * Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */ siteSearch?: string; /** - * Controls whether to include (i) or exclude (e) results from the site named in the siteSearch parameter + * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; /** - * The sort expression to apply to the results + * The sort expression to apply to the results. */ sort?: string; /** - * The index of the first result to return + * The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. */ start?: number; } @@ -636,37 +636,37 @@ export namespace customsearch_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.c2coff Turns off the translation between zh-CN and zh-TW. - * @param {string=} params.cr Country restrict(s). - * @param {string=} params.cx The custom search engine ID to scope this search query - * @param {string=} params.dateRestrict Specifies all search results are from a time period - * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain - * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results - * @param {string=} params.fileType Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... - * @param {string=} params.filter Controls turning on (1) or off (0) the duplicate content filter. - * @param {string=} params.gl Geolocation of end user. - * @param {string=} params.googlehost The local Google domain to use to perform the search. - * @param {string=} params.highRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.hl Sets the user interface language. - * @param {string=} params.hq Appends the extra hidden query terms to the query. - * @param {string=} params.imgColorType Returns black and white, grayscale, transparent-background or color images: mono, gray, trans, and color. - * @param {string=} params.imgDominantColor Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. - * @param {string=} params.imgSize Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. - * @param {string=} params.imgType Returns images of a type, which can be one of: clipart, face, lineart, stock, photo, and animated. - * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL - * @param {string=} params.lowRange Creates a range in form as_nlo value..as_nhi value and attempts to append it to query - * @param {string=} params.lr The language restriction for the search results - * @param {integer=} params.num Number of search results to return - * @param {string=} params.orTerms Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms + * @param {string=} params.c2coff Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) + * @param {string=} params.cr Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. + * @param {string=} params.cx The custom search engine ID to use for this request. + * @param {string=} params.dateRestrict Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. + * @param {string=} params.exactTerms Identifies a phrase that all documents in the search results must contain. + * @param {string=} params.excludeTerms Identifies a word or phrase that should not appear in any documents in the search results. + * @param {string=} params.fileType Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). + * @param {string=} params.filter Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. + * @param {string=} params.gl Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. + * @param {string=} params.googlehost **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. + * @param {string=} params.highRange Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.hl Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. + * @param {string=} params.hq Appends the specified query terms to the query, as if they were combined with a logical AND operator. + * @param {string=} params.imgColorType Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background + * @param {string=} params.imgDominantColor Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` + * @param {string=} params.imgSize Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` + * @param {string=} params.imgType Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` + * @param {string=} params.linkSite Specifies that all search results should contain a link to a particular URL. + * @param {string=} params.lowRange Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. + * @param {string=} params.lr Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) + * @param {integer=} params.num Number of search results to return. * Valid values are integers between 1 and 10, inclusive. + * @param {string=} params.orTerms Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. * @param {string=} params.q Query - * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL - * @param {string=} params.rights Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See https://wiki.creativecommons.org/wiki/CC_Search_integration for typical combinations. - * @param {string=} params.safe Search safety level (active, off) (high, medium are same as active) - * @param {string=} params.searchType Specifies the search type: image. - * @param {string=} params.siteSearch Specifies all search results should be pages from a given site - * @param {string=} params.siteSearchFilter Controls whether to include (i) or exclude (e) results from the site named in the siteSearch parameter - * @param {string=} params.sort The sort expression to apply to the results - * @param {integer=} params.start The index of the first result to return + * @param {string=} params.relatedSite Specifies that all search results should be pages that are related to the specified URL. + * @param {string=} params.rights Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). + * @param {string=} params.safe Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) + * @param {string=} params.searchType Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. + * @param {string=} params.siteSearch Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). + * @param {string=} params.siteSearchFilter Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include + * @param {string=} params.sort The sort expression to apply to the results. + * @param {integer=} params.start The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -740,91 +740,91 @@ export namespace customsearch_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Turns off the translation between zh-CN and zh-TW. + * Enables or disables [Simplified and Traditional Chinese Search](https://developers.google.com/custom-search/docs/xml_results#chineseSearch). The default value for this parameter is 0 (zero), meaning that the feature is enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default) */ c2coff?: string; /** - * Country restrict(s). + * Restricts search results to documents originating in a particular country. You may use [Boolean operators](https://developers.google.com/custom-search/docs/xml_results_appendices#booleanOperators) in the cr parameter's value. Google Search determines the country of a document by analyzing: * the top-level domain (TLD) of the document's URL * the geographic location of the Web server's IP address See the [Country Parameter Values](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCollections) page for a list of valid values for this parameter. */ cr?: string; /** - * The custom search engine ID to scope this search query + * The custom search engine ID to use for this request. */ cx?: string; /** - * Specifies all search results are from a time period + * Restricts results to URLs based on date. Supported values include: * `d[number]`: requests results from the specified number of past days. * `w[number]`: requests results from the specified number of past weeks. * `m[number]`: requests results from the specified number of past months. * `y[number]`: requests results from the specified number of past years. */ dateRestrict?: string; /** - * Identifies a phrase that all documents in the search results must contain + * Identifies a phrase that all documents in the search results must contain. */ exactTerms?: string; /** - * Identifies a word or phrase that should not appear in any documents in the search results + * Identifies a word or phrase that should not appear in any documents in the search results. */ excludeTerms?: string; /** - * Returns images of a specified type. Some of the allowed values are: bmp, gif, png, jpg, svg, pdf, ... + * Restricts results to files of a specified extension. A list of file types indexable by Google can be found in Search Console [Help Center](https://support.google.com/webmasters/answer/35287). */ fileType?: string; /** - * Controls turning on (1) or off (0) the duplicate content filter. + * Controls turning on or off the duplicate content filter. * See [Automatic Filtering](https://developers.google.com/custom-search/docs/xml_results#automaticFiltering) for more information about Google's search results filters. Note that host crowding filtering applies only to multi-site searches. * By default, Google applies filtering to all search results to improve the quality of those results. Acceptable values are: * `0`: Turns off duplicate content filter. * `1`: Turns on duplicate content filter. */ filter?: string; /** - * Geolocation of end user. + * Geolocation of end user. * The `gl` parameter value is a two-letter country code. The `gl` parameter boosts search results whose country of origin matches the parameter value. See the [Country Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#countryCodes) page for a list of valid values. * Specifying a `gl` parameter value should lead to more relevant results. This is particularly true for international customers and, even more specifically, for customers in English- speaking countries other than the United States. */ gl?: string; /** - * The local Google domain to use to perform the search. + * **Deprecated**. Use the `gl` parameter for a similar effect. The local Google domain (for example, google.com, google.de, or google.fr) to use to perform the search. */ googlehost?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * Specifies the ending value for a search range. * Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ highRange?: string; /** - * Sets the user interface language. + * Sets the user interface language. * Explicitly setting this parameter improves the performance and the quality of your search results. * See the [Interface Languages](https://developers.google.com/custom-search/docs/xml_results#wsInterfaceLanguages) section of [Internationalizing Queries and Results Presentation](https://developers.google.com/custom-search/docs/xml_results#wsInternationalizing) for more information, and (Supported Interface Languages)[https://developers.google.com/custom-search/docs/xml_results_appendices#interfaceLanguages] for a list of supported languages. */ hl?: string; /** - * Appends the extra hidden query terms to the query. + * Appends the specified query terms to the query, as if they were combined with a logical AND operator. */ hq?: string; /** - * Returns black and white, grayscale, transparent-background or color images: mono, gray, trans, and color. + * Returns black and white, grayscale, transparent, or color images. Acceptable values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`: transparent background */ imgColorType?: string; /** - * Returns images of a specific dominant color: red, orange, yellow, green, teal, blue, purple, pink, white, gray, black and brown. + * Returns images of a specific dominant color. Acceptable values are: * `"black"` * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"` */ imgDominantColor?: string; /** - * Returns images of a specified size, where size can be one of: icon, small, medium, large, xlarge, xxlarge, and huge. + * Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"` */ imgSize?: string; /** - * Returns images of a type, which can be one of: clipart, face, lineart, stock, photo, and animated. + * Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"lineart"` * `"stock"` * `"photo"` * `"animated"` */ imgType?: string; /** - * Specifies that all search results should contain a link to a particular URL + * Specifies that all search results should contain a link to a particular URL. */ linkSite?: string; /** - * Creates a range in form as_nlo value..as_nhi value and attempts to append it to query + * Specifies the starting value for a search range. Use `lowRange` and `highRange` to append an inclusive search range of `lowRange...highRange` to the query. */ lowRange?: string; /** - * The language restriction for the search results + * Restricts the search to documents written in a particular language (e.g., `lr=lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`: Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `"lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`: Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French * `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`: Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`: Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `"lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`: Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"lang_zh-TW"`: Chinese (Traditional) */ lr?: string; /** - * Number of search results to return + * Number of search results to return. * Valid values are integers between 1 and 10, inclusive. */ num?: number; /** - * Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms + * Provides additional search terms to check for in a document, where each document in the search results must contain at least one of the additional search terms. */ orTerms?: string; /** @@ -832,35 +832,35 @@ export namespace customsearch_v1 { */ q?: string; /** - * Specifies that all search results should be pages that are related to the specified URL + * Specifies that all search results should be pages that are related to the specified URL. */ relatedSite?: string; /** - * Filters based on licensing. Supported values include: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived and combinations of these. See https://wiki.creativecommons.org/wiki/CC_Search_integration for typical combinations. + * Filters based on licensing. Supported values include: `cc_publicdomain`, `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and combinations of these. See [typical combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration). */ rights?: string; /** - * Search safety level (active, off) (high, medium are same as active) + * Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch filtering. * `"off"`: Disables SafeSearch filtering. (default) */ safe?: string; /** - * Specifies the search type: image. + * Specifies the search type: `image`. If unspecified, results are limited to webpages. Acceptable values are: * `"image"`: custom image search. */ searchType?: string; /** - * Specifies all search results should be pages from a given site + * Specifies a given site which should always be included or excluded from results (see `siteSearchFilter` parameter, below). */ siteSearch?: string; /** - * Controls whether to include (i) or exclude (e) results from the site named in the siteSearch parameter + * Controls whether to include or exclude results from the site named in the `siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`: include */ siteSearchFilter?: string; /** - * The sort expression to apply to the results + * The sort expression to apply to the results. */ sort?: string; /** - * The index of the first result to return + * The index of the first result to return. The default number of results per page is 10, so `&start=11` would start at the top of the second page of results. **Note**: The JSON API will never return more than 100 results, even if more than 100 documents match the query, so setting the sum of `start + num` to a number greater than 100 will produce an error. Also note that the maximum value for `num` is 10. */ start?: number; } diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index 956cc82539c..f2581fad8c1 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -166,7 +166,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GetIamPolicyRequest { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */ options?: Schema$GetPolicyOptions; } @@ -529,7 +529,7 @@ export namespace datacatalog_v1beta1 { */ pageToken?: string | null; /** - * Required. The query string in search query syntax. The query must be non-empty. Query strings can be simple as "x" or more qualified as: * name:x * column:x * description:y Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information. + * Required. The query string in search query syntax. The query must be non-empty. Query strings can be simple as "x" or more qualified as: * name:x * column:x * description:y Note: Query tokens need to have a minimum of 3 characters for substring matching to work correctly. See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information. */ query?: string | null; /** @@ -649,7 +649,7 @@ export namespace datacatalog_v1beta1 { groupedEntry?: string | null; } /** - * Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See [Data Catalog IAM](/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. + * Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template. See [Data Catalog IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information on the permissions needed to create or view tags. */ export interface Schema$GoogleCloudDatacatalogV1beta1Tag { /** @@ -718,7 +718,7 @@ export namespace datacatalog_v1beta1 { displayName?: string | null; } /** - * A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. [Tag template roles](/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template (see, for example, the [TagTemplate User](/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources. + * A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources. [Tag template roles](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources. */ export interface Schema$GoogleCloudDatacatalogV1beta1TagTemplate { /** @@ -844,7 +844,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.catalog.search - * @desc Searches Data Catalog for multiple resources like entries, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call `Get` methods. Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries. See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information. + * @desc Searches Data Catalog for multiple resources like entries, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call `Get` methods. Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries. See [Data Catalog Search Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) for more information. * @alias datacatalog.catalog.search * @memberOf! () * @@ -966,7 +966,7 @@ export namespace datacatalog_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.linkedResource The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive. Examples: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId * //pubsub.googleapis.com/projects/projectId/topics/topicId - * @param {string=} params.sqlResource The SQL name of the entry. SQL names are case-sensitive. Examples: * `cloud_pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. + * @param {string=} params.sqlResource The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1053,7 +1053,7 @@ export namespace datacatalog_v1beta1 { */ linkedResource?: string; /** - * The SQL name of the entry. SQL names are case-sensitive. Examples: * `cloud_pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. + * The SQL name of the entry. SQL names are case-sensitive. Examples: * `pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. */ sqlResource?: string; } @@ -1102,7 +1102,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.create - * @desc A maximum of 10,000 entry groups may be created per organization across all locations. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc A maximum of 10,000 entry groups may be created per organization across all locations. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.create * @memberOf! () * @@ -1195,7 +1195,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.delete - * @desc Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.delete * @memberOf! () * @@ -1529,7 +1529,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.patch - * @desc Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.patch * @memberOf! () * @@ -1931,7 +1931,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.entries.create - * @desc Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). A maximum of 100,000 entries may be created per entry group. + * @desc Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). A maximum of 100,000 entries may be created per entry group. * @alias datacatalog.projects.locations.entryGroups.entries.create * @memberOf! () * @@ -2016,7 +2016,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.entries.delete - * @desc Deletes an existing entry. Only entries created through CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes an existing entry. Only entries created through CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.entries.delete * @memberOf! () * @@ -2339,7 +2339,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.entries.patch - * @desc Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.entries.patch * @memberOf! () * @@ -2635,7 +2635,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.entries.tags.create - * @desc Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization. + * @desc Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization. * @alias datacatalog.projects.locations.entryGroups.entries.tags.create * @memberOf! () * @@ -3049,7 +3049,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.tags.create - * @desc Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization. + * @desc Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization. * @alias datacatalog.projects.locations.entryGroups.tags.create * @memberOf! () * @@ -3467,12 +3467,12 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.create - * @desc Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](/data-catalog/docs/concepts/resource-project) for more information). + * @desc Creates a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1 + * @param {string} params.parent Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions. Example: * projects/{project_id}/locations/us-central1 * @param {string=} params.tagTemplateId Required. The id of the tag template to create. * @param {().GoogleCloudDatacatalogV1beta1TagTemplate} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3560,7 +3560,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.delete - * @desc Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.delete * @memberOf! () * @@ -3791,7 +3791,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.patch - * @desc Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.patch * @memberOf! () * @@ -4043,7 +4043,7 @@ export namespace datacatalog_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1 + * Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions. Example: * projects/{project_id}/locations/us-central1 */ parent?: string; /** @@ -4165,12 +4165,12 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.fields.create - * @desc Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](/data-catalog/docs/concepts/resource-project) for more information). + * @desc Creates a field in a tag template. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.fields.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} + * @param {string} params.parent Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions). Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} * @param {string=} params.tagTemplateFieldId Required. The ID of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. * @param {().GoogleCloudDatacatalogV1beta1TagTemplateField} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4266,7 +4266,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.fields.delete - * @desc Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.fields.delete * @memberOf! () * @@ -4336,7 +4336,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.fields.patch - * @desc Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.fields.patch * @memberOf! () * @@ -4434,7 +4434,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.fields.rename - * @desc Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project](/data-catalog/docs/concepts/resource-project) for more information). + * @desc Renames a field in a tag template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project](https://cloud.google.com/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.fields.rename * @memberOf! () * @@ -4541,7 +4541,7 @@ export namespace datacatalog_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} + * Required. The name of the project and the template location [region](https://cloud.google.com/data-catalog/docs/concepts/regions). Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} */ parent?: string; /** diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 0aa829bf1d9..a76a1b9f9db 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -239,7 +239,7 @@ export namespace dataproc_v1 { */ labels?: {[key: string]: string} | null; /** - * Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. + * Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ metrics?: Schema$ClusterMetrics; /** @@ -645,7 +645,7 @@ export namespace dataproc_v1 { */ diskConfig?: Schema$DiskConfig; /** - * Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version. + * Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default. */ imageUri?: string | null; /** @@ -873,7 +873,7 @@ export namespace dataproc_v1 { */ crossRealmTrustSharedPasswordUri?: string | null; /** - * Optional. Flag to indicate whether to Kerberize the cluster. + * Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster. */ enableKerberos?: boolean | null; /** @@ -1179,7 +1179,7 @@ export namespace dataproc_v1 { version?: number | null; } /** - * A Dataproc job for running Presto (https://prestosql.io/) queries + * A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component must be enabled when the cluster is created to submit a Presto job to the cluster. */ export interface Schema$PrestoJob { /** diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 9e602c76045..6a55f45c007 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -675,7 +675,7 @@ export namespace dataproc_v1beta2 { */ diskConfig?: Schema$DiskConfig; /** - * Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version. + * Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default. */ imageUri?: string | null; /** @@ -744,7 +744,13 @@ export namespace dataproc_v1beta2 { * Output only. A URI pointing to the location of the stdout of the job's driver program. */ driverOutputResourceUri?: string | null; + /** + * Optional. Job is a Hadoop job. + */ hadoopJob?: Schema$HadoopJob; + /** + * Optional. Job is a Hive job. + */ hiveJob?: Schema$HiveJob; /** * Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. @@ -754,12 +760,21 @@ export namespace dataproc_v1beta2 { * Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. */ labels?: {[key: string]: string} | null; + /** + * Optional. Job is a Pig job. + */ pigJob?: Schema$PigJob; /** * Required. Job information, including how, when, and where to run the job. */ placement?: Schema$JobPlacement; + /** + * Optional. Job is a Presto job. + */ prestoJob?: Schema$PrestoJob; + /** + * Optional. Job is a PySpark job. + */ pysparkJob?: Schema$PySparkJob; /** * Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. @@ -769,8 +784,17 @@ export namespace dataproc_v1beta2 { * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; + /** + * Optional. Job is a Spark job. + */ sparkJob?: Schema$SparkJob; + /** + * Optional. Job is a SparkR job. + */ sparkRJob?: Schema$SparkRJob; + /** + * Optional. Job is a SparkSql job. + */ sparkSqlJob?: Schema$SparkSqlJob; /** * Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. @@ -887,7 +911,7 @@ export namespace dataproc_v1beta2 { */ crossRealmTrustSharedPasswordUri?: string | null; /** - * Optional. Flag to indicate whether to Kerberize the cluster. + * Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster. */ enableKerberos?: boolean | null; /** @@ -1206,7 +1230,7 @@ export namespace dataproc_v1beta2 { version?: number | null; } /** - * A Dataproc job for running Presto (https://prestosql.io/) queries + * A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component must be enabled when the cluster is created to submit a Presto job to the cluster. */ export interface Schema$PrestoJob { /** diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 281ee87bac2..e1625c89266 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -371,7 +371,7 @@ export namespace dialogflow_v2 { */ name?: string | null; /** - * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value + * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -430,7 +430,7 @@ export namespace dialogflow_v2 { */ name?: string | null; /** - * The collection of parameters associated with the event. + * The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -1419,7 +1419,7 @@ export namespace dialogflow_v2 { */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** - * The collection of extracted parameters. + * The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; /** @@ -1557,7 +1557,7 @@ export namespace dialogflow_v2 { */ name?: string | null; /** - * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value + * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -1683,6 +1683,31 @@ export namespace dialogflow_v2 { */ value?: string | null; } + /** + * Represents an agent environment. + */ + export interface Schema$GoogleCloudDialogflowV2Environment { + /** + * Optional. The agent version loaded into this environment. Format: `projects/<Project ID>/agent/versions/<Version ID>`. + */ + agentVersion?: string | null; + /** + * Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. + */ + description?: string | null; + /** + * Output only. The unique identifier of this agent environment. Format: `projects/<Project ID>/agent/environments/<Environment ID>`. For Environment ID, "-" is reserved for 'draft' environment. + */ + name?: string | null; + /** + * Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + */ + state?: string | null; + /** + * Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + */ + updateTime?: string | null; + } /** * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ @@ -1696,7 +1721,7 @@ export namespace dialogflow_v2 { */ name?: string | null; /** - * The collection of parameters associated with the event. + * The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -2511,6 +2536,19 @@ export namespace dialogflow_v2 { */ nextPageToken?: string | null; } + /** + * The response message for Environments.ListEnvironments. + */ + export interface Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse { + /** + * The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request. + */ + environments?: Schema$GoogleCloudDialogflowV2Environment[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + } /** * The response message for Intents.ListIntents. */ @@ -2708,7 +2746,7 @@ export namespace dialogflow_v2 { */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * The collection of extracted parameters. + * The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; /** @@ -5210,6 +5248,127 @@ export namespace dialogflow_v2 { this.context = context; this.users = new Resource$Projects$Agent$Environments$Users(this.context); } + + /** + * dialogflow.projects.agent.environments.list + * @desc Returns the list of all non-draft environments of the specified agent. + * @alias dialogflow.projects.agent.environments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. + * @param {string} params.parent Required. The agent to list all environments from. Format: `projects//agent`. + * @param {object} [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$Agent$Environments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Agent$Environments$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + > + ): void; + list( + params: Params$Resource$Projects$Agent$Environments$List, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Agent$Environments$List + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Agent$Environments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Agent$Environments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/environments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudDialogflowV2ListEnvironmentsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Projects$Agent$Environments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The agent to list all environments from. Format: `projects//agent`. + */ + parent?: string; } export class Resource$Projects$Agent$Environments$Users { diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index cd6682fedaf..177c659a19f 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -374,7 +374,7 @@ export namespace dialogflow_v2beta1 { */ name?: string | null; /** - * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value + * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -516,6 +516,31 @@ export namespace dialogflow_v2beta1 { */ value?: string | null; } + /** + * Represents an agent environment. + */ + export interface Schema$GoogleCloudDialogflowV2beta1Environment { + /** + * Optional. The agent version loaded into this environment. Format: `projects/<Project ID>/agent/versions/<Version ID>`. + */ + agentVersion?: string | null; + /** + * Optional. The developer-provided description for this environment. The maximum length is 500 characters. If exceeded, the request is rejected. + */ + description?: string | null; + /** + * Output only. The unique identifier of this agent environment. Format: `projects/<Project ID>/agent/environments/<Environment ID>`. For Environment ID, "-" is reserved for 'draft' environment. + */ + name?: string | null; + /** + * Output only. The state of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + */ + state?: string | null; + /** + * Output only. The last update time of this environment. This field is read-only, i.e., it cannot be set by create and update methods. + */ + updateTime?: string | null; + } /** * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ @@ -529,7 +554,7 @@ export namespace dialogflow_v2beta1 { */ name?: string | null; /** - * The collection of parameters associated with the event. + * The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -1652,6 +1677,19 @@ export namespace dialogflow_v2beta1 { */ nextPageToken?: string | null; } + /** + * The response message for Environments.ListEnvironments. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse { + /** + * The list of agent environments. There will be a maximum number of items returned based on the page_size field in the request. + */ + environments?: Schema$GoogleCloudDialogflowV2beta1Environment[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + } /** * The response message for Intents.ListIntents. */ @@ -1832,7 +1870,7 @@ export namespace dialogflow_v2beta1 { */ outputContexts?: Schema$GoogleCloudDialogflowV2beta1Context[]; /** - * The collection of extracted parameters. + * The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; /** @@ -2121,7 +2159,7 @@ export namespace dialogflow_v2beta1 { */ name?: string | null; /** - * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value + * Optional. The collection of parameters associated with this context. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -2201,7 +2239,7 @@ export namespace dialogflow_v2beta1 { */ name?: string | null; /** - * The collection of parameters associated with the event. + * The collection of parameters associated with the event. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; } @@ -2963,7 +3001,7 @@ export namespace dialogflow_v2beta1 { */ outputContexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * The collection of extracted parameters. + * The collection of extracted parameters. Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey type: string - MapKey value: parameter name - MapValue type: - If parameter's entity type is a composite entity: map - Else: string or number, depending on parameter value type - MapValue value: - If parameter's entity type is a composite entity: map from composite entity property names to property values - Else: parameter value */ parameters?: {[key: string]: any} | null; /** @@ -5387,6 +5425,129 @@ export namespace dialogflow_v2beta1 { this.context = context; this.users = new Resource$Projects$Agent$Environments$Users(this.context); } + + /** + * dialogflow.projects.agent.environments.list + * @desc Returns the list of all non-draft environments of the specified agent. + * @alias dialogflow.projects.agent.environments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. + * @param {string} params.parent Required. The agent to list all environments from. Format: `projects//agent`. + * @param {object} [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$Agent$Environments$List, + options?: MethodOptions + ): GaxiosPromise< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >; + list( + params: Params$Resource$Projects$Agent$Environments$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void; + list( + params: Params$Resource$Projects$Agent$Environments$List, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Agent$Environments$List + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Agent$Environments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Agent$Environments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/environments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Projects$Agent$Environments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The agent to list all environments from. Format: `projects//agent`. + */ + parent?: string; } export class Resource$Projects$Agent$Environments$Users { @@ -13080,6 +13241,129 @@ export namespace dialogflow_v2beta1 { this.context ); } + + /** + * dialogflow.projects.locations.agent.environments.list + * @desc Returns the list of all non-draft environments of the specified agent. + * @alias dialogflow.projects.locations.agent.environments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. + * @param {string} params.parent Required. The agent to list all environments from. Format: `projects//agent`. + * @param {object} [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$Agent$Environments$List, + options?: MethodOptions + ): GaxiosPromise< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >; + list( + params: Params$Resource$Projects$Locations$Agent$Environments$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void; + list( + params: Params$Resource$Projects$Locations$Agent$Environments$List, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agent$Environments$List + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agent$Environments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agent$Environments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/environments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudDialogflowV2beta1ListEnvironmentsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Agent$Environments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list request. + */ + pageToken?: string; + /** + * Required. The agent to list all environments from. Format: `projects//agent`. + */ + parent?: string; } export class Resource$Projects$Locations$Agent$Environments$Users { diff --git a/src/apis/displayvideo/v1.ts b/src/apis/displayvideo/v1.ts index fa749f1cc23..dcc405f2ace 100644 --- a/src/apis/displayvideo/v1.ts +++ b/src/apis/displayvideo/v1.ts @@ -103,8 +103,18 @@ export namespace displayvideo_v1 { */ export class Displayvideo { context: APIRequestContext; + advertisers: Resource$Advertisers; + combinedAudiences: Resource$Combinedaudiences; + customLists: Resource$Customlists; + firstAndThirdPartyAudiences: Resource$Firstandthirdpartyaudiences; + floodlightGroups: Resource$Floodlightgroups; + googleAudiences: Resource$Googleaudiences; + inventorySourceGroups: Resource$Inventorysourcegroups; + inventorySources: Resource$Inventorysources; media: Resource$Media; + partners: Resource$Partners; sdfdownloadtasks: Resource$Sdfdownloadtasks; + targetingTypes: Resource$Targetingtypes; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -112,224 +122,8942 @@ export namespace displayvideo_v1 { google, }; + this.advertisers = new Resource$Advertisers(this.context); + this.combinedAudiences = new Resource$Combinedaudiences(this.context); + this.customLists = new Resource$Customlists(this.context); + this.firstAndThirdPartyAudiences = new Resource$Firstandthirdpartyaudiences( + this.context + ); + this.floodlightGroups = new Resource$Floodlightgroups(this.context); + this.googleAudiences = new Resource$Googleaudiences(this.context); + this.inventorySourceGroups = new Resource$Inventorysourcegroups( + this.context + ); + this.inventorySources = new Resource$Inventorysources(this.context); this.media = new Resource$Media(this.context); + this.partners = new Resource$Partners(this.context); this.sdfdownloadtasks = new Resource$Sdfdownloadtasks(this.context); + this.targetingTypes = new Resource$Targetingtypes(this.context); } } /** - * Request message for [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Configuration for custom Active View video viewability metrics. */ - export interface Schema$CreateSdfDownloadTaskRequest { + export interface Schema$ActiveViewVideoViewabilityMetricConfig { /** - * The ID of the advertiser to download SDF for. + * Required. The display name of the custom metric. + */ + displayName?: string | null; + /** + * The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). + */ + minimumDuration?: string | null; + /** + * The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). + */ + minimumQuartile?: string | null; + /** + * Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded. + */ + minimumViewability?: string | null; + /** + * Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. + */ + minimumVolume?: string | null; + } + /** + * Details of Adloox settings. + */ + export interface Schema$Adloox { + /** + * Adloox's brand safety settings. + */ + excludedAdlooxCategories?: string[] | null; + } + /** + * A single advertiser in Display & Video 360 (DV360). + */ + export interface Schema$Advertiser { + /** + * Required. Immutable. Ad server related settings of the advertiser. + */ + adServerConfig?: Schema$AdvertiserAdServerConfig; + /** + * Output only. The unique ID of the advertiser. Assigned by the system. */ advertiserId?: string | null; /** - * Filters on entities by their entity IDs. + * Required. Creative related settings of the advertiser. */ - idFilter?: Schema$IdFilter; + creativeConfig?: Schema$AdvertiserCreativeConfig; /** - * Filters on Inventory Sources by their IDs. + * Settings that control how advertiser data may be accessed. */ - inventorySourceFilter?: Schema$InventorySourceFilter; + dataAccessConfig?: Schema$AdvertiserDataAccessConfig; /** - * Filters on selected file types. The entities in each file are filtered by a chosen set of filter entities. The filter entities must be the same type as, or a parent type of, the selected file types. + * Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. */ - parentEntityFilter?: Schema$ParentEntityFilter; + displayName?: string | null; /** - * The ID of the partner to download SDF for. + * Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion. + */ + entityStatus?: string | null; + /** + * Required. General settings of the advertiser. + */ + generalConfig?: Schema$AdvertiserGeneralConfig; + /** + * Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Output only. The resource name of the advertiser. + */ + name?: string | null; + /** + * Required. Immutable. The unique ID of the partner that the advertiser belongs to. */ partnerId?: string | null; /** - * Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise. + * Output only. The timestamp when the advertiser was last updated. Assigned by the system. */ - version?: string | null; + updateTime?: string | null; } /** - * Media resource. + * Ad server related settings of an advertiser. */ - export interface Schema$GoogleBytestreamMedia { + export interface Schema$AdvertiserAdServerConfig { /** - * Name of the media resource. + * The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers. */ - resourceName?: string | null; + cmHybridConfig?: Schema$CmHybridConfig; + /** + * The configuration for advertisers that use third-party ad servers only. + */ + thirdPartyOnlyConfig?: Schema$ThirdPartyOnlyConfig; } /** - * A filtering option that filters entities by their entity IDs. + * Creatives related settings of an advertiser. */ - export interface Schema$IdFilter { + export interface Schema$AdvertiserCreativeConfig { /** - * TrueView Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * Whether or not the advertiser is enabled for dynamic creatives. */ - adGroupAdIds?: string[] | null; + dynamicCreativeEnabled?: boolean | null; /** - * TrueView Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag. */ - adGroupIds?: string[] | null; + iasClientId?: string | null; /** - * Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * Whether or not to use DV360's Online Behavioral Advertising (OBA) compliance. Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved. */ - campaignIds?: string[] | null; + obaComplianceDisabled?: boolean | null; /** - * Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * By setting this field to `true`, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns. Applicable only when the advertiser has a CM hybrid ad server configuration. */ - insertionOrderIds?: string[] | null; + videoCreativeDataSharingAuthorized?: boolean | null; + } + /** + * Settings that control how advertiser related data may be accessed. + */ + export interface Schema$AdvertiserDataAccessConfig { /** - * Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used. */ - lineItemIds?: string[] | null; + sdfConfig?: Schema$AdvertiserSdfConfig; + } + /** + * General settings of an advertiser. + */ + export interface Schema$AdvertiserGeneralConfig { /** - * Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name * `ARS` : Argentine Peso * `AUD` : Australian Dollar * `BRL` : Brazilian Real * `CAD` : Canadian Dollar * `CHF` : Swiss Franc * `CLP` : Chilean Peso * `CNY` : Chinese Yuan * `COP` : Colombian Peso * `CZK` : Czech Koruna * `DKK` : Danish Krone * `EGP` : Egyption Pound * `EUR` : Euro * `GBP` : British Pound * `HKD` : Hong Kong Dollar * `HUF` : Hungarian Forint * `IDR` : Indonesian Rupiah * `ILS` : Israeli Shekel * `INR` : Indian Rupee * `JPY` : Japanese Yen * `KRW` : South Korean Won * `MXN` : Mexican Pesos * `MYR` : Malaysian Ringgit * `NGN` : Nigerian Naira * `NOK` : Norwegian Krone * `NZD` : New Zealand Dollar * `PEN` : Peruvian Nuevo Sol * `PLN` : Polish Zloty * `RON` : New Romanian Leu * `RUB` : Russian Ruble * `SEK` : Swedish Krona * `TRY` : Turkish Lira * `TWD` : New Taiwan Dollar * `USD` : US Dollar * `ZAR` : South African Rand */ - mediaProductIds?: string[] | null; + currencyCode?: string | null; + /** + * Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser. Provide a URL with no path or query string, beginning with `http:` or `https:`. For example, http://www.example.com + */ + domainUrl?: string | null; + /** + * Output only. The standard TZ database name of the advertiser's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner. + */ + timeZone?: string | null; } /** - * A filtering option for filtering on Inventory Source entities. + * Structured Data Files (SDF) settings of an advertiser. */ - export interface Schema$InventorySourceFilter { + export interface Schema$AdvertiserSdfConfig { /** - * Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner. + * Whether or not this advertiser overrides the SDF configuration of its parent partner. By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to `true` and provide the new configuration in sdfConfig. */ - inventorySourceIds?: string[] | null; + overridePartnerSdfConfig?: boolean | null; + /** + * The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`. + */ + sdfConfig?: Schema$SdfConfig; } /** - * This resource represents a long-running operation that is the result of a network API call. + * Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. */ - export interface Schema$Operation { + export interface Schema$AgeRangeAssignedTargetingOptionDetails { /** - * 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. + * Output only. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. */ - done?: boolean | null; + ageRange?: string | null; /** - * The error result of the operation in case of failure or cancellation. + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AGE_RANGE`. */ - error?: Schema$Status; + targetingOptionId?: string | null; + } + /** + * Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. + */ + export interface Schema$AgeRangeTargetingOptionDetails { /** - * 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. + * Output only. The age range of an audience. */ - metadata?: {[key: string]: any} | null; + ageRange?: string | null; + } + /** + * Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. + */ + export interface Schema$AppAssignedTargetingOptionDetails { /** - * 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 be a resource name ending with `operations/{unique_id}`. + * Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`. + */ + appId?: string | null; + /** + * Output only. The display name of the app. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Details for assigned app category targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + export interface Schema$AppCategoryAssignedTargetingOptionDetails { + /** + * Output only. The display name of the app category. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable collection of apps. A collection lets you target dynamic groups of related apps that are maintained by the platform, for example `All Apps/Google Play/Games`. This will be populated in the app_category field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + export interface Schema$AppCategoryTargetingOptionDetails { + /** + * Output only. The name of the app collection. + */ + displayName?: string | null; + } + /** + * A single asset. + */ + export interface Schema$Asset { + /** + * The asset content. For uploaded assets, the content is the serving path. + */ + content?: string | null; + /** + * Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. + */ + mediaId?: string | null; + } + /** + * Asset association for the creative. + */ + export interface Schema$AssetAssociation { + /** + * The associated asset. + */ + asset?: Schema$Asset; + /** + * The role of this asset for the creative. + */ + role?: string | null; + } + /** + * A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings, such as a Line Item or Insertion Order. + */ + export interface Schema$AssignedTargetingOption { + /** + * Age range details. This field will be populated when the TargetingType is `TARGETING_TYPE_AGE_RANGE`. + */ + ageRangeDetails?: Schema$AgeRangeAssignedTargetingOptionDetails; + /** + * App category details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP_CATEGORY`. + */ + appCategoryDetails?: Schema$AppCategoryAssignedTargetingOptionDetails; + /** + * App details. This field will be populated when the TargetingType is `TARGETING_TYPE_APP`. + */ + appDetails?: Schema$AppAssignedTargetingOptionDetails; + /** + * Output only. The unique ID of the assigned targeting option. The ID is only unique within a given line item and targeting type. It may be reused in other contexts. + */ + assignedTargetingOptionId?: string | null; + /** + * Audience targeting details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per line item. + */ + audienceGroupDetails?: Schema$AudienceGroupAssignedTargetingOptionDetails; + /** + * Authorized seller status details. This field will be populated when the TargetingType is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per line item. If a line item doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default. + */ + authorizedSellerStatusDetails?: Schema$AuthorizedSellerStatusAssignedTargetingOptionDetails; + /** + * Browser details. This field will be populated when the TargetingType is `TARGETING_TYPE_BROWSER`. + */ + browserDetails?: Schema$BrowserAssignedTargetingOptionDetails; + /** + * Carrier and ISP details. This field will be populated when the TargetingType is `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + carrierAndIspDetails?: Schema$CarrierAndIspAssignedTargetingOptionDetails; + /** + * Category details. This field will be populated when the TargetingType is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence. + */ + categoryDetails?: Schema$CategoryAssignedTargetingOptionDetails; + /** + * Channel details. This field will be populated when the TargetingType is `TARGETING_TYPE_CHANNEL`. + */ + channelDetails?: Schema$ChannelAssignedTargetingOptionDetails; + /** + * Content instream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + contentInstreamPositionDetails?: Schema$ContentInstreamPositionAssignedTargetingOptionDetails; + /** + * Content outstream position details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + contentOutstreamPositionDetails?: Schema$ContentOutstreamPositionAssignedTargetingOptionDetails; + /** + * Day and time details. This field will be populated when the TargetingType is `TARGETING_TYPE_DAY_AND_TIME`. + */ + dayAndTimeDetails?: Schema$DayAndTimeAssignedTargetingOptionDetails; + /** + * Device make and model details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + deviceMakeModelDetails?: Schema$DeviceMakeModelAssignedTargetingOptionDetails; + /** + * Device Type details. This field will be populated when the TargetingType is `TARGETING_TYPE_DEVICE_TYPE`. + */ + deviceTypeDetails?: Schema$DeviceTypeAssignedTargetingOptionDetails; + /** + * Digital content label details. This field will be populated when the TargetingType is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in line item settings). Line item settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded. + */ + digitalContentLabelExclusionDetails?: Schema$DigitalContentLabelAssignedTargetingOptionDetails; + /** + * Environment details. This field will be populated when the TargetingType is `TARGETING_TYPE_ENVIRONMENT`. + */ + environmentDetails?: Schema$EnvironmentAssignedTargetingOptionDetails; + /** + * Exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_EXCHANGE`. + */ + exchangeDetails?: Schema$ExchangeAssignedTargetingOptionDetails; + /** + * Gender details. This field will be populated when the TargetingType is `TARGETING_TYPE_GENDER`. + */ + genderDetails?: Schema$GenderAssignedTargetingOptionDetails; + /** + * Geographic region details. This field will be populated when the TargetingType is `TARGETING_TYPE_GEO_REGION`. + */ + geoRegionDetails?: Schema$GeoRegionAssignedTargetingOptionDetails; + /** + * Household income details. This field will be populated when the TargetingType is `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + householdIncomeDetails?: Schema$HouseholdIncomeAssignedTargetingOptionDetails; + /** + * Output only. The inheritance status of the assigned targeting option. + */ + inheritance?: string | null; + /** + * Inventory source details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE`. + */ + inventorySourceDetails?: Schema$InventorySourceAssignedTargetingOptionDetails; + /** + * Inventory source group details. This field will be populated when the TargetingType is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + */ + inventorySourceGroupDetails?: Schema$InventorySourceGroupAssignedTargetingOptionDetails; + /** + * Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a line item. No limit on number of positive keywords that can be assigned. + */ + keywordDetails?: Schema$KeywordAssignedTargetingOptionDetails; + /** + * Language details. This field will be populated when the TargetingType is `TARGETING_TYPE_LANGUAGE`. + */ + languageDetails?: Schema$LanguageAssignedTargetingOptionDetails; + /** + * Output only. The resource name for this assigned targeting option. */ name?: string | null; /** - * 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`. + * Keyword details. This field will be populated when the TargetingType is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a line item. */ - response?: {[key: string]: any} | null; + negativeKeywordListDetails?: Schema$NegativeKeywordListAssignedTargetingOptionDetails; + /** + * On screen position details. This field will be populated when the TargetingType is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + onScreenPositionDetails?: Schema$OnScreenPositionAssignedTargetingOptionDetails; + /** + * Operating system details. This field will be populated when the TargetingType is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + operatingSystemDetails?: Schema$OperatingSystemAssignedTargetingOptionDetails; + /** + * Parental status details. This field will be populated when the TargetingType is `TARGETING_TYPE_PARENTAL_STATUS`. + */ + parentalStatusDetails?: Schema$ParentalStatusAssignedTargetingOptionDetails; + /** + * Proximity location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + */ + proximityLocationListDetails?: Schema$ProximityLocationListAssignedTargetingOptionDetails; + /** + * Regional location list details. This field will be populated when the TargetingType is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + */ + regionalLocationListDetails?: Schema$RegionalLocationListAssignedTargetingOptionDetails; + /** + * Sensitive category details. This field will be populated when the TargetingType is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in line item settings). Line item settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them. + */ + sensitiveCategoryExclusionDetails?: Schema$SensitiveCategoryAssignedTargetingOptionDetails; + /** + * Sub-exchange details. This field will be populated when the TargetingType is `TARGETING_TYPE_SUB_EXCHANGE`. + */ + subExchangeDetails?: Schema$SubExchangeAssignedTargetingOptionDetails; + /** + * Output only. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + /** + * Third party verification details. This field will be populated when the TargetingType is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + */ + thirdPartyVerifierDetails?: Schema$ThirdPartyVerifierAssignedTargetingOptionDetails; + /** + * URL details. This field will be populated when the TargetingType is `TARGETING_TYPE_URL`. + */ + urlDetails?: Schema$UrlAssignedTargetingOptionDetails; + /** + * User rewarded content details. This field will be populated when the TargetingType is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + userRewardedContentDetails?: Schema$UserRewardedContentAssignedTargetingOptionDetails; + /** + * Video player size details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + */ + videoPlayerSizeDetails?: Schema$VideoPlayerSizeAssignedTargetingOptionDetails; + /** + * Viewability details. This field will be populated when the TargetingType is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per line item. + */ + viewabilityDetails?: Schema$ViewabilityAssignedTargetingOptionDetails; } /** - * A filtering option that filters on selected file types belonging to a chosen set of filter entities. + * Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is UNION'ed with other groups. */ - export interface Schema$ParentEntityFilter { + export interface Schema$AudienceGroupAssignedTargetingOptionDetails { /** - * Required. File types that will be returned. + * The first and third party audience ids and recencies of the excluded first and third party audience group. Used for negative targeting. Its COMPLEMENT is used to UNION other audience groups. */ - fileType?: string[] | null; + excludedFirstAndThirdPartyAudienceGroup?: Schema$FirstAndThirdPartyAudienceGroup; /** - * The IDs of the specified filter type. This is used to filter entities to fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified. + * The Google audience ids of the excluded Google audience group. Used for negative targeting. It's COMPLEMENT is used to UNION other audience groups. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other. */ - filterIds?: string[] | null; + excludedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; /** - * Required. Filter type used to filter fetched entities. + * The combined audience ids of the included combined audience group. Contains combined audience ids only. */ - filterType?: string | null; + includedCombinedAudienceGroup?: Schema$CombinedAudienceGroup; + /** + * The custom list ids of the included custom list group. Contains custom list ids only. + */ + includedCustomListGroup?: Schema$CustomListGroup; + /** + * The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + */ + includedFirstAndThirdPartyAudienceGroups?: Schema$FirstAndThirdPartyAudienceGroup[]; + /** + * The Google audience ids of the included Google audience group. Contains Google audience ids only. + */ + includedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; } /** - * Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * The length an audio or a video has been played. */ - export interface Schema$SdfDownloadTask { + export interface Schema$AudioVideoOffset { /** - * A resource name to be used in media.download to Download the prepared files. Resource names have the format `download/sdfdownloadtasks/media/{media_id}`. `media_id` will be made available by the long running operation service once the task status is done. + * The offset in percentage of the audio or video duration. */ - resourceName?: string | null; + percentage?: string | null; + /** + * The offset in seconds from the start of the audio or video. + */ + seconds?: string | null; } /** - * Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + * Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. */ - export interface Schema$SdfDownloadTaskMetadata { + export interface Schema$AuthorizedSellerStatusAssignedTargetingOptionDetails { /** - * The time when the operation was created. + * Output only. The authorized seller status to target. */ - createTime?: string | null; + authorizedSellerStatus?: string | null; /** - * The time when execution was completed. + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. */ - endTime?: string | null; + targetingOptionId?: string | null; + } + /** + * Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + */ + export interface Schema$AuthorizedSellerStatusTargetingOptionDetails { /** - * The SDF version used to execute this download task. + * Output only. The authorized seller status. */ - version?: string | null; + authorizedSellerStatus?: string | null; } /** - * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * Settings that control the bid strategy. Bid strategy determines the bid price. */ - export interface Schema$Status { + export interface Schema$BiddingStrategy { /** - * The status code, which should be an enum value of google.rpc.Code. + * A strategy that uses a fixed bid price. */ - code?: number | null; + fixedBid?: Schema$FixedBidStrategy; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. + */ + maximizeSpendAutoBid?: Schema$MaximizeSpendBidStrategy; + /** + * A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity. + */ + performanceGoalAutoBid?: Schema$PerformanceGoalBidStrategy; + } + /** + * Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. + */ + export interface Schema$BrowserAssignedTargetingOptionDetails { + /** + * Output only. The display name of the browser. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. All assigned browser targeting options on the same line item must have the same value for this field. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. + */ + export interface Schema$BrowserTargetingOptionDetails { + /** + * Output only. The display name of the browser. + */ + displayName?: string | null; + } + /** + * Request message for BulkEditLineItemAssignedTargetingOptions. + */ + export interface Schema$BulkEditLineItemAssignedTargetingOptionsRequest { + /** + * The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. + */ + createRequests?: Schema$CreateAssignedTargetingOptionsRequest[]; + /** + * The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. + */ + deleteRequests?: Schema$DeleteAssignedTargetingOptionsRequest[]; + } + export interface Schema$BulkEditLineItemAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options that have been successfully created. + */ + createdAssignedTargetingOptions?: Schema$AssignedTargetingOption[]; + } + export interface Schema$BulkListLineItemAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. + */ + nextPageToken?: string | null; + } + /** + * A single campaign. + */ + export interface Schema$Campaign { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string | null; + /** + * Required. The planned spend and duration of the campaign. + */ + campaignFlight?: Schema$CampaignFlight; + /** + * Required. The goal of the campaign. + */ + campaignGoal?: Schema$CampaignGoal; + /** + * Output only. The unique ID of the campaign. Assigned by the system. + */ + campaignId?: string | null; + /** + * Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. * For CreateCampaign method, `ENTITY_STATUS_ARCHIVED` is not allowed. + */ + entityStatus?: string | null; + /** + * Required. The frequency cap setting of the campaign. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Output only. The resource name of the campaign. + */ + name?: string | null; + /** + * Output only. The timestamp when the campaign was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Settings that track the planned spend and duration of a campaign. + */ + export interface Schema$CampaignFlight { + /** + * Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone. * The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning. * `start_date` is required and must be the current date or later. * `end_date` is optional. If specified, it must be the `start_date` or later. * Any specified date must be before the year 2037. + */ + plannedDates?: Schema$DateRange; + /** + * The amount the campaign is expected to spend for its given planned_dates. This will not limit serving, but will be used for tracking spend in the DV360 UI. The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency. + */ + plannedSpendAmountMicros?: string | null; + } + /** + * Settings that control the goal of a campaign. + */ + export interface Schema$CampaignGoal { + /** + * Required. The type of the campaign goal. + */ + campaignGoalType?: string | null; + /** + * Required. The performance goal of the campaign. Acceptable values for performance_goal_type are: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_OTHER` + */ + performanceGoal?: Schema$PerformanceGoal; + } + /** + * Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + export interface Schema$CarrierAndIspAssignedTargetingOptionDetails { + /** + * Output only. The display name of the carrier or ISP. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same line item must have the same value for this field. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable carrier or ISP. This will be populated in the carrier_and_isp_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + export interface Schema$CarrierAndIspTargetingOptionDetails { + /** + * Output only. The display name of the carrier or ISP. + */ + displayName?: string | null; + /** + * Output only. The type indicating if it's carrier or ISP. + */ + type?: string | null; + } + /** + * Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + export interface Schema$CategoryAssignedTargetingOptionDetails { + /** + * Output only. The display name of the category. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + export interface Schema$CategoryTargetingOptionDetails { + /** + * Output only. The display name of the category. + */ + displayName?: string | null; + } + /** + * A single channel. Channels are custom groups of related websites and apps. + */ + export interface Schema$Channel { + /** + * The ID of the advertiser that owns the channel. + */ + advertiserId?: string | null; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string | null; + /** + * Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The resource name of the channel. + */ + name?: string | null; + /** + * The ID of the partner that owns the channel. + */ + partnerId?: string | null; + } + /** + * Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. + */ + export interface Schema$ChannelAssignedTargetingOptionDetails { + /** + * Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource. + */ + channelId?: string | null; + /** + * Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. + */ + negative?: boolean | null; + } + /** + * Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers. + */ + export interface Schema$CmHybridConfig { + /** + * Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser. + */ + cmAccountId?: string | null; + /** + * Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser. + */ + cmFloodlightConfigId?: string | null; + /** + * Required. Immutable. By setting this field to `true`, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser. + */ + cmFloodlightLinkingAuthorized?: boolean | null; + /** + * A list of CM sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM site. Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified. + */ + cmSyncableSiteIds?: string[] | null; + /** + * Whether or not to report DV360 cost to CM. + */ + dv360ToCmCostReportingEnabled?: boolean | null; + /** + * Whether or not to include DV360 data in CM data transfer reports. + */ + dv360ToCmDataSharingEnabled?: boolean | null; + } + /** + * A Campaign Manager tracking ad. + */ + export interface Schema$CmTrackingAd { + /** + * The ad ID of the campaign manager tracking Ad. + */ + cmAdId?: string | null; + /** + * The creative ID of the campaign manager tracking Ad. + */ + cmCreativeId?: string | null; + /** + * The placement ID of the campaign manager tracking Ad. + */ + cmPlacementId?: string | null; + } + /** + * Describes a combined audience resource. + */ + export interface Schema$CombinedAudience { + /** + * Output only. The unique ID of the combined audience. Assigned by the system. + */ + combinedAudienceId?: string | null; + /** + * Output only. The display name of the combined audience. . + */ + displayName?: string | null; + /** + * Output only. The resource name of the combined audience. + */ + name?: string | null; + } + /** + * Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$CombinedAudienceGroup { + /** + * Required. All combined audience targeting settings in combined audience group. Repeated settings with same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise. + */ + settings?: Schema$CombinedAudienceTargetingSetting[]; + } + /** + * Details of combined audience targeting setting. + */ + export interface Schema$CombinedAudienceTargetingSetting { + /** + * Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. + */ + combinedAudienceId?: string | null; + } + /** + * Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + export interface Schema$ContentInstreamPositionAssignedTargetingOptionDetails { + /** + * Output only. The content instream position for video or audio ads. + */ + contentInstreamPosition?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + export interface Schema$ContentInstreamPositionTargetingOptionDetails { + /** + * Output only. The content instream position. + */ + contentInstreamPosition?: string | null; + } + /** + * Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + export interface Schema$ContentOutstreamPositionAssignedTargetingOptionDetails { + /** + * Output only. The content outstream position. + */ + contentOutstreamPosition?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + export interface Schema$ContentOutstreamPositionTargetingOptionDetails { + /** + * Output only. The content outstream position. + */ + contentOutstreamPosition?: string | null; + } + /** + * Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. + */ + export interface Schema$ConversionCountingConfig { + /** + * The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. + */ + floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; + /** + * The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. + */ + postViewCountPercentageMillis?: string | null; + } + /** + * Counter event of the creative. + */ + export interface Schema$CounterEvent { + /** + * Required. The name of the counter event. + */ + name?: string | null; + /** + * Required. The name used to identify this counter event in reports. + */ + reportingName?: string | null; + } + /** + * A request message for CreateAsset. + */ + export interface Schema$CreateAssetRequest { + /** + * Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. + */ + filename?: string | null; + } + /** + * A response message for CreateAsset. + */ + export interface Schema$CreateAssetResponse { + /** + * The uploaded asset, if successful. + */ + asset?: Schema$Asset; + } + /** + * A request listing which assigned targeting options of a given targeting type should be created and added. + */ + export interface Schema$CreateAssignedTargetingOptionsRequest { + /** + * Required. The assigned targeting options to create and add. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + } + /** + * Request message for [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$CreateSdfDownloadTaskRequest { + /** + * The ID of the advertiser to download SDF for. + */ + advertiserId?: string | null; + /** + * Filters on entities by their entity IDs. + */ + idFilter?: Schema$IdFilter; + /** + * Filters on Inventory Sources by their IDs. + */ + inventorySourceFilter?: Schema$InventorySourceFilter; + /** + * Filters on selected file types. The entities in each file are filtered by a chosen set of filter entities. The filter entities must be the same type as, or a parent type of, the selected file types. + */ + parentEntityFilter?: Schema$ParentEntityFilter; + /** + * The ID of the partner to download SDF for. + */ + partnerId?: string | null; + /** + * Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise. + */ + version?: string | null; + } + /** + * A single Creative. + */ + export interface Schema$Creative { + /** + * Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + */ + additionalDimensions?: Schema$Dimensions[]; + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string | null; + /** + * Third-party HTML tracking tag to be appended to the creative tag. + */ + appendedTag?: string | null; + /** + * Required. Assets associated to this creative. Assets can be associated to the creative in one of following roles: * `ASSET_ROLE_UNSPECIFIED` * `ASSET_ROLE_MAIN` * `ASSET_ROLE_BACKUP` * `ASSET_ROLE_POLITE_LOAD` + */ + assets?: Schema$AssetAssociation[]; + /** + * Output only. The unique ID of the Campaign Manager placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager. + */ + cmPlacementId?: string | null; + /** + * The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases. + */ + cmTrackingAd?: Schema$CmTrackingAd; + /** + * The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + */ + companionCreativeIds?: string[] | null; + /** + * Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + */ + counterEvents?: Schema$CounterEvent[]; + /** + * Output only. The timestamp when the creative was created. Assigned by the system. + */ + createTime?: string | null; + /** + * Output only. A list of attributes of the creative that is generated by the system. + */ + creativeAttributes?: string[] | null; + /** + * Output only. The unique ID of the creative. Assigned by the system. + */ + creativeId?: string | null; + /** + * Required. Immutable. The type of the creative. + */ + creativeType?: string | null; + /** + * Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` + */ + dimensions?: Schema$Dimensions; + /** + * Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. Indicates whether the creative is dynamic. + */ + dynamic?: boolean | null; + /** + * Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` + */ + entityStatus?: string | null; + /** + * Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats. + */ + exitEvents?: Schema$ExitEvent[]; + /** + * Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` + */ + expandingDirection?: string | null; + /** + * Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE` + */ + expandOnHover?: boolean | null; + /** + * Required. Indicates where the creative is hosted. + */ + hostingSource?: string | null; + /** + * Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + html5Video?: boolean | null; + /** + * Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID. + */ + iasCampaignMonitoring?: boolean | null; + /** + * ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters. + */ + integrationCode?: string | null; + /** + * JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + jsTrackerUrl?: string | null; + /** + * Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED` + */ + mediaDuration?: string | null; + /** + * Output only. The resource name of the creative. + */ + name?: string | null; + /** + * User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + */ + notes?: string | null; + /** + * Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + obaIcon?: Schema$ObaIcon; + /** + * Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + progressOffset?: Schema$AudioVideoOffset; + /** + * Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` + */ + requireHtml5?: boolean | null; + /** + * Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` + */ + requireMraid?: boolean | null; + /** + * Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + requirePingForAttribution?: boolean | null; + /** + * Output only. The current status of the creative review process. + */ + reviewStatus?: Schema$ReviewStatusInfo; + /** + * Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + skipOffset?: Schema$AudioVideoOffset; + /** + * Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + skippable?: boolean | null; + /** + * Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` + */ + thirdPartyTag?: string | null; + /** + * Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + thirdPartyUrls?: Schema$ThirdPartyUrl[]; + /** + * Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + */ + timerEvents?: Schema$TimerEvent[]; + /** + * Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + trackerUrls?: string[] | null; + /** + * Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + */ + transcodes?: Schema$Transcode[]; + /** + * Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + universalAdId?: Schema$UniversalAdId; + /** + * Output only. The timestamp when the creative was last updated. Assigned by the system. + */ + updateTime?: string | null; + /** + * Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + vastTagUrl?: string | null; + /** + * Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + vpaid?: boolean | null; + } + /** + * Creative requirements configuration for the inventory source. + */ + export interface Schema$CreativeConfig { + /** + * The type of creative that can be assigned to the inventory source. + */ + creativeType?: string | null; + /** + * The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`. + */ + displayCreativeConfig?: Schema$InventorySourceDisplayCreativeConfig; + /** + * The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`. + */ + videoCreativeConfig?: Schema$InventorySourceVideoCreativeConfig; + } + /** + * Describes a custom list entity, such as a custom affinity or custom intent audience list. + */ + export interface Schema$CustomList { + /** + * Output only. The unique ID of the custom list. Assigned by the system. + */ + customListId?: string | null; + /** + * Output only. The display name of the custom list. . + */ + displayName?: string | null; + /** + * Output only. The resource name of the custom list. + */ + name?: string | null; + } + /** + * Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$CustomListGroup { + /** + * Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + */ + settings?: Schema$CustomListTargetingSetting[]; + } + /** + * Details of custom list targeting setting. + */ + export interface Schema$CustomListTargetingSetting { + /** + * Required. Custom id of custom list targeting setting. This id is custom_list_id. + */ + customListId?: string | null; + } + /** + * 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 | null; + /** + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. + */ + month?: number | null; + /** + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + */ + year?: number | null; + } + /** + * A date range. + */ + export interface Schema$DateRange { + /** + * The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. + */ + endDate?: Schema$Date; + /** + * The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. + */ + startDate?: Schema$Date; + } + /** + * Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. + */ + export interface Schema$DayAndTimeAssignedTargetingOptionDetails { + /** + * Required. The day of the week for this day and time targeting setting. + */ + dayOfWeek?: string | null; + /** + * Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). + */ + endHour?: number | null; + /** + * Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). + */ + startHour?: number | null; + /** + * Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + */ + timeZoneResolution?: string | null; + } + /** + * A request listing which assigned targeting options of a given targeting type should be deleted. + */ + export interface Schema$DeleteAssignedTargetingOptionsRequest { + /** + * Required. The assigned targeting option IDs to delete. + */ + assignedTargetingOptionIds?: string[] | null; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + } + /** + * Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + export interface Schema$DeviceMakeModelAssignedTargetingOptionDetails { + /** + * Output only. The display name of the device make and model. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + export interface Schema$DeviceMakeModelTargetingOptionDetails { + /** + * Output only. The display name of the device make and model. + */ + displayName?: string | null; + } + /** + * Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. + */ + export interface Schema$DeviceTypeAssignedTargetingOptionDetails { + /** + * Output only. The display name of the device type. + */ + deviceType?: string | null; + /** + * Required. ID of the device type. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable device type. This will be populated in the device_type_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. + */ + export interface Schema$DeviceTypeTargetingOptionDetails { + /** + * Output only. The device type that is used to be targeted. + */ + deviceType?: string | null; + } + /** + * Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + */ + export interface Schema$DigitalContentLabelAssignedTargetingOptionDetails { + /** + * Output only. The display name of the digital content label rating tier. + */ + contentRatingTier?: string | null; + /** + * Required. ID of the digital content label to be EXCLUDED. + */ + excludedTargetingOptionId?: string | null; + } + /** + * Represents a targetable digital content label rating tier. This will be populated in the digital_content_label_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. + */ + export interface Schema$DigitalContentLabelTargetingOptionDetails { + /** + * Output only. An enum for the content label brand safety tiers. Values from content-labels.txt. Must be kept in sync with //contentads/bidder/proto/video_ratings.proto + */ + contentRatingTier?: string | null; + } + /** + * Dimensions. + */ + export interface Schema$Dimensions { + /** + * The height in pixels. + */ + heightPixels?: number | null; + /** + * The width in pixels. + */ + widthPixels?: number | null; + } + /** + * Details of DoubleVerify settings. + */ + export interface Schema$DoubleVerify { + /** + * Avoid bidding on apps with the star ratings. + */ + appStarRating?: Schema$DoubleVerifyAppStarRating; + /** + * Avoid bidding on apps with the age rating. + */ + avoidedAgeRatings?: string[] | null; + /** + * DV Brand Safety Controls. + */ + brandSafetyCategories?: Schema$DoubleVerifyBrandSafetyCategories; + /** + * Display viewability settings (applicable to display line items only). + */ + displayViewability?: Schema$DoubleVerifyDisplayViewability; + /** + * Avoid Sites and Apps with historical Fraud & IVT Rates. + */ + fraudInvalidTraffic?: Schema$DoubleVerifyFraudInvalidTraffic; + /** + * Video viewability settings (applicable to video line items only). + */ + videoViewability?: Schema$DoubleVerifyVideoViewability; + } + /** + * Details of DoubleVerify star ratings settings. + */ + export interface Schema$DoubleVerifyAppStarRating { + /** + * Avoid bidding on apps with the star ratings. + */ + avoidedStarRating?: string | null; + /** + * Avoid bidding on apps with insufficient star ratings. + */ + avoidInsufficientStarRating?: boolean | null; + } + /** + * Settings for brand safety controls. + */ + export interface Schema$DoubleVerifyBrandSafetyCategories { + /** + * Brand safety high severity avoidance categories. + */ + avoidedHighSeverityCategories?: string[] | null; + /** + * Brand safety medium severity avoidance categories. + */ + avoidedMediumSeverityCategories?: string[] | null; + /** + * Unknown or unrateable. + */ + avoidUnknownBrandSafetyCategory?: boolean | null; + } + /** + * Details of DoubleVerify display viewability settings. + */ + export interface Schema$DoubleVerifyDisplayViewability { + /** + * Target web and app inventory to maximize IAB viewable rate. + */ + iab?: string | null; + /** + * Target web and app inventory to maximize 100% viewable duration. + */ + viewableDuring?: string | null; + } + /** + * DoubleVerify Fraud & Invalid Traffic settings. + */ + export interface Schema$DoubleVerifyFraudInvalidTraffic { + /** + * Avoid Sites and Apps with historical Fraud & IVT. + */ + avoidedFraudOption?: string | null; + /** + * Insufficient Historical Fraud & IVT Stats. + */ + avoidInsufficientOption?: boolean | null; + } + /** + * Details of DoubleVerify video viewability settings. + */ + export interface Schema$DoubleVerifyVideoViewability { + /** + * Target inventory to maximize impressions with 400x300 or greater player size. + */ + playerImpressionRate?: string | null; + /** + * Target web inventory to maximize IAB viewable rate. + */ + videoIab?: string | null; + /** + * Target web inventory to maximize fully viewable rate. + */ + videoViewableRate?: string | null; + } + /** + * 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 {} + /** + * Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + export interface Schema$EnvironmentAssignedTargetingOptionDetails { + /** + * Output only. The serving environment. + */ + environment?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_ENVIRONMENT` (e.g., "508010" for targeting the `ENVIRONMENT_WEB_OPTIMIZED` option). + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + export interface Schema$EnvironmentTargetingOptionDetails { + /** + * Output only. The serving environment. + */ + environment?: string | null; + } + /** + * Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. + */ + export interface Schema$ExchangeAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_EXCHANGE`. + */ + targetingOptionId?: string | null; + } + /** + * Exchange review status for the creative. + */ + export interface Schema$ExchangeReviewStatus { + /** + * The exchange reviewing the creative. + */ + exchange?: string | null; + /** + * Status of the exchange review. + */ + status?: string | null; + } + /** + * Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TAREGTING_TYPE_EXCHANGE`. + */ + export interface Schema$ExchangeTargetingOptionDetails { + /** + * Output only. The type of exchange. + */ + exchange?: string | null; + } + /** + * Exit event of the creative. + */ + export interface Schema$ExitEvent { + /** + * The name of the click tag of the exit event. The name must be unique within one creative. Leave it empty or unset for creatives containing image assets only. + */ + name?: string | null; + /** + * The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + */ + reportingName?: string | null; + /** + * Required. The type of the exit event. + */ + type?: string | null; + /** + * Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` + */ + url?: string | null; + } + /** + * Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers. + */ + export interface Schema$FirstAndThirdPartyAudience { + /** + * Output only. The display name of the first and third party audience. . + */ + displayName?: string | null; + /** + * Output only. The unique ID of the first and third party audience. Assigned by the system. + */ + firstAndThirdPartyAudienceId?: string | null; + /** + * Output only. Whether the audience is a first or third party audience. . + */ + firstAndThirdPartyAudienceType?: string | null; + /** + * Output only. The resource name of the first and third party audience. + */ + name?: string | null; + } + /** + * Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$FirstAndThirdPartyAudienceGroup { + /** + * Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + */ + settings?: Schema$FirstAndThirdPartyAudienceTargetingSetting[]; + } + /** + * Details of first and third party audience targeting setting. + */ + export interface Schema$FirstAndThirdPartyAudienceTargetingSetting { + /** + * Required. First and third party audience id of the first and third party audience targeting setting. This id is first_and_third_party_audience_id. + */ + firstAndThirdPartyAudienceId?: string | null; + /** + * The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + */ + recency?: string | null; + } + /** + * A strategy that uses a fixed bidding price. + */ + export interface Schema$FixedBidStrategy { + /** + * The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. + */ + bidAmountMicros?: string | null; + } + /** + * A single Floodlight group. + */ + export interface Schema$FloodlightGroup { + /** + * The Active View video viewability metric configuration for the Floodlight group. + */ + activeViewConfig?: Schema$ActiveViewVideoViewabilityMetricConfig; + /** + * User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`. + */ + customVariables?: {[key: string]: any} | null; + /** + * Required. The display name of the Floodlight group. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the Floodlight group. Assigned by the system. + */ + floodlightGroupId?: string | null; + /** + * Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive. + */ + lookbackWindow?: Schema$LookbackWindow; + /** + * Output only. The resource name of the Floodlight group. + */ + name?: string | null; + /** + * Required. The web tag type enabled for the Floodlight group. + */ + webTagType?: string | null; + } + /** + * Settings that control the number of times a user may be shown with the same ad during a given time period. + */ + export interface Schema$FrequencyCap { + /** + * The maximum number of times a user may be shown with the same ad during this period. Must be greater than 0. Applicable when unlimited is `false`. + */ + maxImpressions?: number | null; + /** + * The time unit in which the frequency cap will be applied. Applicable when unlimited is `false`. + */ + timeUnit?: string | null; + /** + * The number of time_unit the frequency cap will last. Applicable when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_LIFETIME` - this field is output only and will default to 1 * `TIME_UNIT_MONTHS` - must be between 1 and 2 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 + */ + timeUnitCount?: number | null; + /** + * Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. + */ + unlimited?: boolean | null; + } + /** + * Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_GENDER`. + */ + export interface Schema$GenderAssignedTargetingOptionDetails { + /** + * Output only. The gender of the audience. + */ + gender?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GENDER`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. + */ + export interface Schema$GenderTargetingOptionDetails { + /** + * Output only. The gender of an audience. + */ + gender?: string | null; + } + /** + * Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + export interface Schema$GeoRegionAssignedTargetingOptionDetails { + /** + * Output only. The display name of the geographic region (e.g., "Ontario, Canada"). + */ + displayName?: string | null; + /** + * Output only. The type of geographic region targeting. + */ + geoRegionType?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + export interface Schema$GeoRegionTargetingOptionDetails { + /** + * Output only. The display name of the geographic region (e.g., "Ontario, Canada"). + */ + displayName?: string | null; + /** + * Output only. The type of geographic region targeting. + */ + geoRegionType?: string | null; + } + /** + * Describes a Google audience resource. Includes Google audience lists. + */ + export interface Schema$GoogleAudience { + /** + * Output only. The display name of the Google audience. . + */ + displayName?: string | null; + /** + * Output only. The unique ID of the Google audience. Assigned by the system. + */ + googleAudienceId?: string | null; + /** + * Output only. The type of Google audience. . + */ + googleAudienceType?: string | null; + /** + * Output only. The resource name of the google audience. + */ + name?: string | null; + } + /** + * Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$GoogleAudienceGroup { + /** + * Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + */ + settings?: Schema$GoogleAudienceTargetingSetting[]; + } + /** + * Details of Google audience targeting setting. + */ + export interface Schema$GoogleAudienceTargetingSetting { + /** + * Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. + */ + googleAudienceId?: string | null; + } + /** + * Media resource. + */ + export interface Schema$GoogleBytestreamMedia { + /** + * Name of the media resource. + */ + resourceName?: string | null; + } + /** + * Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + export interface Schema$HouseholdIncomeAssignedTargetingOptionDetails { + /** + * Output only. The household income of the audience. + */ + householdIncome?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + export interface Schema$HouseholdIncomeTargetingOptionDetails { + /** + * Output only. The household income of an audience. + */ + householdIncome?: string | null; + } + /** + * A filtering option that filters entities by their entity IDs. + */ + export interface Schema$IdFilter { + /** + * TrueView Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + adGroupAdIds?: string[] | null; + /** + * TrueView Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + adGroupIds?: string[] | null; + /** + * Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + campaignIds?: string[] | null; + /** + * Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + insertionOrderIds?: string[] | null; + /** + * Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + lineItemIds?: string[] | null; + /** + * Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + mediaProductIds?: string[] | null; + } + /** + * A single insertion order. + */ + export interface Schema$InsertionOrder { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string | null; + /** + * Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * Required. The budget allocation settings of the insertion order. + */ + budget?: Schema$InsertionOrderBudget; + /** + * Required. Immutable. The unique ID of the campaign that the insertion order belongs to. + */ + campaignId?: string | null; + /** + * Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. + */ + entityStatus?: string | null; + /** + * Required. The frequency capping setting of the insertion order. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string | null; + /** + * Additional integration details of the insertion order. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Output only. The resource name of the insertion order. + */ + name?: string | null; + /** + * Required. The budget spending speed setting of the insertion order. + */ + pacing?: Schema$Pacing; + /** + * The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + */ + partnerCosts?: Schema$PartnerCost[]; + /** + * Required. Performance goal of the insertion order. + */ + performanceGoal?: Schema$PerformanceGoal; + /** + * Output only. The timestamp when the insertion order was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Settings that control how insertion order budget is allocated. + */ + export interface Schema$InsertionOrderBudget { + /** + * The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + */ + automationType?: string | null; + /** + * Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. + */ + budgetSegments?: Schema$InsertionOrderBudgetSegment[]; + /** + * Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. + */ + budgetUnit?: string | null; + } + /** + * Settings that control the budget of a single budget segment. + */ + export interface Schema$InsertionOrderBudgetSegment { + /** + * Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + */ + budgetAmountMicros?: string | null; + /** + * Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. + */ + dateRange?: Schema$DateRange; + /** + * The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded with a length of no more than 80 characters. + */ + description?: string | null; + } + /** + * Details of Integral Ad Science settings. + */ + export interface Schema$IntegralAdScience { + /** + * Display Viewability section (applicable to display line items only). + */ + displayViewability?: string | null; + /** + * Ad Fraud settings. + */ + excludedAdFraudRisk?: string | null; + /** + * Brand Safety - **Adult content**. + */ + excludedAdultRisk?: string | null; + /** + * Brand Safety - **Alcohol**. + */ + excludedAlcoholRisk?: string | null; + /** + * Brand Safety - **Drugs**. + */ + excludedDrugsRisk?: string | null; + /** + * Brand Safety - **Gambling**. + */ + excludedGamblingRisk?: string | null; + /** + * Brand Safety - **Hate speech**. + */ + excludedHateSpeechRisk?: string | null; + /** + * Brand Safety - **Illegal downloads**. + */ + excludedIllegalDownloadsRisk?: string | null; + /** + * Brand Safety - **Offensive language**. + */ + excludedOffensiveLanguageRisk?: string | null; + /** + * Brand Safety - **Violence**. + */ + excludedViolenceRisk?: string | null; + /** + * Brand Safety - **Unrateable**. + */ + excludeUnrateable?: boolean | null; + /** + * True advertising quality (applicable to Display line items only). + */ + traqScoreOption?: string | null; + /** + * Video Viewability Section (applicable to video line items only). + */ + videoViewability?: string | null; + } + /** + * Integration details of an entry. + */ + export interface Schema$IntegrationDetails { + /** + * Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. + */ + details?: string | null; + /** + * An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. + */ + integrationCode?: string | null; + } + /** + * An inventory source. + */ + export interface Schema$InventorySource { + /** + * Whether the inventory source has a guaranteed or non-guaranteed delivery. + */ + commitment?: string | null; + /** + * The creative requirements of the inventory source. Not applicable for auction packages. + */ + creativeConfigs?: Schema$CreativeConfig[]; + /** + * The ID in the exchange space that uniquely identifies the inventory source. Must be unique across buyers within each exchange but not necessarily unique across exchanges. + */ + dealId?: string | null; + /** + * The delivery method of the inventory source. * For non-guaranteed inventory sources, the only acceptable value is `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. * For guaranteed inventory sources, acceptable values are `INVENTORY_SOURCE_DELIVERY_METHOD_TAG` and `INVENTORY_SOURCE_DELIVERY_METHOD_PROGRAMMATIC`. + */ + deliveryMethod?: string | null; + /** + * The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * The exchange to which the inventory source belongs. + */ + exchange?: string | null; + /** + * Output only. The unique ID of the inventory source. Assigned by the system. + */ + inventorySourceId?: string | null; + /** + * Denotes the type of the inventory source. + */ + inventorySourceType?: string | null; + /** + * Output only. The resource name of the inventory source. + */ + name?: string | null; + /** + * The publisher/seller name of the inventory source. + */ + publisherName?: string | null; + /** + * Required. The rate details of the inventory source. + */ + rateDetails?: Schema$RateDetails; + /** + * The status settings of the inventory source. + */ + status?: Schema$InventorySourceStatus; + /** + * The time range when this inventory source starts and stops serving. + */ + timeRange?: Schema$TimeRange; + /** + * Output only. The timestamp when the inventory source was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. + */ + export interface Schema$InventorySourceAssignedTargetingOptionDetails { + /** + * Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. + */ + inventorySourceId?: string | null; + } + /** + * The configuration for display creatives. + */ + export interface Schema$InventorySourceDisplayCreativeConfig { + /** + * The size requirements for display creatives that can be assigned to the inventory source. + */ + creativeSize?: Schema$Dimensions; + } + /** + * A filtering option for filtering on Inventory Source entities. + */ + export interface Schema$InventorySourceFilter { + /** + * Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner. + */ + inventorySourceIds?: string[] | null; + } + /** + * A collection of targetable inventory sources. + */ + export interface Schema$InventorySourceGroup { + /** + * Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the inventory source group. Assigned by the system. + */ + inventorySourceGroupId?: string | null; + /** + * Output only. The resource name of the inventory source group. + */ + name?: string | null; + } + /** + * Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + */ + export interface Schema$InventorySourceGroupAssignedTargetingOptionDetails { + /** + * Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. + */ + inventorySourceGroupId?: string | null; + } + /** + * The status related settings of the inventory source. + */ + export interface Schema$InventorySourceStatus { + /** + * Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. + */ + configStatus?: string | null; + /** + * The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`. + */ + entityPauseReason?: string | null; + /** + * Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`. + */ + entityStatus?: string | null; + /** + * Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`. + */ + sellerPauseReason?: string | null; + /** + * Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`. + */ + sellerStatus?: string | null; + } + /** + * The configuration for video creatives. + */ + export interface Schema$InventorySourceVideoCreativeConfig { + /** + * The duration requirements for the video creatives that can be assigned to the inventory source. + */ + duration?: string | null; + } + /** + * Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. + */ + export interface Schema$KeywordAssignedTargetingOptionDetails { + /** + * Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. + */ + keyword?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + export interface Schema$LanguageAssignedTargetingOptionDetails { + /** + * Output only. The display name of the language (e.g., "French"). + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. All assigned language targeting options on the same line item must have the same value for this field. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + export interface Schema$LanguageTargetingOptionDetails { + /** + * Output only. The display name of the language (e.g., "French"). + */ + displayName?: string | null; + } + /** + * A single line item. + */ + export interface Schema$LineItem { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string | null; + /** + * Required. The bidding strategy of the line item. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * Required. The budget allocation setting of the line item. + */ + budget?: Schema$LineItemBudget; + /** + * Output only. The unique ID of the campaign that the line item belongs to. + */ + campaignId?: string | null; + /** + * The conversion tracking setting of the line item. + */ + conversionCounting?: Schema$ConversionCountingConfig; + /** + * The IDs of the creatives associated with the line item. + */ + creativeIds?: string[] | null; + /** + * Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. + */ + entityStatus?: string | null; + /** + * Required. The start and end time of the line item's flight. + */ + flight?: Schema$LineItemFlight; + /** + * Required. The frequency capping setting of the line item. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Required. Immutable. The unique ID of the insertion order that the line item belongs to. + */ + insertionOrderId?: string | null; + /** + * Integration details of the line item. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * The IDs of the private inventory sources assigned to the line item. + */ + inventorySourceIds?: string[] | null; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string | null; + /** + * Required. Immutable. The type of the line item. + */ + lineItemType?: string | null; + /** + * Output only. The resource name of the line item. + */ + name?: string | null; + /** + * Required. The budget spending speed setting of the line item. + */ + pacing?: Schema$Pacing; + /** + * The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order. + */ + partnerCosts?: Schema$PartnerCost[]; + /** + * Required. The partner revenue model setting of the line item. + */ + partnerRevenueModel?: Schema$PartnerRevenueModel; + /** + * Output only. The timestamp when the line item was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Settings that control how budget is allocated. + */ + export interface Schema$LineItemBudget { + /** + * Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order. + */ + budgetAllocationType?: string | null; + /** + * Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. + */ + budgetUnit?: string | null; + /** + * The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system. + */ + maxAmount?: string | null; + } + /** + * Settings that control the active duration of a line item. + */ + export interface Schema$LineItemFlight { + /** + * The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. + */ + dateRange?: Schema$DateRange; + /** + * Required. The type of the line item's flight dates. + */ + flightDateType?: string | null; + } + export interface Schema$ListAdvertisersResponse { + /** + * The list of advertisers. + */ + advertisers?: Schema$Advertiser[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCampaignsResponse { + /** + * The list of campaigns. + */ + campaigns?: Schema$Campaign[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCampaigns` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListChannelsResponse { + /** + * The list of channels. + */ + channels?: Schema$Channel[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListChannels` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCombinedAudiencesResponse { + /** + * The list of combined audiences. + */ + combinedAudiences?: Schema$CombinedAudience[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCombinedAudiences` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCreativesResponse { + /** + * The list of creatives. + */ + creatives?: Schema$Creative[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCreativesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomListsResponse { + /** + * The list of custom lists. + */ + customLists?: Schema$CustomList[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomLists` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListFirstAndThirdPartyAudiencesResponse { + /** + * The list of first and third party audiences. + */ + firstAndThirdPartyAudiences?: Schema$FirstAndThirdPartyAudience[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListGoogleAudiencesResponse { + /** + * The list of Google audiences. + */ + googleAudiences?: Schema$GoogleAudience[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListGoogleAudiences` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInsertionOrdersResponse { + /** + * The list of insertion orders. + */ + insertionOrders?: Schema$InsertionOrder[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInsertionOrders` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for InventorySourceGroupService.ListInventorySourceGroups. + */ + export interface Schema$ListInventorySourceGroupsResponse { + /** + * The list of inventory source groups. + */ + inventorySourceGroups?: Schema$InventorySourceGroup[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySourceGroups` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInventorySourcesResponse { + /** + * The list of inventory sources. + */ + inventorySources?: Schema$InventorySource[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInventorySources` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListLineItemAssignedTargetingOptions. + */ + export interface Schema$ListLineItemAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListLineItemAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return. + */ + nextPageToken?: string | null; + } + export interface Schema$ListLineItemsResponse { + /** + * The list of line items. + */ + lineItems?: Schema$LineItem[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLineItems` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + export interface Schema$ListLocationListsResponse { + /** + * The list of location lists. + */ + locationLists?: Schema$LocationList[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListLocationLists` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for NegativeKeywordListService.ListNegativeKeywordLists. + */ + export interface Schema$ListNegativeKeywordListsResponse { + /** + * The list of negative keyword lists. + */ + negativeKeywordLists?: Schema$NegativeKeywordList[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListTargetingOptions. + */ + export interface Schema$ListTargetingOptionsResponse { + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of targeting options. + */ + targetingOptions?: Schema$TargetingOption[]; + } + /** + * A list of locations used for targeting. + */ + export interface Schema$LocationList { + /** + * Required. Immutable. The unique ID of the advertiser the location list belongs to. + */ + advertiserId?: string | null; + /** + * Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the location list. Assigned by the system. + */ + locationListId?: string | null; + /** + * Required. Immutable. The type of location. All locations in the list will share this type. + */ + locationType?: string | null; + /** + * Output only. The resource name of the location list. + */ + name?: string | null; + } + /** + * Specifies how many days into the past to look when determining whether to record a conversion. + */ + export interface Schema$LookbackWindow { + /** + * Lookback window, in days, from the last time a given user clicked on one of your ads. + */ + clickDays?: number | null; + /** + * Lookback window, in days, from the last time a given user viewed one of your ads. + */ + impressionDays?: number | null; + } + /** + * A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. + */ + export interface Schema$MaximizeSpendBidStrategy { + /** + * The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. + */ + maxAverageCpmBidAmountMicros?: string | null; + /** + * Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. + */ + performanceGoalType?: string | null; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The 3-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * 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 | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } + /** + * A list of negative keywords used for targeting. + */ + export interface Schema$NegativeKeywordList { + /** + * Output only. The unique ID of the advertiser the negative keyword list belongs to. + */ + advertiserId?: string | null; + /** + * Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. + */ + displayName?: string | null; + /** + * Output only. The resource name of the negative keyword list. + */ + name?: string | null; + /** + * Output only. The unique ID of the negative keyword list. Assigned by the system. + */ + negativeKeywordListId?: string | null; + } + /** + * Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. + */ + export interface Schema$NegativeKeywordListAssignedTargetingOptionDetails { + /** + * Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. + */ + negativeKeywordListId?: string | null; + } + /** + * OBA Icon for a Creative + */ + export interface Schema$ObaIcon { + /** + * Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + */ + clickTrackingUrl?: string | null; + /** + * The dimensions of the OBA icon. + */ + dimensions?: Schema$Dimensions; + /** + * Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + */ + landingPageUrl?: string | null; + /** + * The position of the OBA icon on the creative. + */ + position?: string | null; + /** + * The program of the OBA icon. For example: “AdChoices”. + */ + program?: string | null; + /** + * The MIME type of the OBA icon resource. + */ + resourceMimeType?: string | null; + /** + * The URL of the OBA icon resource. + */ + resourceUrl?: string | null; + /** + * Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com + */ + viewTrackingUrl?: string | null; + } + /** + * On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + export interface Schema$OnScreenPositionAssignedTargetingOptionDetails { + /** + * Output only. The on screen position. + */ + onScreenPosition?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + export interface Schema$OnScreenPositionTargetingOptionDetails { + /** + * Output only. The on screen position. + */ + onScreenPosition?: string | null; + } + /** + * Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + export interface Schema$OperatingSystemAssignedTargetingOptionDetails { + /** + * Output only. The display name of the operating system. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TAREGTING_TYPE_OPERATING_SYSTEM`. + */ + export interface Schema$OperatingSystemTargetingOptionDetails { + /** + * Output only. The display name of the operating system. + */ + displayName?: string | null; + } + /** + * 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 | null; + /** + * 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} | null; + /** + * 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 be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * 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} | null; + } + /** + * Settings that control the rate at which a budget is spent. + */ + export interface Schema$Pacing { + /** + * Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. + */ + dailyMaxImpressions?: string | null; + /** + * Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. + */ + dailyMaxMicros?: string | null; + /** + * Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via auto_budget_allocation, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. + */ + pacingPeriod?: string | null; + /** + * Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. + */ + pacingType?: string | null; + } + /** + * Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARTGETING_TYPE_PARENTAL_STATUS`. + */ + export interface Schema$ParentalStatusAssignedTargetingOptionDetails { + /** + * Output only. The parental status of the audience. + */ + parentalStatus?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_PARENTAL_STATUS`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. + */ + export interface Schema$ParentalStatusTargetingOptionDetails { + /** + * Output only. The parental status of an audience. + */ + parentalStatus?: string | null; + } + /** + * A filtering option that filters on selected file types belonging to a chosen set of filter entities. + */ + export interface Schema$ParentEntityFilter { + /** + * Required. File types that will be returned. + */ + fileType?: string[] | null; + /** + * The IDs of the specified filter type. This is used to filter entities to fetch. If filter type is not `FILTER_TYPE_NONE`, at least one ID must be specified. + */ + filterIds?: string[] | null; + /** + * Required. Filter type used to filter fetched entities. + */ + filterType?: string | null; + } + /** + * Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service. + */ + export interface Schema$PartnerCost { + /** + * Required. The type of the partner cost. + */ + costType?: string | null; + /** + * The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. + */ + feeAmount?: string | null; + /** + * The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%. + */ + feePercentageMillis?: string | null; + /** + * Required. The fee type for this partner cost. + */ + feeType?: string | null; + /** + * The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types. + */ + invoiceType?: string | null; + } + /** + * Settings that control how partner revenue is calculated. + */ + export interface Schema$PartnerRevenueModel { + /** + * Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). + */ + markupAmount?: string | null; + /** + * Required. The markup type of the partner revenue model. + */ + markupType?: string | null; + } + /** + * Settings that control the performance goal of a campaign or insertion order. + */ + export interface Schema$PerformanceGoal { + /** + * The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` For example 1500000 represents 1.5 standard units of the currency. + */ + performanceGoalAmountMicros?: string | null; + /** + * The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` For example, 70000 represents 7% (decimal 0.07). + */ + performanceGoalPercentageMicros?: string | null; + /** + * A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`. + */ + performanceGoalString?: string | null; + /** + * Required. The type of the performance goal. + */ + performanceGoalType?: string | null; + } + /** + * A strategy that automatically adjusts the bid to meet or beat a specified performance goal. + */ + export interface Schema$PerformanceGoalBidStrategy { + /** + * The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. + */ + maxAverageCpmBidAmountMicros?: string | null; + /** + * Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency. + */ + performanceGoalAmountMicros?: string | null; + /** + * Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. + */ + performanceGoalType?: string | null; + } + /** + * Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + */ + export interface Schema$ProximityLocationListAssignedTargetingOptionDetails { + /** + * Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`. + */ + proximityLocationListId?: string | null; + /** + * Required. Radius range for proximity location list. This represents the size of the area around a chosen location that will be targeted. `All` proximity location targeting under a single line item must have the same radius range value. Set this value to match any existing targeting. If updated, this field will change the radius range for all proximity targeting under the line item. + */ + proximityRadiusRange?: string | null; + } + /** + * Publisher review status for the creative. + */ + export interface Schema$PublisherReviewStatus { + /** + * The publisher reviewing the creative. + */ + publisherName?: string | null; + /** + * Status of the publisher review. + */ + status?: string | null; + } + /** + * The rate related settings of the inventory source. + */ + export interface Schema$RateDetails { + /** + * The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. + */ + inventorySourceRateType?: string | null; + /** + * Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources. + */ + minimumSpend?: Schema$Money; + /** + * The rate for the inventory source. + */ + rate?: Schema$Money; + /** + * Required for guaranteed inventory sources. The number of impressions guaranteed by the seller. + */ + unitsPurchased?: string | null; + } + /** + * Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + */ + export interface Schema$RegionalLocationListAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`. + */ + regionalLocationListId?: string | null; + } + /** + * Review statuses for the creative. + */ + export interface Schema$ReviewStatusInfo { + /** + * Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status. + */ + approvalStatus?: string | null; + /** + * Content and policy review status for the creative. + */ + contentAndPolicyReviewStatus?: string | null; + /** + * Creative and landing page review status for the creative. + */ + creativeAndLandingPageReviewStatus?: string | null; + /** + * Exchange review statuses for the creative. + */ + exchangeReviewStatuses?: Schema$ExchangeReviewStatus[]; + /** + * Publisher review statuses for the creative. + */ + publisherReviewStatuses?: Schema$PublisherReviewStatus[]; + } + /** + * Structured Data File (SDF) related settings. + */ + export interface Schema$SdfConfig { + /** + * An administrator email address to which the SDF processing status reports will be sent. + */ + adminEmail?: string | null; + /** + * Required. The version of SDF being used. + */ + version?: string | null; + } + /** + * Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$SdfDownloadTask { + /** + * A resource name to be used in media.download to Download the prepared files. Resource names have the format `download/sdfdownloadtasks/media/{media_id}`. `media_id` will be made available by the long running operation service once the task status is done. + */ + resourceName?: string | null; + } + /** + * Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$SdfDownloadTaskMetadata { + /** + * The time when the operation was created. + */ + createTime?: string | null; + /** + * The time when execution was completed. + */ + endTime?: string | null; + /** + * The SDF version used to execute this download task. + */ + version?: string | null; + } + /** + * Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + */ + export interface Schema$SensitiveCategoryAssignedTargetingOptionDetails { + /** + * Required. ID of the sensitive category to be EXCLUDED. + */ + excludedTargetingOptionId?: string | null; + /** + * Output only. An enum for the DV360 Sensitive category content classifier. + */ + sensitiveCategory?: string | null; + } + /** + * Represents a targetable sensitive category. This will be populated in the sensitive_category_details field of the TargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. + */ + export interface Schema$SensitiveCategoryTargetingOptionDetails { + /** + * Output only. An enum for the DV360 Sensitive category content classifier. + */ + sensitiveCategory?: string | null; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * 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}> | null; + /** + * 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 | null; + } + /** + * Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. + */ + export interface Schema$SubExchangeAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TAREGTING_TYPE_SUB_EXCHANGE`. + */ + export interface Schema$SubExchangeTargetingOptionDetails { + /** + * Output only. The display name of the sub-exchange. + */ + displayName?: string | null; + } + /** + * Represents a single targeting option, which is a targetable concept in DV360. + */ + export interface Schema$TargetingOption { + /** + * Age range details. + */ + ageRangeDetails?: Schema$AgeRangeTargetingOptionDetails; + /** + * App category details. + */ + appCategoryDetails?: Schema$AppCategoryTargetingOptionDetails; + /** + * Authorized seller status resource details. + */ + authorizedSellerStatusDetails?: Schema$AuthorizedSellerStatusTargetingOptionDetails; + /** + * Browser details. + */ + browserDetails?: Schema$BrowserTargetingOptionDetails; + /** + * Carrier and ISP details. + */ + carrierAndIspDetails?: Schema$CarrierAndIspTargetingOptionDetails; + /** + * Category resource details. + */ + categoryDetails?: Schema$CategoryTargetingOptionDetails; + /** + * Content instream position details. + */ + contentInstreamPositionDetails?: Schema$ContentInstreamPositionTargetingOptionDetails; + /** + * Content outstream position details. + */ + contentOutstreamPositionDetails?: Schema$ContentOutstreamPositionTargetingOptionDetails; + /** + * Device make and model resource details. + */ + deviceMakeModelDetails?: Schema$DeviceMakeModelTargetingOptionDetails; + /** + * Device type details. + */ + deviceTypeDetails?: Schema$DeviceTypeTargetingOptionDetails; + /** + * Digital content label details. + */ + digitalContentLabelDetails?: Schema$DigitalContentLabelTargetingOptionDetails; + /** + * Environment details. + */ + environmentDetails?: Schema$EnvironmentTargetingOptionDetails; + /** + * Exchange details. + */ + exchangeDetails?: Schema$ExchangeTargetingOptionDetails; + /** + * Gender details. + */ + genderDetails?: Schema$GenderTargetingOptionDetails; + /** + * Geographic region resource details. + */ + geoRegionDetails?: Schema$GeoRegionTargetingOptionDetails; + /** + * Household income details. + */ + householdIncomeDetails?: Schema$HouseholdIncomeTargetingOptionDetails; + /** + * Language resource details. + */ + languageDetails?: Schema$LanguageTargetingOptionDetails; + /** + * Output only. The resource name for this targeting option. + */ + name?: string | null; + /** + * On screen position details. + */ + onScreenPositionDetails?: Schema$OnScreenPositionTargetingOptionDetails; + /** + * Operating system resources details. + */ + operatingSystemDetails?: Schema$OperatingSystemTargetingOptionDetails; + /** + * Parental status details. + */ + parentalStatusDetails?: Schema$ParentalStatusTargetingOptionDetails; + /** + * Sensitive Category details. + */ + sensitiveCategoryDetails?: Schema$SensitiveCategoryTargetingOptionDetails; + /** + * Sub-exchange details. + */ + subExchangeDetails?: Schema$SubExchangeTargetingOptionDetails; + /** + * Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique. + */ + targetingOptionId?: string | null; + /** + * Output only. The type of this targeting option. + */ + targetingType?: string | null; + /** + * User rewarded content details. + */ + userRewardedContentDetails?: Schema$UserRewardedContentTargetingOptionDetails; + /** + * Video player size details. + */ + videoPlayerSizeDetails?: Schema$VideoPlayerSizeTargetingOptionDetails; + /** + * Viewability resource details. + */ + viewabilityDetails?: Schema$ViewabilityTargetingOptionDetails; + } + /** + * Settings for advertisers that use third-party ad servers only. + */ + export interface Schema$ThirdPartyOnlyConfig { + /** + * Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`. + */ + pixelOrderIdReportingEnabled?: boolean | null; + } + /** + * Tracking URLs from third parties to track interactions with an audio or a video creative. + */ + export interface Schema$ThirdPartyUrl { + /** + * The type of interaction needs to be tracked by the tracking URL + */ + type?: string | null; + /** + * Tracking URL used to track the interaction. Provide a URL with optional path or query string, beginning with `https:`. For example, https://www.example.com/path + */ + url?: string | null; + } + /** + * Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + */ + export interface Schema$ThirdPartyVerifierAssignedTargetingOptionDetails { + /** + * Third party brand verifier -- Adloox. + */ + adloox?: Schema$Adloox; + /** + * Third party brand verifier -- DoubleVerify. + */ + doubleVerify?: Schema$DoubleVerify; + /** + * Third party brand verifier -- Integral Ad Science. + */ + integralAdScience?: Schema$IntegralAdScience; + } + /** + * A time range. + */ + export interface Schema$TimeRange { + /** + * Required. The upper bound of a time range, inclusive. + */ + endTime?: string | null; + /** + * Required. The lower bound of a time range, inclusive. + */ + startTime?: string | null; + } + /** + * Timer event of the creative. + */ + export interface Schema$TimerEvent { + /** + * Required. The name of the timer event. + */ + name?: string | null; + /** + * Required. The name used to identify this timer event in reports. + */ + reportingName?: string | null; + } + /** + * Settings that control the behavior of a single Floodlight activity config. + */ + export interface Schema$TrackingFloodlightActivityConfig { + /** + * Required. The ID of the Floodlight activity. + */ + floodlightActivityId?: string | null; + /** + * Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive. + */ + postClickLookbackWindowDays?: number | null; + /** + * Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive. + */ + postViewLookbackWindowDays?: number | null; + } + /** + * Represents information about the transcoded audio or video file. + */ + export interface Schema$Transcode { + /** + * The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + */ + audioBitRateKbps?: string | null; + /** + * The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + */ + audioSampleRateHz?: string | null; + /** + * The transcoding bit rate of the transcoded video, in kilobits per second. + */ + bitRateKbps?: string | null; + /** + * The dimensions of the transcoded video. + */ + dimensions?: Schema$Dimensions; + /** + * The size of the transcoded file, in bytes. + */ + fileSizeBytes?: string | null; + /** + * The frame rate of the transcoded video, in frames per second. + */ + frameRate?: number | null; + /** + * The MIME type of the transcoded file. + */ + mimeType?: string | null; + /** + * The name of the transcoded file. + */ + name?: string | null; + /** + * Indicates if the transcoding was successful. + */ + transcoded?: boolean | null; + } + /** + * A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. + */ + export interface Schema$UniversalAdId { + /** + * The unique creative identifier. + */ + id?: string | null; + /** + * The registry provides unique creative identifiers. + */ + registry?: string | null; + } + /** + * Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. + */ + export interface Schema$UrlAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`. + */ + url?: string | null; + } + /** + * User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + export interface Schema$UserRewardedContentAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + targetingOptionId?: string | null; + /** + * Output only. User rewarded content status for video ads. + */ + userRewardedContent?: string | null; + } + /** + * Represents a targetable user rewarded content status for video ads only. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + export interface Schema$UserRewardedContentTargetingOptionDetails { + /** + * Output only. User rewarded content status for video ads. + */ + userRewardedContent?: string | null; + } + /** + * Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. + */ + export interface Schema$VideoPlayerSizeAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + */ + targetingOptionId?: string | null; + /** + * Output only. The video player size. + */ + videoPlayerSize?: string | null; + } + /** + * Represents a targetable video player size. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + */ + export interface Schema$VideoPlayerSizeTargetingOptionDetails { + /** + * Output only. The video player size. + */ + videoPlayerSize?: string | null; + } + /** + * Assigned viewability targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. + */ + export interface Schema$ViewabilityAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_VIEWABILITY` (e.g., "509010" for targeting the `VIEWABILITY_10_PERCENT_OR_MORE` option). + */ + targetingOptionId?: string | null; + /** + * Output only. The predicted viewability percentage. + */ + viewability?: string | null; + } + /** + * Represents a targetable viewability. This will be populated in the details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. + */ + export interface Schema$ViewabilityTargetingOptionDetails { + /** + * Output only. The predicted viewability percentage. + */ + viewability?: string | null; + } + + export class Resource$Advertisers { + context: APIRequestContext; + assets: Resource$Advertisers$Assets; + campaigns: Resource$Advertisers$Campaigns; + channels: Resource$Advertisers$Channels; + creatives: Resource$Advertisers$Creatives; + insertionOrders: Resource$Advertisers$Insertionorders; + lineItems: Resource$Advertisers$Lineitems; + locationLists: Resource$Advertisers$Locationlists; + negativeKeywordLists: Resource$Advertisers$Negativekeywordlists; + constructor(context: APIRequestContext) { + this.context = context; + this.assets = new Resource$Advertisers$Assets(this.context); + this.campaigns = new Resource$Advertisers$Campaigns(this.context); + this.channels = new Resource$Advertisers$Channels(this.context); + this.creatives = new Resource$Advertisers$Creatives(this.context); + this.insertionOrders = new Resource$Advertisers$Insertionorders( + this.context + ); + this.lineItems = new Resource$Advertisers$Lineitems(this.context); + this.locationLists = new Resource$Advertisers$Locationlists(this.context); + this.negativeKeywordLists = new Resource$Advertisers$Negativekeywordlists( + this.context + ); + } + + /** + * displayvideo.advertisers.create + * @desc Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete. + * @alias displayvideo.advertisers.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().Advertiser} params.requestBody Request body data + * @param {object} [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$Advertisers$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/advertisers').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.delete + * @desc Deletes an advertiser. Deleting an advertiser will delete all of its child resources, for example, campaigns, insertion orders and line items. A deleted advertiser cannot be recovered. + * @alias displayvideo.advertisers.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser we need to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Advertisers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.get + * @desc Gets an advertiser. + * @alias displayvideo.advertisers.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser to fetch. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Advertisers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.list + * @desc Lists advertisers that are accessible to the current user. The order is defined by the order_by parameter. A single partner_id is required. Cross-partner listing is not supported. + * @alias displayvideo.advertisers.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Allows filtering by advertiser properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Advertisers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/advertisers').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.patch + * @desc Updates an existing advertiser. Returns the updated advertiser if successful. + * @alias displayvideo.advertisers.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().Advertiser} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Advertisers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser we need to delete. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser to fetch. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Allows filtering by advertiser properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser. Assigned by the system. + */ + advertiserId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + + export class Resource$Advertisers$Assets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.assets.upload + * @desc Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. + * @alias displayvideo.advertisers.assets.upload + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser this asset belongs to. + * @param {object} params.requestBody 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 + */ + upload( + params?: Params$Resource$Advertisers$Assets$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + callback: BodyResponseCallback + ): void; + upload(callback: BodyResponseCallback): void; + upload( + paramsOrCallback?: + | Params$Resource$Advertisers$Assets$Upload + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Assets$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Assets$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/advertisers/{+advertiserId}/assets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + mediaUrl: ( + rootUrl + '/upload/v1/advertisers/{+advertiserId}/assets' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Assets$Upload + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser this asset belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateAssetRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Advertisers$Campaigns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.campaigns.create + * @desc Creates a new campaign. Returns the newly created campaign if successful. + * @alias displayvideo.advertisers.campaigns.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the campaign belongs to. + * @param {().Campaign} params.requestBody Request body data + * @param {object} [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$Advertisers$Campaigns$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.campaigns.delete + * @desc Permanently deletes a campaign. A deleted campaign cannot be recovered. The campaign should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * @alias displayvideo.advertisers.campaigns.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser this campaign belongs to. + * @param {string} params.campaignId The ID of the campaign we need to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Advertisers$Campaigns$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.campaigns.get + * @desc Gets a campaign. + * @alias displayvideo.advertisers.campaigns.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser this campaign belongs to. + * @param {string} params.campaignId Required. The ID of the campaign to fetch. + * @param {object} [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$Campaigns$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.campaigns.list + * @desc Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * @alias displayvideo.advertisers.campaigns.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser to list campaigns for. + * @param {string=} params.filter Allows filtering by campaign properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. + * @param {object} [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$Campaigns$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Campaigns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Campaigns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.campaigns.patch + * @desc Updates an existing campaign. Returns the updated campaign if successful. + * @alias displayvideo.advertisers.campaigns.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the campaign belongs to. + * @param {string} params.campaignId Output only. The unique ID of the campaign. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().Campaign} params.requestBody Request body data + * @param {object} [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$Campaigns$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Campaigns$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Advertisers$Campaigns$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * The ID of the campaign we need to delete. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to fetch. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser to list campaigns for. + */ + advertiserId?: string; + /** + * Allows filtering by campaign properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the campaign. Assigned by the system. + */ + campaignId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + + export class Resource$Advertisers$Channels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.channels.get + * @desc Gets a channel for a partner or advertiser. + * @alias displayvideo.advertisers.channels.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser that owns the fetched channel. + * @param {string} params.channelId Required. The ID of the channel to fetch. + * @param {string=} params.partnerId The ID of the partner that owns the fetched channel. + * @param {object} [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$Channels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Channels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/channels/{+channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.channels.list + * @desc Lists channels for a partner or advertiser. + * @alias displayvideo.advertisers.channels.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser that owns the channels. + * @param {string=} params.filter Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that owns the channels. + * @param {object} [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$Channels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Channels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Channels$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + + export class Resource$Advertisers$Creatives { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.creatives.create + * @desc Creates a new creative. Returns the newly created creative if successful. + * @alias displayvideo.advertisers.creatives.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the creative belongs to. + * @param {().Creative} params.requestBody Request body data + * @param {object} [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$Advertisers$Creatives$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Creatives$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.creatives.delete + * @desc Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. + * @alias displayvideo.advertisers.creatives.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser this creative belongs to. + * @param {string} params.creativeId The ID of the creative to be deleted. + * @param {object} [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$Advertisers$Creatives$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.creatives.get + * @desc Gets a creative. + * @alias displayvideo.advertisers.creatives.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser this creative belongs to. + * @param {string} params.creativeId Required. The ID of the creative to fetch. + * @param {object} [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$Creatives$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Creatives$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.creatives.list + * @desc Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * @alias displayvideo.advertisers.creatives.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser to list creatives for. + * @param {string=} params.filter Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. + * @param {object} [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$Creatives$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Creatives$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Creatives$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.creatives.patch + * @desc Updates an existing creative. Returns the updated creative if successful. + * @alias displayvideo.advertisers.creatives.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the creative belongs to. + * @param {string} params.creativeId Output only. The unique ID of the creative. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().Creative} params.requestBody Request body data + * @param {object} [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$Creatives$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Creatives$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Advertisers$Creatives$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * The ID of the creative to be deleted. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the creative to fetch. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser to list creatives for. + */ + advertiserId?: string; + /** + * Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Creatives$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the creative. Assigned by the system. + */ + creativeId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + + export class Resource$Advertisers$Insertionorders { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.insertionOrders.create + * @desc Creates a new insertion order. Returns the newly created insertion order if successful. + * @alias displayvideo.advertisers.insertionOrders.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the insertion order belongs to. + * @param {().InsertionOrder} params.requestBody Request body data + * @param {object} [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$Advertisers$Insertionorders$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/insertionOrders' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.insertionOrders.delete + * @desc Deletes an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. The insertion order should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * @alias displayvideo.advertisers.insertionOrders.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser this insertion order belongs to. + * @param {string} params.insertionOrderId The ID of the insertion order we need to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Advertisers$Insertionorders$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.insertionOrders.get + * @desc Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. + * @alias displayvideo.advertisers.insertionOrders.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser this insertion order belongs to. + * @param {string} params.insertionOrderId Required. The ID of the insertion order to fetch. + * @param {object} [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$Insertionorders$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.insertionOrders.list + * @desc Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * @alias displayvideo.advertisers.insertionOrders.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser to list insertion orders for. + * @param {string=} params.filter Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `entityStatus` Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" or entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + * @param {object} [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$Insertionorders$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/insertionOrders' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.insertionOrders.patch + * @desc Updates an existing insertion order. Returns the updated insertion order if successful. + * @alias displayvideo.advertisers.insertionOrders.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the insertion order belongs to. + * @param {string} params.insertionOrderId Output only. The unique ID of the insertion order. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().InsertionOrder} params.requestBody Request body data + * @param {object} [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$Insertionorders$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Insertionorders$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + export interface Params$Resource$Advertisers$Insertionorders$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * The ID of the insertion order we need to delete. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the insertion order to fetch. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser to list insertion orders for. + */ + advertiserId?: string; + /** + * Allows filtering by insertion order properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `entityStatus` Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" or entityStatus="ENTITY_STATUS_PAUSED")` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + + export class Resource$Advertisers$Lineitems { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Lineitems$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Lineitems$Targetingtypes( + this.context + ); + } + + /** + * displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions + * @desc Bulk edits targeting options under a single line item. The operation will delete the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditLineItemAssignedTargetingOptionsRequest.create_requests . + * @alias displayvideo.advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option will belong to. + * @param {().BulkEditLineItemAssignedTargetingOptionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulkEditLineItemAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkEditLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >, + callback: BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkEditLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions, + callback: BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkEditLineItemAssignedTargetingOptions( + callback: BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkEditLineItemAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions + | BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >, + callback?: BodyResponseCallback< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > + ): void | GaxiosPromise< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkEditLineItemAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$BulkEditLineItemAssignedTargetingOptionsResponse + >(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions + * @desc Lists assigned targeting options of a line item across targeting types. + * @alias displayvideo.advertisers.lineItems.bulkListLineItemAssignedTargetingOptions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + * @param {string} params.lineItemId Required. The ID of the line item to list assigned targeting options for. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + * @param {integer=} params.pageSize Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + bulkListLineItemAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkListLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >, + callback: BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkListLineItemAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions, + callback: BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkListLineItemAssignedTargetingOptions( + callback: BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + ): void; + bulkListLineItemAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions + | BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >, + callback?: BodyResponseCallback< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > + ): void | GaxiosPromise< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}:bulkListLineItemAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$BulkListLineItemAssignedTargetingOptionsResponse + >(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.create + * @desc Creates a new line item. Returns the newly created line item if successful. + * @alias displayvideo.advertisers.lineItems.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the line item belongs to. + * @param {().LineItem} params.requestBody Request body data + * @param {object} [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$Advertisers$Lineitems$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.delete + * @desc Deletes a line item. Returns error code `NOT_FOUND` if the line item does not exist. The line item should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, to be able to delete it. + * @alias displayvideo.advertisers.lineItems.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId The ID of the advertiser this line item belongs to. + * @param {string} params.lineItemId The ID of the line item we need to fetch. + * @param {object} [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$Advertisers$Lineitems$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.get + * @desc Gets a line item. + * @alias displayvideo.advertisers.lineItems.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser this line item belongs to. + * @param {string} params.lineItemId Required. The ID of the line item to fetch. + * @param {object} [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$Lineitems$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.list + * @desc Lists line items in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, line items with `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * @alias displayvideo.advertisers.lineItems.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser to list line items for. + * @param {string=} params.filter Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType`. Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" or entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + * @param {object} [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$Lineitems$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.patch + * @desc Updates an existing line item. Returns the updated line item if successful. + * @alias displayvideo.advertisers.lineItems.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Output only. The unique ID of the advertiser the line item belongs to. + * @param {string} params.lineItemId Output only. The unique ID of the line item. Assigned by the system. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().LineItem} params.requestBody Request body data + * @param {object} [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$Lineitems$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Bulkeditlineitemassignedtargetingoptions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item the assigned targeting option will belong to. + */ + lineItemId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditLineItemAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Bulklistlineitemassignedtargetingoptions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `targetingType` - `inheritance` Examples: * AssignedTargetingOptions of targeting type TARGETING_TYPE_PROXIMITY_LOCATION_LIST or TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Required. The ID of the line item to list assigned targeting options for. + */ + lineItemId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + export interface Params$Resource$Advertisers$Lineitems$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * The ID of the line item we need to fetch. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to fetch. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser to list line items for. + */ + advertiserId?: string; + /** + * Allows filtering by line item properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `campaignId` - `insertionOrderId` - `entityStatus` - `lineItemType`. Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" or entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * "displayName" (default) * "entityStatus" The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + + export class Resource$Advertisers$Lineitems$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = new Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create + * @desc Assigns a targeting option to a line item. Returns the assigned targeting option if successful. + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option will belong to. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {().AssignedTargetingOption} params.requestBody Request body data + * @param {object} [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$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete + * @desc Deletes an assigned targeting option from a line item. + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.assignedTargetingOptionId Required. The ID of the assigned targeting option to delete. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option belongs to. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {object} [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$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get + * @desc Gets a single targeting option assigned to a line item. + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string} params.assignedTargetingOptionId Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + * @param {string} params.lineItemId Required. The ID of the line item the assigned targeting option belongs to. + * @param {string} params.targetingType Required. Identifies the type of this assigned targeting option. + * @param {object} [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$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list + * @desc Lists the targeting options assigned to a line item. + * @alias displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the advertiser the line item belongs to. + * @param {string=} params.filter Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + * @param {string} params.lineItemId Required. The ID of the line item to list assigned targeting options for. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * @param {string} params.targetingType Required. Identifies the type of assigned targeting options to 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 + */ + list( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + >, + callback: BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + >, + callback?: BodyResponseCallback< + Schema$ListLineItemAssignedTargetingOptionsResponse + > + ): void | GaxiosPromise< + Schema$ListLineItemAssignedTargetingOptionsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$ListLineItemAssignedTargetingOptionsResponse + >(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item the assigned targeting option will belong to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `assignedTargetingOptionId` - `inheritance` Examples: * AssignedTargetingOptions with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * AssignedTargetingOptions with inheritance status of NOT_INHERITED or INHERITED_FROM_PARTNER `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Required. The ID of the line item to list assigned targeting options for. + */ + lineItemId?: string; + /** + * Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. + */ + targetingType?: string; + } + + export class Resource$Advertisers$Locationlists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.locationLists.get + * @desc Gets a location list. + * @alias displayvideo.advertisers.locationLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched location list belongs. + * @param {string} params.locationListId Required. The ID of the location list to fetch. + * @param {object} [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$Locationlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/locationLists/{+locationListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.locationLists.list + * @desc Lists location lists based on a given advertiser id. + * @alias displayvideo.advertisers.locationLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched location lists belong. + * @param {string=} params.filter Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. + * @param {object} [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$Locationlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/locationLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Locationlists$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the DV360 advertiser to which the fetched location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list to fetch. + */ + locationListId?: string; + } + export interface Params$Resource$Advertisers$Locationlists$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the DV360 advertiser to which the fetched location lists belong. + */ + advertiserId?: string; + /** + * Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Negativekeywordlists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.advertisers.negativeKeywordLists.get + * @desc Gets a negative keyword list given an advertiser ID and a negative keyword list ID. + * @alias displayvideo.advertisers.negativeKeywordLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. + * @param {string} params.negativeKeywordListId Required. The ID of the negative keyword list to fetch. + * @param {object} [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$Negativekeywordlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.advertisers.negativeKeywordLists.list + * @desc Lists negative keyword lists based on a given advertiser id. + * @alias displayvideo.advertisers.negativeKeywordLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.advertiserId Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. + * @param {object} [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$Negativekeywordlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/advertisers/{+advertiserId}/negativeKeywordLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Negativekeywordlists$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the negative keyword list to fetch. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. + */ + advertiserId?: string; + /** + * Requested page size. Must be between `1` and `100`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Combinedaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.combinedAudiences.get + * @desc Gets a combined audience. + * @alias displayvideo.combinedAudiences.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched combined audience. + * @param {string} params.combinedAudienceId Required. The ID of the combined audience to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched combined audience. + * @param {object} [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$Combinedaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Combinedaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Combinedaudiences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Combinedaudiences$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Combinedaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Combinedaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/combinedAudiences/{+combinedAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['combinedAudienceId'], + pathParams: ['combinedAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.combinedAudiences.list + * @desc Lists combined audiences. The order is defined by the order_by parameter. + * @alias displayvideo.combinedAudiences.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched combined audiences. + * @param {string=} params.filter Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched combined audiences. + * @param {object} [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$Combinedaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Combinedaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Combinedaudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Combinedaudiences$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Combinedaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Combinedaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/combinedAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Combinedaudiences$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the fetched combined audience. + */ + advertiserId?: string; + /** + * Required. The ID of the combined audience to fetch. + */ + combinedAudienceId?: string; + /** + * The ID of the partner that has access to the fetched combined audience. + */ + partnerId?: string; + } + export interface Params$Resource$Combinedaudiences$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the fetched combined audiences. + */ + advertiserId?: string; + /** + * Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched combined audiences. + */ + partnerId?: string; + } + + export class Resource$Customlists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.customLists.get + * @desc Gets a custom list. + * @alias displayvideo.customLists.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the DV360 advertiser that has access to the fetched custom lists. + * @param {string} params.customListId Required. The ID of the custom list to fetch. + * @param {object} [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$Customlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customlists$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/customLists/{+customListId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customListId'], + pathParams: ['customListId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.customLists.list + * @desc Lists custom lists. The order is defined by the order_by parameter. + * @alias displayvideo.customLists.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the DV360 advertiser that has access to the fetched custom lists. + * @param {string=} params.filter Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. + * @param {object} [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$Customlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customlists$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Customlists$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/customLists').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customlists$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the DV360 advertiser that has access to the fetched custom lists. + */ + advertiserId?: string; + /** + * Required. The ID of the custom list to fetch. + */ + customListId?: string; + } + export interface Params$Resource$Customlists$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the DV360 advertiser that has access to the fetched custom lists. + */ + advertiserId?: string; + /** + * Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Firstandthirdpartyaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.firstAndThirdPartyAudiences.get + * @desc Gets a first and third party audience. + * @alias displayvideo.firstAndThirdPartyAudiences.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched first and third party audience. + * @param {string} params.firstAndThirdPartyAudienceId Required. The ID of the first and third party audience to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched first and third party audience. + * @param {object} [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$Firstandthirdpartyaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Firstandthirdpartyaudiences$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Firstandthirdpartyaudiences$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Firstandthirdpartyaudiences$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstandthirdpartyaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstandthirdpartyaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['firstAndThirdPartyAudienceId'], + pathParams: ['firstAndThirdPartyAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.firstAndThirdPartyAudiences.list + * @desc Lists first and third party audiences. The order is defined by the order_by parameter. + * @alias displayvideo.firstAndThirdPartyAudiences.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched first and third party audiences. + * @param {string=} params.filter Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched first and third party audiences. + * @param {object} [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$Firstandthirdpartyaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Firstandthirdpartyaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListFirstAndThirdPartyAudiencesResponse + > + ): void; + list( + params: Params$Resource$Firstandthirdpartyaudiences$List, + callback: BodyResponseCallback< + Schema$ListFirstAndThirdPartyAudiencesResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$ListFirstAndThirdPartyAudiencesResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Firstandthirdpartyaudiences$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListFirstAndThirdPartyAudiencesResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstandthirdpartyaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstandthirdpartyaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/firstAndThirdPartyAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Firstandthirdpartyaudiences$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the fetched first and third party audience. + */ + advertiserId?: string; + /** + * Required. The ID of the first and third party audience to fetch. + */ + firstAndThirdPartyAudienceId?: string; + /** + * The ID of the partner that has access to the fetched first and third party audience. + */ + partnerId?: string; + } + export interface Params$Resource$Firstandthirdpartyaudiences$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the fetched first and third party audiences. + */ + advertiserId?: string; + /** + * Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched first and third party audiences. + */ + partnerId?: string; + } + + export class Resource$Floodlightgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.floodlightGroups.get + * @desc Gets a Floodlight group. + * @alias displayvideo.floodlightGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.floodlightGroupId Required. The ID of the Floodlight group to fetch. + * @param {string=} params.partnerId Required. The partner context by which the Floodlight group is being accessed. + * @param {object} [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$Floodlightgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/floodlightGroups/{+floodlightGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.floodlightGroups.patch + * @desc Updates an existing Floodlight group. Returns the updated Floodlight group if successful. + * @alias displayvideo.floodlightGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.floodlightGroupId Output only. The unique ID of the Floodlight group. Assigned by the system. + * @param {string=} params.partnerId Required. The partner context by which the Floodlight group is being accessed. + * @param {string=} params.updateMask Required. The mask to control which fields to update. + * @param {().FloodlightGroup} params.requestBody Request body data + * @param {object} [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$Floodlightgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Floodlightgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/floodlightGroups/{floodlightGroupId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightgroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the Floodlight group to fetch. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + } + export interface Params$Resource$Floodlightgroups$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The unique ID of the Floodlight group. Assigned by the system. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightGroup; + } + + export class Resource$Googleaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.googleAudiences.get + * @desc Gets a Google audience. + * @alias displayvideo.googleAudiences.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched Google audience. + * @param {string} params.googleAudienceId Required. The ID of the Google audience to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched Google audience. + * @param {object} [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$Googleaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Googleaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Googleaudiences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Googleaudiences$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Googleaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Googleaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/googleAudiences/{+googleAudienceId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['googleAudienceId'], + pathParams: ['googleAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.googleAudiences.list + * @desc Lists Google audiences. The order is defined by the order_by parameter. + * @alias displayvideo.googleAudiences.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the fetched Google audiences. + * @param {string=} params.filter Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the fetched Google audiences. + * @param {object} [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$Googleaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Googleaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Googleaudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Googleaudiences$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Googleaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Googleaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/googleAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Googleaudiences$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the fetched Google audience. + */ + advertiserId?: string; + /** + * Required. The ID of the Google audience to fetch. + */ + googleAudienceId?: string; + /** + * The ID of the partner that has access to the fetched Google audience. + */ + partnerId?: string; + } + export interface Params$Resource$Googleaudiences$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the fetched Google audiences. + */ + advertiserId?: string; + /** + * Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched Google audiences. + */ + partnerId?: string; + } + + export class Resource$Inventorysourcegroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.inventorySourceGroups.get + * @desc Gets an inventory source group. + * @alias displayvideo.inventorySourceGroups.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + * @param {string} params.inventorySourceGroupId Required. The ID of the inventory source group to fetch. + * @param {string=} params.partnerId The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. + * @param {object} [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$Inventorysourcegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysourcegroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysourcegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/inventorySourceGroups/{+inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.inventorySourceGroups.list + * @desc Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter. + * @alias displayvideo.inventorySourceGroups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + * @param {string=} params.filter Allows filtering by inventory source group properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. + * @param {object} [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$Inventorysourcegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysourcegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/inventorySourceGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Inventorysourcegroups$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to fetch. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source group properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `inventorySourceGroupId` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. + */ + partnerId?: string; + } + + export class Resource$Inventorysources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.inventorySources.get + * @desc Gets an inventory source. + * @alias displayvideo.inventorySources.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.inventorySourceId Required. The ID of the inventory source to fetch. + * @param {string=} params.partnerId Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. + * @param {object} [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$Inventorysources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Inventorysources$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/inventorySources/{+inventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.inventorySources.list + * @desc Lists inventory sources that are accessible to the current user. The order is defined by the order_by parameter. If a filter by entity_status is not specified, inventory sources with entity status `ENTITY_STATUS_ARCHIVED` will not be included in the results. + * @alias displayvideo.inventorySources.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that has access to the inventory source. + * @param {string=} params.filter Allows filtering by inventory source properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `status.entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + * @param {string=} params.partnerId The ID of the partner that has access to the inventory source. + * @param {object} [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$Inventorysources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysources$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysources$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/inventorySources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Inventorysources$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The ID of the inventory source to fetch. + */ + inventorySourceId?: string; + /** + * Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysources$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that has access to the inventory source. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)`. * Supported fields: - `status.entityStatus` - `commitment` - `deliveryMethod` - `rateDetails.rateType` - `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the inventory source. + */ + partnerId?: string; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.media.download + * @desc Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string. + * @alias displayvideo.media.download + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.resourceName Name of the media that is being downloaded. See ReadRequest.resource_name. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + download( + params?: Params$Resource$Media$Download, + options?: MethodOptions + ): GaxiosPromise; + download( + params: Params$Resource$Media$Download, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + callback: BodyResponseCallback + ): void; + download( + callback: BodyResponseCallback + ): void; + download( + paramsOrCallback?: + | Params$Resource$Media$Download + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/download/{+resourceName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resourceName'], + pathParams: ['resourceName'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Download extends StandardParameters { + /** + * Auth client or API Key for the request */ - details?: Array<{[key: string]: any}> | null; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** - * 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. + * Name of the media that is being downloaded. See ReadRequest.resource_name. */ - message?: string | null; + resourceName?: string; } - export class Resource$Media { + export class Resource$Partners { + context: APIRequestContext; + channels: Resource$Partners$Channels; + constructor(context: APIRequestContext) { + this.context = context; + this.channels = new Resource$Partners$Channels(this.context); + } + } + + export class Resource$Partners$Channels { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * displayvideo.media.download - * @desc Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string. - * @alias displayvideo.media.download + * displayvideo.partners.channels.get + * @desc Gets a channel for a partner or advertiser. + * @alias displayvideo.partners.channels.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resourceName Name of the media that is being downloaded. See ReadRequest.resource_name. + * @param {string=} params.advertiserId The ID of the advertiser that owns the fetched channel. + * @param {string} params.channelId Required. The ID of the channel to fetch. + * @param {string} params.partnerId The ID of the partner that owns the fetched channel. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - download( - params?: Params$Resource$Media$Download, + get( + params?: Params$Resource$Partners$Channels$Get, options?: MethodOptions - ): GaxiosPromise; - download( - params: Params$Resource$Media$Download, + ): GaxiosPromise; + get( + params: Params$Resource$Partners$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Channels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/partners/{+partnerId}/channels/{+channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.partners.channels.list + * @desc Lists channels for a partner or advertiser. + * @alias displayvideo.partners.channels.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId The ID of the advertiser that owns the channels. + * @param {string=} params.filter Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + * @param {string} params.partnerId The ID of the partner that owns the channels. + * @param {object} [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$Partners$Channels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$Channels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - download( - params: Params$Resource$Media$Download, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - download( - callback: BodyResponseCallback + list( + params: Params$Resource$Partners$Channels$List, + callback: BodyResponseCallback ): void; - download( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Media$Download - | BodyResponseCallback, + | Params$Resource$Partners$Channels$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Media$Download; + params = {} as Params$Resource$Partners$Channels$List; options = {}; } @@ -342,7 +9070,7 @@ export namespace displayvideo_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/download/{+resourceName}').replace( + url: (rootUrl + '/v1/partners/{+partnerId}/channels').replace( /([^:]\/)\/+/g, '$1' ), @@ -351,28 +9079,69 @@ export namespace displayvideo_v1 { options ), params, - requiredParams: ['resourceName'], - pathParams: ['resourceName'], + requiredParams: ['partnerId'], + pathParams: ['partnerId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Media$Download extends StandardParameters { + export interface Params$Resource$Partners$Channels$Get + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the media that is being downloaded. See ReadRequest.resource_name. + * The ID of the advertiser that owns the fetched channel. */ - resourceName?: string; + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel currently can only contain at most one * restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; } export class Resource$Sdfdownloadtasks { @@ -561,4 +9330,238 @@ export namespace displayvideo_v1 { */ name?: string; } + + export class Resource$Targetingtypes { + context: APIRequestContext; + targetingOptions: Resource$Targetingtypes$Targetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingOptions = new Resource$Targetingtypes$Targetingoptions( + this.context + ); + } + } + + export class Resource$Targetingtypes$Targetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * displayvideo.targetingTypes.targetingOptions.get + * @desc Gets a single targeting option. + * @alias displayvideo.targetingTypes.targetingOptions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Required. The Advertiser this request is being made in the context of. + * @param {string} params.targetingOptionId Required. The ID of the of targeting option to retrieve. + * @param {string} params.targetingType Required. The type of targeting option to retrieve. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Targetingtypes$Targetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['targetingType', 'targetingOptionId'], + pathParams: ['targetingOptionId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * displayvideo.targetingTypes.targetingOptions.list + * @desc Lists targeting options of a given type. + * @alias displayvideo.targetingTypes.targetingOptions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.advertiserId Required. The Advertiser this request is being made in the context of. + * @param {string=} params.filter Allows filtering by targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The operator must be "=" (equal sign). * Supported fields: - `targetingOptionId` The length of this field should be no more than 500 characters. + * @param {string=} params.orderBy Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`. + * @param {integer=} params.pageSize Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * @param {string=} params.pageToken A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned. + * @param {string} params.targetingType Required. The type of targeting option to be listed. + * @param {object} [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$Targetingtypes$Targetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/targetingTypes/{+targetingType}/targetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['targetingType'], + pathParams: ['targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Targetingtypes$Targetingoptions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string; + /** + * Required. The ID of the of targeting option to retrieve. + */ + targetingOptionId?: string; + /** + * Required. The type of targeting option to retrieve. + */ + targetingType?: string; + } + export interface Params$Resource$Targetingtypes$Targetingoptions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string; + /** + * Allows filtering by targeting option properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The operator must be "=" (equal sign). * Supported fields: - `targetingOptionId` The length of this field should be no more than 500 characters. + */ + filter?: string; + /** + * Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingOptionId desc`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. The type of targeting option to be listed. + */ + targetingType?: string; + } } diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 7d6d87e9e00..092bdd076a1 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1224,7 +1224,7 @@ export namespace dlp_v2 { */ jobName?: string | null; /** - * The labels associated with this `Finding`. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 10 labels can be associated with a given finding. Example: <code>"environment" : "production"</code> Example: <code>"pipeline" : "etl"</code> + * The labels associated with this `Finding`. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` */ labels?: {[key: string]: string} | null; /** @@ -1337,7 +1337,7 @@ export namespace dlp_v2 { */ fileOffset?: string | null; /** - * Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with `Finding`'s produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 10 labels can be associated with a given finding. Example: <code>"environment" : "production"</code> Example: <code>"pipeline" : "etl"</code> + * Labels to represent user provided metadata about the data being inspected. If configured by the job, some key values may be required. The labels associated with `Finding`'s produced by hybrid inspection. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` */ labels?: {[key: string]: string} | null; /** @@ -1397,11 +1397,11 @@ export namespace dlp_v2 { */ description?: string | null; /** - * To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 10 labels can be associated with a given finding. Example: <code>"environment" : "production"</code> Example: <code>"pipeline" : "etl"</code> + * To organize findings, these labels will be added to each finding. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. No more than 10 labels can be associated with a given finding. Examples: * `"environment" : "production"` * `"pipeline" : "etl"` */ labels?: {[key: string]: string} | null; /** - * These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. No more than 10 keys can be required. + * These are labels that each inspection request must include within their 'finding_labels' map. Request may contain others, but any missing one of these will be rejected. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. No more than 10 keys can be required. */ requiredFindingLabelKeys?: string[] | null; /** @@ -1440,7 +1440,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2InfoType { /** - * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. InfoType names should conform to the pattern [a-zA-Z0-9_]{1,64}. + * Name of the information type. Either a name of your choosing when creating a CustomInfoType, or one of the names listed at https://cloud.google.com/dlp/docs/infotypes-reference when specifying a built-in type. InfoType names should conform to the pattern `[a-zA-Z0-9_]{1,64}`. */ name?: string | null; } diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 920cb221fd8..46e2b34e0e6 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -1294,7 +1294,7 @@ export namespace drive_v2 { */ etag?: string | null; /** - * The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests + * The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They cannot be set on shared drive items - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests */ expirationDate?: string | null; /** @@ -1963,7 +1963,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.changeId The ID of the change. - * @param {string=} params.driveId The shared drive from which the change will be returned. + * @param {string=} params.driveId The shared drive from which the change is returned. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. @@ -2037,7 +2037,7 @@ export namespace drive_v2 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. + * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. @@ -2116,11 +2116,11 @@ export namespace drive_v2 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * @param {string=} params.driveId The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. * @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. - * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. - * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. + * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults Maximum number of changes to return. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. @@ -2198,11 +2198,11 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * @param {string=} params.driveId The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. * @param {boolean=} params.includeDeleted Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. - * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. - * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. + * @param {boolean=} params.includeSubscribed Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.maxResults Maximum number of changes to return. * @param {string=} params.pageToken The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response or to the response from the getStartPageToken method. @@ -2287,7 +2287,7 @@ export namespace drive_v2 { */ changeId?: string; /** - * The shared drive from which the change will be returned. + * The shared drive from which the change is returned. */ driveId?: string; /** @@ -2311,7 +2311,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. + * The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned. */ driveId?: string; /** @@ -2334,7 +2334,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** @@ -2346,11 +2346,11 @@ export namespace drive_v2 { */ includeDeleted?: boolean; /** - * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. */ includeItemsFromAllDrives?: boolean; /** - * Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. + * Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. */ includeSubscribed?: boolean; /** @@ -2393,7 +2393,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** @@ -2405,11 +2405,11 @@ export namespace drive_v2 { */ includeDeleted?: boolean; /** - * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. */ includeItemsFromAllDrives?: boolean; /** - * Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result. + * Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive are omitted from the result. */ includeSubscribed?: boolean; /** @@ -2555,7 +2555,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string} params.childId The ID of the child. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's last parent is removed, the item will be placed under its owner's root. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's last parent is removed, the item is placed under its owner's root. * @param {string} params.folderId The ID of the folder. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2699,7 +2699,7 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the child's owner makes the request, the child will be removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child's owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. * @param {string} params.folderId The ID of the folder. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. @@ -2858,7 +2858,7 @@ export namespace drive_v2 { */ childId?: string; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's last parent is removed, the item will be placed under its owner's root. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's last parent is removed, the item is placed under its owner's root. */ enforceSingleParent?: boolean; /** @@ -2888,7 +2888,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the child's owner makes the request, the child will be removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child's owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. */ enforceSingleParent?: boolean; /** @@ -4127,7 +4127,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {boolean=} params.convert Whether to convert this file to the corresponding Google Docs format. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. * @param {string} params.fileId The ID of the file to copy. * @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. * @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes. @@ -4576,7 +4576,7 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {boolean=} params.convert Whether to convert this file to the corresponding Google Docs format. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. * @param {boolean=} params.ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. * @param {string=} params.ocrLanguage If ocr is true, hints at the language to use. Valid values are BCP 47 codes. * @param {boolean=} params.pinned Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions. @@ -4744,7 +4744,7 @@ export namespace drive_v2 { * @param {object} params Parameters for request * @param {string=} params.addParents Comma-separated list of parent IDs to add. * @param {boolean=} params.convert This parameter is deprecated and has no function. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. * @param {string} params.fileId The ID of the file to update. * @param {string=} params.modifiedDateBehavior Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. * @param {boolean=} params.newRevision Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. @@ -5051,7 +5051,7 @@ export namespace drive_v2 { * @param {object} params Parameters for request * @param {string=} params.addParents Comma-separated list of parent IDs to add. * @param {boolean=} params.convert This parameter is deprecated and has no function. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. * @param {string} params.fileId The ID of the file to update. * @param {string=} params.modifiedDateBehavior Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate. * @param {boolean=} params.newRevision Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center. @@ -5227,7 +5227,7 @@ export namespace drive_v2 { */ convert?: boolean; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. */ enforceSingleParent?: boolean; /** @@ -5374,7 +5374,7 @@ export namespace drive_v2 { */ convert?: boolean; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. */ enforceSingleParent?: boolean; /** @@ -5512,7 +5512,7 @@ export namespace drive_v2 { */ convert?: boolean; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. */ enforceSingleParent?: boolean; /** @@ -5649,7 +5649,7 @@ export namespace drive_v2 { */ convert?: boolean; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. */ enforceSingleParent?: boolean; /** @@ -5783,7 +5783,7 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's last parent is removed, the item will be placed under its owner's root. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's last parent is removed, the item is placed under its owner's root. * @param {string} params.fileId The ID of the file. * @param {string} params.parentId The ID of the parent. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5928,7 +5928,7 @@ export namespace drive_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the child's owner makes the request, the child will be removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child's owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. * @param {string} params.fileId The ID of the file. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. @@ -6079,7 +6079,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's last parent is removed, the item will be placed under its owner's root. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's last parent is removed, the item is placed under its owner's root. */ enforceSingleParent?: boolean; /** @@ -6113,7 +6113,7 @@ export namespace drive_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the child's owner makes the request, the child will be removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the child's owner makes the request, the child is removed from all current folders and placed in the requested folder. Any other requests that increase the number of the child's parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. */ enforceSingleParent?: boolean; /** @@ -6385,9 +6385,9 @@ export namespace drive_v2 { * * @param {object} params Parameters for request * @param {string=} params.emailMessage A plain text custom message to include in notification emails. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. * @param {string} params.fileId The ID for the file or shared drive. - * @param {boolean=} params.moveToNewOwnersRoot This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. + * @param {boolean=} params.moveToNewOwnersRoot This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. * @param {boolean=} params.sendNotificationEmails Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. @@ -6777,7 +6777,7 @@ export namespace drive_v2 { */ emailMessage?: string; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. */ enforceSingleParent?: boolean; /** @@ -6785,7 +6785,7 @@ export namespace drive_v2 { */ fileId?: string; /** - * This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. + * This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. */ moveToNewOwnersRoot?: boolean; /** diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 4dadc0116cf..8325aa09170 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -1238,7 +1238,7 @@ export namespace drive_v3 { * @memberOf! () * * @param {object=} params Parameters for request - * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. + * @param {string=} params.driveId The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. * @param {string=} params.teamDriveId Deprecated use driveId instead. @@ -1317,9 +1317,9 @@ export namespace drive_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * @param {string=} params.driveId The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. - * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. * @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.pageSize The maximum number of changes to return per page. @@ -1398,9 +1398,9 @@ export namespace drive_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.driveId The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * @param {string=} params.driveId The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. * @param {boolean=} params.includeCorpusRemovals Whether changes should include the file resource if the file is still accessible by the user at the time of the request, even when a file was removed from the list of changes and there will be no further change entries for this file. - * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. * @param {boolean=} params.includeRemoved Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {integer=} params.pageSize The maximum number of changes to return per page. @@ -1483,7 +1483,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned. + * The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive is returned. */ driveId?: string; /** @@ -1506,7 +1506,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** @@ -1514,7 +1514,7 @@ export namespace drive_v3 { */ includeCorpusRemovals?: boolean; /** - * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. */ includeItemsFromAllDrives?: boolean; /** @@ -1561,7 +1561,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. + * The shared drive from which changes are returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier. */ driveId?: string; /** @@ -1569,7 +1569,7 @@ export namespace drive_v3 { */ includeCorpusRemovals?: boolean; /** - * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. */ includeItemsFromAllDrives?: boolean; /** @@ -2802,7 +2802,7 @@ export namespace drive_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. * @param {string} params.fileId The ID of the file. * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. @@ -2880,7 +2880,7 @@ export namespace drive_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. * @param {boolean=} params.ignoreDefaultVisibility Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders. * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). @@ -3329,7 +3329,7 @@ export namespace drive_v3 { * @param {string=} params.corpora Bodies of items (files/documents) to which the query applies. Supported bodies are 'user', 'domain', 'drive' and 'allDrives'. Prefer 'user' or 'drive' to 'allDrives' for efficiency. * @param {string=} params.corpus The source of files to list. Deprecated: use 'corpora' instead. * @param {string=} params.driveId ID of the shared drive to search. - * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * @param {boolean=} params.includeItemsFromAllDrives Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. * @param {boolean=} params.includeTeamDriveItems Deprecated use includeItemsFromAllDrives instead. * @param {string=} params.orderBy A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. * @param {integer=} params.pageSize The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached. @@ -3407,7 +3407,7 @@ export namespace drive_v3 { * * @param {object} params Parameters for request * @param {string=} params.addParents A comma-separated list of parent IDs to add. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. * @param {string} params.fileId The ID of the file. * @param {boolean=} params.keepRevisionForever Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. * @param {string=} params.ocrLanguage A language hint for OCR processing during image import (ISO 639-1 code). @@ -3569,7 +3569,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. */ enforceSingleParent?: boolean; /** @@ -3609,7 +3609,7 @@ export namespace drive_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail. */ enforceSingleParent?: boolean; /** @@ -3755,7 +3755,7 @@ export namespace drive_v3 { */ driveId?: string; /** - * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items will be included in the results. + * Deprecated - Whether both My Drive and shared drive items should be included in results. This parameter will only be effective until June 1, 2020. Afterwards shared drive items are included in the results. */ includeItemsFromAllDrives?: boolean; /** @@ -3806,7 +3806,7 @@ export namespace drive_v3 { */ addParents?: string; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item will be removed from all current folders and placed in the requested folder. Other requests that increase the number of parents will fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added. */ enforceSingleParent?: boolean; /** @@ -3901,9 +3901,9 @@ export namespace drive_v3 { * * @param {object} params Parameters for request * @param {string=} params.emailMessage A plain text custom message to include in the notification email. - * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. + * @param {boolean=} params.enforceSingleParent Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. * @param {string} params.fileId The ID of the file or shared drive. - * @param {boolean=} params.moveToNewOwnersRoot This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. + * @param {boolean=} params.moveToNewOwnersRoot This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. * @param {boolean=} params.sendNotificationEmail Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers. * @param {boolean=} params.supportsAllDrives Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. * @param {boolean=} params.supportsTeamDrives Deprecated use supportsAllDrives instead. @@ -4298,7 +4298,7 @@ export namespace drive_v3 { */ emailMessage?: string; /** - * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. + * Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. See moveToNewOwnersRoot for details. */ enforceSingleParent?: boolean; /** @@ -4306,7 +4306,7 @@ export namespace drive_v3 { */ fileId?: string; /** - * This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. + * This parameter only takes effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. When set to true, the item is moved to the new owner's My Drive root folder and all prior parents removed. If set to false, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive. */ moveToNewOwnersRoot?: boolean; /** diff --git a/src/apis/driveactivity/v2.ts b/src/apis/driveactivity/v2.ts index 595a8b86668..6c53e774aaf 100644 --- a/src/apis/driveactivity/v2.ts +++ b/src/apis/driveactivity/v2.ts @@ -660,7 +660,7 @@ export namespace driveactivity_v2 { */ ancestorName?: string | null; /** - * Details on how to consolidate related actions that make up the activity. If not set, then related actions will not be consolidated. + * Details on how to consolidate related actions that make up the activity. If not set, then related actions are not consolidated. */ consolidationStrategy?: Schema$ConsolidationStrategy; /** @@ -672,7 +672,7 @@ export namespace driveactivity_v2 { */ itemName?: string | null; /** - * The requested number of activity to return. If not set, a default value will be used. + * The requested number of activities to return. If not set, a default value is used. */ pageSize?: number | null; /** diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index e5e5739e952..9bfe72bd3f5 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -311,7 +311,7 @@ export namespace file_v1 { */ createTime?: string | null; /** - * Optional. The description of the instance (2048 characters or less). + * The description of the instance (2048 characters or less). */ description?: string | null; /** @@ -737,8 +737,8 @@ export namespace file_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.instanceId The name of the instance to create. The name must be unique for the specified project and location. - * @param {string} params.parent The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. + * @param {string=} params.instanceId Required. The name of the instance to create. The name must be unique for the specified project and location. + * @param {string} params.parent Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. * @param {().Instance} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -813,7 +813,7 @@ export namespace file_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} + * @param {string} params.name Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_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 @@ -884,7 +884,7 @@ export namespace file_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. + * @param {string} params.name Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_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 @@ -957,7 +957,7 @@ export namespace file_v1 { * @param {string=} params.orderBy Sort results. Supported values are "name", "name desc" or "" (unsorted). * @param {integer=} params.pageSize The maximum number of items to return. * @param {string=} params.pageToken The next_page_token value to use if there are additional results to retrieve for this list request. - * @param {string} params.parent The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. + * @param {string} params.parent Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1108,11 +1108,11 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the instance to create. The name must be unique for the specified project and location. + * Required. The name of the instance to create. The name must be unique for the specified project and location. */ instanceId?: string; /** - * The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. + * Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. */ parent?: string; @@ -1129,7 +1129,7 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} + * Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} */ name?: string; } @@ -1141,7 +1141,7 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. + * Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. */ name?: string; } @@ -1169,7 +1169,7 @@ export namespace file_v1 { */ pageToken?: string; /** - * The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. + * Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. */ parent?: string; } diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index efdb28e705f..fe872d6beb5 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -311,7 +311,7 @@ export namespace file_v1beta1 { */ createTime?: string | null; /** - * Optional. The description of the instance (2048 characters or less). + * The description of the instance (2048 characters or less). */ description?: string | null; /** @@ -737,8 +737,8 @@ export namespace file_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.instanceId The name of the instance to create. The name must be unique for the specified project and location. - * @param {string} params.parent The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. + * @param {string=} params.instanceId Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + * @param {string} params.parent Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. * @param {().Instance} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -813,7 +813,7 @@ export namespace file_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} + * @param {string} params.name Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_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 @@ -884,7 +884,7 @@ export namespace file_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. + * @param {string} params.name Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_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 @@ -957,7 +957,7 @@ export namespace file_v1beta1 { * @param {string=} params.orderBy Sort results. Supported values are "name", "name desc" or "" (unsorted). * @param {integer=} params.pageSize The maximum number of items to return. * @param {string=} params.pageToken The next_page_token value to use if there are additional results to retrieve for this list request. - * @param {string} params.parent The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. + * @param {string} params.parent Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1034,7 +1034,7 @@ export namespace file_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. - * @param {string=} params.updateMask Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" + * @param {string=} params.updateMask Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" * @param {().Instance} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1108,11 +1108,11 @@ export namespace file_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the instance to create. The name must be unique for the specified project and location. + * Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. */ instanceId?: string; /** - * The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. + * Required. The instance's project and location, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. */ parent?: string; @@ -1129,7 +1129,7 @@ export namespace file_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} + * Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} */ name?: string; } @@ -1141,7 +1141,7 @@ export namespace file_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. + * Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. */ name?: string; } @@ -1169,7 +1169,7 @@ export namespace file_v1beta1 { */ pageToken?: string; /** - * The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. + * Required. The project and location for which to retrieve instance information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use "-" for the {location} value. */ parent?: string; } @@ -1185,7 +1185,7 @@ export namespace file_v1beta1 { */ name?: string; /** - * Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" + * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" */ updateMask?: string; diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index 039dc5832c6..55abe0f88de 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -290,6 +290,9 @@ export namespace firebasehosting_v1beta1 { */ regex?: string | null; } + /** + * The response to listing Domains. + */ export interface Schema$ListDomainsResponse { /** * The list of domains, if any exist. @@ -300,6 +303,9 @@ export namespace firebasehosting_v1beta1 { */ nextPageToken?: string | null; } + /** + * The response when listing Releases. + */ export interface Schema$ListReleasesResponse { /** * If there are additional releases remaining beyond the ones in this response, then supply this token in the next [`list`](../sites.versions.files/list) call to continue with the next set of releases. @@ -310,6 +316,9 @@ export namespace firebasehosting_v1beta1 { */ releases?: Schema$Release[]; } + /** + * The response when listing a Version's Files.. + */ export interface Schema$ListVersionFilesResponse { /** * The list path/hashes in the specified version. @@ -320,6 +329,9 @@ export namespace firebasehosting_v1beta1 { */ nextPageToken?: string | null; } + /** + * The response when listing Versions. + */ export interface Schema$ListVersionsResponse { /** * The pagination token, if more results exist @@ -364,12 +376,18 @@ export namespace firebasehosting_v1beta1 { */ regexes?: string[] | null; } + /** + * The request to populate a Version's Files. + */ export interface Schema$PopulateVersionFilesRequest { /** * A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file. */ files?: {[key: string]: string} | null; } + /** + * The response to a PopulateVersionFilesRequest. + */ export interface Schema$PopulateVersionFilesResponse { /** * The content hashes of the specified files that need to be uploaded to the specified endpoint. @@ -708,73 +726,59 @@ export namespace firebasehosting_v1beta1 { export class Resource$Projects$Sites { context: APIRequestContext; channels: Resource$Projects$Sites$Channels; + domains: Resource$Projects$Sites$Domains; releases: Resource$Projects$Sites$Releases; + versions: Resource$Projects$Sites$Versions; constructor(context: APIRequestContext) { this.context = context; this.channels = new Resource$Projects$Sites$Channels(this.context); + this.domains = new Resource$Projects$Sites$Domains(this.context); this.releases = new Resource$Projects$Sites$Releases(this.context); - } - } - - export class Resource$Projects$Sites$Channels { - context: APIRequestContext; - releases: Resource$Projects$Sites$Channels$Releases; - constructor(context: APIRequestContext) { - this.context = context; - this.releases = new Resource$Projects$Sites$Channels$Releases( - this.context - ); - } - } - - export class Resource$Projects$Sites$Channels$Releases { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + this.versions = new Resource$Projects$Sites$Versions(this.context); } /** - * firebasehosting.projects.sites.channels.releases.create - * @desc Creates a new release which makes the content of the specified version actively display on the appropriate URL(s). - * @alias firebasehosting.projects.sites.channels.releases.create + * firebasehosting.projects.sites.getConfig + * @desc Gets the Hosting metadata for a specific site. + * @alias firebasehosting.projects.sites.getConfig * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The site that the release belongs to, in the format: sites/site-name - * @param {string=} params.versionName The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. - * @param {().Release} params.requestBody Request body data + * @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 */ - create( - params?: Params$Resource$Projects$Sites$Channels$Releases$Create, + getConfig( + params?: Params$Resource$Projects$Sites$Getconfig, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Sites$Channels$Releases$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + getConfig( + params: Params$Resource$Projects$Sites$Getconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Sites$Channels$Releases$Create, - callback: BodyResponseCallback + getConfig( + params: Params$Resource$Projects$Sites$Getconfig, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + getConfig(callback: BodyResponseCallback): void; + getConfig( paramsOrCallback?: - | Params$Resource$Projects$Sites$Channels$Releases$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Sites$Getconfig + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Sites$Channels$Releases$Create; + {}) as Params$Resource$Projects$Sites$Getconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sites$Channels$Releases$Create; + params = {} as Params$Resource$Projects$Sites$Getconfig; options = {}; } @@ -788,72 +792,67 @@ export namespace firebasehosting_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/releases').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * firebasehosting.projects.sites.channels.releases.list - * @desc Lists the releases that have been created on the specified site. - * @alias firebasehosting.projects.sites.channels.releases.list + * firebasehosting.projects.sites.updateConfig + * @desc Sets the Hosting metadata for a specific site. + * @alias firebasehosting.projects.sites.updateConfig * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.pageSize The page size to return. Defaults to 100. - * @param {string=} params.pageToken The next_page_token from a previous request, if provided. - * @param {string} params.parent Required. The parent for which to list files, in the format: sites/site-name + * @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.requestBody Request body data * @param {object} [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$Sites$Channels$Releases$List, + updateConfig( + params?: Params$Resource$Projects$Sites$Updateconfig, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Sites$Channels$Releases$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + updateConfig( + params: Params$Resource$Projects$Sites$Updateconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Sites$Channels$Releases$List, - callback: BodyResponseCallback + updateConfig( + params: Params$Resource$Projects$Sites$Updateconfig, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + updateConfig(callback: BodyResponseCallback): void; + updateConfig( paramsOrCallback?: - | Params$Resource$Projects$Sites$Channels$Releases$List - | BodyResponseCallback, + | Params$Resource$Projects$Sites$Updateconfig + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Sites$Channels$Releases$List; + {}) as Params$Resource$Projects$Sites$Updateconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sites$Channels$Releases$List; + params = {} as Params$Resource$Projects$Sites$Updateconfig; options = {}; } @@ -867,28 +866,25 @@ export namespace firebasehosting_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/releases').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Sites$Channels$Releases$Create + export interface Params$Resource$Projects$Sites$Getconfig extends StandardParameters { /** * Auth client or API Key for the request @@ -896,20 +892,11 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The site that the release belongs to, in the format: sites/site-name - */ - parent?: string; - /** - * The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. - */ - versionName?: string; - - /** - * Request body metadata + * Required. The site for which to get the SiteConfig, in the format: sites/site-name/config */ - requestBody?: Schema$Release; + name?: string; } - export interface Params$Resource$Projects$Sites$Channels$Releases$List + export interface Params$Resource$Projects$Sites$Updateconfig extends StandardParameters { /** * Auth client or API Key for the request @@ -917,33 +904,45 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The page size to return. Defaults to 100. + * Required. The site for which to update the SiteConfig, in the format: sites/site-name/config */ - pageSize?: number; + name?: string; /** - * The next_page_token from a previous request, if provided. + * 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. */ - pageToken?: string; + updateMask?: string; + /** - * Required. The parent for which to list files, in the format: sites/site-name + * Request body metadata */ - parent?: string; + requestBody?: Schema$SiteConfig; } - export class Resource$Projects$Sites$Releases { + export class Resource$Projects$Sites$Channels { + context: APIRequestContext; + releases: Resource$Projects$Sites$Channels$Releases; + constructor(context: APIRequestContext) { + this.context = context; + this.releases = new Resource$Projects$Sites$Channels$Releases( + this.context + ); + } + } + + export class Resource$Projects$Sites$Channels$Releases { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * firebasehosting.projects.sites.releases.create + * firebasehosting.projects.sites.channels.releases.create * @desc Creates a new release which makes the content of the specified version actively display on the appropriate URL(s). - * @alias firebasehosting.projects.sites.releases.create + * @alias firebasehosting.projects.sites.channels.releases.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The site that the release belongs to, in the format: sites/site-name + * @param {string} params.parent Required. The site that the release belongs to, in the format: sites/site-name * @param {string=} params.versionName The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. * @param {().Release} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -951,33 +950,33 @@ export namespace firebasehosting_v1beta1 { * @return {object} Request object */ create( - params?: Params$Resource$Projects$Sites$Releases$Create, + params?: Params$Resource$Projects$Sites$Channels$Releases$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Sites$Releases$Create, + params: Params$Resource$Projects$Sites$Channels$Releases$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Sites$Releases$Create, + params: Params$Resource$Projects$Sites$Channels$Releases$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Sites$Releases$Create + | Params$Resource$Projects$Sites$Channels$Releases$Create | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Sites$Releases$Create; + {}) as Params$Resource$Projects$Sites$Channels$Releases$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sites$Releases$Create; + params = {} as Params$Resource$Projects$Sites$Channels$Releases$Create; options = {}; } @@ -1012,9 +1011,9 @@ export namespace firebasehosting_v1beta1 { } /** - * firebasehosting.projects.sites.releases.list + * firebasehosting.projects.sites.channels.releases.list * @desc Lists the releases that have been created on the specified site. - * @alias firebasehosting.projects.sites.releases.list + * @alias firebasehosting.projects.sites.channels.releases.list * @memberOf! () * * @param {object} params Parameters for request @@ -1026,24 +1025,24 @@ export namespace firebasehosting_v1beta1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Sites$Releases$List, + params?: Params$Resource$Projects$Sites$Channels$Releases$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Sites$Releases$List, + params: Params$Resource$Projects$Sites$Channels$Releases$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Sites$Releases$List, + params: Params$Resource$Projects$Sites$Channels$Releases$List, callback: BodyResponseCallback ): void; list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Sites$Releases$List + | Params$Resource$Projects$Sites$Channels$Releases$List | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -1051,12 +1050,12 @@ export namespace firebasehosting_v1beta1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Sites$Releases$List; + {}) as Params$Resource$Projects$Sites$Channels$Releases$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Sites$Releases$List; + params = {} as Params$Resource$Projects$Sites$Channels$Releases$List; options = {}; } @@ -1091,7 +1090,7 @@ export namespace firebasehosting_v1beta1 { } } - export interface Params$Resource$Projects$Sites$Releases$Create + export interface Params$Resource$Projects$Sites$Channels$Releases$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -1099,7 +1098,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The site that the release belongs to, in the format: sites/site-name + * Required. The site that the release belongs to, in the format: sites/site-name */ parent?: string; /** @@ -1112,7 +1111,7 @@ export namespace firebasehosting_v1beta1 { */ requestBody?: Schema$Release; } - export interface Params$Resource$Projects$Sites$Releases$List + export interface Params$Resource$Projects$Sites$Channels$Releases$List extends StandardParameters { /** * Auth client or API Key for the request @@ -1133,6 +1132,1354 @@ export namespace firebasehosting_v1beta1 { parent?: string; } + export class Resource$Projects$Sites$Domains { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebasehosting.projects.sites.domains.create + * @desc Creates a domain mapping on the specified site. + * @alias firebasehosting.projects.sites.domains.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent to create the domain association for, in the format: sites/site-name + * @param {().Domain} params.requestBody Request body data + * @param {object} [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$Sites$Domains$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Sites$Domains$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Sites$Domains$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Domains$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Domains$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Domains$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/domains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.domains.delete + * @desc Deletes the existing domain mapping on the specified site. + * @alias firebasehosting.projects.sites.domains.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the domain association to delete. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Sites$Domains$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Sites$Domains$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Sites$Domains$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Domains$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Domains$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Domains$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.domains.get + * @desc Gets a domain mapping on the specified site. + * @alias firebasehosting.projects.sites.domains.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the domain configuration to get. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Sites$Domains$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Sites$Domains$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Sites$Domains$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Domains$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Domains$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Domains$Get; + 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.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.domains.list + * @desc Lists the domains for the specified site. + * @alias firebasehosting.projects.sites.domains.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The page size to return. Defaults to 50. + * @param {string=} params.pageToken The next_page_token from a previous request, if provided. + * @param {string} params.parent Required. The parent for which to list domains, in the format: sites/site-name + * @param {object} [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$Sites$Domains$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Sites$Domains$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Sites$Domains$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Domains$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Domains$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Domains$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/domains').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.domains.update + * @desc Updates the specified domain mapping, creating the mapping as if it does not exist. + * @alias firebasehosting.projects.sites.domains.update + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the domain association to update or create, if an association doesn't already exist. + * @param {().Domain} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + update( + params?: Params$Resource$Projects$Sites$Domains$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Sites$Domains$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Sites$Domains$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Domains$Update + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Domains$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Domains$Update; + 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: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Sites$Domains$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent to create the domain association for, in the format: sites/site-name + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Domain; + } + export interface Params$Resource$Projects$Sites$Domains$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the domain association to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Sites$Domains$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the domain configuration to get. + */ + name?: string; + } + export interface Params$Resource$Projects$Sites$Domains$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The page size to return. Defaults to 50. + */ + pageSize?: number; + /** + * The next_page_token from a previous request, if provided. + */ + pageToken?: string; + /** + * Required. The parent for which to list domains, in the format: sites/site-name + */ + parent?: string; + } + export interface Params$Resource$Projects$Sites$Domains$Update + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the domain association to update or create, if an association doesn't already exist. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Domain; + } + + export class Resource$Projects$Sites$Releases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebasehosting.projects.sites.releases.create + * @desc Creates a new release which makes the content of the specified version actively display on the appropriate URL(s). + * @alias firebasehosting.projects.sites.releases.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The site that the release belongs to, in the format: sites/site-name + * @param {string=} params.versionName The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. + * @param {().Release} params.requestBody Request body data + * @param {object} [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$Sites$Releases$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Sites$Releases$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Sites$Releases$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Releases$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Releases$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Releases$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/releases').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.releases.list + * @desc Lists the releases that have been created on the specified site. + * @alias firebasehosting.projects.sites.releases.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The page size to return. Defaults to 100. + * @param {string=} params.pageToken The next_page_token from a previous request, if provided. + * @param {string} params.parent Required. The parent for which to list files, in the format: sites/site-name + * @param {object} [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$Sites$Releases$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Sites$Releases$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Sites$Releases$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Releases$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Releases$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Releases$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/releases').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Sites$Releases$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The site that the release belongs to, in the format: sites/site-name + */ + parent?: string; + /** + * The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. + */ + versionName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Release; + } + export interface Params$Resource$Projects$Sites$Releases$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The page size to return. Defaults to 100. + */ + pageSize?: number; + /** + * The next_page_token from a previous request, if provided. + */ + pageToken?: string; + /** + * Required. The parent for which to list files, in the format: sites/site-name + */ + parent?: string; + } + + export class Resource$Projects$Sites$Versions { + context: APIRequestContext; + files: Resource$Projects$Sites$Versions$Files; + constructor(context: APIRequestContext) { + this.context = context; + this.files = new Resource$Projects$Sites$Versions$Files(this.context); + } + + /** + * firebasehosting.projects.sites.versions.clone + * @desc Creates a new version on the target site using the content of the specified version. + * @alias firebasehosting.projects.sites.versions.clone + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The target site where the cloned version will reside, in the format: `sites/{site}` + * @param {().CloneVersionRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + clone( + params?: Params$Resource$Projects$Sites$Versions$Clone, + options?: MethodOptions + ): GaxiosPromise; + clone( + params: Params$Resource$Projects$Sites$Versions$Clone, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + clone( + params: Params$Resource$Projects$Sites$Versions$Clone, + callback: BodyResponseCallback + ): void; + clone(callback: BodyResponseCallback): void; + clone( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Versions$Clone + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Versions$Clone; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Versions$Clone; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/versions:clone').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.versions.create + * @desc Creates a new version for a site. + * @alias firebasehosting.projects.sites.versions.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent to create the version for, in the format: sites/site-name + * @param {string=} params.sizeBytes The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads. + * @param {string=} params.versionId A unique id for the new version. This is only specified for legacy version creations. + * @param {().Version} params.requestBody Request body data + * @param {object} [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$Sites$Versions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Sites$Versions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Sites$Versions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Versions$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Versions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Versions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.versions.delete + * @desc Deletes the specified version. + * @alias firebasehosting.projects.sites.versions.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the version to be deleted, in the format: sites/site-name/versions/versionID + * @param {object} [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$Sites$Versions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Sites$Versions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Sites$Versions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Versions$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Versions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Versions$Delete; + 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: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.versions.list + * @desc Lists the versions that have been created on the specified site. Will include filtering in the future. + * @alias firebasehosting.projects.sites.versions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering. + * @param {integer=} params.pageSize The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100 + * @param {string=} params.pageToken The next_page_token from a previous request, if provided. + * @param {string} params.parent Required. The parent for which to list files, in the format: sites/site-name + * @param {object} [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$Sites$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Sites$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Sites$Versions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Versions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/versions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.versions.patch + * @desc Updates the specified metadata for a version. Note that this method will fail with `FAILED_PRECONDITION` in the event of an invalid state transition. The only valid transition for a version is currently from a `CREATED` status to a `FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the status of a version to `DELETED`. + * @alias firebasehosting.projects.sites.versions.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The unique identifier for a version, in the format: sites/site-name/versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint. + * @param {string=} params.updateMask A set of field names from your [version](../sites.versions) 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 [`status`](../sites.versions#Version.FIELDS.status) will be used. + * @param {().Version} params.requestBody Request body data + * @param {object} [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$Sites$Versions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Sites$Versions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Sites$Versions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Versions$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Versions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Versions$Patch; + 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.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebasehosting.projects.sites.versions.populateFiles + * @desc Adds content files to a version. + * @alias firebasehosting.projects.sites.versions.populateFiles + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The version to add files to, in the format: sites/site-name/versions/versionID + * @param {().PopulateVersionFilesRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + populateFiles( + params?: Params$Resource$Projects$Sites$Versions$Populatefiles, + options?: MethodOptions + ): GaxiosPromise; + populateFiles( + params: Params$Resource$Projects$Sites$Versions$Populatefiles, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + populateFiles( + params: Params$Resource$Projects$Sites$Versions$Populatefiles, + callback: BodyResponseCallback + ): void; + populateFiles( + callback: BodyResponseCallback + ): void; + populateFiles( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Versions$Populatefiles + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Versions$Populatefiles; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Versions$Populatefiles; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}:populateFiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Sites$Versions$Clone + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The target site where the cloned version will reside, in the format: `sites/{site}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloneVersionRequest; + } + export interface Params$Resource$Projects$Sites$Versions$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent to create the version for, in the format: sites/site-name + */ + parent?: string; + /** + * The self-reported size of the version. This value is used for a pre-emptive quota check for legacy version uploads. + */ + sizeBytes?: string; + /** + * A unique id for the new version. This is only specified for legacy version creations. + */ + versionId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Version; + } + export interface Params$Resource$Projects$Sites$Versions$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the version to be deleted, in the format: sites/site-name/versions/versionID + */ + name?: string; + } + export interface Params$Resource$Projects$Sites$Versions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The filter string used to return a subset of versions in the response. Currently supported fields for filtering are: name, status, and create_time. Filter processing will be implemented in accordance with go/filtering. + */ + filter?: string; + /** + * The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 25 versions will be returned. The maximum value is 100; values above 100 will be coerced to 100 + */ + pageSize?: number; + /** + * The next_page_token from a previous request, if provided. + */ + pageToken?: string; + /** + * Required. The parent for which to list files, in the format: sites/site-name + */ + parent?: string; + } + export interface Params$Resource$Projects$Sites$Versions$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The unique identifier for a version, in the format: sites/site-name/versions/versionID This name is provided in the response body when you call the [`CreateVersion`](../sites.versions/create) endpoint. + */ + name?: string; + /** + * A set of field names from your [version](../sites.versions) 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 [`status`](../sites.versions#Version.FIELDS.status) will be used. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Version; + } + export interface Params$Resource$Projects$Sites$Versions$Populatefiles + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The version to add files to, in the format: sites/site-name/versions/versionID + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PopulateVersionFilesRequest; + } + + export class Resource$Projects$Sites$Versions$Files { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebasehosting.projects.sites.versions.files.list + * @desc Lists the remaining files to be uploaded for the specified version. + * @alias firebasehosting.projects.sites.versions.files.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The page size to return. Defaults to 1000. + * @param {string=} params.pageToken The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken. + * @param {string} params.parent Required. The parent to list files for, in the format: sites/site-name/versions/versionID + * @param {string=} params.status The type of files in the version that should be listed. + * @param {object} [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$Sites$Versions$Files$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Sites$Versions$Files$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Sites$Versions$Files$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Sites$Versions$Files$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Sites$Versions$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Sites$Versions$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/files').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Sites$Versions$Files$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The page size to return. Defaults to 1000. + */ + pageSize?: number; + /** + * The next_page_token from a previous request, if provided. This will be the encoded version of a firebase.hosting.proto.metadata.ListFilesPageToken. + */ + pageToken?: string; + /** + * Required. The parent to list files for, in the format: sites/site-name/versions/versionID + */ + parent?: string; + /** + * The type of files in the version that should be listed. + */ + status?: string; + } + export class Resource$Sites { context: APIRequestContext; channels: Resource$Sites$Channels; @@ -1348,7 +2695,7 @@ export namespace firebasehosting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The site that the release belongs to, in the format: sites/site-name + * @param {string} params.parent Required. The site that the release belongs to, in the format: sites/site-name * @param {string=} params.versionName The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. * @param {().Release} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1504,7 +2851,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The site that the release belongs to, in the format: sites/site-name + * Required. The site that the release belongs to, in the format: sites/site-name */ parent?: string; /** @@ -1999,7 +3346,7 @@ export namespace firebasehosting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The site that the release belongs to, in the format: sites/site-name + * @param {string} params.parent Required. The site that the release belongs to, in the format: sites/site-name * @param {string=} params.versionName The unique identifier for a version, in the format: /sites/site-name/versions/versionID The site-name in this version identifier must match the site-name in the `parent` parameter.

This query parameter must be empty if the `type` field in the request body is `SITE_DISABLE`. * @param {().Release} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2155,7 +3502,7 @@ export namespace firebasehosting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The site that the release belongs to, in the format: sites/site-name + * Required. The site that the release belongs to, in the format: sites/site-name */ parent?: string; /** diff --git a/src/apis/firebaseml/README.md b/src/apis/firebaseml/README.md new file mode 100644 index 00000000000..0b14a6345d9 --- /dev/null +++ b/src/apis/firebaseml/README.md @@ -0,0 +1,47 @@ +Google Inc. logo + +# firebaseml + +> Access custom machine learning models hosted via Firebase ML. + +## Installation + +```sh +$ npm install googleapis +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). + +## Building a browser bundle + +This library can be used in a browser. To prepare a single file bundle, clone the +[repository](https://github.com/googleapis/google-api-nodejs-client) and run + +```sh +$ cd src/apis/firebaseml +$ npm install +$ npm run webpack +``` + +The generated bundle will be written to `dist/firebaseml.min.js`. Use it from your HTML file: + +```html + + +``` + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/master/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/master/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/firebaseml/index.ts b/src/apis/firebaseml/index.ts new file mode 100644 index 00000000000..3c8f9cfc3ab --- /dev/null +++ b/src/apis/firebaseml/index.ts @@ -0,0 +1,35 @@ +// Copyright 2019 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {firebaseml_v1beta2} from './v1beta2'; + +export const VERSIONS = { + v1beta2: firebaseml_v1beta2.Firebaseml, +}; + +export function firebaseml(version: 'v1beta2'): firebaseml_v1beta2.Firebaseml; +export function firebaseml( + options: firebaseml_v1beta2.Options +): firebaseml_v1beta2.Firebaseml; +export function firebaseml( + this: GoogleConfigurable, + versionOrOptions: 'v1beta2' | firebaseml_v1beta2.Options +) { + return getAPI('firebaseml', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; diff --git a/src/apis/firebaseml/package.json b/src/apis/firebaseml/package.json new file mode 100644 index 00000000000..29b4be4b33d --- /dev/null +++ b/src/apis/firebaseml/package.json @@ -0,0 +1,43 @@ +{ + "name": "@google/firebaseml", + "version": "0.1.0", + "description": "firebaseml", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=8.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "docs": "typedoc --out docs/", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^4.0.0" + }, + "devDependencies": { + "gts": "^1.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^7.0.0", + "typedoc": "^0.17.0", + "typescript": "~3.7.0", + "webpack": "^4.35.3", + "webpack-cli": "^3.3.5" + } +} diff --git a/src/apis/firebaseml/tsconfig.json b/src/apis/firebaseml/tsconfig.json new file mode 100644 index 00000000000..e0810904968 --- /dev/null +++ b/src/apis/firebaseml/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/firebaseml/v1beta2.ts b/src/apis/firebaseml/v1beta2.ts new file mode 100644 index 00000000000..f8eb30db5d4 --- /dev/null +++ b/src/apis/firebaseml/v1beta2.ts @@ -0,0 +1,817 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace firebaseml_v1beta2 { + export interface Options extends GlobalOptions { + version: 'v1beta2'; + } + + 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; + } + + /** + * Firebase ML API + * + * Access custom machine learning models hosted via Firebase ML. + * + * @example + * const {google} = require('googleapis'); + * const firebaseml = google.firebaseml('v1beta2'); + * + * @namespace firebaseml + * @type {Function} + * @version v1beta2 + * @variation v1beta2 + * @param {object=} options Options for Firebaseml + */ + export class Firebaseml { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * 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 {} + /** + * The response for list models + */ + export interface Schema$ListModelsResponse { + /** + * The list of models + */ + models?: Schema$Model[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + } + /** + * An ML model hosted in Firebase ML + */ + export interface Schema$Model { + /** + * Output only. Lists operation ids associated with this model whose status is NOT done. + */ + activeOperations?: Schema$Operation[]; + /** + * Output only. Timestamp when this model was created in Firebase ML. + */ + createTime?: string | null; + /** + * Required. The name of the model to create. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) and ASCII digits 0-9. It must start with a letter. + */ + displayName?: string | null; + /** + * Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3 + */ + etag?: string | null; + /** + * Output only. The model_hash will change if a new file is available for download. + */ + modelHash?: string | null; + /** + * The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model. + */ + name?: string | null; + /** + * State common to all model types. Includes publishing and validation information. + */ + state?: Schema$ModelState; + /** + * User defined tags which can be used to group/filter models during listing + */ + tags?: string[] | null; + /** + * A TFLite Model + */ + tfliteModel?: Schema$TfLiteModel; + /** + * Output only. Timestamp when this model was updated in Firebase ML. + */ + updateTime?: string | null; + } + /** + * This is returned in the longrunning operations for create/update. + */ + export interface Schema$ModelOperationMetadata { + basicOperationStatus?: string | null; + /** + * The name of the model we are creating/updating The name must have the form `projects/{project_id}/models/{model_id}` + */ + name?: string | null; + } + /** + * State common to all model types. Includes publishing and validation information. + */ + export interface Schema$ModelState { + /** + * Indicates if this model has been published. + */ + published?: boolean | null; + /** + * Output only. Indicates the latest validation error on the model if any. A model may have validation errors if there were problems during the model creation/update. e.g. in the case of a TfLiteModel, if a tflite model file was missing or in the wrong format. This field will be empty for valid models. + */ + validationError?: Schema$Status; + } + /** + * 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 | null; + /** + * 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} | null; + /** + * 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 be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * 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} | null; + } + /** + * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * 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}> | null; + /** + * 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 | null; + } + /** + * Information that is specific to TfLite models. + */ + export interface Schema$TfLiteModel { + /** + * The TfLite file containing the model. (Stored in Google Cloud). The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If you update the file in the original location, it is necessary to call UpdateModel for ML to pick up and validate the updated file. + */ + gcsTfliteUri?: string | null; + /** + * Output only. The size of the TFLite model + */ + sizeBytes?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + models: Resource$Projects$Models; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.models = new Resource$Projects$Models(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + } + + export class Resource$Projects$Models { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebaseml.projects.models.create + * @desc Creates a model in Firebase ML. The longrunning operation will eventually return a Model + * @alias firebaseml.projects.models.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent project resource where the model is to be created. The parent must have the form `projects/{project_id}` + * @param {().Model} params.requestBody Request body data + * @param {object} [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$Models$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Models$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Models$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Models$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Models$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Models$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebaseml.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/models').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebaseml.projects.models.delete + * @desc Deletes a model + * @alias firebaseml.projects.models.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the model to delete. The name must have the form `projects/{project_id}/models/{model_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$Models$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Models$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Models$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Models$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Models$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Models$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebaseml.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebaseml.projects.models.get + * @desc Gets a model resource. + * @alias firebaseml.projects.models.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the model to get. The name must have the form `projects/{project_id}/models/{model_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$Models$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Models$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Models$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Models$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Models$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Models$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebaseml.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebaseml.projects.models.list + * @desc Lists the models + * @alias firebaseml.projects.models.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter for the list e.g. 'tags: abc' to list models which are tagged with "abc" + * @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. The name of the parent to list models for. The parent must have the form `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 + */ + list( + params?: Params$Resource$Projects$Models$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Models$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Models$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Models$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Models$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Models$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebaseml.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+parent}/models').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * firebaseml.projects.models.patch + * @desc Updates a model. The longrunning operation will eventually return a Model. + * @alias firebaseml.projects.models.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model. + * @param {string=} params.updateMask The update mask + * @param {().Model} params.requestBody Request body data + * @param {object} [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$Models$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Models$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Models$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Models$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Models$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Models$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebaseml.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Models$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent project resource where the model is to be created. The parent must have the form `projects/{project_id}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Model; + } + export interface Params$Resource$Projects$Models$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the model to delete. The name must have the form `projects/{project_id}/models/{model_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Models$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the model to get. The name must have the form `projects/{project_id}/models/{model_id}` + */ + name?: string; + } + export interface Params$Resource$Projects$Models$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter for the list e.g. 'tags: abc' to list models which are tagged with "abc" + */ + 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. The name of the parent to list models for. The parent must have the form `projects/{project_id}' + */ + parent?: string; + } + export interface Params$Resource$Projects$Models$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the Model. Model names have the form `projects/{project_id}/models/{model_id}` The name is ignored when creating a model. + */ + name?: string; + /** + * The update mask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Model; + } + + export class Resource$Projects$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebaseml.projects.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 firebaseml.projects.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://firebaseml.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$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; + } +} diff --git a/src/apis/firebaseml/webpack.config.js b/src/apis/firebaseml/webpack.config.js new file mode 100644 index 00000000000..09780bde9f0 --- /dev/null +++ b/src/apis/firebaseml/webpack.config.js @@ -0,0 +1,69 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, + output: { + library: 'Firebaseml', + filename: 'firebaseml.min.js', + path: path.resolve(__dirname, 'dist'), + }, + node: { + child_process: 'empty', + fs: 'empty', + crypto: 'empty', + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/gameservices/v1beta.ts b/src/apis/gameservices/v1beta.ts index d55c7c108a1..bad6011a67d 100644 --- a/src/apis/gameservices/v1beta.ts +++ b/src/apis/gameservices/v1beta.ts @@ -992,7 +992,7 @@ export namespace gameservices_v1beta { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } @@ -2056,7 +2056,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @alias gameservices.projects.locations.gameServerDeployments.setIamPolicy * @memberOf! () * @@ -2129,7 +2129,7 @@ export namespace gameservices_v1beta { /** * gameservices.projects.locations.gameServerDeployments.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias gameservices.projects.locations.gameServerDeployments.testIamPermissions * @memberOf! () * diff --git a/src/apis/genomics/v2alpha1.ts b/src/apis/genomics/v2alpha1.ts index 95a0e5efd5a..4048e4f6acd 100644 --- a/src/apis/genomics/v2alpha1.ts +++ b/src/apis/genomics/v2alpha1.ts @@ -937,9 +937,11 @@ export namespace genomics_v2alpha1 { export class Resource$Projects { context: APIRequestContext; operations: Resource$Projects$Operations; + workers: Resource$Projects$Workers; constructor(context: APIRequestContext) { this.context = context; this.operations = new Resource$Projects$Operations(this.context); + this.workers = new Resource$Projects$Workers(this.context); } } @@ -1376,6 +1378,106 @@ export namespace genomics_v2alpha1 { pageToken?: string; } + export class Resource$Projects$Workers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * genomics.projects.workers.checkIn + * @desc The worker uses this method to retrieve the assigned operation and provide periodic status updates. + * @alias genomics.projects.workers.checkIn + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.id The worker id, assigned when it was created. + * @param {().CheckInRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + checkIn( + params?: Params$Resource$Projects$Workers$Checkin, + options?: MethodOptions + ): GaxiosPromise; + checkIn( + params: Params$Resource$Projects$Workers$Checkin, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + checkIn( + params: Params$Resource$Projects$Workers$Checkin, + callback: BodyResponseCallback + ): void; + checkIn(callback: BodyResponseCallback): void; + checkIn( + paramsOrCallback?: + | Params$Resource$Projects$Workers$Checkin + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Workers$Checkin; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Workers$Checkin; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://genomics.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha1/{+id}:checkIn').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['id'], + pathParams: ['id'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Workers$Checkin + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The worker id, assigned when it was created. + */ + id?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CheckInRequest; + } + export class Resource$Workers { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index db0f3e8e6bf..70126b926b0 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -41,9 +41,21 @@ export namespace gmail_v1 { interface StandardParameters { /** - * Data format for the response. + * 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. */ @@ -61,19 +73,23 @@ export namespace gmail_v1 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * 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; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** * Gmail API * - * Access Gmail mailboxes including sending user email. + * The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels. * * @example * const {google} = require('googleapis'); @@ -108,7 +124,7 @@ export namespace gmail_v1 { */ disposition?: string | null; /** - * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. + * Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. */ emailAddress?: string | null; /** @@ -137,7 +153,7 @@ export namespace gmail_v1 { removeLabelIds?: string[] | null; } /** - * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates. + * Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See <a href="https://support.google.com/mail/answer/138350">"Set up mail delegation"</a> for more information about delegates. */ export interface Schema$Delegate { /** @@ -145,7 +161,7 @@ export namespace gmail_v1 { */ delegateEmail?: string | null; /** - * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. + * Indicates whether this address has been verified and can act as a delegate for the account. Read-only. */ verificationStatus?: string | null; } @@ -213,11 +229,11 @@ export namespace gmail_v1 { */ hasAttachment?: boolean | null; /** - * Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". + * Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, <code>"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"</code>. */ negatedQuery?: string | null; /** - * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, <code>"from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread"</code>. */ query?: string | null; /** @@ -246,7 +262,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string | null; /** - * Indicates whether this address has been verified and is usable for forwarding. Read-only. + * Indicates whether this address has been verified and is usable for forwarding. Read-only. */ verificationStatus?: string | null; } @@ -267,7 +283,7 @@ export namespace gmail_v1 { */ labelsRemoved?: Schema$HistoryLabelRemoved[]; /** - * List of messages changed in this history record. The fields for specific change types, such as messagesAdded may duplicate messages in this field. We recommend using the specific change-type fields instead of this. + * List of messages changed in this history record. The fields for specific change types, such as <code>messagesAdded</code> may duplicate messages in this field. We recommend using the specific change-type fields instead of this. */ messages?: Schema$Message[]; /** @@ -304,7 +320,7 @@ export namespace gmail_v1 { */ export interface Schema$ImapSettings { /** - * If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted. + * If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted. */ autoExpunge?: boolean | null; /** @@ -316,7 +332,7 @@ export namespace gmail_v1 { */ expungeBehavior?: string | null; /** - * An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit. + * An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit. */ maxFolderSize?: number | null; } @@ -325,7 +341,7 @@ export namespace gmail_v1 { */ export interface Schema$Label { /** - * The color to assign to the label. Color is only available for labels that have their type set to user. + * The color to assign to the label. Color is only available for labels that have their <code>type</code> set to <code>user</code>. @mutable gmail.users.labels.create gmail.users.labels.update */ color?: Schema$LabelColor; /** @@ -333,11 +349,11 @@ export namespace gmail_v1 { */ id?: string | null; /** - * The visibility of the label in the label list in the Gmail web interface. + * The visibility of the label in the label list in the Gmail web interface. @mutable gmail.users.labels.create gmail.users.labels.update */ labelListVisibility?: string | null; /** - * The visibility of the label in the message list in the Gmail web interface. + * The visibility of the label in the message list in the Gmail web interface. @mutable gmail.users.labels.create gmail.users.labels.update */ messageListVisibility?: string | null; /** @@ -349,7 +365,7 @@ export namespace gmail_v1 { */ messagesUnread?: number | null; /** - * The display name of the label. + * The display name of the label. @mutable gmail.users.labels.create gmail.users.labels.update */ name?: string | null; /** @@ -361,26 +377,26 @@ export namespace gmail_v1 { */ threadsUnread?: number | null; /** - * The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads. + * The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the <code>INBOX</code> and <code>UNREAD</code> labels from messages and threads, but cannot apply or remove the <code>DRAFTS</code> or <code>SENT</code> labels from messages or threads. */ type?: string | null; } export interface Schema$LabelColor { /** - * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + * The background color represented as hex string #RRGGBB (ex #000000). This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: <br/> # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update */ backgroundColor?: string | null; /** - * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: #000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, #fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, #f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, #efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, #e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, #cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, #ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, #822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c #464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, #711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, #594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, #c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, #662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 + * The text color of the label, represented as hex string. This field is required in order to set the color of a label. Only the following predefined set of color values are allowed: <br/> # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update */ textColor?: string | null; } /** - * Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. + * Language settings for an account. These settings correspond to the <a href="https://support.google.com/mail/answer/17091">"Language settings"</a> feature in the web interface. */ export interface Schema$LanguageSettings { /** - * The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. A table of sample values is also provided in the Managing Language Settings guide Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). + * The language to display Gmail in, formatted as an <a href="https://www.w3.org/International/articles/language-tags/">RFC 3066 Language Tag</a> (for example <code>en-GB</code>, <code>fr</code> or <code>ja</code> for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the <a href="https://mail.google.com/mail/u/0/#settings/general">Gmail settings </a> for all available options, as described in the <a href="https://support.google.com/mail/answer/17091">language settings help article</a>. A table of sample values is also provided in the <a href="/gmail/api/guides/language_settings#display_language">Managing Language Settings guide</a> Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). */ displayLanguage?: string | null; } @@ -395,7 +411,7 @@ export namespace gmail_v1 { } export interface Schema$ListDraftsResponse { /** - * List of drafts. Note that the Message property in each Draft resource only contains an id and a threadId. The messages.get method can fetch additional message details. + * List of drafts. Note that the <code>Message</code> property in each <code>Draft</code> resource only contains an <code>id</code> and a <code>threadId</code>. The <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> method can fetch additional message details. */ drafts?: Schema$Draft[]; /** @@ -427,7 +443,7 @@ export namespace gmail_v1 { } export interface Schema$ListHistoryResponse { /** - * List of history records. Any messages contained in the response will typically only have id and threadId fields populated. + * List of history records. Any <code>messages</code> contained in the response will typically only have <code>id</code> and <code>threadId</code> fields populated. */ history?: Schema$History[]; /** @@ -441,13 +457,13 @@ export namespace gmail_v1 { } export interface Schema$ListLabelsResponse { /** - * List of labels. Note that each label resource only contains an id, name, messageListVisibility, labelListVisibility, and type. The labels.get method can fetch additional label details. + * List of labels. Note that each label resource only contains an <code>id</code>, <code>name</code>, <code>messageListVisibility</code>, <code>labelListVisibility</code>, and <code>type</code>. The <a href="/gmail/api/v1/reference/users/labels/get">labels.get</a> method can fetch additional label details. */ labels?: Schema$Label[]; } export interface Schema$ListMessagesResponse { /** - * List of messages. Note that each message resource contains only an id and a threadId. Additional message details can be fetched using the messages.get method. + * List of messages. Note that each message resource contains only an <code>id</code> and a <code>threadId</code>. Additional message details can be fetched using the <a href="/gmail/api/v1/reference/users/messages/get">messages.get</a> method. */ messages?: Schema$Message[]; /** @@ -484,7 +500,7 @@ export namespace gmail_v1 { */ resultSizeEstimate?: number | null; /** - * List of threads. Note that each thread resource does not contain a list of messages. The list of messages for a given thread can be fetched using the threads.get method. + * List of threads. Note that each thread resource does not contain a list of <code>messages</code>. The list of <code>messages</code> for a given thread can be fetched using the <a href="/gmail/api/v1/reference/users/threads/get">threads.get</a> method. */ threads?: Schema$Thread[]; } @@ -501,11 +517,11 @@ export namespace gmail_v1 { */ id?: string | null; /** - * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the Date header. However, for API-migrated mail, it can be configured by client to be based on the Date header. + * The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the <code>Date</code> header. However, for API-migrated mail, it can be configured by client to be based on the <code>Date</code> header. */ internalDate?: string | null; /** - * List of IDs of labels applied to this message. + * List of IDs of labels applied to this message. @mutable gmail.users.messages.insert gmail.users.messages.modify */ labelIds?: string[] | null; /** @@ -513,7 +529,7 @@ export namespace gmail_v1 { */ payload?: Schema$MessagePart; /** - * The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in messages.get and drafts.get responses when the format=RAW parameter is supplied. + * The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in <code>messages.get</code> and <code>drafts.get</code> responses when the <code>format=RAW</code> parameter is supplied. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update */ raw?: string | null; /** @@ -525,7 +541,7 @@ export namespace gmail_v1 { */ snippet?: string | null; /** - * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: - The requested threadId must be specified on the Message or Draft.Message you supply with your request. - The References and In-Reply-To headers must be set in compliance with the RFC 2822 standard. - The Subject headers must match. + * The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: <ol><li>The requested <code>threadId</code> must be specified on the <code>Message</code> or <code>Draft.Message</code> you supply with your request.</li> <li>The <code>References</code> and <code>In-Reply-To</code> headers must be set in compliance with the <a href="https://tools.ietf.org/html/rfc2822">RFC 2822</a> standard.</li> <li>The <code>Subject</code> headers must match. @mutable gmail.users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update */ threadId?: string | null; } @@ -542,7 +558,7 @@ export namespace gmail_v1 { */ filename?: string | null; /** - * List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as To, From, and Subject. + * List of headers on this message part. For the top-level message part, representing the entire message payload, it will contain the standard RFC 2822 email headers such as <code>To</code>, <code>From</code>, and <code>Subject</code>. */ headers?: Schema$MessagePartHeader[]; /** @@ -554,7 +570,7 @@ export namespace gmail_v1 { */ partId?: string | null; /** - * The child MIME message parts of this part. This only applies to container MIME message parts, for example multipart/*. For non- container MIME message part types, such as text/plain, this field is empty. For more information, see RFC 1521. + * The child MIME message parts of this part. This only applies to container MIME message parts, for example <code>multipart/*</code>. For non- container MIME message part types, such as <code>text/plain</code>, this field is empty. For more information, see <a href="http://www.ietf.org/rfc/rfc1521.txt">RFC 1521</a>. */ parts?: Schema$MessagePart[]; } @@ -563,7 +579,7 @@ export namespace gmail_v1 { */ export interface Schema$MessagePartBody { /** - * When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field. + * When present, contains the ID of an external attachment that can be retrieved in a separate <code>messages.attachments.get</code> request. When not present, the entire content of the message part body is contained in the data field. */ attachmentId?: string | null; /** @@ -577,11 +593,11 @@ export namespace gmail_v1 { } export interface Schema$MessagePartHeader { /** - * The name of the header before the : separator. For example, To. + * The name of the header before the <code>:</code> separator. For example, <code>To</code>. */ name?: string | null; /** - * The value of the header after the : separator. For example, someuser@example.com. + * The value of the header after the <code>:</code> separator. For example, <code>someuser@example.com</code>. */ value?: string | null; } @@ -640,7 +656,7 @@ export namespace gmail_v1 { threadsTotal?: number | null; } /** - * Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the "Send Mail As" feature in the web interface. + * Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom "from" address. Send-as aliases correspond to the <a href="https://support.google.com/mail/answer/22370">"Send Mail As"</a> feature in the web interface. */ export interface Schema$SendAs { /** @@ -648,19 +664,19 @@ export namespace gmail_v1 { */ displayName?: string | null; /** - * Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address. + * Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is <code>true</code>. Changing this from <code>false</code> to <code>true</code> for an address will result in this field becoming <code>false</code> for the other previous default address. */ isDefault?: boolean | null; /** - * Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only. + * Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only. */ isPrimary?: boolean | null; /** - * An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header. + * An optional email address that is included in a "Reply-To:" header for mail sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" header. */ replyToAddress?: string | null; /** - * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. + * The email address that appears in the "From:" header for mail sent using this alias. This is read-only for all operations except create. */ sendAsEmail?: string | null; /** @@ -668,15 +684,15 @@ export namespace gmail_v1 { */ signature?: string | null; /** - * An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases. + * An optional SMTP service that will be used as an outbound relay for mail sent using this alias. If this is empty, outbound mail will be sent directly from Gmail's servers to the destination SMTP service. This setting only applies to custom "from" aliases. */ smtpMsa?: Schema$SmtpMsa; /** - * Whether Gmail should treat this address as an alias for the user's primary email address. This setting only applies to custom "from" aliases. + * Whether Gmail should <a href="https://support.google.com/a/answer/1710338"> treat this address as an alias</a> for the user's primary email address. This setting only applies to custom "from" aliases. */ treatAsAlias?: boolean | null; /** - * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. + * Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom "from" aliases. */ verificationStatus?: string | null; } @@ -705,11 +721,11 @@ export namespace gmail_v1 { */ issuerCn?: string | null; /** - * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). + * PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key). */ pem?: string | null; /** - * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. + * PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. */ pkcs12?: string | null; } @@ -718,7 +734,7 @@ export namespace gmail_v1 { */ export interface Schema$SmtpMsa { /** - * The hostname of the SMTP service. Required. + * The hostname of the SMTP service. Required. */ host?: string | null; /** @@ -726,11 +742,11 @@ export namespace gmail_v1 { */ password?: string | null; /** - * The port of the SMTP service. Required. + * The port of the SMTP service. Required. */ port?: number | null; /** - * The protocol that will be used to secure communication with the SMTP service. Required. + * The protocol that will be used to secure communication with the SMTP service. Required. */ securityMode?: string | null; /** @@ -760,7 +776,7 @@ export namespace gmail_v1 { snippet?: string | null; } /** - * Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. + * Vacation auto-reply settings for an account. These settings correspond to the <a href="https://support.google.com/mail/answer/25922">"Vacation responder"</a> feature in the web interface. */ export interface Schema$VacationSettings { /** @@ -768,11 +784,11 @@ export namespace gmail_v1 { */ enableAutoReply?: boolean | null; /** - * An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime. + * An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both <code>startTime</code> and <code>endTime</code> are specified, <code>startTime</code> must precede <code>endTime</code>. */ endTime?: string | null; /** - * Response body in HTML format. Gmail will sanitize the HTML before storing it. + * Response body in HTML format. Gmail will sanitize the HTML before storing it. */ responseBodyHtml?: string | null; /** @@ -780,7 +796,7 @@ export namespace gmail_v1 { */ responseBodyPlainText?: string | null; /** - * Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. + * Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. */ responseSubject?: string | null; /** @@ -792,7 +808,7 @@ export namespace gmail_v1 { */ restrictToDomain?: boolean | null; /** - * An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime. + * An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both <code>startTime</code> and <code>endTime</code> are specified, <code>startTime</code> must precede <code>endTime</code>. */ startTime?: string | null; } @@ -805,7 +821,7 @@ export namespace gmail_v1 { */ labelFilterAction?: string | null; /** - * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. + * List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. */ labelIds?: string[] | null; /** @@ -818,7 +834,7 @@ export namespace gmail_v1 { */ export interface Schema$WatchResponse { /** - * When Gmail will stop sending notifications for mailbox updates (epoch millis). Call watch again before this time to renew the watch. + * When Gmail will stop sending notifications for mailbox updates (epoch millis). Call <code>watch</code> again before this time to renew the watch. */ expiration?: string | null; /** @@ -852,7 +868,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -923,7 +939,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -994,7 +1010,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().WatchRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1069,7 +1085,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1080,7 +1096,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1091,7 +1107,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1109,12 +1125,12 @@ export namespace gmail_v1 { /** * gmail.users.drafts.create - * @desc Creates a new draft with the DRAFT label. + * @desc Creates a new draft with the DRAFT label. * @alias gmail.users.drafts.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -1195,7 +1211,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the draft to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -1269,7 +1285,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string=} params.format The format to return the draft in. * @param {string} params.id The ID of the draft to retrieve. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -1340,11 +1356,11 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.includeSpamTrash Include drafts from SPAM and TRASH in the results. + * @param {boolean=} params.includeSpamTrash Include drafts from SPAM and TRASH in the results. * @param {integer=} params.maxResults Maximum number of drafts to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.q Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -1413,12 +1429,12 @@ export namespace gmail_v1 { /** * gmail.users.drafts.send - * @desc Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. + * @desc Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. * @alias gmail.users.drafts.send * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -1498,7 +1514,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the draft to update. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -1579,7 +1595,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1615,7 +1631,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1634,7 +1650,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1646,7 +1662,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Include drafts from SPAM and TRASH in the results. + * Include drafts from SPAM and TRASH in the results. */ includeSpamTrash?: boolean; /** @@ -1658,11 +1674,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". + * Only return draft messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". */ q?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1674,7 +1690,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1710,7 +1726,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -1743,7 +1759,7 @@ export namespace gmail_v1 { /** * gmail.users.history.list - * @desc Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). + * @desc Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). * @alias gmail.users.history.list * @memberOf! () * @@ -1752,8 +1768,8 @@ export namespace gmail_v1 { * @param {string=} params.labelId Only return messages with a label matching the ID. * @param {integer=} params.maxResults The maximum number of history records to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.startHistoryId Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.startHistoryId Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -1845,11 +1861,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. + * Required. Returns history records after the specified startHistoryId. The supplied startHistoryId should be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application should perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request. */ startHistoryId?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -1867,7 +1883,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().Label} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1941,7 +1957,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -2014,7 +2030,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to retrieve. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -2085,7 +2101,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -2154,13 +2170,13 @@ export namespace gmail_v1 { /** * gmail.users.labels.patch - * @desc Updates the specified label. This method supports patch semantics. + * @desc Patch the specified label. * @alias gmail.users.labels.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to update. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().Label} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2234,7 +2250,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the label to update. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().Label} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2309,7 +2325,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2330,7 +2346,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2345,7 +2361,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2357,7 +2373,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -2373,7 +2389,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2394,7 +2410,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -2414,12 +2430,12 @@ export namespace gmail_v1 { /** * gmail.users.messages.batchDelete - * @desc Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. + * @desc Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. * @alias gmail.users.messages.batchDelete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().BatchDeleteMessagesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2491,7 +2507,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().BatchModifyMessagesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2558,13 +2574,13 @@ export namespace gmail_v1 { /** * gmail.users.messages.delete - * @desc Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. + * @desc Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. * @alias gmail.users.messages.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -2639,7 +2655,7 @@ export namespace gmail_v1 { * @param {string=} params.format The format to return the message in. * @param {string} params.id The ID of the message to retrieve. * @param {string=} params.metadataHeaders When given and format is METADATA, only include headers specified. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -2711,11 +2727,11 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * @param {string=} params.internalDateSource Source for Gmail's internal date of the message. * @param {boolean=} params.neverMarkSpam Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox. * @param {boolean=} params.processForCalendar Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -2789,14 +2805,14 @@ export namespace gmail_v1 { /** * gmail.users.messages.insert - * @desc Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. + * @desc Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. * @alias gmail.users.messages.insert * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * @param {boolean=} params.deleted Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. * @param {string=} params.internalDateSource Source for Gmail's internal date of the message. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -2875,12 +2891,12 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.includeSpamTrash Include messages from SPAM and TRASH in the results. + * @param {boolean=} params.includeSpamTrash Include messages from SPAM and TRASH in the results. * @param {string=} params.labelIds Only return messages with labels that match all of the specified label IDs. * @param {integer=} params.maxResults Maximum number of messages to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.q Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -2957,7 +2973,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to modify. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().ModifyMessageRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3024,12 +3040,12 @@ export namespace gmail_v1 { /** * gmail.users.messages.send - * @desc Sends the specified message to the recipients in the To, Cc, and Bcc headers. + * @desc Sends the specified message to the recipients in the To, Cc, and Bcc headers. * @alias gmail.users.messages.send * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {object} params.requestBody Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type @@ -3109,7 +3125,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -3181,7 +3197,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the message to remove from Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -3254,7 +3270,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3271,7 +3287,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3292,7 +3308,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3316,7 +3332,7 @@ export namespace gmail_v1 { */ metadataHeaders?: string[]; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3328,7 +3344,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -3344,7 +3360,7 @@ export namespace gmail_v1 { */ processForCalendar?: boolean; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3376,7 +3392,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. + * Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for G Suite accounts. */ deleted?: boolean; /** @@ -3384,7 +3400,7 @@ export namespace gmail_v1 { */ internalDateSource?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3416,7 +3432,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Include messages from SPAM and TRASH in the results. + * Include messages from SPAM and TRASH in the results. */ includeSpamTrash?: boolean; /** @@ -3432,11 +3448,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3452,7 +3468,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3469,7 +3485,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -3505,7 +3521,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3521,7 +3537,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3541,7 +3557,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The ID of the attachment. * @param {string} params.messageId The ID of the message containing the attachment. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -3625,7 +3641,7 @@ export namespace gmail_v1 { */ messageId?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -3653,7 +3669,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -3728,7 +3744,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -3802,7 +3818,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -3875,7 +3891,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -3949,7 +3965,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -4017,12 +4033,12 @@ export namespace gmail_v1 { /** * gmail.users.settings.updateAutoForwarding - * @desc Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.updateAutoForwarding * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().AutoForwarding} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4098,7 +4114,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().ImapSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4168,12 +4184,12 @@ export namespace gmail_v1 { /** * gmail.users.settings.updateLanguage - * @desc Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. + * @desc Updates language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead. * @alias gmail.users.settings.updateLanguage * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().LanguageSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4249,7 +4265,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().PopSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4324,7 +4340,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().VacationSettings} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4402,7 +4418,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4414,7 +4430,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4426,7 +4442,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4438,7 +4454,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4450,7 +4466,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4462,7 +4478,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4479,7 +4495,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4496,7 +4512,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4513,7 +4529,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4530,7 +4546,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4548,12 +4564,12 @@ export namespace gmail_v1 { /** * gmail.users.settings.delegates.create - * @desc Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.delegates.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().Delegate} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4626,7 +4642,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.delegateEmail The email address of the user to be removed as a delegate. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -4699,7 +4715,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.delegateEmail The email address of the user whose delegate relationship is to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -4771,7 +4787,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -4848,7 +4864,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -4869,7 +4885,7 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4885,7 +4901,7 @@ export namespace gmail_v1 { */ delegateEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -4897,7 +4913,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5268,12 +5284,12 @@ export namespace gmail_v1 { /** * gmail.users.settings.forwardingAddresses.create - * @desc Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.forwardingAddresses.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().ForwardingAddress} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5348,7 +5364,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.forwardingEmail The forwarding address to be deleted. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -5421,7 +5437,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.forwardingEmail The forwarding address to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -5495,7 +5511,7 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -5579,7 +5595,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -5600,7 +5616,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5616,7 +5632,7 @@ export namespace gmail_v1 { */ forwardingEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5628,7 +5644,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -5645,12 +5661,12 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.create - * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5718,13 +5734,13 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.delete - * @desc Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be deleted. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -5790,13 +5806,13 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.get - * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. + * @desc Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. * @alias gmail.users.settings.sendAs.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be retrieved. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -5862,12 +5878,12 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.list - * @desc Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. + * @desc Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. * @alias gmail.users.settings.sendAs.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -5936,13 +5952,13 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.patch - * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics. + * @desc Patch the specified send-as alias. * @alias gmail.users.settings.sendAs.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be updated. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6009,13 +6025,13 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.update - * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. + * @desc Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be updated. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. * @param {().SendAs} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6082,13 +6098,13 @@ export namespace gmail_v1 { /** * gmail.users.settings.sendAs.verify - * @desc Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority. + * @desc Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority. * @alias gmail.users.settings.sendAs.verify * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The send-as alias to be verified. - * @param {string} params.userId User's email address. The special value "me" can be used to indicate the authenticated user. + * @param {string} params.userId User's email address. The special value "me" can be used to indicate the 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 @@ -6162,7 +6178,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -6183,7 +6199,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6199,7 +6215,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6211,7 +6227,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6227,7 +6243,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -6248,7 +6264,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; @@ -6269,7 +6285,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * User's email address. The special value "me" can be used to indicate the authenticated user. + * User's email address. The special value "me" can be used to indicate the authenticated user. */ userId?: string; } @@ -6289,7 +6305,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The immutable ID for the SmimeInfo. * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -6363,7 +6379,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The immutable ID for the SmimeInfo. * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -6438,7 +6454,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().SmimeInfo} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6514,7 +6530,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -6592,7 +6608,7 @@ export namespace gmail_v1 { * @param {object} params Parameters for request * @param {string} params.id The immutable ID for the SmimeInfo. * @param {string} params.sendAsEmail The email address that appears in the "From:" header for mail sent using this alias. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -6674,7 +6690,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6694,7 +6710,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6710,7 +6726,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -6731,7 +6747,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6751,7 +6767,7 @@ export namespace gmail_v1 { */ sendAsEmail?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -6764,13 +6780,13 @@ export namespace gmail_v1 { /** * gmail.users.threads.delete - * @desc Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. + * @desc Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. * @alias gmail.users.threads.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.id ID of the Thread to delete. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -6845,7 +6861,7 @@ export namespace gmail_v1 { * @param {string=} params.format The format to return the messages in. * @param {string} params.id The ID of the thread to retrieve. * @param {string=} params.metadataHeaders When given and format is METADATA, only include headers specified. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -6917,12 +6933,12 @@ export namespace gmail_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.includeSpamTrash Include threads from SPAM and TRASH in the results. + * @param {boolean=} params.includeSpamTrash Include threads from SPAM and TRASH in the results. * @param {string=} params.labelIds Only return threads with labels that match all of the specified label IDs. * @param {integer=} params.maxResults Maximum number of threads to return. * @param {string=} params.pageToken Page token to retrieve a specific page of results in the list. - * @param {string=} params.q Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string=} params.q Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -6997,7 +7013,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the thread to modify. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. * @param {().ModifyThreadRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -7070,7 +7086,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the thread to Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -7142,7 +7158,7 @@ export namespace gmail_v1 { * * @param {object} params Parameters for request * @param {string} params.id The ID of the thread to remove from Trash. - * @param {string} params.userId The user's email address. The special value me can be used to indicate the authenticated user. + * @param {string} params.userId The user's email address. The special value me can be used to indicate the 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 @@ -7219,7 +7235,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7243,7 +7259,7 @@ export namespace gmail_v1 { */ metadataHeaders?: string[]; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7255,7 +7271,7 @@ export namespace gmail_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Include threads from SPAM and TRASH in the results. + * Include threads from SPAM and TRASH in the results. */ includeSpamTrash?: boolean; /** @@ -7271,11 +7287,11 @@ export namespace gmail_v1 { */ pageToken?: string; /** - * Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. + * Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope. */ q?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7291,7 +7307,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; @@ -7312,7 +7328,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } @@ -7328,7 +7344,7 @@ export namespace gmail_v1 { */ id?: string; /** - * The user's email address. The special value me can be used to indicate the authenticated user. + * The user's email address. The special value me can be used to indicate the authenticated user. */ userId?: string; } diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index 5991612694a..23bf7c3d9ab 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -440,7 +440,7 @@ export namespace healthcare_v1 { */ streamConfigs?: Schema$StreamConfig[]; /** - * The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. An empty value is treated as STU3. + * The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. */ version?: string | null; } @@ -5965,7 +5965,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.create - * @desc Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @alias healthcare.projects.locations.datasets.fhirStores.fhir.create * @memberOf! () * @@ -6324,7 +6324,7 @@ export namespace healthcare_v1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything - * @desc On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @alias healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything * @memberOf! () * diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index e673dde03aa..ecbd2392981 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -8355,7 +8355,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.import - * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger PubSub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * @desc Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID, and will be stored using that ID regardless of the enable_update_create setting on the FHIR store. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Cloud Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store will contain exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and will count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data is specified by the parameters below. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. * @example * * // BEFORE RUNNING: * // --------------- @@ -9406,6 +9406,160 @@ export namespace healthcare_v1beta1 { } } + /** + * healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-search-translate + * @desc Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-search-translate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.code The code to translate. + * @param {string=} params.conceptMapVersion The version of the concept map to use. If unset, the most current version is used. + * @param {string} params.parent The name for the FHIR store containing the concept map(s) to use for the translation. + * @param {string=} params.source The source value set of the concept map to be used. If unset, target is used to search for concept maps. + * @param {string=} params.system The system for the code to be translated. + * @param {string=} params.target The target value set of the concept map to be used. If unset, source is used to search for concept maps. + * @param {string=} params.url The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + ConceptMapSearchTranslate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmapsearchtranslate, + options?: MethodOptions + ): GaxiosPromise; + ConceptMapSearchTranslate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmapsearchtranslate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ConceptMapSearchTranslate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmapsearchtranslate, + callback: BodyResponseCallback + ): void; + ConceptMapSearchTranslate( + callback: BodyResponseCallback + ): void; + ConceptMapSearchTranslate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmapsearchtranslate + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmapsearchtranslate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmapsearchtranslate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/fhir/ConceptMap/$translate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-translate + * @desc Translates a code from one value set to another using a concept map. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @alias healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-translate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.code The code to translate. + * @param {string=} params.conceptMapVersion The version of the concept map to use. If unset, the most current version is used. + * @param {string} params.name The URL for the concept map to use for the translation. + * @param {string=} params.system The system for the code to be translated. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + ConceptMapTranslate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmaptranslate, + options?: MethodOptions + ): GaxiosPromise; + ConceptMapTranslate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmaptranslate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ConceptMapTranslate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmaptranslate, + callback: BodyResponseCallback + ): void; + ConceptMapTranslate(callback: BodyResponseCallback): void; + ConceptMapTranslate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmaptranslate + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmaptranslate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmaptranslate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/$translate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. @@ -10518,7 +10672,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything - * @desc On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Retrieves all the resources directly referenced by a patient, as well as all of the resources in the patient compartment. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -11240,6 +11394,66 @@ export namespace healthcare_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmapsearchtranslate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The code to translate. + */ + code?: string; + /** + * The version of the concept map to use. If unset, the most current version is used. + */ + conceptMapVersion?: string; + /** + * The name for the FHIR store containing the concept map(s) to use for the translation. + */ + parent?: string; + /** + * The source value set of the concept map to be used. If unset, target is used to search for concept maps. + */ + source?: string; + /** + * The system for the code to be translated. + */ + system?: string; + /** + * The target value set of the concept map to be used. If unset, source is used to search for concept maps. + */ + target?: string; + /** + * The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps. + */ + url?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conceptmaptranslate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The code to translate. + */ + code?: string; + /** + * The version of the concept map to use. If unset, the most current version is used. + */ + conceptMapVersion?: string; + /** + * The URL for the concept map to use for the translation. + */ + name?: string; + /** + * The system for the code to be translated. + */ + system?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Conditionaldelete extends StandardParameters { /** diff --git a/src/apis/homegraph/v1.ts b/src/apis/homegraph/v1.ts index 4051c17c6b9..be6cb0a496c 100644 --- a/src/apis/homegraph/v1.ts +++ b/src/apis/homegraph/v1.ts @@ -168,7 +168,7 @@ export namespace homegraph_v1 { */ notificationSupportedByAgent?: boolean | null; /** - * Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local execution](https://developers.google.com/assistant/smarthome/concepts/local). + * Alternate IDs associated with this device. This is used to identify cloud synced devices enabled for [local fulfillment](https://developers.google.com/assistant/smarthome/concepts/local). */ otherDeviceIds?: Schema$AgentOtherDeviceId[]; /** diff --git a/src/apis/identitytoolkit/v3.ts b/src/apis/identitytoolkit/v3.ts index 25aa4097f70..6ec682e9c66 100644 --- a/src/apis/identitytoolkit/v3.ts +++ b/src/apis/identitytoolkit/v3.ts @@ -1139,10 +1139,10 @@ export namespace identitytoolkit_v3 { * The user's profiles at the associated IdPs. */ providerUserInfo?: Array<{ + displayName?: string; federatedId?: string; providerId?: string; photoUrl?: string; - displayName?: string; }> | null; /** * If idToken is STS id token, then this field will be refresh token. @@ -1255,7 +1255,6 @@ export namespace identitytoolkit_v3 { * The IDP of the user. */ providerUserInfo?: Array<{ - rawId?: string; photoUrl?: string; email?: string; federatedId?: string; @@ -1263,6 +1262,7 @@ export namespace identitytoolkit_v3 { screenName?: string; displayName?: string; phoneNumber?: string; + rawId?: string; }> | null; /** * The user's plain text password. diff --git a/src/apis/index.ts b/src/apis/index.ts index 10b8802aeff..442b54757f8 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -94,6 +94,7 @@ import * as file from './file'; import * as firebase from './firebase'; import * as firebasedynamiclinks from './firebasedynamiclinks'; import * as firebasehosting from './firebasehosting'; +import * as firebaseml from './firebaseml'; import * as firebaserules from './firebaserules'; import * as firestore from './firestore'; import * as fitness from './fitness'; @@ -269,6 +270,7 @@ export const APIS: APIList = { firebase: firebase.VERSIONS, firebasedynamiclinks: firebasedynamiclinks.VERSIONS, firebasehosting: firebasehosting.VERSIONS, + firebaseml: firebaseml.VERSIONS, firebaserules: firebaserules.VERSIONS, firestore: firestore.VERSIONS, fitness: fitness.VERSIONS, @@ -441,6 +443,7 @@ export class GeneratedAPIs { firebase = firebase.firebase; firebasedynamiclinks = firebasedynamiclinks.firebasedynamiclinks; firebasehosting = firebasehosting.firebasehosting; + firebaseml = firebaseml.firebaseml; firebaserules = firebaserules.firebaserules; firestore = firestore.firestore; fitness = fitness.fitness; diff --git a/src/apis/jobs/index.ts b/src/apis/jobs/index.ts index 285df38e2d5..3cda8fdc913 100644 --- a/src/apis/jobs/index.ts +++ b/src/apis/jobs/index.ts @@ -14,21 +14,27 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {jobs_v2} from './v2'; import {jobs_v3} from './v3'; import {jobs_v3p1beta1} from './v3p1beta1'; export const VERSIONS = { + v2: jobs_v2.Jobs, v3: jobs_v3.Jobs, v3p1beta1: jobs_v3p1beta1.Jobs, }; +export function jobs(version: 'v2'): jobs_v2.Jobs; +export function jobs(options: jobs_v2.Options): jobs_v2.Jobs; export function jobs(version: 'v3'): jobs_v3.Jobs; export function jobs(options: jobs_v3.Options): jobs_v3.Jobs; export function jobs(version: 'v3p1beta1'): jobs_v3p1beta1.Jobs; export function jobs(options: jobs_v3p1beta1.Options): jobs_v3p1beta1.Jobs; -export function jobs( +export function jobs( this: GoogleConfigurable, versionOrOptions: + | 'v2' + | jobs_v2.Options | 'v3' | jobs_v3.Options | 'v3p1beta1' diff --git a/src/apis/jobs/v2.ts b/src/apis/jobs/v2.ts new file mode 100644 index 00000000000..131f3f4ad0d --- /dev/null +++ b/src/apis/jobs/v2.ts @@ -0,0 +1,3097 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace jobs_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; + } + + /** + * Cloud Talent Solution API + * + * Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters. + * + * @example + * const {google} = require('googleapis'); + * const jobs = google.jobs('v2'); + * + * @namespace jobs + * @type {Function} + * @version v2 + * @variation v2 + * @param {object=} options Options for Jobs + */ + export class Jobs { + context: APIRequestContext; + companies: Resource$Companies; + jobs: Resource$Jobs; + v2: Resource$V2; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.companies = new Resource$Companies(this.context); + this.jobs = new Resource$Jobs(this.context); + this.v2 = new Resource$V2(this.context); + } + } + + /** + * Input only. Batch delete jobs request. + */ + export interface Schema$BatchDeleteJobsRequest { + /** + * Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "companies/123" AND requisitionId = "req-1" + */ + filter?: string | null; + } + /** + * Represents count of jobs within one bucket. + */ + export interface Schema$BucketizedCount { + /** + * Number of jobs whose numeric field value fall into `range`. + */ + count?: number | null; + /** + * Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range. + */ + range?: Schema$BucketRange; + } + /** + * Represents starting and ending value of a range in double. + */ + export interface Schema$BucketRange { + /** + * Starting value of the bucket range. + */ + from?: number | null; + /** + * Ending value of the bucket range. + */ + to?: number | null; + } + /** + * Output only. Commute details related to this job. + */ + export interface Schema$CommuteInfo { + /** + * Location used as the destination in the commute calculation. + */ + jobLocation?: Schema$JobLocation; + /** + * The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query. + */ + travelDuration?: string | null; + } + /** + * Input only. Parameters needed for commute search. + */ + export interface Schema$CommutePreference { + /** + * Optional. If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or is not specified, only jobs that include street level addresses will be returned by commute search. + */ + allowNonStreetLevelAddress?: boolean | null; + /** + * Optional. The departure hour to use to calculate traffic impact. Accepts an integer between 0 and 23, representing the hour in the time zone of the start_location. Must not be present if road_traffic is specified. + */ + departureHourLocal?: number | null; + /** + * Required. The method of transportation for which to calculate the commute time. + */ + method?: string | null; + /** + * Optional. Specifies the traffic density to use when calculating commute time. Must not be present if departure_hour_local is specified. + */ + roadTraffic?: string | null; + /** + * Required. The latitude and longitude of the location from which to calculate the commute time. + */ + startLocation?: Schema$LatLng; + /** + * Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`. + */ + travelTime?: string | null; + } + /** + * A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position. + */ + export interface Schema$Company { + /** + * Optional. The URL to employer's career site or careers page on the employer's web site. + */ + careerPageLink?: string | null; + /** + * Optional. Identifiers external to the application that help to further identify the employer. + */ + companyInfoSources?: Schema$CompanyInfoSource[]; + /** + * Optional. The employer's company size. + */ + companySize?: string | null; + /** + * Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored. + */ + disableLocationOptimization?: boolean | null; + /** + * Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". + */ + displayName?: string | null; + /** + * Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided. + */ + distributorBillingCompanyId?: string | null; + /** + * Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255. + */ + distributorCompanyId?: string | null; + /** + * Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. + */ + eeoText?: string | null; + /** + * Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. + */ + hiringAgency?: boolean | null; + /** + * Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in structured_company_hq_location. + */ + hqLocation?: string | null; + /** + * Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted. + */ + imageUrl?: string | null; + /** + * Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. + */ + keywordSearchableCustomAttributes?: string[] | null; + /** + * Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes. + */ + keywordSearchableCustomFields?: number[] | null; + /** + * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + */ + name?: string | null; + /** + * Output only. A structured headquarters location of the company, resolved from hq_location if possible. + */ + structuredCompanyHqLocation?: Schema$JobLocation; + /** + * Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. + */ + suspended?: boolean | null; + /** + * Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.". + */ + title?: string | null; + /** + * Optional. The URL representing the company's primary web site or home page, such as, "www.google.com". + */ + website?: string | null; + } + /** + * A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`. + */ + export interface Schema$CompanyInfoSource { + /** + * Optional. The Google's Knowledge Graph value for the employer's company. + */ + freebaseMid?: string | null; + /** + * Optional. The numeric identifier for the employer's Google+ business page. + */ + gplusId?: string | null; + /** + * Optional. The numeric identifier for the employer's headquarters on Google Maps, namely, the Google Maps CID (cell id). + */ + mapsCid?: string | null; + /** + * Optional. A Google identifier that does not match any of the other types. + */ + unknownTypeId?: string | null; + } + /** + * A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + */ + export interface Schema$CompensationEntry { + /** + * Optional. Compensation amount. + */ + amount?: Schema$Money; + /** + * Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus. + */ + description?: string | null; + /** + * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 + */ + expectedUnitsPerYear?: number | null; + /** + * Optional. Compensation range. + */ + range?: Schema$CompensationRange; + /** + * Required. Compensation type. + */ + type?: string | null; + /** + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + */ + unit?: string | null; + } + /** + * Input only. Filter on job compensation type and amount. + */ + export interface Schema$CompensationFilter { + /** + * Optional. Whether to include jobs whose compensation range is unspecified. + */ + includeJobsWithUnspecifiedCompensationRange?: boolean | null; + /** + * Optional. Compensation range. + */ + range?: Schema$CompensationRange; + /** + * Required. Type of filter. + */ + type?: string | null; + /** + * Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit. + */ + units?: string[] | null; + } + /** + * Input only. Compensation based histogram request. + */ + export interface Schema$CompensationHistogramRequest { + /** + * Required. Numeric histogram options, like buckets, whether include min or max value. + */ + bucketingOption?: Schema$NumericBucketingOption; + /** + * Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`. + */ + type?: string | null; + } + /** + * Output only. Compensation based histogram result. + */ + export interface Schema$CompensationHistogramResult { + /** + * Histogram result. + */ + result?: Schema$NumericBucketingResult; + /** + * Type of the request, corresponding to CompensationHistogramRequest.type. + */ + type?: string | null; + } + /** + * Job compensation details. + */ + export interface Schema$CompensationInfo { + /** + * Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation. + */ + amount?: Schema$Money; + /** + * Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedBaseCompensationRange?: Schema$CompensationRange; + /** + * Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization. + */ + annualizedTotalCompensationRange?: Schema$CompensationRange; + /** + * Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. + */ + entries?: Schema$CompensationEntry[]; + /** + * Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. + */ + max?: Schema$Money; + /** + * Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount. + */ + min?: Schema$Money; + /** + * Deprecated. Use entries instead. Optional. Type of job compensation. + */ + type?: string | null; + } + /** + * Compensation range. + */ + export interface Schema$CompensationRange { + /** + * Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation. + */ + max?: Schema$Money; + /** + * Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation. + */ + min?: Schema$Money; + } + /** + * Output only. Response of auto-complete query. + */ + export interface Schema$CompleteQueryResponse { + /** + * Results of the matching job/company candidates. + */ + completionResults?: Schema$CompletionResult[]; + /** + * Additional information for the API invocation, such as the request tracking id. + */ + metadata?: Schema$ResponseMetadata; + } + /** + * Output only. Resource that represents completion results. + */ + export interface Schema$CompletionResult { + /** + * The URL for the company logo if `type=COMPANY_NAME`. + */ + imageUrl?: string | null; + /** + * The suggestion for the query. + */ + suggestion?: string | null; + /** + * The completion topic. + */ + type?: string | null; + } + /** + * Input only. Create job request. + */ + export interface Schema$CreateJobRequest { + /** + * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. + */ + disableStreetAddressResolution?: boolean | null; + /** + * Required. The Job to be created. + */ + job?: Schema$Job; + /** + * Optional. Options for job processing. + */ + processingOptions?: Schema$JobProcessingOptions; + } + /** + * Custom attribute values that are either filterable or non-filterable. + */ + export interface Schema$CustomAttribute { + /** + * Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false. + */ + filterable?: boolean | null; + /** + * Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed. + */ + longValue?: string | null; + /** + * Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed. + */ + stringValues?: Schema$StringValues; + } + /** + * Custom attributes histogram request. An error will be thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined. + */ + export interface Schema$CustomAttributeHistogramRequest { + /** + * Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values. + */ + key?: string | null; + /** + * Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements. + */ + longValueHistogramBucketingOption?: Schema$NumericBucketingOption; + /** + * Optional. If set to true, the response will include the histogram value for each key as a string. + */ + stringValueHistogram?: boolean | null; + } + /** + * Output only. Custom attribute histogram result. + */ + export interface Schema$CustomAttributeHistogramResult { + /** + * Stores the key of custom attribute the histogram is performed on. + */ + key?: string | null; + /** + * Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`. + */ + longValueHistogramResult?: Schema$NumericBucketingResult; + /** + * 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?: {[key: string]: number} | null; + } + /** + * Resource that represents the custom data not captured by the standard fields. + */ + export interface Schema$CustomField { + /** + * Optional. The values of the custom data. + */ + values?: string[] | null; + } + /** + * Input only. Custom field filter of the search. + */ + export interface Schema$CustomFieldFilter { + /** + * Required. The query strings for the filter. + */ + queries?: string[] | null; + /** + * Optional. The type of filter. Defaults to FilterType.OR. + */ + type?: string | null; + } + /** + * 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 | null; + /** + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. + */ + month?: number | null; + /** + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + */ + year?: number | null; + } + /** + * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes. + */ + export interface Schema$DeleteJobsByFilterRequest { + /** + * Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. + */ + disableFastProcess?: boolean | null; + /** + * Required. Restrictions on the scope of the delete request. + */ + filter?: Schema$Filter; + } + /** + * Input only. Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices. + */ + export interface Schema$DeviceInfo { + /** + * Optional. Type of the device. + */ + deviceType?: string | null; + /** + * Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices. + */ + id?: string | null; + } + /** + * 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 {} + /** + * Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount. + */ + export interface Schema$ExtendedCompensationFilter { + /** + * Optional. Compensation range. + */ + compensationRange?: Schema$ExtendedCompensationInfoCompensationRange; + /** + * Required. Specify desired `base compensation entry's` ExtendedCompensationInfo.CompensationUnit. + */ + compensationUnits?: string[] | null; + /** + * Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If unspecified, jobs are returned regardless of currency. + */ + currency?: string | null; + /** + * Optional. Whether to include jobs whose compensation range is unspecified. + */ + includeJobWithUnspecifiedCompensationRange?: boolean | null; + /** + * Required. Type of filter. + */ + type?: string | null; + } + /** + * Deprecated. Use CompensationInfo. Describes job compensation. + */ + export interface Schema$ExtendedCompensationInfo { + /** + * Output only. Annualized base compensation range. + */ + annualizedBaseCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange; + /** + * Output only. Indicates annualized base compensation range cannot be derived, due to the job's base compensation entry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry. + */ + annualizedBaseCompensationUnspecified?: boolean | null; + /** + * Output only. Annualized total compensation range. + */ + annualizedTotalCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange; + /** + * Output only. Indicates annualized total compensation range cannot be derived, due to the job's all CompensationEntry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry. + */ + annualizedTotalCompensationUnspecified?: boolean | null; + /** + * Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code. + */ + currency?: string | null; + /** + * Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job. + */ + entries?: Schema$ExtendedCompensationInfoCompensationEntry[]; + } + /** + * Deprecated. See CompensationInfo. A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year. + */ + export interface Schema$ExtendedCompensationInfoCompensationEntry { + /** + * Optional. Monetary amount. + */ + amount?: Schema$ExtendedCompensationInfoDecimal; + /** + * Optional. Compensation description. + */ + description?: string | null; + /** + * Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1 + */ + expectedUnitsPerYear?: Schema$ExtendedCompensationInfoDecimal; + /** + * Optional. Compensation range. + */ + range?: Schema$ExtendedCompensationInfoCompensationRange; + /** + * Required. Compensation type. + */ + type?: string | null; + /** + * Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED. + */ + unit?: string | null; + /** + * Optional. Indicates compensation amount and range are unset. + */ + unspecified?: boolean | null; + } + /** + * Deprecated. See CompensationInfo. Compensation range. + */ + export interface Schema$ExtendedCompensationInfoCompensationRange { + /** + * Required. Maximum value. + */ + max?: Schema$ExtendedCompensationInfoDecimal; + /** + * Required. Minimum value. + */ + min?: Schema$ExtendedCompensationInfoDecimal; + } + /** + * Deprecated. See CompensationInfo. Decimal number. + */ + export interface Schema$ExtendedCompensationInfoDecimal { + /** + * Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. If `units` is positive, `micros` must be positive or zero. If `units` is zero, `micros` can be positive, zero, or negative. If `units` is negative, `micros` must be negative or zero. For example -1.75 is represented as `units`=-1 and `micros`=-750,000. + */ + micros?: number | null; + /** + * Whole units. + */ + units?: string | null; + } + /** + * Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted. + */ + export interface Schema$Filter { + /** + * Required. The requisition ID (or posting ID) assigned by the client to identify a job. This is intended for client identification and tracking of listings. name takes precedence over this field The maximum number of allowed characters is 225. + */ + requisitionId?: string | null; + } + /** + * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method. + */ + export interface Schema$GetHistogramRequest { + /** + * Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false. + */ + allowBroadening?: boolean | null; + /** + * Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram. + */ + filters?: Schema$JobFilters; + /** + * Optional. Query used to search against jobs, such as keyword, location filters, etc. + */ + query?: Schema$JobQuery; + /** + * Meta information, such as `user_id`, collected from the job searcher or other entity conducting a job search, is used to improve the service's search quality. Users determine identifier values, which must be unique and consist. + */ + requestMetadata?: Schema$RequestMetadata; + /** + * Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution. + */ + searchTypes?: string[] | null; + } + /** + * Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method. + */ + export interface Schema$GetHistogramResponse { + /** + * Additional information for the API invocation, such as the request tracking id. + */ + metadata?: Schema$ResponseMetadata; + /** + * The Histogram results. + */ + results?: Schema$HistogramResult[]; + } + /** + * Input only. Histogram facets to be specified in SearchJobsRequest. + */ + export interface Schema$HistogramFacets { + /** + * Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed. + */ + compensationHistogramFacets?: Schema$CompensationHistogramRequest[]; + /** + * Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed. + */ + customAttributeHistogramFacets?: Schema$CustomAttributeHistogramRequest[]; + /** + * Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to GetHistogramRequest. + */ + simpleHistogramFacets?: string[] | null; + } + /** + * Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter. + */ + export interface Schema$HistogramResult { + /** + * The Histogram search filters. + */ + searchType?: string | null; + /** + * A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search. + */ + values?: {[key: string]: number} | null; + } + /** + * Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest. + */ + export interface Schema$HistogramResults { + /** + * Specifies compensation field-based histogram results that matches HistogramFacets.compensation_histogram_requests. + */ + compensationHistogramResults?: Schema$CompensationHistogramResult[]; + /** + * Specifies histogram results for custom attributes that matches HistogramFacets.custom_attribute_histogram_facets. + */ + customAttributeHistogramResults?: Schema$CustomAttributeHistogramResult[]; + /** + * Specifies histogram results that matches HistogramFacets.simple_histogram_facets. + */ + simpleHistogramResults?: Schema$HistogramResult[]; + } + /** + * A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job. + */ + export interface Schema$Job { + /** + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255. + */ + applicationEmailList?: string[] | null; + /** + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000. + */ + applicationInstruction?: string | null; + /** + * Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000. + */ + applicationUrls?: string[] | null; + /** + * Optional. The benefits included with the job. + */ + benefits?: string[] | null; + /** + * Output only. The name of the company listing the job. + */ + companyDisplayName?: string | null; + /** + * Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id. + */ + companyName?: string | null; + /** + * Deprecated. Use company_display_name instead. Output only. The name of the company listing the job. + */ + companyTitle?: string | null; + /** + * Optional. Job compensation information. + */ + compensationInfo?: Schema$CompensationInfo; + /** + * Output only. The timestamp when this job was created. + */ + createTime?: string | null; + /** + * Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. + */ + customAttributes?: {[key: string]: Schema$CustomAttribute} | null; + /** + * Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255. + */ + department?: string | null; + /** + * Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. + */ + description?: string | null; + /** + * Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255. + */ + distributorCompanyId?: string | null; + /** + * Optional. The desired education level for the job, such as "Bachelors", "Masters", "Doctorate". + */ + educationLevels?: string[] | null; + /** + * Optional. The employment type(s) of a job, for example, full time or part time. + */ + employmentTypes?: string[] | null; + /** + * Optional. The end date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored. + */ + endDate?: Schema$Date; + /** + * Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. + */ + expireTime?: string | null; + /** + * Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. + */ + expiryDate?: Schema$Date; + /** + * Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown. + */ + extendedCompensationInfo?: Schema$ExtendedCompensationInfo; + /** + * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned. + */ + filterableCustomFields?: {[key: string]: Schema$CustomField} | null; + /** + * Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. + */ + incentives?: string | null; + /** + * Output only. Structured locations of the job, resolved from locations. + */ + jobLocations?: Schema$JobLocation[]; + /** + * Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. + */ + jobTitle?: string | null; + /** + * Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. + */ + languageCode?: string | null; + /** + * Optional. The experience level associated with the job, such as "Entry Level". + */ + level?: string | null; + /** + * Optional but strongly recommended for the best service experience. Location(s) where the emploeyer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500. + */ + locations?: string[] | null; + /** + * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + */ + name?: string | null; + /** + * Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. + */ + promotionValue?: number | null; + /** + * Optional. The date this job was most recently published in UTC format. The default value is the time the request arrives at the server. + */ + publishDate?: Schema$Date; + /** + * Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. + */ + qualifications?: string | null; + /** + * Output only. The URL of a web page that displays job details. + */ + referenceUrl?: string | null; + /** + * Optional. The job Region (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job if an exact location match is not specified. If this field is set, setting job locations to the same location level as this field is strongly recommended. + */ + region?: string | null; + /** + * Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255. + */ + requisitionId?: string | null; + /** + * Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. + */ + responsibilities?: string | null; + /** + * Optional. The start date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored. + */ + startDate?: Schema$Date; + /** + * Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string. + */ + unindexedCustomFields?: {[key: string]: Schema$CustomField} | null; + /** + * Output only. The timestamp when this job was last updated. + */ + updateTime?: string | null; + /** + * Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE if not specified. Currently only JobVisibility.PRIVATE is supported. + */ + visibility?: string | null; + } + /** + * Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram. + */ + export interface Schema$JobFilters { + /** + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. + */ + categories?: string[] | null; + /** + * Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time. + */ + commuteFilter?: Schema$CommutePreference; + /** + * Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed. + */ + companyNames?: string[] | null; + /** + * Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company title filters are allowed. + */ + companyTitles?: string[] | null; + /** + * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet this criteria are searched. If a filter is not defined, all open jobs are searched. + */ + compensationFilter?: Schema$CompensationFilter; + /** + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 + */ + customAttributeFilter?: string | null; + /** + * Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding 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?: {[key: string]: Schema$CustomFieldFilter} | null; + /** + * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. + */ + disableSpellCheck?: boolean | null; + /** + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. + */ + employmentTypes?: string[] | null; + /** + * Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched. + */ + extendedCompensationFilter?: Schema$ExtendedCompensationFilter; + /** + * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. + */ + languageCodes?: string[] | null; + /** + * 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 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[]; + /** + * Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value is not specified, all open jobs are searched against regardless of the date they were published. + */ + publishDateRange?: string | null; + /** + * Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters. + */ + query?: string | null; + /** + * Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against. + */ + tenantJobOnly?: boolean | null; + } + /** + * Output only. A resource that represents a location with full geographic information. + */ + export interface Schema$JobLocation { + /** + * An object representing a latitude/longitude pair. + */ + latLng?: Schema$LatLng; + /** + * The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY. + */ + locationType?: string | null; + /** + * Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location. + */ + postalAddress?: Schema$PostalAddress; + /** + * Radius in meters 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 of 7885.79 meters. + */ + radiusMeters?: number | null; + } + /** + * Input only. Options for job processing. + */ + export interface Schema$JobProcessingOptions { + /** + * Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job. + */ + disableStreetAddressResolution?: boolean | null; + /** + * Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY. + */ + htmlSanitization?: string | null; + } + /** + * Input only. The query required to perform a search query or histogram. + */ + export interface Schema$JobQuery { + /** + * Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against. + */ + categories?: string[] | null; + /** + * Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time. + */ + commuteFilter?: Schema$CommutePreference; + /** + * Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed. + */ + companyDisplayNames?: string[] | null; + /** + * Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. At most 20 company filters are allowed. + */ + companyNames?: string[] | null; + /** + * Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched. + */ + compensationFilter?: Schema$CompensationFilter; + /** + * Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100 + */ + customAttributeFilter?: string | null; + /** + * Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed. + */ + disableSpellCheck?: boolean | null; + /** + * Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types. + */ + employmentTypes?: string[] | null; + /** + * Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed. + */ + languageCodes?: string[] | null; + /** + * Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a 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. 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[]; + /** + * Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value isn't specified, all open jobs are searched against regardless of their published date. + */ + publishDateRange?: string | null; + /** + * Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes. + */ + query?: string | null; + } + /** + * 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 | null; + /** + * The longitude in degrees. It must be in the range [-180.0, +180.0]. + */ + longitude?: number | null; + } + /** + * Output only. The List companies response object. + */ + export interface Schema$ListCompaniesResponse { + /** + * Companies for the current client. + */ + companies?: Schema$Company[]; + /** + * Additional information for the API invocation, such as the request tracking id. + */ + metadata?: Schema$ResponseMetadata; + /** + * A token to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object. + */ + export interface Schema$ListCompanyJobsResponse { + /** + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. + */ + jobs?: Schema$Job[]; + /** + * Additional information for the API invocation, such as the request tracking id. + */ + metadata?: Schema$ResponseMetadata; + /** + * A token to retrieve the next page of results. + */ + nextPageToken?: string | null; + /** + * The total number of open jobs. The result will be empty if ListCompanyJobsRequest.include_jobs_count is not enabled or if no open jobs are available. + */ + totalSize?: string | null; + } + /** + * Output only. List jobs response. + */ + export interface Schema$ListJobsResponse { + /** + * The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request. + */ + jobs?: Schema$Job[]; + /** + * Additional information for the API invocation, such as the request tracking id. + */ + metadata?: Schema$ResponseMetadata; + /** + * A token to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Input only. Geographic region of the search. + */ + export interface Schema$LocationFilter { + /** + * Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored. + */ + distanceInMiles?: number | null; + /** + * Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.allow_telecommute indicates if a job permits telecommuting. If this field is true, telecommuting jobs are searched, and name and lat_lng are ignored. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response. + */ + isTelecommute?: boolean | null; + /** + * Optional. The latitude and longitude of the geographic center from which to search. This field is ignored if `location_name` is provided. + */ + latLng?: Schema$LatLng; + /** + * Optional. The address name, such as "Mountain View" or "Bay Area". + */ + name?: string | null; + /** + * Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + */ + regionCode?: string | null; + } + /** + * Output only. Job entry with metadata inside SearchJobsResponse. + */ + export interface Schema$MatchingJob { + /** + * Commute information which is generated based on specified CommutePreference. + */ + commuteInfo?: Schema$CommuteInfo; + /** + * Job resource that matches the specified SearchJobsRequest. + */ + job?: Schema$Job; + /** + * A summary of the job with core information that's displayed on the search results listing page. + */ + jobSummary?: string | null; + /** + * Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags. + */ + jobTitleSnippet?: string | null; + /** + * Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. + */ + searchTextSnippet?: string | null; + } + /** + * Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2 + */ + export interface Schema$MendelDebugInput { + /** + * When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details. + */ + namespacedDebugInput?: {[key: string]: Schema$NamespacedDebugInput} | null; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The 3-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * 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 | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } + /** + * Next ID: 15 + */ + export interface Schema$NamespacedDebugInput { + /** + * Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions. + */ + absolutelyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions. + */ + absolutelyForcedExps?: number[] | null; + /** + * Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions. + */ + absolutelyForcedExpTags?: string[] | null; + /** + * Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpNames?: string[] | null; + /** + * Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExps?: number[] | null; + /** + * Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true. + */ + conditionallyForcedExpTags?: string[] | null; + /** + * If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments. + */ + disableAutomaticEnrollmentSelection?: boolean | null; + /** + * Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExpNames?: string[] | null; + /** + * Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together. + */ + disableExps?: number[] | null; + /** + * Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. + */ + disableExpTags?: string[] | null; + /** + * If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments. + */ + disableManualEnrollmentSelection?: boolean | null; + /** + * If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem. + */ + disableOrganicSelection?: boolean | null; + /** + * Flags to force in a particular experiment state. Map from flag name to flag value. + */ + forcedFlags?: {[key: string]: string} | null; + /** + * Rollouts to force in a particular experiment state. Map from rollout name to rollout value. + */ + forcedRollouts?: {[key: string]: boolean} | null; + } + /** + * Input only. Use this field to specify bucketing option for the histogram search response. + */ + export interface Schema$NumericBucketingOption { + /** + * Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported. + */ + bucketBounds?: number[] | null; + /** + * Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field. + */ + requiresMinMax?: boolean | null; + } + /** + * Output only. Custom numeric bucketing result. + */ + export interface Schema$NumericBucketingResult { + /** + * Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1. + */ + counts?: Schema$BucketizedCount[]; + /** + * Stores the maximum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. + */ + maxValue?: number | null; + /** + * Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true. + */ + minValue?: number | null; + } + /** + * Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 + */ + export interface Schema$PostalAddress { + /** + * Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). + */ + addressLines?: string[] | null; + /** + * Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. + */ + administrativeArea?: string | null; + /** + * Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en". + */ + languageCode?: string | null; + /** + * Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. + */ + locality?: string | null; + /** + * Optional. The name of the organization at the address. + */ + organization?: string | null; + /** + * Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.). + */ + postalCode?: string | null; + /** + * Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information. + */ + recipients?: string[] | null; + /** + * Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. + */ + regionCode?: string | null; + /** + * The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions. + */ + revision?: number | null; + /** + * Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire). + */ + sortingCode?: string | null; + /** + * Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts. + */ + sublocality?: string | null; + } + /** + * Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service. + */ + export interface Schema$RequestMetadata { + /** + * Optional. The type of device used by the job seeker at the time of the call to the service. + */ + deviceInfo?: Schema$DeviceInfo; + /** + * Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain. + */ + domain?: string | null; + /** + * Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id. + */ + sessionId?: string | null; + /** + * Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id. + */ + userId?: string | null; + } + /** + * Output only. Additional information returned to client, such as debugging information. + */ + export interface Schema$ResponseMetadata { + /** + * Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only. + */ + experimentIdList?: number[] | null; + /** + * For search response only. Indicates the mode of a performed search. + */ + mode?: string | null; + /** + * A unique id associated with this call. This id is logged for tracking purposes. + */ + requestId?: string | null; + } + /** + * Input only. The Request body of the `SearchJobs` call. + */ + export interface Schema$SearchJobsRequest { + /** + * 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 thresholding improves the accuracy of subsequent search requests. Defaults to false. + */ + disableRelevanceThresholding?: boolean | null; + /** + * Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false. + */ + enableBroadening?: boolean | null; + /** + * Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false. + */ + enablePreciseResultSize?: boolean | null; + /** + * Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location. + */ + filters?: Schema$JobFilters; + /** + * Optional. Restrictions on what fields to perform histogram on, such as `COMPANY_SIZE` etc. + */ + histogramFacets?: Schema$HistogramFacets; + /** + * Optional. The number of job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified. + */ + jobView?: string | null; + /** + * Required. Mode of a search. + */ + mode?: string | null; + /** + * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). + */ + offset?: number | null; + /** + * Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. + */ + orderBy?: string | null; + /** + * Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100. + */ + pageSize?: number | null; + /** + * Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results. + */ + pageToken?: string | null; + /** + * Optional. Query used to search against jobs, such as keyword, location filters, etc. + */ + query?: Schema$JobQuery; + /** + * Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent. + */ + requestMetadata?: Schema$RequestMetadata; + /** + * Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified. + */ + sortBy?: string | null; + } + /** + * Output only. Response for SearchJob method. + */ + export interface Schema$SearchJobsResponse { + /** + * The commute filter the service applied to the specified query. This information is only available when query has a valid CommutePreference. + */ + appliedCommuteFilter?: Schema$CommutePreference; + /** + * The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED. + */ + appliedJobLocationFilters?: Schema$JobLocation[]; + /** + * An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size. + */ + estimatedTotalSize?: string | null; + /** + * The histogram results that match specified SearchJobsRequest.HistogramFacets. + */ + histogramResults?: Schema$HistogramResults; + /** + * Corresponds to SearchJobsRequest.job_view. + */ + jobView?: string | null; + /** + * The Job entities that match the specified SearchJobsRequest. + */ + matchingJobs?: Schema$MatchingJob[]; + /** + * Additional information for the API invocation, such as the request tracking id. + */ + metadata?: Schema$ResponseMetadata; + /** + * The token that specifies the starting position of the next page of results. This field is empty if there are no more results. + */ + nextPageToken?: string | null; + /** + * If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0 means all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results. + */ + numJobsFromBroadenedQuery?: number | null; + /** + * The spell checking result, and correction. + */ + spellResult?: 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 of results. Otherwise, the value will be `-1`. + */ + totalSize?: string | null; + } + /** + * Output only. Spell check result. + */ + export interface Schema$SpellingCorrection { + /** + * Indicates if the query was corrected by the spell checker. + */ + corrected?: boolean | null; + /** + * Correction output consisting of the corrected keyword string. + */ + correctedText?: string | null; + } + /** + * Represents array of string values. + */ + export interface Schema$StringValues { + /** + * Required. String values. + */ + values?: string[] | null; + } + /** + * Input only. Update job request. + */ + export interface Schema$UpdateJobRequest { + /** + * Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job. + */ + disableStreetAddressResolution?: boolean | null; + /** + * Required. The Job to be updated. + */ + job?: Schema$Job; + /** + * Optional. Options for job processing. UpdateJobRequest.disable_street_address_resolution is ignored if this flag is set. + */ + processingOptions?: Schema$JobProcessingOptions; + /** + * Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated) + */ + updateJobFields?: string | null; + } + + export class Resource$Companies { + context: APIRequestContext; + jobs: Resource$Companies$Jobs; + constructor(context: APIRequestContext) { + this.context = context; + this.jobs = new Resource$Companies$Jobs(this.context); + } + + /** + * jobs.companies.create + * @desc Creates a new company entity. + * @alias jobs.companies.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().Company} params.requestBody Request body data + * @param {object} [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$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Companies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Companies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Companies$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Companies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Companies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/companies').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.companies.delete + * @desc Deletes the specified company. + * @alias jobs.companies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the company to be deleted, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * @param {object} [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$Companies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Companies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Companies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Companies$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Companies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Companies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.companies.get + * @desc Retrieves the specified company. + * @alias jobs.companies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Resource name of the company to retrieve, such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * @param {object} [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 + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.companies.list + * @desc Lists all companies associated with a Cloud Talent Solution account. + * @alias jobs.companies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.mustHaveOpenJobs Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + * @param {integer=} params.pageSize Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. + * @param {string=} params.pageToken Optional. The starting indicator from which to return 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$Companies$List, + options?: MethodOptions + ): GaxiosPromise; + 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 | GaxiosPromise { + 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://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/companies').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.companies.patch + * @desc Updates the specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them. + * @alias jobs.companies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * @param {string=} params.updateCompanyFields Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) + * @param {().Company} params.requestBody Request body data + * @param {object} [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$Companies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Companies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Companies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Companies$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Companies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Companies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Companies$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$Company; + } + export interface Params$Resource$Companies$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the company to be deleted, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + */ + name?: string; + } + export interface Params$Resource$Companies$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Resource name of the company to retrieve, such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + */ + name?: string; + } + export interface Params$Resource$Companies$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned. + */ + mustHaveOpenJobs?: boolean; + /** + * Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided. + */ + pageSize?: number; + /** + * Optional. The starting indicator from which to return results. + */ + pageToken?: string; + } + export interface Params$Resource$Companies$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + */ + name?: string; + /** + * Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated) + */ + updateCompanyFields?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Company; + } + + export class Resource$Companies$Jobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * jobs.companies.jobs.list + * @desc Deprecated. Use ListJobs instead. Lists all jobs associated with a company. + * @alias jobs.companies.jobs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.companyName Required. The resource name of the company that owns the jobs to be listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + * @param {boolean=} params.idsOnly Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. + * @param {boolean=} params.includeJobsCount Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. + * @param {string=} params.jobRequisitionId Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. + * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. + * @param {string=} params.pageToken Optional. The starting point of a query result. + * @param {object} [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$Jobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Companies$Jobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Companies$Jobs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Companies$Jobs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Companies$Jobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Companies$Jobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+companyName}/jobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['companyName'], + pathParams: ['companyName'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Companies$Jobs$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the company that owns the jobs to be listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd". + */ + companyName?: string; + /** + * Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false. + */ + idsOnly?: boolean; + /** + * Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false. + */ + includeJobsCount?: boolean; + /** + * Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225. + */ + jobRequisitionId?: string; + /** + * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. + */ + pageSize?: number; + /** + * Optional. The starting point of a query result. + */ + pageToken?: string; + } + + export class Resource$Jobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * jobs.jobs.batchDelete + * @desc Deletes a list of Job postings by filter. + * @alias jobs.jobs.batchDelete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().BatchDeleteJobsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + batchDelete( + params?: Params$Resource$Jobs$Batchdelete, + options?: MethodOptions + ): GaxiosPromise; + batchDelete( + params: Params$Resource$Jobs$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Jobs$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete(callback: BodyResponseCallback): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Jobs$Batchdelete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/jobs:batchDelete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.create + * @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes. + * @alias jobs.jobs.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().CreateJobRequest} params.requestBody Request body data + * @param {object} [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$Jobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Jobs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Jobs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Jobs$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/jobs').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.delete + * @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes. + * @alias jobs.jobs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {boolean=} params.disableFastProcess Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. + * @param {string} params.name Required. The resource name of the job to be deleted, such as "jobs/11111111". + * @param {object} [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$Jobs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Jobs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Jobs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Jobs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.deleteByFilter + * @desc Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned. + * @alias jobs.jobs.deleteByFilter + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().DeleteJobsByFilterRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteByFilter( + params?: Params$Resource$Jobs$Deletebyfilter, + options?: MethodOptions + ): GaxiosPromise; + deleteByFilter( + params: Params$Resource$Jobs$Deletebyfilter, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteByFilter( + params: Params$Resource$Jobs$Deletebyfilter, + callback: BodyResponseCallback + ): void; + deleteByFilter(callback: BodyResponseCallback): void; + deleteByFilter( + paramsOrCallback?: + | Params$Resource$Jobs$Deletebyfilter + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Jobs$Deletebyfilter; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Deletebyfilter; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/jobs:deleteByFilter').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.get + * @desc Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days. + * @alias jobs.jobs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the job to retrieve, such as "jobs/11111111". + * @param {object} [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$Jobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Jobs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Jobs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Jobs$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.histogram + * @desc Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state. + * @alias jobs.jobs.histogram + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().GetHistogramRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + histogram( + params?: Params$Resource$Jobs$Histogram, + options?: MethodOptions + ): GaxiosPromise; + histogram( + params: Params$Resource$Jobs$Histogram, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + histogram( + params: Params$Resource$Jobs$Histogram, + callback: BodyResponseCallback + ): void; + histogram( + callback: BodyResponseCallback + ): void; + histogram( + paramsOrCallback?: + | Params$Resource$Jobs$Histogram + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$Histogram; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Histogram; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/jobs:histogram').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.list + * @desc Lists jobs by filter. + * @alias jobs.jobs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" + * @param {boolean=} params.idsOnly Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. + * @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. + * @param {string=} params.pageToken Optional. The starting point of a query result. + * @param {object} [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$Jobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Jobs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Jobs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Jobs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/jobs').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.patch + * @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes. + * @alias jobs.jobs.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + * @param {().UpdateJobRequest} params.requestBody Request body data + * @param {object} [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$Jobs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Jobs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Jobs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Jobs$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.search + * @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against. + * @alias jobs.jobs.search + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SearchJobsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + search( + params?: Params$Resource$Jobs$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Jobs$Search, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Jobs$Search, + callback: BodyResponseCallback + ): void; + search(callback: BodyResponseCallback): void; + search( + paramsOrCallback?: + | Params$Resource$Jobs$Search + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Jobs$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/jobs:search').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * jobs.jobs.searchForAlert + * @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against. + * @alias jobs.jobs.searchForAlert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().SearchJobsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + searchForAlert( + params?: Params$Resource$Jobs$Searchforalert, + options?: MethodOptions + ): GaxiosPromise; + searchForAlert( + params: Params$Resource$Jobs$Searchforalert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchForAlert( + params: Params$Resource$Jobs$Searchforalert, + callback: BodyResponseCallback + ): void; + searchForAlert( + callback: BodyResponseCallback + ): void; + searchForAlert( + paramsOrCallback?: + | Params$Resource$Jobs$Searchforalert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Jobs$Searchforalert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Jobs$Searchforalert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/jobs:searchForAlert').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Jobs$Batchdelete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchDeleteJobsRequest; + } + export interface Params$Resource$Jobs$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateJobRequest; + } + export interface Params$Resource$Jobs$Delete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster. + */ + disableFastProcess?: boolean; + /** + * Required. The resource name of the job to be deleted, such as "jobs/11111111". + */ + name?: string; + } + export interface Params$Resource$Jobs$Deletebyfilter + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$DeleteJobsByFilterRequest; + } + export interface Params$Resource$Jobs$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the job to retrieve, such as "jobs/11111111". + */ + name?: string; + } + export interface Params$Resource$Jobs$Histogram extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$GetHistogramRequest; + } + export interface Params$Resource$Jobs$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1" + */ + filter?: string; + /** + * Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false. + */ + idsOnly?: boolean; + /** + * Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified. + */ + pageSize?: number; + /** + * Optional. The starting point of a query result. + */ + pageToken?: string; + } + export interface Params$Resource$Jobs$Patch extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateJobRequest; + } + export interface Params$Resource$Jobs$Search extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchJobsRequest; + } + export interface Params$Resource$Jobs$Searchforalert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchJobsRequest; + } + + export class Resource$V2 { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * jobs.complete + * @desc Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box. + * @alias jobs.complete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.companyName Optional. If provided, restricts completion to the specified company. + * @param {string=} params.languageCode Required. 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. + * @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. + * @param {string=} params.scope Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. + * @param {string=} params.type Optional. The completion topic. The default is CompletionType.COMBINED. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + complete( + params?: Params$Resource$V2$Complete, + options?: MethodOptions + ): GaxiosPromise; + complete( + params: Params$Resource$V2$Complete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + complete( + params: Params$Resource$V2$Complete, + callback: BodyResponseCallback + ): void; + complete( + callback: BodyResponseCallback + ): void; + complete( + paramsOrCallback?: + | Params$Resource$V2$Complete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$V2$Complete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V2$Complete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://jobs.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2:complete').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$V2$Complete extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. If provided, restricts completion to the specified company. + */ + companyName?: string; + /** + * Required. 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. + */ + languageCode?: string; + /** + * Required. Completion result count. The maximum allowed page size is 10. + */ + pageSize?: number; + /** + * Required. The query used to generate suggestions. + */ + query?: string; + /** + * Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC. + */ + scope?: string; + /** + * Optional. The completion topic. The default is CompletionType.COMBINED. + */ + type?: string; + } +} diff --git a/src/apis/managedidentities/v1.ts b/src/apis/managedidentities/v1.ts index 52fad27c7ff..6339a7bc45f 100644 --- a/src/apis/managedidentities/v1.ts +++ b/src/apis/managedidentities/v1.ts @@ -1747,7 +1747,7 @@ export namespace managedidentities_v1 { /** * managedidentities.projects.locations.global.domains.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @alias managedidentities.projects.locations.global.domains.setIamPolicy * @memberOf! () * @@ -1821,7 +1821,7 @@ export namespace managedidentities_v1 { /** * managedidentities.projects.locations.global.domains.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias managedidentities.projects.locations.global.domains.testIamPermissions * @memberOf! () * diff --git a/src/apis/managedidentities/v1alpha1.ts b/src/apis/managedidentities/v1alpha1.ts index ce1a4f29738..bb6f8414b1e 100644 --- a/src/apis/managedidentities/v1alpha1.ts +++ b/src/apis/managedidentities/v1alpha1.ts @@ -1719,7 +1719,7 @@ export namespace managedidentities_v1alpha1 { /** * managedidentities.projects.locations.global.domains.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @alias managedidentities.projects.locations.global.domains.setIamPolicy * @memberOf! () * @@ -1793,7 +1793,7 @@ export namespace managedidentities_v1alpha1 { /** * managedidentities.projects.locations.global.domains.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias managedidentities.projects.locations.global.domains.testIamPermissions * @memberOf! () * diff --git a/src/apis/managedidentities/v1beta1.ts b/src/apis/managedidentities/v1beta1.ts index eb9d833d7a2..a71957e6864 100644 --- a/src/apis/managedidentities/v1beta1.ts +++ b/src/apis/managedidentities/v1beta1.ts @@ -1747,7 +1747,7 @@ export namespace managedidentities_v1beta1 { /** * managedidentities.projects.locations.global.domains.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @alias managedidentities.projects.locations.global.domains.setIamPolicy * @memberOf! () * @@ -1821,7 +1821,7 @@ export namespace managedidentities_v1beta1 { /** * managedidentities.projects.locations.global.domains.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias managedidentities.projects.locations.global.domains.testIamPermissions * @memberOf! () * diff --git a/src/apis/memcache/v1beta2.ts b/src/apis/memcache/v1beta2.ts index 9bc4f8642be..cad155fc7b2 100644 --- a/src/apis/memcache/v1beta2.ts +++ b/src/apis/memcache/v1beta2.ts @@ -214,31 +214,31 @@ export namespace memcache_v1beta2 { */ export interface Schema$GoogleCloudMemcacheV1beta2OperationMetadata { /** - * API version used to start the operation. + * Output only. API version used to start the operation. */ apiVersion?: string | null; /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ cancelRequested?: boolean | null; /** - * Time when the operation was created. + * Output only. Time when the operation was created. */ createTime?: string | null; /** - * Time when the operation finished running. + * Output only. Time when the operation finished running. */ endTime?: string | null; /** - * Human-readable status of the operation, if any. + * Output only. Human-readable status of the operation, if any. */ statusDetail?: string | null; /** - * Server-defined resource path for the target of the operation. + * Output only. Server-defined resource path for the target of the operation. */ target?: string | null; /** - * Name of the verb executed by the operation. + * Output only. Name of the verb executed by the operation. */ verb?: string | null; } @@ -1081,7 +1081,7 @@ export namespace memcache_v1beta2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region + * @param {string} params.name Required. Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1717,7 +1717,7 @@ export namespace memcache_v1beta2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region + * Required. Memcached instance resource name in the format: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region */ name?: string; } diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 748a547fce6..1ceaafe39c2 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -134,7 +134,7 @@ export namespace ml_v1 { } export interface Schema$GoogleCloudMlV1_AutomatedStoppingConfig_DecayCurveAutomatedStoppingConfig { /** - * True if measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis. + * If true, measurement.elapsed_time is used as the x-axis of each Trials Decay Curve. Otherwise, Measurement.steps will be used as the x-axis. */ useElapsedTime?: boolean | null; } @@ -143,7 +143,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1_AutomatedStoppingConfig_MedianAutomatedStoppingConfig { /** - * True if median automated stopping rule applies on measurement.use_elapsed_time. it means that elapsed_time field of latest measurement of current trial is used to compute median objective value for each completed trials. + * If true, the median automated stopping rule applies to measurement.use_elapsed_time, which means the elapsed_time field of the current trial's latest measurement is used to compute the median objective value for each completed trial. */ useElapsedTime?: boolean | null; } @@ -286,7 +286,7 @@ export namespace ml_v1 { type?: string | null; } /** - * A message representing a parameter to be tuned. + * A message representing a parameter to be tuned. Contains the name of the parameter and the suggested value to use for this trial. */ export interface Schema$GoogleCloudMlV1_Trial_Parameter { /** @@ -381,7 +381,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__CheckTrialEarlyStoppingStateMetatdata { /** - * The time operation was submitted. + * The time at which the operation was submitted. */ createTime?: string | null; /** @@ -389,7 +389,7 @@ export namespace ml_v1 { */ study?: string | null; /** - * The Trial name. + * The trial name. */ trial?: string | null; } @@ -402,7 +402,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__CheckTrialEarlyStoppingStateResponse { /** - * The time operation processing completed. + * The time at which operation processing completed. */ endTime?: string | null; /** @@ -410,7 +410,7 @@ export namespace ml_v1 { */ shouldStop?: boolean | null; /** - * The time operation was started. + * The time at which the operation was started. */ startTime?: string | null; } @@ -423,7 +423,7 @@ export namespace ml_v1 { */ finalMeasurement?: Schema$GoogleCloudMlV1__Measurement; /** - * Optional. A human readable reason why the Trial was infeasible. This should only be provided if `trial_infeasible` is true. + * Optional. A human readable reason why the trial was infeasible. This should only be provided if `trial_infeasible` is true. */ infeasibleReason?: string | null; /** @@ -442,7 +442,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__EncryptionConfig { /** - * The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource, such as a training job. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. + * The Cloud KMS resource identifier of the customer-managed encryption key used to protect a resource, such as a training job. It has the following format: `projects/{PROJECT_ID}/locations/{REGION}/keyRings/{KEY_RING_NAME}/cryptoKeys/{KEY_NAME}` */ kmsKeyName?: string | null; } @@ -668,7 +668,7 @@ export namespace ml_v1 { } export interface Schema$GoogleCloudMlV1__ListStudiesResponse { /** - * The Studies associated with the project. + * The studies associated with the project. */ studies?: Schema$GoogleCloudMlV1__Study[]; } @@ -711,11 +711,11 @@ export namespace ml_v1 { nodes?: number | null; } /** - * A message representing a Measurement. + * A message representing a measurement. */ export interface Schema$GoogleCloudMlV1__Measurement { /** - * Time that the Trial has been running at the point of this Measurement. + * Output only. Time that the trial has been running at the point of this measurement. */ elapsedTime?: string | null; /** @@ -979,7 +979,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__Study { /** - * Output only. Time that the study was created. + * Output only. Time at which the study was created. */ createTime?: string | null; /** @@ -1011,6 +1011,9 @@ export namespace ml_v1 { * Configuration for automated stopping of unpromising Trials. */ automatedStoppingConfig?: Schema$GoogleCloudMlV1__AutomatedStoppingConfig; + /** + * Metric specs for the study. + */ metrics?: Schema$GoogleCloudMlV1_StudyConfig_MetricSpec[]; /** * Required. The set of parameters to tune. @@ -1056,11 +1059,11 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__SuggestTrialsResponse { /** - * The time operation processing completed. + * The time at which operation processing completed. */ endTime?: string | null; /** - * The time operation was started. + * The time at which the operation was started. */ startTime?: string | null; /** @@ -1068,7 +1071,7 @@ export namespace ml_v1 { */ studyState?: string | null; /** - * A list of Trials. + * A list of trials. */ trials?: Schema$GoogleCloudMlV1__Trial[]; } @@ -1077,15 +1080,15 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__TrainingInput { /** - * Optional. Arguments passed to the training. - If it is a python package training: It will be passed as command line argument to the program. - If it is a custom container training, It will be passed as an argument to the custom container image. + * Optional. Command-line arguments passed to the training application when it starts. If your job uses a custom container, then the arguments are passed to the container's <a class="external" target="_blank" href="https://docs.docker.com/engine/reference/builder/#entrypoint"> `ENTRYPOINT`</a> command. */ args?: string[] | null; /** - * Custom encryption key options for a training job. If this is set, then all resources created by the training job will be encrypted with the provided encryption key. + * Optional. Options for using customer-managed encryption keys (CMEK) to protect resources created by a training job, instead of using Google's default encryption. If this is set, then all resources created by the training job will be encrypted with the customer-managed encryption key that you specify. [Learn how and when to use CMEK with AI Platform Training](/ai-platform/training/docs/cmek). */ encryptionConfig?: Schema$GoogleCloudMlV1__EncryptionConfig; /** - * Optional. The configuration for evaluators. You should only set `evaluatorConfig.acceleratorConfig` if `evaluatorType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `evaluatorConfig.imageUri` only if you build a custom image for your evaluator. If `evaluatorConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri` . Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers). + * Optional. The configuration for evaluators. You should only set `evaluatorConfig.acceleratorConfig` if `evaluatorType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `evaluatorConfig.imageUri` only if you build a custom image for your evaluator. If `evaluatorConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers). */ evaluatorConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** @@ -1117,7 +1120,7 @@ export namespace ml_v1 { */ packageUris?: string[] | null; /** - * Optional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri` . Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers). + * Optional. The configuration for parameter servers. You should only set `parameterServerConfig.acceleratorConfig` if `parameterServerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `parameterServerConfig.imageUri` only if you build a custom image for your parameter server. If `parameterServerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers). */ parameterServerConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** @@ -1157,7 +1160,7 @@ export namespace ml_v1 { */ useChiefInTfConfig?: boolean | null; /** - * Optional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri` . Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers). + * Optional. The configuration for workers. You should only set `workerConfig.acceleratorConfig` if `workerType` is set to a Compute Engine machine type. [Learn about restrictions on accelerator configurations for training.](/ai-platform/training/docs/using-gpus#compute-engine-machine-types-with-gpu) Set `workerConfig.imageUri` only if you build a custom image for your worker. If `workerConfig.imageUri` has not been set, AI Platform uses the value of `masterConfig.imageUri`. Learn more about [configuring custom containers](/ai-platform/training/docs/distributed-training-containers). */ workerConfig?: Schema$GoogleCloudMlV1__ReplicaConfig; /** @@ -1203,7 +1206,7 @@ export namespace ml_v1 { trials?: Schema$GoogleCloudMlV1__HyperparameterOutput[]; } /** - * A message representing a Trial. + * A message representing a trial. */ export interface Schema$GoogleCloudMlV1__Trial { /** @@ -1211,15 +1214,15 @@ export namespace ml_v1 { */ clientId?: string | null; /** - * Output only. Time the Trial's status changed to COMPLETED. + * Output only. Time at which the trial's status changed to COMPLETED. */ endTime?: string | null; /** - * The final Measurement containing the objective value. + * The final measurement containing the objective value. */ finalMeasurement?: Schema$GoogleCloudMlV1__Measurement; /** - * Output only. A human readable string describing why the Trial is infeasible. This should only be set if trial_infeasible is true. + * Output only. A human readable string describing why the trial is infeasible. This should only be set if trial_infeasible is true. */ infeasibleReason?: string | null; /** @@ -1231,11 +1234,11 @@ export namespace ml_v1 { */ name?: string | null; /** - * The parameters of the Trial. + * The parameters of the trial. */ parameters?: Schema$GoogleCloudMlV1_Trial_Parameter[]; /** - * Output only. Time the Trial was started. + * Output only. Time at which the trial was started. */ startTime?: string | null; /** @@ -1243,7 +1246,7 @@ export namespace ml_v1 { */ state?: string | null; /** - * Output only. True if the parameters in this trial should not be attempted again. + * Output only. If true, the parameters in this trial are not attempted again. */ trialInfeasible?: boolean | null; } @@ -3382,7 +3385,7 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.addMeasurement - * @desc Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. + * @desc Adds a measurement of the objective metrics to a trial. This measurement is assumed to have been taken before the trial is complete. * @alias ml.projects.locations.studies.trials.addMeasurement * @memberOf! () * @@ -3461,7 +3464,7 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.checkEarlyStoppingState - * @desc Checks whether a trial should stop or not. + * @desc Checks whether a trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. * @alias ml.projects.locations.studies.trials.checkEarlyStoppingState * @memberOf! () * @@ -3545,12 +3548,12 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.complete - * @desc Marks a Trial as complete. + * @desc Marks a trial as complete. * @alias ml.projects.locations.studies.trials.complete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The trial name. + * @param {string} params.name Required. The trial name.metat * @param {().GoogleCloudMlV1__CompleteTrialRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3624,7 +3627,7 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.create - * @desc Adds a user provided trial to a Study. + * @desc Adds a user provided trial to a study. * @alias ml.projects.locations.studies.trials.create * @memberOf! () * @@ -3701,7 +3704,7 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.delete - * @desc Deletes a Trial. + * @desc Deletes a trial. * @alias ml.projects.locations.studies.trials.delete * @memberOf! () * @@ -3774,7 +3777,7 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.get - * @desc Gets a Trial. + * @desc Gets a trial. * @alias ml.projects.locations.studies.trials.get * @memberOf! () * @@ -3847,7 +3850,7 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.list - * @desc Lists the trials associated with a Study. + * @desc Lists the trials associated with a study. * @alias ml.projects.locations.studies.trials.list * @memberOf! () * @@ -4006,7 +4009,7 @@ export namespace ml_v1 { /** * ml.projects.locations.studies.trials.suggest - * @desc Returns a long-running operation associated with the generation of trial suggestions. + * @desc Adds one or more trials to a study, with parameter values suggested by AI Platform Optimizer. Returns a long-running operation associated with the generation of trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. * @alias ml.projects.locations.studies.trials.suggest * @memberOf! () * @@ -4131,7 +4134,7 @@ export namespace ml_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The trial name. + * Required. The trial name.metat */ name?: string; diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 71d3e859fe3..8d041170a6f 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -383,10 +383,6 @@ export namespace monitoring_v3 { * A condition that compares a time series against a threshold. */ conditionThreshold?: Schema$MetricThreshold; - /** - * A condition that uses the Monitoring Query Language to define alerts. If set, no other conditions can be present. - */ - conditionTimeSeriesQueryLanguage?: Schema$TimeSeriesQueryLanguageCondition; /** * A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy. */ @@ -1634,19 +1630,6 @@ export namespace monitoring_v3 { */ pointDescriptors?: Schema$ValueDescriptor[]; } - /** - * A condition type that allows alert policies to be defined using Monitoring Query Language. - */ - export interface Schema$TimeSeriesQueryLanguageCondition { - /** - * Monitoring Query Language query that generates time series data and describes a condition for alerting on that data. - */ - query?: string | null; - /** - * A short explanation of what the query represents. For example:"Error ratio exceeds 15% for >5% of servers in >2 regions" - */ - summary?: string | null; - } /** * A TimeSeriesRatio specifies two TimeSeries to use for computing the good_service / total_service ratio. The specified TimeSeries must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. The TimeSeriesRatio must specify exactly two of good, bad, and total, and the relationship good_service + bad_service = total_service will be assumed. */ diff --git a/src/apis/oslogin/README.md b/src/apis/oslogin/README.md index 95f87e1f671..bab790661f2 100644 --- a/src/apis/oslogin/README.md +++ b/src/apis/oslogin/README.md @@ -2,7 +2,7 @@ # oslogin -> You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). +> You can use OS Login to manage access to your VM instances using IAM roles. ## Installation diff --git a/src/apis/prod_tt_sasportal/v1alpha1.ts b/src/apis/prod_tt_sasportal/v1alpha1.ts index 9baf4e257c6..420ceef315b 100644 --- a/src/apis/prod_tt_sasportal/v1alpha1.ts +++ b/src/apis/prod_tt_sasportal/v1alpha1.ts @@ -302,6 +302,10 @@ export namespace prod_tt_sasportal_v1alpha1 { * State of the grant. */ state?: string | null; + /** + * If the grant is suspended, the reason(s) for suspension. + */ + suspensionReason?: string[] | null; } /** * Information about the model of the device. @@ -404,6 +408,10 @@ export namespace prod_tt_sasportal_v1alpha1 { * If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. */ antennaModel?: string | null; + /** + * If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. + */ + cpeCbsdIndication?: boolean | null; /** * This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. */ @@ -1323,7 +1331,7 @@ export namespace prod_tt_sasportal_v1alpha1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. - * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. * @param {string} params.parent Required. The name of the parent resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1792,7 +1800,7 @@ export namespace prod_tt_sasportal_v1alpha1 { */ filter?: string; /** - * The maximum number of devices to return in the response. + * The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. */ pageSize?: number; /** @@ -3251,7 +3259,7 @@ export namespace prod_tt_sasportal_v1alpha1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. - * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. * @param {string} params.parent Required. The name of the parent resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3720,7 +3728,7 @@ export namespace prod_tt_sasportal_v1alpha1 { */ filter?: string; /** - * The maximum number of devices to return in the response. + * The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. */ pageSize?: number; /** @@ -4615,7 +4623,7 @@ export namespace prod_tt_sasportal_v1alpha1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. - * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. * @param {string} params.parent Required. The name of the parent resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4758,7 +4766,7 @@ export namespace prod_tt_sasportal_v1alpha1 { */ filter?: string; /** - * The maximum number of devices to return in the response. + * The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. */ pageSize?: number; /** diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index 050e7343e0a..39fc884b6cc 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -808,15 +808,19 @@ export namespace remotebuildexecution_v1 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest { /** - * Whether to enable Stackdriver logging for this instance. + * Specifies the instance to update. + */ + instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; + /** + * Deprecated, use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance. */ loggingEnabled?: boolean | null; /** - * Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Deprecated, use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string | null; /** - * The fields to update. + * The update mask applies to instance. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ updateMask?: string | null; } diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index a79f5aa5b5b..b8de2803b24 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -795,15 +795,19 @@ export namespace remotebuildexecution_v1alpha { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest { /** - * Whether to enable Stackdriver logging for this instance. + * Specifies the instance to update. + */ + instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; + /** + * Deprecated, use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance. */ loggingEnabled?: boolean | null; /** - * Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Deprecated, use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string | null; /** - * The fields to update. + * The update mask applies to instance. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ updateMask?: string | null; } diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index f8ff3b57a8b..c9a93961ab7 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -1067,15 +1067,19 @@ export namespace remotebuildexecution_v2 { */ export interface Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaUpdateInstanceRequest { /** - * Whether to enable Stackdriver logging for this instance. + * Specifies the instance to update. + */ + instance?: Schema$GoogleDevtoolsRemotebuildexecutionAdminV1alphaInstance; + /** + * Deprecated, use instance.logging_enabled instead. Whether to enable Stackdriver logging for this instance. */ loggingEnabled?: boolean | null; /** - * Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. + * Deprecated, use instance.Name instead. Name of the instance to update. Format: `projects/[PROJECT_ID]/instances/[INSTANCE_ID]`. */ name?: string | null; /** - * The fields to update. + * The update mask applies to instance. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If an empty update_mask is provided, only the non-default valued field in the worker pool field will be updated. Note that in order to update a field to the default value (zero, false, empty string) an explicit update_mask must be provided. */ updateMask?: string | null; } diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 75bc80cd310..6c320a9823e 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -1347,7 +1347,7 @@ export namespace run_v1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index 44baaa46f2f..427ed49ec56 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -1577,18 +1577,14 @@ export namespace run_v1alpha1 { * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ export interface Schema$Probe { - /** - * One and only one of the following should be specified. Exec specifies the action to take. A field inlined from the Handler message. - */ - exec?: Schema$ExecAction; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. +optional */ failureThreshold?: number | null; /** - * HTTPGet specifies the http request to perform. A field inlined from the Handler message. + * The action taken to determine the health of a container */ - httpGet?: Schema$HTTPGetAction; + handler?: Schema$Handler; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ @@ -1601,10 +1597,6 @@ export namespace run_v1alpha1 { * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness. Minimum value is 1. +optional */ successThreshold?: number | null; - /** - * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported A field inlined from the Handler message. - */ - tcpSocket?: Schema$TCPSocketAction; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes +optional */ @@ -2180,7 +2172,7 @@ export namespace run_v1alpha1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index e725fda02cd..15dd4b333c9 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -778,7 +778,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED + * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @alias runtimeconfig.projects.configs.setIamPolicy * @memberOf! () * @@ -852,7 +852,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.testIamPermissions * @memberOf! () * @@ -1220,7 +1220,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.operations.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.operations.testIamPermissions * @memberOf! () * @@ -1637,7 +1637,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.variables.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.variables.testIamPermissions * @memberOf! () * @@ -2295,7 +2295,7 @@ export namespace runtimeconfig_v1beta1 { /** * runtimeconfig.projects.configs.waiters.testIamPermissions - * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @desc Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @alias runtimeconfig.projects.configs.waiters.testIamPermissions * @memberOf! () * diff --git a/src/apis/sasportal/v1alpha1.ts b/src/apis/sasportal/v1alpha1.ts index 6f6dcddaa70..63a11d541bf 100644 --- a/src/apis/sasportal/v1alpha1.ts +++ b/src/apis/sasportal/v1alpha1.ts @@ -302,6 +302,10 @@ export namespace sasportal_v1alpha1 { * State of the grant. */ state?: string | null; + /** + * If the grant is suspended, the reason(s) for suspension. + */ + suspensionReason?: string[] | null; } /** * Information about the model of the device. @@ -404,6 +408,10 @@ export namespace sasportal_v1alpha1 { * If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. */ antennaModel?: string | null; + /** + * If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. + */ + cpeCbsdIndication?: boolean | null; /** * This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. */ @@ -1315,7 +1323,7 @@ export namespace sasportal_v1alpha1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. - * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. * @param {string} params.parent Required. The name of the parent resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1779,7 +1787,7 @@ export namespace sasportal_v1alpha1 { */ filter?: string; /** - * The maximum number of devices to return in the response. + * The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. */ pageSize?: number; /** @@ -3223,7 +3231,7 @@ export namespace sasportal_v1alpha1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. - * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. * @param {string} params.parent Required. The name of the parent resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3687,7 +3695,7 @@ export namespace sasportal_v1alpha1 { */ filter?: string; /** - * The maximum number of devices to return in the response. + * The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. */ pageSize?: number; /** @@ -4573,7 +4581,7 @@ export namespace sasportal_v1alpha1 { * * @param {object} params Parameters for request * @param {string=} params.filter The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the device. The filter is case insensitive. - * @param {integer=} params.pageSize The maximum number of devices to return in the response. + * @param {integer=} params.pageSize The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. * @param {string=} params.pageToken A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. * @param {string} params.parent Required. The name of the parent resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4715,7 +4723,7 @@ export namespace sasportal_v1alpha1 { */ filter?: string; /** - * The maximum number of devices to return in the response. + * The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. */ pageSize?: number; /** diff --git a/src/apis/script/v1.ts b/src/apis/script/v1.ts index 8169428652f..9eb517eae3e 100644 --- a/src/apis/script/v1.ts +++ b/src/apis/script/v1.ts @@ -217,7 +217,7 @@ export namespace script_v1 { */ export interface Schema$ExecuteStreamResponse { /** - * The result of the execution. TODO (johnlattin): Add debugging and logging. + * The result of the execution. */ result?: Schema$ScriptExecutionResult; } @@ -486,7 +486,7 @@ export namespace script_v1 { processes?: Schema$GoogleAppsScriptTypeProcess[]; } /** - * `ListValue` is a wrapper around a repeated field of values. Based on LustValue at: google3/apps/maestro/api/struct.proto?q=message%5c%20ListValue + * `ListValue` is a wrapper around a repeated field of values. */ export interface Schema$ListValue { /** @@ -592,11 +592,11 @@ export namespace script_v1 { updateTime?: string | null; } /** - * The result of an execution Based on ScriptExecutionResult at: google3/apps/maestro/api/frontend_execution_common.proto?q=message%5c%20ScriptExecutionResult + * The result of an execution. */ export interface Schema$ScriptExecutionResult { /** - * The returned value of the execution. TODO (johnlattin): Add HtmlResponse TODO (johnlattin): Add ExceptionResponse TODO (johlnattin): Add TextResponse + * The returned value of the execution. */ returnValue?: Schema$Value; } @@ -631,7 +631,7 @@ export namespace script_v1 { message?: string | null; } /** - * `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. Based on Struct at: google3/apps/maestro/api/struct.proto?q=message%5c%20Struct + * `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. */ export interface Schema$Struct { /** @@ -649,7 +649,7 @@ export namespace script_v1 { deploymentConfig?: Schema$DeploymentConfig; } /** - * `Value` represents a dynamically typed value which is the outcome of an executed script Based on Value at: google3/apps/maestro/api/struct.proto?q=message%5c%20Value + * `Value` represents a dynamically typed value which is the outcome of an executed script. */ export interface Schema$Value { /** diff --git a/src/apis/secretmanager/README.md b/src/apis/secretmanager/README.md index 1e07b9b022a..727634d4d4d 100644 --- a/src/apis/secretmanager/README.md +++ b/src/apis/secretmanager/README.md @@ -2,7 +2,7 @@ # secretmanager -> Stores API keys, passwords, certificates, and other sensitive data. Provides convenience while improving security. +> Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. ## Installation diff --git a/src/apis/secretmanager/v1.ts b/src/apis/secretmanager/v1.ts index 9b65d19cbf3..1b3139a3cd6 100644 --- a/src/apis/secretmanager/v1.ts +++ b/src/apis/secretmanager/v1.ts @@ -89,7 +89,7 @@ export namespace secretmanager_v1 { /** * Secret Manager API * - * Stores API keys, passwords, certificates, and other sensitive data. Provides convenience while improving security. + * Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. * * @example * const {google} = require('googleapis'); @@ -396,7 +396,7 @@ export namespace secretmanager_v1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } @@ -725,7 +725,7 @@ export namespace secretmanager_v1 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource name of the project to associate with the Secret, in the format `projects/x`. - * @param {string=} params.secretId Required. This must be unique within the project. + * @param {string=} params.secretId Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. * @param {().Secret} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1342,7 +1342,7 @@ export namespace secretmanager_v1 { */ parent?: string; /** - * Required. This must be unique within the project. + * Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. */ secretId?: string; diff --git a/src/apis/secretmanager/v1beta1.ts b/src/apis/secretmanager/v1beta1.ts index 8aa75d11015..fbcfa2ec93e 100644 --- a/src/apis/secretmanager/v1beta1.ts +++ b/src/apis/secretmanager/v1beta1.ts @@ -89,7 +89,7 @@ export namespace secretmanager_v1beta1 { /** * Secret Manager API * - * Stores API keys, passwords, certificates, and other sensitive data. Provides convenience while improving security. + * Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security. * * @example * const {google} = require('googleapis'); @@ -396,7 +396,7 @@ export namespace secretmanager_v1beta1 { */ policy?: Schema$Policy; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag" This field is only used by Cloud IAM. + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` */ updateMask?: string | null; } @@ -725,7 +725,7 @@ export namespace secretmanager_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The resource name of the project to associate with the Secret, in the format `projects/x`. - * @param {string=} params.secretId Required. This must be unique within the project. + * @param {string=} params.secretId Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. * @param {().Secret} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1342,7 +1342,7 @@ export namespace secretmanager_v1beta1 { */ parent?: string; /** - * Required. This must be unique within the project. + * Required. This must be unique within the project. A secret ID is a string with a maximum length of 255 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore (`_`) characters. */ secretId?: string; diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index 7848867282e..85ef9b6fb95 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -230,7 +230,7 @@ export namespace securitycenter_v1 { title?: string | null; } /** - * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. When adding a new field hidden behind a visibility label, ensure it is also hidden from Notifications: http://google3/java/com/google/cloud/security/riskdashboard/notification/actions/streaming/FindingTranslator.java?l=26 + * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. */ export interface Schema$Finding { /** diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index ae299739385..b0649e5a974 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -230,7 +230,7 @@ export namespace securitycenter_v1beta1 { title?: string | null; } /** - * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. When adding a new field hidden behind a visibility label, ensure it is also hidden from Notifications: http://google3/java/com/google/cloud/security/riskdashboard/notification/actions/streaming/FindingTranslator.java?l=26 + * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. */ export interface Schema$Finding { /** diff --git a/src/apis/securitycenter/v1p1alpha1.ts b/src/apis/securitycenter/v1p1alpha1.ts index f6c6511b7fb..19fa464b5ab 100644 --- a/src/apis/securitycenter/v1p1alpha1.ts +++ b/src/apis/securitycenter/v1p1alpha1.ts @@ -120,7 +120,7 @@ export namespace securitycenter_v1p1alpha1 { */ export interface Schema$Empty {} /** - * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. When adding a new field hidden behind a visibility label, ensure it is also hidden from Notifications: http://google3/java/com/google/cloud/security/riskdashboard/notification/actions/streaming/FindingTranslator.java?l=26 + * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. */ export interface Schema$Finding { /** diff --git a/src/apis/securitycenter/v1p1beta1.ts b/src/apis/securitycenter/v1p1beta1.ts index 6a314e97300..11514d08000 100644 --- a/src/apis/securitycenter/v1p1beta1.ts +++ b/src/apis/securitycenter/v1p1beta1.ts @@ -197,7 +197,7 @@ export namespace securitycenter_v1p1beta1 { title?: string | null; } /** - * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. When adding a new field hidden behind a visibility label, ensure it is also hidden from Notifications: http://google3/java/com/google/cloud/security/riskdashboard/notification/actions/streaming/FindingTranslator.java?l=26 + * Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. */ export interface Schema$Finding { /** diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 78b28fe09bd..7c19ca6ff64 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -1505,11 +1505,11 @@ export namespace serviceconsumermanagement_v1beta1 { /** * Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ - export interface Schema$V1Beta1RefreshConsumerResponse {} + export interface Schema$V1beta1RefreshConsumerResponse {} /** * Response message for the `RefreshConsumer` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ - export interface Schema$V1beta1RefreshConsumerResponse {} + export interface Schema$V1Beta1RefreshConsumerResponse {} /** * Response message for the `RemoveVisibilityLabels` method. This response message is assigned to the `response` field of the returned Operation when that operation is done. */ diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index d2edad46a82..4efb1918cee 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -1941,7 +1941,7 @@ export namespace servicemanagement_v1 { /** * servicemanagement.services.create - * @desc Creates a new managed service. Please note one producer project can own no more than 20 services. Operation + * @desc Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project. Operation * @alias servicemanagement.services.create * @memberOf! () * diff --git a/src/apis/slides/v1.ts b/src/apis/slides/v1.ts index aba77c801c1..e2d6e4e3f64 100644 --- a/src/apis/slides/v1.ts +++ b/src/apis/slides/v1.ts @@ -1224,11 +1224,11 @@ export namespace slides_v1 { */ locale?: string | null; /** - * The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts. They serve three purposes: - Placeholder shapes on a master contain the default text styles and shape properties of all placeholder shapes on pages that use that master. - The master page properties define the common page properties inherited by its layouts. - Any other shapes on the master slide will appear on all slides using that master, regardless of their layout. + * The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts. They serve three purposes: - Placeholder shapes on a master contain the default text styles and shape properties of all placeholder shapes on pages that use that master. - The master page properties define the common page properties inherited by its layouts. - Any other shapes on the master slide appear on all slides using that master, regardless of their layout. */ masters?: Schema$Page[]; /** - * The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master will appear on all notes pages. The notes master is read-only. + * The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appears on all notes pages. The notes master is read-only. */ notesMaster?: Schema$Page; /** @@ -2943,7 +2943,7 @@ export namespace slides_v1 { * @param {object} params Parameters for request * @param {string} params.pageObjectId The object ID of the page whose thumbnail to retrieve. * @param {string} params.presentationId The ID of the presentation to retrieve. - * @param {string=} params.thumbnailProperties.mimeType The optional mime type of the thumbnail image. If you don't specify the mime type, the default mime type will be PNG. + * @param {string=} params.thumbnailProperties.mimeType The optional mime type of the thumbnail image. If you don't specify the mime type, the mime type defaults to PNG. * @param {string=} params.thumbnailProperties.thumbnailSize The optional thumbnail image size. If you don't specify the size, the server chooses a default size of the image. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3044,7 +3044,7 @@ export namespace slides_v1 { */ presentationId?: string; /** - * The optional mime type of the thumbnail image. If you don't specify the mime type, the default mime type will be PNG. + * The optional mime type of the thumbnail image. If you don't specify the mime type, the mime type defaults to PNG. */ 'thumbnailProperties.mimeType'?: string; /** diff --git a/src/apis/speech/v1.ts b/src/apis/speech/v1.ts index 60a67de199c..8ed0ca02417 100644 --- a/src/apis/speech/v1.ts +++ b/src/apis/speech/v1.ts @@ -149,7 +149,7 @@ export namespace speech_v1 { */ startTime?: string | null; /** - * The URI of the audio file being transcribed. Empty if the audio was sent as byte content. + * Output only. The URI of the audio file being transcribed. Empty if the audio was sent as byte content. */ uri?: string | null; } @@ -226,7 +226,7 @@ export namespace speech_v1 { */ diarizationConfig?: Schema$SpeakerDiarizationConfig; /** - * 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. + * 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. */ enableAutomaticPunctuation?: boolean | null; /** diff --git a/src/apis/speech/v1p1beta1.ts b/src/apis/speech/v1p1beta1.ts index 7cee1245e8a..73c7b855dac 100644 --- a/src/apis/speech/v1p1beta1.ts +++ b/src/apis/speech/v1p1beta1.ts @@ -119,6 +119,32 @@ export namespace speech_v1p1beta1 { } } + /** + * An item of the class. + */ + export interface Schema$ClassItem { + /** + * The class item's value. + */ + value?: string | null; + } + /** + * A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases. + */ + export interface Schema$CustomClass { + /** + * If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. + */ + customClassId?: string | null; + /** + * A collection of class items. + */ + items?: Schema$ClassItem[]; + /** + * The resource name of the custom class. + */ + name?: string | null; + } /** * The response message for Operations.ListOperations. */ @@ -149,7 +175,7 @@ export namespace speech_v1p1beta1 { */ startTime?: string | null; /** - * The URI of the audio file being transcribed. Empty if the audio was sent as byte content. + * Output only. The URI of the audio file being transcribed. Empty if the audio was sent as byte content. */ uri?: string | null; } @@ -200,6 +226,36 @@ export namespace speech_v1p1beta1 { */ response?: {[key: string]: any} | null; } + /** + * A phrases containing words and phrase "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-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built $MONTH class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with $ e.g. $MONTH. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in ${...} e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in ${} (e.g. ${my-months}). + */ + export interface Schema$Phrase { + /** + * Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. + */ + boost?: number | null; + /** + * The phrase itself. + */ + value?: string | null; + } + /** + * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. + */ + export interface Schema$PhraseSet { + /** + * Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case. Speech recognition will skip PhraseSets with a boost value of 0. + */ + boost?: number | null; + /** + * The resource name of the phrase set. + */ + name?: string | null; + /** + * A list of word and phrases. + */ + phrases?: Schema$Phrase[]; + } /** * 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](https://cloud.google.com/speech-to-text/quotas#content). */ @@ -217,6 +273,10 @@ export namespace speech_v1p1beta1 { * Provides information to the recognizer that specifies how to process the request. */ export interface Schema$RecognitionConfig { + /** + * Speech adaptation configuration improves the accuracy of speech recognition. When speech adaptation is set it supersedes the `speech_contexts` field. For more information, see the [speech adaptation](https://cloud.google.com/speech-to-text/docs/context-strength) documentation. + */ + adaptation?: Schema$SpeechAdaptation; /** * 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](https://cloud.google.com/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). */ @@ -234,7 +294,7 @@ export namespace speech_v1p1beta1 { */ diarizationSpeakerCount?: number | null; /** - * 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. + * 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. */ enableAutomaticPunctuation?: boolean | null; /** @@ -374,6 +434,19 @@ export namespace speech_v1p1beta1 { */ speakerTag?: number | null; } + /** + * Speech adaptation configuration. + */ + export interface Schema$SpeechAdaptation { + /** + * A collection of custom classes. To specify the classes inline, leave the class' `name` blank and fill in the rest of its fields, giving it a unique `custom_class_id`. Refer to the inline defined class in phrase hints by its `custom_class_id`. + */ + customClasses?: Schema$CustomClass[]; + /** + * A collection of phrase sets. To specify the hints inline, leave the phrase set's `name` blank and fill in the rest of its fields. Any phrase set can use any custom class. + */ + phraseSets?: Schema$PhraseSet[]; + } /** * Provides "hints" to the speech recognizer to favor specific words and phrases in the results. */ diff --git a/src/apis/sql/v1beta4.ts b/src/apis/sql/v1beta4.ts index 71814715d6c..e484f7c751f 100644 --- a/src/apis/sql/v1beta4.ts +++ b/src/apis/sql/v1beta4.ts @@ -709,9 +709,9 @@ export namespace sql_v1beta4 { */ bakImportOptions?: { encryptionOptions?: { - pvkPassword?: string; certPath?: string; pvkPath?: string; + pvkPassword?: string; }; } | null; /** diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 78349a63934..639f73f30cf 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -184,6 +184,8 @@ export namespace storage_v1 { condition?: { age?: number; createdBefore?: string; + customTimeBefore?: string; + daysSinceCustomTime?: number; isLive?: boolean; matchesPattern?: string; matchesStorageClass?: string[]; @@ -252,9 +254,13 @@ export namespace storage_v1 { */ website?: {mainPageSuffix?: string; notFoundPage?: string} | null; /** - * The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won’t be able to use zonal quota. The zone or zones need to be within the bucket location otherwise the requests will fail with a 400 Bad Request response. + * The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won't be able to use zonal quota. The zone or zones need to be within the bucket location otherwise the requests will fail with a 400 Bad Request response. */ - zone_affinity?: string[] | null; + zoneAffinity?: string[] | null; + /** + * If set, objects placed in this bucket are required to be separated by disaster domain. + */ + zoneSeparation?: boolean | null; } /** * An access-control entry. @@ -602,6 +608,10 @@ export namespace storage_v1 { encryptionAlgorithm?: string; keySha256?: string; } | null; + /** + * A timestamp in RFC 3339 format specified by the user for an object. + */ + customTime?: string | null; /** * HTTP 1.1 Entity tag for the object. */ @@ -6244,6 +6254,7 @@ export namespace storage_v1 { * * @param {object} params Parameters for request * @param {string} params.destinationBucket Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * @param {string=} params.destinationKmsKeyName Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. * @param {string} params.destinationObject Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. * @param {string=} params.destinationPredefinedAcl Apply a predefined set of access controls to the destination object. * @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. @@ -7907,6 +7918,10 @@ export namespace storage_v1 { * Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. */ destinationBucket?: string; + /** + * Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. + */ + destinationKmsKeyName?: string; /** * Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. */ diff --git a/src/apis/toolresults/v1beta3.ts b/src/apis/toolresults/v1beta3.ts index 9af272da924..054e0b3210c 100644 --- a/src/apis/toolresults/v1beta3.ts +++ b/src/apis/toolresults/v1beta3.ts @@ -41,9 +41,21 @@ export namespace toolresults_v1beta3 { interface StandardParameters { /** - * Data format for the response. + * 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. */ @@ -61,19 +73,23 @@ export namespace toolresults_v1beta3 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * 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; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). */ - userIp?: string; + upload_protocol?: string; } /** * Cloud Tool Results API * - * Reads and publishes results from Firebase Test Lab. + * API to publish and access results from developer tools. * * @example * const {google} = require('googleapis'); @@ -87,7 +103,17 @@ export namespace toolresults_v1beta3 { */ export class Toolresults { context: APIRequestContext; + clusters: Resource$Clusters; + environments: Resource$Environments; + executions: Resource$Executions; + histories: Resource$Histories; + perfMetricsSummary: Resource$Perfmetricssummary; + perfSampleSeries: Resource$Perfsampleseries; projects: Resource$Projects; + samples: Resource$Samples; + steps: Resource$Steps; + testCases: Resource$Testcases; + thumbnails: Resource$Thumbnails; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -95,7 +121,17 @@ export namespace toolresults_v1beta3 { google, }; + this.clusters = new Resource$Clusters(this.context); + this.environments = new Resource$Environments(this.context); + this.executions = new Resource$Executions(this.context); + this.histories = new Resource$Histories(this.context); + this.perfMetricsSummary = new Resource$Perfmetricssummary(this.context); + this.perfSampleSeries = new Resource$Perfsampleseries(this.context); this.projects = new Resource$Projects(this.context); + this.samples = new Resource$Samples(this.context); + this.steps = new Resource$Steps(this.context); + this.testCases = new Resource$Testcases(this.context); + this.thumbnails = new Resource$Thumbnails(this.context); } } @@ -121,7 +157,7 @@ export namespace toolresults_v1beta3 { versionName?: string | null; } /** - * A test of an Android application that can control an Android component independently of its normal lifecycle. See for more information on types of Android tests. + * A test of an Android application that can control an Android component independently of its normal lifecycle. See <http://developer.android.com/tools/testing/testing_android.html> for more information on types of Android tests. */ export interface Schema$AndroidInstrumentationTest { /** @@ -133,7 +169,7 @@ export namespace toolresults_v1beta3 { */ testRunnerClass?: string | null; /** - * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. + * Each target must be fully qualified with the package name or class name, in one of these formats: - "package package_name" - "class package_name.class_name" - "class package_name.class_name#method_name" If empty, all targets in the module will be run. */ testTargets?: string[] | null; /** @@ -182,17 +218,34 @@ export namespace toolresults_v1beta3 { * An Android robo test. */ androidRoboTest?: Schema$AndroidRoboTest; + /** + * An Android test loop. + */ + androidTestLoop?: Schema$AndroidTestLoop; /** * Max time a test is allowed to run before it is automatically cancelled. */ testTimeout?: Schema$Duration; } /** - * `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } + * Test Loops are tests that can be launched by the app itself, determining when to run by listening for an intent. go/ftl-games-dd + */ + export interface Schema$AndroidTestLoop {} + /** + * Additional details for an ANR crash. + */ + export interface Schema$ANR { + /** + * The stack trace of the ANR crash. Optional. + */ + stackTrace?: Schema$StackTrace; + } + /** + * `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". # JSON The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message google.protobuf.Duration): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } */ export interface Schema$Any { /** - * A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. + * A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a google.protobuf.Type value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. */ typeUrl?: string | null; /** @@ -210,6 +263,10 @@ export namespace toolresults_v1beta3 { */ initialDisplayTime?: Schema$Duration; } + /** + * A suggestion to use deep links for a Robo run. + */ + export interface Schema$AvailableDeepLinks {} /** * Encapsulates the metadata for basic sample series represented by a line chart */ @@ -230,6 +287,15 @@ export namespace toolresults_v1beta3 { export interface Schema$BatchCreatePerfSamplesResponse { perfSamples?: Schema$PerfSample[]; } + /** + * A warning that Robo encountered a screen that was mostly blank; this may indicate a problem with the app. + */ + export interface Schema$BlankScreen { + /** + * The screen id of the element + */ + screenId?: string | null; + } export interface Schema$CPUInfo { /** * description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A' @@ -245,7 +311,16 @@ export namespace toolresults_v1beta3 { numberOfCores?: number | null; } /** - * A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # Examples Example 1: Compute Duration from two Timestamps in pseudo code. Timestamp start = ...; Timestamp end = ...; Duration duration = ...; duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos; if (duration.seconds 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end = ...; end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos; if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; } Example 3: Compute Duration from datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s". + * Crash dialog was detected during the test execution + */ + export interface Schema$CrashDialogError { + /** + * The name of the package that caused the dialog. + */ + crashPackage?: string | null; + } + /** + * A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. */ export interface Schema$Duration { /** @@ -257,6 +332,32 @@ export namespace toolresults_v1beta3 { */ seconds?: string | null; } + /** + * Additional details about encountered login screens. + */ + export interface Schema$EncounteredLoginScreen { + /** + * Number of encountered distinct login screens. + */ + distinctScreens?: number | null; + /** + * Subset of login screens. + */ + screenIds?: string[] | null; + } + /** + * Additional details about encountered screens with elements that are not Android UI widgets. + */ + export interface Schema$EncounteredNonAndroidUiWidgetScreen { + /** + * Number of encountered distinct screens with non Android UI widgets. + */ + distinctScreens?: number | null; + /** + * Subset of screens which contain non Android UI widgets. + */ + screenIds?: string[] | null; + } /** * An Environment represents the set of test runs (Steps) from the parent Execution that are configured with the same set of dimensions (Model, Version, Locale, and Orientation). Multiple such runs occur particularly because of features like sharding (splitting up a test suite to run in parallel across devices) and reruns (running a test multiple times to check for different outcomes). */ @@ -311,7 +412,7 @@ export namespace toolresults_v1beta3 { value?: string | null; } /** - * An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. + * An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable. */ export interface Schema$Execution { /** @@ -322,6 +423,10 @@ export namespace toolresults_v1beta3 { * The time when the Execution was created. This value will be set automatically when CreateExecution is called. - In response: always set - In create/update request: never set */ creationTime?: Schema$Timestamp; + /** + * The dimensions along which different steps in this execution may vary. This must remain fixed over the life of the execution. Returns INVALID_ARGUMENT if this field is set in an update request. Returns INVALID_ARGUMENT if the same name occurs in more than one dimension_definition. Returns INVALID_ARGUMENT if the size of the list is over 100. - In response: present if set by create - In create request: optional - In update request: never set + */ + dimensionDefinitions?: Schema$MatrixDimensionDefinition[]; /** * A unique identifier within a History for this Execution. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create/update request: never set */ @@ -343,6 +448,10 @@ export namespace toolresults_v1beta3 { */ testExecutionMatrixId?: string | null; } + /** + * Failed to install the APK. + */ + export interface Schema$FailedToInstall {} /** * Details for an outcome with a FAILURE outcome summary. */ @@ -368,6 +477,15 @@ export namespace toolresults_v1beta3 { */ unableToCrawl?: boolean | null; } + /** + * Additional details for a fatal exception. + */ + export interface Schema$FatalException { + /** + * The stack trace of the fatal exception. Optional. + */ + stackTrace?: Schema$StackTrace; + } /** * A reference to a file. */ @@ -478,6 +596,19 @@ export namespace toolresults_v1beta3 { */ thumbnail?: Schema$Thumbnail; } + /** + * Additional details of in-app purchases encountered during the crawl. + */ + export interface Schema$InAppPurchasesFound { + /** + * The total number of in-app purchases flows explored: how many times the robo tries to buy a SKU. + */ + inAppPurchasesFlowsExplored?: number | null; + /** + * The total number of in-app purchases flows started. + */ + inAppPurchasesFlowsStarted?: number | null; + } /** * Details for an outcome with an INCONCLUSIVE outcome summary. */ @@ -510,6 +641,23 @@ export namespace toolresults_v1beta3 { runDuration?: Schema$Duration; stepId?: string | null; } + /** + * A warning that Robo did not crawl potentially important parts of the app. + */ + export interface Schema$InsufficientCoverage {} + /** + * Additional details for an iOS app crash. + */ + export interface Schema$IosAppCrashed { + /** + * The stack trace, if one is available. Optional. + */ + stackTrace?: Schema$StackTrace; + } + /** + * Failed to find the launcher activity of an app. + */ + export interface Schema$LauncherActivityNotFound {} /** * Response message for EnvironmentService.ListEnvironments. */ @@ -612,7 +760,7 @@ export namespace toolresults_v1beta3 { */ nextPageToken?: string | null; /** - * A list of image data. Images are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep). + * A list of image data. Images are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep). */ thumbnails?: Schema$Image[]; } @@ -626,6 +774,10 @@ export namespace toolresults_v1beta3 { */ testCases?: Schema$TestCase[]; } + /** + * One dimension of the matrix of different runs of a step. + */ + export interface Schema$MatrixDimensionDefinition {} export interface Schema$MemoryInfo { /** * Maximum memory that can be allocated to the process in KiB @@ -649,7 +801,7 @@ export namespace toolresults_v1beta3 { */ state?: string | null; /** - * The combined and rolled-up result of each test suite that was run as part of this environment. Combining: When the test cases from a suite are run in different steps (sharding), the results are added back together in one overview. (e.g., if shard1 has 2 failures and shard2 has 1 failure than the overview failure_count = 3). Rollup: When test cases from the same suite are run multiple times (flaky), the results are combined (e.g., if testcase1.run1 fails, testcase1.run2 passes, and both testcase2.run1 and testcase2.run2 fail then the overview flaky_count = 1 and failure_count = 1). + * The combined and rolled-up result of each test suite that was run as part of this environment. Combining: When the test cases from a suite are run in different steps (sharding), the results are added back together in one overview. (e.g., if shard1 has 2 failures and shard2 has 1 failure than the overview failure_count = 3). Rollup: When test cases from the same suite are run multiple times (flaky), the results are combined (e.g., if testcase1.run1 fails, testcase1.run2 passes, and both testcase2.run1 and testcase2.run2 fail then the overview flaky_count = 1 and failure_count = 1). */ testSuiteOverviews?: Schema$TestSuiteOverview[]; } @@ -670,6 +822,95 @@ export namespace toolresults_v1beta3 { */ primaryStepId?: string | null; } + /** + * Additional details for a native crash. + */ + export interface Schema$NativeCrash { + /** + * The stack trace of the native crash. Optional. + */ + stackTrace?: Schema$StackTrace; + } + /** + * A non-sdk API and examples of it being called along with other metadata See https://developer.android.com/distribute/best-practices/develop/restrictions-non-sdk-interfaces + */ + export interface Schema$NonSdkApi { + /** + * The signature of the Non-SDK API + */ + apiSignature?: string | null; + /** + * Example stack traces of this API being called. + */ + exampleStackTraces?: string[] | null; + /** + * Optional debugging insights for non-SDK API violations. + */ + insights?: Schema$NonSdkApiInsight[]; + /** + * The total number of times this API was observed to have been called. + */ + invocationCount?: number | null; + /** + * Which list this API appears on + */ + list?: string | null; + } + /** + * Non-SDK API insights (to address debugging solutions). + */ + export interface Schema$NonSdkApiInsight { + /** + * Optional sample stack traces, for which this insight applies (there should be at least one). + */ + exampleTraceMessages?: string[] | null; + /** + * A unique ID, to be used for determining the effectiveness of this particular insight in the context of a matcher. (required) + */ + matcherId?: string | null; + /** + * An insight indicating that the hidden API usage originates from a Google-provided library. + */ + pendingGoogleUpdateInsight?: Schema$PendingGoogleUpdateInsight; + /** + * An insight indicating that the hidden API usage originates from the use of a library that needs to be upgraded. + */ + upgradeInsight?: Schema$UpgradeInsight; + } + /** + * Additional details for a non-sdk API usage violation. + */ + export interface Schema$NonSdkApiUsageViolation { + /** + * Signatures of a subset of those hidden API's. + */ + apiSignatures?: string[] | null; + /** + * Total number of unique hidden API's accessed. + */ + uniqueApis?: number | null; + } + /** + * Contains a summary and examples of non-sdk API usage violations. + */ + export interface Schema$NonSdkApiUsageViolationReport { + /** + * Examples of the detected API usages. + */ + exampleApis?: Schema$NonSdkApi[]; + /** + * Minimum API level required for the application to run. + */ + minSdkVersion?: number | null; + /** + * Specifies the API Level on which the application is designed to run. + */ + targetSdkVersion?: number | null; + /** + * Total number of unique Non-SDK API's accessed. + */ + uniqueApis?: number | null; + } /** * Interprets a result so that humans and machines can act on it. */ @@ -695,6 +936,28 @@ export namespace toolresults_v1beta3 { */ summary?: string | null; } + /** + * A warning that Robo encountered a screen that has overlapping clickable elements; this may indicate a potential UI issue. + */ + export interface Schema$OverlappingUIElements { + /** + * Resource names of the overlapping screen elements + */ + resourceName?: string[] | null; + /** + * The screen id of the elements + */ + screenId?: string | null; + } + /** + * This insight indicates that the hidden API usage originates from a Google-provided library. Users need not take any action. + */ + export interface Schema$PendingGoogleUpdateInsight { + /** + * The name of the Google-provided library with the non-SDK API dependency. + */ + nameOfGoogleLibrary?: string | null; + } /** * Encapsulates performance environment info */ @@ -714,7 +977,7 @@ export namespace toolresults_v1beta3 { export interface Schema$PerfMetricsSummary { appStartTime?: Schema$AppStartTime; /** - * A tool results execution ID. + * A tool results execution ID. @OutputOnly */ executionId?: string | null; /** @@ -722,7 +985,7 @@ export namespace toolresults_v1beta3 { */ graphicsStats?: Schema$GraphicsStats; /** - * A tool results history ID. + * A tool results history ID. @OutputOnly */ historyId?: string | null; /** @@ -734,14 +997,27 @@ export namespace toolresults_v1beta3 { */ perfMetrics?: string[] | null; /** - * The cloud project + * The cloud project @OutputOnly */ projectId?: string | null; /** - * A tool results step ID. + * A tool results step ID. @OutputOnly */ stepId?: string | null; } + /** + * A notification that Robo signed in with Google. + */ + export interface Schema$PerformedGoogleLogin {} + /** + * A notification that Robo performed some monkey actions. + */ + export interface Schema$PerformedMonkeyActions { + /** + * The total number of monkey actions performed during the crawl. + */ + totalActions?: number | null; + } /** * Resource representing a single performance measure or data point */ @@ -764,23 +1040,23 @@ export namespace toolresults_v1beta3 { */ basicPerfSampleSeries?: Schema$BasicPerfSampleSeries; /** - * A tool results execution ID. + * A tool results execution ID. @OutputOnly */ executionId?: string | null; /** - * A tool results history ID. + * A tool results history ID. @OutputOnly */ historyId?: string | null; /** - * The cloud project + * The cloud project @OutputOnly */ projectId?: string | null; /** - * A sample series id + * A sample series id @OutputOnly */ sampleSeriesId?: string | null; /** - * A tool results step ID. + * A tool results step ID. @OutputOnly */ stepId?: string | null; } @@ -853,6 +1129,19 @@ export namespace toolresults_v1beta3 { */ xunitXmlFile?: Schema$FileReference; } + /** + * Execution stats for a user-provided Robo script. + */ + export interface Schema$RoboScriptExecution { + /** + * The number of Robo script actions executed successfully. + */ + successfulActions?: number | null; + /** + * The total number of actions in the Robo script. + */ + totalActions?: number | null; + } /** * IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests. */ @@ -886,7 +1175,7 @@ export namespace toolresults_v1beta3 { */ activity?: string | null; /** - * A unique identifier for the cluster. + * A unique identifier for the cluster. @OutputOnly */ clusterId?: string | null; /** @@ -902,6 +1191,10 @@ export namespace toolresults_v1beta3 { * Result summary for a shard in an environment. */ export interface Schema$ShardSummary { + /** + * Summaries of the steps belonging to the shard. With flaky_test_attempts enabled from TestExecutionService, more than one run (Step) can present. And the runs will be sorted by multistep_number. + */ + runs?: Schema$StepSummary[]; /** * Merged result of the shard. */ @@ -942,25 +1235,32 @@ export namespace toolresults_v1beta3 { */ exception?: string | null; } + /** + * User provided intent failed to resolve to an activity. + */ + export interface Schema$StartActivityNotFound { + action?: string | null; + uri?: string | null; + } /** * 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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$Status { /** - * The status code, which should be an enum value of [google.rpc.Code][]. + * The status code, which should be an enum value of google.rpc.Code. */ code?: number | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * A list of messages that carry the error details. There is a common set of message types for APIs to use. */ - details?: Schema$Any[]; + details?: Array<{[key: string]: any}> | null; /** - * 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. + * 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 | null; } /** - * A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 + * A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates an TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable. Next tag: 27 */ export interface Schema$Step { /** @@ -988,7 +1288,7 @@ export namespace toolresults_v1beta3 { */ hasImages?: boolean | null; /** - * Arbitrary user-supplied key/value pairs that are associated with the step. Users are responsible for managing the key namespace such that keys don't accidentally collide. An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters. - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value + * Arbitrary user-supplied key/value pairs that are associated with the step. Users are responsible for managing the key namespace such that keys don't accidentally collide. An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters. - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value */ labels?: Schema$StepLabelsEntry[]; /** @@ -1032,6 +1332,10 @@ export namespace toolresults_v1beta3 { key?: string | null; value?: string | null; } + /** + * Lightweight summary of a step within this execution. + */ + export interface Schema$StepSummary {} /** * Details for an outcome with a SUCCESS outcome summary. LINT.IfChange */ @@ -1102,7 +1406,7 @@ export namespace toolresults_v1beta3 { */ elapsedTime?: Schema$Duration; /** - * The end time of the test case. Optional. + * The end time of the test case. */ endTime?: Schema$Timestamp; /** @@ -1114,7 +1418,7 @@ export namespace toolresults_v1beta3 { */ stackTraces?: Schema$StackTrace[]; /** - * The start time of the test case. Optional. + * The start time of the test case. */ startTime?: Schema$Timestamp; /** @@ -1130,7 +1434,7 @@ export namespace toolresults_v1beta3 { */ testCaseReference?: Schema$TestCaseReference; /** - * References to opaque files of any format output by the tool execution. + * References to opaque files of any format output by the tool execution. @OutputOnly */ toolOutputs?: Schema$ToolOutputReference[]; } @@ -1269,7 +1573,7 @@ export namespace toolresults_v1beta3 { widthPx?: number | null; } /** - * A Timestamp represents a point in time independent of any time zone or 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 = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D ) to obtain a formatter capable of generating timestamps in this format. + * A Timestamp represents a point in time independent of any time zone or 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. */ export interface Schema$Timestamp { /** @@ -1290,15 +1594,15 @@ export namespace toolresults_v1beta3 { */ commandLineArguments?: string[] | null; /** - * Tool execution exit code. This field will be set once the tool has exited. - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set. + * Tool execution exit code. This field will be set once the tool has exited. - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set. */ exitCode?: Schema$ToolExitCode; /** - * References to any plain text logs output the tool execution. This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running. The maximum allowed number of tool logs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list + * References to any plain text logs output the tool execution. This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running. The maximum allowed number of tool logs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list */ toolLogs?: Schema$FileReference[]; /** - * References to opaque files of any format output by the tool execution. The maximum allowed number of tool outputs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list + * References to opaque files of any format output by the tool execution. The maximum allowed number of tool outputs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list */ toolOutputs?: Schema$ToolOutputReference[]; } @@ -1337,57 +1641,118 @@ export namespace toolresults_v1beta3 { */ testCase?: Schema$TestCaseReference; } + /** + * A warning that the screen hierarchy is deeper than the recommended threshold. + */ + export interface Schema$UIElementTooDeep { + /** + * The depth of the screen element + */ + depth?: number | null; + /** + * The screen id of the element + */ + screenId?: string | null; + /** + * The screen state id of the element + */ + screenStateId?: string | null; + } + /** + * Default unspecified warning. + */ + export interface Schema$UnspecifiedWarning {} + /** + * Additional details of an unused robodirective. + */ + export interface Schema$UnusedRoboDirective { + /** + * The name of the resource that was unused. + */ + resourceName?: string | null; + } + /** + * This insight is a recommendation to upgrade a given library to the specified version, in order to avoid dependencies on non-SDK APIs. + */ + export interface Schema$UpgradeInsight { + /** + * The name of the package to be upgraded. + */ + packageName?: string | null; + /** + * The suggested version to upgrade to. Optional: In case we are not sure which version solves this problem + */ + upgradeToVersion?: string | null; + } + /** + * Additional details of a used Robo directive. + */ + export interface Schema$UsedRoboDirective { + /** + * The name of the resource that was used. + */ + resourceName?: string | null; + } + /** + * Additional details of a used Robo directive with an ignore action. Note: This is a different scenario than unused directive. + */ + export interface Schema$UsedRoboIgnoreDirective { + /** + * The name of the resource that was ignored. + */ + resourceName?: string | null; + } - export class Resource$Projects { + export class Resource$Clusters { context: APIRequestContext; - histories: Resource$Projects$Histories; constructor(context: APIRequestContext) { this.context = context; - this.histories = new Resource$Projects$Histories(this.context); } /** - * toolresults.projects.getSettings - * @desc Gets the Tool Results settings for a project. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from project - * @alias toolresults.projects.getSettings + * toolresults.clusters.get + * @desc Retrieves a single screenshot cluster by its ID + * @alias toolresults.clusters.get * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.clusterId A Cluster id Required. + * @param {string} params.executionId An Execution id. Required. + * @param {string} params.historyId A History id. Required. * @param {string} params.projectId A Project id. Required. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getSettings( - params?: Params$Resource$Projects$Getsettings, + get( + params?: Params$Resource$Clusters$Get, options?: MethodOptions - ): GaxiosPromise; - getSettings( - params: Params$Resource$Projects$Getsettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Clusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSettings( - params: Params$Resource$Projects$Getsettings, - callback: BodyResponseCallback + get( + params: Params$Resource$Clusters$Get, + callback: BodyResponseCallback ): void; - getSettings(callback: BodyResponseCallback): void; - getSettings( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Getsettings - | BodyResponseCallback, + | Params$Resource$Clusters$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getsettings; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Clusters$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getsettings; + params = {} as Params$Resource$Clusters$Get; options = {}; } @@ -1401,68 +1766,72 @@ export namespace toolresults_v1beta3 { options: Object.assign( { url: ( - rootUrl + '/toolresults/v1beta3/projects/{projectId}/settings' + rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId'], - pathParams: ['projectId'], + requiredParams: ['projectId', 'historyId', 'executionId', 'clusterId'], + pathParams: ['clusterId', 'executionId', 'historyId', 'projectId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * toolresults.projects.initializeSettings - * @desc Creates resources for settings which have not yet been set. Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days. The bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details. If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created. May return any canonical error codes, including the following: - PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage - * @alias toolresults.projects.initializeSettings + * toolresults.clusters.list + * @desc Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores. + * @alias toolresults.clusters.list * @memberOf! () * * @param {object} params Parameters for request + * @param {string} params.executionId An Execution id. Required. + * @param {string} params.historyId A History id. Required. * @param {string} params.projectId A Project id. Required. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - initializeSettings( - params?: Params$Resource$Projects$Initializesettings, + list( + params?: Params$Resource$Clusters$List, options?: MethodOptions - ): GaxiosPromise; - initializeSettings( - params: Params$Resource$Projects$Initializesettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Clusters$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - initializeSettings( - params: Params$Resource$Projects$Initializesettings, - callback: BodyResponseCallback + list( + params: Params$Resource$Clusters$List, + callback: BodyResponseCallback ): void; - initializeSettings( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - initializeSettings( + list( paramsOrCallback?: - | Params$Resource$Projects$Initializesettings - | BodyResponseCallback, + | Params$Resource$Clusters$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Initializesettings; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Clusters$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Initializesettings; + params = {} as Params$Resource$Clusters$List; options = {}; } @@ -1477,174 +1846,123 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}:initializeSettings' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['projectId'], - pathParams: ['projectId'], + requiredParams: ['projectId', 'historyId', 'executionId'], + pathParams: ['executionId', 'historyId', 'projectId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Getsettings - extends StandardParameters { + export interface Params$Resource$Clusters$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * A Cluster id Required. + */ + clusterId?: string; + /** + * An Execution id. Required. + */ + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; /** * A Project id. Required. */ projectId?: string; } - export interface Params$Resource$Projects$Initializesettings - extends StandardParameters { + export interface Params$Resource$Clusters$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * An Execution id. Required. + */ + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; /** * A Project id. Required. */ projectId?: string; } - export class Resource$Projects$Histories { + export class Resource$Environments { context: APIRequestContext; - executions: Resource$Projects$Histories$Executions; constructor(context: APIRequestContext) { this.context = context; - this.executions = new Resource$Projects$Histories$Executions( - this.context - ); - } - - /** - * toolresults.projects.histories.create - * @desc Creates a History. The returned History will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist - * @alias toolresults.projects.histories.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.projectId A Project id. Required. - * @param {string=} params.requestId A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. - * @param {().History} params.requestBody Request body data - * @param {object} [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$Histories$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Histories$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Histories$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Histories$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/toolresults/v1beta3/projects/{projectId}/histories' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['projectId'], - pathParams: ['projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } } /** - * toolresults.projects.histories.get - * @desc Gets a History. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist - * @alias toolresults.projects.histories.get + * toolresults.environments.get + * @desc Gets an Environment. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Environment does not exist + * @alias toolresults.environments.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.historyId A History id. Required. - * @param {string} params.projectId A Project id. Required. + * @param {string} params.environmentId Required. An Environment id. + * @param {string} params.executionId Required. An Execution id. + * @param {string} params.historyId Required. A History id. + * @param {string} params.projectId Required. A 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 */ get( - params?: Params$Resource$Projects$Histories$Get, + params?: Params$Resource$Environments$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Histories$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Environments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Histories$Get, - callback: BodyResponseCallback + params: Params$Resource$Environments$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Histories$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Get; + | Params$Resource$Environments$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Environments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Get; + params = {} as Params$Resource$Environments$Get; options = {}; } @@ -1659,71 +1977,77 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId'], - pathParams: ['historyId', 'projectId'], + requiredParams: [ + 'projectId', + 'historyId', + 'executionId', + 'environmentId', + ], + pathParams: ['environmentId', 'executionId', 'historyId', 'projectId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.list - * @desc Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist - * @alias toolresults.projects.histories.list + * toolresults.environments.list + * @desc Lists Environments for a given Execution. The Environments are sorted by display name. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Execution does not exist + * @alias toolresults.environments.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filterByName If set, only return histories with the given name. Optional. - * @param {integer=} params.pageSize The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional. - * @param {string=} params.pageToken A continuation token to resume the query at the next item. Optional. - * @param {string} params.projectId A Project id. Required. + * @param {string} params.executionId Required. An Execution id. + * @param {string} params.historyId Required. A History id. + * @param {integer=} params.pageSize The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. + * @param {string=} params.pageToken A continuation token to resume the query at the next item. + * @param {string} params.projectId Required. A 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 */ list( - params?: Params$Resource$Projects$Histories$List, + params?: Params$Resource$Environments$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Histories$List, + params: Params$Resource$Environments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Histories$List, - callback: BodyResponseCallback + params: Params$Resource$Environments$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Histories$List - | BodyResponseCallback, + | Params$Resource$Environments$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$List; + {}) as Params$Resource$Environments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$List; + params = {} as Params$Resource$Environments$List; options = {}; } @@ -1737,47 +2061,50 @@ export namespace toolresults_v1beta3 { options: Object.assign( { url: ( - rootUrl + '/toolresults/v1beta3/projects/{projectId}/histories' + rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId'], - pathParams: ['projectId'], + requiredParams: ['projectId', 'historyId', 'executionId'], + pathParams: ['executionId', 'historyId', 'projectId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Histories$Create - extends StandardParameters { + export interface Params$Resource$Environments$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A Project id. Required. + * Required. An Environment id. */ - projectId?: string; + environmentId?: string; /** - * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. + * Required. An Execution id. */ - requestId?: string; - + executionId?: string; /** - * Request body metadata + * Required. A History id. */ - requestBody?: Schema$History; + historyId?: string; + /** + * Required. A Project id. + */ + projectId?: string; } - export interface Params$Resource$Projects$Histories$Get + export interface Params$Resource$Environments$List extends StandardParameters { /** * Auth client or API Key for the request @@ -1785,61 +2112,37 @@ export namespace toolresults_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A History id. Required. + * Required. An Execution id. */ - historyId?: string; + executionId?: string; /** - * A Project id. Required. + * Required. A History id. */ - projectId?: string; - } - export interface Params$Resource$Projects$Histories$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * If set, only return histories with the given name. Optional. - */ - filterByName?: string; + historyId?: string; /** - * The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional. + * The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. */ pageSize?: number; /** - * A continuation token to resume the query at the next item. Optional. + * A continuation token to resume the query at the next item. */ pageToken?: string; /** - * A Project id. Required. + * Required. A Project id. */ projectId?: string; } - export class Resource$Projects$Histories$Executions { + export class Resource$Executions { context: APIRequestContext; - clusters: Resource$Projects$Histories$Executions$Clusters; - environments: Resource$Projects$Histories$Executions$Environments; - steps: Resource$Projects$Histories$Executions$Steps; constructor(context: APIRequestContext) { this.context = context; - this.clusters = new Resource$Projects$Histories$Executions$Clusters( - this.context - ); - this.environments = new Resource$Projects$Histories$Executions$Environments( - this.context - ); - this.steps = new Resource$Projects$Histories$Executions$Steps( - this.context - ); } /** - * toolresults.projects.histories.executions.create + * toolresults.executions.create * @desc Creates an Execution. The returned Execution will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist - * @alias toolresults.projects.histories.executions.create + * @alias toolresults.executions.create * @memberOf! () * * @param {object} params Parameters for request @@ -1852,22 +2155,22 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ create( - params?: Params$Resource$Projects$Histories$Executions$Create, + params?: Params$Resource$Executions$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Histories$Executions$Create, + params: Params$Resource$Executions$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Histories$Executions$Create, + params: Params$Resource$Executions$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Create + | Params$Resource$Executions$Create | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -1875,12 +2178,12 @@ export namespace toolresults_v1beta3 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Create; + {}) as Params$Resource$Executions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Create; + params = {} as Params$Resource$Executions$Create; options = {}; } @@ -1914,9 +2217,9 @@ export namespace toolresults_v1beta3 { } /** - * toolresults.projects.histories.executions.get + * toolresults.executions.get * @desc Gets an Execution. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Execution does not exist - * @alias toolresults.projects.histories.executions.get + * @alias toolresults.executions.get * @memberOf! () * * @param {object} params Parameters for request @@ -1928,35 +2231,34 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ get( - params?: Params$Resource$Projects$Histories$Executions$Get, + params?: Params$Resource$Executions$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Histories$Executions$Get, + params: Params$Resource$Executions$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Histories$Executions$Get, + params: Params$Resource$Executions$Get, callback: BodyResponseCallback ): void; get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Get + | Params$Resource$Executions$Get | BodyResponseCallback, optionsOrCallback?: | MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Get; + let params = (paramsOrCallback || {}) as Params$Resource$Executions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Get; + params = {} as Params$Resource$Executions$Get; options = {}; } @@ -1990,9 +2292,9 @@ export namespace toolresults_v1beta3 { } /** - * toolresults.projects.histories.executions.list + * toolresults.executions.list * @desc Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing History does not exist - * @alias toolresults.projects.histories.executions.list + * @alias toolresults.executions.list * @memberOf! () * * @param {object} params Parameters for request @@ -2005,37 +2307,36 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Histories$Executions$List, + params?: Params$Resource$Executions$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Histories$Executions$List, + params: Params$Resource$Executions$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Histories$Executions$List, + params: Params$Resource$Executions$List, callback: BodyResponseCallback ): void; list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$List + | Params$Resource$Executions$List | BodyResponseCallback, optionsOrCallback?: | MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$List; + let params = (paramsOrCallback || {}) as Params$Resource$Executions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$List; + params = {} as Params$Resource$Executions$List; options = {}; } @@ -2069,9 +2370,9 @@ export namespace toolresults_v1beta3 { } /** - * toolresults.projects.histories.executions.patch + * toolresults.executions.patch * @desc Updates an existing Execution with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist - * @alias toolresults.projects.histories.executions.patch + * @alias toolresults.executions.patch * @memberOf! () * * @param {object} params Parameters for request @@ -2085,35 +2386,34 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ patch( - params?: Params$Resource$Projects$Histories$Executions$Patch, + params?: Params$Resource$Executions$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Histories$Executions$Patch, + params: Params$Resource$Executions$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Histories$Executions$Patch, + params: Params$Resource$Executions$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Patch + | Params$Resource$Executions$Patch | BodyResponseCallback, optionsOrCallback?: | MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Patch; + let params = (paramsOrCallback || {}) as Params$Resource$Executions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Patch; + params = {} as Params$Resource$Executions$Patch; options = {}; } @@ -2147,7 +2447,7 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Create + export interface Params$Resource$Executions$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -2172,8 +2472,7 @@ export namespace toolresults_v1beta3 { */ requestBody?: Schema$Execution; } - export interface Params$Resource$Projects$Histories$Executions$Get - extends StandardParameters { + export interface Params$Resource$Executions$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2192,8 +2491,7 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$Executions$List - extends StandardParameters { + export interface Params$Resource$Executions$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2216,8 +2514,7 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Patch - extends StandardParameters { + export interface Params$Resource$Executions$Patch extends StandardParameters { /** * Auth client or API Key for the request */ @@ -2246,21 +2543,91 @@ export namespace toolresults_v1beta3 { requestBody?: Schema$Execution; } - export class Resource$Projects$Histories$Executions$Clusters { + export class Resource$Histories { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * toolresults.projects.histories.executions.clusters.get - * @desc Retrieves a single screenshot cluster by its ID - * @alias toolresults.projects.histories.executions.clusters.get + * toolresults.histories.create + * @desc Creates a History. The returned History will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist + * @alias toolresults.histories.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.projectId A Project id. Required. + * @param {string=} params.requestId A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. + * @param {().History} params.requestBody Request body data + * @param {object} [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$Histories$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Histories$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Histories$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Histories$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Histories$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Histories$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/toolresults/v1beta3/projects/{projectId}/histories' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['projectId'], + pathParams: ['projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * toolresults.histories.get + * @desc Gets a History. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist + * @alias toolresults.histories.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.clusterId A Cluster id Required. - * @param {string} params.executionId An Execution id. Required. * @param {string} params.historyId A History id. Required. * @param {string} params.projectId A Project id. Required. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2268,35 +2635,32 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ get( - params?: Params$Resource$Projects$Histories$Executions$Clusters$Get, + params?: Params$Resource$Histories$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Histories$Executions$Clusters$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Histories$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Histories$Executions$Clusters$Get, - callback: BodyResponseCallback + params: Params$Resource$Histories$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Clusters$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Clusters$Get; + | Params$Resource$Histories$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Histories$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Clusters$Get; + params = {} as Params$Resource$Histories$Get; options = {}; } @@ -2311,72 +2675,70 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId', 'clusterId'], - pathParams: ['clusterId', 'executionId', 'historyId', 'projectId'], + requiredParams: ['projectId', 'historyId'], + pathParams: ['historyId', 'projectId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.executions.clusters.list - * @desc Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores. - * @alias toolresults.projects.histories.executions.clusters.list + * toolresults.histories.list + * @desc Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the History does not exist + * @alias toolresults.histories.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId An Execution id. Required. - * @param {string} params.historyId A History id. Required. + * @param {string=} params.filterByName If set, only return histories with the given name. Optional. + * @param {integer=} params.pageSize The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional. + * @param {string=} params.pageToken A continuation token to resume the query at the next item. Optional. * @param {string} params.projectId A Project id. Required. * @param {object} [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$Histories$Executions$Clusters$List, + params?: Params$Resource$Histories$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Histories$Executions$Clusters$List, + params: Params$Resource$Histories$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Histories$Executions$Clusters$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Histories$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Clusters$List - | BodyResponseCallback, + | Params$Resource$Histories$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Clusters$List; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Histories$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Clusters$List; + params = {} as Params$Resource$Histories$List; options = {}; } @@ -2390,46 +2752,51 @@ export namespace toolresults_v1beta3 { options: Object.assign( { url: ( - rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters' + rootUrl + '/toolresults/v1beta3/projects/{projectId}/histories' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId'], - pathParams: ['executionId', 'historyId', 'projectId'], + requiredParams: ['projectId'], + pathParams: ['projectId'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Histories$Executions$Clusters$Get - extends StandardParameters { + export interface Params$Resource$Histories$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A Cluster id Required. + * A Project id. Required. */ - clusterId?: string; + projectId?: string; /** - * An Execution id. Required. + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. */ - executionId?: string; + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$History; + } + export interface Params$Resource$Histories$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** * A History id. Required. */ @@ -2439,78 +2806,82 @@ export namespace toolresults_v1beta3 { */ projectId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Clusters$List - extends StandardParameters { + export interface Params$Resource$Histories$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An Execution id. Required. + * If set, only return histories with the given name. Optional. */ - executionId?: string; + filterByName?: string; /** - * A History id. Required. + * The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional. */ - historyId?: string; + pageSize?: number; + /** + * A continuation token to resume the query at the next item. Optional. + */ + pageToken?: string; /** * A Project id. Required. */ projectId?: string; } - export class Resource$Projects$Histories$Executions$Environments { + export class Resource$Perfmetricssummary { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * toolresults.projects.histories.executions.environments.get - * @desc Gets an Environment. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Environment does not exist - * @alias toolresults.projects.histories.executions.environments.get + * toolresults.perfMetricsSummary.create + * @desc Creates a PerfMetricsSummary resource. Returns the existing one if it has already been created. May return any of the following error code(s): - NOT_FOUND - The containing Step does not exist + * @alias toolresults.perfMetricsSummary.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.environmentId Required. An Environment id. - * @param {string} params.executionId Required. An Execution id. - * @param {string} params.historyId Required. A History id. - * @param {string} params.projectId Required. A Project id. + * @param {string} params.executionId A tool results execution ID. + * @param {string} params.historyId A tool results history ID. + * @param {string} params.projectId The cloud project + * @param {string} params.stepId A tool results step ID. + * @param {().PerfMetricsSummary} params.requestBody Request body data * @param {object} [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$Histories$Executions$Environments$Get, + create( + params?: Params$Resource$Perfmetricssummary$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Histories$Executions$Environments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Perfmetricssummary$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Histories$Executions$Environments$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Perfmetricssummary$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Environments$Get - | BodyResponseCallback, + | Params$Resource$Perfmetricssummary$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Environments$Get; + {}) as Params$Resource$Perfmetricssummary$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Environments$Get; + params = {} as Params$Resource$Perfmetricssummary$Create; options = {}; } @@ -2525,111 +2896,26 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: [ - 'projectId', - 'historyId', - 'executionId', - 'environmentId', - ], - pathParams: ['environmentId', 'executionId', 'historyId', 'projectId'], + requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], + pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } - /** - * toolresults.projects.histories.executions.environments.list - * @desc Lists Environments for a given Execution. The Environments are sorted by display name. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Execution does not exist - * @alias toolresults.projects.histories.executions.environments.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.executionId Required. An Execution id. - * @param {string} params.historyId Required. A History id. - * @param {integer=} params.pageSize The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. - * @param {string=} params.pageToken A continuation token to resume the query at the next item. - * @param {string} params.projectId Required. A 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 - */ - list( - params?: Params$Resource$Projects$Histories$Executions$Environments$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Histories$Executions$Environments$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Histories$Executions$Environments$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Environments$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Environments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Environments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['projectId', 'historyId', 'executionId'], - pathParams: ['executionId', 'historyId', 'projectId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Histories$Executions$Environments$Get + export interface Params$Resource$Perfmetricssummary$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -2637,128 +2923,80 @@ export namespace toolresults_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. An Environment id. - */ - environmentId?: string; - /** - * Required. An Execution id. + * A tool results execution ID. */ executionId?: string; /** - * Required. A History id. + * A tool results history ID. */ historyId?: string; /** - * Required. A Project id. + * The cloud project */ projectId?: string; - } - export interface Params$Resource$Projects$Histories$Executions$Environments$List - extends StandardParameters { /** - * Auth client or API Key for the request + * A tool results step ID. */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + stepId?: string; /** - * Required. An Execution id. - */ - executionId?: string; - /** - * Required. A History id. - */ - historyId?: string; - /** - * The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. - */ - pageSize?: number; - /** - * A continuation token to resume the query at the next item. - */ - pageToken?: string; - /** - * Required. A Project id. + * Request body metadata */ - projectId?: string; + requestBody?: Schema$PerfMetricsSummary; } - export class Resource$Projects$Histories$Executions$Steps { + export class Resource$Perfsampleseries { context: APIRequestContext; - perfMetricsSummary: Resource$Projects$Histories$Executions$Steps$Perfmetricssummary; - perfSampleSeries: Resource$Projects$Histories$Executions$Steps$Perfsampleseries; - testCases: Resource$Projects$Histories$Executions$Steps$Testcases; - thumbnails: Resource$Projects$Histories$Executions$Steps$Thumbnails; constructor(context: APIRequestContext) { this.context = context; - this.perfMetricsSummary = new Resource$Projects$Histories$Executions$Steps$Perfmetricssummary( - this.context - ); - this.perfSampleSeries = new Resource$Projects$Histories$Executions$Steps$Perfsampleseries( - this.context - ); - this.testCases = new Resource$Projects$Histories$Executions$Steps$Testcases( - this.context - ); - this.thumbnails = new Resource$Projects$Histories$Executions$Steps$Thumbnails( - this.context - ); } /** - * toolresults.projects.histories.executions.steps.accessibilityClusters - * @desc Lists accessibility clusters for a given Step May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if the locale format is incorrect - NOT_FOUND - if the containing Step does not exist - * @alias toolresults.projects.histories.executions.steps.accessibilityClusters + * toolresults.perfSampleSeries.create + * @desc Creates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist + * @alias toolresults.perfSampleSeries.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.locale The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details. Required. - * @param {string} params.name A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required. + * @param {string} params.executionId A tool results execution ID. + * @param {string} params.historyId A tool results history ID. + * @param {string} params.projectId The cloud project + * @param {string} params.stepId A tool results step ID. + * @param {().PerfSampleSeries} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - accessibilityClusters( - params?: Params$Resource$Projects$Histories$Executions$Steps$Accessibilityclusters, + create( + params?: Params$Resource$Perfsampleseries$Create, options?: MethodOptions - ): GaxiosPromise; - accessibilityClusters( - params: Params$Resource$Projects$Histories$Executions$Steps$Accessibilityclusters, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$ListStepAccessibilityClustersResponse - > - ): void; - accessibilityClusters( - params: Params$Resource$Projects$Histories$Executions$Steps$Accessibilityclusters, - callback: BodyResponseCallback< - Schema$ListStepAccessibilityClustersResponse - > + ): GaxiosPromise; + create( + params: Params$Resource$Perfsampleseries$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - accessibilityClusters( - callback: BodyResponseCallback< - Schema$ListStepAccessibilityClustersResponse - > + create( + params: Params$Resource$Perfsampleseries$Create, + callback: BodyResponseCallback ): void; - accessibilityClusters( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Accessibilityclusters - | BodyResponseCallback, + | Params$Resource$Perfsampleseries$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$ListStepAccessibilityClustersResponse - > - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Accessibilityclusters; + {}) as Params$Resource$Perfsampleseries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Accessibilityclusters; + params = {} as Params$Resource$Perfsampleseries$Create; options = {}; } @@ -2772,73 +3010,71 @@ export namespace toolresults_v1beta3 { options: Object.assign( { url: ( - rootUrl + '/toolresults/v1beta3/{+name}:accessibilityClusters' + rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], + pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.executions.steps.create - * @desc Creates a Step. The returned Step will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist - * @alias toolresults.projects.histories.executions.steps.create + * toolresults.perfSampleSeries.get + * @desc Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist + * @alias toolresults.perfSampleSeries.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId Required. An Execution id. - * @param {string} params.historyId Required. A History id. - * @param {string} params.projectId Required. A Project id. - * @param {string=} params.requestId A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. - * @param {().Step} params.requestBody Request body data + * @param {string} params.executionId A tool results execution ID. + * @param {string} params.historyId A tool results history ID. + * @param {string} params.projectId The cloud project + * @param {string} params.sampleSeriesId A sample series id + * @param {string} params.stepId A tool results step 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$Projects$Histories$Executions$Steps$Create, + get( + params?: Params$Resource$Perfsampleseries$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Histories$Executions$Steps$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Perfsampleseries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Histories$Executions$Steps$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Perfsampleseries$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Perfsampleseries$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Create; + {}) as Params$Resource$Perfsampleseries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Create; + params = {} as Params$Resource$Perfsampleseries$Get; options = {}; } @@ -2853,67 +3089,86 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId'], - pathParams: ['executionId', 'historyId', 'projectId'], + requiredParams: [ + 'projectId', + 'historyId', + 'executionId', + 'stepId', + 'sampleSeriesId', + ], + pathParams: [ + 'executionId', + 'historyId', + 'projectId', + 'sampleSeriesId', + 'stepId', + ], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.executions.steps.get - * @desc Gets a Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist - * @alias toolresults.projects.histories.executions.steps.get + * toolresults.perfSampleSeries.list + * @desc Lists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist + * @alias toolresults.perfSampleSeries.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A Execution id. Required. - * @param {string} params.historyId A History id. Required. - * @param {string} params.projectId A Project id. Required. - * @param {string} params.stepId A Step id. Required. + * @param {string} params.executionId A tool results execution ID. + * @param {string=} params.filter Specify one or more PerfMetricType values such as CPU to filter the result + * @param {string} params.historyId A tool results history ID. + * @param {string} params.projectId The cloud project + * @param {string} params.stepId A tool results step 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$Histories$Executions$Steps$Get, + list( + params?: Params$Resource$Perfsampleseries$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Histories$Executions$Steps$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Histories$Executions$Steps$Get, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Perfsampleseries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + params: Params$Resource$Perfsampleseries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Perfsampleseries$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Get; + {}) as Params$Resource$Perfsampleseries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Get; + params = {} as Params$Resource$Perfsampleseries$List; options = {}; } @@ -2928,7 +3183,7 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -2940,59 +3195,152 @@ export namespace toolresults_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Perfsampleseries$Create + extends StandardParameters { /** - * toolresults.projects.histories.executions.steps.getPerfMetricsSummary - * @desc Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist - * @alias toolresults.projects.histories.executions.steps.getPerfMetricsSummary + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A tool results execution ID. + */ + executionId?: string; + /** + * A tool results history ID. + */ + historyId?: string; + /** + * The cloud project + */ + projectId?: string; + /** + * A tool results step ID. + */ + stepId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PerfSampleSeries; + } + export interface Params$Resource$Perfsampleseries$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A tool results execution ID. + */ + executionId?: string; + /** + * A tool results history ID. + */ + historyId?: string; + /** + * The cloud project + */ + projectId?: string; + /** + * A sample series id + */ + sampleSeriesId?: string; + /** + * A tool results step ID. + */ + stepId?: string; + } + export interface Params$Resource$Perfsampleseries$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A tool results execution ID. + */ + executionId?: string; + /** + * Specify one or more PerfMetricType values such as CPU to filter the result + */ + filter?: string[]; + /** + * A tool results history ID. + */ + historyId?: string; + /** + * The cloud project + */ + projectId?: string; + /** + * A tool results step ID. + */ + stepId?: string; + } + + export class Resource$Projects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * toolresults.projects.getSettings + * @desc Gets the Tool Results settings for a project. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from project + * @alias toolresults.projects.getSettings * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A tool results execution ID. - * @param {string} params.historyId A tool results history ID. - * @param {string} params.projectId The cloud project - * @param {string} params.stepId A tool results step ID. + * @param {string} params.projectId A Project id. Required. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getPerfMetricsSummary( - params?: Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary, + getSettings( + params?: Params$Resource$Projects$Getsettings, options?: MethodOptions - ): GaxiosPromise; - getPerfMetricsSummary( - params: Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getPerfMetricsSummary( - params: Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary, - callback: BodyResponseCallback + ): GaxiosPromise; + getSettings( + params: Params$Resource$Projects$Getsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getPerfMetricsSummary( - callback: BodyResponseCallback + getSettings( + params: Params$Resource$Projects$Getsettings, + callback: BodyResponseCallback ): void; - getPerfMetricsSummary( + getSettings(callback: BodyResponseCallback): void; + getSettings( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary - | BodyResponseCallback, + | Params$Resource$Projects$Getsettings + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary; + {}) as Params$Resource$Projects$Getsettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary; + params = {} as Params$Resource$Projects$Getsettings; options = {}; } @@ -3006,71 +3354,68 @@ export namespace toolresults_v1beta3 { options: Object.assign( { url: ( - rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary' + rootUrl + '/toolresults/v1beta3/projects/{projectId}/settings' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], - pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], + requiredParams: ['projectId'], + pathParams: ['projectId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.executions.steps.list - * @desc Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist - * @alias toolresults.projects.histories.executions.steps.list + * toolresults.projects.initializeSettings + * @desc Creates resources for settings which have not yet been set. Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 90 days. The bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details. If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created. May return any canonical error codes, including the following: - PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage + * @alias toolresults.projects.initializeSettings * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A Execution id. Required. - * @param {string} params.historyId A History id. Required. - * @param {integer=} params.pageSize The maximum number of Steps to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional. - * @param {string=} params.pageToken A continuation token to resume the query at the next item. Optional. * @param {string} params.projectId A Project id. Required. * @param {object} [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$Histories$Executions$Steps$List, + initializeSettings( + params?: Params$Resource$Projects$Initializesettings, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Histories$Executions$Steps$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + initializeSettings( + params: Params$Resource$Projects$Initializesettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Histories$Executions$Steps$List, - callback: BodyResponseCallback + initializeSettings( + params: Params$Resource$Projects$Initializesettings, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + initializeSettings( + callback: BodyResponseCallback + ): void; + initializeSettings( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$List - | BodyResponseCallback, + | Params$Resource$Projects$Initializesettings + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$List; + {}) as Params$Resource$Projects$Initializesettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$List; + params = {} as Params$Resource$Projects$Initializesettings; options = {}; } @@ -3085,69 +3430,107 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps' + '/toolresults/v1beta3/projects/{projectId}:initializeSettings' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId'], - pathParams: ['executionId', 'historyId', 'projectId'], + requiredParams: ['projectId'], + pathParams: ['projectId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Getsettings + extends StandardParameters { /** - * toolresults.projects.histories.executions.steps.patch - * @desc Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist - * @alias toolresults.projects.histories.executions.steps.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.executionId A Execution id. Required. - * @param {string} params.historyId A History id. Required. - * @param {string} params.projectId A Project id. Required. - * @param {string=} params.requestId A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. - * @param {string} params.stepId A Step id. Required. - * @param {().Step} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object + * Auth client or API Key for the request */ - patch( - params?: Params$Resource$Projects$Histories$Executions$Steps$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Histories$Executions$Steps$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A Project id. Required. + */ + projectId?: string; + } + export interface Params$Resource$Projects$Initializesettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A Project id. Required. + */ + projectId?: string; + } + + export class Resource$Samples { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * toolresults.samples.batchCreate + * @desc Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist + * @alias toolresults.samples.batchCreate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.executionId A tool results execution ID. + * @param {string} params.historyId A tool results history ID. + * @param {string} params.projectId The cloud project + * @param {string} params.sampleSeriesId A sample series id + * @param {string} params.stepId A tool results step ID. + * @param {().BatchCreatePerfSamplesRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + batchCreate( + params?: Params$Resource$Samples$Batchcreate, + options?: MethodOptions + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Samples$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Histories$Executions$Steps$Patch, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Samples$Batchcreate, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Samples$Batchcreate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Patch; + {}) as Params$Resource$Samples$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Patch; + params = {} as Params$Resource$Samples$Batchcreate; options = {}; } @@ -3162,68 +3545,90 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], - pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], + requiredParams: [ + 'projectId', + 'historyId', + 'executionId', + 'stepId', + 'sampleSeriesId', + ], + pathParams: [ + 'executionId', + 'historyId', + 'projectId', + 'sampleSeriesId', + 'stepId', + ], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * toolresults.projects.histories.executions.steps.publishXunitXmlFiles - * @desc Publish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist - * @alias toolresults.projects.histories.executions.steps.publishXunitXmlFiles + * toolresults.samples.list + * @desc Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist + * @alias toolresults.samples.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A Execution id. Required. - * @param {string} params.historyId A History id. Required. - * @param {string} params.projectId A Project id. Required. - * @param {string} params.stepId A Step id. Note: This step must include a TestExecutionStep. Required. - * @param {().PublishXunitXmlFilesRequest} params.requestBody Request body data + * @param {string} params.executionId A tool results execution ID. + * @param {string} params.historyId A tool results history ID. + * @param {integer=} params.pageSize The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000 + * @param {string=} params.pageToken Optional, the next_page_token returned in the previous response + * @param {string} params.projectId The cloud project + * @param {string} params.sampleSeriesId A sample series id + * @param {string} params.stepId A tool results step 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 */ - publishXunitXmlFiles( - params?: Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles, + list( + params?: Params$Resource$Samples$List, options?: MethodOptions - ): GaxiosPromise; - publishXunitXmlFiles( - params: Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Samples$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - publishXunitXmlFiles( - params: Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles, - callback: BodyResponseCallback + list( + params: Params$Resource$Samples$List, + callback: BodyResponseCallback ): void; - publishXunitXmlFiles(callback: BodyResponseCallback): void; - publishXunitXmlFiles( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles; + | Params$Resource$Samples$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Samples$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles; + params = {} as Params$Resource$Samples$List; options = {}; } @@ -3238,26 +3643,38 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], - pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], + requiredParams: [ + 'projectId', + 'historyId', + 'executionId', + 'stepId', + 'sampleSeriesId', + ], + pathParams: [ + 'executionId', + 'historyId', + 'projectId', + 'sampleSeriesId', + 'stepId', + ], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Accessibilityclusters + export interface Params$Resource$Samples$Batchcreate extends StandardParameters { /** * Auth client or API Key for the request @@ -3265,69 +3682,32 @@ export namespace toolresults_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details. Required. - */ - locale?: string; - /** - * A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required. - */ - name?: string; - } - export interface Params$Resource$Projects$Histories$Executions$Steps$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. An Execution id. + * A tool results execution ID. */ executionId?: string; /** - * Required. A History id. + * A tool results history ID. */ historyId?: string; /** - * Required. A Project id. + * The cloud project */ projectId?: string; /** - * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. - */ - requestId?: string; - - /** - * Request body metadata + * A sample series id */ - requestBody?: Schema$Step; - } - export interface Params$Resource$Projects$Histories$Executions$Steps$Get - extends StandardParameters { + sampleSeriesId?: string; /** - * Auth client or API Key for the request + * A tool results step ID. */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + stepId?: string; /** - * A Execution id. Required. - */ - executionId?: string; - /** - * A History id. Required. - */ - historyId?: string; - /** - * A Project id. Required. - */ - projectId?: string; - /** - * A Step id. Required. + * Request body metadata */ - stepId?: string; + requestBody?: Schema$BatchCreatePerfSamplesRequest; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Getperfmetricssummary - extends StandardParameters { + export interface Params$Resource$Samples$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3342,157 +3722,88 @@ export namespace toolresults_v1beta3 { */ historyId?: string; /** - * The cloud project - */ - projectId?: string; - /** - * A tool results step ID. - */ - stepId?: string; - } - export interface Params$Resource$Projects$Histories$Executions$Steps$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * A Execution id. Required. - */ - executionId?: string; - /** - * A History id. Required. - */ - historyId?: string; - /** - * The maximum number of Steps to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional. + * The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000 */ pageSize?: number; /** - * A continuation token to resume the query at the next item. Optional. + * Optional, the next_page_token returned in the previous response */ pageToken?: string; /** - * A Project id. Required. - */ - projectId?: string; - } - export interface Params$Resource$Projects$Histories$Executions$Steps$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * A Execution id. Required. - */ - executionId?: string; - /** - * A History id. Required. - */ - historyId?: string; - /** - * A Project id. Required. + * The cloud project */ projectId?: string; /** - * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. - */ - requestId?: string; - /** - * A Step id. Required. - */ - stepId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Step; - } - export interface Params$Resource$Projects$Histories$Executions$Steps$Publishxunitxmlfiles - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * A Execution id. Required. - */ - executionId?: string; - /** - * A History id. Required. - */ - historyId?: string; - /** - * A Project id. Required. + * A sample series id */ - projectId?: string; + sampleSeriesId?: string; /** - * A Step id. Note: This step must include a TestExecutionStep. Required. + * A tool results step ID. */ stepId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PublishXunitXmlFilesRequest; } - export class Resource$Projects$Histories$Executions$Steps$Perfmetricssummary { + export class Resource$Steps { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * toolresults.projects.histories.executions.steps.perfMetricsSummary.create - * @desc Creates a PerfMetricsSummary resource. Returns the existing one if it has already been created. May return any of the following error code(s): - NOT_FOUND - The containing Step does not exist - * @alias toolresults.projects.histories.executions.steps.perfMetricsSummary.create + * toolresults.steps.accessibilityClusters + * @desc Lists accessibility clusters for a given Step May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if the locale format is incorrect - NOT_FOUND - if the containing Step does not exist + * @alias toolresults.steps.accessibilityClusters * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A tool results execution ID. - * @param {string} params.historyId A tool results history ID. - * @param {string} params.projectId The cloud project - * @param {string} params.stepId A tool results step ID. - * @param {().PerfMetricsSummary} params.requestBody Request body data + * @param {string=} params.locale The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details. Required. + * @param {string} params.name A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required. * @param {object} [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$Histories$Executions$Steps$Perfmetricssummary$Create, + accessibilityClusters( + params?: Params$Resource$Steps$Accessibilityclusters, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + accessibilityClusters( + params: Params$Resource$Steps$Accessibilityclusters, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$ListStepAccessibilityClustersResponse + > ): void; - create( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create, - callback: BodyResponseCallback + accessibilityClusters( + params: Params$Resource$Steps$Accessibilityclusters, + callback: BodyResponseCallback< + Schema$ListStepAccessibilityClustersResponse + > ): void; - create(callback: BodyResponseCallback): void; - create( + accessibilityClusters( + callback: BodyResponseCallback< + Schema$ListStepAccessibilityClustersResponse + > + ): void; + accessibilityClusters( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create - | BodyResponseCallback, + | Params$Resource$Steps$Accessibilityclusters + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListStepAccessibilityClustersResponse + > + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create; + {}) as Params$Resource$Steps$Accessibilityclusters; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create; + params = {} as Params$Resource$Steps$Accessibilityclusters; options = {}; } @@ -3506,112 +3817,146 @@ export namespace toolresults_v1beta3 { options: Object.assign( { url: ( - rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary' + rootUrl + '/toolresults/v1beta3/{+name}:accessibilityClusters' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], - pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfmetricssummary$Create - extends StandardParameters { /** - * Auth client or API Key for the request + * toolresults.steps.create + * @desc Creates a Step. The returned Step will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist + * @alias toolresults.steps.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.executionId Required. An Execution id. + * @param {string} params.historyId Required. A History id. + * @param {string} params.projectId Required. A Project id. + * @param {string=} params.requestId A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. + * @param {().Step} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + create( + params?: Params$Resource$Steps$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Steps$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Steps$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Steps$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Steps$Create; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * A tool results execution ID. - */ - executionId?: string; - /** - * A tool results history ID. - */ - historyId?: string; - /** - * The cloud project - */ - projectId?: string; - /** - * A tool results step ID. - */ - stepId?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Steps$Create; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$PerfMetricsSummary; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Histories$Executions$Steps$Perfsampleseries { - context: APIRequestContext; - samples: Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples; - constructor(context: APIRequestContext) { - this.context = context; - this.samples = new Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples( - this.context - ); + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['projectId', 'historyId', 'executionId'], + pathParams: ['executionId', 'historyId', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } } /** - * toolresults.projects.histories.executions.steps.perfSampleSeries.create - * @desc Creates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist - * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.create + * toolresults.steps.get + * @desc Gets a Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Step does not exist + * @alias toolresults.steps.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A tool results execution ID. - * @param {string} params.historyId A tool results history ID. - * @param {string} params.projectId The cloud project - * @param {string} params.stepId A tool results step ID. - * @param {().PerfSampleSeries} params.requestBody Request body data + * @param {string} params.executionId A Execution id. Required. + * @param {string} params.historyId A History id. Required. + * @param {string} params.projectId A Project id. Required. + * @param {string} params.stepId A Step id. Required. * @param {object} [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$Histories$Executions$Steps$Perfsampleseries$Create, + get( + params?: Params$Resource$Steps$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Steps$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Steps$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create; + | Params$Resource$Steps$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Steps$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create; + params = {} as Params$Resource$Steps$Get; options = {}; } @@ -3626,9 +3971,9 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), @@ -3638,58 +3983,59 @@ export namespace toolresults_v1beta3 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.executions.steps.perfSampleSeries.get - * @desc Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist - * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.get + * toolresults.steps.getPerfMetricsSummary + * @desc Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist + * @alias toolresults.steps.getPerfMetricsSummary * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.executionId A tool results execution ID. * @param {string} params.historyId A tool results history ID. * @param {string} params.projectId The cloud project - * @param {string} params.sampleSeriesId A sample series id * @param {string} params.stepId A tool results step 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$Histories$Executions$Steps$Perfsampleseries$Get, + getPerfMetricsSummary( + params?: Params$Resource$Steps$Getperfmetricssummary, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + getPerfMetricsSummary( + params: Params$Resource$Steps$Getperfmetricssummary, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get, - callback: BodyResponseCallback + getPerfMetricsSummary( + params: Params$Resource$Steps$Getperfmetricssummary, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getPerfMetricsSummary( + callback: BodyResponseCallback + ): void; + getPerfMetricsSummary( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get - | BodyResponseCallback, + | Params$Resource$Steps$Getperfmetricssummary + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get; + {}) as Params$Resource$Steps$Getperfmetricssummary; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get; + params = {} as Params$Resource$Steps$Getperfmetricssummary; options = {}; } @@ -3704,86 +4050,69 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: [ - 'projectId', - 'historyId', - 'executionId', - 'stepId', - 'sampleSeriesId', - ], - pathParams: [ - 'executionId', - 'historyId', - 'projectId', - 'sampleSeriesId', - 'stepId', - ], + requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], + pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.executions.steps.perfSampleSeries.list - * @desc Lists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist - * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.list + * toolresults.steps.list + * @desc Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_time. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist + * @alias toolresults.steps.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A tool results execution ID. - * @param {string=} params.filter Specify one or more PerfMetricType values such as CPU to filter the result - * @param {string} params.historyId A tool results history ID. - * @param {string} params.projectId The cloud project - * @param {string} params.stepId A tool results step ID. + * @param {string} params.executionId A Execution id. Required. + * @param {string} params.historyId A History id. Required. + * @param {integer=} params.pageSize The maximum number of Steps to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional. + * @param {string=} params.pageToken A continuation token to resume the query at the next item. Optional. + * @param {string} params.projectId A Project id. Required. * @param {object} [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$Histories$Executions$Steps$Perfsampleseries$List, + params?: Params$Resource$Steps$List, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List, - callback: BodyResponseCallback + params: Params$Resource$Steps$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Steps$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List - | BodyResponseCallback, + | Params$Resource$Steps$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List; + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Steps$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List; + params = {} as Params$Resource$Steps$List; options = {}; } @@ -3798,173 +4127,68 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], - pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], + requiredParams: ['projectId', 'historyId', 'executionId'], + pathParams: ['executionId', 'historyId', 'projectId'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * A tool results execution ID. - */ - executionId?: string; - /** - * A tool results history ID. - */ - historyId?: string; - /** - * The cloud project - */ - projectId?: string; - /** - * A tool results step ID. - */ - stepId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PerfSampleSeries; - } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * A tool results execution ID. - */ - executionId?: string; - /** - * A tool results history ID. - */ - historyId?: string; - /** - * The cloud project - */ - projectId?: string; - /** - * A sample series id - */ - sampleSeriesId?: string; - /** - * A tool results step ID. - */ - stepId?: string; - } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * A tool results execution ID. - */ - executionId?: string; - /** - * Specify one or more PerfMetricType values such as CPU to filter the result - */ - filter?: string[]; - /** - * A tool results history ID. - */ - historyId?: string; - /** - * The cloud project - */ - projectId?: string; - /** - * A tool results step ID. - */ - stepId?: string; - } - - export class Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate - * @desc Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist - * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate + * toolresults.steps.patch + * @desc Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist + * @alias toolresults.steps.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A tool results execution ID. - * @param {string} params.historyId A tool results history ID. - * @param {string} params.projectId The cloud project - * @param {string} params.sampleSeriesId A sample series id - * @param {string} params.stepId A tool results step ID. - * @param {().BatchCreatePerfSamplesRequest} params.requestBody Request body data + * @param {string} params.executionId A Execution id. Required. + * @param {string} params.historyId A History id. Required. + * @param {string} params.projectId A Project id. Required. + * @param {string=} params.requestId A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. + * @param {string} params.stepId A Step id. Required. + * @param {().Step} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - batchCreate( - params?: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate, + patch( + params?: Params$Resource$Steps$Patch, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate, - callback: BodyResponseCallback + ): GaxiosPromise; + patch( + params: Params$Resource$Steps$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + patch( + params: Params$Resource$Steps$Patch, + callback: BodyResponseCallback ): void; - batchCreate( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate; + | Params$Resource$Steps$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Steps$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate; + params = {} as Params$Resource$Steps$Patch; options = {}; } @@ -3979,91 +4203,68 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'PATCH', }, options ), params, - requiredParams: [ - 'projectId', - 'historyId', - 'executionId', - 'stepId', - 'sampleSeriesId', - ], - pathParams: [ - 'executionId', - 'historyId', - 'projectId', - 'sampleSeriesId', - 'stepId', - ], + requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], + pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list - * @desc Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist - * @alias toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list + * toolresults.steps.publishXunitXmlFiles + * @desc Publish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist + * @alias toolresults.steps.publishXunitXmlFiles * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.executionId A tool results execution ID. - * @param {string} params.historyId A tool results history ID. - * @param {integer=} params.pageSize The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000 - * @param {string=} params.pageToken Optional, the next_page_token returned in the previous response - * @param {string} params.projectId The cloud project - * @param {string} params.sampleSeriesId A sample series id - * @param {string} params.stepId A tool results step ID. + * @param {string} params.executionId A Execution id. Required. + * @param {string} params.historyId A History id. Required. + * @param {string} params.projectId A Project id. Required. + * @param {string} params.stepId A Step id. Note: This step must include a TestExecutionStep. Required. + * @param {().PublishXunitXmlFilesRequest} params.requestBody Request body data * @param {object} [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$Histories$Executions$Steps$Perfsampleseries$Samples$List, + publishXunitXmlFiles( + params?: Params$Resource$Steps$Publishxunitxmlfiles, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + publishXunitXmlFiles( + params: Params$Resource$Steps$Publishxunitxmlfiles, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List, - callback: BodyResponseCallback + publishXunitXmlFiles( + params: Params$Resource$Steps$Publishxunitxmlfiles, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + publishXunitXmlFiles(callback: BodyResponseCallback): void; + publishXunitXmlFiles( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Steps$Publishxunitxmlfiles + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List; + {}) as Params$Resource$Steps$Publishxunitxmlfiles; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List; + params = {} as Params$Resource$Steps$Publishxunitxmlfiles; options = {}; } @@ -4078,38 +4279,26 @@ export namespace toolresults_v1beta3 { { url: ( rootUrl + - '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples' + '/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: [ - 'projectId', - 'historyId', - 'executionId', - 'stepId', - 'sampleSeriesId', - ], - pathParams: [ - 'executionId', - 'historyId', - 'projectId', - 'sampleSeriesId', - 'stepId', - ], + requiredParams: ['projectId', 'historyId', 'executionId', 'stepId'], + pathParams: ['executionId', 'historyId', 'projectId', 'stepId'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$Batchcreate + export interface Params$Resource$Steps$Accessibilityclusters extends StandardParameters { /** * Auth client or API Key for the request @@ -4117,32 +4306,66 @@ export namespace toolresults_v1beta3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A tool results execution ID. + * The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details. Required. + */ + locale?: string; + /** + * A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required. + */ + name?: string; + } + export interface Params$Resource$Steps$Create extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. An Execution id. */ executionId?: string; /** - * A tool results history ID. + * Required. A History id. */ historyId?: string; /** - * The cloud project + * Required. A Project id. */ projectId?: string; /** - * A sample series id + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. */ - sampleSeriesId?: string; + requestId?: string; + /** - * A tool results step ID. + * Request body metadata */ - stepId?: string; + requestBody?: Schema$Step; + } + export interface Params$Resource$Steps$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Request body metadata + * A Execution id. Required. */ - requestBody?: Schema$BatchCreatePerfSamplesRequest; + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; + /** + * A Project id. Required. + */ + projectId?: string; + /** + * A Step id. Required. + */ + stepId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Perfsampleseries$Samples$List + export interface Params$Resource$Steps$Getperfmetricssummary extends StandardParameters { /** * Auth client or API Key for the request @@ -4158,37 +4381,113 @@ export namespace toolresults_v1beta3 { */ historyId?: string; /** - * The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000 + * The cloud project + */ + projectId?: string; + /** + * A tool results step ID. + */ + stepId?: string; + } + export interface Params$Resource$Steps$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A Execution id. Required. + */ + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; + /** + * The maximum number of Steps to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional. */ pageSize?: number; /** - * Optional, the next_page_token returned in the previous response + * A continuation token to resume the query at the next item. Optional. */ pageToken?: string; /** - * The cloud project + * A Project id. Required. */ projectId?: string; + } + export interface Params$Resource$Steps$Patch extends StandardParameters { /** - * A sample series id + * Auth client or API Key for the request */ - sampleSeriesId?: string; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** - * A tool results step ID. + * A Execution id. Required. + */ + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; + /** + * A Project id. Required. + */ + projectId?: string; + /** + * A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended. + */ + requestId?: string; + /** + * A Step id. Required. + */ + stepId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Step; + } + export interface Params$Resource$Steps$Publishxunitxmlfiles + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A Execution id. Required. + */ + executionId?: string; + /** + * A History id. Required. + */ + historyId?: string; + /** + * A Project id. Required. + */ + projectId?: string; + /** + * A Step id. Note: This step must include a TestExecutionStep. Required. */ stepId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PublishXunitXmlFilesRequest; } - export class Resource$Projects$Histories$Executions$Steps$Testcases { + export class Resource$Testcases { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * toolresults.projects.histories.executions.steps.testCases.get + * toolresults.testCases.get * @desc Gets details of a Test Case for a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Test Case does not exist - * @alias toolresults.projects.histories.executions.steps.testCases.get + * @alias toolresults.testCases.get * @memberOf! () * * @param {object} params Parameters for request @@ -4202,33 +4501,32 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ get( - params?: Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get, + params?: Params$Resource$Testcases$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get, + params: Params$Resource$Testcases$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get, + params: Params$Resource$Testcases$Get, callback: BodyResponseCallback ): void; get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get + | Params$Resource$Testcases$Get | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get; + let params = (paramsOrCallback || {}) as Params$Resource$Testcases$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get; + params = {} as Params$Resource$Testcases$Get; options = {}; } @@ -4274,9 +4572,9 @@ export namespace toolresults_v1beta3 { } /** - * toolresults.projects.histories.executions.steps.testCases.list + * toolresults.testCases.list * @desc Lists Test Cases attached to a Step. Experimental test cases API. Still in active development. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Step does not exist - * @alias toolresults.projects.histories.executions.steps.testCases.list + * @alias toolresults.testCases.list * @memberOf! () * * @param {object} params Parameters for request @@ -4291,37 +4589,36 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Histories$Executions$Steps$Testcases$List, + params?: Params$Resource$Testcases$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Histories$Executions$Steps$Testcases$List, + params: Params$Resource$Testcases$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Histories$Executions$Steps$Testcases$List, + params: Params$Resource$Testcases$List, callback: BodyResponseCallback ): void; list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Testcases$List + | Params$Resource$Testcases$List | BodyResponseCallback, optionsOrCallback?: | MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Testcases$List; + let params = (paramsOrCallback || {}) as Params$Resource$Testcases$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Testcases$List; + params = {} as Params$Resource$Testcases$List; options = {}; } @@ -4355,8 +4652,7 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Testcases$Get - extends StandardParameters { + export interface Params$Resource$Testcases$Get extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4383,8 +4679,7 @@ export namespace toolresults_v1beta3 { */ testCaseId?: string; } - export interface Params$Resource$Projects$Histories$Executions$Steps$Testcases$List - extends StandardParameters { + export interface Params$Resource$Testcases$List extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4416,16 +4711,16 @@ export namespace toolresults_v1beta3 { stepId?: string; } - export class Resource$Projects$Histories$Executions$Steps$Thumbnails { + export class Resource$Thumbnails { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * toolresults.projects.histories.executions.steps.thumbnails.list - * @desc Lists thumbnails of images attached to a step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist - * @alias toolresults.projects.histories.executions.steps.thumbnails.list + * toolresults.thumbnails.list + * @desc Lists thumbnails of images attached to a step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist + * @alias toolresults.thumbnails.list * @memberOf! () * * @param {object} params Parameters for request @@ -4440,18 +4735,18 @@ export namespace toolresults_v1beta3 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List, + params?: Params$Resource$Thumbnails$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List, + params: Params$Resource$Thumbnails$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List, + params: Params$Resource$Thumbnails$List, callback: BodyResponseCallback ): void; list( @@ -4459,20 +4754,19 @@ export namespace toolresults_v1beta3 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List + | Params$Resource$Thumbnails$List | BodyResponseCallback, optionsOrCallback?: | MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List; + let params = (paramsOrCallback || {}) as Params$Resource$Thumbnails$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List; + params = {} as Params$Resource$Thumbnails$List; options = {}; } @@ -4509,8 +4803,7 @@ export namespace toolresults_v1beta3 { } } - export interface Params$Resource$Projects$Histories$Executions$Steps$Thumbnails$List - extends StandardParameters { + export interface Params$Resource$Thumbnails$List extends StandardParameters { /** * Auth client or API Key for the request */ diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 2857b501ecf..5a0ed7734c1 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -146,7 +146,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -163,7 +163,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -176,7 +176,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -215,7 +215,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -368,7 +368,7 @@ export namespace videointelligence_v1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -475,7 +475,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -487,7 +487,7 @@ export namespace videointelligence_v1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** @@ -532,11 +532,11 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -625,7 +625,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -642,7 +642,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -655,7 +655,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -694,7 +694,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -847,7 +847,7 @@ export namespace videointelligence_v1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -954,7 +954,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -966,7 +966,7 @@ export namespace videointelligence_v1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** @@ -1011,11 +1011,11 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1104,7 +1104,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1121,7 +1121,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1134,7 +1134,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1173,7 +1173,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1326,7 +1326,7 @@ export namespace videointelligence_v1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1433,7 +1433,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -1445,7 +1445,7 @@ export namespace videointelligence_v1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** @@ -1490,11 +1490,11 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1622,7 +1622,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1639,7 +1639,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1652,7 +1652,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1704,7 +1704,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -1849,7 +1849,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { /** - * The trackes that a person is detected. + * The detected tracks of a person. */ tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; } @@ -1879,7 +1879,7 @@ export namespace videointelligence_v1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -1905,7 +1905,7 @@ export namespace videointelligence_v1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * Cloud Storage URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id + * Google Cloud Storage(GCS) URI that stores annotation results of one streaming session in JSON format. It is the annotation_result_storage_directory from the request followed by '/cloud_project_number-session_id'. */ annotationResultsUri?: string | null; /** @@ -2024,7 +2024,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2036,7 +2036,7 @@ export namespace videointelligence_v1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** @@ -2093,11 +2093,11 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2177,19 +2177,19 @@ export namespace videointelligence_v1 { */ features?: string[] | null; /** - * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via the `input_uri`. If set, `input_uri` must be unset. */ inputContent?: string | null; /** - * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. + * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. URIs must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify multiple videos, a video URI may include wildcards in the `object-id`. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` must be unset. */ inputUri?: string | null; /** - * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, the region will be determined based on video file location. */ locationId?: string | null; /** - * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. These must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). */ outputUri?: string | null; /** @@ -2215,7 +2215,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -2232,7 +2232,7 @@ export namespace videointelligence_v1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -2245,7 +2245,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -2293,7 +2293,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2314,7 +2314,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number | null; /** @@ -2326,11 +2326,11 @@ export namespace videointelligence_v1 { */ model?: string | null; /** - * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e., non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean | null; /** - * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it's set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number | null; } @@ -2498,7 +2498,7 @@ export namespace videointelligence_v1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2532,7 +2532,7 @@ export namespace videointelligence_v1 { */ enableAutomaticPunctuation?: boolean | null; /** - * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * 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 response. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** @@ -2659,7 +2659,7 @@ export namespace videointelligence_v1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2671,7 +2671,7 @@ export namespace videointelligence_v1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** @@ -2716,11 +2716,11 @@ export namespace videointelligence_v1 { */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index 107bba06342..7fe121a1dad 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -133,19 +133,19 @@ export namespace videointelligence_v1beta2 { */ features?: string[] | null; /** - * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via the `input_uri`. If set, `input_uri` must be unset. */ inputContent?: string | null; /** - * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. + * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. URIs must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify multiple videos, a video URI may include wildcards in the `object-id`. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` must be unset. */ inputUri?: string | null; /** - * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, the region will be determined based on video file location. */ locationId?: string | null; /** - * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. These must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). */ outputUri?: string | null; /** @@ -171,7 +171,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -188,7 +188,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -201,7 +201,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -249,7 +249,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -270,7 +270,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number | null; /** @@ -282,11 +282,11 @@ export namespace videointelligence_v1beta2 { */ model?: string | null; /** - * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e., non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean | null; /** - * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it's set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number | null; } @@ -454,7 +454,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -488,7 +488,7 @@ export namespace videointelligence_v1beta2 { */ enableAutomaticPunctuation?: boolean | null; /** - * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * 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 response. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** @@ -615,7 +615,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -627,7 +627,7 @@ export namespace videointelligence_v1beta2 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** @@ -672,11 +672,11 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -798,7 +798,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -815,7 +815,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -828,7 +828,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -867,7 +867,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -1020,7 +1020,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -1127,7 +1127,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -1139,7 +1139,7 @@ export namespace videointelligence_v1beta2 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** @@ -1184,11 +1184,11 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1277,7 +1277,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1294,7 +1294,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1307,7 +1307,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1346,7 +1346,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1499,7 +1499,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1606,7 +1606,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -1618,7 +1618,7 @@ export namespace videointelligence_v1beta2 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** @@ -1663,11 +1663,11 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1795,7 +1795,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1812,7 +1812,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1825,7 +1825,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1877,7 +1877,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -2022,7 +2022,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { /** - * The trackes that a person is detected. + * The detected tracks of a person. */ tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; } @@ -2052,7 +2052,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -2078,7 +2078,7 @@ export namespace videointelligence_v1beta2 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * Cloud Storage URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id + * Google Cloud Storage(GCS) URI that stores annotation results of one streaming session in JSON format. It is the annotation_result_storage_directory from the request followed by '/cloud_project_number-session_id'. */ annotationResultsUri?: string | null; /** @@ -2197,7 +2197,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2209,7 +2209,7 @@ export namespace videointelligence_v1beta2 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** @@ -2266,11 +2266,11 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2359,7 +2359,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -2376,7 +2376,7 @@ export namespace videointelligence_v1beta2 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -2389,7 +2389,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -2428,7 +2428,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2581,7 +2581,7 @@ export namespace videointelligence_v1beta2 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2688,7 +2688,7 @@ export namespace videointelligence_v1beta2 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2700,7 +2700,7 @@ export namespace videointelligence_v1beta2 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** @@ -2745,11 +2745,11 @@ export namespace videointelligence_v1beta2 { */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index b20858dc2ff..1b7fcde12c7 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -142,7 +142,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -159,7 +159,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -172,7 +172,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -211,7 +211,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -364,7 +364,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -471,7 +471,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -483,7 +483,7 @@ export namespace videointelligence_v1p1beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** @@ -528,11 +528,11 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -612,19 +612,19 @@ export namespace videointelligence_v1p1beta1 { */ features?: string[] | null; /** - * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via the `input_uri`. If set, `input_uri` must be unset. */ inputContent?: string | null; /** - * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. + * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. URIs must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify multiple videos, a video URI may include wildcards in the `object-id`. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` must be unset. */ inputUri?: string | null; /** - * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, the region will be determined based on video file location. */ locationId?: string | null; /** - * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. These must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). */ outputUri?: string | null; /** @@ -650,7 +650,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -667,7 +667,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -680,7 +680,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -728,7 +728,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -749,7 +749,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number | null; /** @@ -761,11 +761,11 @@ export namespace videointelligence_v1p1beta1 { */ model?: string | null; /** - * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e., non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean | null; /** - * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it's set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number | null; } @@ -933,7 +933,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -967,7 +967,7 @@ export namespace videointelligence_v1p1beta1 { */ enableAutomaticPunctuation?: boolean | null; /** - * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * 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 response. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** @@ -1094,7 +1094,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -1106,7 +1106,7 @@ export namespace videointelligence_v1p1beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** @@ -1151,11 +1151,11 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1277,7 +1277,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1294,7 +1294,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1307,7 +1307,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1346,7 +1346,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1499,7 +1499,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1606,7 +1606,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -1618,7 +1618,7 @@ export namespace videointelligence_v1p1beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** @@ -1663,11 +1663,11 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1795,7 +1795,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1812,7 +1812,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1825,7 +1825,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1877,7 +1877,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -2022,7 +2022,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { /** - * The trackes that a person is detected. + * The detected tracks of a person. */ tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; } @@ -2052,7 +2052,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -2078,7 +2078,7 @@ export namespace videointelligence_v1p1beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * Cloud Storage URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id + * Google Cloud Storage(GCS) URI that stores annotation results of one streaming session in JSON format. It is the annotation_result_storage_directory from the request followed by '/cloud_project_number-session_id'. */ annotationResultsUri?: string | null; /** @@ -2197,7 +2197,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2209,7 +2209,7 @@ export namespace videointelligence_v1p1beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** @@ -2266,11 +2266,11 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2359,7 +2359,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -2376,7 +2376,7 @@ export namespace videointelligence_v1p1beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -2389,7 +2389,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -2428,7 +2428,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2581,7 +2581,7 @@ export namespace videointelligence_v1p1beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2688,7 +2688,7 @@ export namespace videointelligence_v1p1beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2700,7 +2700,7 @@ export namespace videointelligence_v1p1beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** @@ -2745,11 +2745,11 @@ export namespace videointelligence_v1p1beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1p2beta1.ts b/src/apis/videointelligence/v1p2beta1.ts index 92aefad7405..1bd80b2ad79 100644 --- a/src/apis/videointelligence/v1p2beta1.ts +++ b/src/apis/videointelligence/v1p2beta1.ts @@ -142,7 +142,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -159,7 +159,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -172,7 +172,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -211,7 +211,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -364,7 +364,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -471,7 +471,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -483,7 +483,7 @@ export namespace videointelligence_v1p2beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** @@ -528,11 +528,11 @@ export namespace videointelligence_v1p2beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -621,7 +621,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -638,7 +638,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -651,7 +651,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -690,7 +690,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -843,7 +843,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -950,7 +950,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -962,7 +962,7 @@ export namespace videointelligence_v1p2beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** @@ -1007,11 +1007,11 @@ export namespace videointelligence_v1p2beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1091,19 +1091,19 @@ export namespace videointelligence_v1p2beta1 { */ features?: string[] | null; /** - * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via the `input_uri`. If set, `input_uri` must be unset. */ inputContent?: string | null; /** - * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. + * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. URIs must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify multiple videos, a video URI may include wildcards in the `object-id`. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` must be unset. */ inputUri?: string | null; /** - * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, the region will be determined based on video file location. */ locationId?: string | null; /** - * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. These must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). */ outputUri?: string | null; /** @@ -1129,7 +1129,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1146,7 +1146,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1159,7 +1159,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1207,7 +1207,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1228,7 +1228,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number | null; /** @@ -1240,11 +1240,11 @@ export namespace videointelligence_v1p2beta1 { */ model?: string | null; /** - * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e., non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean | null; /** - * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it's set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number | null; } @@ -1412,7 +1412,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1446,7 +1446,7 @@ export namespace videointelligence_v1p2beta1 { */ enableAutomaticPunctuation?: boolean | null; /** - * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * 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 response. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** @@ -1573,7 +1573,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -1585,7 +1585,7 @@ export namespace videointelligence_v1p2beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** @@ -1630,11 +1630,11 @@ export namespace videointelligence_v1p2beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1795,7 +1795,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1812,7 +1812,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1825,7 +1825,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1877,7 +1877,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -2022,7 +2022,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { /** - * The trackes that a person is detected. + * The detected tracks of a person. */ tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; } @@ -2052,7 +2052,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -2078,7 +2078,7 @@ export namespace videointelligence_v1p2beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * Cloud Storage URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id + * Google Cloud Storage(GCS) URI that stores annotation results of one streaming session in JSON format. It is the annotation_result_storage_directory from the request followed by '/cloud_project_number-session_id'. */ annotationResultsUri?: string | null; /** @@ -2197,7 +2197,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2209,7 +2209,7 @@ export namespace videointelligence_v1p2beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** @@ -2266,11 +2266,11 @@ export namespace videointelligence_v1p2beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2359,7 +2359,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -2376,7 +2376,7 @@ export namespace videointelligence_v1p2beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -2389,7 +2389,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -2428,7 +2428,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2581,7 +2581,7 @@ export namespace videointelligence_v1p2beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2688,7 +2688,7 @@ export namespace videointelligence_v1p2beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2700,7 +2700,7 @@ export namespace videointelligence_v1p2beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** @@ -2745,11 +2745,11 @@ export namespace videointelligence_v1p2beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/videointelligence/v1p3beta1.ts b/src/apis/videointelligence/v1p3beta1.ts index 44dc7483c23..18ff407bf85 100644 --- a/src/apis/videointelligence/v1p3beta1.ts +++ b/src/apis/videointelligence/v1p3beta1.ts @@ -142,7 +142,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -159,7 +159,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -172,7 +172,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -211,7 +211,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1beta2_Entity[]; /** @@ -364,7 +364,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1beta2_WordInfo[]; } @@ -471,7 +471,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -483,7 +483,7 @@ export namespace videointelligence_v1p3beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** @@ -528,11 +528,11 @@ export namespace videointelligence_v1p3beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1beta2_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1beta2_LabelAnnotation[]; /** @@ -621,7 +621,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -638,7 +638,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -651,7 +651,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -690,7 +690,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p1beta1_Entity[]; /** @@ -843,7 +843,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p1beta1_WordInfo[]; } @@ -950,7 +950,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p1beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -962,7 +962,7 @@ export namespace videointelligence_v1p3beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** @@ -1007,11 +1007,11 @@ export namespace videointelligence_v1p3beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p1beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p1beta1_LabelAnnotation[]; /** @@ -1100,7 +1100,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1117,7 +1117,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1130,7 +1130,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1169,7 +1169,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p2beta1_Entity[]; /** @@ -1322,7 +1322,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p2beta1_WordInfo[]; } @@ -1429,7 +1429,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p2beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -1441,7 +1441,7 @@ export namespace videointelligence_v1p3beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** @@ -1486,11 +1486,11 @@ export namespace videointelligence_v1p3beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p2beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p2beta1_LabelAnnotation[]; /** @@ -1570,19 +1570,19 @@ export namespace videointelligence_v1p3beta1 { */ features?: string[] | null; /** - * The video data bytes. If unset, the input video(s) should be specified via `input_uri`. If set, `input_uri` should be unset. + * The video data bytes. If unset, the input video(s) should be specified via the `input_uri`. If set, `input_uri` must be unset. */ inputContent?: string | null; /** - * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). A video URI may include wildcards in `object-id`, and thus identify multiple videos. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` should be unset. + * Input video location. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. URIs must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify multiple videos, a video URI may include wildcards in the `object-id`. Supported wildcards: '*' to match 0 or more characters; '?' to match 1 character. If unset, the input video should be embedded in the request as `input_content`. If set, `input_content` must be unset. */ inputUri?: string | null; /** - * Optional. Cloud region where annotation should take place. Supported cloud regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, a region will be determined based on video file location. + * Optional. Cloud region where annotation should take place. Supported cloud regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region is specified, the region will be determined based on video file location. */ locationId?: string | null; /** - * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported, which must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). + * Optional. Location where the output (in JSON format) should be stored. Currently, only [Cloud Storage](https://cloud.google.com/storage/) URIs are supported. These must be specified in the following format: `gs://bucket-id/object-id` (other URI formats return google.rpc.Code.INVALID_ARGUMENT). For more information, see [Request URIs](https://cloud.google.com/storage/docs/request-endpoints). */ outputUri?: string | null; /** @@ -1647,7 +1647,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -1664,7 +1664,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -1677,7 +1677,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -1738,11 +1738,11 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionConfig { /** - * Whether to enable face attributes detection, such as glasses, dark_glasses, mouth_open etc. Ignored if 'include_bounding_boxes' is false. + * Whether to enable face attributes detection, such as glasses, dark_glasses, mouth_open etc. Ignored if 'include_bounding_boxes' is set to false. */ includeAttributes?: boolean | null; /** - * Whether bounding boxes be included in the face annotation output. + * Whether bounding boxes are included in the face annotation output. */ includeBoundingBoxes?: boolean | null; /** @@ -1755,7 +1755,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1p3beta1_Entity[]; /** @@ -1776,7 +1776,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_LabelDetectionConfig { /** - * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from frame-level detection. If not set, it is set to 0.4 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ frameConfidenceThreshold?: number | null; /** @@ -1788,11 +1788,11 @@ export namespace videointelligence_v1p3beta1 { */ model?: string | null; /** - * Whether the video has been shot from a stationary (i.e. non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. + * Whether the video has been shot from a stationary (i.e., non-moving) camera. When set to true, might improve detection accuracy for moving objects. Should be used with `SHOT_AND_FRAME_MODE` enabled. */ stationaryCamera?: boolean | null; /** - * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it is set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: for best results please follow the default threshold. We will update the default threshold everytime when we release a new model. + * The confidence threshold we perform filtering on the labels from video-level and shot-level detections. If not set, it's set to 0.3 by default. The valid range for this threshold is [0.1, 0.9]. Any value set outside of this range will be clipped. Note: For best results, follow the default threshold. We will update the default threshold everytime when we release a new model. */ videoConfidenceThreshold?: number | null; } @@ -1934,7 +1934,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { /** - * The trackes that a person is detected. + * The detected tracks of a person. */ tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; } @@ -1943,15 +1943,15 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionConfig { /** - * Whether to enable person attributes detection, such as cloth color (black, blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair color (black, blonde, etc), hair length (long, short, bald), etc. Ignored if 'include_bounding_boxes' is false. + * Whether to enable person attributes detection, such as cloth color (black, blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair, etc. Ignored if 'include_bounding_boxes' is set to false. */ includeAttributes?: boolean | null; /** - * Whether bounding boxes be included in the person detection annotation output. + * Whether bounding boxes are included in the person detection annotation output. */ includeBoundingBoxes?: boolean | null; /** - * Whether to enable pose landmarks detection. Ignored if 'include_bounding_boxes' is false. + * Whether to enable pose landmarks detection. Ignored if 'include_bounding_boxes' is set to false. */ includePoseLandmarks?: boolean | null; } @@ -1999,7 +1999,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1p3beta1_WordInfo[]; } @@ -2033,7 +2033,7 @@ export namespace videointelligence_v1p3beta1 { */ enableAutomaticPunctuation?: boolean | null; /** - * Optional. If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. + * 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 response. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. */ enableSpeakerDiarization?: boolean | null; /** @@ -2066,7 +2066,7 @@ export namespace videointelligence_v1p3beta1 { */ annotationResults?: Schema$GoogleCloudVideointelligenceV1p3beta1_StreamingVideoAnnotationResults; /** - * Cloud Storage URI that stores annotation results of one streaming session. It is a directory that can hold multiple files in JSON format. Example uri format: gs://bucket_id/object_id/cloud_project_name-session_id + * Google Cloud Storage(GCS) URI that stores annotation results of one streaming session in JSON format. It is the annotation_result_storage_directory from the request followed by '/cloud_project_number-session_id'. */ annotationResultsUri?: string | null; /** @@ -2198,7 +2198,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1p3beta1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2210,7 +2210,7 @@ export namespace videointelligence_v1p3beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** @@ -2267,11 +2267,11 @@ export namespace videointelligence_v1p3beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1p3beta1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_LabelAnnotation[]; /** @@ -2401,7 +2401,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of the attribute, i.e. glasses, dark_glasses, mouth_open etc. A full list of supported type names will be provided in the document. + * The name of the attribute, for example, glasses, dark_glasses, mouth_open. A full list of supported type names will be provided in the document. */ name?: string | null; /** @@ -2418,7 +2418,7 @@ export namespace videointelligence_v1p3beta1 { */ confidence?: number | null; /** - * The name of this landmark, i.e. left_hand, right_shoulder. + * The name of this landmark, for example, left_hand, right_shoulder. */ name?: string | null; /** @@ -2431,7 +2431,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_Entity { /** - * Textual description, e.g. `Fixed-gear bicycle`. + * Textual description, e.g., `Fixed-gear bicycle`. */ description?: string | null; /** @@ -2470,7 +2470,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_LabelAnnotation { /** - * Common categories for the detected entity. E.g. when the label is `Terrier` the category is likely `dog`. And in some cases there might be more than one categories e.g. `Terrier` could also be a `pet`. + * Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`. */ categoryEntities?: Schema$GoogleCloudVideointelligenceV1_Entity[]; /** @@ -2623,7 +2623,7 @@ export namespace videointelligence_v1p3beta1 { */ transcript?: string | null; /** - * 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. + * Output only. A list of word-specific information for each recognized word. Note: When `enable_speaker_diarization` is set to true, you will see all the words from the beginning of the audio. */ words?: Schema$GoogleCloudVideointelligenceV1_WordInfo[]; } @@ -2730,7 +2730,7 @@ export namespace videointelligence_v1p3beta1 { */ export interface Schema$GoogleCloudVideointelligenceV1_VideoAnnotationProgress { /** - * Specifies which feature is being tracked if the request contains more than one features. + * Specifies which feature is being tracked if the request contains more than one feature. */ feature?: string | null; /** @@ -2742,7 +2742,7 @@ export namespace videointelligence_v1p3beta1 { */ progressPercent?: number | null; /** - * Specifies which segment is being tracked if the request contains more than one segments. + * Specifies which segment is being tracked if the request contains more than one segment. */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** @@ -2787,11 +2787,11 @@ export namespace videointelligence_v1p3beta1 { */ segment?: Schema$GoogleCloudVideointelligenceV1_VideoSegment; /** - * Topical label annotations on video level or user specified segment level. There is exactly one element for each unique label. + * Topical label annotations on video level or user-specified segment level. There is exactly one element for each unique label. */ segmentLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** - * Presence label annotations on video level or user specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. + * Presence label annotations on video level or user-specified segment level. There is exactly one element for each unique label. Compared to the existing topical `segment_label_annotations`, this field presents more fine-grained, segment-level labels detected in video content and is made available only when the client sets `LabelDetectionConfig.model` to "builtin/latest" in the request. */ segmentPresenceLabelAnnotations?: Schema$GoogleCloudVideointelligenceV1_LabelAnnotation[]; /** diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index 37add774d7f..356fdf12231 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -4332,7 +4332,7 @@ export namespace vision_v1 { */ cropHintsParams?: Schema$CropHintsParams; /** - * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). + * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages). */ languageHints?: string[] | null; /** diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 8d989f0bd2a..afd7ebb9e5e 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -1036,7 +1036,7 @@ export namespace vision_v1p1beta1 { */ cropHintsParams?: Schema$GoogleCloudVisionV1p1beta1CropHintsParams; /** - * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). + * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages). */ languageHints?: string[] | null; /** diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index 1860950ad1b..b77331b04ec 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -1898,7 +1898,7 @@ export namespace vision_v1p2beta1 { */ cropHintsParams?: Schema$GoogleCloudVisionV1p2beta1CropHintsParams; /** - * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](/vision/docs/languages). + * List of languages to use for TEXT_DETECTION. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting `language_hints` is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong). Text detection returns an error if one or more of the specified languages is not one of the [supported languages](https://cloud.google.com/vision/docs/languages). */ languageHints?: string[] | null; /** diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 0a6d3dcf661..a89c517bc52 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -2012,6 +2012,7 @@ export namespace youtube_v3 { * This setting indicates whether auto start is enabled for this broadcast. */ enableAutoStart?: boolean | null; + enableAutoStop?: boolean | null; /** * This setting indicates whether HTTP POST closed captioning is enabled for this broadcast. The ingestion URL of the closed captions is returned through the liveStreams API. This is mutually exclusive with using the closed_captions_type property, and is equivalent to setting closed_captions_type to CLOSED_CAPTIONS_HTTP_POST. */ diff --git a/src/generator/templates/package.json.njk b/src/generator/templates/package.json.njk index 0ee43f1610c..342b753b744 100644 --- a/src/generator/templates/package.json.njk +++ b/src/generator/templates/package.json.njk @@ -33,8 +33,8 @@ }, "devDependencies": { "gts": "^1.0.0", - "null-loader": "^3.0.0", - "ts-loader": "^6.0.4", + "null-loader": "^4.0.0", + "ts-loader": "^7.0.0", "typedoc": "^0.17.0", "typescript": "~3.7.0", "webpack": "^4.35.3", diff --git a/src/index.ts b/src/index.ts index 3d6dfe062ef..efe27bbdb04 100644 --- a/src/index.ts +++ b/src/index.ts @@ -70,6 +70,7 @@ export {classroom_v1} from './apis/classroom/v1'; export {cloudasset_v1} from './apis/cloudasset/v1'; export {cloudasset_v1beta1} from './apis/cloudasset/v1beta1'; export {cloudasset_v1p1beta1} from './apis/cloudasset/v1p1beta1'; +export {cloudasset_v1p4beta1} from './apis/cloudasset/v1p4beta1'; export {cloudbilling_v1} from './apis/cloudbilling/v1'; export {cloudbuild_v1} from './apis/cloudbuild/v1'; export {cloudbuild_v1alpha1} from './apis/cloudbuild/v1alpha1'; @@ -148,6 +149,7 @@ export {file_v1beta1} from './apis/file/v1beta1'; export {firebase_v1beta1} from './apis/firebase/v1beta1'; export {firebasedynamiclinks_v1} from './apis/firebasedynamiclinks/v1'; export {firebasehosting_v1beta1} from './apis/firebasehosting/v1beta1'; +export {firebaseml_v1beta2} from './apis/firebaseml/v1beta2'; export {firebaserules_v1} from './apis/firebaserules/v1'; export {firestore_v1} from './apis/firestore/v1'; export {firestore_v1beta1} from './apis/firestore/v1beta1'; @@ -172,6 +174,7 @@ export {iap_v1} from './apis/iap/v1'; export {iap_v1beta1} from './apis/iap/v1beta1'; export {identitytoolkit_v3} from './apis/identitytoolkit/v3'; export {indexing_v3} from './apis/indexing/v3'; +export {jobs_v2} from './apis/jobs/v2'; export {jobs_v3} from './apis/jobs/v3'; export {jobs_v3p1beta1} from './apis/jobs/v3p1beta1'; export {kgsearch_v1} from './apis/kgsearch/v1'; diff --git a/test/fixtures/discovery/blogger.json b/test/fixtures/discovery/blogger.json index 633388bbd37..81f94152823 100644 --- a/test/fixtures/discovery/blogger.json +++ b/test/fixtures/discovery/blogger.json @@ -1,2507 +1,2388 @@ { - "kind": "discovery#restDescription", - "etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/xSOfH1Tz95YnVhKU4FjuY2Lv4PE\"", - "discoveryVersion": "v1", - "id": "blogger:v3", - "name": "blogger", - "version": "v3", - "revision": "20200204", - "title": "Blogger API", - "description": "API for access to the data within Blogger.", - "ownerDomain": "google.com", "ownerName": "Google", - "icons": { - "x16": "https://www.google.com/images/icons/product/blogger-16.png", - "x32": "https://www.google.com/images/icons/product/blogger-32.png" + "resources": { + "comments": { + "methods": { + "list": { + "description": "Lists comments.", + "response": { + "$ref": "CommentList" + }, + "parameterOrder": [ + "blogId", + "postId" + ], + "httpMethod": "GET", + "parameters": { + "view": { + "type": "string", + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "maxResults": { + "location": "query", + "format": "uint32", + "type": "integer" + }, + "startDate": { + "type": "string", + "location": "query" + }, + "status": { + "location": "query", + "enum": [ + "LIVE", + "EMPTIED", + "PENDING", + "SPAM" + ], + "type": "string" + }, + "postId": { + "location": "path", + "type": "string", + "required": true + }, + "fetchBodies": { + "type": "boolean", + "location": "query" + }, + "pageToken": { + "location": "query", + "type": "string" + }, + "endDate": { + "location": "query", + "type": "string" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "flatPath": "v3/blogs/{blogId}/posts/{postId}/comments", + "id": "blogger.comments.list", + "path": "v3/blogs/{blogId}/posts/{postId}/comments" + }, + "markAsSpam": { + "description": "Marks a comment as spam by blog id, post id and comment id.", + "httpMethod": "POST", + "parameterOrder": [ + "blogId", + "postId", + "commentId" + ], + "response": { + "$ref": "Comment" + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "commentId": { + "location": "path", + "type": "string", + "required": true + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "postId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam", + "path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/spam", + "id": "blogger.comments.markAsSpam" + }, + "approve": { + "parameters": { + "commentId": { + "type": "string", + "required": true, + "location": "path" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "postId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve", + "id": "blogger.comments.approve", + "path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/approve", + "description": "Marks a comment as not spam by blog id, post id and comment id.", + "response": { + "$ref": "Comment" + }, + "parameterOrder": [ + "blogId", + "postId", + "commentId" + ], + "httpMethod": "POST" + }, + "listByBlog": { + "id": "blogger.comments.listByBlog", + "path": "v3/blogs/{blogId}/comments", + "description": "Lists comments by blog.", + "response": { + "$ref": "CommentList" + }, + "parameterOrder": [ + "blogId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "startDate": { + "location": "query", + "type": "string" + }, + "status": { + "type": "string", + "repeated": true, + "location": "query", + "enum": [ + "LIVE", + "EMPTIED", + "PENDING", + "SPAM" + ] + }, + "fetchBodies": { + "type": "boolean", + "location": "query" + }, + "pageToken": { + "location": "query", + "type": "string" + }, + "endDate": { + "location": "query", + "type": "string" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "maxResults": { + "type": "integer", + "location": "query", + "format": "uint32" + } + }, + "flatPath": "v3/blogs/{blogId}/comments" + }, + "get": { + "response": { + "$ref": "Comment" + }, + "parameterOrder": [ + "blogId", + "postId", + "commentId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "view": { + "type": "string", + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "postId": { + "type": "string", + "required": true, + "location": "path" + }, + "commentId": { + "location": "path", + "type": "string", + "required": true + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}", + "id": "blogger.comments.get", + "path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}", + "description": "Gets a comment by id." + }, + "removeContent": { + "description": "Removes the content of a comment by blog id, post id and comment id.", + "parameterOrder": [ + "blogId", + "postId", + "commentId" + ], + "response": { + "$ref": "Comment" + }, + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "postId": { + "type": "string", + "required": true, + "location": "path" + }, + "commentId": { + "location": "path", + "type": "string", + "required": true + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + } + }, + "flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent", + "id": "blogger.comments.removeContent", + "path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent" + }, + "delete": { + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "commentId": { + "location": "path", + "type": "string", + "required": true + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "postId": { + "location": "path", + "type": "string", + "required": true + } + }, + "flatPath": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}", + "id": "blogger.comments.delete", + "path": "v3/blogs/{blogId}/posts/{postId}/comments/{commentId}", + "description": "Deletes a comment by blog id, post id and comment id.", + "parameterOrder": [ + "blogId", + "postId", + "commentId" + ], + "httpMethod": "DELETE" + } + } + }, + "posts": { + "methods": { + "search": { + "path": "v3/blogs/{blogId}/posts/search", + "id": "blogger.posts.search", + "description": "Searches for posts matching given query terms in the specified blog.", + "httpMethod": "GET", + "response": { + "$ref": "PostList" + }, + "parameterOrder": [ + "blogId", + "q" + ], + "parameters": { + "orderBy": { + "location": "query", + "enum": [ + "ORDER_BY_UNSPECIFIED", + "PUBLISHED", + "UPDATED" + ], + "type": "string", + "default": "PUBLISHED" + }, + "q": { + "type": "string", + "required": true, + "location": "query" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "fetchBodies": { + "type": "boolean", + "default": "true", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "flatPath": "v3/blogs/{blogId}/posts/search" + }, + "insert": { + "httpMethod": "POST", + "parameterOrder": [ + "blogId" + ], + "response": { + "$ref": "Post" + }, + "parameters": { + "isDraft": { + "location": "query", + "type": "boolean" + }, + "fetchImages": { + "type": "boolean", + "location": "query" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "fetchBody": { + "type": "boolean", + "default": "true", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/posts", + "path": "v3/blogs/{blogId}/posts", + "id": "blogger.posts.insert", + "request": { + "$ref": "Post" + }, + "description": "Inserts a post." + }, + "get": { + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "postId": { + "location": "path", + "type": "string", + "required": true + }, + "maxComments": { + "type": "integer", + "location": "query", + "format": "uint32" + }, + "fetchImages": { + "type": "boolean", + "location": "query" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "view": { + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ], + "type": "string" + }, + "fetchBody": { + "type": "boolean", + "default": "true", + "location": "query" + } + }, + "flatPath": "v3/blogs/{blogId}/posts/{postId}", + "id": "blogger.posts.get", + "path": "v3/blogs/{blogId}/posts/{postId}", + "description": "Gets a post by blog id and post id", + "response": { + "$ref": "Post" + }, + "parameterOrder": [ + "blogId", + "postId" + ], + "httpMethod": "GET" + }, + "patch": { + "httpMethod": "PATCH", + "parameterOrder": [ + "blogId", + "postId" + ], + "response": { + "$ref": "Post" + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "maxComments": { + "location": "query", + "format": "uint32", + "type": "integer" + }, + "fetchImages": { + "type": "boolean", + "location": "query" + }, + "publish": { + "type": "boolean", + "location": "query" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "fetchBody": { + "location": "query", + "type": "boolean", + "default": "true" + }, + "revert": { + "location": "query", + "type": "boolean" + }, + "postId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "flatPath": "v3/blogs/{blogId}/posts/{postId}", + "path": "v3/blogs/{blogId}/posts/{postId}", + "id": "blogger.posts.patch", + "description": "Patches a post.", + "request": { + "$ref": "Post" + } + }, + "update": { + "flatPath": "v3/blogs/{blogId}/posts/{postId}", + "path": "v3/blogs/{blogId}/posts/{postId}", + "id": "blogger.posts.update", + "request": { + "$ref": "Post" + }, + "description": "Updates a post by blog id and post id.", + "httpMethod": "PUT", + "parameterOrder": [ + "blogId", + "postId" + ], + "response": { + "$ref": "Post" + }, + "parameters": { + "postId": { + "type": "string", + "required": true, + "location": "path" + }, + "maxComments": { + "format": "uint32", + "type": "integer", + "location": "query" + }, + "publish": { + "type": "boolean", + "location": "query" + }, + "fetchImages": { + "location": "query", + "type": "boolean" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "fetchBody": { + "location": "query", + "type": "boolean", + "default": "true" + }, + "revert": { + "type": "boolean", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ] + }, + "publish": { + "httpMethod": "POST", + "parameterOrder": [ + "blogId", + "postId" + ], + "response": { + "$ref": "Post" + }, + "parameters": { + "postId": { + "location": "path", + "type": "string", + "required": true + }, + "publishDate": { + "location": "query", + "type": "string" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/posts/{postId}/publish", + "path": "v3/blogs/{blogId}/posts/{postId}/publish", + "id": "blogger.posts.publish", + "description": "Publishes a post." + }, + "revert": { + "id": "blogger.posts.revert", + "path": "v3/blogs/{blogId}/posts/{postId}/revert", + "description": "Reverts a published or scheduled post to draft state.", + "response": { + "$ref": "Post" + }, + "parameterOrder": [ + "blogId", + "postId" + ], + "httpMethod": "POST", + "parameters": { + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "postId": { + "location": "path", + "type": "string", + "required": true + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/posts/{postId}/revert" + }, + "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "blogId", + "postId" + ], + "parameters": { + "postId": { + "location": "path", + "type": "string", + "required": true + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/posts/{postId}", + "path": "v3/blogs/{blogId}/posts/{postId}", + "id": "blogger.posts.delete", + "description": "Deletes a post by blog id and post id." + }, + "list": { + "response": { + "$ref": "PostList" + }, + "parameterOrder": [ + "blogId" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "location": "query", + "type": "string" + }, + "fetchImages": { + "type": "boolean", + "location": "query" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "endDate": { + "type": "string", + "location": "query" + }, + "view": { + "type": "string", + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "maxResults": { + "location": "query", + "format": "uint32", + "type": "integer" + }, + "startDate": { + "location": "query", + "type": "string" + }, + "labels": { + "location": "query", + "type": "string" + }, + "status": { + "location": "query", + "enum": [ + "LIVE", + "DRAFT", + "SCHEDULED" + ], + "type": "string", + "repeated": true + }, + "orderBy": { + "location": "query", + "enum": [ + "ORDER_BY_UNSPECIFIED", + "PUBLISHED", + "UPDATED" + ], + "type": "string", + "default": "PUBLISHED" + }, + "fetchBodies": { + "type": "boolean", + "default": "true", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "flatPath": "v3/blogs/{blogId}/posts", + "id": "blogger.posts.list", + "path": "v3/blogs/{blogId}/posts", + "description": "Lists posts." + }, + "getByPath": { + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "view": { + "type": "string", + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "path": { + "type": "string", + "required": true, + "location": "query" + }, + "maxComments": { + "format": "uint32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v3/blogs/{blogId}/posts/bypath", + "id": "blogger.posts.getByPath", + "path": "v3/blogs/{blogId}/posts/bypath", + "description": "Gets a post by path.", + "response": { + "$ref": "Post" + }, + "parameterOrder": [ + "blogId", + "path" + ], + "httpMethod": "GET" + } + } + }, + "users": { + "methods": { + "get": { + "flatPath": "v3/users/{userId}", + "id": "blogger.users.get", + "path": "v3/users/{userId}", + "description": "Gets one user by user_id.", + "response": { + "$ref": "User" + }, + "parameterOrder": [ + "userId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "userId": { + "type": "string", + "required": true, + "location": "path" + } + } + } + } + }, + "pages": { + "methods": { + "revert": { + "httpMethod": "POST", + "parameterOrder": [ + "blogId", + "pageId" + ], + "response": { + "$ref": "Page" + }, + "parameters": { + "pageId": { + "type": "string", + "required": true, + "location": "path" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/pages/{pageId}/revert", + "path": "v3/blogs/{blogId}/pages/{pageId}/revert", + "id": "blogger.pages.revert", + "description": "Reverts a published or scheduled page to draft state." + }, + "delete": { + "parameterOrder": [ + "blogId", + "pageId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "pageId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "flatPath": "v3/blogs/{blogId}/pages/{pageId}", + "id": "blogger.pages.delete", + "path": "v3/blogs/{blogId}/pages/{pageId}", + "description": "Deletes a page by blog id and page id." + }, + "list": { + "path": "v3/blogs/{blogId}/pages", + "id": "blogger.pages.list", + "description": "Lists pages.", + "httpMethod": "GET", + "parameterOrder": [ + "blogId" + ], + "response": { + "$ref": "PageList" + }, + "parameters": { + "fetchBodies": { + "location": "query", + "type": "boolean" + }, + "pageToken": { + "type": "string", + "location": "query" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "maxResults": { + "format": "uint32", + "type": "integer", + "location": "query" + }, + "view": { + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ], + "type": "string" + }, + "status": { + "type": "string", + "repeated": true, + "location": "query", + "enum": [ + "LIVE", + "DRAFT" + ] + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "flatPath": "v3/blogs/{blogId}/pages" + }, + "insert": { + "parameters": { + "isDraft": { + "type": "boolean", + "location": "query" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/pages", + "path": "v3/blogs/{blogId}/pages", + "id": "blogger.pages.insert", + "request": { + "$ref": "Page" + }, + "description": "Inserts a page.", + "httpMethod": "POST", + "parameterOrder": [ + "blogId" + ], + "response": { + "$ref": "Page" + } + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "blogId", + "pageId" + ], + "response": { + "$ref": "Page" + }, + "parameters": { + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "view": { + "type": "string", + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "pageId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "flatPath": "v3/blogs/{blogId}/pages/{pageId}", + "path": "v3/blogs/{blogId}/pages/{pageId}", + "id": "blogger.pages.get", + "description": "Gets a page by blog id and page id." + }, + "patch": { + "id": "blogger.pages.patch", + "path": "v3/blogs/{blogId}/pages/{pageId}", + "description": "Patches a page.", + "request": { + "$ref": "Page" + }, + "response": { + "$ref": "Page" + }, + "parameterOrder": [ + "blogId", + "pageId" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "publish": { + "location": "query", + "type": "boolean" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "revert": { + "type": "boolean", + "location": "query" + }, + "pageId": { + "location": "path", + "type": "string", + "required": true + } + }, + "flatPath": "v3/blogs/{blogId}/pages/{pageId}" + }, + "update": { + "description": "Updates a page by blog id and page id.", + "request": { + "$ref": "Page" + }, + "httpMethod": "PUT", + "parameterOrder": [ + "blogId", + "pageId" + ], + "response": { + "$ref": "Page" + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "publish": { + "location": "query", + "type": "boolean" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "revert": { + "type": "boolean", + "location": "query" + }, + "pageId": { + "type": "string", + "required": true, + "location": "path" + } + }, + "flatPath": "v3/blogs/{blogId}/pages/{pageId}", + "path": "v3/blogs/{blogId}/pages/{pageId}", + "id": "blogger.pages.update" + }, + "publish": { + "parameters": { + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "pageId": { + "location": "path", + "type": "string", + "required": true + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "flatPath": "v3/blogs/{blogId}/pages/{pageId}/publish", + "id": "blogger.pages.publish", + "path": "v3/blogs/{blogId}/pages/{pageId}/publish", + "description": "Publishes a page.", + "response": { + "$ref": "Page" + }, + "parameterOrder": [ + "blogId", + "pageId" + ], + "httpMethod": "POST" + } + } + }, + "pageViews": { + "methods": { + "get": { + "id": "blogger.pageViews.get", + "path": "v3/blogs/{blogId}/pageviews", + "description": "Gets page views by blog id.", + "response": { + "$ref": "Pageviews" + }, + "parameterOrder": [ + "blogId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/blogger" + ], + "parameters": { + "range": { + "type": "string", + "repeated": true, + "location": "query", + "enum": [ + "all", + "30DAYS", + "7DAYS" + ] + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + } + }, + "flatPath": "v3/blogs/{blogId}/pageviews" + } + } + }, + "blogs": { + "methods": { + "get": { + "response": { + "$ref": "Blog" + }, + "httpMethod": "GET", + "parameterOrder": [ + "blogId" + ], + "parameters": { + "maxPosts": { + "location": "query", + "format": "uint32", + "type": "integer" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "view": { + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ], + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "flatPath": "v3/blogs/{blogId}", + "id": "blogger.blogs.get", + "path": "v3/blogs/{blogId}", + "description": "Gets a blog by id." + }, + "listByUser": { + "description": "Lists blogs by user.", + "httpMethod": "GET", + "parameterOrder": [ + "userId" + ], + "response": { + "$ref": "BlogList" + }, + "parameters": { + "status": { + "enum": [ + "LIVE", + "DELETED" + ], + "type": "string", + "repeated": true, + "location": "query", + "description": "Default value of status is LIVE.", + "default": "LIVE" + }, + "role": { + "type": "string", + "repeated": true, + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "userId": { + "location": "path", + "type": "string", + "required": true + }, + "view": { + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ], + "type": "string" + }, + "fetchUserInfo": { + "location": "query", + "type": "boolean" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "flatPath": "v3/users/{userId}/blogs", + "path": "v3/users/{userId}/blogs", + "id": "blogger.blogs.listByUser" + }, + "getByUrl": { + "flatPath": "v3/blogs/byurl", + "id": "blogger.blogs.getByUrl", + "path": "v3/blogs/byurl", + "description": "Gets a blog by url.", + "response": { + "$ref": "Blog" + }, + "parameterOrder": [ + "url" + ], + "httpMethod": "GET", + "parameters": { + "view": { + "type": "string", + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "url": { + "location": "query", + "type": "string", + "required": true + } + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ] + } + } + }, + "blogUserInfos": { + "methods": { + "get": { + "description": "Gets one blog and user info pair by blog id and user id.", + "httpMethod": "GET", + "parameterOrder": [ + "userId", + "blogId" + ], + "response": { + "$ref": "BlogUserInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "userId": { + "location": "path", + "type": "string", + "required": true + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "maxPosts": { + "type": "integer", + "location": "query", + "format": "uint32" + } + }, + "flatPath": "v3/users/{userId}/blogs/{blogId}", + "path": "v3/users/{userId}/blogs/{blogId}", + "id": "blogger.blogUserInfos.get" + } + } + }, + "postUserInfos": { + "methods": { + "list": { + "flatPath": "v3/users/{userId}/blogs/{blogId}/posts", + "id": "blogger.postUserInfos.list", + "path": "v3/users/{userId}/blogs/{blogId}/posts", + "description": "Lists post and user info pairs.", + "parameterOrder": [ + "userId", + "blogId" + ], + "httpMethod": "GET", + "response": { + "$ref": "PostUserInfosList" + }, + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "maxResults": { + "type": "integer", + "location": "query", + "format": "uint32" + }, + "view": { + "type": "string", + "location": "query", + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "labels": { + "location": "query", + "type": "string" + }, + "startDate": { + "location": "query", + "type": "string" + }, + "status": { + "repeated": true, + "location": "query", + "enum": [ + "LIVE", + "DRAFT", + "SCHEDULED" + ], + "type": "string" + }, + "userId": { + "location": "path", + "type": "string", + "required": true + }, + "orderBy": { + "type": "string", + "default": "PUBLISHED", + "location": "query", + "enum": [ + "ORDER_BY_UNSPECIFIED", + "PUBLISHED", + "UPDATED" + ] + }, + "fetchBodies": { + "type": "boolean", + "default": "false", + "location": "query" + }, + "pageToken": { + "location": "query", + "type": "string" + }, + "blogId": { + "location": "path", + "type": "string", + "required": true + }, + "endDate": { + "type": "string", + "location": "query" + } + } + }, + "get": { + "description": "Gets one post and user info pair, by post_id and user_id.", + "response": { + "$ref": "PostUserInfo" + }, + "parameterOrder": [ + "userId", + "blogId", + "postId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/blogger", + "https://www.googleapis.com/auth/blogger.readonly" + ], + "parameters": { + "maxComments": { + "location": "query", + "format": "uint32", + "type": "integer" + }, + "userId": { + "type": "string", + "required": true, + "location": "path" + }, + "blogId": { + "type": "string", + "required": true, + "location": "path" + }, + "postId": { + "location": "path", + "type": "string", + "required": true + } + }, + "flatPath": "v3/users/{userId}/blogs/{blogId}/posts/{postId}", + "id": "blogger.postUserInfos.get", + "path": "v3/users/{userId}/blogs/{blogId}/posts/{postId}" + } + } + } }, - "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", - "labels": [ - "limited_availability" - ], - "protocol": "rest", - "baseUrl": "https://www.googleapis.com/blogger/v3/", - "basePath": "/blogger/v3/", - "rootUrl": "https://www.googleapis.com/", - "servicePath": "blogger/v3/", - "batchPath": "batch/blogger/v3", "parameters": { - "alt": { - "type": "string", - "description": "Data format for the response.", - "default": "json", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query" - }, - "fields": { - "type": "string", - "description": "Selector specifying which fields to include in a partial response.", - "location": "query" - }, - "key": { - "type": "string", - "description": "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.", - "location": "query" - }, - "oauth_token": { - "type": "string", - "description": "OAuth 2.0 token for the current user.", - "location": "query" - }, - "prettyPrint": { - "type": "boolean", - "description": "Returns response with indentations and line breaks.", - "default": "true", - "location": "query" - }, - "quotaUser": { - "type": "string", - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", - "location": "query" - }, - "userIp": { - "type": "string", - "description": "Deprecated. Please use quotaUser instead.", - "location": "query" - } - }, - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/blogger": { - "description": "Manage your Blogger account" - }, - "https://www.googleapis.com/auth/blogger.readonly": { - "description": "View your Blogger account" - } + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, + "key": { + "location": "query", + "description": "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.", + "type": "string" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "default": "true", + "type": "boolean" + }, + "quotaUser": { + "description": "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.", + "type": "string", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "$.xgafv": { + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format." + }, + "alt": { + "location": "query", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ] } - } }, + "version": "v3", + "baseUrl": "https://blogger.googleapis.com/", + "description": "The Blogger API provides access to posts, comments and pages of a\n Blogger blog.", + "servicePath": "", + "kind": "discovery#restDescription", + "basePath": "", + "id": "blogger:v3", + "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", + "revision": "20200422", + "discoveryVersion": "v1", "schemas": { - "Blog": { - "id": "Blog", - "type": "object", - "properties": { - "customMetaData": { - "type": "string", - "description": "The JSON custom meta-data for the Blog" - }, - "description": { - "type": "string", - "description": "The description of this blog. This is displayed underneath the title." - }, - "id": { - "type": "string", - "description": "The identifier for this resource." - }, - "kind": { - "type": "string", - "description": "The kind of this entry. Always blogger#blog", - "default": "blogger#blog" - }, - "locale": { + "Page": { + "id": "Page", "type": "object", - "description": "The locale this Blog is set to.", "properties": { - "country": { - "type": "string", - "description": "The country this blog's locale is set to." - }, - "language": { - "type": "string", - "description": "The language this blog is authored in." - }, - "variant": { - "type": "string", - "description": "The language variant this blog is authored in." - } + "content": { + "description": "The body content of this Page, in HTML.", + "type": "string" + }, + "selfLink": { + "type": "string", + "description": "The API REST URL to fetch this resource from." + }, + "updated": { + "description": "RFC 3339 date-time when this Page was last updated.", + "type": "string" + }, + "blog": { + "type": "object", + "properties": { + "id": { + "description": "The identifier of the blog containing this page.", + "type": "string" + } + }, + "description": "Data about the blog containing this Page." + }, + "published": { + "type": "string", + "description": "RFC 3339 date-time when this Page was published." + }, + "kind": { + "description": "The kind of this entity. Always blogger#page.", + "type": "string" + }, + "etag": { + "description": "Etag of the resource.", + "type": "string" + }, + "author": { + "description": "The author of this Page.", + "type": "object", + "properties": { + "image": { + "description": "The creator's avatar.", + "type": "object", + "properties": { + "url": { + "description": "The creator's avatar URL.", + "type": "string" + } + } + }, + "displayName": { + "description": "The display name.", + "type": "string" + }, + "url": { + "description": "The URL of the creator's Profile page.", + "type": "string" + }, + "id": { + "type": "string", + "description": "The identifier of the creator." + } + } + }, + "url": { + "type": "string", + "description": "The URL that this Page is displayed at." + }, + "status": { + "enum": [ + "LIVE", + "DRAFT" + ], + "description": "The status of the page for admin resources (either LIVE or DRAFT).", + "type": "string", + "enumDescriptions": [ + "", + "" + ] + }, + "id": { + "description": "The identifier for this resource.", + "type": "string" + }, + "title": { + "description": "The title of this entity. This is the name displayed in the Admin user\ninterface.", + "type": "string" + } } - }, - "name": { - "type": "string", - "description": "The name of this blog. This is displayed as the title." - }, - "pages": { + }, + "BlogPerUserInfo": { "type": "object", - "description": "The container of pages in this blog.", "properties": { - "selfLink": { - "type": "string", - "description": "The URL of the container for pages in this blog." - }, - "totalItems": { - "type": "integer", - "description": "The count of pages in this blog.", - "format": "int32" - } - } - }, - "posts": { + "photosAlbumKey": { + "description": "The Photo Album Key for the user when adding photos to the blog.", + "type": "string" + }, + "userId": { + "description": "ID of the User.", + "type": "string" + }, + "hasAdminAccess": { + "description": "True if the user has Admin level access to the blog.", + "type": "boolean" + }, + "role": { + "description": "Access permissions that the user has for the blog (ADMIN, AUTHOR, or\nREADER).", + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "" + ], + "enum": [ + "VIEW_TYPE_UNSPECIFIED", + "READER", + "AUTHOR", + "ADMIN" + ] + }, + "kind": { + "description": "The kind of this entity. Always blogger#blogPerUserInfo.", + "type": "string" + }, + "blogId": { + "description": "ID of the Blog resource.", + "type": "string" + } + }, + "id": "BlogPerUserInfo" + }, + "Blog": { "type": "object", - "description": "The container of posts in this blog.", "properties": { - "items": { - "type": "array", - "description": "The List of Posts for this Blog.", - "items": { - "$ref": "Post" + "url": { + "description": "The URL where this blog is published.", + "type": "string" + }, + "status": { + "description": "The status of the blog.", + "type": "string", + "enumDescriptions": [ + "", + "" + ], + "enum": [ + "LIVE", + "DELETED" + ] + }, + "name": { + "type": "string", + "description": "The name of this blog. This is displayed as the title." + }, + "id": { + "description": "The identifier for this resource.", + "type": "string" + }, + "customMetaData": { + "description": "The JSON custom meta-data for the Blog.", + "type": "string" + }, + "locale": { + "type": "object", + "properties": { + "country": { + "description": "The country this blog's locale is set to.", + "type": "string" + }, + "language": { + "description": "The language this blog is authored in.", + "type": "string" + }, + "variant": { + "description": "The language variant this blog is authored in.", + "type": "string" + } + }, + "description": "The locale this Blog is set to." + }, + "pages": { + "description": "The container of pages in this blog.", + "type": "object", + "properties": { + "selfLink": { + "type": "string", + "description": "The URL of the container for pages in this blog." + }, + "totalItems": { + "format": "int32", + "description": "The count of pages in this blog.", + "type": "integer" + } + } + }, + "selfLink": { + "type": "string", + "description": "The API REST URL to fetch this resource from." + }, + "updated": { + "description": "RFC 3339 date-time when this blog was last updated.", + "type": "string" + }, + "published": { + "description": "RFC 3339 date-time when this blog was published.", + "type": "string" + }, + "posts": { + "type": "object", + "properties": { + "items": { + "description": "The List of Posts for this Blog.", + "items": { + "$ref": "Post" + }, + "type": "array" + }, + "selfLink": { + "description": "The URL of the container for posts in this blog.", + "type": "string" + }, + "totalItems": { + "format": "int32", + "description": "The count of posts in this blog.", + "type": "integer" + } + }, + "description": "The container of posts in this blog." + }, + "description": { + "type": "string", + "description": "The description of this blog. This is displayed underneath the title." + }, + "kind": { + "description": "The kind of this entry. Always blogger#blog.", + "type": "string" } - }, - "selfLink": { - "type": "string", - "description": "The URL of the container for posts in this blog." - }, - "totalItems": { - "type": "integer", - "description": "The count of posts in this blog.", - "format": "int32" - } - } - }, - "published": { - "type": "string", - "description": "RFC 3339 date-time when this blog was published.", - "format": "date-time" - }, - "selfLink": { - "type": "string", - "description": "The API REST URL to fetch this resource from." - }, - "status": { - "type": "string", - "description": "The status of the blog." - }, - "updated": { - "type": "string", - "description": "RFC 3339 date-time when this blog was last updated.", - "format": "date-time" - }, - "url": { - "type": "string", - "description": "The URL where this blog is published." - } - } - }, - "BlogList": { - "id": "BlogList", - "type": "object", - "properties": { - "blogUserInfos": { - "type": "array", - "description": "Admin level list of blog per-user information", - "items": { - "$ref": "BlogUserInfo" - } - }, - "items": { - "type": "array", - "description": "The list of Blogs this user has Authorship or Admin rights over.", - "items": { - "$ref": "Blog" - } - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#blogList", - "default": "blogger#blogList" - } - } - }, - "BlogPerUserInfo": { - "id": "BlogPerUserInfo", - "type": "object", - "properties": { - "blogId": { - "type": "string", - "description": "ID of the Blog resource" - }, - "hasAdminAccess": { - "type": "boolean", - "description": "True if the user has Admin level access to the blog." - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#blogPerUserInfo", - "default": "blogger#blogPerUserInfo" - }, - "photosAlbumKey": { - "type": "string", - "description": "The Photo Album Key for the user when adding photos to the blog" - }, - "role": { - "type": "string", - "description": "Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER)." - }, - "userId": { - "type": "string", - "description": "ID of the User" - } - } - }, - "BlogUserInfo": { - "id": "BlogUserInfo", - "type": "object", - "properties": { - "blog": { - "$ref": "Blog", - "description": "The Blog resource." - }, - "blog_user_info": { - "$ref": "BlogPerUserInfo", - "description": "Information about a User for the Blog." - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#blogUserInfo", - "default": "blogger#blogUserInfo" - } - } - }, - "Comment": { - "id": "Comment", - "type": "object", - "properties": { - "author": { + }, + "id": "Blog" + }, + "Post": { + "id": "Post", "type": "object", - "description": "The author of this Comment.", "properties": { - "displayName": { - "type": "string", - "description": "The display name." - }, - "id": { - "type": "string", - "description": "The identifier of the Comment creator." - }, - "image": { - "type": "object", - "description": "The comment creator's avatar.", - "properties": { - "url": { + "id": { + "type": "string", + "description": "The identifier of this Post." + }, + "readerComments": { + "enum": [ + "ALLOW", + "DONT_ALLOW_SHOW_EXISTING", + "DONT_ALLOW_HIDE_EXISTING" + ], + "description": "Comment control and display setting for readers of this post.", + "type": "string", + "enumDescriptions": [ + "", + "", + "" + ] + }, + "location": { + "description": "The location for geotagged posts.", + "type": "object", + "properties": { + "name": { + "description": "Location name.", + "type": "string" + }, + "span": { + "description": "Location's viewport span. Can be used when rendering a map preview.", + "type": "string" + }, + "lat": { + "format": "double", + "description": "Location's latitude.", + "type": "number" + }, + "lng": { + "format": "double", + "description": "Location's longitude.", + "type": "number" + } + } + }, + "title": { + "type": "string", + "description": "The title of the Post." + }, + "customMetaData": { + "description": "The JSON meta-data for the Post.", + "type": "string" + }, + "labels": { + "description": "The list of labels this Post was tagged with.", + "items": { + "type": "string" + }, + "type": "array" + }, + "images": { + "description": "Display image for the Post.", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + } + }, + "type": "array" + }, + "content": { + "description": "The content of the Post. May contain HTML markup.", + "type": "string" + }, + "selfLink": { + "description": "The API REST URL to fetch this resource from.", + "type": "string" + }, + "updated": { + "description": "RFC 3339 date-time when this Post was last updated.", + "type": "string" + }, + "blog": { + "description": "Data about the blog containing this Post.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the Blog that contains this Post.", + "type": "string" + } + } + }, + "published": { + "type": "string", + "description": "RFC 3339 date-time when this Post was published." + }, + "kind": { "type": "string", - "description": "The comment creator's avatar URL." - } + "description": "The kind of this entity. Always blogger#post." + }, + "etag": { + "description": "Etag of the resource.", + "type": "string" + }, + "replies": { + "description": "The container of comments on this Post.", + "type": "object", + "properties": { + "totalItems": { + "format": "int64", + "description": "The count of comments on this post.", + "type": "string" + }, + "items": { + "description": "The List of Comments for this Post.", + "items": { + "$ref": "Comment" + }, + "type": "array" + }, + "selfLink": { + "description": "The URL of the comments on this post.", + "type": "string" + } + } + }, + "author": { + "type": "object", + "properties": { + "url": { + "description": "The URL of the creator's Profile page.", + "type": "string" + }, + "id": { + "description": "The identifier of the creator.", + "type": "string" + }, + "image": { + "description": "The creator's avatar.", + "type": "object", + "properties": { + "url": { + "description": "The creator's avatar URL.", + "type": "string" + } + } + }, + "displayName": { + "description": "The display name.", + "type": "string" + } + }, + "description": "The author of this Post." + }, + "url": { + "type": "string", + "description": "The URL where this Post is displayed." + }, + "titleLink": { + "type": "string", + "description": "The title link URL, similar to atom's related link." + }, + "status": { + "description": "Status of the post. Only set for admin-level requests.", + "type": "string", + "enumDescriptions": [ + "", + "", + "" + ], + "enum": [ + "LIVE", + "DRAFT", + "SCHEDULED" + ] } - }, - "url": { - "type": "string", - "description": "The URL of the Comment creator's Profile page." - } } - }, - "blog": { + }, + "CommentList": { + "id": "CommentList", "type": "object", - "description": "Data about the blog containing this comment.", "properties": { - "id": { - "type": "string", - "description": "The identifier of the blog containing this comment." - } + "kind": { + "description": "The kind of this entry. Always blogger#commentList.", + "type": "string" + }, + "items": { + "description": "The List of Comments for a Post.", + "items": { + "$ref": "Comment" + }, + "type": "array" + }, + "etag": { + "description": "Etag of the response.", + "type": "string" + }, + "prevPageToken": { + "type": "string", + "description": "Pagination token to fetch the previous page, if one exists." + }, + "nextPageToken": { + "description": "Pagination token to fetch the next page, if one exists.", + "type": "string" + } } - }, - "content": { - "type": "string", - "description": "The actual content of the comment. May include HTML markup." - }, - "id": { - "type": "string", - "description": "The identifier for this resource." - }, - "inReplyTo": { + }, + "PostUserInfo": { "type": "object", - "description": "Data about the comment this is in reply to.", "properties": { - "id": { - "type": "string", - "description": "The identified of the parent of this comment." - } - } - }, - "kind": { - "type": "string", - "description": "The kind of this entry. Always blogger#comment", - "default": "blogger#comment" - }, - "post": { + "kind": { + "description": "The kind of this entity. Always blogger#postUserInfo.", + "type": "string" + }, + "post": { + "$ref": "Post", + "description": "The Post resource." + }, + "post_user_info": { + "description": "Information about a User for the Post.", + "$ref": "PostPerUserInfo" + } + }, + "id": "PostUserInfo" + }, + "PostUserInfosList": { "type": "object", - "description": "Data about the post containing this comment.", "properties": { - "id": { - "type": "string", - "description": "The identifier of the post containing this comment." - } - } - }, - "published": { - "type": "string", - "description": "RFC 3339 date-time when this comment was published.", - "format": "date-time" - }, - "selfLink": { - "type": "string", - "description": "The API REST URL to fetch this resource from." - }, - "status": { - "type": "string", - "description": "The status of the comment (only populated for admin users)" - }, - "updated": { - "type": "string", - "description": "RFC 3339 date-time when this comment was last updated.", - "format": "date-time" - } - } - }, - "CommentList": { - "id": "CommentList", - "type": "object", - "properties": { - "etag": { - "type": "string", - "description": "Etag of the response." - }, - "items": { - "type": "array", - "description": "The List of Comments for a Post.", - "items": { - "$ref": "Comment" - } - }, - "kind": { - "type": "string", - "description": "The kind of this entry. Always blogger#commentList", - "default": "blogger#commentList" - }, - "nextPageToken": { - "type": "string", - "description": "Pagination token to fetch the next page, if one exists." - }, - "prevPageToken": { - "type": "string", - "description": "Pagination token to fetch the previous page, if one exists." - } - } - }, - "Page": { - "id": "Page", - "type": "object", - "properties": { - "author": { + "items": { + "description": "The list of Posts with User information for the post, for this Blog.", + "items": { + "$ref": "PostUserInfo" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token to fetch the next page, if one exists.", + "type": "string" + }, + "kind": { + "type": "string", + "description": "The kind of this entity. Always blogger#postList." + } + }, + "id": "PostUserInfosList" + }, + "PageList": { + "id": "PageList", "type": "object", - "description": "The author of this Page.", "properties": { - "displayName": { - "type": "string", - "description": "The display name." - }, - "id": { - "type": "string", - "description": "The identifier of the Page creator." - }, - "image": { - "type": "object", - "description": "The page author's avatar.", - "properties": { - "url": { - "type": "string", - "description": "The page author's avatar URL." - } + "nextPageToken": { + "description": "Pagination token to fetch the next page, if one exists.", + "type": "string" + }, + "kind": { + "description": "The kind of this entity. Always blogger#pageList.", + "type": "string" + }, + "items": { + "description": "The list of Pages for a Blog.", + "items": { + "$ref": "Page" + }, + "type": "array" + }, + "etag": { + "description": "Etag of the response.", + "type": "string" } - }, - "url": { - "type": "string", - "description": "The URL of the Page creator's Profile page." - } } - }, - "blog": { + }, + "BlogList": { "type": "object", - "description": "Data about the blog containing this Page.", "properties": { - "id": { - "type": "string", - "description": "The identifier of the blog containing this page." - } - } - }, - "content": { - "type": "string", - "description": "The body content of this Page, in HTML." - }, - "etag": { - "type": "string", - "description": "Etag of the resource." - }, - "id": { - "type": "string", - "description": "The identifier for this resource." - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#page", - "default": "blogger#page" - }, - "published": { - "type": "string", - "description": "RFC 3339 date-time when this Page was published.", - "format": "date-time" - }, - "selfLink": { - "type": "string", - "description": "The API REST URL to fetch this resource from." - }, - "status": { - "type": "string", - "description": "The status of the page for admin resources (either LIVE or DRAFT)." - }, - "title": { - "type": "string", - "description": "The title of this entity. This is the name displayed in the Admin user interface." - }, - "updated": { - "type": "string", - "description": "RFC 3339 date-time when this Page was last updated.", - "format": "date-time" - }, - "url": { - "type": "string", - "description": "The URL that this Page is displayed at." - } - } - }, - "PageList": { - "id": "PageList", - "type": "object", - "properties": { - "etag": { - "type": "string", - "description": "Etag of the response." - }, - "items": { - "type": "array", - "description": "The list of Pages for a Blog.", - "items": { - "$ref": "Page" - } - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#pageList", - "default": "blogger#pageList" - }, - "nextPageToken": { - "type": "string", - "description": "Pagination token to fetch the next page, if one exists." - } - } - }, - "Pageviews": { - "id": "Pageviews", - "type": "object", - "properties": { - "blogId": { - "type": "string", - "description": "Blog Id" - }, - "counts": { - "type": "array", - "description": "The container of posts in this blog.", - "items": { - "type": "object", - "properties": { - "count": { - "type": "string", - "description": "Count of page views for the given time range", - "format": "int64" - }, - "timeRange": { - "type": "string", - "description": "Time range the given count applies to" + "blogUserInfos": { + "description": "Admin level list of blog per-user information.", + "items": { + "$ref": "BlogUserInfo" + }, + "type": "array" + }, + "kind": { + "description": "The kind of this entity. Always blogger#blogList.", + "type": "string" + }, + "items": { + "items": { + "$ref": "Blog" + }, + "type": "array", + "description": "The list of Blogs this user has Authorship or Admin rights over." } - } - } - }, - "kind": { - "type": "string", - "description": "The kind of this entry. Always blogger#page_views", - "default": "blogger#page_views" - } - } - }, - "Post": { - "id": "Post", - "type": "object", - "properties": { - "author": { + }, + "id": "BlogList" + }, + "Pageviews": { "type": "object", - "description": "The author of this Post.", "properties": { - "displayName": { - "type": "string", - "description": "The display name." - }, - "id": { - "type": "string", - "description": "The identifier of the Post creator." - }, - "image": { - "type": "object", - "description": "The Post author's avatar.", - "properties": { - "url": { + "blogId": { + "description": "Blog Id.", + "type": "string" + }, + "kind": { "type": "string", - "description": "The Post author's avatar URL." - } + "description": "The kind of this entry. Always blogger#page_views." + }, + "counts": { + "description": "The container of posts in this blog.", + "items": { + "type": "object", + "properties": { + "count": { + "type": "string", + "format": "int64", + "description": "Count of page views for the given time range." + }, + "timeRange": { + "description": "Time range the given count applies to.", + "type": "string", + "enumDescriptions": [ + "", + "", + "" + ], + "enum": [ + "ALL_TIME", + "THIRTY_DAYS", + "SEVEN_DAYS" + ] + } + } + }, + "type": "array" } - }, - "url": { - "type": "string", - "description": "The URL of the Post creator's Profile page." - } - } - }, - "blog": { + }, + "id": "Pageviews" + }, + "User": { "type": "object", - "description": "Data about the blog containing this Post.", "properties": { - "id": { - "type": "string", - "description": "The identifier of the Blog that contains this Post." - } - } - }, - "content": { - "type": "string", - "description": "The content of the Post. May contain HTML markup." - }, - "customMetaData": { - "type": "string", - "description": "The JSON meta-data for the Post." - }, - "etag": { - "type": "string", - "description": "Etag of the resource." - }, - "id": { - "type": "string", - "description": "The identifier of this Post." - }, - "images": { - "type": "array", - "description": "Display image for the Post.", - "items": { - "type": "object", - "properties": { + "selfLink": { + "description": "The API REST URL to fetch this resource from.", + "type": "string" + }, + "id": { + "description": "The identifier for this User.", + "type": "string" + }, + "locale": { + "description": "This user's locale", + "type": "object", + "properties": { + "country": { + "description": "The country this blog's locale is set to.", + "type": "string" + }, + "language": { + "description": "The language this blog is authored in.", + "type": "string" + }, + "variant": { + "type": "string", + "description": "The language variant this blog is authored in." + } + } + }, + "about": { + "description": "Profile summary information.", + "type": "string" + }, + "displayName": { + "description": "The display name.", + "type": "string" + }, + "kind": { + "description": "The kind of this entity. Always blogger#user.", + "type": "string" + }, + "created": { + "type": "string", + "description": "The timestamp of when this profile was created, in seconds since epoch." + }, + "blogs": { + "description": "The container of blogs for this user.", + "type": "object", + "properties": { + "selfLink": { + "type": "string", + "description": "The URL of the Blogs for this user." + } + } + }, "url": { - "type": "string" + "description": "The user's profile page.", + "type": "string" } - } - } - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#post", - "default": "blogger#post" - }, - "labels": { - "type": "array", - "description": "The list of labels this Post was tagged with.", - "items": { - "type": "string" - } - }, - "location": { + }, + "id": "User" + }, + "PostList": { "type": "object", - "description": "The location for geotagged posts.", "properties": { - "lat": { - "type": "number", - "description": "Location's latitude.", - "format": "double" - }, - "lng": { - "type": "number", - "description": "Location's longitude.", - "format": "double" - }, - "name": { - "type": "string", - "description": "Location name." - }, - "span": { - "type": "string", - "description": "Location's viewport span. Can be used when rendering a map preview." - } - } - }, - "published": { - "type": "string", - "description": "RFC 3339 date-time when this Post was published.", - "format": "date-time" - }, - "readerComments": { - "type": "string", - "description": "Comment control and display setting for readers of this post." - }, - "replies": { + "items": { + "description": "The list of Posts for this Blog.", + "items": { + "$ref": "Post" + }, + "type": "array" + }, + "etag": { + "description": "Etag of the response.", + "type": "string" + }, + "prevPageToken": { + "type": "string", + "description": "Pagination token to fetch the previous page, if one exists." + }, + "nextPageToken": { + "description": "Pagination token to fetch the next page, if one exists.", + "type": "string" + }, + "kind": { + "description": "The kind of this entity. Always blogger#postList.", + "type": "string" + } + }, + "id": "PostList" + }, + "Comment": { "type": "object", - "description": "The container of comments on this Post.", "properties": { - "items": { - "type": "array", - "description": "The List of Comments for this Post.", - "items": { - "$ref": "Comment" + "content": { + "description": "The actual content of the comment. May include HTML markup.", + "type": "string" + }, + "selfLink": { + "description": "The API REST URL to fetch this resource from.", + "type": "string" + }, + "updated": { + "type": "string", + "description": "RFC 3339 date-time when this comment was last updated." + }, + "id": { + "type": "string", + "description": "The identifier for this resource." + }, + "post": { + "description": "Data about the post containing this comment.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the post containing this comment.", + "type": "string" + } + } + }, + "blog": { + "description": "Data about the blog containing this comment.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the blog containing this comment.", + "type": "string" + } + } + }, + "published": { + "description": "RFC 3339 date-time when this comment was published.", + "type": "string" + }, + "kind": { + "description": "The kind of this entry. Always blogger#comment.", + "type": "string" + }, + "author": { + "description": "The author of this Comment.", + "type": "object", + "properties": { + "url": { + "description": "The URL of the creator's Profile page.", + "type": "string" + }, + "id": { + "description": "The identifier of the creator.", + "type": "string" + }, + "image": { + "description": "The creator's avatar.", + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The creator's avatar URL." + } + } + }, + "displayName": { + "description": "The display name.", + "type": "string" + } + } + }, + "inReplyTo": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identified of the parent of this comment." + } + }, + "description": "Data about the comment this is in reply to." + }, + "status": { + "description": "The status of the comment (only populated for admin users).", + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "" + ], + "enum": [ + "LIVE", + "EMPTIED", + "PENDING", + "SPAM" + ] } - }, - "selfLink": { - "type": "string", - "description": "The URL of the comments on this post." - }, - "totalItems": { - "type": "string", - "description": "The count of comments on this post.", - "format": "int64" - } - } - }, - "selfLink": { - "type": "string", - "description": "The API REST URL to fetch this resource from." - }, - "status": { - "type": "string", - "description": "Status of the post. Only set for admin-level requests" - }, - "title": { - "type": "string", - "description": "The title of the Post." - }, - "titleLink": { - "type": "string", - "description": "The title link URL, similar to atom's related link." - }, - "updated": { - "type": "string", - "description": "RFC 3339 date-time when this Post was last updated.", - "format": "date-time" - }, - "url": { - "type": "string", - "description": "The URL where this Post is displayed." - } - } - }, - "PostList": { - "id": "PostList", - "type": "object", - "properties": { - "etag": { - "type": "string", - "description": "Etag of the response." - }, - "items": { - "type": "array", - "description": "The list of Posts for this Blog.", - "items": { - "$ref": "Post" - } - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#postList", - "default": "blogger#postList" - }, - "nextPageToken": { - "type": "string", - "description": "Pagination token to fetch the next page, if one exists." - } - } - }, - "PostPerUserInfo": { - "id": "PostPerUserInfo", - "type": "object", - "properties": { - "blogId": { - "type": "string", - "description": "ID of the Blog that the post resource belongs to." - }, - "hasEditAccess": { - "type": "boolean", - "description": "True if the user has Author level access to the post." - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#postPerUserInfo", - "default": "blogger#postPerUserInfo" - }, - "postId": { - "type": "string", - "description": "ID of the Post resource." - }, - "userId": { - "type": "string", - "description": "ID of the User." - } - } - }, - "PostUserInfo": { - "id": "PostUserInfo", - "type": "object", - "properties": { - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#postUserInfo", - "default": "blogger#postUserInfo" - }, - "post": { - "$ref": "Post", - "description": "The Post resource." - }, - "post_user_info": { - "$ref": "PostPerUserInfo", - "description": "Information about a User for the Post." - } - } - }, - "PostUserInfosList": { - "id": "PostUserInfosList", - "type": "object", - "properties": { - "items": { - "type": "array", - "description": "The list of Posts with User information for the post, for this Blog.", - "items": { - "$ref": "PostUserInfo" - } - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#postList", - "default": "blogger#postUserInfosList" - }, - "nextPageToken": { - "type": "string", - "description": "Pagination token to fetch the next page, if one exists." - } - } - }, - "User": { - "id": "User", - "type": "object", - "properties": { - "about": { - "type": "string", - "description": "Profile summary information." - }, - "blogs": { + }, + "id": "Comment" + }, + "PostPerUserInfo": { "type": "object", - "description": "The container of blogs for this user.", "properties": { - "selfLink": { - "type": "string", - "description": "The URL of the Blogs for this user." - } - } - }, - "created": { - "type": "string", - "description": "The timestamp of when this profile was created, in seconds since epoch.", - "format": "date-time" - }, - "displayName": { - "type": "string", - "description": "The display name." - }, - "id": { - "type": "string", - "description": "The identifier for this User." - }, - "kind": { - "type": "string", - "description": "The kind of this entity. Always blogger#user", - "default": "blogger#user" - }, - "locale": { + "postId": { + "description": "ID of the Post resource.", + "type": "string" + }, + "userId": { + "description": "ID of the User.", + "type": "string" + }, + "blogId": { + "description": "ID of the Blog that the post resource belongs to.", + "type": "string" + }, + "kind": { + "type": "string", + "description": "The kind of this entity. Always blogger#postPerUserInfo." + }, + "hasEditAccess": { + "description": "True if the user has Author level access to the post.", + "type": "boolean" + } + }, + "id": "PostPerUserInfo" + }, + "BlogUserInfo": { + "id": "BlogUserInfo", "type": "object", - "description": "This user's locale", "properties": { - "country": { - "type": "string", - "description": "The user's country setting." - }, - "language": { - "type": "string", - "description": "The user's language setting." - }, - "variant": { - "type": "string", - "description": "The user's language variant setting." - } + "kind": { + "description": "The kind of this entity. Always blogger#blogUserInfo.", + "type": "string" + }, + "blog_user_info": { + "description": "Information about a User for the Blog.", + "$ref": "BlogPerUserInfo" + }, + "blog": { + "description": "The Blog resource.", + "$ref": "Blog" + } } - }, - "selfLink": { - "type": "string", - "description": "The API REST URL to fetch this resource from." - }, - "url": { - "type": "string", - "description": "The user's profile page." - } } - } }, - "resources": { - "blogUserInfos": { - "methods": { - "get": { - "id": "blogger.blogUserInfos.get", - "path": "users/{userId}/blogs/{blogId}", - "httpMethod": "GET", - "description": "Gets one blog and user info pair by blogId and userId.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the blog to get.", - "required": true, - "location": "path" - }, - "maxPosts": { - "type": "integer", - "description": "Maximum number of posts to pull back with the blog.", - "format": "uint32", - "location": "query" - }, - "userId": { - "type": "string", - "description": "ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "userId", - "blogId" - ], - "response": { - "$ref": "BlogUserInfo" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - } - } - }, - "blogs": { - "methods": { - "get": { - "id": "blogger.blogs.get", - "path": "blogs/{blogId}", - "httpMethod": "GET", - "description": "Gets one blog by ID.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the blog to get.", - "required": true, - "location": "path" - }, - "maxPosts": { - "type": "integer", - "description": "Maximum number of posts to pull back with the blog.", - "format": "uint32", - "location": "query" - }, - "view": { - "type": "string", - "description": "Access level with which to view the blog. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail.", - "Author level detail.", - "Reader level detail." - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId" - ], - "response": { - "$ref": "Blog" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "getByUrl": { - "id": "blogger.blogs.getByUrl", - "path": "blogs/byurl", - "httpMethod": "GET", - "description": "Retrieve a Blog by URL.", - "parameters": { - "url": { - "type": "string", - "description": "The URL of the blog to retrieve.", - "required": true, - "location": "query" - }, - "view": { - "type": "string", - "description": "Access level with which to view the blog. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail.", - "Author level detail.", - "Reader level detail." - ], - "location": "query" - } - }, - "parameterOrder": [ - "url" - ], - "response": { - "$ref": "Blog" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "listByUser": { - "id": "blogger.blogs.listByUser", - "path": "users/{userId}/blogs", - "httpMethod": "GET", - "description": "Retrieves a list of blogs, possibly filtered.", - "parameters": { - "fetchUserInfo": { - "type": "boolean", - "description": "Whether the response is a list of blogs with per-user information instead of just blogs.", - "location": "query" - }, - "role": { - "type": "string", - "description": "User access types for blogs to include in the results, e.g. AUTHOR will return blogs where the user has author level access. If no roles are specified, defaults to ADMIN and AUTHOR roles.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin role - Blogs where the user has Admin level access.", - "Author role - Blogs where the user has Author level access.", - "Reader role - Blogs where the user has Reader level access (to a private blog)." - ], - "repeated": true, - "location": "query" - }, - "status": { - "type": "string", - "description": "Blog statuses to include in the result (default: Live blogs only). Note that ADMIN access is required to view deleted blogs.", - "default": "LIVE", - "enum": [ - "DELETED", - "LIVE" - ], - "enumDescriptions": [ - "Blog has been deleted by an administrator.", - "Blog is currently live." - ], - "repeated": true, - "location": "query" - }, - "userId": { - "type": "string", - "description": "ID of the user whose blogs are to be fetched. Either the word 'self' or the user's profile identifier.", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "description": "Access level with which to view the blogs. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail.", - "Author level detail.", - "Reader level detail." - ], - "location": "query" - } - }, - "parameterOrder": [ - "userId" - ], - "response": { - "$ref": "BlogList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - } - } - }, - "comments": { - "methods": { - "approve": { - "id": "blogger.comments.approve", - "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/approve", - "httpMethod": "POST", - "description": "Marks a comment as not spam.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "commentId": { - "type": "string", - "description": "The ID of the comment to mark as not spam.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "postId", - "commentId" - ], - "response": { - "$ref": "Comment" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "delete": { - "id": "blogger.comments.delete", - "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}", - "httpMethod": "DELETE", - "description": "Delete a comment by ID.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "commentId": { - "type": "string", - "description": "The ID of the comment to delete.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "postId", - "commentId" - ], - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "get": { - "id": "blogger.comments.get", - "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}", - "httpMethod": "GET", - "description": "Gets one comment by ID.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to containing the comment.", - "required": true, - "location": "path" - }, - "commentId": { - "type": "string", - "description": "The ID of the comment to get.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "ID of the post to fetch posts from.", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "description": "Access level for the requested comment (default: READER). Note that some comments will require elevated permissions, for example comments where the parent posts which is in a draft state, or comments that are pending moderation.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Admin level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "postId", - "commentId" - ], - "response": { - "$ref": "Comment" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "list": { - "id": "blogger.comments.list", - "path": "blogs/{blogId}/posts/{postId}/comments", - "httpMethod": "GET", - "description": "Retrieves the comments for a post, possibly filtered.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch comments from.", - "required": true, - "location": "path" - }, - "endDate": { - "type": "string", - "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "fetchBodies": { - "type": "boolean", - "description": "Whether the body content of the comments is included.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of comments to include in the result.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "Continuation token if request is paged.", - "location": "query" - }, - "postId": { - "type": "string", - "description": "ID of the post to fetch posts from.", - "required": true, - "location": "path" - }, - "startDate": { - "type": "string", - "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "status": { - "type": "string", - "enum": [ - "emptied", - "live", - "pending", - "spam" - ], - "enumDescriptions": [ - "Comments that have had their content removed", - "Comments that are publicly visible", - "Comments that are awaiting administrator approval", - "Comments marked as spam by the administrator" - ], - "repeated": true, - "location": "query" - }, - "view": { - "type": "string", - "description": "Access level with which to view the returned result. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Reader level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "postId" - ], - "response": { - "$ref": "CommentList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "listByBlog": { - "id": "blogger.comments.listByBlog", - "path": "blogs/{blogId}/comments", - "httpMethod": "GET", - "description": "Retrieves the comments for a blog, across all posts, possibly filtered.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch comments from.", - "required": true, - "location": "path" - }, - "endDate": { - "type": "string", - "description": "Latest date of comment to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "fetchBodies": { - "type": "boolean", - "description": "Whether the body content of the comments is included.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of comments to include in the result.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "Continuation token if request is paged.", - "location": "query" - }, - "startDate": { - "type": "string", - "description": "Earliest date of comment to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "status": { - "type": "string", - "enum": [ - "emptied", - "live", - "pending", - "spam" - ], - "enumDescriptions": [ - "Comments that have had their content removed", - "Comments that are publicly visible", - "Comments that are awaiting administrator approval", - "Comments marked as spam by the administrator" - ], - "repeated": true, - "location": "query" - } - }, - "parameterOrder": [ - "blogId" - ], - "response": { - "$ref": "CommentList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "markAsSpam": { - "id": "blogger.comments.markAsSpam", - "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/spam", - "httpMethod": "POST", - "description": "Marks a comment as spam.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "commentId": { - "type": "string", - "description": "The ID of the comment to mark as spam.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "postId", - "commentId" - ], - "response": { - "$ref": "Comment" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "removeContent": { - "id": "blogger.comments.removeContent", - "path": "blogs/{blogId}/posts/{postId}/comments/{commentId}/removecontent", - "httpMethod": "POST", - "description": "Removes the content of a comment.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "commentId": { - "type": "string", - "description": "The ID of the comment to delete content from.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "postId", - "commentId" - ], - "response": { - "$ref": "Comment" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "pageViews": { - "methods": { - "get": { - "id": "blogger.pageViews.get", - "path": "blogs/{blogId}/pageviews", - "httpMethod": "GET", - "description": "Retrieve pageview stats for a Blog.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the blog to get.", - "required": true, - "location": "path" - }, - "range": { - "type": "string", - "enum": [ - "30DAYS", - "7DAYS", - "all" - ], - "enumDescriptions": [ - "Page view counts from the last thirty days.", - "Page view counts from the last seven days.", - "Total page view counts from all time." - ], - "repeated": true, - "location": "query" - } - }, - "parameterOrder": [ - "blogId" - ], - "response": { - "$ref": "Pageviews" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "pages": { - "methods": { - "delete": { - "id": "blogger.pages.delete", - "path": "blogs/{blogId}/pages/{pageId}", - "httpMethod": "DELETE", - "description": "Delete a page by ID.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "pageId": { - "type": "string", - "description": "The ID of the Page.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "pageId" - ], - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "get": { - "id": "blogger.pages.get", - "path": "blogs/{blogId}/pages/{pageId}", - "httpMethod": "GET", - "description": "Gets one blog page by ID.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog containing the page.", - "required": true, - "location": "path" - }, - "pageId": { - "type": "string", - "description": "The ID of the page to get.", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Reader level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "pageId" - ], - "response": { - "$ref": "Page" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "insert": { - "id": "blogger.pages.insert", - "path": "blogs/{blogId}/pages", - "httpMethod": "POST", - "description": "Add a page.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to add the page to.", - "required": true, - "location": "path" - }, - "isDraft": { - "type": "boolean", - "description": "Whether to create the page as a draft (default: false).", - "location": "query" - } - }, - "parameterOrder": [ - "blogId" - ], - "request": { - "$ref": "Page" - }, - "response": { - "$ref": "Page" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "list": { - "id": "blogger.pages.list", - "path": "blogs/{blogId}/pages", - "httpMethod": "GET", - "description": "Retrieves the pages for a blog, optionally including non-LIVE statuses.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch Pages from.", - "required": true, - "location": "path" - }, - "fetchBodies": { - "type": "boolean", - "description": "Whether to retrieve the Page bodies.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of Pages to fetch.", - "format": "uint32", - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "Continuation token if the request is paged.", - "location": "query" - }, - "status": { - "type": "string", - "enum": [ - "draft", - "live" - ], - "enumDescriptions": [ - "Draft (unpublished) Pages", - "Pages that are publicly visible" - ], - "repeated": true, - "location": "query" - }, - "view": { - "type": "string", - "description": "Access level with which to view the returned result. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Reader level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId" - ], - "response": { - "$ref": "PageList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "patch": { - "id": "blogger.pages.patch", - "path": "blogs/{blogId}/pages/{pageId}", - "httpMethod": "PATCH", - "description": "Update a page. This method supports patch semantics.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "pageId": { - "type": "string", - "description": "The ID of the Page.", - "required": true, - "location": "path" - }, - "publish": { - "type": "boolean", - "description": "Whether a publish action should be performed when the page is updated (default: false).", - "location": "query" - }, - "revert": { - "type": "boolean", - "description": "Whether a revert action should be performed when the page is updated (default: false).", - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "pageId" - ], - "request": { - "$ref": "Page" - }, - "response": { - "$ref": "Page" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "publish": { - "id": "blogger.pages.publish", - "path": "blogs/{blogId}/pages/{pageId}/publish", - "httpMethod": "POST", - "description": "Publishes a draft page.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the blog.", - "required": true, - "location": "path" - }, - "pageId": { - "type": "string", - "description": "The ID of the page.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "pageId" - ], - "response": { - "$ref": "Page" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "revert": { - "id": "blogger.pages.revert", - "path": "blogs/{blogId}/pages/{pageId}/revert", - "httpMethod": "POST", - "description": "Revert a published or scheduled page to draft state.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the blog.", - "required": true, - "location": "path" - }, - "pageId": { - "type": "string", - "description": "The ID of the page.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "pageId" - ], - "response": { - "$ref": "Page" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "update": { - "id": "blogger.pages.update", - "path": "blogs/{blogId}/pages/{pageId}", - "httpMethod": "PUT", - "description": "Update a page.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "pageId": { - "type": "string", - "description": "The ID of the Page.", - "required": true, - "location": "path" - }, - "publish": { - "type": "boolean", - "description": "Whether a publish action should be performed when the page is updated (default: false).", - "location": "query" - }, - "revert": { - "type": "boolean", - "description": "Whether a revert action should be performed when the page is updated (default: false).", - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "pageId" - ], - "request": { - "$ref": "Page" - }, - "response": { - "$ref": "Page" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "postUserInfos": { - "methods": { - "get": { - "id": "blogger.postUserInfos.get", - "path": "users/{userId}/blogs/{blogId}/posts/{postId}", - "httpMethod": "GET", - "description": "Gets one post and user info pair, by post ID and user ID. The post user info contains per-user information about the post, such as access rights, specific to the user.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the blog.", - "required": true, - "location": "path" - }, - "maxComments": { - "type": "integer", - "description": "Maximum number of comments to pull back on a post.", - "format": "uint32", - "location": "query" - }, - "postId": { - "type": "string", - "description": "The ID of the post to get.", - "required": true, - "location": "path" - }, - "userId": { - "type": "string", - "description": "ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "userId", - "blogId", - "postId" - ], - "response": { - "$ref": "PostUserInfo" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "list": { - "id": "blogger.postUserInfos.list", - "path": "users/{userId}/blogs/{blogId}/posts", - "httpMethod": "GET", - "description": "Retrieves a list of post and post user info pairs, possibly filtered. The post user info contains per-user information about the post, such as access rights, specific to the user.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch posts from.", - "required": true, - "location": "path" - }, - "endDate": { - "type": "string", - "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "fetchBodies": { - "type": "boolean", - "description": "Whether the body content of posts is included. Default is false.", - "default": "false", - "location": "query" - }, - "labels": { - "type": "string", - "description": "Comma-separated list of labels to search for.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of posts to fetch.", - "format": "uint32", - "location": "query" - }, - "orderBy": { - "type": "string", - "description": "Sort order applied to search results. Default is published.", - "default": "PUBLISHED", - "enum": [ - "published", - "updated" - ], - "enumDescriptions": [ - "Order by the date the post was published", - "Order by the date the post was last updated" - ], - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "Continuation token if the request is paged.", - "location": "query" - }, - "startDate": { - "type": "string", - "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "status": { - "type": "string", - "enum": [ - "draft", - "live", - "scheduled" - ], - "enumDescriptions": [ - "Draft posts", - "Published posts", - "Posts that are scheduled to publish in future." - ], - "repeated": true, - "location": "query" - }, - "userId": { - "type": "string", - "description": "ID of the user for the per-user information to be fetched. Either the word 'self' or the user's profile identifier.", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "description": "Access level with which to view the returned result. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Reader level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "userId", - "blogId" - ], - "response": { - "$ref": "PostUserInfosList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - } - } - }, - "posts": { - "methods": { - "delete": { - "id": "blogger.posts.delete", - "path": "blogs/{blogId}/posts/{postId}", - "httpMethod": "DELETE", - "description": "Delete a post by ID.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "postId" - ], - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "get": { - "id": "blogger.posts.get", - "path": "blogs/{blogId}/posts/{postId}", - "httpMethod": "GET", - "description": "Get a post by ID.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch the post from.", - "required": true, - "location": "path" - }, - "fetchBody": { - "type": "boolean", - "description": "Whether the body content of the post is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.", - "default": "true", - "location": "query" - }, - "fetchImages": { - "type": "boolean", - "description": "Whether image URL metadata for each post is included (default: false).", - "location": "query" - }, - "maxComments": { - "type": "integer", - "description": "Maximum number of comments to pull back on a post.", - "format": "uint32", - "location": "query" - }, - "postId": { - "type": "string", - "description": "The ID of the post", - "required": true, - "location": "path" - }, - "view": { - "type": "string", - "description": "Access level with which to view the returned result. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Reader level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "postId" - ], - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "getByPath": { - "id": "blogger.posts.getByPath", - "path": "blogs/{blogId}/posts/bypath", - "httpMethod": "GET", - "description": "Retrieve a Post by Path.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch the post from.", - "required": true, - "location": "path" - }, - "maxComments": { - "type": "integer", - "description": "Maximum number of comments to pull back on a post.", - "format": "uint32", - "location": "query" - }, - "path": { - "type": "string", - "description": "Path of the Post to retrieve.", - "required": true, - "location": "query" - }, - "view": { - "type": "string", - "description": "Access level with which to view the returned result. Note that some fields require elevated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Reader level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "path" - ], - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "insert": { - "id": "blogger.posts.insert", - "path": "blogs/{blogId}/posts", - "httpMethod": "POST", - "description": "Add a post.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to add the post to.", - "required": true, - "location": "path" - }, - "fetchBody": { - "type": "boolean", - "description": "Whether the body content of the post is included with the result (default: true).", - "default": "true", - "location": "query" - }, - "fetchImages": { - "type": "boolean", - "description": "Whether image URL metadata for each post is included in the returned result (default: false).", - "location": "query" - }, - "isDraft": { - "type": "boolean", - "description": "Whether to create the post as a draft (default: false).", - "location": "query" - } - }, - "parameterOrder": [ - "blogId" - ], - "request": { - "$ref": "Post" - }, - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "list": { - "id": "blogger.posts.list", - "path": "blogs/{blogId}/posts", - "httpMethod": "GET", - "description": "Retrieves a list of posts, possibly filtered.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch posts from.", - "required": true, - "location": "path" - }, - "endDate": { - "type": "string", - "description": "Latest post date to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "fetchBodies": { - "type": "boolean", - "description": "Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.", - "default": "true", - "location": "query" - }, - "fetchImages": { - "type": "boolean", - "description": "Whether image URL metadata for each post is included.", - "location": "query" - }, - "labels": { - "type": "string", - "description": "Comma-separated list of labels to search for.", - "location": "query" - }, - "maxResults": { - "type": "integer", - "description": "Maximum number of posts to fetch.", - "format": "uint32", - "location": "query" - }, - "orderBy": { - "type": "string", - "description": "Sort search results", - "default": "PUBLISHED", - "enum": [ - "published", - "updated" - ], - "enumDescriptions": [ - "Order by the date the post was published", - "Order by the date the post was last updated" - ], - "location": "query" - }, - "pageToken": { - "type": "string", - "description": "Continuation token if the request is paged.", - "location": "query" - }, - "startDate": { - "type": "string", - "description": "Earliest post date to fetch, a date-time with RFC 3339 formatting.", - "format": "date-time", - "location": "query" - }, - "status": { - "type": "string", - "description": "Statuses to include in the results.", - "enum": [ - "draft", - "live", - "scheduled" - ], - "enumDescriptions": [ - "Draft (non-published) posts.", - "Published posts", - "Posts that are scheduled to publish in the future." - ], - "repeated": true, - "location": "query" - }, - "view": { - "type": "string", - "description": "Access level with which to view the returned result. Note that some fields require escalated access.", - "enum": [ - "ADMIN", - "AUTHOR", - "READER" - ], - "enumDescriptions": [ - "Admin level detail", - "Author level detail", - "Reader level detail" - ], - "location": "query" - } - }, - "parameterOrder": [ - "blogId" - ], - "response": { - "$ref": "PostList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "patch": { - "id": "blogger.posts.patch", - "path": "blogs/{blogId}/posts/{postId}", - "httpMethod": "PATCH", - "description": "Update a post. This method supports patch semantics.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "fetchBody": { - "type": "boolean", - "description": "Whether the body content of the post is included with the result (default: true).", - "default": "true", - "location": "query" - }, - "fetchImages": { - "type": "boolean", - "description": "Whether image URL metadata for each post is included in the returned result (default: false).", - "location": "query" - }, - "maxComments": { - "type": "integer", - "description": "Maximum number of comments to retrieve with the returned post.", - "format": "uint32", - "location": "query" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - }, - "publish": { - "type": "boolean", - "description": "Whether a publish action should be performed when the post is updated (default: false).", - "location": "query" - }, - "revert": { - "type": "boolean", - "description": "Whether a revert action should be performed when the post is updated (default: false).", - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "postId" - ], - "request": { - "$ref": "Post" - }, - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "publish": { - "id": "blogger.posts.publish", - "path": "blogs/{blogId}/posts/{postId}/publish", - "httpMethod": "POST", - "description": "Publishes a draft post, optionally at the specific time of the given publishDate parameter.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - }, - "publishDate": { - "type": "string", - "description": "Optional date and time to schedule the publishing of the Blog. If no publishDate parameter is given, the post is either published at the a previously saved schedule date (if present), or the current time. If a future date is given, the post will be scheduled to be published.", - "format": "date-time", - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "postId" - ], - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "revert": { - "id": "blogger.posts.revert", - "path": "blogs/{blogId}/posts/{postId}/revert", - "httpMethod": "POST", - "description": "Revert a published or scheduled post to draft state.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "blogId", - "postId" - ], - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - }, - "search": { - "id": "blogger.posts.search", - "path": "blogs/{blogId}/posts/search", - "httpMethod": "GET", - "description": "Search for a post.", - "parameters": { - "blogId": { - "type": "string", - "description": "ID of the blog to fetch the post from.", - "required": true, - "location": "path" - }, - "fetchBodies": { - "type": "boolean", - "description": "Whether the body content of posts is included (default: true). This should be set to false when the post bodies are not required, to help minimize traffic.", - "default": "true", - "location": "query" - }, - "orderBy": { - "type": "string", - "description": "Sort search results", - "default": "PUBLISHED", - "enum": [ - "published", - "updated" - ], - "enumDescriptions": [ - "Order by the date the post was published", - "Order by the date the post was last updated" - ], - "location": "query" - }, - "q": { - "type": "string", - "description": "Query terms to search this blog for matching posts.", - "required": true, - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "q" - ], - "response": { - "$ref": "PostList" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - }, - "update": { - "id": "blogger.posts.update", - "path": "blogs/{blogId}/posts/{postId}", - "httpMethod": "PUT", - "description": "Update a post.", - "parameters": { - "blogId": { - "type": "string", - "description": "The ID of the Blog.", - "required": true, - "location": "path" - }, - "fetchBody": { - "type": "boolean", - "description": "Whether the body content of the post is included with the result (default: true).", - "default": "true", - "location": "query" - }, - "fetchImages": { - "type": "boolean", - "description": "Whether image URL metadata for each post is included in the returned result (default: false).", - "location": "query" - }, - "maxComments": { - "type": "integer", - "description": "Maximum number of comments to retrieve with the returned post.", - "format": "uint32", - "location": "query" - }, - "postId": { - "type": "string", - "description": "The ID of the Post.", - "required": true, - "location": "path" - }, - "publish": { - "type": "boolean", - "description": "Whether a publish action should be performed when the post is updated (default: false).", - "location": "query" - }, - "revert": { - "type": "boolean", - "description": "Whether a revert action should be performed when the post is updated (default: false).", - "location": "query" - } - }, - "parameterOrder": [ - "blogId", - "postId" - ], - "request": { - "$ref": "Post" - }, - "response": { - "$ref": "Post" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger" - ] - } - } - }, - "users": { - "methods": { - "get": { - "id": "blogger.users.get", - "path": "users/{userId}", - "httpMethod": "GET", - "description": "Gets one user by ID.", - "parameters": { - "userId": { - "type": "string", - "description": "The ID of the user to get.", - "required": true, - "location": "path" - } - }, - "parameterOrder": [ - "userId" - ], - "response": { - "$ref": "User" - }, - "scopes": [ - "https://www.googleapis.com/auth/blogger", - "https://www.googleapis.com/auth/blogger.readonly" - ] - } + "protocol": "rest", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "canonicalName": "Blogger", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/blogger.readonly": { + "description": "View your Blogger account" + }, + "https://www.googleapis.com/auth/blogger": { + "description": "Manage your Blogger account" + } + } } - } - } - } \ No newline at end of file + }, + "rootUrl": "https://blogger.googleapis.com/", + "ownerDomain": "google.com", + "name": "blogger", + "batchPath": "batch", + "mtlsRootUrl": "https://blogger.mtls.googleapis.com/", + "fullyEncodeReservedExpansion": true, + "title": "Blogger API v3" +} diff --git a/test/test.apikey.ts b/test/test.apikey.ts index 932e1b824f7..a867f1abf2a 100644 --- a/test/test.apikey.ts +++ b/test/test.apikey.ts @@ -50,8 +50,8 @@ async function testKeyParam(drive: APIEndpoint) { } async function testAuthKey(blogger: APIEndpoint) { - const req = nock(Utils.baseUrl) - .get('/blogger/v3/blogs/abc123/pages?key=YOUR%20API%20KEY') + const req = nock('https://blogger.googleapis.com') + .get('/v3/blogs/abc123/pages?key=YOUR%20API%20KEY') .reply(200); const res = await blogger.pages.list({ auth: 'YOUR API KEY', diff --git a/test/test.auth.ts b/test/test.auth.ts index 2a24601b3d6..31d817c76ef 100644 --- a/test/test.auth.ts +++ b/test/test.auth.ts @@ -161,13 +161,13 @@ describe('OAuth2 client', () => { REDIRECT_URI ); oauth2client.credentials = {access_token: 'foo', refresh_token: ''}; - const scope = nock(Utils.baseUrl) - .get('/blogger/v3/blogs/abc123/pages') + const scope = nock('https://blogger.googleapis.com') + .get('/v3/blogs/abc123/pages') .times(2) .reply(200); - await testNoBearer(localBlogger, oauth2client); await testNoBearer(remoteBlogger, oauth2client); + scope.done(); }); it('should refresh if access token is expired', async () => { diff --git a/test/test.transporters.ts b/test/test.transporters.ts index ff4d9e227c1..6fde28b6305 100644 --- a/test/test.transporters.ts +++ b/test/test.transporters.ts @@ -122,34 +122,44 @@ async function testBodyDelete(drive: APIEndpoint) { assert.strictEqual(res.config.body, undefined); } -function testResponseError(drive: APIEndpoint, cb: (err?: Error) => void) { - drive.files.list({q: 'hello'}, (err: NodeJS.ErrnoException) => { - assert(err instanceof Error); - assert.strictEqual(err.message, 'Error!'); - assert.strictEqual(err.code, 400); - cb(); - }); +async function testResponseError(drive: APIEndpoint) { + await assert.rejects( + drive.files.list({q: 'hello'}), + (err: NodeJS.ErrnoException) => { + assert(err instanceof Error); + assert.strictEqual(err.message, 'Error!'); + assert.strictEqual(err.code, 400); + return true; + } + ); } -function testNotObjectError(oauth2: APIEndpoint, cb: (err?: Error) => void) { - oauth2.tokeninfo({access_token: 'hello'}, (err: NodeJS.ErrnoException) => { - assert(err instanceof Error); - assert.strictEqual(err.message, 'invalid_grant'); - assert.strictEqual(err.code, '400'); - cb(); - }); +async function testNotObjectError(oauth2: APIEndpoint) { + await assert.rejects( + oauth2.tokeninfo({access_token: 'hello'}), + (err: NodeJS.ErrnoException) => { + assert(err instanceof Error); + assert.strictEqual(err.message, 'invalid_grant'); + assert.strictEqual(err.code, '400'); + return true; + } + ); } -function testBackendError(blogger: APIEndpoint, cb: (err?: Error) => void) { +async function testBackendError(blogger: APIEndpoint) { const obj = {longUrl: 'http://google.com/'}; - blogger.posts.publish( - {resource: obj, blogId: 'abc123', postId: 'abc123'}, - (err: NodeJS.ErrnoException, result: {}) => { + await assert.rejects( + blogger.posts.publish({ + resource: obj, + blogId: 'abc123', + postId: 'abc123', + }), + (err: NodeJS.ErrnoException) => { assert(err instanceof Error); + console.log(err); assert.strictEqual(Number(err.code), 500); assert.strictEqual(err.message, 'There was an error!'); - assert.strictEqual(result, undefined); - cb(); + return true; } ); } @@ -207,23 +217,19 @@ describe('Transporters', () => { await testBodyDelete(remoteDrive); }); - it('should return errors within response body as instances of Error', done => { + it('should return errors within response body as instances of Error', async () => { const scope = nock(Utils.baseUrl) .get('/drive/v2/files?q=hello') .times(2) // Simulate an error returned via response body from // Google's API endpoint .reply(400, {error: {code: 400, message: 'Error!'}}); - - testResponseError(localDrive, () => { - testResponseError(remoteDrive, () => { - scope.done(); - done(); - }); - }); + await testResponseError(localDrive); + await testResponseError(remoteDrive); + scope.done(); }); - it('should return error message correctly when error is not an object', done => { + it('should return error message correctly when error is not an object', async () => { const scope = nock(Utils.baseUrl) .post('/oauth2/v2/tokeninfo?access_token=hello') .times(2) @@ -233,27 +239,19 @@ describe('Transporters', () => { error: 'invalid_grant', error_description: 'Code was already redeemed.', }); - - testNotObjectError(localOauth2, () => { - testNotObjectError(remoteOauth2, () => { - scope.done(); - done(); - }); - }); + await testNotObjectError(localOauth2); + await testNotObjectError(remoteOauth2); + scope.done(); }); - it('should return 5xx responses as errors', done => { - const scope = nock(Utils.baseUrl) - .post('/blogger/v3/blogs/abc123/posts/abc123/publish') + it('should return 5xx responses as errors', async () => { + const scope = nock('https://blogger.googleapis.com') + .post('/v3/blogs/abc123/posts/abc123/publish') .times(2) .reply(500, 'There was an error!'); - - testBackendError(localBlogger, () => { - testBackendError(remoteBlogger, () => { - scope.done(); - done(); - }); - }); + await testBackendError(localBlogger); + await testBackendError(remoteBlogger); + scope.done(); }); it('should return 304 responses as success', async () => { @@ -262,27 +260,24 @@ describe('Transporters', () => { .reply(304); const res = await localDrive.files.list(); assert.strictEqual(res.status, 304); + scope.done(); }); - it('should handle 5xx responses that include errors', done => { - const scope = nock(Utils.baseUrl) - .post('/blogger/v3/blogs/abc123/posts/abc123/publish') + it('should handle 5xx responses that include errors', async () => { + const scope = nock('https://blogger.googleapis.com') + .post('/v3/blogs/abc123/posts/abc123/publish') .times(2) .reply(500, { error: {message: 'There was an error!'}, }); - - testBackendError(localBlogger, () => { - testBackendError(remoteBlogger, () => { - scope.done(); - done(); - }); - }); + await testBackendError(localBlogger); + await testBackendError(remoteBlogger); + scope.done(); }); - it('should handle a Backend Error', done => { - const scope = nock(Utils.baseUrl) - .post('/blogger/v3/blogs/abc123/posts/abc123/publish') + it('should handle a Backend Error', async () => { + const scope = nock('https://blogger.googleapis.com') + .post('/v3/blogs/abc123/posts/abc123/publish') .times(2) .reply(500, { error: { @@ -297,13 +292,9 @@ describe('Transporters', () => { message: 'There was an error!', }, }); - - testBackendError(localBlogger, () => { - testBackendError(remoteBlogger, () => { - scope.done(); - done(); - }); - }); + await testBackendError(localBlogger); + await testBackendError(remoteBlogger); + scope.done(); }); after(() => {