gas-types-detailed
Version:
Detailed Google Apps Script Type Definitions. Forked from Definitely Typed @types/google-apps-script. Adds full documentation and urls.
776 lines (774 loc) • 142 kB
TypeScript
// Type definitions for Google Apps Script 2019-03-25
// Project: https://developers.google.com/apps-script/
// Generator: https://github.com/grant/google-apps-script-dts
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace GoogleAppsScript {
namespace Dfareporting {
namespace Collection {
namespace Reports {
interface CompatibleFieldsCollection {
// Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions.
query(resource: Schema.Report, profileId: string): Dfareporting.Schema.CompatibleFields;
}
interface FilesCollection {
// Retrieves a report file. This method supports media download.
get(profileId: string, reportId: string, fileId: string): Dfareporting.Schema.File;
// Lists files for a report.
list(profileId: string, reportId: string): Dfareporting.Schema.FileList;
// Lists files for a report.
list(profileId: string, reportId: string, optionalArgs: object): Dfareporting.Schema.FileList;
}
}
interface AccountActiveAdSummariesCollection {
// Gets the account's active ad summary by account ID.
get(profileId: string, summaryAccountId: string): Dfareporting.Schema.AccountActiveAdSummary;
}
interface AccountPermissionGroupsCollection {
// Gets one account permission group by ID.
get(profileId: string, id: string): Dfareporting.Schema.AccountPermissionGroup;
// Retrieves the list of account permission groups.
list(profileId: string): Dfareporting.Schema.AccountPermissionGroupsListResponse;
}
interface AccountPermissionsCollection {
// Gets one account permission by ID.
get(profileId: string, id: string): Dfareporting.Schema.AccountPermission;
// Retrieves the list of account permissions.
list(profileId: string): Dfareporting.Schema.AccountPermissionsListResponse;
}
interface AccountUserProfilesCollection {
// Gets one account user profile by ID.
get(profileId: string, id: string): Dfareporting.Schema.AccountUserProfile;
// Inserts a new account user profile.
insert(resource: Schema.AccountUserProfile, profileId: string): Dfareporting.Schema.AccountUserProfile;
// Retrieves a list of account user profiles, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.AccountUserProfilesListResponse;
// Retrieves a list of account user profiles, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.AccountUserProfilesListResponse;
// Updates an existing account user profile. This method supports patch semantics.
patch(resource: Schema.AccountUserProfile, profileId: string, id: string): Dfareporting.Schema.AccountUserProfile;
// Updates an existing account user profile.
update(resource: Schema.AccountUserProfile, profileId: string): Dfareporting.Schema.AccountUserProfile;
}
interface AccountsCollection {
// Gets one account by ID.
get(profileId: string, id: string): Dfareporting.Schema.Account;
// Retrieves the list of accounts, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.AccountsListResponse;
// Retrieves the list of accounts, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.AccountsListResponse;
// Updates an existing account. This method supports patch semantics.
patch(resource: Schema.Account, profileId: string, id: string): Dfareporting.Schema.Account;
// Updates an existing account.
update(resource: Schema.Account, profileId: string): Dfareporting.Schema.Account;
}
interface AdsCollection {
// Gets one ad by ID.
get(profileId: string, id: string): Dfareporting.Schema.Ad;
// Inserts a new ad.
insert(resource: Schema.Ad, profileId: string): Dfareporting.Schema.Ad;
// Retrieves a list of ads, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.AdsListResponse;
// Retrieves a list of ads, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdsListResponse;
// Updates an existing ad. This method supports patch semantics.
patch(resource: Schema.Ad, profileId: string, id: string): Dfareporting.Schema.Ad;
// Updates an existing ad.
update(resource: Schema.Ad, profileId: string): Dfareporting.Schema.Ad;
}
interface AdvertiserGroupsCollection {
// Gets one advertiser group by ID.
get(profileId: string, id: string): Dfareporting.Schema.AdvertiserGroup;
// Inserts a new advertiser group.
insert(resource: Schema.AdvertiserGroup, profileId: string): Dfareporting.Schema.AdvertiserGroup;
// Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.AdvertiserGroupsListResponse;
// Retrieves a list of advertiser groups, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdvertiserGroupsListResponse;
// Updates an existing advertiser group. This method supports patch semantics.
patch(resource: Schema.AdvertiserGroup, profileId: string, id: string): Dfareporting.Schema.AdvertiserGroup;
// Deletes an existing advertiser group.
remove(profileId: string, id: string): void;
// Updates an existing advertiser group.
update(resource: Schema.AdvertiserGroup, profileId: string): Dfareporting.Schema.AdvertiserGroup;
}
interface AdvertiserLandingPagesCollection {
// Gets one landing page by ID.
get(profileId: string, id: string): Dfareporting.Schema.LandingPage;
// Inserts a new landing page.
insert(resource: Schema.LandingPage, profileId: string): Dfareporting.Schema.LandingPage;
// Retrieves a list of landing pages.
list(profileId: string): Dfareporting.Schema.AdvertiserLandingPagesListResponse;
// Retrieves a list of landing pages.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdvertiserLandingPagesListResponse;
// Updates an existing landing page. This method supports patch semantics.
patch(resource: Schema.LandingPage, profileId: string, id: string): Dfareporting.Schema.LandingPage;
// Updates an existing landing page.
update(resource: Schema.LandingPage, profileId: string): Dfareporting.Schema.LandingPage;
}
interface AdvertisersCollection {
// Gets one advertiser by ID.
get(profileId: string, id: string): Dfareporting.Schema.Advertiser;
// Inserts a new advertiser.
insert(resource: Schema.Advertiser, profileId: string): Dfareporting.Schema.Advertiser;
// Retrieves a list of advertisers, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.AdvertisersListResponse;
// Retrieves a list of advertisers, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdvertisersListResponse;
// Updates an existing advertiser. This method supports patch semantics.
patch(resource: Schema.Advertiser, profileId: string, id: string): Dfareporting.Schema.Advertiser;
// Updates an existing advertiser.
update(resource: Schema.Advertiser, profileId: string): Dfareporting.Schema.Advertiser;
}
interface BrowsersCollection {
// Retrieves a list of browsers.
list(profileId: string): Dfareporting.Schema.BrowsersListResponse;
}
interface CampaignCreativeAssociationsCollection {
// Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already.
insert(resource: Schema.CampaignCreativeAssociation, profileId: string, campaignId: string): Dfareporting.Schema.CampaignCreativeAssociation;
// Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
list(profileId: string, campaignId: string): Dfareporting.Schema.CampaignCreativeAssociationsListResponse;
// Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.
list(profileId: string, campaignId: string, optionalArgs: object): Dfareporting.Schema.CampaignCreativeAssociationsListResponse;
}
interface CampaignsCollection {
// Gets one campaign by ID.
get(profileId: string, id: string): Dfareporting.Schema.Campaign;
// Inserts a new campaign.
insert(resource: Schema.Campaign, profileId: string): Dfareporting.Schema.Campaign;
// Retrieves a list of campaigns, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.CampaignsListResponse;
// Retrieves a list of campaigns, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.CampaignsListResponse;
// Updates an existing campaign. This method supports patch semantics.
patch(resource: Schema.Campaign, profileId: string, id: string): Dfareporting.Schema.Campaign;
// Updates an existing campaign.
update(resource: Schema.Campaign, profileId: string): Dfareporting.Schema.Campaign;
}
interface ChangeLogsCollection {
// Gets one change log by ID.
get(profileId: string, id: string): Dfareporting.Schema.ChangeLog;
// Retrieves a list of change logs. This method supports paging.
list(profileId: string): Dfareporting.Schema.ChangeLogsListResponse;
// Retrieves a list of change logs. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.ChangeLogsListResponse;
}
interface CitiesCollection {
// Retrieves a list of cities, possibly filtered.
list(profileId: string): Dfareporting.Schema.CitiesListResponse;
// Retrieves a list of cities, possibly filtered.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.CitiesListResponse;
}
interface ConnectionTypesCollection {
// Gets one connection type by ID.
get(profileId: string, id: string): Dfareporting.Schema.ConnectionType;
// Retrieves a list of connection types.
list(profileId: string): Dfareporting.Schema.ConnectionTypesListResponse;
}
interface ContentCategoriesCollection {
// Gets one content category by ID.
get(profileId: string, id: string): Dfareporting.Schema.ContentCategory;
// Inserts a new content category.
insert(resource: Schema.ContentCategory, profileId: string): Dfareporting.Schema.ContentCategory;
// Retrieves a list of content categories, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.ContentCategoriesListResponse;
// Retrieves a list of content categories, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.ContentCategoriesListResponse;
// Updates an existing content category. This method supports patch semantics.
patch(resource: Schema.ContentCategory, profileId: string, id: string): Dfareporting.Schema.ContentCategory;
// Deletes an existing content category.
remove(profileId: string, id: string): void;
// Updates an existing content category.
update(resource: Schema.ContentCategory, profileId: string): Dfareporting.Schema.ContentCategory;
}
interface ConversionsCollection {
// Inserts conversions.
batchinsert(resource: Schema.ConversionsBatchInsertRequest, profileId: string): Dfareporting.Schema.ConversionsBatchInsertResponse;
// Updates existing conversions.
batchupdate(resource: Schema.ConversionsBatchUpdateRequest, profileId: string): Dfareporting.Schema.ConversionsBatchUpdateResponse;
}
interface CountriesCollection {
// Gets one country by ID.
get(profileId: string, dartId: string): Dfareporting.Schema.Country;
// Retrieves a list of countries.
list(profileId: string): Dfareporting.Schema.CountriesListResponse;
}
interface CreativeAssetsCollection {
// Inserts a new creative asset.
insert(resource: Schema.CreativeAssetMetadata, profileId: string, advertiserId: string): Dfareporting.Schema.CreativeAssetMetadata;
// Inserts a new creative asset.
insert(resource: Schema.CreativeAssetMetadata, profileId: string, advertiserId: string, mediaData: any): Dfareporting.Schema.CreativeAssetMetadata;
}
interface CreativeFieldValuesCollection {
// Gets one creative field value by ID.
get(profileId: string, creativeFieldId: string, id: string): Dfareporting.Schema.CreativeFieldValue;
// Inserts a new creative field value.
insert(resource: Schema.CreativeFieldValue, profileId: string, creativeFieldId: string): Dfareporting.Schema.CreativeFieldValue;
// Retrieves a list of creative field values, possibly filtered. This method supports paging.
list(profileId: string, creativeFieldId: string): Dfareporting.Schema.CreativeFieldValuesListResponse;
// Retrieves a list of creative field values, possibly filtered. This method supports paging.
list(profileId: string, creativeFieldId: string, optionalArgs: object): Dfareporting.Schema.CreativeFieldValuesListResponse;
// Updates an existing creative field value. This method supports patch semantics.
patch(resource: Schema.CreativeFieldValue, profileId: string, creativeFieldId: string, id: string): Dfareporting.Schema.CreativeFieldValue;
// Deletes an existing creative field value.
remove(profileId: string, creativeFieldId: string, id: string): void;
// Updates an existing creative field value.
update(resource: Schema.CreativeFieldValue, profileId: string, creativeFieldId: string): Dfareporting.Schema.CreativeFieldValue;
}
interface CreativeFieldsCollection {
// Gets one creative field by ID.
get(profileId: string, id: string): Dfareporting.Schema.CreativeField;
// Inserts a new creative field.
insert(resource: Schema.CreativeField, profileId: string): Dfareporting.Schema.CreativeField;
// Retrieves a list of creative fields, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.CreativeFieldsListResponse;
// Retrieves a list of creative fields, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.CreativeFieldsListResponse;
// Updates an existing creative field. This method supports patch semantics.
patch(resource: Schema.CreativeField, profileId: string, id: string): Dfareporting.Schema.CreativeField;
// Deletes an existing creative field.
remove(profileId: string, id: string): void;
// Updates an existing creative field.
update(resource: Schema.CreativeField, profileId: string): Dfareporting.Schema.CreativeField;
}
interface CreativeGroupsCollection {
// Gets one creative group by ID.
get(profileId: string, id: string): Dfareporting.Schema.CreativeGroup;
// Inserts a new creative group.
insert(resource: Schema.CreativeGroup, profileId: string): Dfareporting.Schema.CreativeGroup;
// Retrieves a list of creative groups, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.CreativeGroupsListResponse;
// Retrieves a list of creative groups, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.CreativeGroupsListResponse;
// Updates an existing creative group. This method supports patch semantics.
patch(resource: Schema.CreativeGroup, profileId: string, id: string): Dfareporting.Schema.CreativeGroup;
// Updates an existing creative group.
update(resource: Schema.CreativeGroup, profileId: string): Dfareporting.Schema.CreativeGroup;
}
interface CreativesCollection {
// Gets one creative by ID.
get(profileId: string, id: string): Dfareporting.Schema.Creative;
// Inserts a new creative.
insert(resource: Schema.Creative, profileId: string): Dfareporting.Schema.Creative;
// Retrieves a list of creatives, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.CreativesListResponse;
// Retrieves a list of creatives, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.CreativesListResponse;
// Updates an existing creative. This method supports patch semantics.
patch(resource: Schema.Creative, profileId: string, id: string): Dfareporting.Schema.Creative;
// Updates an existing creative.
update(resource: Schema.Creative, profileId: string): Dfareporting.Schema.Creative;
}
interface DimensionValuesCollection {
// Retrieves list of report dimension values for a list of filters.
query(resource: Schema.DimensionValueRequest, profileId: string): Dfareporting.Schema.DimensionValueList;
// Retrieves list of report dimension values for a list of filters.
query(resource: Schema.DimensionValueRequest, profileId: string, optionalArgs: object): Dfareporting.Schema.DimensionValueList;
}
interface DirectorySitesCollection {
// Gets one directory site by ID.
get(profileId: string, id: string): Dfareporting.Schema.DirectorySite;
// Inserts a new directory site.
insert(resource: Schema.DirectorySite, profileId: string): Dfareporting.Schema.DirectorySite;
// Retrieves a list of directory sites, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.DirectorySitesListResponse;
// Retrieves a list of directory sites, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.DirectorySitesListResponse;
}
interface DynamicTargetingKeysCollection {
// Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement.
insert(resource: Schema.DynamicTargetingKey, profileId: string): Dfareporting.Schema.DynamicTargetingKey;
// Retrieves a list of dynamic targeting keys.
list(profileId: string): Dfareporting.Schema.DynamicTargetingKeysListResponse;
// Retrieves a list of dynamic targeting keys.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.DynamicTargetingKeysListResponse;
// Deletes an existing dynamic targeting key.
remove(profileId: string, objectId: string, name: string, objectType: string): void;
}
interface EventTagsCollection {
// Gets one event tag by ID.
get(profileId: string, id: string): Dfareporting.Schema.EventTag;
// Inserts a new event tag.
insert(resource: Schema.EventTag, profileId: string): Dfareporting.Schema.EventTag;
// Retrieves a list of event tags, possibly filtered.
list(profileId: string): Dfareporting.Schema.EventTagsListResponse;
// Retrieves a list of event tags, possibly filtered.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.EventTagsListResponse;
// Updates an existing event tag. This method supports patch semantics.
patch(resource: Schema.EventTag, profileId: string, id: string): Dfareporting.Schema.EventTag;
// Deletes an existing event tag.
remove(profileId: string, id: string): void;
// Updates an existing event tag.
update(resource: Schema.EventTag, profileId: string): Dfareporting.Schema.EventTag;
}
interface FilesCollection {
// Retrieves a report file by its report ID and file ID. This method supports media download.
get(reportId: string, fileId: string): Dfareporting.Schema.File;
// Lists files for a user profile.
list(profileId: string): Dfareporting.Schema.FileList;
// Lists files for a user profile.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.FileList;
}
interface FloodlightActivitiesCollection {
// Generates a tag for a floodlight activity.
generatetag(profileId: string): Dfareporting.Schema.FloodlightActivitiesGenerateTagResponse;
// Generates a tag for a floodlight activity.
generatetag(profileId: string, optionalArgs: object): Dfareporting.Schema.FloodlightActivitiesGenerateTagResponse;
// Gets one floodlight activity by ID.
get(profileId: string, id: string): Dfareporting.Schema.FloodlightActivity;
// Inserts a new floodlight activity.
insert(resource: Schema.FloodlightActivity, profileId: string): Dfareporting.Schema.FloodlightActivity;
// Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.FloodlightActivitiesListResponse;
// Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.FloodlightActivitiesListResponse;
// Updates an existing floodlight activity. This method supports patch semantics.
patch(resource: Schema.FloodlightActivity, profileId: string, id: string): Dfareporting.Schema.FloodlightActivity;
// Deletes an existing floodlight activity.
remove(profileId: string, id: string): void;
// Updates an existing floodlight activity.
update(resource: Schema.FloodlightActivity, profileId: string): Dfareporting.Schema.FloodlightActivity;
}
interface FloodlightActivityGroupsCollection {
// Gets one floodlight activity group by ID.
get(profileId: string, id: string): Dfareporting.Schema.FloodlightActivityGroup;
// Inserts a new floodlight activity group.
insert(resource: Schema.FloodlightActivityGroup, profileId: string): Dfareporting.Schema.FloodlightActivityGroup;
// Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.FloodlightActivityGroupsListResponse;
// Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.FloodlightActivityGroupsListResponse;
// Updates an existing floodlight activity group. This method supports patch semantics.
patch(resource: Schema.FloodlightActivityGroup, profileId: string, id: string): Dfareporting.Schema.FloodlightActivityGroup;
// Updates an existing floodlight activity group.
update(resource: Schema.FloodlightActivityGroup, profileId: string): Dfareporting.Schema.FloodlightActivityGroup;
}
interface FloodlightConfigurationsCollection {
// Gets one floodlight configuration by ID.
get(profileId: string, id: string): Dfareporting.Schema.FloodlightConfiguration;
// Retrieves a list of floodlight configurations, possibly filtered.
list(profileId: string): Dfareporting.Schema.FloodlightConfigurationsListResponse;
// Retrieves a list of floodlight configurations, possibly filtered.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.FloodlightConfigurationsListResponse;
// Updates an existing floodlight configuration. This method supports patch semantics.
patch(resource: Schema.FloodlightConfiguration, profileId: string, id: string): Dfareporting.Schema.FloodlightConfiguration;
// Updates an existing floodlight configuration.
update(resource: Schema.FloodlightConfiguration, profileId: string): Dfareporting.Schema.FloodlightConfiguration;
}
interface InventoryItemsCollection {
// Gets one inventory item by ID.
get(profileId: string, projectId: string, id: string): Dfareporting.Schema.InventoryItem;
// Retrieves a list of inventory items, possibly filtered. This method supports paging.
list(profileId: string, projectId: string): Dfareporting.Schema.InventoryItemsListResponse;
// Retrieves a list of inventory items, possibly filtered. This method supports paging.
list(profileId: string, projectId: string, optionalArgs: object): Dfareporting.Schema.InventoryItemsListResponse;
}
interface LanguagesCollection {
// Retrieves a list of languages.
list(profileId: string): Dfareporting.Schema.LanguagesListResponse;
}
interface MetrosCollection {
// Retrieves a list of metros.
list(profileId: string): Dfareporting.Schema.MetrosListResponse;
}
interface MobileAppsCollection {
// Gets one mobile app by ID.
get(profileId: string, id: string): Dfareporting.Schema.MobileApp;
// Retrieves list of available mobile apps.
list(profileId: string): Dfareporting.Schema.MobileAppsListResponse;
// Retrieves list of available mobile apps.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.MobileAppsListResponse;
}
interface MobileCarriersCollection {
// Gets one mobile carrier by ID.
get(profileId: string, id: string): Dfareporting.Schema.MobileCarrier;
// Retrieves a list of mobile carriers.
list(profileId: string): Dfareporting.Schema.MobileCarriersListResponse;
}
interface OperatingSystemVersionsCollection {
// Gets one operating system version by ID.
get(profileId: string, id: string): Dfareporting.Schema.OperatingSystemVersion;
// Retrieves a list of operating system versions.
list(profileId: string): Dfareporting.Schema.OperatingSystemVersionsListResponse;
}
interface OperatingSystemsCollection {
// Gets one operating system by DART ID.
get(profileId: string, dartId: string): Dfareporting.Schema.OperatingSystem;
// Retrieves a list of operating systems.
list(profileId: string): Dfareporting.Schema.OperatingSystemsListResponse;
}
interface OrderDocumentsCollection {
// Gets one order document by ID.
get(profileId: string, projectId: string, id: string): Dfareporting.Schema.OrderDocument;
// Retrieves a list of order documents, possibly filtered. This method supports paging.
list(profileId: string, projectId: string): Dfareporting.Schema.OrderDocumentsListResponse;
// Retrieves a list of order documents, possibly filtered. This method supports paging.
list(profileId: string, projectId: string, optionalArgs: object): Dfareporting.Schema.OrderDocumentsListResponse;
}
interface OrdersCollection {
// Gets one order by ID.
get(profileId: string, projectId: string, id: string): Dfareporting.Schema.Order;
// Retrieves a list of orders, possibly filtered. This method supports paging.
list(profileId: string, projectId: string): Dfareporting.Schema.OrdersListResponse;
// Retrieves a list of orders, possibly filtered. This method supports paging.
list(profileId: string, projectId: string, optionalArgs: object): Dfareporting.Schema.OrdersListResponse;
}
interface PlacementGroupsCollection {
// Gets one placement group by ID.
get(profileId: string, id: string): Dfareporting.Schema.PlacementGroup;
// Inserts a new placement group.
insert(resource: Schema.PlacementGroup, profileId: string): Dfareporting.Schema.PlacementGroup;
// Retrieves a list of placement groups, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.PlacementGroupsListResponse;
// Retrieves a list of placement groups, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.PlacementGroupsListResponse;
// Updates an existing placement group. This method supports patch semantics.
patch(resource: Schema.PlacementGroup, profileId: string, id: string): Dfareporting.Schema.PlacementGroup;
// Updates an existing placement group.
update(resource: Schema.PlacementGroup, profileId: string): Dfareporting.Schema.PlacementGroup;
}
interface PlacementStrategiesCollection {
// Gets one placement strategy by ID.
get(profileId: string, id: string): Dfareporting.Schema.PlacementStrategy;
// Inserts a new placement strategy.
insert(resource: Schema.PlacementStrategy, profileId: string): Dfareporting.Schema.PlacementStrategy;
// Retrieves a list of placement strategies, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.PlacementStrategiesListResponse;
// Retrieves a list of placement strategies, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.PlacementStrategiesListResponse;
// Updates an existing placement strategy. This method supports patch semantics.
patch(resource: Schema.PlacementStrategy, profileId: string, id: string): Dfareporting.Schema.PlacementStrategy;
// Deletes an existing placement strategy.
remove(profileId: string, id: string): void;
// Updates an existing placement strategy.
update(resource: Schema.PlacementStrategy, profileId: string): Dfareporting.Schema.PlacementStrategy;
}
interface PlacementsCollection {
// Generates tags for a placement.
generatetags(profileId: string): Dfareporting.Schema.PlacementsGenerateTagsResponse;
// Generates tags for a placement.
generatetags(profileId: string, optionalArgs: object): Dfareporting.Schema.PlacementsGenerateTagsResponse;
// Gets one placement by ID.
get(profileId: string, id: string): Dfareporting.Schema.Placement;
// Inserts a new placement.
insert(resource: Schema.Placement, profileId: string): Dfareporting.Schema.Placement;
// Retrieves a list of placements, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.PlacementsListResponse;
// Retrieves a list of placements, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.PlacementsListResponse;
// Updates an existing placement. This method supports patch semantics.
patch(resource: Schema.Placement, profileId: string, id: string): Dfareporting.Schema.Placement;
// Updates an existing placement.
update(resource: Schema.Placement, profileId: string): Dfareporting.Schema.Placement;
}
interface PlatformTypesCollection {
// Gets one platform type by ID.
get(profileId: string, id: string): Dfareporting.Schema.PlatformType;
// Retrieves a list of platform types.
list(profileId: string): Dfareporting.Schema.PlatformTypesListResponse;
}
interface PostalCodesCollection {
// Gets one postal code by ID.
get(profileId: string, code: string): Dfareporting.Schema.PostalCode;
// Retrieves a list of postal codes.
list(profileId: string): Dfareporting.Schema.PostalCodesListResponse;
}
interface ProjectsCollection {
// Gets one project by ID.
get(profileId: string, id: string): Dfareporting.Schema.Project;
// Retrieves a list of projects, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.ProjectsListResponse;
// Retrieves a list of projects, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.ProjectsListResponse;
}
interface RegionsCollection {
// Retrieves a list of regions.
list(profileId: string): Dfareporting.Schema.RegionsListResponse;
}
interface RemarketingListSharesCollection {
// Gets one remarketing list share by remarketing list ID.
get(profileId: string, remarketingListId: string): Dfareporting.Schema.RemarketingListShare;
// Updates an existing remarketing list share. This method supports patch semantics.
patch(resource: Schema.RemarketingListShare, profileId: string, remarketingListId: string): Dfareporting.Schema.RemarketingListShare;
// Updates an existing remarketing list share.
update(resource: Schema.RemarketingListShare, profileId: string): Dfareporting.Schema.RemarketingListShare;
}
interface RemarketingListsCollection {
// Gets one remarketing list by ID.
get(profileId: string, id: string): Dfareporting.Schema.RemarketingList;
// Inserts a new remarketing list.
insert(resource: Schema.RemarketingList, profileId: string): Dfareporting.Schema.RemarketingList;
// Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
list(profileId: string, advertiserId: string): Dfareporting.Schema.RemarketingListsListResponse;
// Retrieves a list of remarketing lists, possibly filtered. This method supports paging.
list(profileId: string, advertiserId: string, optionalArgs: object): Dfareporting.Schema.RemarketingListsListResponse;
// Updates an existing remarketing list. This method supports patch semantics.
patch(resource: Schema.RemarketingList, profileId: string, id: string): Dfareporting.Schema.RemarketingList;
// Updates an existing remarketing list.
update(resource: Schema.RemarketingList, profileId: string): Dfareporting.Schema.RemarketingList;
}
interface ReportsCollection {
CompatibleFields?: Dfareporting.Collection.Reports.CompatibleFieldsCollection | undefined;
Files?: Dfareporting.Collection.Reports.FilesCollection | undefined;
// Retrieves a report by its ID.
get(profileId: string, reportId: string): Dfareporting.Schema.Report;
// Creates a report.
insert(resource: Schema.Report, profileId: string): Dfareporting.Schema.Report;
// Retrieves list of reports.
list(profileId: string): Dfareporting.Schema.ReportList;
// Retrieves list of reports.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.ReportList;
// Updates a report. This method supports patch semantics.
patch(resource: Schema.Report, profileId: string, reportId: string): Dfareporting.Schema.Report;
// Deletes a report by its ID.
remove(profileId: string, reportId: string): void;
// Runs a report.
run(profileId: string, reportId: string): Dfareporting.Schema.File;
// Runs a report.
run(profileId: string, reportId: string, optionalArgs: object): Dfareporting.Schema.File;
// Updates a report.
update(resource: Schema.Report, profileId: string, reportId: string): Dfareporting.Schema.Report;
}
interface SitesCollection {
// Gets one site by ID.
get(profileId: string, id: string): Dfareporting.Schema.Site;
// Inserts a new site.
insert(resource: Schema.Site, profileId: string): Dfareporting.Schema.Site;
// Retrieves a list of sites, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.SitesListResponse;
// Retrieves a list of sites, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.SitesListResponse;
// Updates an existing site. This method supports patch semantics.
patch(resource: Schema.Site, profileId: string, id: string): Dfareporting.Schema.Site;
// Updates an existing site.
update(resource: Schema.Site, profileId: string): Dfareporting.Schema.Site;
}
interface SizesCollection {
// Gets one size by ID.
get(profileId: string, id: string): Dfareporting.Schema.Size;
// Inserts a new size.
insert(resource: Schema.Size, profileId: string): Dfareporting.Schema.Size;
// Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.
list(profileId: string): Dfareporting.Schema.SizesListResponse;
// Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.SizesListResponse;
}
interface SubaccountsCollection {
// Gets one subaccount by ID.
get(profileId: string, id: string): Dfareporting.Schema.Subaccount;
// Inserts a new subaccount.
insert(resource: Schema.Subaccount, profileId: string): Dfareporting.Schema.Subaccount;
// Gets a list of subaccounts, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.SubaccountsListResponse;
// Gets a list of subaccounts, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.SubaccountsListResponse;
// Updates an existing subaccount. This method supports patch semantics.
patch(resource: Schema.Subaccount, profileId: string, id: string): Dfareporting.Schema.Subaccount;
// Updates an existing subaccount.
update(resource: Schema.Subaccount, profileId: string): Dfareporting.Schema.Subaccount;
}
interface TargetableRemarketingListsCollection {
// Gets one remarketing list by ID.
get(profileId: string, id: string): Dfareporting.Schema.TargetableRemarketingList;
// Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
list(profileId: string, advertiserId: string): Dfareporting.Schema.TargetableRemarketingListsListResponse;
// Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.
list(profileId: string, advertiserId: string, optionalArgs: object): Dfareporting.Schema.TargetableRemarketingListsListResponse;
}
interface TargetingTemplatesCollection {
// Gets one targeting template by ID.
get(profileId: string, id: string): Dfareporting.Schema.TargetingTemplate;
// Inserts a new targeting template.
insert(resource: Schema.TargetingTemplate, profileId: string): Dfareporting.Schema.TargetingTemplate;
// Retrieves a list of targeting templates, optionally filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.TargetingTemplatesListResponse;
// Retrieves a list of targeting templates, optionally filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.TargetingTemplatesListResponse;
// Updates an existing targeting template. This method supports patch semantics.
patch(resource: Schema.TargetingTemplate, profileId: string, id: string): Dfareporting.Schema.TargetingTemplate;
// Updates an existing targeting template.
update(resource: Schema.TargetingTemplate, profileId: string): Dfareporting.Schema.TargetingTemplate;
}
interface UserProfilesCollection {
// Gets one user profile by ID.
get(profileId: string): Dfareporting.Schema.UserProfile;
// Retrieves list of user profiles for a user.
list(): Dfareporting.Schema.UserProfileList;
}
interface UserRolePermissionGroupsCollection {
// Gets one user role permission group by ID.
get(profileId: string, id: string): Dfareporting.Schema.UserRolePermissionGroup;
// Gets a list of all supported user role permission groups.
list(profileId: string): Dfareporting.Schema.UserRolePermissionGroupsListResponse;
}
interface UserRolePermissionsCollection {
// Gets one user role permission by ID.
get(profileId: string, id: string): Dfareporting.Schema.UserRolePermission;
// Gets a list of user role permissions, possibly filtered.
list(profileId: string): Dfareporting.Schema.UserRolePermissionsListResponse;
// Gets a list of user role permissions, possibly filtered.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.UserRolePermissionsListResponse;
}
interface UserRolesCollection {
// Gets one user role by ID.
get(profileId: string, id: string): Dfareporting.Schema.UserRole;
// Inserts a new user role.
insert(resource: Schema.UserRole, profileId: string): Dfareporting.Schema.UserRole;
// Retrieves a list of user roles, possibly filtered. This method supports paging.
list(profileId: string): Dfareporting.Schema.UserRolesListResponse;
// Retrieves a list of user roles, possibly filtered. This method supports paging.
list(profileId: string, optionalArgs: object): Dfareporting.Schema.UserRolesListResponse;
// Updates an existing user role. This method supports patch semantics.
patch(resource: Schema.UserRole, profileId: string, id: string): Dfareporting.Schema.UserRole;
// Deletes an existing user role.
remove(profileId: string, id: string): void;
// Updates an existing user role.
update(resource: Schema.UserRole, profileId: string): Dfareporting.Schema.UserRole;
}
interface VideoFormatsCollection {
// Gets one video format by ID.
get(profileId: string, id: number): Dfareporting.Schema.VideoFormat;
// Lists available video formats.
list(profileId: string): Dfareporting.Schema.VideoFormatsListResponse;
}
}
namespace Schema {
interface Account {
accountPermissionIds?: string[] | undefined;
accountProfile?: string | undefined;
active?: boolean | undefined;
activeAdsLimitTier?: string | undefined;
activeViewOptOut?: boolean | undefined;
availablePermissionIds?: string[] | undefined;
countryId?: string | undefined;
currencyId?: string | undefined;
defaultCreativeSizeId?: string | undefined;
description?: string | undefined;
id?: string | undefined;
kind?: string | undefined;
locale?: string | undefined;
maximumImageSize?: string | undefined;
name?: string | undefined;
nielsenOcrEnabled?: boolean | undefined;
reportsConfiguration?: Dfareporting.Schema.ReportsConfiguration | undefined;
shareReportsWithTwitter?: boolean | undefined;
teaserSizeLimit?: string | undefined;
}
interface AccountActiveAdSummary {
accountId?: string | undefined;
activeAds?: string | undefined;
activeAdsLimitTier?: string | undefined;
availableAds?: string | undefined;
kind?: string | undefined;
}
interface AccountPermission {
accountProfiles?: string[] | undefined;
id?: string | undefined;
kind?: string | undefined;
level?: string | undefined;
name?: string | undefined;
permissionGroupId?: string | undefined;
}
interface AccountPermissionGroup {
id?: string | undefined;
kind?: string | undefined;
name?: string | undefined;
}
interface AccountPermissionGroupsListResponse {
accountPermissionGroups?: Dfareporting.Schema.AccountPermissionGroup[] | undefined;
kind?: string | undefined;
}
interface AccountPermissionsListResponse {
accountPermissions?: Dfareporting.Schema.AccountPermission[] | undefined;
kind?: string | undefined;
}
interface AccountUserProfile {
accountId?: string | undefined;
active?: boolean | undefined;
advertiserFilter?: Dfareporting.Schema.ObjectFilter | undefined;
campaignFilter?: Dfareporting.Schema.ObjectFilter | undefined;
comments?: string | undefined;
email?: string | undefined;
id?: string | undefined;
kind?: string | undefined;
locale?: string | undefined;
name?: string | undefined;
siteFilter?: Dfareporting.Schema.ObjectFilter | undefined;
subaccountId?: string | undefined;
traffickerType?: string | undefined;
userAccessType?: string | undefined;
userRoleFilter?: Dfareporting.Schema.ObjectFilter | undefined;
userRoleId?: string | undefined;
}
interface AccountUserProfilesListResponse {
accountUserProfiles?: Dfareporting.Schema.AccountUserProfile[] | undefined;
kind?: string | undefined;
nextPageToken?: string | undefined;
}
interface AccountsListResponse {
accounts?: Dfareporting.Schema.Account[] | undefined;
kind?: string | undefined;
nextPageToken?: string | undefined;
}
interface Activities {
filters?: Dfareporting.Schema.DimensionValue[] | undefined;
kind?: string | undefined;
metricNames?: string[] | undefined;
}
interface Ad {
accountId?: string | undefined;
active?: boolean | undefined;
advertiserId?: string | undefined;
advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined;
archived?: boolean | undefined;
audienceSegmentId?: string | undefined;
campaignId?: string | undefined;
campaignIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined;
clickThroughUrl?: Dfareporting.Schema.ClickThroughUrl | undefined;
clickThroughUrlSuffixProperties?: Dfareporting.Schema.ClickThroughUrlSuffixProperties | undefined;
comments?: string | undefined;
compatibility?: string | undefined;
createInfo?: Dfareporting.Schema.LastModifiedInfo | undefined;
creativeGroupAssignments?: Dfareporting.Schema.CreativeGroupAssignment[] | undefined;
creativeRotation?: Dfareporting.Schema.CreativeRotation | undefined;
dayPartTargeting?: Dfareporting.Schema.DayPartTargeting | undefined;
defaultClickThroughEventTagProperties?: Dfareporting.Schema.DefaultClickThroughEventTagProperties | undefined;
deliverySchedule?: Dfareporting.Schema.DeliverySchedule | undefined;
dynamicClickTracker?: boolean | undefined;
endTime?: string | undefined;
eventTagOverrides?: Dfareporting.Schema.EventTagOverride[] | undefined;
geoTargeting?: Dfareporting.Schema.GeoTargeting | undefined;
id?: string | undefined;
idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined;
keyValueTargetingExpression?: Dfareporting.Schema.KeyValueTargetingExpression | undefined;
kind?: string | undefined;
languageTargeting?: Dfareporting.Schema.LanguageTargeting | undefined;
lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined;
name?: string | undefined;
placementAssignments?: Dfareporting.Schema.PlacementAssignment[] | undefined;
remarketingListExpression?: Dfareporting.Schema.ListTargetingExpression | undefined;
size?: Dfareporting.Schema.Size | undefined;
sslCompliant?: boolean | undefined;
sslRequired?: boolean | undefined;
startTime?: string | undefined;
subaccountId?: string | undefined;
targetingTemplateId?: string | undefined;
technologyTargeting?: Dfareporting.Schema.TechnologyTargeting | undefined;
type?: string | undefined;
}
interface AdBlockingConfiguration {
clickThroughUrl?: string | undefined;
creativeBundleId?: string | undefined;
enabled?: boolean | undefined;
overrideClickThroughUrl?: boolean | undefined;
}
interface AdSlot {
comment?: string | undefined;
compatibility?: string | undefined;
height?: string | undefined;
linkedPlacementId?: string | undefined;
name?: string | undefined;
paymentSourceType?: string | undefined;
primary?: boolean | undefined;
width?: string | undefined;
}