TypeScript typings for Campaign Manager 360 API v4
Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.
For detailed description please check documentation.
Installing
Install typings for Campaign Manager 360 API:
npm install @types/gapi.client.dfareporting-v4 --save-dev
Usage
You need to initialize Google API client in your code:
gapi.load('client', () => {
});
Then load api client wrapper:
gapi.client.load('https://dfareporting.googleapis.com/$discovery/rest?version=v4', () => {
});
gapi.client.load('dfareporting', 'v4', () => {
});
Don't forget to authenticate your client before sending any request to resources:
var client_id = '',
scope = [
'https://www.googleapis.com/auth/ddmconversions',
'https://www.googleapis.com/auth/dfareporting',
'https://www.googleapis.com/auth/dfatrafficking',
],
immediate = true;
gapi.auth.authorize(
{ client_id: client_id, scope: scope, immediate: immediate },
authResult => {
if (authResult && !authResult.error) {
} else {
}
});
After that you can use Campaign Manager 360 API resources:
await gapi.client.dfareporting.accountActiveAdSummaries.get({ profileId: "profileId", summaryAccountId: "summaryAccountId", });
await gapi.client.dfareporting.accountPermissionGroups.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.accountPermissionGroups.list({ profileId: "profileId", });
await gapi.client.dfareporting.accountPermissions.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.accountPermissions.list({ profileId: "profileId", });
await gapi.client.dfareporting.accounts.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.accounts.list({ profileId: "profileId", });
await gapi.client.dfareporting.accounts.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.accounts.update({ profileId: "profileId", });
await gapi.client.dfareporting.accountUserProfiles.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.accountUserProfiles.insert({ profileId: "profileId", });
await gapi.client.dfareporting.accountUserProfiles.list({ profileId: "profileId", });
await gapi.client.dfareporting.accountUserProfiles.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.accountUserProfiles.update({ profileId: "profileId", });
await gapi.client.dfareporting.ads.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.ads.insert({ profileId: "profileId", });
await gapi.client.dfareporting.ads.list({ profileId: "profileId", });
await gapi.client.dfareporting.ads.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.ads.update({ profileId: "profileId", });
await gapi.client.dfareporting.advertiserGroups.delete({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.advertiserGroups.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.advertiserGroups.insert({ profileId: "profileId", });
await gapi.client.dfareporting.advertiserGroups.list({ profileId: "profileId", });
await gapi.client.dfareporting.advertiserGroups.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.advertiserGroups.update({ profileId: "profileId", });
await gapi.client.dfareporting.advertiserInvoices.list({ advertiserId: "advertiserId", profileId: "profileId", });
await gapi.client.dfareporting.advertiserLandingPages.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.advertiserLandingPages.insert({ profileId: "profileId", });
await gapi.client.dfareporting.advertiserLandingPages.list({ profileId: "profileId", });
await gapi.client.dfareporting.advertiserLandingPages.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.advertiserLandingPages.update({ profileId: "profileId", });
await gapi.client.dfareporting.advertisers.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.advertisers.insert({ profileId: "profileId", });
await gapi.client.dfareporting.advertisers.list({ profileId: "profileId", });
await gapi.client.dfareporting.advertisers.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.advertisers.update({ profileId: "profileId", });
await gapi.client.dfareporting.billingAssignments.insert({ billingProfileId: "billingProfileId", profileId: "profileId", });
await gapi.client.dfareporting.billingAssignments.list({ billingProfileId: "billingProfileId", profileId: "profileId", });
await gapi.client.dfareporting.billingProfiles.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.billingProfiles.list({ profileId: "profileId", });
await gapi.client.dfareporting.billingProfiles.update({ profileId: "profileId", });
await gapi.client.dfareporting.billingRates.list({ billingProfileId: "billingProfileId", profileId: "profileId", });
await gapi.client.dfareporting.browsers.list({ profileId: "profileId", });
await gapi.client.dfareporting.campaignCreativeAssociations.insert({ campaignId: "campaignId", profileId: "profileId", });
await gapi.client.dfareporting.campaignCreativeAssociations.list({ campaignId: "campaignId", profileId: "profileId", });
await gapi.client.dfareporting.campaigns.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.campaigns.insert({ profileId: "profileId", });
await gapi.client.dfareporting.campaigns.list({ profileId: "profileId", });
await gapi.client.dfareporting.campaigns.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.campaigns.update({ profileId: "profileId", });
await gapi.client.dfareporting.changeLogs.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.changeLogs.list({ profileId: "profileId", });
await gapi.client.dfareporting.cities.list({ profileId: "profileId", });
await gapi.client.dfareporting.connectionTypes.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.connectionTypes.list({ profileId: "profileId", });
await gapi.client.dfareporting.contentCategories.delete({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.contentCategories.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.contentCategories.insert({ profileId: "profileId", });
await gapi.client.dfareporting.contentCategories.list({ profileId: "profileId", });
await gapi.client.dfareporting.contentCategories.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.contentCategories.update({ profileId: "profileId", });
await gapi.client.dfareporting.conversions.batchinsert({ profileId: "profileId", });
await gapi.client.dfareporting.conversions.batchupdate({ profileId: "profileId", });
await gapi.client.dfareporting.countries.get({ dartId: "dartId", profileId: "profileId", });
await gapi.client.dfareporting.countries.list({ profileId: "profileId", });
await gapi.client.dfareporting.creativeAssets.insert({ advertiserId: "advertiserId", profileId: "profileId", });
await gapi.client.dfareporting.creativeFields.delete({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeFields.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeFields.insert({ profileId: "profileId", });
await gapi.client.dfareporting.creativeFields.list({ profileId: "profileId", });
await gapi.client.dfareporting.creativeFields.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeFields.update({ profileId: "profileId", });
await gapi.client.dfareporting.creativeFieldValues.delete({ creativeFieldId: "creativeFieldId", id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeFieldValues.get({ creativeFieldId: "creativeFieldId", id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeFieldValues.insert({ creativeFieldId: "creativeFieldId", profileId: "profileId", });
await gapi.client.dfareporting.creativeFieldValues.list({ creativeFieldId: "creativeFieldId", profileId: "profileId", });
await gapi.client.dfareporting.creativeFieldValues.patch({ creativeFieldId: "creativeFieldId", id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeFieldValues.update({ creativeFieldId: "creativeFieldId", profileId: "profileId", });
await gapi.client.dfareporting.creativeGroups.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeGroups.insert({ profileId: "profileId", });
await gapi.client.dfareporting.creativeGroups.list({ profileId: "profileId", });
await gapi.client.dfareporting.creativeGroups.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creativeGroups.update({ profileId: "profileId", });
await gapi.client.dfareporting.creatives.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creatives.insert({ profileId: "profileId", });
await gapi.client.dfareporting.creatives.list({ profileId: "profileId", });
await gapi.client.dfareporting.creatives.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.creatives.update({ profileId: "profileId", });
await gapi.client.dfareporting.dimensionValues.query({ profileId: "profileId", });
await gapi.client.dfareporting.directorySites.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.directorySites.insert({ profileId: "profileId", });
await gapi.client.dfareporting.directorySites.list({ profileId: "profileId", });
await gapi.client.dfareporting.dynamicTargetingKeys.delete({ name: "name", objectId: "objectId", objectType: "objectType", profileId: "profileId", });
await gapi.client.dfareporting.dynamicTargetingKeys.insert({ profileId: "profileId", });
await gapi.client.dfareporting.dynamicTargetingKeys.list({ profileId: "profileId", });
await gapi.client.dfareporting.eventTags.delete({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.eventTags.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.eventTags.insert({ profileId: "profileId", });
await gapi.client.dfareporting.eventTags.list({ profileId: "profileId", });
await gapi.client.dfareporting.eventTags.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.eventTags.update({ profileId: "profileId", });
await gapi.client.dfareporting.files.get({ fileId: "fileId", reportId: "reportId", });
await gapi.client.dfareporting.files.list({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivities.delete({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivities.generatetag({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivities.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivities.insert({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivities.list({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivities.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivities.update({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivityGroups.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivityGroups.insert({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivityGroups.list({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivityGroups.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.floodlightActivityGroups.update({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightConfigurations.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.floodlightConfigurations.list({ profileId: "profileId", });
await gapi.client.dfareporting.floodlightConfigurations.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.floodlightConfigurations.update({ profileId: "profileId", });
await gapi.client.dfareporting.inventoryItems.get({ id: "id", profileId: "profileId", projectId: "projectId", });
await gapi.client.dfareporting.inventoryItems.list({ profileId: "profileId", projectId: "projectId", });
await gapi.client.dfareporting.languages.list({ profileId: "profileId", });
await gapi.client.dfareporting.metros.list({ profileId: "profileId", });
await gapi.client.dfareporting.mobileApps.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.mobileApps.list({ profileId: "profileId", });
await gapi.client.dfareporting.mobileCarriers.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.mobileCarriers.list({ profileId: "profileId", });
await gapi.client.dfareporting.operatingSystems.get({ dartId: "dartId", profileId: "profileId", });
await gapi.client.dfareporting.operatingSystems.list({ profileId: "profileId", });
await gapi.client.dfareporting.operatingSystemVersions.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.operatingSystemVersions.list({ profileId: "profileId", });
await gapi.client.dfareporting.orders.get({ id: "id", profileId: "profileId", projectId: "projectId", });
await gapi.client.dfareporting.orders.list({ profileId: "profileId", projectId: "projectId", });
await gapi.client.dfareporting.placementGroups.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.placementGroups.insert({ profileId: "profileId", });
await gapi.client.dfareporting.placementGroups.list({ profileId: "profileId", });
await gapi.client.dfareporting.placementGroups.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.placementGroups.update({ profileId: "profileId", });
await gapi.client.dfareporting.placements.generatetags({ profileId: "profileId", });
await gapi.client.dfareporting.placements.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.placements.insert({ profileId: "profileId", });
await gapi.client.dfareporting.placements.list({ profileId: "profileId", });
await gapi.client.dfareporting.placements.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.placements.update({ profileId: "profileId", });
await gapi.client.dfareporting.placementStrategies.delete({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.placementStrategies.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.placementStrategies.insert({ profileId: "profileId", });
await gapi.client.dfareporting.placementStrategies.list({ profileId: "profileId", });
await gapi.client.dfareporting.placementStrategies.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.placementStrategies.update({ profileId: "profileId", });
await gapi.client.dfareporting.platformTypes.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.platformTypes.list({ profileId: "profileId", });
await gapi.client.dfareporting.postalCodes.get({ code: "code", profileId: "profileId", });
await gapi.client.dfareporting.postalCodes.list({ profileId: "profileId", });
await gapi.client.dfareporting.projects.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.projects.list({ profileId: "profileId", });
await gapi.client.dfareporting.regions.list({ profileId: "profileId", });
await gapi.client.dfareporting.remarketingLists.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.remarketingLists.insert({ profileId: "profileId", });
await gapi.client.dfareporting.remarketingLists.list({ advertiserId: "advertiserId", profileId: "profileId", });
await gapi.client.dfareporting.remarketingLists.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.remarketingLists.update({ profileId: "profileId", });
await gapi.client.dfareporting.remarketingListShares.get({ profileId: "profileId", remarketingListId: "remarketingListId", });
await gapi.client.dfareporting.remarketingListShares.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.remarketingListShares.update({ profileId: "profileId", });
await gapi.client.dfareporting.reports.delete({ profileId: "profileId", reportId: "reportId", });
await gapi.client.dfareporting.reports.get({ profileId: "profileId", reportId: "reportId", });
await gapi.client.dfareporting.reports.insert({ profileId: "profileId", });
await gapi.client.dfareporting.reports.list({ profileId: "profileId", });
await gapi.client.dfareporting.reports.patch({ profileId: "profileId", reportId: "reportId", });
await gapi.client.dfareporting.reports.run({ profileId: "profileId", reportId: "reportId", });
await gapi.client.dfareporting.reports.update({ profileId: "profileId", reportId: "reportId", });
await gapi.client.dfareporting.sites.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.sites.insert({ profileId: "profileId", });
await gapi.client.dfareporting.sites.list({ profileId: "profileId", });
await gapi.client.dfareporting.sites.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.sites.update({ profileId: "profileId", });
await gapi.client.dfareporting.sizes.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.sizes.insert({ profileId: "profileId", });
await gapi.client.dfareporting.sizes.list({ profileId: "profileId", });
await gapi.client.dfareporting.subaccounts.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.subaccounts.insert({ profileId: "profileId", });
await gapi.client.dfareporting.subaccounts.list({ profileId: "profileId", });
await gapi.client.dfareporting.subaccounts.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.subaccounts.update({ profileId: "profileId", });
await gapi.client.dfareporting.targetableRemarketingLists.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.targetableRemarketingLists.list({ advertiserId: "advertiserId", profileId: "profileId", });
await gapi.client.dfareporting.targetingTemplates.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.targetingTemplates.insert({ profileId: "profileId", });
await gapi.client.dfareporting.targetingTemplates.list({ profileId: "profileId", });
await gapi.client.dfareporting.targetingTemplates.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.targetingTemplates.update({ profileId: "profileId", });
await gapi.client.dfareporting.userProfiles.get({ profileId: "profileId", });
await gapi.client.dfareporting.userProfiles.list({ });
await gapi.client.dfareporting.userRolePermissionGroups.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.userRolePermissionGroups.list({ profileId: "profileId", });
await gapi.client.dfareporting.userRolePermissions.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.userRolePermissions.list({ profileId: "profileId", });
await gapi.client.dfareporting.userRoles.delete({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.userRoles.get({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.userRoles.insert({ profileId: "profileId", });
await gapi.client.dfareporting.userRoles.list({ profileId: "profileId", });
await gapi.client.dfareporting.userRoles.patch({ id: "id", profileId: "profileId", });
await gapi.client.dfareporting.userRoles.update({ profileId: "profileId", });
await gapi.client.dfareporting.videoFormats.get({ id: 1, profileId: "profileId", });
await gapi.client.dfareporting.videoFormats.list({ profileId: "profileId", });