/** * 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 { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace analytics_v3 { interface Options extends GlobalOptions { version: 'v3'; } 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; } /** * Google Analytics API * * Views and manages your Google Analytics data. * * @example * const {google} = require('googleapis'); * const analytics = google.analytics('v3'); * * @namespace analytics * @type {Function} * @version v3 * @variation v3 * @param {object=} options Options for Analytics */ class Analytics { data: Resource$Data; management: Resource$Management; metadata: Resource$Metadata; provisioning: Resource$Provisioning; userDeletion: Resource$Userdeletion; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * JSON template for Analytics account entry. */ interface Schema$Account { /** * Child link for an account entry. Points to the list of web properties for * this account. */ childLink?: { href?: string; type?: string; }; /** * Time the account was created. */ created?: string; /** * Account ID. */ id?: string; /** * Resource type for Analytics account. */ kind?: string; /** * Account name. */ name?: string; /** * Permissions the user has for this account. */ permissions?: { effective?: string[]; }; /** * Link for this account. */ selfLink?: string; /** * Indicates whether this account is starred or not. */ starred?: boolean; /** * Time the account was last modified. */ updated?: string; } /** * JSON template for a linked account. */ interface Schema$AccountRef { /** * Link for this account. */ href?: string; /** * Account ID. */ id?: string; /** * Analytics account reference. */ kind?: string; /** * Account name. */ name?: string; } /** * An account collection provides a list of Analytics accounts to which a user * has access. The account collection is the entry point to all management * information. Each resource in the collection corresponds to a single * Analytics account. */ interface Schema$Accounts { /** * A list of accounts. */ items?: Schema$Account[]; /** * The maximum number of entries the response can contain, regardless of the * actual number of entries returned. Its value ranges from 1 to 1000 with a * value of 1000 by default, or otherwise specified by the max-results query * parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Next link for this account collection. */ nextLink?: string; /** * Previous link for this account collection. */ previousLink?: string; /** * The starting index of the entries, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * An AccountSummary collection lists a summary of accounts, properties and * views (profiles) to which the user has access. Each resource in the * collection corresponds to a single AccountSummary. */ interface Schema$AccountSummaries { /** * A list of AccountSummaries. */ items?: Schema$AccountSummary[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this AccountSummary collection. */ nextLink?: string; /** * Link to previous page for this AccountSummary collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for an Analytics AccountSummary. An AccountSummary is a * lightweight tree comprised of properties/profiles. */ interface Schema$AccountSummary { /** * Account ID. */ id?: string; /** * Resource type for Analytics AccountSummary. */ kind?: string; /** * Account name. */ name?: string; /** * Indicates whether this account is starred or not. */ starred?: boolean; /** * List of web properties under this account. */ webProperties?: Schema$WebPropertySummary[]; } /** * JSON template for an Analytics account ticket. The account ticket consists * of the ticket ID and the basic information for the account, property and * profile. */ interface Schema$AccountTicket { /** * Account for this ticket. */ account?: Schema$Account; /** * Account ticket ID used to access the account ticket. */ id?: string; /** * Resource type for account ticket. */ kind?: string; /** * View (Profile) for the account. */ profile?: Schema$Profile; /** * Redirect URI where the user will be sent after accepting Terms of * Service. Must be configured in APIs console as a callback URL. */ redirectUri?: string; /** * Web property for the account. */ webproperty?: Schema$Webproperty; } /** * JSON template for an Analytics account tree requests. The account tree * request is used in the provisioning api to create an account, property, and * view (profile). It contains the basic information required to make these * fields. */ interface Schema$AccountTreeRequest { accountName?: string; /** * Resource type for account ticket. */ kind?: string; profileName?: string; timezone?: string; webpropertyName?: string; websiteUrl?: string; } /** * JSON template for an Analytics account tree response. The account tree * response is used in the provisioning api to return the result of creating * an account, property, and view (profile). */ interface Schema$AccountTreeResponse { /** * The account created. */ account?: Schema$Account; /** * Resource type for account ticket. */ kind?: string; /** * View (Profile) for the account. */ profile?: Schema$Profile; /** * Web property for the account. */ webproperty?: Schema$Webproperty; } /** * JSON template for an Google Ads account. */ interface Schema$AdWordsAccount { /** * True if auto-tagging is enabled on the Google Ads account. Read-only * after the insert operation. */ autoTaggingEnabled?: boolean; /** * Customer ID. This field is required when creating a Google Ads link. */ customerId?: string; /** * Resource type for Google Ads account. */ kind?: string; } /** * Request template for the delete upload data request. */ interface Schema$AnalyticsDataimportDeleteUploadDataRequest { /** * A list of upload UIDs. */ customDataImportUids?: string[]; } /** * JSON template for a metadata column. */ interface Schema$Column { /** * Map of attribute name and value for this column. */ attributes?: { [key: string]: string; }; /** * Column id. */ id?: string; /** * Resource type for Analytics column. */ kind?: string; } /** * Lists columns (dimensions and metrics) for a particular report type. */ interface Schema$Columns { /** * List of attributes names returned by columns. */ attributeNames?: string[]; /** * Etag of collection. This etag can be compared with the last response etag * to check if response has changed. */ etag?: string; /** * List of columns for a report type. */ items?: Schema$Column[]; /** * Collection type. */ kind?: string; /** * Total number of columns returned in the response. */ totalResults?: number; } /** * JSON template for an Analytics custom data source. */ interface Schema$CustomDataSource { /** * Account ID to which this custom data source belongs. */ accountId?: string; childLink?: { href?: string; type?: string; }; /** * Time this custom data source was created. */ created?: string; /** * Description of custom data source. */ description?: string; /** * Custom data source ID. */ id?: string; importBehavior?: string; /** * Resource type for Analytics custom data source. */ kind?: string; /** * Name of this custom data source. */ name?: string; /** * Parent link for this custom data source. Points to the web property to * which this custom data source belongs. */ parentLink?: { href?: string; type?: string; }; /** * IDs of views (profiles) linked to the custom data source. */ profilesLinked?: string[]; /** * Collection of schema headers of the custom data source. */ schema?: string[]; /** * Link for this Analytics custom data source. */ selfLink?: string; /** * Type of the custom data source. */ type?: string; /** * Time this custom data source was last modified. */ updated?: string; /** * Upload type of the custom data source. */ uploadType?: string; /** * Web property ID of the form UA-XXXXX-YY to which this custom data source * belongs. */ webPropertyId?: string; } /** * Lists Analytics custom data sources to which the user has access. Each * resource in the collection corresponds to a single Analytics custom data * source. */ interface Schema$CustomDataSources { /** * Collection of custom data sources. */ items?: Schema$CustomDataSource[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this custom data source collection. */ nextLink?: string; /** * Link to previous page for this custom data source collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for Analytics Custom Dimension. */ interface Schema$CustomDimension { /** * Account ID. */ accountId?: string; /** * Boolean indicating whether the custom dimension is active. */ active?: boolean; /** * Time the custom dimension was created. */ created?: string; /** * Custom dimension ID. */ id?: string; /** * Index of the custom dimension. */ index?: number; /** * Kind value for a custom dimension. Set to * "analytics#customDimension". It is a read-only field. */ kind?: string; /** * Name of the custom dimension. */ name?: string; /** * Parent link for the custom dimension. Points to the property to which the * custom dimension belongs. */ parentLink?: { href?: string; type?: string; }; /** * Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. */ scope?: string; /** * Link for the custom dimension */ selfLink?: string; /** * Time the custom dimension was last modified. */ updated?: string; /** * Property ID. */ webPropertyId?: string; } /** * A custom dimension collection lists Analytics custom dimensions to which * the user has access. Each resource in the collection corresponds to a * single Analytics custom dimension. */ interface Schema$CustomDimensions { /** * Collection of custom dimensions. */ items?: Schema$CustomDimension[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this custom dimension collection. */ nextLink?: string; /** * Link to previous page for this custom dimension collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for Analytics Custom Metric. */ interface Schema$CustomMetric { /** * Account ID. */ accountId?: string; /** * Boolean indicating whether the custom metric is active. */ active?: boolean; /** * Time the custom metric was created. */ created?: string; /** * Custom metric ID. */ id?: string; /** * Index of the custom metric. */ index?: number; /** * Kind value for a custom metric. Set to * "analytics#customMetric". It is a read-only field. */ kind?: string; /** * Max value of custom metric. */ max_value?: string; /** * Min value of custom metric. */ min_value?: string; /** * Name of the custom metric. */ name?: string; /** * Parent link for the custom metric. Points to the property to which the * custom metric belongs. */ parentLink?: { href?: string; type?: string; }; /** * Scope of the custom metric: HIT or PRODUCT. */ scope?: string; /** * Link for the custom metric */ selfLink?: string; /** * Data type of custom metric. */ type?: string; /** * Time the custom metric was last modified. */ updated?: string; /** * Property ID. */ webPropertyId?: string; } /** * A custom metric collection lists Analytics custom metrics to which the user * has access. Each resource in the collection corresponds to a single * Analytics custom metric. */ interface Schema$CustomMetrics { /** * Collection of custom metrics. */ items?: Schema$CustomMetric[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this custom metric collection. */ nextLink?: string; /** * Link to previous page for this custom metric collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for Analytics Entity Google Ads Link. */ interface Schema$EntityAdWordsLink { /** * A list of Google Ads client accounts. These cannot be MCC accounts. This * field is required when creating a Google Ads link. It cannot be empty. */ adWordsAccounts?: Schema$AdWordsAccount[]; /** * Web property being linked. */ entity?: { webPropertyRef?: Schema$WebPropertyRef; }; /** * Entity Google Ads link ID */ id?: string; /** * Resource type for entity Google Ads link. */ kind?: string; /** * Name of the link. This field is required when creating a Google Ads link. */ name?: string; /** * IDs of linked Views (Profiles) represented as strings. */ profileIds?: string[]; /** * URL link for this Google Analytics - Google Ads link. */ selfLink?: string; } /** * An entity Google Ads link collection provides a list of GA-Google Ads links * Each resource in this collection corresponds to a single link. */ interface Schema$EntityAdWordsLinks { /** * A list of entity Google Ads links. */ items?: Schema$EntityAdWordsLink[]; /** * The maximum number of entries the response can contain, regardless of the * actual number of entries returned. Its value ranges from 1 to 1000 with a * value of 1000 by default, or otherwise specified by the max-results query * parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Next link for this Google Ads link collection. */ nextLink?: string; /** * Previous link for this Google Ads link collection. */ previousLink?: string; /** * The starting index of the entries, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; } /** * JSON template for an Analytics Entity-User Link. Returns permissions that a * user has for an entity. */ interface Schema$EntityUserLink { /** * Entity for this link. It can be an account, a web property, or a view * (profile). */ entity?: { accountRef?: Schema$AccountRef; profileRef?: Schema$ProfileRef; webPropertyRef?: Schema$WebPropertyRef; }; /** * Entity user link ID */ id?: string; /** * Resource type for entity user link. */ kind?: string; /** * Permissions the user has for this entity. */ permissions?: { effective?: string[]; local?: string[]; }; /** * Self link for this resource. */ selfLink?: string; /** * User reference. */ userRef?: Schema$UserRef; } /** * An entity user link collection provides a list of Analytics ACL links Each * resource in this collection corresponds to a single link. */ interface Schema$EntityUserLinks { /** * A list of entity user links. */ items?: Schema$EntityUserLink[]; /** * The maximum number of entries the response can contain, regardless of the * actual number of entries returned. Its value ranges from 1 to 1000 with a * value of 1000 by default, or otherwise specified by the max-results query * parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Next link for this account collection. */ nextLink?: string; /** * Previous link for this account collection. */ previousLink?: string; /** * The starting index of the entries, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; } /** * JSON template for Analytics experiment resource. */ interface Schema$Experiment { /** * Account ID to which this experiment belongs. This field is read-only. */ accountId?: string; /** * Time the experiment was created. This field is read-only. */ created?: string; /** * Notes about this experiment. */ description?: string; /** * If true, the end user will be able to edit the experiment via the Google * Analytics user interface. */ editableInGaUi?: boolean; /** * The ending time of the experiment (the time the status changed from * RUNNING to ENDED). This field is present only if the experiment has * ended. This field is read-only. */ endTime?: string; /** * Boolean specifying whether to distribute traffic evenly across all * variations. If the value is False, content experiments follows the * default behavior of adjusting traffic dynamically based on variation * performance. Optional -- defaults to False. This field may not be changed * for an experiment whose status is ENDED. */ equalWeighting?: boolean; /** * Experiment ID. Required for patch and update. Disallowed for create. */ id?: string; /** * Internal ID for the web property to which this experiment belongs. This * field is read-only. */ internalWebPropertyId?: string; /** * Resource type for an Analytics experiment. This field is read-only. */ kind?: string; /** * An integer number in [3, 90]. Specifies the minimum length of the * experiment. Can be changed for a running experiment. This field may not * be changed for an experiments whose status is ENDED. */ minimumExperimentLengthInDays?: number; /** * Experiment name. This field may not be changed for an experiment whose * status is ENDED. This field is required when creating an experiment. */ name?: string; /** * The metric that the experiment is optimizing. Valid values: * "ga:goal(n)Completions", "ga:adsenseAdsClicks", * "ga:adsenseAdsViewed", "ga:adsenseRevenue", * "ga:bounces", "ga:pageviews", * "ga:sessionDuration", "ga:transactions", * "ga:transactionRevenue". This field is required if status is * "RUNNING" and servingFramework is one of "REDIRECT" * or "API". */ objectiveMetric?: string; /** * Whether the objectiveMetric should be minimized or maximized. Possible * values: "MAXIMUM", "MINIMUM". Optional--defaults to * "MAXIMUM". Cannot be specified without objectiveMetric. Cannot * be modified when status is "RUNNING" or "ENDED". */ optimizationType?: string; /** * Parent link for an experiment. Points to the view (profile) to which this * experiment belongs. */ parentLink?: { href?: string; type?: string; }; /** * View (Profile) ID to which this experiment belongs. This field is * read-only. */ profileId?: string; /** * Why the experiment ended. Possible values: "STOPPED_BY_USER", * "WINNER_FOUND", "EXPERIMENT_EXPIRED", * "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". * "ENDED_WITH_NO_WINNER" means that the experiment didn't * expire but no winner was projected to be found. If the experiment status * is changed via the API to ENDED this field is set to STOPPED_BY_USER. * This field is read-only. */ reasonExperimentEnded?: string; /** * Boolean specifying whether variations URLS are rewritten to match those * of the original. This field may not be changed for an experiments whose * status is ENDED. */ rewriteVariationUrlsAsOriginal?: boolean; /** * Link for this experiment. This field is read-only. */ selfLink?: string; /** * The framework used to serve the experiment variations and evaluate the * results. One of: - REDIRECT: Google Analytics redirects traffic to * different variation pages, reports the chosen variation and evaluates the * results. - API: Google Analytics chooses and reports the variation to * serve and evaluates the results; the caller is responsible for serving * the selected variation. - EXTERNAL: The variations will be served * externally and the chosen variation reported to Google Analytics. The * caller is responsible for serving the selected variation and evaluating * the results. */ servingFramework?: string; /** * The snippet of code to include on the control page(s). This field is * read-only. */ snippet?: string; /** * The starting time of the experiment (the time the status changed from * READY_TO_RUN to RUNNING). This field is present only if the experiment * has started. This field is read-only. */ startTime?: string; /** * Experiment status. Possible values: "DRAFT", * "READY_TO_RUN", "RUNNING", "ENDED". * Experiments can be created in the "DRAFT", * "READY_TO_RUN" or "RUNNING" state. This field is * required when creating an experiment. */ status?: string; /** * A floating-point number in (0, 1]. Specifies the fraction of the traffic * that participates in the experiment. Can be changed for a running * experiment. This field may not be changed for an experiments whose status * is ENDED. */ trafficCoverage?: number; /** * Time the experiment was last modified. This field is read-only. */ updated?: string; /** * 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; status?: string; url?: string; weight?: number; won?: boolean; }>; /** * Web property ID to which this experiment belongs. The web property ID is * of the form UA-XXXXX-YY. This field is read-only. */ webPropertyId?: string; /** * A floating-point number in (0, 1). Specifies the necessary confidence * level to choose a winner. This field may not be changed for an * experiments whose status is ENDED. */ winnerConfidenceLevel?: number; /** * Boolean specifying whether a winner has been found for this experiment. * This field is read-only. */ winnerFound?: boolean; } /** * An experiment collection lists Analytics experiments to which the user has * access. Each view (profile) can have a set of experiments. Each resource in * the Experiment collection corresponds to a single Analytics experiment. */ interface Schema$Experiments { /** * A list of experiments. */ items?: Schema$Experiment[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this experiment collection. */ nextLink?: string; /** * Link to previous page for this experiment collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * resources in the result. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for an Analytics account filter. */ interface Schema$Filter { /** * Account ID to which this filter belongs. */ accountId?: string; /** * Details for the filter of the type ADVANCED. */ advancedDetails?: { caseSensitive?: boolean; extractA?: string; extractB?: string; fieldA?: string; fieldAIndex?: number; fieldARequired?: boolean; fieldB?: string; fieldBIndex?: number; fieldBRequired?: boolean; outputConstructor?: string; outputToField?: string; outputToFieldIndex?: number; overrideOutputField?: boolean; }; /** * Time this filter was created. */ created?: string; /** * Details for the filter of the type EXCLUDE. */ excludeDetails?: Schema$FilterExpression; /** * Filter ID. */ id?: string; /** * Details for the filter of the type INCLUDE. */ includeDetails?: Schema$FilterExpression; /** * Resource type for Analytics filter. */ kind?: string; /** * Details for the filter of the type LOWER. */ lowercaseDetails?: { field?: string; fieldIndex?: number; }; /** * Name of this filter. */ name?: string; /** * Parent link for this filter. Points to the account to which this filter * belongs. */ parentLink?: { href?: string; type?: string; }; /** * Details for the filter of the type SEARCH_AND_REPLACE. */ searchAndReplaceDetails?: { caseSensitive?: boolean; field?: string; fieldIndex?: number; replaceString?: string; searchString?: string; }; /** * Link for this filter. */ selfLink?: string; /** * Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, * UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. */ type?: string; /** * Time this filter was last modified. */ updated?: string; /** * Details for the filter of the type UPPER. */ uppercaseDetails?: { field?: string; fieldIndex?: number; }; } /** * JSON template for an Analytics filter expression. */ interface Schema$FilterExpression { /** * Determines if the filter is case sensitive. */ caseSensitive?: boolean; /** * Filter expression value */ expressionValue?: string; /** * Field to filter. Possible values: - Content and Traffic - * PAGE_REQUEST_URI, - PAGE_HOSTNAME, - PAGE_TITLE, - REFERRAL, - * COST_DATA_URI (Campaign target URL), - HIT_TYPE, - * INTERNAL_SEARCH_TERM, - INTERNAL_SEARCH_TYPE, - * SOURCE_PROPERTY_TRACKING_ID, - Campaign or AdGroup - * CAMPAIGN_SOURCE, - CAMPAIGN_MEDIUM, - CAMPAIGN_NAME, - * CAMPAIGN_AD_GROUP, - CAMPAIGN_TERM, - CAMPAIGN_CONTENT, - * CAMPAIGN_CODE, - CAMPAIGN_REFERRAL_PATH, - E-Commerce - * TRANSACTION_COUNTRY, - TRANSACTION_REGION, - TRANSACTION_CITY, - * TRANSACTION_AFFILIATION (Store or order location), - ITEM_NAME, - * ITEM_CODE, - ITEM_VARIATION, - TRANSACTION_ID, - * TRANSACTION_CURRENCY_CODE, - PRODUCT_ACTION_TYPE, - Audience/Users - * BROWSER, - BROWSER_VERSION, - BROWSER_SIZE, - PLATFORM, - * PLATFORM_VERSION, - LANGUAGE, - SCREEN_RESOLUTION, - SCREEN_COLORS, - * JAVA_ENABLED (Boolean Field), - FLASH_VERSION, - GEO_SPEED (Connection * speed), - VISITOR_TYPE, - GEO_ORGANIZATION (ISP organization), - * GEO_DOMAIN, - GEO_IP_ADDRESS, - GEO_IP_VERSION, - Location - * GEO_COUNTRY, - GEO_REGION, - GEO_CITY, - Event - EVENT_CATEGORY, * - EVENT_ACTION, - EVENT_LABEL, - Other - CUSTOM_FIELD_1, - * CUSTOM_FIELD_2, - USER_DEFINED_VALUE, - Application - APP_ID, - * APP_INSTALLER_ID, - APP_NAME, - APP_VERSION, - SCREEN, - IS_APP * (Boolean Field), - IS_FATAL_EXCEPTION (Boolean Field), - * EXCEPTION_DESCRIPTION, - Mobile device - IS_MOBILE (Boolean Field, * Deprecated. Use DEVICE_CATEGORY=mobile), - IS_TABLET (Boolean Field, * Deprecated. Use DEVICE_CATEGORY=tablet), - DEVICE_CATEGORY, - * MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - MOBILE_HAS_NFC_SUPPORT * (Boolean Field), - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), - * MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - MOBILE_BRAND_NAME, - * MOBILE_MODEL_NAME, - MOBILE_MARKETING_NAME, - MOBILE_POINTING_METHOD, * - Social - SOCIAL_NETWORK, - SOCIAL_ACTION, - SOCIAL_ACTION_TARGET, * - Custom dimension - CUSTOM_DIMENSION (See accompanying field index), */ field?: string; /** * The Index of the custom dimension. Set only if the field is a is * CUSTOM_DIMENSION. */ fieldIndex?: number; /** * Kind value for filter expression */ kind?: string; /** * Match type for this filter. Possible values are BEGINS_WITH, EQUAL, * ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, * PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all * other filters must use MATCHES. */ matchType?: string; } /** * JSON template for a profile filter link. */ interface Schema$FilterRef { /** * Account ID to which this filter belongs. */ accountId?: string; /** * Link for this filter. */ href?: string; /** * Filter ID. */ id?: string; /** * Kind value for filter reference. */ kind?: string; /** * Name of this filter. */ name?: string; } /** * A filter collection lists filters created by users in an Analytics account. * Each resource in the collection corresponds to a filter. */ interface Schema$Filters { /** * A list of filters. */ items?: Schema$Filter[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1,000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this filter collection. */ nextLink?: string; /** * Link to previous page for this filter collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * Analytics data for a given view (profile). */ interface Schema$GaData { /** * 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<{ columnType?: string; dataType?: string; name?: string; }>; /** * Determines if Analytics data contains samples. */ containsSampledData?: boolean; /** * The last refreshed time in seconds for Analytics data. */ dataLastRefreshed?: string; dataTable?: { cols?: Array<{ id?: string; label?: string; type?: string; }>; rows?: Array<{ c?: Array<{ v?: string; }>; }>; }; /** * Unique ID for this data response. */ id?: string; /** * The maximum number of rows the response can contain, regardless of the * actual number of rows returned. Its value ranges from 1 to 10,000 with a * value of 1000 by default, or otherwise specified by the max-results query * parameter. */ itemsPerPage?: number; /** * Resource type. */ kind?: string; /** * Link to next page for this Analytics data query. */ nextLink?: string; /** * Link to previous page for this Analytics data query. */ previousLink?: string; /** * Information for the view (profile), for which the Analytics data was * requested. */ profileInfo?: { accountId?: string; internalWebPropertyId?: string; profileId?: string; profileName?: string; tableId?: string; webPropertyId?: string; }; /** * Analytics data request query parameters. */ query?: { dimensions?: string; 'end-date'?: string; filters?: string; ids?: string; 'max-results'?: number; metrics?: string[]; samplingLevel?: string; segment?: string; sort?: string[]; 'start-date'?: string; 'start-index'?: number; }; /** * Analytics data rows, where each row contains a list of dimension values * followed by the metric values. The order of dimensions and metrics is * same as specified in the request. */ rows?: string[][]; /** * The number of samples used to calculate the result. */ sampleSize?: string; /** * Total size of the sample space from which the samples were selected. */ sampleSpace?: string; /** * Link to this page. */ selfLink?: string; /** * The total number of rows for the query, regardless of the number of rows * in the response. */ totalResults?: number; /** * Total values for the requested metrics over all the results, not just the * results returned in this response. The order of the metric totals is same * as the metric order specified in the request. */ totalsForAllResults?: { [key: string]: string; }; } /** * JSON template for Analytics goal resource. */ interface Schema$Goal { /** * Account ID to which this goal belongs. */ accountId?: string; /** * Determines whether this goal is active. */ active?: boolean; /** * Time this goal was created. */ created?: string; /** * Details for the goal of the type EVENT. */ eventDetails?: { eventConditions?: Array<{ comparisonType?: string; comparisonValue?: string; expression?: string; matchType?: string; type?: string; }>; useEventValue?: boolean; }; /** * Goal ID. */ id?: string; /** * Internal ID for the web property to which this goal belongs. */ internalWebPropertyId?: string; /** * Resource type for an Analytics goal. */ kind?: string; /** * Goal name. */ name?: string; /** * Parent link for a goal. Points to the view (profile) to which this goal * belongs. */ parentLink?: { href?: string; type?: string; }; /** * View (Profile) ID to which this goal belongs. */ profileId?: string; /** * Link for this goal. */ selfLink?: string; /** * Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, * VISIT_NUM_PAGES, AND EVENT. */ type?: string; /** * Time this goal was last modified. */ updated?: string; /** * Details for the goal of the type URL_DESTINATION. */ urlDestinationDetails?: { caseSensitive?: boolean; firstStepRequired?: boolean; matchType?: string; steps?: Array<{ name?: string; number?: number; url?: string; }>; url?: string; }; /** * Goal value. */ value?: number; /** * Details for the goal of the type VISIT_NUM_PAGES. */ visitNumPagesDetails?: { comparisonType?: string; comparisonValue?: string; }; /** * Details for the goal of the type VISIT_TIME_ON_SITE. */ visitTimeOnSiteDetails?: { comparisonType?: string; comparisonValue?: string; }; /** * Web property ID to which this goal belongs. The web property ID is of the * form UA-XXXXX-YY. */ webPropertyId?: string; } /** * A goal collection lists Analytics goals to which the user has access. Each * view (profile) can have a set of goals. Each resource in the Goal * collection corresponds to a single Analytics goal. */ interface Schema$Goals { /** * A list of goals. */ items?: Schema$Goal[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this goal collection. */ nextLink?: string; /** * Link to previous page for this goal collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * resources in the result. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for a hash Client Id request resource. */ interface Schema$HashClientIdRequest { clientId?: string; kind?: string; webPropertyId?: string; } /** * JSON template for a hash Client Id response resource. */ interface Schema$HashClientIdResponse { clientId?: string; hashedClientId?: string; kind?: string; webPropertyId?: string; } /** * JSON template for an Analytics Remarketing Include Conditions. */ interface Schema$IncludeConditions { /** * The look-back window lets you specify a time frame for evaluating the * behavior that qualifies users for your audience. For example, if your * filters include users from Central Asia, and Transactions Greater than 2, * and you set the look-back window to 14 days, then any user from Central * Asia whose cumulative transactions exceed 2 during the last 14 days is * added to the audience. */ daysToLookBack?: number; /** * Boolean indicating whether this segment is a smart list. * https://support.google.com/analytics/answer/4628577 */ isSmartList?: boolean; /** * Resource type for include conditions. */ kind?: string; /** * Number of days (in the range 1 to 540) a user remains in the audience. */ membershipDurationDays?: number; /** * The segment condition that will cause a user to be added to an audience. */ segment?: string; } /** * JSON template for an Analytics Remarketing Audience Foreign Link. */ interface Schema$LinkedForeignAccount { /** * Account ID to which this linked foreign account belongs. */ accountId?: string; /** * Boolean indicating whether this is eligible for search. */ eligibleForSearch?: boolean; /** * Entity ad account link ID. */ id?: string; /** * Internal ID for the web property to which this linked foreign account * belongs. */ internalWebPropertyId?: string; /** * Resource type for linked foreign account. */ kind?: string; /** * The foreign account ID. For example the an Google Ads `linkedAccountId` * has the following format XXX-XXX-XXXX. */ linkedAccountId?: string; /** * Remarketing audience ID to which this linked foreign account belongs. */ remarketingAudienceId?: string; /** * The status of this foreign account link. */ status?: string; /** * The type of the foreign account. For example, `ADWORDS_LINKS`, * `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. */ type?: string; /** * Web property ID of the form UA-XXXXX-YY to which this linked foreign * account belongs. */ webPropertyId?: string; } /** * Multi-Channel Funnels data for a given view (profile). */ interface Schema$McfData { /** * 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<{ columnType?: string; dataType?: string; name?: string; }>; /** * Determines if the Analytics data contains sampled data. */ containsSampledData?: boolean; /** * Unique ID for this data response. */ id?: string; /** * The maximum number of rows the response can contain, regardless of the * actual number of rows returned. Its value ranges from 1 to 10,000 with a * value of 1000 by default, or otherwise specified by the max-results query * parameter. */ itemsPerPage?: number; /** * Resource type. */ kind?: string; /** * Link to next page for this Analytics data query. */ nextLink?: string; /** * Link to previous page for this Analytics data query. */ previousLink?: string; /** * Information for the view (profile), for which the Analytics data was * requested. */ profileInfo?: { accountId?: string; internalWebPropertyId?: string; profileId?: string; profileName?: string; tableId?: string; webPropertyId?: string; }; /** * Analytics data request query parameters. */ query?: { dimensions?: string; 'end-date'?: string; filters?: string; ids?: string; 'max-results'?: number; metrics?: string[]; samplingLevel?: string; segment?: string; sort?: string[]; 'start-date'?: string; 'start-index'?: number; }; /** * Analytics data rows, where each row contains a list of dimension values * followed by the metric values. The order of dimensions and metrics is * same as specified in the request. */ rows?: Array; primitiveValue?: string; }>>; /** * The number of samples used to calculate the result. */ sampleSize?: string; /** * Total size of the sample space from which the samples were selected. */ sampleSpace?: string; /** * Link to this page. */ selfLink?: string; /** * The total number of rows for the query, regardless of the number of rows * in the response. */ totalResults?: number; /** * Total values for the requested metrics over all the results, not just the * results returned in this response. The order of the metric totals is same * as the metric order specified in the request. */ totalsForAllResults?: { [key: string]: string; }; } /** * JSON template for an Analytics view (profile). */ interface Schema$Profile { /** * Account ID to which this view (profile) belongs. */ accountId?: string; /** * Indicates whether bot filtering is enabled for this view (profile). */ botFilteringEnabled?: boolean; /** * Child link for this view (profile). Points to the list of goals for this * view (profile). */ childLink?: { href?: string; type?: string; }; /** * Time this view (profile) was created. */ created?: string; /** * The currency type associated with this view (profile), defaults to USD. * The supported values are: USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, * RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, * CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, * HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL */ currency?: string; /** * Default page for this view (profile). */ defaultPage?: string; /** * Indicates whether ecommerce tracking is enabled for this view (profile). */ eCommerceTracking?: boolean; /** * Indicates whether enhanced ecommerce tracking is enabled for this view * (profile). This property can only be enabled if ecommerce tracking is * enabled. */ enhancedECommerceTracking?: boolean; /** * The query parameters that are excluded from this view (profile). */ excludeQueryParameters?: string; /** * View (Profile) ID. */ id?: string; /** * Internal ID for the web property to which this view (profile) belongs. */ internalWebPropertyId?: string; /** * Resource type for Analytics view (profile). */ kind?: string; /** * Name of this view (profile). */ name?: string; /** * Parent link for this view (profile). Points to the web property to which * this view (profile) belongs. */ parentLink?: { href?: string; type?: string; }; /** * Permissions the user has for this view (profile). */ permissions?: { effective?: string[]; }; /** * Link for this view (profile). */ selfLink?: string; /** * Site search category parameters for this view (profile). */ siteSearchCategoryParameters?: string; /** * The site search query parameters for this view (profile). */ siteSearchQueryParameters?: string; /** * Indicates whether this view (profile) is starred or not. */ starred?: boolean; /** * Whether or not Analytics will strip search category parameters from the * URLs in your reports. */ stripSiteSearchCategoryParameters?: boolean; /** * Whether or not Analytics will strip search query parameters from the URLs * in your reports. */ stripSiteSearchQueryParameters?: boolean; /** * Time zone for which this view (profile) has been configured. Time zones * are identified by strings from the TZ database. */ timezone?: string; /** * View (Profile) type. Supported types: WEB or APP. */ type?: string; /** * Time this view (profile) was last modified. */ updated?: string; /** * Web property ID of the form UA-XXXXX-YY to which this view (profile) * belongs. */ webPropertyId?: string; /** * Website URL for this view (profile). */ websiteUrl?: string; } /** * JSON template for an Analytics profile filter link. */ interface Schema$ProfileFilterLink { /** * Filter for this link. */ filterRef?: Schema$FilterRef; /** * Profile filter link ID. */ id?: string; /** * Resource type for Analytics filter. */ kind?: string; /** * View (Profile) for this link. */ profileRef?: Schema$ProfileRef; /** * The rank of this profile filter link relative to the other filters linked * to the same profile. For readonly (i.e., list and get) operations, the * rank always starts at 1. For write (i.e., create, update, or delete) * operations, you may specify a value between 0 and 255 inclusively, [0, * 255]. In order to insert a link at the end of the list, either don't * specify a rank or set a rank to a number greater than the largest rank in * the list. In order to insert a link to the beginning of the list specify * a rank that is less than or equal to 1. The new link will move all * existing filters with the same or lower rank down the list. After the * link is inserted/updated/deleted all profile filter links will be * renumbered starting at 1. */ rank?: number; /** * Link for this profile filter link. */ selfLink?: string; } /** * A profile filter link collection lists profile filter links between * profiles and filters. Each resource in the collection corresponds to a * profile filter link. */ interface Schema$ProfileFilterLinks { /** * A list of profile filter links. */ items?: Schema$ProfileFilterLink[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1,000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this profile filter link collection. */ nextLink?: string; /** * Link to previous page for this profile filter link collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for a linked view (profile). */ interface Schema$ProfileRef { /** * Account ID to which this view (profile) belongs. */ accountId?: string; /** * Link for this view (profile). */ href?: string; /** * View (Profile) ID. */ id?: string; /** * Internal ID for the web property to which this view (profile) belongs. */ internalWebPropertyId?: string; /** * Analytics view (profile) reference. */ kind?: string; /** * Name of this view (profile). */ name?: string; /** * Web property ID of the form UA-XXXXX-YY to which this view (profile) * belongs. */ webPropertyId?: string; } /** * A view (profile) collection lists Analytics views (profiles) to which the * user has access. Each resource in the collection corresponds to a single * Analytics view (profile). */ interface Schema$Profiles { /** * A list of views (profiles). */ items?: Schema$Profile[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this view (profile) collection. */ nextLink?: string; /** * Link to previous page for this view (profile) collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for an Analytics ProfileSummary. ProfileSummary returns basic * information (i.e., summary) for a profile. */ interface Schema$ProfileSummary { /** * View (profile) ID. */ id?: string; /** * Resource type for Analytics ProfileSummary. */ kind?: string; /** * View (profile) name. */ name?: string; /** * Indicates whether this view (profile) is starred or not. */ starred?: boolean; /** * View (Profile) type. Supported types: WEB or APP. */ type?: string; } /** * Real time data for a given view (profile). */ interface Schema$RealtimeData { /** * 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<{ columnType?: string; dataType?: string; name?: string; }>; /** * Unique ID for this data response. */ id?: string; /** * Resource type. */ kind?: string; /** * Information for the view (profile), for which the real time data was * requested. */ profileInfo?: { accountId?: string; internalWebPropertyId?: string; profileId?: string; profileName?: string; tableId?: string; webPropertyId?: string; }; /** * Real time data request query parameters. */ query?: { dimensions?: string; filters?: string; ids?: string; 'max-results'?: number; metrics?: string[]; sort?: string[]; }; /** * Real time data rows, where each row contains a list of dimension values * followed by the metric values. The order of dimensions and metrics is * same as specified in the request. */ rows?: string[][]; /** * Link to this page. */ selfLink?: string; /** * The total number of rows for the query, regardless of the number of rows * in the response. */ totalResults?: number; /** * Total values for the requested metrics over all the results, not just the * results returned in this response. The order of the metric totals is same * as the metric order specified in the request. */ totalsForAllResults?: { [key: string]: string; }; } /** * JSON template for an Analytics remarketing audience. */ interface Schema$RemarketingAudience { /** * Account ID to which this remarketing audience belongs. */ accountId?: string; /** * The simple audience definition that will cause a user to be added to an * audience. */ audienceDefinition?: { includeConditions?: Schema$IncludeConditions; }; /** * The type of audience, either SIMPLE or STATE_BASED. */ audienceType?: string; /** * Time this remarketing audience was created. */ created?: string; /** * The description of this remarketing audience. */ description?: string; /** * Remarketing Audience ID. */ id?: string; /** * Internal ID for the web property to which this remarketing audience * belongs. */ internalWebPropertyId?: string; /** * Collection type. */ kind?: string; /** * The linked ad accounts associated with this remarketing audience. A * remarketing audience can have only one linkedAdAccount currently. */ linkedAdAccounts?: Schema$LinkedForeignAccount[]; /** * The views (profiles) that this remarketing audience is linked to. */ linkedViews?: string[]; /** * The name of this remarketing audience. */ name?: string; /** * A state based audience definition that will cause a user to be added or * removed from an audience. */ stateBasedAudienceDefinition?: { excludeConditions?: { exclusionDuration?: string; segment?: string; }; includeConditions?: Schema$IncludeConditions; }; /** * Time this remarketing audience was last modified. */ updated?: string; /** * Web property ID of the form UA-XXXXX-YY to which this remarketing * audience belongs. */ webPropertyId?: string; } /** * A remarketing audience collection lists Analytics remarketing audiences to * which the user has access. Each resource in the collection corresponds to a * single Analytics remarketing audience. */ interface Schema$RemarketingAudiences { /** * A list of remarketing audiences. */ items?: Schema$RemarketingAudience[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this remarketing audience collection. */ nextLink?: string; /** * Link to previous page for this view (profile) collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for an Analytics segment. */ interface Schema$Segment { /** * Time the segment was created. */ created?: string; /** * Segment definition. */ definition?: string; /** * Segment ID. */ id?: string; /** * Resource type for Analytics segment. */ kind?: string; /** * Segment name. */ name?: string; /** * Segment ID. Can be used with the 'segment' parameter in Core * Reporting API. */ segmentId?: string; /** * Link for this segment. */ selfLink?: string; /** * Type for a segment. Possible values are "BUILT_IN" or * "CUSTOM". */ type?: string; /** * Time the segment was last modified. */ updated?: string; } /** * An segment collection lists Analytics segments that the user has access to. * Each resource in the collection corresponds to a single Analytics segment. */ interface Schema$Segments { /** * A list of segments. */ items?: Schema$Segment[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type for segments. */ kind?: string; /** * Link to next page for this segment collection. */ nextLink?: string; /** * Link to previous page for this segment collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for Analytics unsampled report resource. */ interface Schema$UnsampledReport { /** * Account ID to which this unsampled report belongs. */ accountId?: string; /** * Download details for a file stored in Google Cloud Storage. */ cloudStorageDownloadDetails?: { bucketId?: string; objectId?: string; }; /** * Time this unsampled report was created. */ created?: string; /** * The dimensions for the unsampled report. */ dimensions?: string; /** * The type of download you need to use for the report data file. Possible * values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is * `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is * `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. */ downloadType?: string; /** * Download details for a file stored in Google Drive. */ driveDownloadDetails?: { documentId?: string; }; /** * The end date for the unsampled report. */ 'end-date'?: string; /** * The filters for the unsampled report. */ filters?: string; /** * Unsampled report ID. */ id?: string; /** * Resource type for an Analytics unsampled report. */ kind?: string; /** * The metrics for the unsampled report. */ metrics?: string; /** * View (Profile) ID to which this unsampled report belongs. */ profileId?: string; /** * The segment for the unsampled report. */ segment?: string; /** * Link for this unsampled report. */ selfLink?: string; /** * The start date for the unsampled report. */ 'start-date'?: string; /** * Status of this unsampled report. Possible values are PENDING, COMPLETED, * or FAILED. */ status?: string; /** * Title of the unsampled report. */ title?: string; /** * Time this unsampled report was last modified. */ updated?: string; /** * Web property ID to which this unsampled report belongs. The web property * ID is of the form UA-XXXXX-YY. */ webPropertyId?: string; } /** * An unsampled report collection lists Analytics unsampled reports to which * the user has access. Each view (profile) can have a set of unsampled * reports. Each resource in the unsampled report collection corresponds to a * single Analytics unsampled report. */ interface Schema$UnsampledReports { /** * A list of unsampled reports. */ items?: Schema$UnsampledReport[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this unsampled report collection. */ nextLink?: string; /** * Link to previous page for this unsampled report collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * resources in the result. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * Metadata returned for an upload operation. */ interface Schema$Upload { /** * Account Id to which this upload belongs. */ accountId?: string; /** * Custom data source Id to which this data import belongs. */ customDataSourceId?: string; /** * Data import errors collection. */ errors?: string[]; /** * A unique ID for this upload. */ id?: string; /** * Resource type for Analytics upload. */ kind?: string; /** * Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, * DELETED. */ status?: string; /** * Time this file is uploaded. */ uploadTime?: string; } /** * Upload collection lists Analytics uploads to which the user has access. * Each custom data source can have a set of uploads. Each resource in the * upload collection corresponds to a single Analytics data upload. */ interface Schema$Uploads { /** * A list of uploads. */ items?: Schema$Upload[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this upload collection. */ nextLink?: string; /** * Link to previous page for this upload collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * resources in the result. */ totalResults?: number; } /** * JSON template for a user deletion request resource. */ interface Schema$UserDeletionRequest { /** * This marks the point in time for which all user data before should be * deleted */ deletionRequestTime?: string; /** * Firebase Project Id */ firebaseProjectId?: string; /** * User ID. */ id?: { type?: string; userId?: string; }; /** * Value is "analytics#userDeletionRequest". */ kind?: string; /** * Web property ID of the form UA-XXXXX-YY. */ webPropertyId?: string; } /** * JSON template for a user reference. */ interface Schema$UserRef { /** * Email ID of this user. */ email?: string; /** * User ID. */ id?: string; kind?: string; } /** * A web property collection lists Analytics web properties to which the user * has access. Each resource in the collection corresponds to a single * Analytics web property. */ interface Schema$Webproperties { /** * A list of web properties. */ items?: Schema$Webproperty[]; /** * The maximum number of resources the response can contain, regardless of * the actual number of resources returned. Its value ranges from 1 to 1000 * with a value of 1000 by default, or otherwise specified by the * max-results query parameter. */ itemsPerPage?: number; /** * Collection type. */ kind?: string; /** * Link to next page for this web property collection. */ nextLink?: string; /** * Link to previous page for this web property collection. */ previousLink?: string; /** * The starting index of the resources, which is 1 by default or otherwise * specified by the start-index query parameter. */ startIndex?: number; /** * The total number of results for the query, regardless of the number of * results in the response. */ totalResults?: number; /** * Email ID of the authenticated user */ username?: string; } /** * JSON template for an Analytics web property. */ interface Schema$Webproperty { /** * Account ID to which this web property belongs. */ accountId?: string; /** * Child link for this web property. Points to the list of views (profiles) * for this web property. */ childLink?: { href?: string; type?: string; }; /** * Time this web property was created. */ created?: string; /** * Set to true to reset the retention period of the user identifier with * each new event from that user (thus setting the expiration date to * current time plus retention period). Set to false to delete data * associated with the user identifer automatically after the rentention * period. This property cannot be set on insert. */ dataRetentionResetOnNewActivity?: boolean; /** * The length of time for which user and event data is retained. This * property cannot be set on insert. */ dataRetentionTtl?: string; /** * Default view (profile) ID. */ defaultProfileId?: string; /** * Web property ID of the form UA-XXXXX-YY. */ id?: string; /** * The industry vertical/category selected for this web property. */ industryVertical?: string; /** * Internal ID for this web property. */ internalWebPropertyId?: string; /** * Resource type for Analytics WebProperty. */ kind?: string; /** * Level for this web property. Possible values are STANDARD or PREMIUM. */ level?: string; /** * Name of this web property. */ name?: string; /** * Parent link for this web property. Points to the account to which this * web property belongs. */ parentLink?: { href?: string; type?: string; }; /** * Permissions the user has for this web property. */ permissions?: { effective?: string[]; }; /** * View (Profile) count for this web property. */ profileCount?: number; /** * Link for this web property. */ selfLink?: string; /** * Indicates whether this web property is starred or not. */ starred?: boolean; /** * Time this web property was last modified. */ updated?: string; /** * Website url for this web property. */ websiteUrl?: string; } /** * JSON template for a web property reference. */ interface Schema$WebPropertyRef { /** * Account ID to which this web property belongs. */ accountId?: string; /** * Link for this web property. */ href?: string; /** * Web property ID of the form UA-XXXXX-YY. */ id?: string; /** * Internal ID for this web property. */ internalWebPropertyId?: string; /** * Analytics web property reference. */ kind?: string; /** * Name of this web property. */ name?: string; } /** * JSON template for an Analytics WebPropertySummary. WebPropertySummary * returns basic information (i.e., summary) for a web property. */ interface Schema$WebPropertySummary { /** * Web property ID of the form UA-XXXXX-YY. */ id?: string; /** * Internal ID for this web property. */ internalWebPropertyId?: string; /** * Resource type for Analytics WebPropertySummary. */ kind?: string; /** * Level for this web property. Possible values are STANDARD or PREMIUM. */ level?: string; /** * Web property name. */ name?: string; /** * List of profiles under this web property. */ profiles?: Schema$ProfileSummary[]; /** * Indicates whether this web property is starred or not. */ starred?: boolean; /** * Website url for this web property. */ websiteUrl?: string; } class Resource$Data { ga: Resource$Data$Ga; mcf: Resource$Data$Mcf; realtime: Resource$Data$Realtime; constructor(); } class Resource$Data$Ga { constructor(); /** * analytics.data.ga.get * @desc Returns Analytics data for a view (profile). * @alias analytics.data.ga.get * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.dimensions A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. * @param {string} params.end-date End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to Analytics data. * @param {string} params.ids Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. * @param {boolean=} params.include-empty-rows The response will include empty rows if this parameter is set to true, the default is true * @param {integer=} params.max-results The maximum number of entries to include in this feed. * @param {string} params.metrics A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. * @param {string=} params.output The selected format for the response. Default format is JSON. * @param {string=} params.samplingLevel The desired sampling level. * @param {string=} params.segment An Analytics segment to be applied to data. * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. * @param {string} params.start-date Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Data$Ga$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Data$Ga$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Data$Ga$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; } interface Params$Resource$Data$Ga$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * A comma-separated list of Analytics dimensions. E.g., * 'ga:browser,ga:city'. */ dimensions?: string; /** * End date for fetching Analytics data. Request can should specify an end * date formatted as YYYY-MM-DD, or as a relative date (e.g., today, * yesterday, or 7daysAgo). The default value is yesterday. */ 'end-date'?: string; /** * A comma-separated list of dimension or metric filters to be applied to * Analytics data. */ filters?: string; /** * Unique table ID for retrieving Analytics data. Table ID is of the form * ga:XXXX, where XXXX is the Analytics view (profile) ID. */ ids?: string; /** * The response will include empty rows if this parameter is set to true, * the default is true */ 'include-empty-rows'?: boolean; /** * The maximum number of entries to include in this feed. */ 'max-results'?: number; /** * A comma-separated list of Analytics metrics. E.g., * 'ga:sessions,ga:pageviews'. At least one metric must be specified. */ metrics?: string; /** * The selected format for the response. Default format is JSON. */ output?: string; /** * The desired sampling level. */ samplingLevel?: string; /** * An Analytics segment to be applied to data. */ segment?: string; /** * A comma-separated list of dimensions or metrics that determine the sort * order for Analytics data. */ sort?: string; /** * Start date for fetching Analytics data. Requests can specify a start date * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, * or 7daysAgo). The default value is 7daysAgo. */ 'start-date'?: string; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } class Resource$Data$Mcf { constructor(); /** * analytics.data.mcf.get * @desc Returns Analytics Multi-Channel Funnels data for a view (profile). * @alias analytics.data.mcf.get * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.dimensions A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. * @param {string} params.end-date End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to the Analytics data. * @param {string} params.ids Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. * @param {integer=} params.max-results The maximum number of entries to include in this feed. * @param {string} params.metrics A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. * @param {string=} params.samplingLevel The desired sampling level. * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data. * @param {string} params.start-date Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Data$Mcf$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Data$Mcf$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Data$Mcf$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; } interface Params$Resource$Data$Mcf$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * A comma-separated list of Multi-Channel Funnels dimensions. E.g., * 'mcf:source,mcf:medium'. */ dimensions?: string; /** * End date for fetching Analytics data. Requests can specify a start date * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, * or 7daysAgo). The default value is 7daysAgo. */ 'end-date'?: string; /** * A comma-separated list of dimension or metric filters to be applied to * the Analytics data. */ filters?: string; /** * Unique table ID for retrieving Analytics data. Table ID is of the form * ga:XXXX, where XXXX is the Analytics view (profile) ID. */ ids?: string; /** * The maximum number of entries to include in this feed. */ 'max-results'?: number; /** * A comma-separated list of Multi-Channel Funnels metrics. E.g., * 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must * be specified. */ metrics?: string; /** * The desired sampling level. */ samplingLevel?: string; /** * A comma-separated list of dimensions or metrics that determine the sort * order for the Analytics data. */ sort?: string; /** * Start date for fetching Analytics data. Requests can specify a start date * formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, * or 7daysAgo). The default value is 7daysAgo. */ 'start-date'?: string; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } class Resource$Data$Realtime { constructor(); /** * analytics.data.realtime.get * @desc Returns real time data for a view (profile). * @alias analytics.data.realtime.get * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.dimensions A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to real time data. * @param {string} params.ids Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. * @param {integer=} params.max-results The maximum number of entries to include in this feed. * @param {string} params.metrics A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified. * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for real time data. * @param {object} [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$Data$Realtime$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Data$Realtime$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Data$Realtime$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; } interface Params$Resource$Data$Realtime$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * A comma-separated list of real time dimensions. E.g., * 'rt:medium,rt:city'. */ dimensions?: string; /** * A comma-separated list of dimension or metric filters to be applied to * real time data. */ filters?: string; /** * Unique table ID for retrieving real time data. Table ID is of the form * ga:XXXX, where XXXX is the Analytics view (profile) ID. */ ids?: string; /** * The maximum number of entries to include in this feed. */ 'max-results'?: number; /** * A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At * least one metric must be specified. */ metrics?: string; /** * A comma-separated list of dimensions or metrics that determine the sort * order for real time data. */ sort?: string; } class Resource$Management { accounts: Resource$Management$Accounts; accountSummaries: Resource$Management$Accountsummaries; accountUserLinks: Resource$Management$Accountuserlinks; clientId: Resource$Management$Clientid; customDataSources: Resource$Management$Customdatasources; customDimensions: Resource$Management$Customdimensions; customMetrics: Resource$Management$Custommetrics; experiments: Resource$Management$Experiments; filters: Resource$Management$Filters; goals: Resource$Management$Goals; profileFilterLinks: Resource$Management$Profilefilterlinks; profiles: Resource$Management$Profiles; profileUserLinks: Resource$Management$Profileuserlinks; remarketingAudience: Resource$Management$Remarketingaudience; segments: Resource$Management$Segments; unsampledReports: Resource$Management$Unsampledreports; uploads: Resource$Management$Uploads; webproperties: Resource$Management$Webproperties; webPropertyAdWordsLinks: Resource$Management$Webpropertyadwordslinks; webpropertyUserLinks: Resource$Management$Webpropertyuserlinks; constructor(); } class Resource$Management$Accounts { constructor(); /** * analytics.management.accounts.list * @desc Lists all accounts to which the user has access. * @alias analytics.management.accounts.list * @memberOf! () * * @param {object=} params Parameters for request * @param {integer=} params.max-results The maximum number of accounts to include in this response. * @param {integer=} params.start-index An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Management$Accounts$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Accounts$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Accounts$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Accounts$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The maximum number of accounts to include in this response. */ 'max-results'?: number; /** * An index of the first account to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } class Resource$Management$Accountsummaries { constructor(); /** * analytics.management.accountSummaries.list * @desc Lists account summaries (lightweight tree comprised of * accounts/properties/profiles) to which the user has access. * @alias analytics.management.accountSummaries.list * @memberOf! () * * @param {object=} params Parameters for request * @param {integer=} params.max-results The maximum number of account summaries to include in this response, where the largest acceptable value is 1000. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Management$Accountsummaries$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Accountsummaries$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Accountsummaries$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Accountsummaries$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The maximum number of account summaries to include in this response, * where the largest acceptable value is 1000. */ 'max-results'?: number; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } class Resource$Management$Accountuserlinks { constructor(); /** * analytics.management.accountUserLinks.delete * @desc Removes a user from the given account. * @alias analytics.management.accountUserLinks.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the user link for. * @param {string} params.linkId Link ID to delete the user link for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Management$Accountuserlinks$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Accountuserlinks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Accountuserlinks$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.accountUserLinks.insert * @desc Adds a new user to the given account. * @alias analytics.management.accountUserLinks.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the user link for. * @param {().EntityUserLink} params.resource Request body data * @param {object} [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$Management$Accountuserlinks$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Accountuserlinks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Accountuserlinks$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.accountUserLinks.list * @desc Lists account-user links for a given account. * @alias analytics.management.accountUserLinks.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve the user links for. * @param {integer=} params.max-results The maximum number of account-user links to include in this response. * @param {integer=} params.start-index An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Management$Accountuserlinks$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Accountuserlinks$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Accountuserlinks$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.accountUserLinks.update * @desc Updates permissions for an existing user on the given account. * @alias analytics.management.accountUserLinks.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to update the account-user link for. * @param {string} params.linkId Link ID to update the account-user link for. * @param {().EntityUserLink} params.resource Request body data * @param {object} [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$Management$Accountuserlinks$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Accountuserlinks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Accountuserlinks$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Accountuserlinks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to delete the user link for. */ accountId?: string; /** * Link ID to delete the user link for. */ linkId?: string; } interface Params$Resource$Management$Accountuserlinks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the user link for. */ accountId?: string; /** * Request body metadata */ requestBody?: Schema$EntityUserLink; } interface Params$Resource$Management$Accountuserlinks$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve the user links for. */ accountId?: string; /** * The maximum number of account-user links to include in this response. */ 'max-results'?: number; /** * An index of the first account-user link to retrieve. Use this parameter * as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } interface Params$Resource$Management$Accountuserlinks$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to update the account-user link for. */ accountId?: string; /** * Link ID to update the account-user link for. */ linkId?: string; /** * Request body metadata */ requestBody?: Schema$EntityUserLink; } class Resource$Management$Clientid { constructor(); /** * analytics.management.clientId.hashClientId * @desc Hashes the given Client ID. * @alias analytics.management.clientId.hashClientId * @memberOf! () * * @param {object} params Parameters for request * @param {().HashClientIdRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ hashClientId(params?: Params$Resource$Management$Clientid$Hashclientid, options?: MethodOptions): GaxiosPromise; hashClientId(params: Params$Resource$Management$Clientid$Hashclientid, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; hashClientId(params: Params$Resource$Management$Clientid$Hashclientid, callback: BodyResponseCallback): void; hashClientId(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Clientid$Hashclientid extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$HashClientIdRequest; } class Resource$Management$Customdatasources { constructor(); /** * analytics.management.customDataSources.list * @desc List custom data sources to which the user has access. * @alias analytics.management.customDataSources.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account Id for the custom data sources to retrieve. * @param {integer=} params.max-results The maximum number of custom data sources to include in this response. * @param {integer=} params.start-index A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property Id for the custom data sources to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Management$Customdatasources$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Customdatasources$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Customdatasources$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Customdatasources$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account Id for the custom data sources to retrieve. */ accountId?: string; /** * The maximum number of custom data sources to include in this response. */ 'max-results'?: number; /** * A 1-based index of the first custom data source to retrieve. Use this * parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property Id for the custom data sources to retrieve. */ webPropertyId?: string; } class Resource$Management$Customdimensions { constructor(); /** * analytics.management.customDimensions.get * @desc Get a custom dimension to which the user has access. * @alias analytics.management.customDimensions.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom dimension to retrieve. * @param {string} params.customDimensionId The ID of the custom dimension to retrieve. * @param {string} params.webPropertyId Web property ID for the custom dimension 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$Management$Customdimensions$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Customdimensions$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Customdimensions$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.customDimensions.insert * @desc Create a new custom dimension. * @alias analytics.management.customDimensions.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom dimension to create. * @param {string} params.webPropertyId Web property ID for the custom dimension to create. * @param {().CustomDimension} params.resource Request body data * @param {object} [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$Management$Customdimensions$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Customdimensions$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Customdimensions$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.customDimensions.list * @desc Lists custom dimensions to which the user has access. * @alias analytics.management.customDimensions.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom dimensions to retrieve. * @param {integer=} params.max-results The maximum number of custom dimensions to include in this response. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property ID for the custom dimensions to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Management$Customdimensions$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Customdimensions$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Customdimensions$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.customDimensions.patch * @desc Updates an existing custom dimension. This method supports patch * semantics. * @alias analytics.management.customDimensions.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom dimension to update. * @param {string} params.customDimensionId Custom dimension ID for the custom dimension to update. * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. * @param {string} params.webPropertyId Web property ID for the custom dimension to update. * @param {().CustomDimension} params.resource Request body data * @param {object} [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$Management$Customdimensions$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Customdimensions$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Customdimensions$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.customDimensions.update * @desc Updates an existing custom dimension. * @alias analytics.management.customDimensions.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom dimension to update. * @param {string} params.customDimensionId Custom dimension ID for the custom dimension to update. * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. * @param {string} params.webPropertyId Web property ID for the custom dimension to update. * @param {().CustomDimension} params.resource Request body data * @param {object} [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$Management$Customdimensions$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Customdimensions$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Customdimensions$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Customdimensions$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom dimension to retrieve. */ accountId?: string; /** * The ID of the custom dimension to retrieve. */ customDimensionId?: string; /** * Web property ID for the custom dimension to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Customdimensions$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom dimension to create. */ accountId?: string; /** * Web property ID for the custom dimension to create. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$CustomDimension; } interface Params$Resource$Management$Customdimensions$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom dimensions to retrieve. */ accountId?: string; /** * The maximum number of custom dimensions to include in this response. */ 'max-results'?: number; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property ID for the custom dimensions to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Customdimensions$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom dimension to update. */ accountId?: string; /** * Custom dimension ID for the custom dimension to update. */ customDimensionId?: string; /** * Force the update and ignore any warnings related to the custom dimension * being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** * Web property ID for the custom dimension to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$CustomDimension; } interface Params$Resource$Management$Customdimensions$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom dimension to update. */ accountId?: string; /** * Custom dimension ID for the custom dimension to update. */ customDimensionId?: string; /** * Force the update and ignore any warnings related to the custom dimension * being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** * Web property ID for the custom dimension to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$CustomDimension; } class Resource$Management$Custommetrics { constructor(); /** * analytics.management.customMetrics.get * @desc Get a custom metric to which the user has access. * @alias analytics.management.customMetrics.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom metric to retrieve. * @param {string} params.customMetricId The ID of the custom metric to retrieve. * @param {string} params.webPropertyId Web property ID for the custom metric 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$Management$Custommetrics$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Custommetrics$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Custommetrics$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.customMetrics.insert * @desc Create a new custom metric. * @alias analytics.management.customMetrics.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom metric to create. * @param {string} params.webPropertyId Web property ID for the custom dimension to create. * @param {().CustomMetric} params.resource Request body data * @param {object} [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$Management$Custommetrics$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Custommetrics$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Custommetrics$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.customMetrics.list * @desc Lists custom metrics to which the user has access. * @alias analytics.management.customMetrics.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom metrics to retrieve. * @param {integer=} params.max-results The maximum number of custom metrics to include in this response. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property ID for the custom metrics to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Management$Custommetrics$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Custommetrics$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Custommetrics$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.customMetrics.patch * @desc Updates an existing custom metric. This method supports patch * semantics. * @alias analytics.management.customMetrics.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom metric to update. * @param {string} params.customMetricId Custom metric ID for the custom metric to update. * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. * @param {string} params.webPropertyId Web property ID for the custom metric to update. * @param {().CustomMetric} params.resource Request body data * @param {object} [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$Management$Custommetrics$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Custommetrics$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Custommetrics$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.customMetrics.update * @desc Updates an existing custom metric. * @alias analytics.management.customMetrics.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the custom metric to update. * @param {string} params.customMetricId Custom metric ID for the custom metric to update. * @param {boolean=} params.ignoreCustomDataSourceLinks Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. * @param {string} params.webPropertyId Web property ID for the custom metric to update. * @param {().CustomMetric} params.resource Request body data * @param {object} [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$Management$Custommetrics$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Custommetrics$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Custommetrics$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Custommetrics$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom metric to retrieve. */ accountId?: string; /** * The ID of the custom metric to retrieve. */ customMetricId?: string; /** * Web property ID for the custom metric to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Custommetrics$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom metric to create. */ accountId?: string; /** * Web property ID for the custom dimension to create. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$CustomMetric; } interface Params$Resource$Management$Custommetrics$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom metrics to retrieve. */ accountId?: string; /** * The maximum number of custom metrics to include in this response. */ 'max-results'?: number; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property ID for the custom metrics to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Custommetrics$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom metric to update. */ accountId?: string; /** * Custom metric ID for the custom metric to update. */ customMetricId?: string; /** * Force the update and ignore any warnings related to the custom metric * being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** * Web property ID for the custom metric to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$CustomMetric; } interface Params$Resource$Management$Custommetrics$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the custom metric to update. */ accountId?: string; /** * Custom metric ID for the custom metric to update. */ customMetricId?: string; /** * Force the update and ignore any warnings related to the custom metric * being linked to a custom data source / data set. */ ignoreCustomDataSourceLinks?: boolean; /** * Web property ID for the custom metric to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$CustomMetric; } class Resource$Management$Experiments { constructor(); /** * analytics.management.experiments.delete * @desc Delete an experiment. * @alias analytics.management.experiments.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the experiment belongs * @param {string} params.experimentId ID of the experiment to delete * @param {string} params.profileId View (Profile) ID to which the experiment belongs * @param {string} params.webPropertyId Web property ID to which the experiment belongs * @param {object} [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$Management$Experiments$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Experiments$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Experiments$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.experiments.get * @desc Returns an experiment to which the user has access. * @alias analytics.management.experiments.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve the experiment for. * @param {string} params.experimentId Experiment ID to retrieve the experiment for. * @param {string} params.profileId View (Profile) ID to retrieve the experiment for. * @param {string} params.webPropertyId Web property ID to retrieve the experiment for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Experiments$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Experiments$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Experiments$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.experiments.insert * @desc Create a new experiment. * @alias analytics.management.experiments.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the experiment for. * @param {string} params.profileId View (Profile) ID to create the experiment for. * @param {string} params.webPropertyId Web property ID to create the experiment for. * @param {().Experiment} params.resource Request body data * @param {object} [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$Management$Experiments$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Experiments$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Experiments$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.experiments.list * @desc Lists experiments to which the user has access. * @alias analytics.management.experiments.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve experiments for. * @param {integer=} params.max-results The maximum number of experiments to include in this response. * @param {string} params.profileId View (Profile) ID to retrieve experiments for. * @param {integer=} params.start-index An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property ID to retrieve experiments for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Management$Experiments$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Experiments$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Experiments$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.experiments.patch * @desc Update an existing experiment. This method supports patch * semantics. * @alias analytics.management.experiments.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID of the experiment to update. * @param {string} params.experimentId Experiment ID of the experiment to update. * @param {string} params.profileId View (Profile) ID of the experiment to update. * @param {string} params.webPropertyId Web property ID of the experiment to update. * @param {().Experiment} params.resource Request body data * @param {object} [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$Management$Experiments$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Experiments$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Experiments$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.experiments.update * @desc Update an existing experiment. * @alias analytics.management.experiments.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID of the experiment to update. * @param {string} params.experimentId Experiment ID of the experiment to update. * @param {string} params.profileId View (Profile) ID of the experiment to update. * @param {string} params.webPropertyId Web property ID of the experiment to update. * @param {().Experiment} params.resource Request body data * @param {object} [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$Management$Experiments$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Experiments$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Experiments$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Experiments$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the experiment belongs */ accountId?: string; /** * ID of the experiment to delete */ experimentId?: string; /** * View (Profile) ID to which the experiment belongs */ profileId?: string; /** * Web property ID to which the experiment belongs */ webPropertyId?: string; } interface Params$Resource$Management$Experiments$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve the experiment for. */ accountId?: string; /** * Experiment ID to retrieve the experiment for. */ experimentId?: string; /** * View (Profile) ID to retrieve the experiment for. */ profileId?: string; /** * Web property ID to retrieve the experiment for. */ webPropertyId?: string; } interface Params$Resource$Management$Experiments$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the experiment for. */ accountId?: string; /** * View (Profile) ID to create the experiment for. */ profileId?: string; /** * Web property ID to create the experiment for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Experiment; } interface Params$Resource$Management$Experiments$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve experiments for. */ accountId?: string; /** * The maximum number of experiments to include in this response. */ 'max-results'?: number; /** * View (Profile) ID to retrieve experiments for. */ profileId?: string; /** * An index of the first experiment to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property ID to retrieve experiments for. */ webPropertyId?: string; } interface Params$Resource$Management$Experiments$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID of the experiment to update. */ accountId?: string; /** * Experiment ID of the experiment to update. */ experimentId?: string; /** * View (Profile) ID of the experiment to update. */ profileId?: string; /** * Web property ID of the experiment to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Experiment; } interface Params$Resource$Management$Experiments$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID of the experiment to update. */ accountId?: string; /** * Experiment ID of the experiment to update. */ experimentId?: string; /** * View (Profile) ID of the experiment to update. */ profileId?: string; /** * Web property ID of the experiment to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Experiment; } class Resource$Management$Filters { constructor(); /** * analytics.management.filters.delete * @desc Delete a filter. * @alias analytics.management.filters.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the filter for. * @param {string} params.filterId ID of the filter 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$Management$Filters$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Filters$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Filters$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.filters.get * @desc Returns a filters to which the user has access. * @alias analytics.management.filters.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve filters for. * @param {string} params.filterId Filter ID to retrieve filters for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Filters$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Filters$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Filters$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.filters.insert * @desc Create a new filter. * @alias analytics.management.filters.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create filter for. * @param {().Filter} params.resource Request body data * @param {object} [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$Management$Filters$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Filters$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Filters$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.filters.list * @desc Lists all filters for an account * @alias analytics.management.filters.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve filters for. * @param {integer=} params.max-results The maximum number of filters to include in this response. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Management$Filters$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Filters$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Filters$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.filters.patch * @desc Updates an existing filter. This method supports patch semantics. * @alias analytics.management.filters.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the filter belongs. * @param {string} params.filterId ID of the filter to be updated. * @param {().Filter} params.resource Request body data * @param {object} [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$Management$Filters$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Filters$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Filters$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.filters.update * @desc Updates an existing filter. * @alias analytics.management.filters.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the filter belongs. * @param {string} params.filterId ID of the filter to be updated. * @param {().Filter} params.resource Request body data * @param {object} [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$Management$Filters$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Filters$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Filters$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Filters$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to delete the filter for. */ accountId?: string; /** * ID of the filter to be deleted. */ filterId?: string; } interface Params$Resource$Management$Filters$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve filters for. */ accountId?: string; /** * Filter ID to retrieve filters for. */ filterId?: string; } interface Params$Resource$Management$Filters$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create filter for. */ accountId?: string; /** * Request body metadata */ requestBody?: Schema$Filter; } interface Params$Resource$Management$Filters$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve filters for. */ accountId?: string; /** * The maximum number of filters to include in this response. */ 'max-results'?: number; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } interface Params$Resource$Management$Filters$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the filter belongs. */ accountId?: string; /** * ID of the filter to be updated. */ filterId?: string; /** * Request body metadata */ requestBody?: Schema$Filter; } interface Params$Resource$Management$Filters$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the filter belongs. */ accountId?: string; /** * ID of the filter to be updated. */ filterId?: string; /** * Request body metadata */ requestBody?: Schema$Filter; } class Resource$Management$Goals { constructor(); /** * analytics.management.goals.get * @desc Gets a goal to which the user has access. * @alias analytics.management.goals.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve the goal for. * @param {string} params.goalId Goal ID to retrieve the goal for. * @param {string} params.profileId View (Profile) ID to retrieve the goal for. * @param {string} params.webPropertyId Web property ID to retrieve the goal for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Goals$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Goals$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Goals$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.goals.insert * @desc Create a new goal. * @alias analytics.management.goals.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the goal for. * @param {string} params.profileId View (Profile) ID to create the goal for. * @param {string} params.webPropertyId Web property ID to create the goal for. * @param {().Goal} params.resource Request body data * @param {object} [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$Management$Goals$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Goals$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Goals$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.goals.list * @desc Lists goals to which the user has access. * @alias analytics.management.goals.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. * @param {integer=} params.max-results The maximum number of goals to include in this response. * @param {string} params.profileId View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. * @param {integer=} params.start-index An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. * @param {object} [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$Management$Goals$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Goals$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Goals$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.goals.patch * @desc Updates an existing goal. This method supports patch semantics. * @alias analytics.management.goals.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to update the goal. * @param {string} params.goalId Index of the goal to be updated. * @param {string} params.profileId View (Profile) ID to update the goal. * @param {string} params.webPropertyId Web property ID to update the goal. * @param {().Goal} params.resource Request body data * @param {object} [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$Management$Goals$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Goals$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Goals$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.goals.update * @desc Updates an existing goal. * @alias analytics.management.goals.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to update the goal. * @param {string} params.goalId Index of the goal to be updated. * @param {string} params.profileId View (Profile) ID to update the goal. * @param {string} params.webPropertyId Web property ID to update the goal. * @param {().Goal} params.resource Request body data * @param {object} [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$Management$Goals$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Goals$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Goals$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Goals$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve the goal for. */ accountId?: string; /** * Goal ID to retrieve the goal for. */ goalId?: string; /** * View (Profile) ID to retrieve the goal for. */ profileId?: string; /** * Web property ID to retrieve the goal for. */ webPropertyId?: string; } interface Params$Resource$Management$Goals$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the goal for. */ accountId?: string; /** * View (Profile) ID to create the goal for. */ profileId?: string; /** * Web property ID to create the goal for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Goal; } interface Params$Resource$Management$Goals$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve goals for. Can either be a specific account ID or * '~all', which refers to all the accounts that user has access to. */ accountId?: string; /** * The maximum number of goals to include in this response. */ 'max-results'?: number; /** * View (Profile) ID to retrieve goals for. Can either be a specific view * (profile) ID or '~all', which refers to all the views (profiles) that * user has access to. */ profileId?: string; /** * An index of the first goal to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property ID to retrieve goals for. Can either be a specific web * property ID or '~all', which refers to all the web properties that user * has access to. */ webPropertyId?: string; } interface Params$Resource$Management$Goals$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to update the goal. */ accountId?: string; /** * Index of the goal to be updated. */ goalId?: string; /** * View (Profile) ID to update the goal. */ profileId?: string; /** * Web property ID to update the goal. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Goal; } interface Params$Resource$Management$Goals$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to update the goal. */ accountId?: string; /** * Index of the goal to be updated. */ goalId?: string; /** * View (Profile) ID to update the goal. */ profileId?: string; /** * Web property ID to update the goal. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Goal; } class Resource$Management$Profilefilterlinks { constructor(); /** * analytics.management.profileFilterLinks.delete * @desc Delete a profile filter link. * @alias analytics.management.profileFilterLinks.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the profile filter link belongs. * @param {string} params.linkId ID of the profile filter link to delete. * @param {string} params.profileId Profile ID to which the filter link belongs. * @param {string} params.webPropertyId Web property Id to which the profile filter link belongs. * @param {object} [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$Management$Profilefilterlinks$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Profilefilterlinks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Profilefilterlinks$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.profileFilterLinks.get * @desc Returns a single profile filter link. * @alias analytics.management.profileFilterLinks.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve profile filter link for. * @param {string} params.linkId ID of the profile filter link. * @param {string} params.profileId Profile ID to retrieve filter link for. * @param {string} params.webPropertyId Web property Id to retrieve profile filter link for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Profilefilterlinks$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Profilefilterlinks$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Profilefilterlinks$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.profileFilterLinks.insert * @desc Create a new profile filter link. * @alias analytics.management.profileFilterLinks.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create profile filter link for. * @param {string} params.profileId Profile ID to create filter link for. * @param {string} params.webPropertyId Web property Id to create profile filter link for. * @param {().ProfileFilterLink} params.resource Request body data * @param {object} [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$Management$Profilefilterlinks$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Profilefilterlinks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Profilefilterlinks$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.profileFilterLinks.list * @desc Lists all profile filter links for a profile. * @alias analytics.management.profileFilterLinks.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve profile filter links for. * @param {integer=} params.max-results The maximum number of profile filter links to include in this response. * @param {string} params.profileId Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. * @param {object} [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$Management$Profilefilterlinks$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Profilefilterlinks$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Profilefilterlinks$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.profileFilterLinks.patch * @desc Update an existing profile filter link. This method supports patch * semantics. * @alias analytics.management.profileFilterLinks.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which profile filter link belongs. * @param {string} params.linkId ID of the profile filter link to be updated. * @param {string} params.profileId Profile ID to which filter link belongs * @param {string} params.webPropertyId Web property Id to which profile filter link belongs * @param {().ProfileFilterLink} params.resource Request body data * @param {object} [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$Management$Profilefilterlinks$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Profilefilterlinks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Profilefilterlinks$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.profileFilterLinks.update * @desc Update an existing profile filter link. * @alias analytics.management.profileFilterLinks.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which profile filter link belongs. * @param {string} params.linkId ID of the profile filter link to be updated. * @param {string} params.profileId Profile ID to which filter link belongs * @param {string} params.webPropertyId Web property Id to which profile filter link belongs * @param {().ProfileFilterLink} params.resource Request body data * @param {object} [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$Management$Profilefilterlinks$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Profilefilterlinks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Profilefilterlinks$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Profilefilterlinks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the profile filter link belongs. */ accountId?: string; /** * ID of the profile filter link to delete. */ linkId?: string; /** * Profile ID to which the filter link belongs. */ profileId?: string; /** * Web property Id to which the profile filter link belongs. */ webPropertyId?: string; } interface Params$Resource$Management$Profilefilterlinks$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve profile filter link for. */ accountId?: string; /** * ID of the profile filter link. */ linkId?: string; /** * Profile ID to retrieve filter link for. */ profileId?: string; /** * Web property Id to retrieve profile filter link for. */ webPropertyId?: string; } interface Params$Resource$Management$Profilefilterlinks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create profile filter link for. */ accountId?: string; /** * Profile ID to create filter link for. */ profileId?: string; /** * Web property Id to create profile filter link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$ProfileFilterLink; } interface Params$Resource$Management$Profilefilterlinks$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve profile filter links for. */ accountId?: string; /** * The maximum number of profile filter links to include in this response. */ 'max-results'?: number; /** * Profile ID to retrieve filter links for. Can either be a specific profile * ID or '~all', which refers to all the profiles that user has access to. */ profileId?: string; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property Id for profile filter links for. Can either be a specific * web property ID or '~all', which refers to all the web properties that * user has access to. */ webPropertyId?: string; } interface Params$Resource$Management$Profilefilterlinks$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which profile filter link belongs. */ accountId?: string; /** * ID of the profile filter link to be updated. */ linkId?: string; /** * Profile ID to which filter link belongs */ profileId?: string; /** * Web property Id to which profile filter link belongs */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$ProfileFilterLink; } interface Params$Resource$Management$Profilefilterlinks$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which profile filter link belongs. */ accountId?: string; /** * ID of the profile filter link to be updated. */ linkId?: string; /** * Profile ID to which filter link belongs */ profileId?: string; /** * Web property Id to which profile filter link belongs */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$ProfileFilterLink; } class Resource$Management$Profiles { constructor(); /** * analytics.management.profiles.delete * @desc Deletes a view (profile). * @alias analytics.management.profiles.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the view (profile) for. * @param {string} params.profileId ID of the view (profile) to be deleted. * @param {string} params.webPropertyId Web property ID to delete the view (profile) for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Management$Profiles$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Profiles$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Profiles$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.profiles.get * @desc Gets a view (profile) to which the user has access. * @alias analytics.management.profiles.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve the view (profile) for. * @param {string} params.profileId View (Profile) ID to retrieve the view (profile) for. * @param {string} params.webPropertyId Web property ID to retrieve the view (profile) for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Profiles$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Profiles$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Profiles$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.profiles.insert * @desc Create a new view (profile). * @alias analytics.management.profiles.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the view (profile) for. * @param {string} params.webPropertyId Web property ID to create the view (profile) for. * @param {().Profile} params.resource Request body data * @param {object} [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$Management$Profiles$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Profiles$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Profiles$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.profiles.list * @desc Lists views (profiles) to which the user has access. * @alias analytics.management.profiles.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. * @param {integer=} params.max-results The maximum number of views (profiles) to include in this response. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. * @param {object} [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$Management$Profiles$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Profiles$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Profiles$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.profiles.patch * @desc Updates an existing view (profile). This method supports patch * semantics. * @alias analytics.management.profiles.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the view (profile) belongs * @param {string} params.profileId ID of the view (profile) to be updated. * @param {string} params.webPropertyId Web property ID to which the view (profile) belongs * @param {().Profile} params.resource Request body data * @param {object} [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$Management$Profiles$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Profiles$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Profiles$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.profiles.update * @desc Updates an existing view (profile). * @alias analytics.management.profiles.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the view (profile) belongs * @param {string} params.profileId ID of the view (profile) to be updated. * @param {string} params.webPropertyId Web property ID to which the view (profile) belongs * @param {().Profile} params.resource Request body data * @param {object} [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$Management$Profiles$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Profiles$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Profiles$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Profiles$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to delete the view (profile) for. */ accountId?: string; /** * ID of the view (profile) to be deleted. */ profileId?: string; /** * Web property ID to delete the view (profile) for. */ webPropertyId?: string; } interface Params$Resource$Management$Profiles$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve the view (profile) for. */ accountId?: string; /** * View (Profile) ID to retrieve the view (profile) for. */ profileId?: string; /** * Web property ID to retrieve the view (profile) for. */ webPropertyId?: string; } interface Params$Resource$Management$Profiles$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the view (profile) for. */ accountId?: string; /** * Web property ID to create the view (profile) for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Profile; } interface Params$Resource$Management$Profiles$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID for the view (profiles) to retrieve. Can either be a specific * account ID or '~all', which refers to all the accounts to which the user * has access. */ accountId?: string; /** * The maximum number of views (profiles) to include in this response. */ 'max-results'?: number; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property ID for the views (profiles) to retrieve. Can either be a * specific web property ID or '~all', which refers to all the web * properties to which the user has access. */ webPropertyId?: string; } interface Params$Resource$Management$Profiles$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the view (profile) belongs */ accountId?: string; /** * ID of the view (profile) to be updated. */ profileId?: string; /** * Web property ID to which the view (profile) belongs */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Profile; } interface Params$Resource$Management$Profiles$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the view (profile) belongs */ accountId?: string; /** * ID of the view (profile) to be updated. */ profileId?: string; /** * Web property ID to which the view (profile) belongs */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Profile; } class Resource$Management$Profileuserlinks { constructor(); /** * analytics.management.profileUserLinks.delete * @desc Removes a user from the given view (profile). * @alias analytics.management.profileUserLinks.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the user link for. * @param {string} params.linkId Link ID to delete the user link for. * @param {string} params.profileId View (Profile) ID to delete the user link for. * @param {string} params.webPropertyId Web Property ID to delete the user link for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Management$Profileuserlinks$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Profileuserlinks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Profileuserlinks$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.profileUserLinks.insert * @desc Adds a new user to the given view (profile). * @alias analytics.management.profileUserLinks.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the user link for. * @param {string} params.profileId View (Profile) ID to create the user link for. * @param {string} params.webPropertyId Web Property ID to create the user link for. * @param {().EntityUserLink} params.resource Request body data * @param {object} [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$Management$Profileuserlinks$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Profileuserlinks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Profileuserlinks$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.profileUserLinks.list * @desc Lists profile-user links for a given view (profile). * @alias analytics.management.profileUserLinks.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID which the given view (profile) belongs to. * @param {integer=} params.max-results The maximum number of profile-user links to include in this response. * @param {string} params.profileId View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. * @param {integer=} params.start-index An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. * @param {object} [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$Management$Profileuserlinks$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Profileuserlinks$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Profileuserlinks$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.profileUserLinks.update * @desc Updates permissions for an existing user on the given view * (profile). * @alias analytics.management.profileUserLinks.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to update the user link for. * @param {string} params.linkId Link ID to update the user link for. * @param {string} params.profileId View (Profile ID) to update the user link for. * @param {string} params.webPropertyId Web Property ID to update the user link for. * @param {().EntityUserLink} params.resource Request body data * @param {object} [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$Management$Profileuserlinks$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Profileuserlinks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Profileuserlinks$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Profileuserlinks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to delete the user link for. */ accountId?: string; /** * Link ID to delete the user link for. */ linkId?: string; /** * View (Profile) ID to delete the user link for. */ profileId?: string; /** * Web Property ID to delete the user link for. */ webPropertyId?: string; } interface Params$Resource$Management$Profileuserlinks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the user link for. */ accountId?: string; /** * View (Profile) ID to create the user link for. */ profileId?: string; /** * Web Property ID to create the user link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$EntityUserLink; } interface Params$Resource$Management$Profileuserlinks$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID which the given view (profile) belongs to. */ accountId?: string; /** * The maximum number of profile-user links to include in this response. */ 'max-results'?: number; /** * View (Profile) ID to retrieve the profile-user links for. Can either be a * specific profile ID or '~all', which refers to all the profiles that user * has access to. */ profileId?: string; /** * An index of the first profile-user link to retrieve. Use this parameter * as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web Property ID which the given view (profile) belongs to. Can either be * a specific web property ID or '~all', which refers to all the web * properties that user has access to. */ webPropertyId?: string; } interface Params$Resource$Management$Profileuserlinks$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to update the user link for. */ accountId?: string; /** * Link ID to update the user link for. */ linkId?: string; /** * View (Profile ID) to update the user link for. */ profileId?: string; /** * Web Property ID to update the user link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$EntityUserLink; } class Resource$Management$Remarketingaudience { constructor(); /** * analytics.management.remarketingAudience.delete * @desc Delete a remarketing audience. * @alias analytics.management.remarketingAudience.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the remarketing audience belongs. * @param {string} params.remarketingAudienceId The ID of the remarketing audience to delete. * @param {string} params.webPropertyId Web property ID to which the remarketing audience belongs. * @param {object} [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$Management$Remarketingaudience$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Remarketingaudience$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Remarketingaudience$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.remarketingAudience.get * @desc Gets a remarketing audience to which the user has access. * @alias analytics.management.remarketingAudience.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId The account ID of the remarketing audience to retrieve. * @param {string} params.remarketingAudienceId The ID of the remarketing audience to retrieve. * @param {string} params.webPropertyId The web property ID of the remarketing audience 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$Management$Remarketingaudience$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Remarketingaudience$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Remarketingaudience$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.remarketingAudience.insert * @desc Creates a new remarketing audience. * @alias analytics.management.remarketingAudience.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId The account ID for which to create the remarketing audience. * @param {string} params.webPropertyId Web property ID for which to create the remarketing audience. * @param {().RemarketingAudience} params.resource Request body data * @param {object} [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$Management$Remarketingaudience$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Remarketingaudience$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Remarketingaudience$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.remarketingAudience.list * @desc Lists remarketing audiences to which the user has access. * @alias analytics.management.remarketingAudience.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId The account ID of the remarketing audiences to retrieve. * @param {integer=} params.max-results The maximum number of remarketing audiences to include in this response. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string=} params.type * @param {string} params.webPropertyId The web property ID of the remarketing audiences to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Management$Remarketingaudience$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Remarketingaudience$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Remarketingaudience$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.remarketingAudience.patch * @desc Updates an existing remarketing audience. This method supports * patch semantics. * @alias analytics.management.remarketingAudience.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId The account ID of the remarketing audience to update. * @param {string} params.remarketingAudienceId The ID of the remarketing audience to update. * @param {string} params.webPropertyId The web property ID of the remarketing audience to update. * @param {().RemarketingAudience} params.resource Request body data * @param {object} [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$Management$Remarketingaudience$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Remarketingaudience$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Remarketingaudience$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.remarketingAudience.update * @desc Updates an existing remarketing audience. * @alias analytics.management.remarketingAudience.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId The account ID of the remarketing audience to update. * @param {string} params.remarketingAudienceId The ID of the remarketing audience to update. * @param {string} params.webPropertyId The web property ID of the remarketing audience to update. * @param {().RemarketingAudience} params.resource Request body data * @param {object} [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$Management$Remarketingaudience$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Remarketingaudience$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Remarketingaudience$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Remarketingaudience$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the remarketing audience belongs. */ accountId?: string; /** * The ID of the remarketing audience to delete. */ remarketingAudienceId?: string; /** * Web property ID to which the remarketing audience belongs. */ webPropertyId?: string; } interface Params$Resource$Management$Remarketingaudience$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The account ID of the remarketing audience to retrieve. */ accountId?: string; /** * The ID of the remarketing audience to retrieve. */ remarketingAudienceId?: string; /** * The web property ID of the remarketing audience to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Remarketingaudience$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The account ID for which to create the remarketing audience. */ accountId?: string; /** * Web property ID for which to create the remarketing audience. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$RemarketingAudience; } interface Params$Resource$Management$Remarketingaudience$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The account ID of the remarketing audiences to retrieve. */ accountId?: string; /** * The maximum number of remarketing audiences to include in this response. */ 'max-results'?: number; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * */ type?: string; /** * The web property ID of the remarketing audiences to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Remarketingaudience$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The account ID of the remarketing audience to update. */ accountId?: string; /** * The ID of the remarketing audience to update. */ remarketingAudienceId?: string; /** * The web property ID of the remarketing audience to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$RemarketingAudience; } interface Params$Resource$Management$Remarketingaudience$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The account ID of the remarketing audience to update. */ accountId?: string; /** * The ID of the remarketing audience to update. */ remarketingAudienceId?: string; /** * The web property ID of the remarketing audience to update. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$RemarketingAudience; } class Resource$Management$Segments { constructor(); /** * analytics.management.segments.list * @desc Lists segments to which the user has access. * @alias analytics.management.segments.list * @memberOf! () * * @param {object=} params Parameters for request * @param {integer=} params.max-results The maximum number of segments to include in this response. * @param {integer=} params.start-index An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Management$Segments$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Segments$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Segments$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Segments$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The maximum number of segments to include in this response. */ 'max-results'?: number; /** * An index of the first segment to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } class Resource$Management$Unsampledreports { constructor(); /** * analytics.management.unsampledReports.delete * @desc Deletes an unsampled report. * @alias analytics.management.unsampledReports.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the unsampled report for. * @param {string} params.profileId View (Profile) ID to delete the unsampled report for. * @param {string} params.unsampledReportId ID of the unsampled report to be deleted. * @param {string} params.webPropertyId Web property ID to delete the unsampled reports for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Management$Unsampledreports$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Unsampledreports$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Unsampledreports$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.unsampledReports.get * @desc Returns a single unsampled report. * @alias analytics.management.unsampledReports.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve unsampled report for. * @param {string} params.profileId View (Profile) ID to retrieve unsampled report for. * @param {string} params.unsampledReportId ID of the unsampled report to retrieve. * @param {string} params.webPropertyId Web property ID to retrieve unsampled reports for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Unsampledreports$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Unsampledreports$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Unsampledreports$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.unsampledReports.insert * @desc Create a new unsampled report. * @alias analytics.management.unsampledReports.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the unsampled report for. * @param {string} params.profileId View (Profile) ID to create the unsampled report for. * @param {string} params.webPropertyId Web property ID to create the unsampled report for. * @param {().UnsampledReport} params.resource Request body data * @param {object} [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$Management$Unsampledreports$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Unsampledreports$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Unsampledreports$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.unsampledReports.list * @desc Lists unsampled reports to which the user has access. * @alias analytics.management.unsampledReports.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. * @param {integer=} params.max-results The maximum number of unsampled reports to include in this response. * @param {string} params.profileId View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. * @param {integer=} params.start-index An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. * @param {object} [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$Management$Unsampledreports$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Unsampledreports$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Unsampledreports$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Unsampledreports$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to delete the unsampled report for. */ accountId?: string; /** * View (Profile) ID to delete the unsampled report for. */ profileId?: string; /** * ID of the unsampled report to be deleted. */ unsampledReportId?: string; /** * Web property ID to delete the unsampled reports for. */ webPropertyId?: string; } interface Params$Resource$Management$Unsampledreports$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve unsampled report for. */ accountId?: string; /** * View (Profile) ID to retrieve unsampled report for. */ profileId?: string; /** * ID of the unsampled report to retrieve. */ unsampledReportId?: string; /** * Web property ID to retrieve unsampled reports for. */ webPropertyId?: string; } interface Params$Resource$Management$Unsampledreports$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the unsampled report for. */ accountId?: string; /** * View (Profile) ID to create the unsampled report for. */ profileId?: string; /** * Web property ID to create the unsampled report for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$UnsampledReport; } interface Params$Resource$Management$Unsampledreports$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve unsampled reports for. Must be a specific account * ID, ~all is not supported. */ accountId?: string; /** * The maximum number of unsampled reports to include in this response. */ 'max-results'?: number; /** * View (Profile) ID to retrieve unsampled reports for. Must be a specific * view (profile) ID, ~all is not supported. */ profileId?: string; /** * An index of the first unsampled report to retrieve. Use this parameter as * a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property ID to retrieve unsampled reports for. Must be a specific web * property ID, ~all is not supported. */ webPropertyId?: string; } class Resource$Management$Uploads { constructor(); /** * analytics.management.uploads.deleteUploadData * @desc Delete data associated with a previous upload. * @alias analytics.management.uploads.deleteUploadData * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account Id for the uploads to be deleted. * @param {string} params.customDataSourceId Custom data source Id for the uploads to be deleted. * @param {string} params.webPropertyId Web property Id for the uploads to be deleted. * @param {().AnalyticsDataimportDeleteUploadDataRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ deleteUploadData(params?: Params$Resource$Management$Uploads$Deleteuploaddata, options?: MethodOptions): GaxiosPromise; deleteUploadData(params: Params$Resource$Management$Uploads$Deleteuploaddata, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; deleteUploadData(params: Params$Resource$Management$Uploads$Deleteuploaddata, callback: BodyResponseCallback): void; deleteUploadData(callback: BodyResponseCallback): void; /** * analytics.management.uploads.get * @desc List uploads to which the user has access. * @alias analytics.management.uploads.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account Id for the upload to retrieve. * @param {string} params.customDataSourceId Custom data source Id for upload to retrieve. * @param {string} params.uploadId Upload Id to retrieve. * @param {string} params.webPropertyId Web property Id for the upload 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$Management$Uploads$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Uploads$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Uploads$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.uploads.list * @desc List uploads to which the user has access. * @alias analytics.management.uploads.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account Id for the uploads to retrieve. * @param {string} params.customDataSourceId Custom data source Id for uploads to retrieve. * @param {integer=} params.max-results The maximum number of uploads to include in this response. * @param {integer=} params.start-index A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property Id for the uploads to retrieve. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Management$Uploads$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Uploads$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Uploads$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.uploads.uploadData * @desc Upload data for a custom data source. * @alias analytics.management.uploads.uploadData * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account Id associated with the upload. * @param {string} params.customDataSourceId Custom data source Id to which the data being uploaded belongs. * @param {string} params.webPropertyId Web property UA-string associated with the upload. * @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 */ uploadData(params?: Params$Resource$Management$Uploads$Uploaddata, options?: MethodOptions): GaxiosPromise; uploadData(params: Params$Resource$Management$Uploads$Uploaddata, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; uploadData(params: Params$Resource$Management$Uploads$Uploaddata, callback: BodyResponseCallback): void; uploadData(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Uploads$Deleteuploaddata extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account Id for the uploads to be deleted. */ accountId?: string; /** * Custom data source Id for the uploads to be deleted. */ customDataSourceId?: string; /** * Web property Id for the uploads to be deleted. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$AnalyticsDataimportDeleteUploadDataRequest; } interface Params$Resource$Management$Uploads$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account Id for the upload to retrieve. */ accountId?: string; /** * Custom data source Id for upload to retrieve. */ customDataSourceId?: string; /** * Upload Id to retrieve. */ uploadId?: string; /** * Web property Id for the upload to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Uploads$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account Id for the uploads to retrieve. */ accountId?: string; /** * Custom data source Id for uploads to retrieve. */ customDataSourceId?: string; /** * The maximum number of uploads to include in this response. */ 'max-results'?: number; /** * A 1-based index of the first upload to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property Id for the uploads to retrieve. */ webPropertyId?: string; } interface Params$Resource$Management$Uploads$Uploaddata extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account Id associated with the upload. */ accountId?: string; /** * Custom data source Id to which the data being uploaded belongs. */ customDataSourceId?: string; /** * Web property UA-string associated with the upload. */ webPropertyId?: string; /** * Media metadata */ media?: { /** * Media mime-type */ mediaType?: string; /** * Media body contents */ body?: any; }; } class Resource$Management$Webproperties { constructor(); /** * analytics.management.webproperties.get * @desc Gets a web property to which the user has access. * @alias analytics.management.webproperties.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve the web property for. * @param {string} params.webPropertyId ID to retrieve the web property for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Webproperties$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Webproperties$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Webproperties$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.webproperties.insert * @desc Create a new property if the account has fewer than 20 properties. * Web properties are visible in the Google Analytics interface only if they * have at least one profile. * @alias analytics.management.webproperties.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the web property for. * @param {().Webproperty} params.resource Request body data * @param {object} [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$Management$Webproperties$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Webproperties$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Webproperties$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.webproperties.list * @desc Lists web properties to which the user has access. * @alias analytics.management.webproperties.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. * @param {integer=} params.max-results The maximum number of web properties to include in this response. * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {object} [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$Management$Webproperties$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Webproperties$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Webproperties$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.webproperties.patch * @desc Updates an existing web property. This method supports patch * semantics. * @alias analytics.management.webproperties.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the web property belongs * @param {string} params.webPropertyId Web property ID * @param {().Webproperty} params.resource Request body data * @param {object} [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$Management$Webproperties$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Webproperties$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Webproperties$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.webproperties.update * @desc Updates an existing web property. * @alias analytics.management.webproperties.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to which the web property belongs * @param {string} params.webPropertyId Web property ID * @param {().Webproperty} params.resource Request body data * @param {object} [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$Management$Webproperties$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Webproperties$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Webproperties$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Webproperties$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve the web property for. */ accountId?: string; /** * ID to retrieve the web property for. */ webPropertyId?: string; } interface Params$Resource$Management$Webproperties$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the web property for. */ accountId?: string; /** * Request body metadata */ requestBody?: Schema$Webproperty; } interface Params$Resource$Management$Webproperties$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to retrieve web properties for. Can either be a specific * account ID or '~all', which refers to all the accounts that user has * access to. */ accountId?: string; /** * The maximum number of web properties to include in this response. */ 'max-results'?: number; /** * An index of the first entity to retrieve. Use this parameter as a * pagination mechanism along with the max-results parameter. */ 'start-index'?: number; } interface Params$Resource$Management$Webproperties$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the web property belongs */ accountId?: string; /** * Web property ID */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Webproperty; } interface Params$Resource$Management$Webproperties$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to which the web property belongs */ accountId?: string; /** * Web property ID */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$Webproperty; } class Resource$Management$Webpropertyadwordslinks { constructor(); /** * analytics.management.webPropertyAdWordsLinks.delete * @desc Deletes a web property-Google Ads link. * @alias analytics.management.webPropertyAdWordsLinks.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId ID of the account which the given web property belongs to. * @param {string} params.webPropertyAdWordsLinkId Web property Google Ads link ID. * @param {string} params.webPropertyId Web property ID to delete the Google Ads link for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Management$Webpropertyadwordslinks$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Webpropertyadwordslinks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Webpropertyadwordslinks$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.webPropertyAdWordsLinks.get * @desc Returns a web property-Google Ads link to which the user has * access. * @alias analytics.management.webPropertyAdWordsLinks.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId ID of the account which the given web property belongs to. * @param {string} params.webPropertyAdWordsLinkId Web property-Google Ads link ID. * @param {string} params.webPropertyId Web property ID to retrieve the Google Ads link for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Management$Webpropertyadwordslinks$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Management$Webpropertyadwordslinks$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Management$Webpropertyadwordslinks$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * analytics.management.webPropertyAdWordsLinks.insert * @desc Creates a webProperty-Google Ads link. * @alias analytics.management.webPropertyAdWordsLinks.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId ID of the Google Analytics account to create the link for. * @param {string} params.webPropertyId Web property ID to create the link for. * @param {().EntityAdWordsLink} params.resource Request body data * @param {object} [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$Management$Webpropertyadwordslinks$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Webpropertyadwordslinks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Webpropertyadwordslinks$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.webPropertyAdWordsLinks.list * @desc Lists webProperty-Google Ads links for a given web property. * @alias analytics.management.webPropertyAdWordsLinks.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId ID of the account which the given web property belongs to. * @param {integer=} params.max-results The maximum number of webProperty-Google Ads links to include in this response. * @param {integer=} params.start-index An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web property ID to retrieve the Google Ads links for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Management$Webpropertyadwordslinks$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Webpropertyadwordslinks$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Webpropertyadwordslinks$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.webPropertyAdWordsLinks.patch * @desc Updates an existing webProperty-Google Ads link. This method * supports patch semantics. * @alias analytics.management.webPropertyAdWordsLinks.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId ID of the account which the given web property belongs to. * @param {string} params.webPropertyAdWordsLinkId Web property-Google Ads link ID. * @param {string} params.webPropertyId Web property ID to retrieve the Google Ads link for. * @param {().EntityAdWordsLink} params.resource Request body data * @param {object} [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$Management$Webpropertyadwordslinks$Patch, options?: MethodOptions): GaxiosPromise; patch(params: Params$Resource$Management$Webpropertyadwordslinks$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; patch(params: Params$Resource$Management$Webpropertyadwordslinks$Patch, callback: BodyResponseCallback): void; patch(callback: BodyResponseCallback): void; /** * analytics.management.webPropertyAdWordsLinks.update * @desc Updates an existing webProperty-Google Ads link. * @alias analytics.management.webPropertyAdWordsLinks.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId ID of the account which the given web property belongs to. * @param {string} params.webPropertyAdWordsLinkId Web property-Google Ads link ID. * @param {string} params.webPropertyId Web property ID to retrieve the Google Ads link for. * @param {().EntityAdWordsLink} params.resource Request body data * @param {object} [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$Management$Webpropertyadwordslinks$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Webpropertyadwordslinks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Webpropertyadwordslinks$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Webpropertyadwordslinks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the account which the given web property belongs to. */ accountId?: string; /** * Web property Google Ads link ID. */ webPropertyAdWordsLinkId?: string; /** * Web property ID to delete the Google Ads link for. */ webPropertyId?: string; } interface Params$Resource$Management$Webpropertyadwordslinks$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the account which the given web property belongs to. */ accountId?: string; /** * Web property-Google Ads link ID. */ webPropertyAdWordsLinkId?: string; /** * Web property ID to retrieve the Google Ads link for. */ webPropertyId?: string; } interface Params$Resource$Management$Webpropertyadwordslinks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the Google Analytics account to create the link for. */ accountId?: string; /** * Web property ID to create the link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$EntityAdWordsLink; } interface Params$Resource$Management$Webpropertyadwordslinks$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the account which the given web property belongs to. */ accountId?: string; /** * The maximum number of webProperty-Google Ads links to include in this * response. */ 'max-results'?: number; /** * An index of the first webProperty-Google Ads link to retrieve. Use this * parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web property ID to retrieve the Google Ads links for. */ webPropertyId?: string; } interface Params$Resource$Management$Webpropertyadwordslinks$Patch extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the account which the given web property belongs to. */ accountId?: string; /** * Web property-Google Ads link ID. */ webPropertyAdWordsLinkId?: string; /** * Web property ID to retrieve the Google Ads link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$EntityAdWordsLink; } interface Params$Resource$Management$Webpropertyadwordslinks$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * ID of the account which the given web property belongs to. */ accountId?: string; /** * Web property-Google Ads link ID. */ webPropertyAdWordsLinkId?: string; /** * Web property ID to retrieve the Google Ads link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$EntityAdWordsLink; } class Resource$Management$Webpropertyuserlinks { constructor(); /** * analytics.management.webpropertyUserLinks.delete * @desc Removes a user from the given web property. * @alias analytics.management.webpropertyUserLinks.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to delete the user link for. * @param {string} params.linkId Link ID to delete the user link for. * @param {string} params.webPropertyId Web Property ID to delete the user link for. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Management$Webpropertyuserlinks$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Management$Webpropertyuserlinks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Management$Webpropertyuserlinks$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * analytics.management.webpropertyUserLinks.insert * @desc Adds a new user to the given web property. * @alias analytics.management.webpropertyUserLinks.insert * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to create the user link for. * @param {string} params.webPropertyId Web Property ID to create the user link for. * @param {().EntityUserLink} params.resource Request body data * @param {object} [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$Management$Webpropertyuserlinks$Insert, options?: MethodOptions): GaxiosPromise; insert(params: Params$Resource$Management$Webpropertyuserlinks$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; insert(params: Params$Resource$Management$Webpropertyuserlinks$Insert, callback: BodyResponseCallback): void; insert(callback: BodyResponseCallback): void; /** * analytics.management.webpropertyUserLinks.list * @desc Lists webProperty-user links for a given web property. * @alias analytics.management.webpropertyUserLinks.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID which the given web property belongs to. * @param {integer=} params.max-results The maximum number of webProperty-user Links to include in this response. * @param {integer=} params.start-index An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. * @param {string} params.webPropertyId Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. * @param {object} [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$Management$Webpropertyuserlinks$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Management$Webpropertyuserlinks$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Management$Webpropertyuserlinks$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * analytics.management.webpropertyUserLinks.update * @desc Updates permissions for an existing user on the given web property. * @alias analytics.management.webpropertyUserLinks.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.accountId Account ID to update the account-user link for. * @param {string} params.linkId Link ID to update the account-user link for. * @param {string} params.webPropertyId Web property ID to update the account-user link for. * @param {().EntityUserLink} params.resource Request body data * @param {object} [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$Management$Webpropertyuserlinks$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Management$Webpropertyuserlinks$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Management$Webpropertyuserlinks$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Management$Webpropertyuserlinks$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to delete the user link for. */ accountId?: string; /** * Link ID to delete the user link for. */ linkId?: string; /** * Web Property ID to delete the user link for. */ webPropertyId?: string; } interface Params$Resource$Management$Webpropertyuserlinks$Insert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to create the user link for. */ accountId?: string; /** * Web Property ID to create the user link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$EntityUserLink; } interface Params$Resource$Management$Webpropertyuserlinks$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID which the given web property belongs to. */ accountId?: string; /** * The maximum number of webProperty-user Links to include in this response. */ 'max-results'?: number; /** * An index of the first webProperty-user link to retrieve. Use this * parameter as a pagination mechanism along with the max-results parameter. */ 'start-index'?: number; /** * Web Property ID for the webProperty-user links to retrieve. Can either be * a specific web property ID or '~all', which refers to all the web * properties that user has access to. */ webPropertyId?: string; } interface Params$Resource$Management$Webpropertyuserlinks$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Account ID to update the account-user link for. */ accountId?: string; /** * Link ID to update the account-user link for. */ linkId?: string; /** * Web property ID to update the account-user link for. */ webPropertyId?: string; /** * Request body metadata */ requestBody?: Schema$EntityUserLink; } class Resource$Metadata { columns: Resource$Metadata$Columns; constructor(); } class Resource$Metadata$Columns { constructor(); /** * analytics.metadata.columns.list * @desc Lists all columns for a report type * @alias analytics.metadata.columns.list * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.reportType Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API * @param {object} [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$Metadata$Columns$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Metadata$Columns$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Metadata$Columns$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Metadata$Columns$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core * Reporting API */ reportType?: string; } class Resource$Provisioning { constructor(); /** * analytics.provisioning.createAccountTicket * @desc Creates an account ticket. * @alias analytics.provisioning.createAccountTicket * @memberOf! () * * @param {object} params Parameters for request * @param {().AccountTicket} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ createAccountTicket(params?: Params$Resource$Provisioning$Createaccountticket, options?: MethodOptions): GaxiosPromise; createAccountTicket(params: Params$Resource$Provisioning$Createaccountticket, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; createAccountTicket(params: Params$Resource$Provisioning$Createaccountticket, callback: BodyResponseCallback): void; createAccountTicket(callback: BodyResponseCallback): void; /** * analytics.provisioning.createAccountTree * @desc Provision account. * @alias analytics.provisioning.createAccountTree * @memberOf! () * * @param {object} params Parameters for request * @param {().AccountTreeRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ createAccountTree(params?: Params$Resource$Provisioning$Createaccounttree, options?: MethodOptions): GaxiosPromise; createAccountTree(params: Params$Resource$Provisioning$Createaccounttree, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; createAccountTree(params: Params$Resource$Provisioning$Createaccounttree, callback: BodyResponseCallback): void; createAccountTree(callback: BodyResponseCallback): void; } interface Params$Resource$Provisioning$Createaccountticket extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$AccountTicket; } interface Params$Resource$Provisioning$Createaccounttree extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$AccountTreeRequest; } class Resource$Userdeletion { userDeletionRequest: Resource$Userdeletion$Userdeletionrequest; constructor(); } class Resource$Userdeletion$Userdeletionrequest { constructor(); /** * analytics.userDeletion.userDeletionRequest.upsert * @desc Insert or update a user deletion requests. * @alias analytics.userDeletion.userDeletionRequest.upsert * @memberOf! () * * @param {object} params Parameters for request * @param {().UserDeletionRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ upsert(params?: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, options?: MethodOptions): GaxiosPromise; upsert(params: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; upsert(params: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, callback: BodyResponseCallback): void; upsert(callback: BodyResponseCallback): void; } interface Params$Resource$Userdeletion$Userdeletionrequest$Upsert extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$UserDeletionRequest; } }