/opt/canhelp/node_modules/googleapis/build/src/apis/merchantapi
Edit: /opt/canhelp/node_modules/googleapis/build/src/apis/merchantapi/quota_v1.d.ts (21580B)
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace merchantapi_quota_v1 {
export interface Options extends GlobalOptions {
version: 'quota_v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
}
/**
* Merchant API
*
* Programmatically manage your Merchant Center Accounts.
*
* @example
* ```js
* const {google} = require('googleapis');
* const merchantapi = google.merchantapi('quota_v1');
* ```
*/
export class Merchantapi {
context: APIRequestContext;
accounts: Resource$Accounts;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A limit of a certain type that is applied to an account.
*/
export interface Schema$AccountLimit {
/**
* Identifier. The limit part of the name will be a combination of the type and the scope. For example: `accounts/123/limits/products~ADS_NON_EEA` Format: `accounts/{account\}/limits/{limit\}`
*/
name?: string | null;
/**
* The limit for products.
*/
products?: Schema$ProductLimit;
}
/**
* Response message for the `ListAccountLimits` method.
*/
export interface Schema$ListAccountLimitsResponse {
/**
* The limits for the given account.
*/
accountLimits?: Schema$AccountLimit[];
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
}
/**
* Response message for the ListMethodGroups method.
*/
export interface Schema$ListQuotaGroupsResponse {
/**
* A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
*/
nextPageToken?: string | null;
/**
* The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quota_usage.
*/
quotaGroups?: Schema$QuotaGroup[];
}
/**
* The method details per method in the Merchant API.
*/
export interface Schema$MethodDetails {
/**
* Output only. The name of the method for example `products.list`.
*/
method?: string | null;
/**
* Output only. The path for the method such as `products/v1/productInputs.insert`
*/
path?: string | null;
/**
* Output only. The sub-API that the method belongs to.
*/
subapi?: string | null;
/**
* Output only. The API version that the method belongs to.
*/
version?: string | null;
}
/**
* The change that happened to the product including old value, new value, country code as the region code and reporting context.
*/
export interface Schema$ProductChange {
/**
* The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
*/
newValue?: string | null;
/**
* The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)
*/
oldValue?: string | null;
/**
* Countries that have the change (if applicable). Represented in the ISO 3166 format.
*/
regionCode?: string | null;
/**
* Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)
*/
reportingContext?: string | null;
}
/**
* The limit for products.
*/
export interface Schema$ProductLimit {
/**
* Required. The maximum number of products that are allowed in the account in the given scope.
*/
limit?: string | null;
/**
* Required. The scope of the product limit.
*/
scope?: string | null;
}
/**
* The message that the merchant will receive to notify about product status change event
*/
export interface Schema$ProductStatusChangeMessage {
/**
* The target account that owns the entity that changed. Format : `accounts/{merchant_id\}`
*/
account?: string | null;
/**
* The attribute in the resource that changed, in this case it will be always `Status`.
*/
attribute?: string | null;
/**
* A message to describe the change that happened to the product
*/
changes?: Schema$ProductChange[];
/**
* The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications.
*/
eventTime?: string | null;
/**
* Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.
*/
expirationTime?: string | null;
/**
* The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id\}`
*/
managingAccount?: string | null;
/**
* The product name. Format: `accounts/{account\}/products/{product\}`
*/
resource?: string | null;
/**
* The product id.
*/
resourceId?: string | null;
/**
* The resource that changed, in this case it will always be `Product`.
*/
resourceType?: string | null;
}
/**
* The group information for methods in the Merchant API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned.
*/
export interface Schema$QuotaGroup {
/**
* Output only. List of all methods group quota applies to.
*/
methodDetails?: Schema$MethodDetails[];
/**
* Identifier. The resource name of the quota group. Format: accounts/{account\}/quotas/{group\} Note: There is no guarantee on the format of {group\}
*/
name?: string | null;
/**
* Output only. The maximum number of calls allowed per day for the group.
*/
quotaLimit?: string | null;
/**
* Output only. The maximum number of calls allowed per minute for the group.
*/
quotaMinuteLimit?: string | null;
/**
* Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC.
*/
quotaUsage?: string | null;
}
export class Resource$Accounts {
context: APIRequestContext;
limits: Resource$Accounts$Limits;
quotas: Resource$Accounts$Quotas;
constructor(context: APIRequestContext);
}
export class Resource$Accounts$Limits {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Retrieves an account limit.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const merchantapi = google.merchantapi('quota_v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/content'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await merchantapi.accounts.limits.get({
* // Required. The name of the limit to retrieve. Format: `accounts/{account\}/limits/{limit\}` For example: `accounts/123/limits/products~ADS_NON_EEA`
* name: 'accounts/my-account/limits/my-limit',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "name": "my_name",
* // "products": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Accounts$Limits$Get, options: StreamMethodOptions): Promise
>;
get(params?: Params$Resource$Accounts$Limits$Get, options?: MethodOptions): Promise>;
get(params: Params$Resource$Accounts$Limits$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void;
get(params: Params$Resource$Accounts$Limits$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void;
get(params: Params$Resource$Accounts$Limits$Get, callback: BodyResponseCallback): void;
get(callback: BodyResponseCallback): void;
/**
* Lists the limits of an account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const merchantapi = google.merchantapi('quota_v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/content'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await merchantapi.accounts.limits.list({
* // Required. A filter on the limit `type` is required, for example, `type = "products"`.
* filter: 'placeholder-value',
* // Optional. The maximum number of limits to return. The service may return fewer than this value. If unspecified, at most 100 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100.
* pageSize: 'placeholder-value',
* // Optional. A page token, received from a previous `ListAccountLimits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLimits` must match the call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The parent account. Format: `accounts/{account\}`
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountLimits": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Limits$List, options: StreamMethodOptions): Promise>;
list(params?: Params$Resource$Accounts$Limits$List, options?: MethodOptions): Promise>;
list(params: Params$Resource$Accounts$Limits$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void;
list(params: Params$Resource$Accounts$Limits$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void;
list(params: Params$Resource$Accounts$Limits$List, callback: BodyResponseCallback): void;
list(callback: BodyResponseCallback): void;
}
export interface Params$Resource$Accounts$Limits$Get extends StandardParameters {
/**
* Required. The name of the limit to retrieve. Format: `accounts/{account\}/limits/{limit\}` For example: `accounts/123/limits/products~ADS_NON_EEA`
*/
name?: string;
}
export interface Params$Resource$Accounts$Limits$List extends StandardParameters {
/**
* Required. A filter on the limit `type` is required, for example, `type = "products"`.
*/
filter?: string;
/**
* Optional. The maximum number of limits to return. The service may return fewer than this value. If unspecified, at most 100 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100.
*/
pageSize?: number;
/**
* Optional. A page token, received from a previous `ListAccountLimits` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLimits` must match the call that provided the page token.
*/
pageToken?: string;
/**
* Required. The parent account. Format: `accounts/{account\}`
*/
parent?: string;
}
export class Resource$Accounts$Quotas {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Lists the daily call quota and usage per group for your Merchant Center account.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/merchantapi.googleapis.com
* // - Login into gcloud by running:
* // ```sh
* // $ gcloud auth application-default login
* // ```
* // - Install the npm module by running:
* // ```sh
* // $ npm install googleapis
* // ```
*
* const {google} = require('googleapis');
* const merchantapi = google.merchantapi('quota_v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/content'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await merchantapi.accounts.quotas.list({
* // Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.
* pageSize: 'placeholder-value',
* // Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
* pageToken: 'placeholder-value',
* // Required. The merchant account who owns the collection of method quotas Format: accounts/{account\}
* parent: 'accounts/my-account',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "nextPageToken": "my_nextPageToken",
* // "quotaGroups": []
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Accounts$Quotas$List, options: StreamMethodOptions): Promise>;
list(params?: Params$Resource$Accounts$Quotas$List, options?: MethodOptions): Promise>;
list(params: Params$Resource$Accounts$Quotas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void;
list(params: Params$Resource$Accounts$Quotas$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void;
list(params: Params$Resource$Accounts$Quotas$List, callback: BodyResponseCallback): void;
list(callback: BodyResponseCallback): void;
}
export interface Params$Resource$Accounts$Quotas$List extends StandardParameters {
/**
* Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.
*/
pageSize?: number;
/**
* Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.
*/
pageToken?: string;
/**
* Required. The merchant account who owns the collection of method quotas Format: accounts/{account\}
*/
parent?: string;
}
export {};
}