mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
579 lines
32 KiB
TypeScript
579 lines
32 KiB
TypeScript
// Type definitions for non-npm package Google DoubleClick Search API v2 2.0
|
|
// Project: https://developers.google.com/doubleclick-search/
|
|
// Definitions by: Bolisov Alexey <https://github.com/Bolisov>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
// IMPORTANT
|
|
// This file was generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually.
|
|
// In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator
|
|
// Generated from: https://www.googleapis.com/discovery/v1/apis/doubleclicksearch/v2/rest
|
|
|
|
/// <reference types="gapi.client" />
|
|
|
|
declare namespace gapi.client {
|
|
/** Load DoubleClick Search API v2 */
|
|
function load(name: "doubleclicksearch", version: "v2"): PromiseLike<void>;
|
|
function load(name: "doubleclicksearch", version: "v2", callback: () => any): void;
|
|
|
|
const conversion: doubleclicksearch.ConversionResource;
|
|
|
|
const reports: doubleclicksearch.ReportsResource;
|
|
|
|
const savedColumns: doubleclicksearch.SavedColumnsResource;
|
|
|
|
namespace doubleclicksearch {
|
|
interface Availability {
|
|
/** DS advertiser ID. */
|
|
advertiserId?: string;
|
|
/** DS agency ID. */
|
|
agencyId?: string;
|
|
/** The time by which all conversions have been uploaded, in epoch millis UTC. */
|
|
availabilityTimestamp?: string;
|
|
/** The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). */
|
|
segmentationId?: string;
|
|
/** The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). */
|
|
segmentationName?: string;
|
|
/** The segmentation type that this availability is for (its default value is FLOODLIGHT). */
|
|
segmentationType?: string;
|
|
}
|
|
interface Conversion {
|
|
/** DS ad group ID. */
|
|
adGroupId?: string;
|
|
/** DS ad ID. */
|
|
adId?: string;
|
|
/** DS advertiser ID. */
|
|
advertiserId?: string;
|
|
/** DS agency ID. */
|
|
agencyId?: string;
|
|
/** Available to advertisers only after contacting DoubleClick Search customer support. */
|
|
attributionModel?: string;
|
|
/** DS campaign ID. */
|
|
campaignId?: string;
|
|
/**
|
|
* Sales channel for the product. Acceptable values are:
|
|
* - "local": a physical store
|
|
* - "online": an online store
|
|
*/
|
|
channel?: string;
|
|
/** DS click ID for the conversion. */
|
|
clickId?: string;
|
|
/**
|
|
* For offline conversions, advertisers provide this ID. Advertisers can specify any ID that is meaningful to them. Each conversion in a request must
|
|
* specify a unique ID, and the combination of ID and timestamp must be unique amongst all conversions within the advertiser.
|
|
* For online conversions, DS copies the dsConversionId or floodlightOrderId into this property depending on the advertiser's Floodlight instructions.
|
|
*/
|
|
conversionId?: string;
|
|
/** The time at which the conversion was last modified, in epoch millis UTC. */
|
|
conversionModifiedTimestamp?: string;
|
|
/** The time at which the conversion took place, in epoch millis UTC. */
|
|
conversionTimestamp?: string;
|
|
/** Available to advertisers only after contacting DoubleClick Search customer support. */
|
|
countMillis?: string;
|
|
/** DS criterion (keyword) ID. */
|
|
criterionId?: string;
|
|
/** The currency code for the conversion's revenue. Should be in ISO 4217 alphabetic (3-char) format. */
|
|
currencyCode?: string;
|
|
/** Custom dimensions for the conversion, which can be used to filter data in a report. */
|
|
customDimension?: CustomDimension[];
|
|
/** Custom metrics for the conversion. */
|
|
customMetric?: CustomMetric[];
|
|
/** The type of device on which the conversion occurred. */
|
|
deviceType?: string;
|
|
/** ID that DoubleClick Search generates for each conversion. */
|
|
dsConversionId?: string;
|
|
/** DS engine account ID. */
|
|
engineAccountId?: string;
|
|
/** The Floodlight order ID provided by the advertiser for the conversion. */
|
|
floodlightOrderId?: string;
|
|
/** ID that DS generates and uses to uniquely identify the inventory account that contains the product. */
|
|
inventoryAccountId?: string;
|
|
/** The country registered for the Merchant Center feed that contains the product. Use an ISO 3166 code to specify a country. */
|
|
productCountry?: string;
|
|
/** DS product group ID. */
|
|
productGroupId?: string;
|
|
/** The product ID (SKU). */
|
|
productId?: string;
|
|
/** The language registered for the Merchant Center feed that contains the product. Use an ISO 639 code to specify a language. */
|
|
productLanguage?: string;
|
|
/** The quantity of this conversion, in millis. */
|
|
quantityMillis?: string;
|
|
/**
|
|
* The revenue amount of this TRANSACTION conversion, in micros (value multiplied by 1000000, no decimal). For example, to specify a revenue value of "10"
|
|
* enter "10000000" (10 million) in your request.
|
|
*/
|
|
revenueMicros?: string;
|
|
/** The numeric segmentation identifier (for example, DoubleClick Search Floodlight activity ID). */
|
|
segmentationId?: string;
|
|
/** The friendly segmentation identifier (for example, DoubleClick Search Floodlight activity name). */
|
|
segmentationName?: string;
|
|
/** The segmentation type of this conversion (for example, FLOODLIGHT). */
|
|
segmentationType?: string;
|
|
/** The state of the conversion, that is, either ACTIVE or REMOVED. Note: state DELETED is deprecated. */
|
|
state?: string;
|
|
/** The ID of the local store for which the product was advertised. Applicable only when the channel is "local". */
|
|
storeId?: string;
|
|
/**
|
|
* The type of the conversion, that is, either ACTION or TRANSACTION. An ACTION conversion is an action by the user that has no monetarily quantifiable
|
|
* value, while a TRANSACTION conversion is an action that does have a monetarily quantifiable value. Examples are email list signups (ACTION) versus
|
|
* ecommerce purchases (TRANSACTION).
|
|
*/
|
|
type?: string;
|
|
}
|
|
interface ConversionList {
|
|
/** The conversions being requested. */
|
|
conversion?: Conversion[];
|
|
/** Identifies this as a ConversionList resource. Value: the fixed string doubleclicksearch#conversionList. */
|
|
kind?: string;
|
|
}
|
|
interface CustomDimension {
|
|
/** Custom dimension name. */
|
|
name?: string;
|
|
/** Custom dimension value. */
|
|
value?: string;
|
|
}
|
|
interface CustomMetric {
|
|
/** Custom metric name. */
|
|
name?: string;
|
|
/** Custom metric numeric value. */
|
|
value?: number;
|
|
}
|
|
interface Report {
|
|
/** Asynchronous report only. Contains a list of generated report files once the report has succesfully completed. */
|
|
files?: Array<{
|
|
/** The size of this report file in bytes. */
|
|
byteCount?: string;
|
|
/** Use this url to download the report file. */
|
|
url?: string;
|
|
}>;
|
|
/** Asynchronous report only. Id of the report. */
|
|
id?: string;
|
|
/** Asynchronous report only. True if and only if the report has completed successfully and the report files are ready to be downloaded. */
|
|
isReportReady?: boolean;
|
|
/** Identifies this as a Report resource. Value: the fixed string doubleclicksearch#report. */
|
|
kind?: string;
|
|
/** The request that created the report. Optional fields not specified in the original request are filled with default values. */
|
|
request?: ReportRequest;
|
|
/** The number of report rows generated by the report, not including headers. */
|
|
rowCount?: number;
|
|
/** Synchronous report only. Generated report rows. */
|
|
rows?: ReportRow[];
|
|
/**
|
|
* The currency code of all monetary values produced in the report, including values that are set by users (e.g., keyword bid settings) and metrics (e.g.,
|
|
* cost and revenue). The currency code of a report is determined by the statisticsCurrency field of the report request.
|
|
*/
|
|
statisticsCurrencyCode?: string;
|
|
/** If all statistics of the report are sourced from the same time zone, this would be it. Otherwise the field is unset. */
|
|
statisticsTimeZone?: string;
|
|
}
|
|
interface ReportApiColumnSpec {
|
|
/** Name of a DoubleClick Search column to include in the report. */
|
|
columnName?: string;
|
|
/**
|
|
* Segments a report by a custom dimension. The report must be scoped to an advertiser or lower, and the custom dimension must already be set up in
|
|
* DoubleClick Search. The custom dimension name, which appears in DoubleClick Search, is case sensitive.
|
|
* If used in a conversion report, returns the value of the specified custom dimension for the given conversion, if set. This column does not segment the
|
|
* conversion report.
|
|
*/
|
|
customDimensionName?: string;
|
|
/**
|
|
* Name of a custom metric to include in the report. The report must be scoped to an advertiser or lower, and the custom metric must already be set up in
|
|
* DoubleClick Search. The custom metric name, which appears in DoubleClick Search, is case sensitive.
|
|
*/
|
|
customMetricName?: string;
|
|
/**
|
|
* Inclusive day in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together
|
|
* with startDate.
|
|
*/
|
|
endDate?: string;
|
|
/** Synchronous report only. Set to true to group by this column. Defaults to false. */
|
|
groupByColumn?: boolean;
|
|
/**
|
|
* Text used to identify this column in the report output; defaults to columnName or savedColumnName when not specified. This can be used to prevent
|
|
* collisions between DoubleClick Search columns and saved columns with the same name.
|
|
*/
|
|
headerText?: string;
|
|
/** The platform that is used to provide data for the custom dimension. Acceptable values are "floodlight". */
|
|
platformSource?: string;
|
|
/**
|
|
* Returns metrics only for a specific type of product activity. Accepted values are:
|
|
* - "sold": returns metrics only for products that were sold
|
|
* - "advertised": returns metrics only for products that were advertised in a Shopping campaign, and that might or might not have been sold
|
|
*/
|
|
productReportPerspective?: string;
|
|
/**
|
|
* Name of a saved column to include in the report. The report must be scoped at advertiser or lower, and this saved column must already be created in the
|
|
* DoubleClick Search UI.
|
|
*/
|
|
savedColumnName?: string;
|
|
/**
|
|
* Inclusive date in YYYY-MM-DD format. When provided, this overrides the overall time range of the report for this column only. Must be provided together
|
|
* with endDate.
|
|
*/
|
|
startDate?: string;
|
|
}
|
|
interface ReportRequest {
|
|
/**
|
|
* The columns to include in the report. This includes both DoubleClick Search columns and saved columns. For DoubleClick Search columns, only the
|
|
* columnName parameter is required. For saved columns only the savedColumnName parameter is required. Both columnName and savedColumnName cannot be set
|
|
* in the same stanza.
|
|
*/
|
|
columns?: ReportApiColumnSpec[];
|
|
/** Format that the report should be returned in. Currently csv or tsv is supported. */
|
|
downloadFormat?: string;
|
|
/** A list of filters to be applied to the report. */
|
|
filters?: Array<{
|
|
/** Column to perform the filter on. This can be a DoubleClick Search column or a saved column. */
|
|
column?: ReportApiColumnSpec;
|
|
/** Operator to use in the filter. See the filter reference for a list of available operators. */
|
|
operator?: string;
|
|
/** A list of values to filter the column value against. */
|
|
values?: any[];
|
|
}>;
|
|
/** Determines if removed entities should be included in the report. Defaults to false. Deprecated, please use includeRemovedEntities instead. */
|
|
includeDeletedEntities?: boolean;
|
|
/** Determines if removed entities should be included in the report. Defaults to false. */
|
|
includeRemovedEntities?: boolean;
|
|
/**
|
|
* Asynchronous report only. The maximum number of rows per report file. A large report is split into many files based on this field. Acceptable values
|
|
* are 1000000 to 100000000, inclusive.
|
|
*/
|
|
maxRowsPerFile?: number;
|
|
/** Synchronous report only. A list of columns and directions defining sorting to be performed on the report rows. */
|
|
orderBy?: Array<{
|
|
/** Column to perform the sort on. This can be a DoubleClick Search-defined column or a saved column. */
|
|
column?: ReportApiColumnSpec;
|
|
/** The sort direction, which is either ascending or descending. */
|
|
sortOrder?: string;
|
|
}>;
|
|
/**
|
|
* The reportScope is a set of IDs that are used to determine which subset of entities will be returned in the report. The full lineage of IDs from the
|
|
* lowest scoped level desired up through agency is required.
|
|
*/
|
|
reportScope?: {
|
|
/** DS ad group ID. */
|
|
adGroupId?: string;
|
|
/** DS ad ID. */
|
|
adId?: string;
|
|
/** DS advertiser ID. */
|
|
advertiserId?: string;
|
|
/** DS agency ID. */
|
|
agencyId?: string;
|
|
/** DS campaign ID. */
|
|
campaignId?: string;
|
|
/** DS engine account ID. */
|
|
engineAccountId?: string;
|
|
/** DS keyword ID. */
|
|
keywordId?: string;
|
|
};
|
|
/**
|
|
* Determines the type of rows that are returned in the report. For example, if you specify reportType: keyword, each row in the report will contain data
|
|
* about a keyword. See the Types of Reports reference for the columns that are available for each type.
|
|
*/
|
|
reportType?: string;
|
|
/**
|
|
* Synchronous report only. The maxinum number of rows to return; additional rows are dropped. Acceptable values are 0 to 10000, inclusive. Defaults to
|
|
* 10000.
|
|
*/
|
|
rowCount?: number;
|
|
/** Synchronous report only. Zero-based index of the first row to return. Acceptable values are 0 to 50000, inclusive. Defaults to 0. */
|
|
startRow?: number;
|
|
/**
|
|
* Specifies the currency in which monetary will be returned. Possible values are: usd, agency (valid if the report is scoped to agency or lower),
|
|
* advertiser (valid if the report is scoped to * advertiser or lower), or account (valid if the report is scoped to engine account or lower).
|
|
*/
|
|
statisticsCurrency?: string;
|
|
/** If metrics are requested in a report, this argument will be used to restrict the metrics to a specific time range. */
|
|
timeRange?: {
|
|
/** Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed attribute reports work. */
|
|
changedAttributesSinceTimestamp?: string;
|
|
/** Inclusive UTC timestamp in RFC format, e.g., 2013-07-16T10:16:23.555Z. See additional references on how changed metrics reports work. */
|
|
changedMetricsSinceTimestamp?: string;
|
|
/** Inclusive date in YYYY-MM-DD format. */
|
|
endDate?: string;
|
|
/** Inclusive date in YYYY-MM-DD format. */
|
|
startDate?: string;
|
|
};
|
|
/** If true, the report would only be created if all the requested stat data are sourced from a single timezone. Defaults to false. */
|
|
verifySingleTimeZone?: boolean;
|
|
}
|
|
interface ReportRow {
|
|
[key: string]: any;
|
|
}
|
|
interface SavedColumn {
|
|
/** Identifies this as a SavedColumn resource. Value: the fixed string doubleclicksearch#savedColumn. */
|
|
kind?: string;
|
|
/** The name of the saved column. */
|
|
savedColumnName?: string;
|
|
/** The type of data this saved column will produce. */
|
|
type?: string;
|
|
}
|
|
interface SavedColumnList {
|
|
/** The saved columns being requested. */
|
|
items?: SavedColumn[];
|
|
/** Identifies this as a SavedColumnList resource. Value: the fixed string doubleclicksearch#savedColumnList. */
|
|
kind?: string;
|
|
}
|
|
interface UpdateAvailabilityRequest {
|
|
/** The availabilities being requested. */
|
|
availabilities?: Availability[];
|
|
}
|
|
interface UpdateAvailabilityResponse {
|
|
/** The availabilities being returned. */
|
|
availabilities?: Availability[];
|
|
}
|
|
interface ConversionResource {
|
|
/** Retrieves a list of conversions from a DoubleClick Search engine account. */
|
|
get(request: {
|
|
/** Numeric ID of the ad group. */
|
|
adGroupId?: string;
|
|
/** Numeric ID of the ad. */
|
|
adId?: string;
|
|
/** Numeric ID of the advertiser. */
|
|
advertiserId: string;
|
|
/** Numeric ID of the agency. */
|
|
agencyId: string;
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Numeric ID of the campaign. */
|
|
campaignId?: string;
|
|
/** Numeric ID of the criterion. */
|
|
criterionId?: string;
|
|
/** Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */
|
|
endDate: number;
|
|
/** Numeric ID of the engine account. */
|
|
engineAccountId: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The number of conversions to return per call. */
|
|
rowCount: number;
|
|
/** First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */
|
|
startDate: number;
|
|
/** The 0-based starting index for retrieving conversions results. */
|
|
startRow: number;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<ConversionList>;
|
|
/** Inserts a batch of new conversions into DoubleClick Search. */
|
|
insert(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<ConversionList>;
|
|
/** Updates a batch of conversions in DoubleClick Search. This method supports patch semantics. */
|
|
patch(request: {
|
|
/** Numeric ID of the advertiser. */
|
|
advertiserId: string;
|
|
/** Numeric ID of the agency. */
|
|
agencyId: string;
|
|
/** Data format for the response. */
|
|
alt?: string;
|
|
/** Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */
|
|
endDate: number;
|
|
/** Numeric ID of the engine account. */
|
|
engineAccountId: string;
|
|
/** Selector specifying which fields to include in a partial response. */
|
|
fields?: string;
|
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
key?: string;
|
|
/** OAuth 2.0 token for the current user. */
|
|
oauth_token?: string;
|
|
/** Returns response with indentations and line breaks. */
|
|
prettyPrint?: boolean;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The number of conversions to return per call. */
|
|
rowCount: number;
|
|
/** First date (inclusive) on which to retrieve conversions. Format is yyyymmdd. */
|
|
startDate: number;
|
|
/** The 0-based starting index for retrieving conversions results. */
|
|
startRow: number;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<ConversionList>;
|
|
/** Updates a batch of conversions in DoubleClick Search. */
|
|
update(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<ConversionList>;
|
|
/** Updates the availabilities of a batch of floodlight activities in DoubleClick Search. */
|
|
updateAvailability(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<UpdateAvailabilityResponse>;
|
|
}
|
|
interface ReportsResource {
|
|
/** Generates and returns a report immediately. */
|
|
generate(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Report>;
|
|
/** Polls for the status of a report request. */
|
|
get(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** ID of the report request being polled. */
|
|
reportId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Report>;
|
|
/** Downloads a report file encoded in UTF-8. */
|
|
getFile(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** The index of the report fragment to download. */
|
|
reportFragment: number;
|
|
/** ID of the report. */
|
|
reportId: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<void>;
|
|
/** Inserts a report request into the reporting system. */
|
|
request(request: {
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<Report>;
|
|
}
|
|
interface SavedColumnsResource {
|
|
/** Retrieve the list of saved columns for a specified advertiser. */
|
|
list(request: {
|
|
/** DS ID of the advertiser. */
|
|
advertiserId: string;
|
|
/** DS ID of the agency. */
|
|
agencyId: string;
|
|
/** 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;
|
|
/**
|
|
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
|
|
* Overrides userIp if both are provided.
|
|
*/
|
|
quotaUser?: string;
|
|
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
|
|
userIp?: string;
|
|
}): Request<SavedColumnList>;
|
|
}
|
|
}
|
|
}
|