v1.d.ts 10.8 KB
/**
 * Copyright 2019 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace urlshortener_v1 {
    interface Options extends GlobalOptions {
        version: 'v1';
    }
    interface StandardParameters {
        /**
         * Data format for the response.
         */
        alt?: string;
        /**
         * Selector specifying which fields to include in a partial response.
         */
        fields?: string;
        /**
         * API key. Your API key identifies your project and provides you with API
         * access, quota, and reports. Required unless you provide an OAuth 2.0
         * token.
         */
        key?: string;
        /**
         * OAuth 2.0 token for the current user.
         */
        oauth_token?: string;
        /**
         * Returns response with indentations and line breaks.
         */
        prettyPrint?: boolean;
        /**
         * An opaque string that represents a user for quota purposes. Must not
         * exceed 40 characters.
         */
        quotaUser?: string;
        /**
         * Deprecated. Please use quotaUser instead.
         */
        userIp?: string;
    }
    /**
     * URL Shortener API
     *
     * Lets you create, inspect, and manage goo.gl short URLs
     *
     * @example
     * const {google} = require('googleapis');
     * const urlshortener = google.urlshortener('v1');
     *
     * @namespace urlshortener
     * @type {Function}
     * @version v1
     * @variation v1
     * @param {object=} options Options for Urlshortener
     */
    class Urlshortener {
        context: APIRequestContext;
        url: Resource$Url;
        constructor(options: GlobalOptions, google?: GoogleConfigurable);
    }
    interface Schema$AnalyticsSnapshot {
        /**
         * Top browsers, e.g. "Chrome"; sorted by (descending) click
         * counts. Only present if this data is available.
         */
        browsers?: Schema$StringCount[];
        /**
         * Top countries (expressed as country codes), e.g. "US" or
         * "DE"; sorted by (descending) click counts. Only present if this
         * data is available.
         */
        countries?: Schema$StringCount[];
        /**
         * Number of clicks on all goo.gl short URLs pointing to this long URL.
         */
        longUrlClicks?: string;
        /**
         * Top platforms or OSes, e.g. "Windows"; sorted by (descending)
         * click counts. Only present if this data is available.
         */
        platforms?: Schema$StringCount[];
        /**
         * Top referring hosts, e.g. "www.google.com"; sorted by
         * (descending) click counts. Only present if this data is available.
         */
        referrers?: Schema$StringCount[];
        /**
         * Number of clicks on this short URL.
         */
        shortUrlClicks?: string;
    }
    interface Schema$AnalyticsSummary {
        /**
         * Click analytics over all time.
         */
        allTime?: Schema$AnalyticsSnapshot;
        /**
         * Click analytics over the last day.
         */
        day?: Schema$AnalyticsSnapshot;
        /**
         * Click analytics over the last month.
         */
        month?: Schema$AnalyticsSnapshot;
        /**
         * Click analytics over the last two hours.
         */
        twoHours?: Schema$AnalyticsSnapshot;
        /**
         * Click analytics over the last week.
         */
        week?: Schema$AnalyticsSnapshot;
    }
    interface Schema$StringCount {
        /**
         * Number of clicks for this top entry, e.g. for this particular country or
         * browser.
         */
        count?: string;
        /**
         * Label assigned to this top entry, e.g. "US" or
         * "Chrome".
         */
        id?: string;
    }
    interface Schema$Url {
        /**
         * A summary of the click analytics for the short and long URL. Might not be
         * present if not requested or currently unavailable.
         */
        analytics?: Schema$AnalyticsSummary;
        /**
         * Time the short URL was created; ISO 8601 representation using the
         * yyyy-MM-dd'T'HH:mm:ss.SSSZZ format, e.g.
         * "2010-10-14T19:01:24.944+00:00".
         */
        created?: string;
        /**
         * Short URL, e.g. "http://goo.gl/l6MS".
         */
        id?: string;
        /**
         * The fixed string "urlshortener#url".
         */
        kind?: string;
        /**
         * Long URL, e.g. "http://www.google.com/". Might not be present
         * if the status is "REMOVED".
         */
        longUrl?: string;
        /**
         * Status of the target URL. Possible values: "OK",
         * "MALWARE", "PHISHING", or "REMOVED". A URL
         * might be marked "REMOVED" if it was flagged as spam, for
         * example.
         */
        status?: string;
    }
    interface Schema$UrlHistory {
        /**
         * A list of URL resources.
         */
        items?: Schema$Url[];
        /**
         * Number of items returned with each full "page" of results. Note
         * that the last page could have fewer items than the
         * "itemsPerPage" value.
         */
        itemsPerPage?: number;
        /**
         * The fixed string "urlshortener#urlHistory".
         */
        kind?: string;
        /**
         * A token to provide to get the next page of results.
         */
        nextPageToken?: string;
        /**
         * Total number of short URLs associated with this user (may be
         * approximate).
         */
        totalItems?: number;
    }
    class Resource$Url {
        context: APIRequestContext;
        constructor(context: APIRequestContext);
        /**
         * urlshortener.url.get
         * @desc Expands a short URL or gets creation time and analytics.
         * @alias urlshortener.url.get
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {string=} params.projection Additional information to return.
         * @param {string} params.shortUrl The short URL, including the protocol.
         * @param {object} [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$Url$Get, options?: MethodOptions): GaxiosPromise<Schema$Url>;
        get(params: Params$Resource$Url$Get, options: MethodOptions | BodyResponseCallback<Schema$Url>, callback: BodyResponseCallback<Schema$Url>): void;
        get(params: Params$Resource$Url$Get, callback: BodyResponseCallback<Schema$Url>): void;
        get(callback: BodyResponseCallback<Schema$Url>): void;
        /**
         * urlshortener.url.insert
         * @desc Creates a new short URL.
         * @alias urlshortener.url.insert
         * @memberOf! ()
         *
         * @param {object} params Parameters for request
         * @param {().Url} params.resource Request body data
         * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
         * @param {callback} callback The callback that handles the response.
         * @return {object} Request object
         */
        insert(params?: Params$Resource$Url$Insert, options?: MethodOptions): GaxiosPromise<Schema$Url>;
        insert(params: Params$Resource$Url$Insert, options: MethodOptions | BodyResponseCallback<Schema$Url>, callback: BodyResponseCallback<Schema$Url>): void;
        insert(params: Params$Resource$Url$Insert, callback: BodyResponseCallback<Schema$Url>): void;
        insert(callback: BodyResponseCallback<Schema$Url>): void;
        /**
         * urlshortener.url.list
         * @desc Retrieves a list of URLs shortened by a user.
         * @alias urlshortener.url.list
         * @memberOf! ()
         *
         * @param {object=} params Parameters for request
         * @param {string=} params.projection Additional information to return.
         * @param {string=} params.start-token Token for requesting successive pages of 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$Url$List, options?: MethodOptions): GaxiosPromise<Schema$UrlHistory>;
        list(params: Params$Resource$Url$List, options: MethodOptions | BodyResponseCallback<Schema$UrlHistory>, callback: BodyResponseCallback<Schema$UrlHistory>): void;
        list(params: Params$Resource$Url$List, callback: BodyResponseCallback<Schema$UrlHistory>): void;
        list(callback: BodyResponseCallback<Schema$UrlHistory>): void;
    }
    interface Params$Resource$Url$Get extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Additional information to return.
         */
        projection?: string;
        /**
         * The short URL, including the protocol.
         */
        shortUrl?: string;
    }
    interface Params$Resource$Url$Insert extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Request body metadata
         */
        requestBody?: Schema$Url;
    }
    interface Params$Resource$Url$List extends StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
        /**
         * Additional information to return.
         */
        projection?: string;
        /**
         * Token for requesting successive pages of results.
         */
        'start-token'?: string;
    }
}