dfareporting

import { dfareporting } from "https://googleapis.deno.dev/v1/dfareporting:v4.ts";

Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.

class dfareporting {

constructor(client?: CredentialsClient, baseUrl?: string);

async accountActiveAdSummariesGet(profileId: bigint, summaryAccountId: bigint): Promise<AccountActiveAdSummary>;

async accountPermissionGroupsGet(id: bigint, profileId: bigint): Promise<AccountPermissionGroup>;

async accountPermissionGroupsList(profileId: bigint): Promise<AccountPermissionGroupsListResponse>;

async accountPermissionsGet(id: bigint, profileId: bigint): Promise<AccountPermission>;

async accountPermissionsList(profileId: bigint): Promise<AccountPermissionsListResponse>;

async accountsGet(id: bigint, profileId: bigint): Promise<Account>;

async accountsList(profileId: bigint, opts?: AccountsListOptions): Promise<AccountsListResponse>;

async accountsPatch(

profileId: bigint,

req: Account,

opts?: AccountsPatchOptions,

): Promise<Account>;

async accountsUpdate(profileId: bigint, req: Account): Promise<Account>;

async accountUserProfilesGet(id: bigint, profileId: bigint): Promise<AccountUserProfile>;

async accountUserProfilesInsert(profileId: bigint, req: AccountUserProfile): Promise<AccountUserProfile>;

async accountUserProfilesList(profileId: bigint, opts?: AccountUserProfilesListOptions): Promise<AccountUserProfilesListResponse>;

async accountUserProfilesPatch(

profileId: bigint,

req: AccountUserProfile,

opts?: AccountUserProfilesPatchOptions,

): Promise<AccountUserProfile>;

async accountUserProfilesUpdate(profileId: bigint, req: AccountUserProfile): Promise<AccountUserProfile>;

async adsGet(id: bigint, profileId: bigint): Promise<Ad>;

async adsInsert(profileId: bigint, req: Ad): Promise<Ad>;

async adsList(profileId: bigint, opts?: AdsListOptions): Promise<AdsListResponse>;

async adsPatch(

profileId: bigint,

req: Ad,

opts?: AdsPatchOptions,

): Promise<Ad>;

async adsUpdate(profileId: bigint, req: Ad): Promise<Ad>;

async advertiserGroupsDelete(id: bigint, profileId: bigint): Promise<void>;

async advertiserGroupsGet(id: bigint, profileId: bigint): Promise<AdvertiserGroup>;

async advertiserGroupsInsert(profileId: bigint, req: AdvertiserGroup): Promise<AdvertiserGroup>;

async advertiserGroupsList(profileId: bigint, opts?: AdvertiserGroupsListOptions): Promise<AdvertiserGroupsListResponse>;

async advertiserGroupsPatch(

profileId: bigint,

req: AdvertiserGroup,

opts?: AdvertiserGroupsPatchOptions,

): Promise<AdvertiserGroup>;

async advertiserGroupsUpdate(profileId: bigint, req: AdvertiserGroup): Promise<AdvertiserGroup>;

async advertiserInvoicesList(

advertiserId: bigint,

profileId: bigint,

opts?: AdvertiserInvoicesListOptions,

): Promise<AdvertiserInvoicesListResponse>;

async advertiserLandingPagesGet(id: bigint, profileId: bigint): Promise<LandingPage>;

async advertiserLandingPagesInsert(profileId: bigint, req: LandingPage): Promise<LandingPage>;

async advertiserLandingPagesList(profileId: bigint, opts?: AdvertiserLandingPagesListOptions): Promise<AdvertiserLandingPagesListResponse>;

async advertiserLandingPagesPatch(

profileId: bigint,

req: LandingPage,

opts?: AdvertiserLandingPagesPatchOptions,

): Promise<LandingPage>;

async advertiserLandingPagesUpdate(profileId: bigint, req: LandingPage): Promise<LandingPage>;

async advertisersGet(id: bigint, profileId: bigint): Promise<Advertiser>;

async advertisersInsert(profileId: bigint, req: Advertiser): Promise<Advertiser>;

async advertisersList(profileId: bigint, opts?: AdvertisersListOptions): Promise<AdvertisersListResponse>;

async advertisersPatch(

profileId: bigint,

req: Advertiser,

opts?: AdvertisersPatchOptions,

): Promise<Advertiser>;

async advertisersUpdate(profileId: bigint, req: Advertiser): Promise<Advertiser>;

async billingAssignmentsInsert(

billingProfileId: bigint,

profileId: bigint,

req: BillingAssignment,

): Promise<BillingAssignment>;

async billingAssignmentsList(billingProfileId: bigint, profileId: bigint): Promise<BillingAssignmentsListResponse>;

async billingProfilesGet(id: bigint, profileId: bigint): Promise<BillingProfile>;

async billingProfilesList(profileId: bigint, opts?: BillingProfilesListOptions): Promise<BillingProfilesListResponse>;

async billingProfilesUpdate(profileId: bigint, req: BillingProfile): Promise<BillingProfile>;

async billingRatesList(billingProfileId: bigint, profileId: bigint): Promise<BillingRatesListResponse>;

async browsersList(profileId: bigint): Promise<BrowsersListResponse>;

async campaignCreativeAssociationsInsert(

campaignId: bigint,

profileId: bigint,

req: CampaignCreativeAssociation,

): Promise<CampaignCreativeAssociation>;

async campaignCreativeAssociationsList(

campaignId: bigint,

profileId: bigint,

opts?: CampaignCreativeAssociationsListOptions,

): Promise<CampaignCreativeAssociationsListResponse>;

async campaignsGet(id: bigint, profileId: bigint): Promise<Campaign>;

async campaignsInsert(profileId: bigint, req: Campaign): Promise<Campaign>;

async campaignsList(profileId: bigint, opts?: CampaignsListOptions): Promise<CampaignsListResponse>;

async campaignsPatch(

profileId: bigint,

req: Campaign,

opts?: CampaignsPatchOptions,

): Promise<Campaign>;

async campaignsUpdate(profileId: bigint, req: Campaign): Promise<Campaign>;

async changeLogsGet(id: bigint, profileId: bigint): Promise<ChangeLog>;

async changeLogsList(profileId: bigint, opts?: ChangeLogsListOptions): Promise<ChangeLogsListResponse>;

async citiesList(profileId: bigint, opts?: CitiesListOptions): Promise<CitiesListResponse>;

async connectionTypesGet(id: bigint, profileId: bigint): Promise<ConnectionType>;

async connectionTypesList(profileId: bigint): Promise<ConnectionTypesListResponse>;

async contentCategoriesDelete(id: bigint, profileId: bigint): Promise<void>;

async contentCategoriesGet(id: bigint, profileId: bigint): Promise<ContentCategory>;

async contentCategoriesInsert(profileId: bigint, req: ContentCategory): Promise<ContentCategory>;

async contentCategoriesList(profileId: bigint, opts?: ContentCategoriesListOptions): Promise<ContentCategoriesListResponse>;

async contentCategoriesPatch(

profileId: bigint,

req: ContentCategory,

opts?: ContentCategoriesPatchOptions,

): Promise<ContentCategory>;

async contentCategoriesUpdate(profileId: bigint, req: ContentCategory): Promise<ContentCategory>;

async conversionsBatchinsert(profileId: bigint, req: ConversionsBatchInsertRequest): Promise<ConversionsBatchInsertResponse>;

async conversionsBatchupdate(profileId: bigint, req: ConversionsBatchUpdateRequest): Promise<ConversionsBatchUpdateResponse>;

async countriesGet(dartId: bigint, profileId: bigint): Promise<Country>;

async countriesList(profileId: bigint): Promise<CountriesListResponse>;

async creativeAssetsInsert(

advertiserId: bigint,

profileId: bigint,

req: CreativeAssetMetadata,

): Promise<CreativeAssetMetadata>;

async creativeFieldsDelete(id: bigint, profileId: bigint): Promise<void>;

async creativeFieldsGet(id: bigint, profileId: bigint): Promise<CreativeField>;

async creativeFieldsInsert(profileId: bigint, req: CreativeField): Promise<CreativeField>;

async creativeFieldsList(profileId: bigint, opts?: CreativeFieldsListOptions): Promise<CreativeFieldsListResponse>;

async creativeFieldsPatch(

profileId: bigint,

req: CreativeField,

opts?: CreativeFieldsPatchOptions,

): Promise<CreativeField>;

async creativeFieldsUpdate(profileId: bigint, req: CreativeField): Promise<CreativeField>;

async creativeFieldValuesDelete(

creativeFieldId: bigint,

id: bigint,

profileId: bigint,

): Promise<void>;

async creativeFieldValuesGet(

creativeFieldId: bigint,

id: bigint,

profileId: bigint,

): Promise<CreativeFieldValue>;

async creativeFieldValuesInsert(

creativeFieldId: bigint,

profileId: bigint,

req: CreativeFieldValue,

): Promise<CreativeFieldValue>;

async creativeFieldValuesList(

creativeFieldId: bigint,

profileId: bigint,

opts?: CreativeFieldValuesListOptions,

): Promise<CreativeFieldValuesListResponse>;

async creativeFieldValuesPatch(

creativeFieldId: bigint,

profileId: bigint,

req: CreativeFieldValue,

opts?: CreativeFieldValuesPatchOptions,

): Promise<CreativeFieldValue>;

async creativeFieldValuesUpdate(

creativeFieldId: bigint,

profileId: bigint,

req: CreativeFieldValue,

): Promise<CreativeFieldValue>;

async creativeGroupsGet(id: bigint, profileId: bigint): Promise<CreativeGroup>;

async creativeGroupsInsert(profileId: bigint, req: CreativeGroup): Promise<CreativeGroup>;

async creativeGroupsList(profileId: bigint, opts?: CreativeGroupsListOptions): Promise<CreativeGroupsListResponse>;

async creativeGroupsPatch(

profileId: bigint,

req: CreativeGroup,

opts?: CreativeGroupsPatchOptions,

): Promise<CreativeGroup>;

async creativeGroupsUpdate(profileId: bigint, req: CreativeGroup): Promise<CreativeGroup>;

async creativesGet(id: bigint, profileId: bigint): Promise<Creative>;

async creativesInsert(profileId: bigint, req: Creative): Promise<Creative>;

async creativesList(profileId: bigint, opts?: CreativesListOptions): Promise<CreativesListResponse>;

async creativesPatch(

profileId: bigint,

req: Creative,

opts?: CreativesPatchOptions,

): Promise<Creative>;

async creativesUpdate(profileId: bigint, req: Creative): Promise<Creative>;

async dimensionValuesQuery(

profileId: bigint,

req: DimensionValueRequest,

opts?: DimensionValuesQueryOptions,

): Promise<DimensionValueList>;

async directorySitesGet(id: bigint, profileId: bigint): Promise<DirectorySite>;

async directorySitesInsert(profileId: bigint, req: DirectorySite): Promise<DirectorySite>;

async directorySitesList(profileId: bigint, opts?: DirectorySitesListOptions): Promise<DirectorySitesListResponse>;

async dynamicTargetingKeysDelete(

objectId: bigint,

profileId: bigint,

opts?: DynamicTargetingKeysDeleteOptions,

): Promise<void>;

async dynamicTargetingKeysInsert(profileId: bigint, req: DynamicTargetingKey): Promise<DynamicTargetingKey>;

async dynamicTargetingKeysList(profileId: bigint, opts?: DynamicTargetingKeysListOptions): Promise<DynamicTargetingKeysListResponse>;

async eventTagsDelete(id: bigint, profileId: bigint): Promise<void>;

async eventTagsGet(id: bigint, profileId: bigint): Promise<EventTag>;

async eventTagsInsert(profileId: bigint, req: EventTag): Promise<EventTag>;

async eventTagsList(profileId: bigint, opts?: EventTagsListOptions): Promise<EventTagsListResponse>;

async eventTagsPatch(

profileId: bigint,

req: EventTag,

opts?: EventTagsPatchOptions,

): Promise<EventTag>;

async eventTagsUpdate(profileId: bigint, req: EventTag): Promise<EventTag>;

async filesGet(fileId: bigint, reportId: bigint): Promise<File>;

async filesList(profileId: bigint, opts?: FilesListOptions): Promise<FileList>;

async floodlightActivitiesDelete(id: bigint, profileId: bigint): Promise<void>;

async floodlightActivitiesGeneratetag(profileId: bigint, opts?: FloodlightActivitiesGeneratetagOptions): Promise<FloodlightActivitiesGenerateTagResponse>;

async floodlightActivitiesGet(id: bigint, profileId: bigint): Promise<FloodlightActivity>;

async floodlightActivitiesInsert(profileId: bigint, req: FloodlightActivity): Promise<FloodlightActivity>;

async floodlightActivitiesList(profileId: bigint, opts?: FloodlightActivitiesListOptions): Promise<FloodlightActivitiesListResponse>;

async floodlightActivitiesPatch(

profileId: bigint,

req: FloodlightActivity,

opts?: FloodlightActivitiesPatchOptions,

): Promise<FloodlightActivity>;

async floodlightActivitiesUpdate(profileId: bigint, req: FloodlightActivity): Promise<FloodlightActivity>;

async floodlightActivityGroupsGet(id: bigint, profileId: bigint): Promise<FloodlightActivityGroup>;

async floodlightActivityGroupsInsert(profileId: bigint, req: FloodlightActivityGroup): Promise<FloodlightActivityGroup>;

async floodlightActivityGroupsList(profileId: bigint, opts?: FloodlightActivityGroupsListOptions): Promise<FloodlightActivityGroupsListResponse>;

async floodlightActivityGroupsPatch(

profileId: bigint,

req: FloodlightActivityGroup,

opts?: FloodlightActivityGroupsPatchOptions,

): Promise<FloodlightActivityGroup>;

async floodlightActivityGroupsUpdate(profileId: bigint, req: FloodlightActivityGroup): Promise<FloodlightActivityGroup>;

async floodlightConfigurationsGet(id: bigint, profileId: bigint): Promise<FloodlightConfiguration>;

async floodlightConfigurationsList(profileId: bigint, opts?: FloodlightConfigurationsListOptions): Promise<FloodlightConfigurationsListResponse>;

async floodlightConfigurationsPatch(

profileId: bigint,

req: FloodlightConfiguration,

opts?: FloodlightConfigurationsPatchOptions,

): Promise<FloodlightConfiguration>;

async floodlightConfigurationsUpdate(profileId: bigint, req: FloodlightConfiguration): Promise<FloodlightConfiguration>;

async inventoryItemsGet(

id: bigint,

profileId: bigint,

projectId: bigint,

): Promise<InventoryItem>;

async inventoryItemsList(

profileId: bigint,

projectId: bigint,

opts?: InventoryItemsListOptions,

): Promise<InventoryItemsListResponse>;

async languagesList(profileId: bigint): Promise<LanguagesListResponse>;

async metrosList(profileId: bigint): Promise<MetrosListResponse>;

async mobileAppsGet(id: string, profileId: bigint): Promise<MobileApp>;

async mobileAppsList(profileId: bigint, opts?: MobileAppsListOptions): Promise<MobileAppsListResponse>;

async mobileCarriersGet(id: bigint, profileId: bigint): Promise<MobileCarrier>;

async mobileCarriersList(profileId: bigint): Promise<MobileCarriersListResponse>;

async operatingSystemsGet(dartId: bigint, profileId: bigint): Promise<OperatingSystem>;

async operatingSystemsList(profileId: bigint): Promise<OperatingSystemsListResponse>;

async operatingSystemVersionsGet(id: bigint, profileId: bigint): Promise<OperatingSystemVersion>;

async operatingSystemVersionsList(profileId: bigint): Promise<OperatingSystemVersionsListResponse>;

async ordersGet(

id: bigint,

profileId: bigint,

projectId: bigint,

): Promise<Order>;

async ordersList(

profileId: bigint,

projectId: bigint,

opts?: OrdersListOptions,

): Promise<OrdersListResponse>;

async placementGroupsGet(id: bigint, profileId: bigint): Promise<PlacementGroup>;

async placementGroupsInsert(profileId: bigint, req: PlacementGroup): Promise<PlacementGroup>;

async placementGroupsList(profileId: bigint, opts?: PlacementGroupsListOptions): Promise<PlacementGroupsListResponse>;

async placementGroupsPatch(

profileId: bigint,

req: PlacementGroup,

opts?: PlacementGroupsPatchOptions,

): Promise<PlacementGroup>;

async placementGroupsUpdate(profileId: bigint, req: PlacementGroup): Promise<PlacementGroup>;

async placementsGeneratetags(profileId: bigint, opts?: PlacementsGeneratetagsOptions): Promise<PlacementsGenerateTagsResponse>;

async placementsGet(id: bigint, profileId: bigint): Promise<Placement>;

async placementsInsert(profileId: bigint, req: Placement): Promise<Placement>;

async placementsList(profileId: bigint, opts?: PlacementsListOptions): Promise<PlacementsListResponse>;

async placementsPatch(

profileId: bigint,

req: Placement,

opts?: PlacementsPatchOptions,

): Promise<Placement>;

async placementStrategiesDelete(id: bigint, profileId: bigint): Promise<void>;

async placementStrategiesGet(id: bigint, profileId: bigint): Promise<PlacementStrategy>;

async placementStrategiesInsert(profileId: bigint, req: PlacementStrategy): Promise<PlacementStrategy>;

async placementStrategiesList(profileId: bigint, opts?: PlacementStrategiesListOptions): Promise<PlacementStrategiesListResponse>;

async placementStrategiesPatch(

profileId: bigint,

req: PlacementStrategy,

opts?: PlacementStrategiesPatchOptions,

): Promise<PlacementStrategy>;

async placementStrategiesUpdate(profileId: bigint, req: PlacementStrategy): Promise<PlacementStrategy>;

async placementsUpdate(profileId: bigint, req: Placement): Promise<Placement>;

async platformTypesGet(id: bigint, profileId: bigint): Promise<PlatformType>;

async platformTypesList(profileId: bigint): Promise<PlatformTypesListResponse>;

async postalCodesGet(code: string, profileId: bigint): Promise<PostalCode>;

async postalCodesList(profileId: bigint): Promise<PostalCodesListResponse>;

async projectsGet(id: bigint, profileId: bigint): Promise<Project>;

async projectsList(profileId: bigint, opts?: ProjectsListOptions): Promise<ProjectsListResponse>;

async regionsList(profileId: bigint): Promise<RegionsListResponse>;

async remarketingListsGet(id: bigint, profileId: bigint): Promise<RemarketingList>;

async remarketingListSharesGet(profileId: bigint, remarketingListId: bigint): Promise<RemarketingListShare>;

async remarketingListSharesPatch(

profileId: bigint,

req: RemarketingListShare,

opts?: RemarketingListSharesPatchOptions,

): Promise<RemarketingListShare>;

async remarketingListSharesUpdate(profileId: bigint, req: RemarketingListShare): Promise<RemarketingListShare>;

async remarketingListsInsert(profileId: bigint, req: RemarketingList): Promise<RemarketingList>;

async remarketingListsList(profileId: bigint, opts?: RemarketingListsListOptions): Promise<RemarketingListsListResponse>;

async remarketingListsPatch(

profileId: bigint,

req: RemarketingList,

opts?: RemarketingListsPatchOptions,

): Promise<RemarketingList>;

async remarketingListsUpdate(profileId: bigint, req: RemarketingList): Promise<RemarketingList>;

async reportsCompatibleFieldsQuery(profileId: bigint, req: Report): Promise<CompatibleFields>;

async reportsDelete(profileId: bigint, reportId: bigint): Promise<void>;

async reportsFilesGet(

fileId: bigint,

profileId: bigint,

reportId: bigint,

): Promise<File>;

async reportsFilesList(

profileId: bigint,

reportId: bigint,

opts?: ReportsFilesListOptions,

): Promise<FileList>;

async reportsGet(profileId: bigint, reportId: bigint): Promise<Report>;

async reportsInsert(profileId: bigint, req: Report): Promise<Report>;

async reportsList(profileId: bigint, opts?: ReportsListOptions): Promise<ReportList>;

async reportsPatch(

profileId: bigint,

reportId: bigint,

req: Report,

): Promise<Report>;

async reportsRun(

profileId: bigint,

reportId: bigint,

opts?: ReportsRunOptions,

): Promise<File>;

async reportsUpdate(

profileId: bigint,

reportId: bigint,

req: Report,

): Promise<Report>;

async sitesGet(id: bigint, profileId: bigint): Promise<Site>;

async sitesInsert(profileId: bigint, req: Site): Promise<Site>;

async sitesList(profileId: bigint, opts?: SitesListOptions): Promise<SitesListResponse>;

async sitesPatch(

profileId: bigint,

req: Site,

opts?: SitesPatchOptions,

): Promise<Site>;

async sitesUpdate(profileId: bigint, req: Site): Promise<Site>;

async sizesGet(id: bigint, profileId: bigint): Promise<Size>;

async sizesInsert(profileId: bigint, req: Size): Promise<Size>;

async sizesList(profileId: bigint, opts?: SizesListOptions): Promise<SizesListResponse>;

async subaccountsGet(id: bigint, profileId: bigint): Promise<Subaccount>;

async subaccountsInsert(profileId: bigint, req: Subaccount): Promise<Subaccount>;

async subaccountsList(profileId: bigint, opts?: SubaccountsListOptions): Promise<SubaccountsListResponse>;

async subaccountsPatch(

profileId: bigint,

req: Subaccount,

opts?: SubaccountsPatchOptions,

): Promise<Subaccount>;

async subaccountsUpdate(profileId: bigint, req: Subaccount): Promise<Subaccount>;

async targetableRemarketingListsGet(id: bigint, profileId: bigint): Promise<TargetableRemarketingList>;

async targetableRemarketingListsList(profileId: bigint, opts?: TargetableRemarketingListsListOptions): Promise<TargetableRemarketingListsListResponse>;

async targetingTemplatesGet(id: bigint, profileId: bigint): Promise<TargetingTemplate>;

async targetingTemplatesInsert(profileId: bigint, req: TargetingTemplate): Promise<TargetingTemplate>;

async targetingTemplatesList(profileId: bigint, opts?: TargetingTemplatesListOptions): Promise<TargetingTemplatesListResponse>;

async targetingTemplatesPatch(

profileId: bigint,

req: TargetingTemplate,

opts?: TargetingTemplatesPatchOptions,

): Promise<TargetingTemplate>;

async targetingTemplatesUpdate(profileId: bigint, req: TargetingTemplate): Promise<TargetingTemplate>;

async userProfilesGet(profileId: bigint): Promise<UserProfile>;

async userProfilesList(): Promise<UserProfileList>;

async userRolePermissionGroupsGet(id: bigint, profileId: bigint): Promise<UserRolePermissionGroup>;

async userRolePermissionGroupsList(profileId: bigint): Promise<UserRolePermissionGroupsListResponse>;

async userRolePermissionsGet(id: bigint, profileId: bigint): Promise<UserRolePermission>;

async userRolePermissionsList(profileId: bigint, opts?: UserRolePermissionsListOptions): Promise<UserRolePermissionsListResponse>;

async userRolesDelete(id: bigint, profileId: bigint): Promise<void>;

async userRolesGet(id: bigint, profileId: bigint): Promise<UserRole>;

async userRolesInsert(profileId: bigint, req: UserRole): Promise<UserRole>;

async userRolesList(profileId: bigint, opts?: UserRolesListOptions): Promise<UserRolesListResponse>;

async userRolesPatch(

profileId: bigint,

req: UserRole,

opts?: UserRolesPatchOptions,

): Promise<UserRole>;

async userRolesUpdate(profileId: bigint, req: UserRole): Promise<UserRole>;

async videoFormatsGet(id: number, profileId: bigint): Promise<VideoFormat>;

async videoFormatsList(profileId: bigint): Promise<VideoFormatsListResponse>;

}

§Constructors

new dfareporting(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

accountActiveAdSummariesGet(profileId: bigint, summaryAccountId: bigint): Promise<AccountActiveAdSummary>

[src]

Gets the account's active ad summary by account ID.

@param profileId

User profile ID associated with this request.

@param summaryAccountId

Account ID.

accountPermissionGroupsGet(id: bigint, profileId: bigint): Promise<AccountPermissionGroup>

[src]

Gets one account permission group by ID.

@param id

Account permission group ID.

@param profileId

User profile ID associated with this request.

accountPermissionGroupsList(profileId: bigint): Promise<AccountPermissionGroupsListResponse>

[src]

Retrieves the list of account permission groups.

@param profileId

User profile ID associated with this request.

accountPermissionsGet(id: bigint, profileId: bigint): Promise<AccountPermission>

[src]

Gets one account permission by ID.

@param id

Account permission ID.

@param profileId

User profile ID associated with this request.

accountPermissionsList(profileId: bigint): Promise<AccountPermissionsListResponse>

[src]

Retrieves the list of account permissions.

@param profileId

User profile ID associated with this request.

accountsGet(id: bigint, profileId: bigint): Promise<Account>

[src]

Gets one account by ID.

@param id

Account ID.

@param profileId

User profile ID associated with this request.

accountsList(profileId: bigint, opts?: AccountsListOptions): Promise<AccountsListResponse>

[src]

Retrieves the list of accounts, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

accountsPatch(profileId: bigint, req: Account, opts?: AccountsPatchOptions): Promise<Account>

[src]

Updates an existing account. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

accountsUpdate(profileId: bigint, req: Account): Promise<Account>

[src]

Updates an existing account.

@param profileId

User profile ID associated with this request.

accountUserProfilesGet(id: bigint, profileId: bigint): Promise<AccountUserProfile>

[src]

Gets one account user profile by ID.

@param id

User profile ID.

@param profileId

User profile ID associated with this request.

accountUserProfilesInsert(profileId: bigint, req: AccountUserProfile): Promise<AccountUserProfile>

[src]

Inserts a new account user profile.

@param profileId

User profile ID associated with this request.

accountUserProfilesList(profileId: bigint, opts?: AccountUserProfilesListOptions): Promise<AccountUserProfilesListResponse>

[src]

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

accountUserProfilesPatch(profileId: bigint, req: AccountUserProfile, opts?: AccountUserProfilesPatchOptions): Promise<AccountUserProfile>

[src]

Updates an existing user role. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

accountUserProfilesUpdate(profileId: bigint, req: AccountUserProfile): Promise<AccountUserProfile>

[src]

Updates an existing account user profile.

@param profileId

User profile ID associated with this request.

adsGet(id: bigint, profileId: bigint): Promise<Ad>

[src]

Gets one ad by ID.

@param id

Ad ID.

@param profileId

User profile ID associated with this request.

adsInsert(profileId: bigint, req: Ad): Promise<Ad>

[src]

Inserts a new ad.

@param profileId

User profile ID associated with this request.

adsList(profileId: bigint, opts?: AdsListOptions): Promise<AdsListResponse>

[src]

Retrieves a list of ads, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

adsPatch(profileId: bigint, req: Ad, opts?: AdsPatchOptions): Promise<Ad>

[src]

Updates an existing event tag. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

adsUpdate(profileId: bigint, req: Ad): Promise<Ad>

[src]

Updates an existing ad.

@param profileId

User profile ID associated with this request.

advertiserGroupsDelete(id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing advertiser group.

@param id

Advertiser group ID.

@param profileId

User profile ID associated with this request.

advertiserGroupsGet(id: bigint, profileId: bigint): Promise<AdvertiserGroup>

[src]

Gets one advertiser group by ID.

@param id

Advertiser group ID.

@param profileId

User profile ID associated with this request.

advertiserGroupsInsert(profileId: bigint, req: AdvertiserGroup): Promise<AdvertiserGroup>

[src]

Inserts a new advertiser group.

@param profileId

User profile ID associated with this request.

advertiserGroupsList(profileId: bigint, opts?: AdvertiserGroupsListOptions): Promise<AdvertiserGroupsListResponse>

[src]

Retrieves a list of advertiser groups, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

advertiserGroupsPatch(profileId: bigint, req: AdvertiserGroup, opts?: AdvertiserGroupsPatchOptions): Promise<AdvertiserGroup>

[src]

Updates an existing advertiser group. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

advertiserGroupsUpdate(profileId: bigint, req: AdvertiserGroup): Promise<AdvertiserGroup>

[src]

Updates an existing advertiser group.

@param profileId

User profile ID associated with this request.

advertiserInvoicesList(advertiserId: bigint, profileId: bigint, opts?: AdvertiserInvoicesListOptions): Promise<AdvertiserInvoicesListResponse>

[src]

Retrieves a list of invoices for a particular issue month. The api only works if the billing profile invoice level is set to either advertiser or campaign non-consolidated invoice level.

@param advertiserId

Advertiser ID of this invoice.

@param profileId

User profile ID associated with this request.

advertiserLandingPagesGet(id: bigint, profileId: bigint): Promise<LandingPage>

[src]

Gets one landing page by ID.

@param id

Landing page ID.

@param profileId

User profile ID associated with this request.

advertiserLandingPagesInsert(profileId: bigint, req: LandingPage): Promise<LandingPage>

[src]

Inserts a new landing page.

@param profileId

User profile ID associated with this request.

advertiserLandingPagesList(profileId: bigint, opts?: AdvertiserLandingPagesListOptions): Promise<AdvertiserLandingPagesListResponse>

[src]

Retrieves a list of landing pages.

@param profileId

User profile ID associated with this request.

advertiserLandingPagesPatch(profileId: bigint, req: LandingPage, opts?: AdvertiserLandingPagesPatchOptions): Promise<LandingPage>

[src]

Updates an existing advertiser. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

advertiserLandingPagesUpdate(profileId: bigint, req: LandingPage): Promise<LandingPage>

[src]

Updates an existing landing page.

@param profileId

User profile ID associated with this request.

advertisersGet(id: bigint, profileId: bigint): Promise<Advertiser>

[src]

Gets one advertiser by ID.

@param id

Advertiser ID.

@param profileId

User profile ID associated with this request.

advertisersInsert(profileId: bigint, req: Advertiser): Promise<Advertiser>

[src]

Inserts a new advertiser.

@param profileId

User profile ID associated with this request.

advertisersList(profileId: bigint, opts?: AdvertisersListOptions): Promise<AdvertisersListResponse>

[src]

Retrieves a list of advertisers, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

advertisersPatch(profileId: bigint, req: Advertiser, opts?: AdvertisersPatchOptions): Promise<Advertiser>

[src]

Updates an existing advertiser. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

advertisersUpdate(profileId: bigint, req: Advertiser): Promise<Advertiser>

[src]

Updates an existing advertiser.

@param profileId

User profile ID associated with this request.

billingAssignmentsInsert(billingProfileId: bigint, profileId: bigint, req: BillingAssignment): Promise<BillingAssignment>

[src]

Inserts a new billing assignment and returns the new assignment. Only one of advertiser_id or campaign_id is support per request. If the new assignment has no effect (assigning a campaign to the parent advertiser billing profile or assigning an advertiser to the account billing profile), no assignment will be returned.

@param billingProfileId

Billing profile ID of this billing assignment.

@param profileId

User profile ID associated with this request.

billingAssignmentsList(billingProfileId: bigint, profileId: bigint): Promise<BillingAssignmentsListResponse>

[src]

Retrieves a list of billing assignments.

@param billingProfileId

Billing profile ID of this billing assignment.

@param profileId

User profile ID associated with this request.

billingProfilesGet(id: bigint, profileId: bigint): Promise<BillingProfile>

[src]

Gets one billing profile by ID.

@param id

Billing Profile ID.

@param profileId

User profile ID associated with this request.

billingProfilesList(profileId: bigint, opts?: BillingProfilesListOptions): Promise<BillingProfilesListResponse>

[src]

Retrieves a list of billing profiles, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

billingProfilesUpdate(profileId: bigint, req: BillingProfile): Promise<BillingProfile>

[src]

Updates an existing billing profile.

@param profileId

User profile ID associated with this request.

billingRatesList(billingProfileId: bigint, profileId: bigint): Promise<BillingRatesListResponse>

[src]

Retrieves a list of billing rates. This method supports paging.

@param billingProfileId

Billing profile ID of this billing rate.

@param profileId

User profile ID associated with this request.

browsersList(profileId: bigint): Promise<BrowsersListResponse>

[src]

Retrieves a list of browsers.

@param profileId

User profile ID associated with this request.

campaignCreativeAssociationsInsert(campaignId: bigint, profileId: bigint, req: CampaignCreativeAssociation): Promise<CampaignCreativeAssociation>

[src]

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.

@param campaignId

Campaign ID in this association.

@param profileId

User profile ID associated with this request.

campaignCreativeAssociationsList(campaignId: bigint, profileId: bigint, opts?: CampaignCreativeAssociationsListOptions): Promise<CampaignCreativeAssociationsListResponse>

[src]

Retrieves the list of creative IDs associated with the specified campaign. This method supports paging.

@param campaignId

Campaign ID in this association.

@param profileId

User profile ID associated with this request.

campaignsGet(id: bigint, profileId: bigint): Promise<Campaign>

[src]

Gets one campaign by ID.

@param id

Campaign ID.

@param profileId

User profile ID associated with this request.

campaignsInsert(profileId: bigint, req: Campaign): Promise<Campaign>

[src]

Inserts a new campaign.

@param profileId

User profile ID associated with this request.

campaignsList(profileId: bigint, opts?: CampaignsListOptions): Promise<CampaignsListResponse>

[src]

Retrieves a list of campaigns, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

campaignsPatch(profileId: bigint, req: Campaign, opts?: CampaignsPatchOptions): Promise<Campaign>

[src]

Updates an existing creative. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

campaignsUpdate(profileId: bigint, req: Campaign): Promise<Campaign>

[src]

Updates an existing campaign.

@param profileId

User profile ID associated with this request.

changeLogsGet(id: bigint, profileId: bigint): Promise<ChangeLog>

[src]

Gets one change log by ID.

@param id

Change log ID.

@param profileId

User profile ID associated with this request.

changeLogsList(profileId: bigint, opts?: ChangeLogsListOptions): Promise<ChangeLogsListResponse>

[src]

Retrieves a list of change logs. This method supports paging.

@param profileId

User profile ID associated with this request.

citiesList(profileId: bigint, opts?: CitiesListOptions): Promise<CitiesListResponse>

[src]

Retrieves a list of cities, possibly filtered.

@param profileId

User profile ID associated with this request.

connectionTypesGet(id: bigint, profileId: bigint): Promise<ConnectionType>

[src]

Gets one connection type by ID.

@param id

Connection type ID.

@param profileId

User profile ID associated with this request.

connectionTypesList(profileId: bigint): Promise<ConnectionTypesListResponse>

[src]

Retrieves a list of connection types.

@param profileId

User profile ID associated with this request.

contentCategoriesDelete(id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing content category.

@param id

Content category ID.

@param profileId

User profile ID associated with this request.

contentCategoriesGet(id: bigint, profileId: bigint): Promise<ContentCategory>

[src]

Gets one content category by ID.

@param id

Content category ID.

@param profileId

User profile ID associated with this request.

contentCategoriesInsert(profileId: bigint, req: ContentCategory): Promise<ContentCategory>

[src]

Inserts a new content category.

@param profileId

User profile ID associated with this request.

contentCategoriesList(profileId: bigint, opts?: ContentCategoriesListOptions): Promise<ContentCategoriesListResponse>

[src]

Retrieves a list of content categories, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

contentCategoriesPatch(profileId: bigint, req: ContentCategory, opts?: ContentCategoriesPatchOptions): Promise<ContentCategory>

[src]

Updates an existing content category. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

contentCategoriesUpdate(profileId: bigint, req: ContentCategory): Promise<ContentCategory>

[src]

Updates an existing content category.

@param profileId

User profile ID associated with this request.

conversionsBatchinsert(profileId: bigint, req: ConversionsBatchInsertRequest): Promise<ConversionsBatchInsertResponse>

[src]

Inserts conversions.

@param profileId

User profile ID associated with this request.

conversionsBatchupdate(profileId: bigint, req: ConversionsBatchUpdateRequest): Promise<ConversionsBatchUpdateResponse>

[src]

Updates existing conversions.

@param profileId

User profile ID associated with this request.

countriesGet(dartId: bigint, profileId: bigint): Promise<Country>

[src]

Gets one country by ID.

@param dartId

Country DART ID.

@param profileId

User profile ID associated with this request.

countriesList(profileId: bigint): Promise<CountriesListResponse>

[src]

Retrieves a list of countries.

@param profileId

User profile ID associated with this request.

creativeAssetsInsert(advertiserId: bigint, profileId: bigint, req: CreativeAssetMetadata): Promise<CreativeAssetMetadata>

[src]

Inserts a new creative asset.

@param advertiserId

Advertiser ID of this creative. This is a required field.

@param profileId

User profile ID associated with this request.

creativeFieldsDelete(id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing creative field.

@param id

Creative Field ID

@param profileId

User profile ID associated with this request.

creativeFieldsGet(id: bigint, profileId: bigint): Promise<CreativeField>

[src]

Gets one creative field by ID.

@param id

Creative Field ID

@param profileId

User profile ID associated with this request.

creativeFieldsInsert(profileId: bigint, req: CreativeField): Promise<CreativeField>

[src]

Inserts a new creative field.

@param profileId

User profile ID associated with this request.

creativeFieldsList(profileId: bigint, opts?: CreativeFieldsListOptions): Promise<CreativeFieldsListResponse>

[src]

Retrieves a list of creative fields, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

creativeFieldsPatch(profileId: bigint, req: CreativeField, opts?: CreativeFieldsPatchOptions): Promise<CreativeField>

[src]

Updates an existing creative field. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

creativeFieldsUpdate(profileId: bigint, req: CreativeField): Promise<CreativeField>

[src]

Updates an existing creative field.

@param profileId

User profile ID associated with this request.

creativeFieldValuesDelete(creativeFieldId: bigint, id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing creative field value.

@param creativeFieldId

Creative field ID for this creative field value.

@param id

Creative Field Value ID

@param profileId

User profile ID associated with this request.

creativeFieldValuesGet(creativeFieldId: bigint, id: bigint, profileId: bigint): Promise<CreativeFieldValue>

[src]

Gets one creative field value by ID.

@param creativeFieldId

Creative field ID for this creative field value.

@param id

Creative Field Value ID

@param profileId

User profile ID associated with this request.

creativeFieldValuesInsert(creativeFieldId: bigint, profileId: bigint, req: CreativeFieldValue): Promise<CreativeFieldValue>

[src]

Inserts a new creative field value.

@param creativeFieldId

Creative field ID for this creative field value.

@param profileId

User profile ID associated with this request.

creativeFieldValuesList(creativeFieldId: bigint, profileId: bigint, opts?: CreativeFieldValuesListOptions): Promise<CreativeFieldValuesListResponse>

[src]

Retrieves a list of creative field values, possibly filtered. This method supports paging.

@param creativeFieldId

Creative field ID for this creative field value.

@param profileId

User profile ID associated with this request.

creativeFieldValuesPatch(creativeFieldId: bigint, profileId: bigint, req: CreativeFieldValue, opts?: CreativeFieldValuesPatchOptions): Promise<CreativeFieldValue>

[src]

Updates an existing creative field value. This method supports patch semantics.

@param creativeFieldId

CreativeField ID.

@param profileId

User profile ID associated with this request.

creativeFieldValuesUpdate(creativeFieldId: bigint, profileId: bigint, req: CreativeFieldValue): Promise<CreativeFieldValue>

[src]

Updates an existing creative field value.

@param creativeFieldId

Creative field ID for this creative field value.

@param profileId

User profile ID associated with this request.

creativeGroupsGet(id: bigint, profileId: bigint): Promise<CreativeGroup>

[src]

Gets one creative group by ID.

@param id

Creative group ID.

@param profileId

User profile ID associated with this request.

creativeGroupsInsert(profileId: bigint, req: CreativeGroup): Promise<CreativeGroup>

[src]

Inserts a new creative group.

@param profileId

User profile ID associated with this request.

creativeGroupsList(profileId: bigint, opts?: CreativeGroupsListOptions): Promise<CreativeGroupsListResponse>

[src]

Retrieves a list of creative groups, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

creativeGroupsPatch(profileId: bigint, req: CreativeGroup, opts?: CreativeGroupsPatchOptions): Promise<CreativeGroup>

[src]

Updates an existing creative group. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

creativeGroupsUpdate(profileId: bigint, req: CreativeGroup): Promise<CreativeGroup>

[src]

Updates an existing creative group.

@param profileId

User profile ID associated with this request.

creativesGet(id: bigint, profileId: bigint): Promise<Creative>

[src]

Gets one creative by ID.

@param id

Creative ID.

@param profileId

User profile ID associated with this request.

creativesInsert(profileId: bigint, req: Creative): Promise<Creative>

[src]

Inserts a new creative.

@param profileId

User profile ID associated with this request.

creativesList(profileId: bigint, opts?: CreativesListOptions): Promise<CreativesListResponse>

[src]

Retrieves a list of creatives, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

creativesPatch(profileId: bigint, req: Creative, opts?: CreativesPatchOptions): Promise<Creative>

[src]

Updates an existing creative. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

creativesUpdate(profileId: bigint, req: Creative): Promise<Creative>

[src]

Updates an existing creative.

@param profileId

User profile ID associated with this request.

dimensionValuesQuery(profileId: bigint, req: DimensionValueRequest, opts?: DimensionValuesQueryOptions): Promise<DimensionValueList>

[src]

Retrieves list of report dimension values for a list of filters.

@param profileId

The Campaign Manager 360 user profile ID.

directorySitesGet(id: bigint, profileId: bigint): Promise<DirectorySite>

[src]

Gets one directory site by ID.

@param id

Directory site ID.

@param profileId

User profile ID associated with this request.

directorySitesInsert(profileId: bigint, req: DirectorySite): Promise<DirectorySite>

[src]

Inserts a new directory site.

@param profileId

User profile ID associated with this request.

directorySitesList(profileId: bigint, opts?: DirectorySitesListOptions): Promise<DirectorySitesListResponse>

[src]

Retrieves a list of directory sites, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

dynamicTargetingKeysDelete(objectId: bigint, profileId: bigint, opts?: DynamicTargetingKeysDeleteOptions): Promise<void>

[src]

Deletes an existing dynamic targeting key.

@param objectId

ID of the object of this dynamic targeting key. This is a required field.

@param profileId

User profile ID associated with this request.

dynamicTargetingKeysInsert(profileId: bigint, req: DynamicTargetingKey): Promise<DynamicTargetingKey>

[src]

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.

@param profileId

User profile ID associated with this request.

dynamicTargetingKeysList(profileId: bigint, opts?: DynamicTargetingKeysListOptions): Promise<DynamicTargetingKeysListResponse>

[src]

Retrieves a list of dynamic targeting keys.

@param profileId

User profile ID associated with this request.

eventTagsDelete(id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing event tag.

@param id

Event tag ID.

@param profileId

User profile ID associated with this request.

eventTagsGet(id: bigint, profileId: bigint): Promise<EventTag>

[src]

Gets one event tag by ID.

@param id

Event tag ID.

@param profileId

User profile ID associated with this request.

eventTagsInsert(profileId: bigint, req: EventTag): Promise<EventTag>

[src]

Inserts a new event tag.

@param profileId

User profile ID associated with this request.

eventTagsList(profileId: bigint, opts?: EventTagsListOptions): Promise<EventTagsListResponse>

[src]

Retrieves a list of event tags, possibly filtered.

@param profileId

User profile ID associated with this request.

eventTagsPatch(profileId: bigint, req: EventTag, opts?: EventTagsPatchOptions): Promise<EventTag>

[src]

Updates an existing event tag. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

eventTagsUpdate(profileId: bigint, req: EventTag): Promise<EventTag>

[src]

Updates an existing event tag.

@param profileId

User profile ID associated with this request.

filesGet(fileId: bigint, reportId: bigint): Promise<File>

[src]

Retrieves a report file by its report ID and file ID. This method supports media download.

@param fileId

The ID of the report file.

@param reportId

The ID of the report.

filesList(profileId: bigint, opts?: FilesListOptions): Promise<FileList>

[src]

Lists files for a user profile.

@param profileId

The Campaign Manager 360 user profile ID.

floodlightActivitiesDelete(id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing floodlight activity.

@param id

Floodlight activity ID.

@param profileId

User profile ID associated with this request.

floodlightActivitiesGeneratetag(profileId: bigint, opts?: FloodlightActivitiesGeneratetagOptions): Promise<FloodlightActivitiesGenerateTagResponse>

[src]

Generates a tag for a floodlight activity.

@param profileId

User profile ID associated with this request.

floodlightActivitiesGet(id: bigint, profileId: bigint): Promise<FloodlightActivity>

[src]

Gets one floodlight activity by ID.

@param id

Floodlight activity ID.

@param profileId

User profile ID associated with this request.

floodlightActivitiesInsert(profileId: bigint, req: FloodlightActivity): Promise<FloodlightActivity>

[src]

Inserts a new floodlight activity.

@param profileId

User profile ID associated with this request.

floodlightActivitiesList(profileId: bigint, opts?: FloodlightActivitiesListOptions): Promise<FloodlightActivitiesListResponse>

[src]

Retrieves a list of floodlight activities, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

floodlightActivitiesPatch(profileId: bigint, req: FloodlightActivity, opts?: FloodlightActivitiesPatchOptions): Promise<FloodlightActivity>

[src]

Updates an existing event tag. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

floodlightActivitiesUpdate(profileId: bigint, req: FloodlightActivity): Promise<FloodlightActivity>

[src]

Updates an existing floodlight activity.

@param profileId

User profile ID associated with this request.

floodlightActivityGroupsGet(id: bigint, profileId: bigint): Promise<FloodlightActivityGroup>

[src]

Gets one floodlight activity group by ID.

@param id

Floodlight activity Group ID.

@param profileId

User profile ID associated with this request.

floodlightActivityGroupsInsert(profileId: bigint, req: FloodlightActivityGroup): Promise<FloodlightActivityGroup>

[src]

Inserts a new floodlight activity group.

@param profileId

User profile ID associated with this request.

floodlightActivityGroupsList(profileId: bigint, opts?: FloodlightActivityGroupsListOptions): Promise<FloodlightActivityGroupsListResponse>

[src]

Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

floodlightActivityGroupsPatch(profileId: bigint, req: FloodlightActivityGroup, opts?: FloodlightActivityGroupsPatchOptions): Promise<FloodlightActivityGroup>

[src]

Updates an existing event tag. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

floodlightActivityGroupsUpdate(profileId: bigint, req: FloodlightActivityGroup): Promise<FloodlightActivityGroup>

[src]

Updates an existing floodlight activity group.

@param profileId

User profile ID associated with this request.

floodlightConfigurationsGet(id: bigint, profileId: bigint): Promise<FloodlightConfiguration>

[src]

Gets one floodlight configuration by ID.

@param id

Floodlight configuration ID.

@param profileId

User profile ID associated with this request.

floodlightConfigurationsList(profileId: bigint, opts?: FloodlightConfigurationsListOptions): Promise<FloodlightConfigurationsListResponse>

[src]

Retrieves a list of floodlight configurations, possibly filtered.

@param profileId

User profile ID associated with this request.

floodlightConfigurationsPatch(profileId: bigint, req: FloodlightConfiguration, opts?: FloodlightConfigurationsPatchOptions): Promise<FloodlightConfiguration>

[src]

Updates an existing event tag. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

floodlightConfigurationsUpdate(profileId: bigint, req: FloodlightConfiguration): Promise<FloodlightConfiguration>

[src]

Updates an existing floodlight configuration.

@param profileId

User profile ID associated with this request.

inventoryItemsGet(id: bigint, profileId: bigint, projectId: bigint): Promise<InventoryItem>

[src]

Gets one inventory item by ID.

@param id

Inventory item ID.

@param profileId

User profile ID associated with this request.

@param projectId

Project ID for order documents.

inventoryItemsList(profileId: bigint, projectId: bigint, opts?: InventoryItemsListOptions): Promise<InventoryItemsListResponse>

[src]

Retrieves a list of inventory items, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

@param projectId

Project ID for order documents.

languagesList(profileId: bigint): Promise<LanguagesListResponse>

[src]

Retrieves a list of languages.

@param profileId

User profile ID associated with this request.

metrosList(profileId: bigint): Promise<MetrosListResponse>

[src]

Retrieves a list of metros.

@param profileId

User profile ID associated with this request.

mobileAppsGet(id: string, profileId: bigint): Promise<MobileApp>

[src]

Gets one mobile app by ID.

@param id

Mobile app ID.

@param profileId

User profile ID associated with this request.

mobileAppsList(profileId: bigint, opts?: MobileAppsListOptions): Promise<MobileAppsListResponse>

[src]

Retrieves list of available mobile apps.

@param profileId

User profile ID associated with this request.

mobileCarriersGet(id: bigint, profileId: bigint): Promise<MobileCarrier>

[src]

Gets one mobile carrier by ID.

@param id

Mobile carrier ID.

@param profileId

User profile ID associated with this request.

mobileCarriersList(profileId: bigint): Promise<MobileCarriersListResponse>

[src]

Retrieves a list of mobile carriers.

@param profileId

User profile ID associated with this request.

operatingSystemsGet(dartId: bigint, profileId: bigint): Promise<OperatingSystem>

[src]

Gets one operating system by DART ID.

@param dartId

Operating system DART ID.

@param profileId

User profile ID associated with this request.

operatingSystemsList(profileId: bigint): Promise<OperatingSystemsListResponse>

[src]

Retrieves a list of operating systems.

@param profileId

User profile ID associated with this request.

operatingSystemVersionsGet(id: bigint, profileId: bigint): Promise<OperatingSystemVersion>

[src]

Gets one operating system version by ID.

@param id

Operating system version ID.

@param profileId

User profile ID associated with this request.

operatingSystemVersionsList(profileId: bigint): Promise<OperatingSystemVersionsListResponse>

[src]

Retrieves a list of operating system versions.

@param profileId

User profile ID associated with this request.

ordersGet(id: bigint, profileId: bigint, projectId: bigint): Promise<Order>

[src]

Gets one order by ID.

@param id

Order ID.

@param profileId

User profile ID associated with this request.

@param projectId

Project ID for orders.

ordersList(profileId: bigint, projectId: bigint, opts?: OrdersListOptions): Promise<OrdersListResponse>

[src]

Retrieves a list of orders, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

@param projectId

Project ID for orders.

placementGroupsGet(id: bigint, profileId: bigint): Promise<PlacementGroup>

[src]

Gets one placement group by ID.

@param id

Placement group ID.

@param profileId

User profile ID associated with this request.

placementGroupsInsert(profileId: bigint, req: PlacementGroup): Promise<PlacementGroup>

[src]

Inserts a new placement group.

@param profileId

User profile ID associated with this request.

placementGroupsList(profileId: bigint, opts?: PlacementGroupsListOptions): Promise<PlacementGroupsListResponse>

[src]

Retrieves a list of placement groups, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

placementGroupsPatch(profileId: bigint, req: PlacementGroup, opts?: PlacementGroupsPatchOptions): Promise<PlacementGroup>

[src]

Updates an existing placement group. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

placementGroupsUpdate(profileId: bigint, req: PlacementGroup): Promise<PlacementGroup>

[src]

Updates an existing placement group.

@param profileId

User profile ID associated with this request.

placementsGeneratetags(profileId: bigint, opts?: PlacementsGeneratetagsOptions): Promise<PlacementsGenerateTagsResponse>

[src]

Generates tags for a placement.

@param profileId

User profile ID associated with this request.

placementsGet(id: bigint, profileId: bigint): Promise<Placement>

[src]

Gets one placement by ID.

@param id

Placement ID.

@param profileId

User profile ID associated with this request.

placementsInsert(profileId: bigint, req: Placement): Promise<Placement>

[src]

Inserts a new placement.

@param profileId

User profile ID associated with this request.

placementsList(profileId: bigint, opts?: PlacementsListOptions): Promise<PlacementsListResponse>

[src]

Retrieves a list of placements, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

placementsPatch(profileId: bigint, req: Placement, opts?: PlacementsPatchOptions): Promise<Placement>

[src]

Updates an existing placement. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

placementStrategiesDelete(id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing placement strategy.

@param id

Placement strategy ID.

@param profileId

User profile ID associated with this request.

placementStrategiesGet(id: bigint, profileId: bigint): Promise<PlacementStrategy>

[src]

Gets one placement strategy by ID.

@param id

Placement strategy ID.

@param profileId

User profile ID associated with this request.

placementStrategiesInsert(profileId: bigint, req: PlacementStrategy): Promise<PlacementStrategy>

[src]

Inserts a new placement strategy.

@param profileId

User profile ID associated with this request.

placementStrategiesList(profileId: bigint, opts?: PlacementStrategiesListOptions): Promise<PlacementStrategiesListResponse>

[src]

Retrieves a list of placement strategies, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

placementStrategiesPatch(profileId: bigint, req: PlacementStrategy, opts?: PlacementStrategiesPatchOptions): Promise<PlacementStrategy>

[src]

Updates an existing placement strategy. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

placementStrategiesUpdate(profileId: bigint, req: PlacementStrategy): Promise<PlacementStrategy>

[src]

Updates an existing placement strategy.

@param profileId

User profile ID associated with this request.

placementsUpdate(profileId: bigint, req: Placement): Promise<Placement>

[src]

Updates an existing placement.

@param profileId

User profile ID associated with this request.

platformTypesGet(id: bigint, profileId: bigint): Promise<PlatformType>

[src]

Gets one platform type by ID.

@param id

Platform type ID.

@param profileId

User profile ID associated with this request.

platformTypesList(profileId: bigint): Promise<PlatformTypesListResponse>

[src]

Retrieves a list of platform types.

@param profileId

User profile ID associated with this request.

postalCodesGet(code: string, profileId: bigint): Promise<PostalCode>

[src]

Gets one postal code by ID.

@param code

Postal code ID.

@param profileId

User profile ID associated with this request.

postalCodesList(profileId: bigint): Promise<PostalCodesListResponse>

[src]

Retrieves a list of postal codes.

@param profileId

User profile ID associated with this request.

projectsGet(id: bigint, profileId: bigint): Promise<Project>

[src]

Gets one project by ID.

@param id

Project ID.

@param profileId

User profile ID associated with this request.

projectsList(profileId: bigint, opts?: ProjectsListOptions): Promise<ProjectsListResponse>

[src]

Retrieves a list of projects, possibly filtered. This method supports paging .

@param profileId

User profile ID associated with this request.

regionsList(profileId: bigint): Promise<RegionsListResponse>

[src]

Retrieves a list of regions.

@param profileId

User profile ID associated with this request.

remarketingListsGet(id: bigint, profileId: bigint): Promise<RemarketingList>

[src]

Gets one remarketing list by ID.

@param id

Remarketing list ID.

@param profileId

User profile ID associated with this request.

remarketingListSharesGet(profileId: bigint, remarketingListId: bigint): Promise<RemarketingListShare>

[src]

Gets one remarketing list share by remarketing list ID.

@param profileId

User profile ID associated with this request.

@param remarketingListId

Remarketing list ID.

remarketingListSharesPatch(profileId: bigint, req: RemarketingListShare, opts?: RemarketingListSharesPatchOptions): Promise<RemarketingListShare>

[src]

Updates an existing RemarketingListShare. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

remarketingListSharesUpdate(profileId: bigint, req: RemarketingListShare): Promise<RemarketingListShare>

[src]

Updates an existing remarketing list share.

@param profileId

User profile ID associated with this request.

remarketingListsInsert(profileId: bigint, req: RemarketingList): Promise<RemarketingList>

[src]

Inserts a new remarketing list.

@param profileId

User profile ID associated with this request.

remarketingListsList(profileId: bigint, opts?: RemarketingListsListOptions): Promise<RemarketingListsListResponse>

[src]

Retrieves a list of remarketing lists, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

remarketingListsPatch(profileId: bigint, req: RemarketingList, opts?: RemarketingListsPatchOptions): Promise<RemarketingList>

[src]

Updates an existing RemarketingList. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

remarketingListsUpdate(profileId: bigint, req: RemarketingList): Promise<RemarketingList>

[src]

Updates an existing remarketing list.

@param profileId

User profile ID associated with this request.

reportsCompatibleFieldsQuery(profileId: bigint, req: Report): Promise<CompatibleFields>

[src]

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.

@param profileId

The Campaign Manager 360 user profile ID.

reportsDelete(profileId: bigint, reportId: bigint): Promise<void>

[src]

Deletes a report by its ID.

@param profileId

The Campaign Manager 360 user profile ID.

@param reportId

The ID of the report.

reportsFilesGet(fileId: bigint, profileId: bigint, reportId: bigint): Promise<File>

[src]

Retrieves a report file by its report ID and file ID. This method supports media download.

@param fileId

The ID of the report file.

@param profileId

The Campaign Manager 360 user profile ID.

@param reportId

The ID of the report.

reportsFilesList(profileId: bigint, reportId: bigint, opts?: ReportsFilesListOptions): Promise<FileList>

[src]

Lists files for a report.

@param profileId

The Campaign Manager 360 user profile ID.

@param reportId

The ID of the parent report.

reportsGet(profileId: bigint, reportId: bigint): Promise<Report>

[src]

Retrieves a report by its ID.

@param profileId

The Campaign Manager 360 user profile ID.

@param reportId

The ID of the report.

reportsInsert(profileId: bigint, req: Report): Promise<Report>

[src]

Creates a report.

@param profileId

The Campaign Manager 360 user profile ID.

reportsList(profileId: bigint, opts?: ReportsListOptions): Promise<ReportList>

[src]

Retrieves list of reports.

@param profileId

The Campaign Manager 360 user profile ID.

reportsPatch(profileId: bigint, reportId: bigint, req: Report): Promise<Report>

[src]

Updates an existing report. This method supports patch semantics.

@param profileId

The Campaign Manager 360 user profile ID.

@param reportId

The ID of the report.

reportsRun(profileId: bigint, reportId: bigint, opts?: ReportsRunOptions): Promise<File>

[src]

Runs a report.

@param profileId

The Campaign Manager 360 user profile ID.

@param reportId

The ID of the report.

reportsUpdate(profileId: bigint, reportId: bigint, req: Report): Promise<Report>

[src]

Updates a report.

@param profileId

The Campaign Manager 360 user profile ID.

@param reportId

The ID of the report.

sitesGet(id: bigint, profileId: bigint): Promise<Site>

[src]

Gets one site by ID.

@param id

Site ID.

@param profileId

User profile ID associated with this request.

sitesInsert(profileId: bigint, req: Site): Promise<Site>

[src]

Inserts a new site.

@param profileId

User profile ID associated with this request.

sitesList(profileId: bigint, opts?: SitesListOptions): Promise<SitesListResponse>

[src]

Retrieves a list of sites, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

sitesPatch(profileId: bigint, req: Site, opts?: SitesPatchOptions): Promise<Site>

[src]

Updates an existing site. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

sitesUpdate(profileId: bigint, req: Site): Promise<Site>

[src]

Updates an existing site.

@param profileId

User profile ID associated with this request.

sizesGet(id: bigint, profileId: bigint): Promise<Size>

[src]

Gets one size by ID.

@param id

Size ID.

@param profileId

User profile ID associated with this request.

sizesInsert(profileId: bigint, req: Size): Promise<Size>

[src]

Inserts a new size.

@param profileId

User profile ID associated with this request.

sizesList(profileId: bigint, opts?: SizesListOptions): Promise<SizesListResponse>

[src]

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.

@param profileId

User profile ID associated with this request.

subaccountsGet(id: bigint, profileId: bigint): Promise<Subaccount>

[src]

Gets one subaccount by ID.

@param id

Subaccount ID.

@param profileId

User profile ID associated with this request.

subaccountsInsert(profileId: bigint, req: Subaccount): Promise<Subaccount>

[src]

Inserts a new subaccount.

@param profileId

User profile ID associated with this request.

subaccountsList(profileId: bigint, opts?: SubaccountsListOptions): Promise<SubaccountsListResponse>

[src]

Gets a list of subaccounts, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

subaccountsPatch(profileId: bigint, req: Subaccount, opts?: SubaccountsPatchOptions): Promise<Subaccount>

[src]

Updates an existing subaccount. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

subaccountsUpdate(profileId: bigint, req: Subaccount): Promise<Subaccount>

[src]

Updates an existing subaccount.

@param profileId

User profile ID associated with this request.

targetableRemarketingListsGet(id: bigint, profileId: bigint): Promise<TargetableRemarketingList>

[src]

Gets one remarketing list by ID.

@param id

Remarketing list ID.

@param profileId

User profile ID associated with this request.

targetableRemarketingListsList(profileId: bigint, opts?: TargetableRemarketingListsListOptions): Promise<TargetableRemarketingListsListResponse>

[src]

Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

targetingTemplatesGet(id: bigint, profileId: bigint): Promise<TargetingTemplate>

[src]

Gets one targeting template by ID.

@param id

Targeting template ID.

@param profileId

User profile ID associated with this request.

targetingTemplatesInsert(profileId: bigint, req: TargetingTemplate): Promise<TargetingTemplate>

[src]

Inserts a new targeting template.

@param profileId

User profile ID associated with this request.

targetingTemplatesList(profileId: bigint, opts?: TargetingTemplatesListOptions): Promise<TargetingTemplatesListResponse>

[src]

Retrieves a list of targeting templates, optionally filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

targetingTemplatesPatch(profileId: bigint, req: TargetingTemplate, opts?: TargetingTemplatesPatchOptions): Promise<TargetingTemplate>

[src]

Updates an existing targeting template. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

targetingTemplatesUpdate(profileId: bigint, req: TargetingTemplate): Promise<TargetingTemplate>

[src]

Updates an existing targeting template.

@param profileId

User profile ID associated with this request.

userProfilesGet(profileId: bigint): Promise<UserProfile>

[src]

Gets one user profile by ID.

@param profileId

The user profile ID.

userProfilesList(): Promise<UserProfileList>

[src]

Retrieves list of user profiles for a user.

userRolePermissionGroupsGet(id: bigint, profileId: bigint): Promise<UserRolePermissionGroup>

[src]

Gets one user role permission group by ID.

@param id

User role permission group ID.

@param profileId

User profile ID associated with this request.

userRolePermissionGroupsList(profileId: bigint): Promise<UserRolePermissionGroupsListResponse>

[src]

Gets a list of all supported user role permission groups.

@param profileId

User profile ID associated with this request.

userRolePermissionsGet(id: bigint, profileId: bigint): Promise<UserRolePermission>

[src]

Gets one user role permission by ID.

@param id

User role permission ID.

@param profileId

User profile ID associated with this request.

userRolePermissionsList(profileId: bigint, opts?: UserRolePermissionsListOptions): Promise<UserRolePermissionsListResponse>

[src]

Gets a list of user role permissions, possibly filtered.

@param profileId

User profile ID associated with this request.

userRolesDelete(id: bigint, profileId: bigint): Promise<void>

[src]

Deletes an existing user role.

@param id

User role ID.

@param profileId

User profile ID associated with this request.

userRolesGet(id: bigint, profileId: bigint): Promise<UserRole>

[src]

Gets one user role by ID.

@param id

User role ID.

@param profileId

User profile ID associated with this request.

userRolesInsert(profileId: bigint, req: UserRole): Promise<UserRole>

[src]

Inserts a new user role.

@param profileId

User profile ID associated with this request.

userRolesList(profileId: bigint, opts?: UserRolesListOptions): Promise<UserRolesListResponse>

[src]

Retrieves a list of user roles, possibly filtered. This method supports paging.

@param profileId

User profile ID associated with this request.

userRolesPatch(profileId: bigint, req: UserRole, opts?: UserRolesPatchOptions): Promise<UserRole>

[src]

Updates an existing user role. This method supports patch semantics.

@param profileId

User profile ID associated with this request.

userRolesUpdate(profileId: bigint, req: UserRole): Promise<UserRole>

[src]

Updates an existing user role.

@param profileId

User profile ID associated with this request.

videoFormatsGet(id: number, profileId: bigint): Promise<VideoFormat>

[src]

Gets one video format by ID.

@param id

Video format ID.

@param profileId

User profile ID associated with this request.

videoFormatsList(profileId: bigint): Promise<VideoFormatsListResponse>

[src]

Lists available video formats.

@param profileId

User profile ID associated with this request.